StaticAssert.h
Go to the documentation of this file.
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25 
26 #ifndef EIGEN_STATIC_ASSERT_H
27 #define EIGEN_STATIC_ASSERT_H
28 
29 /* Some notes on Eigen's static assertion mechanism:
30  *
31  * - in EIGEN_STATIC_ASSERT(CONDITION,MSG) the parameter CONDITION must be a compile time boolean
32  * expression, and MSG an enum listed in struct internal::static_assertion<true>
33  *
34  * - define EIGEN_NO_STATIC_ASSERT to disable them (and save compilation time)
35  * in that case, the static assertion is converted to the following runtime assert:
36  * eigen_assert(CONDITION && "MSG")
37  *
38  * - currently EIGEN_STATIC_ASSERT can only be used in function scope
39  *
40  */
41 
42 #ifndef EIGEN_NO_STATIC_ASSERT
43 
44  #if defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(_MSC_VER) && (_MSC_VER >= 1600))
45 
46  // if native static_assert is enabled, let's use it
47  #define EIGEN_STATIC_ASSERT(X,MSG) static_assert(X,#MSG);
48 
49  #else // not CXX0X
50 
51  namespace Eigen {
52 
53  namespace internal {
54 
55  template<bool condition>
56  struct static_assertion {};
57 
58  template<>
59  struct static_assertion<true>
60  {
61  enum {
62  YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX,
63  YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES,
64  YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES,
65  THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE,
66  THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE,
67  THIS_METHOD_IS_ONLY_FOR_OBJECTS_OF_A_SPECIFIC_SIZE,
68  YOU_MADE_A_PROGRAMMING_MISTAKE,
69  EIGEN_INTERNAL_ERROR_PLEASE_FILE_A_BUG_REPORT,
70  EIGEN_INTERNAL_COMPILATION_ERROR_OR_YOU_MADE_A_PROGRAMMING_MISTAKE,
71  YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR,
72  YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR,
73  UNALIGNED_LOAD_AND_STORE_OPERATIONS_UNIMPLEMENTED_ON_ALTIVEC,
74  THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES,
75  FLOATING_POINT_ARGUMENT_PASSED__INTEGER_WAS_EXPECTED,
76  NUMERIC_TYPE_MUST_BE_REAL,
77  COEFFICIENT_WRITE_ACCESS_TO_SELFADJOINT_NOT_SUPPORTED,
78  WRITING_TO_TRIANGULAR_PART_WITH_UNIT_DIAGONAL_IS_NOT_SUPPORTED,
79  THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE,
80  INVALID_MATRIX_PRODUCT,
81  INVALID_VECTOR_VECTOR_PRODUCT__IF_YOU_WANTED_A_DOT_OR_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTIONS,
82  INVALID_MATRIX_PRODUCT__IF_YOU_WANTED_A_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTION,
83  YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY,
84  THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES,
85  THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES,
86  INVALID_MATRIX_TEMPLATE_PARAMETERS,
87  INVALID_MATRIXBASE_TEMPLATE_PARAMETERS,
88  BOTH_MATRICES_MUST_HAVE_THE_SAME_STORAGE_ORDER,
89  THIS_METHOD_IS_ONLY_FOR_DIAGONAL_MATRIX,
90  THE_MATRIX_OR_EXPRESSION_THAT_YOU_PASSED_DOES_NOT_HAVE_THE_EXPECTED_TYPE,
91  THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_WITH_DIRECT_MEMORY_ACCESS_SUCH_AS_MAP_OR_PLAIN_MATRICES,
92  YOU_ALREADY_SPECIFIED_THIS_STRIDE,
93  INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION,
94  THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD,
95  PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1,
96  THIS_METHOD_IS_ONLY_FOR_SPECIFIC_TRANSFORMATIONS,
97  YOU_CANNOT_MIX_ARRAYS_AND_MATRICES,
98  YOU_PERFORMED_AN_INVALID_TRANSFORMATION_CONVERSION,
99  THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY,
100  YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT,
101  THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS,
102  THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_OF_BOOL,
103  THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES,
104  YOU_PASSED_A_ROW_VECTOR_BUT_A_COLUMN_VECTOR_WAS_EXPECTED,
105  YOU_PASSED_A_COLUMN_VECTOR_BUT_A_ROW_VECTOR_WAS_EXPECTED,
106  THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE,
107  THE_STORAGE_ORDER_OF_BOTH_SIDES_MUST_MATCH
108  };
109  };
110 
111  } // end namespace internal
112 
113  } // end namespace Eigen
114 
115  // Specialized implementation for MSVC to avoid "conditional
116  // expression is constant" warnings. This implementation doesn't
117  // appear to work under GCC, hence the multiple implementations.
118  #ifdef _MSC_VER
119 
120  #define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
121  {Eigen::internal::static_assertion<bool(CONDITION)>::MSG;}
122 
123  #else
124 
125  #define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
126  if (Eigen::internal::static_assertion<bool(CONDITION)>::MSG) {}
127 
128  #endif
129 
130  #endif // not CXX0X
131 
132 #else // EIGEN_NO_STATIC_ASSERT
133 
134  #define EIGEN_STATIC_ASSERT(CONDITION,MSG) eigen_assert((CONDITION) && #MSG);
135 
136 #endif // EIGEN_NO_STATIC_ASSERT
137 
138 
139 // static assertion failing if the type \a TYPE is not a vector type
140 #define EIGEN_STATIC_ASSERT_VECTOR_ONLY(TYPE) \
141  EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime, \
142  YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX)
143 
144 // static assertion failing if the type \a TYPE is not fixed-size
145 #define EIGEN_STATIC_ASSERT_FIXED_SIZE(TYPE) \
146  EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime!=Eigen::Dynamic, \
147  YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR)
148 
149 // static assertion failing if the type \a TYPE is not dynamic-size
150 #define EIGEN_STATIC_ASSERT_DYNAMIC_SIZE(TYPE) \
151  EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime==Eigen::Dynamic, \
152  YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR)
153 
154 // static assertion failing if the type \a TYPE is not a vector type of the given size
155 #define EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(TYPE, SIZE) \
156  EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime && TYPE::SizeAtCompileTime==SIZE, \
157  THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE)
158 
159 // static assertion failing if the type \a TYPE is not a vector type of the given size
160 #define EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE(TYPE, ROWS, COLS) \
161  EIGEN_STATIC_ASSERT(TYPE::RowsAtCompileTime==ROWS && TYPE::ColsAtCompileTime==COLS, \
162  THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE)
163 
164 // static assertion failing if the two vector expression types are not compatible (same fixed-size or dynamic size)
165 #define EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE(TYPE0,TYPE1) \
166  EIGEN_STATIC_ASSERT( \
167  (int(TYPE0::SizeAtCompileTime)==Eigen::Dynamic \
168  || int(TYPE1::SizeAtCompileTime)==Eigen::Dynamic \
169  || int(TYPE0::SizeAtCompileTime)==int(TYPE1::SizeAtCompileTime)),\
170  YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES)
171 
172 #define EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
173  ( \
174  (int(TYPE0::SizeAtCompileTime)==0 && int(TYPE1::SizeAtCompileTime)==0) \
175  || (\
176  (int(TYPE0::RowsAtCompileTime)==Eigen::Dynamic \
177  || int(TYPE1::RowsAtCompileTime)==Eigen::Dynamic \
178  || int(TYPE0::RowsAtCompileTime)==int(TYPE1::RowsAtCompileTime)) \
179  && (int(TYPE0::ColsAtCompileTime)==Eigen::Dynamic \
180  || int(TYPE1::ColsAtCompileTime)==Eigen::Dynamic \
181  || int(TYPE0::ColsAtCompileTime)==int(TYPE1::ColsAtCompileTime))\
182  ) \
183  )
184 
185 #ifdef EIGEN2_SUPPORT
186  #define EIGEN_STATIC_ASSERT_NON_INTEGER(TYPE) \
187  eigen_assert(!NumTraits<Scalar>::IsInteger);
188 #else
189  #define EIGEN_STATIC_ASSERT_NON_INTEGER(TYPE) \
190  EIGEN_STATIC_ASSERT(!NumTraits<TYPE>::IsInteger, THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES)
191 #endif
192 
193 
194 // static assertion failing if it is guaranteed at compile-time that the two matrix expression types have different sizes
195 #define EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
196  EIGEN_STATIC_ASSERT( \
197  EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1),\
198  YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES)
199 
200 #define EIGEN_STATIC_ASSERT_SIZE_1x1(TYPE) \
201  EIGEN_STATIC_ASSERT((TYPE::RowsAtCompileTime == 1 || TYPE::RowsAtCompileTime == Dynamic) && \
202  (TYPE::ColsAtCompileTime == 1 || TYPE::ColsAtCompileTime == Dynamic), \
203  THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS)
204 
205 #define EIGEN_STATIC_ASSERT_LVALUE(Derived) \
206  EIGEN_STATIC_ASSERT(internal::is_lvalue<Derived>::value, \
207  THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY)
208 
209 #define EIGEN_STATIC_ASSERT_ARRAYXPR(Derived) \
210  EIGEN_STATIC_ASSERT((internal::is_same<typename internal::traits<Derived>::XprKind, ArrayXpr>::value), \
211  THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES)
212 
213 #define EIGEN_STATIC_ASSERT_SAME_XPR_KIND(Derived1, Derived2) \
214  EIGEN_STATIC_ASSERT((internal::is_same<typename internal::traits<Derived1>::XprKind, \
215  typename internal::traits<Derived2>::XprKind \
216  >::value), \
217  YOU_CANNOT_MIX_ARRAYS_AND_MATRICES)
218 
219 
220 #endif // EIGEN_STATIC_ASSERT_H