Base.h
Go to the documentation of this file.
1 /*!
2  *
3  *
4  * \brief Entry Point for all Basic Linear Algebra(BLAS) in shark
5  *
6  *
7  *
8  * \author O.Krause, T.Glasmachers, T. Voss
9  * \date 2010-2011
10  *
11  *
12  * \par Copyright 1995-2015 Shark Development Team
13  *
14  * <BR><HR>
15  * This file is part of Shark.
16  * <http://image.diku.dk/shark/>
17  *
18  * Shark is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU Lesser General Public License as published
20  * by the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * Shark is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26  * GNU Lesser General Public License for more details.
27  *
28  * You should have received a copy of the GNU Lesser General Public License
29  * along with Shark. If not, see <http://www.gnu.org/licenses/>.
30  *
31  */
32 #ifndef SHARK_LINALG_BASE_H
33 #define SHARK_LINALG_BASE_H
34 
35 /**
36 * \brief Shark linear algebra definitions
37 *
38 * \par
39 * This file provides all basic definitions for linear algebra.
40 * If defines objects and views for vectors and matrices over
41 * several base types as well as a lot of usefull functions.
42 */
43 
44 //for debug error handling of linear algebra
45 #include <shark/LinAlg/BLAS/blas.h>
46 #include <shark/Core/Exception.h>
48 #include <shark/LinAlg/Tools.h>
49 #include <shark/LinAlg/Metrics.h>
50 
51 #include <boost/serialization/deque.hpp>
52 #include <deque>
53 
54 namespace shark{
55 
56 #define SHARK_VECTOR_MATRIX_TYPEDEFS(basetype, prefix) \
57  typedef blas::vector< basetype > prefix##Vector; \
58  typedef blas::vector< const basetype > Const##prefix##Vector; \
59  typedef blas::matrix< basetype, blas::row_major > prefix##Matrix; \
60  typedef blas::identity_matrix< basetype > prefix##Identity; \
61  typedef blas::identity_matrix< basetype > prefix##IdentityMatrix; \
62  typedef blas::scalar_matrix< basetype > prefix##ScalarMatrix; \
63  typedef blas::vector_range< prefix##Vector > prefix##VectorRange; \
64  typedef blas::vector_range< const prefix##Vector > Const##prefix##VectorRange; \
65  typedef blas::matrix_row< prefix##Matrix > prefix##MatrixRow; \
66  typedef blas::matrix_row< const prefix##Matrix > Const##prefix##MatrixRow; \
67  typedef blas::matrix_column< prefix##Matrix > prefix##MatrixColumn; \
68  typedef blas::matrix_column< const prefix##Matrix > Const##prefix##MatrixColumn; \
69  typedef blas::matrix_range< prefix##Matrix > prefix##SubMatrix; \
70  typedef blas::matrix_range< const prefix##Matrix > Const##prefix##SubMatrix; \
71  typedef blas::compressed_vector< basetype > Compressed##prefix##Vector; \
72  typedef blas::vector_range< Compressed##prefix##Vector > Compressed##prefix##VectorRange; \
73  typedef blas::vector_range< const Compressed##prefix##Vector > ConstCompressed##prefix##VectorRange; \
74  typedef blas::compressed_matrix< basetype > Compressed##prefix##Matrix; \
75  typedef blas::matrix_row< Compressed##prefix##Matrix > Compressed##prefix##MatrixRow; \
76  typedef blas::matrix_row< const Compressed##prefix##Matrix > ConstCompressed##prefix##MatrixRow; \
77  typedef blas::matrix_column< Compressed##prefix##Matrix > Compressed##prefix##MatrixColumn; \
78  typedef blas::matrix_column< const Compressed##prefix##Matrix > ConstCompressed##prefix##MatrixColumn; \
79  typedef blas::matrix_range< Compressed##prefix##Matrix > Compressed##prefix##SubMatrix; \
80  typedef blas::matrix_range< const Compressed##prefix##Matrix > ConstCompressed##prefix##SubMatrix;\
81  typedef blas::diagonal_matrix<blas::vector< basetype > > prefix##DiagonalMatrix;
82 
83 #define SHARK_VECTOR_MATRIX_ASSIGNMENT(prefix) \
84  template<> struct VectorMatrixTraits< prefix##Vector >{ \
85  typedef prefix##Matrix MatrixType;\
86  typedef prefix##Matrix DenseMatrixType;\
87  typedef prefix##Vector VectorType;\
88  typedef prefix##Vector DenseVectorType;\
89  typedef prefix##VectorRange SubType;\
90  typedef prefix##VectorRange DenseSubType;\
91  typedef Const##prefix##VectorRange ConstSubType;\
92  typedef Const##prefix##VectorRange ConstDenseSubType;\
93  };\
94  template<> struct VectorMatrixTraits< Compressed##prefix##Vector >{ \
95  typedef Compressed##prefix##Matrix MatrixType;\
96  typedef prefix##Matrix DenseMatrixType;\
97  typedef Compressed##prefix##Vector VectorType;\
98  typedef prefix##Vector DenseVectorType;\
99  typedef Compressed##prefix##VectorRange SubType;\
100  typedef prefix##VectorRange DenseSubType;\
101  typedef ConstCompressed##prefix##VectorRange ConstSubType;\
102  typedef Const##prefix##VectorRange ConstDenseSubType;\
103  };\
104  template<> struct VectorMatrixTraits< prefix##VectorRange > { \
105  typedef prefix##Matrix MatrixType;\
106  typedef prefix##Matrix DenseMatrixType;\
107  typedef prefix##Vector VectorType;\
108  typedef prefix##Vector DenseVectorType;\
109  typedef prefix##VectorRange SubType;\
110  typedef prefix##VectorRange DenseSubType;\
111  typedef Const##prefix##VectorRange ConstSubType;\
112  typedef Const##prefix##VectorRange ConstDenseSubType;\
113  };\
114  template<> struct VectorMatrixTraits< Compressed##prefix##VectorRange > { \
115  typedef Compressed##prefix##Matrix MatrixType;\
116  typedef prefix##Matrix DenseMatrixType;\
117  typedef Compressed##prefix##Vector VectorType;\
118  typedef prefix##Vector DenseVectorType;\
119  typedef Compressed##prefix##VectorRange SubType;\
120  typedef prefix##VectorRange DenseSubType;\
121  typedef ConstCompressed##prefix##VectorRange ConstSubType;\
122  typedef Const##prefix##VectorRange ConstDenseSubType;\
123  };
124 
125  SHARK_VECTOR_MATRIX_TYPEDEFS(long double, BigReal);
126  SHARK_VECTOR_MATRIX_TYPEDEFS(double, Real)
127  SHARK_VECTOR_MATRIX_TYPEDEFS(float, Float)
128  SHARK_VECTOR_MATRIX_TYPEDEFS(std::complex<double>, Complex)
130  SHARK_VECTOR_MATRIX_TYPEDEFS(unsigned int, UInt)
131  SHARK_VECTOR_MATRIX_TYPEDEFS(bool, Bool);
132 #undef SHARK_VECTOR_MATRIX_TYPEDEFS
133 
134 ///\brief Template which finds for every Vector type the best fitting Matrix.
135 ///
136 ///As default a RealMatrix is used
137 template<class VectorType>
139  typedef RealMatrix MatrixType;
140  typedef RealMatrix DenseMatrixType;
141  typedef RealVector SuperType;
142  typedef RealVector DenseSuperType;
143  typedef RealVectorRange SubType;
144  typedef RealVectorRange DenseSubType;
145  typedef ConstRealVectorRange ConstSubType;
146  typedef ConstRealVectorRange ConstDenseSubType;
147 };
148 
149 typedef blas::range Range;
151 
159 
160 //this ensures, that Sequence is serializable
161 
162 ///Type of Data sequences.
163 typedef std::deque<RealVector> Sequence;
164 }
165 #endif