StaticAssert.h
Go to the documentation of this file.
00001 // This file is part of Eigen, a lightweight C++ template library
00002 // for linear algebra.
00003 //
00004 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
00005 // Copyright (C) 2008 Benoit Jacob <jacob.benoit.1@gmail.com>
00006 //
00007 // Eigen is free software; you can redistribute it and/or
00008 // modify it under the terms of the GNU Lesser General Public
00009 // License as published by the Free Software Foundation; either
00010 // version 3 of the License, or (at your option) any later version.
00011 //
00012 // Alternatively, you can redistribute it and/or
00013 // modify it under the terms of the GNU General Public License as
00014 // published by the Free Software Foundation; either version 2 of
00015 // the License, or (at your option) any later version.
00016 //
00017 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
00018 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00019 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
00020 // GNU General Public License for more details.
00021 //
00022 // You should have received a copy of the GNU Lesser General Public
00023 // License and a copy of the GNU General Public License along with
00024 // Eigen. If not, see <http://www.gnu.org/licenses/>.
00025 
00026 #ifndef EIGEN_STATIC_ASSERT_H
00027 #define EIGEN_STATIC_ASSERT_H
00028 
00029 /* Some notes on Eigen's static assertion mechanism:
00030  *
00031  *  - in EIGEN_STATIC_ASSERT(CONDITION,MSG) the parameter CONDITION must be a compile time boolean
00032  *    expression, and MSG an enum listed in struct internal::static_assertion<true>
00033  *
00034  *  - define EIGEN_NO_STATIC_ASSERT to disable them (and save compilation time)
00035  *    in that case, the static assertion is converted to the following runtime assert:
00036  *      eigen_assert(CONDITION && "MSG")
00037  *
00038  *  - currently EIGEN_STATIC_ASSERT can only be used in function scope
00039  *
00040  */
00041 
00042 #ifndef EIGEN_NO_STATIC_ASSERT
00043 
00044   #if defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(_MSC_VER) && (_MSC_VER >= 1600))
00045 
00046     // if native static_assert is enabled, let's use it
00047     #define EIGEN_STATIC_ASSERT(X,MSG) static_assert(X,#MSG);
00048 
00049   #else // not CXX0X
00050 
00051     namespace Eigen {
00052 
00053     namespace internal {
00054 
00055     template<bool condition>
00056     struct static_assertion {};
00057 
00058     template<>
00059     struct static_assertion<true>
00060     {
00061       enum {
00062         YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX,
00063         YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES,
00064         YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES,
00065         THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE,
00066         THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE,
00067         THIS_METHOD_IS_ONLY_FOR_OBJECTS_OF_A_SPECIFIC_SIZE,
00068         YOU_MADE_A_PROGRAMMING_MISTAKE,
00069         EIGEN_INTERNAL_ERROR_PLEASE_FILE_A_BUG_REPORT,
00070         EIGEN_INTERNAL_COMPILATION_ERROR_OR_YOU_MADE_A_PROGRAMMING_MISTAKE,
00071         YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR,
00072         YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR,
00073         UNALIGNED_LOAD_AND_STORE_OPERATIONS_UNIMPLEMENTED_ON_ALTIVEC,
00074         THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES,
00075         FLOATING_POINT_ARGUMENT_PASSED__INTEGER_WAS_EXPECTED,
00076         NUMERIC_TYPE_MUST_BE_REAL,
00077         COEFFICIENT_WRITE_ACCESS_TO_SELFADJOINT_NOT_SUPPORTED,
00078         WRITING_TO_TRIANGULAR_PART_WITH_UNIT_DIAGONAL_IS_NOT_SUPPORTED,
00079         THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE,
00080         INVALID_MATRIX_PRODUCT,
00081         INVALID_VECTOR_VECTOR_PRODUCT__IF_YOU_WANTED_A_DOT_OR_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTIONS,
00082         INVALID_MATRIX_PRODUCT__IF_YOU_WANTED_A_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTION,
00083         YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY,
00084         THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES,
00085         THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES,
00086         INVALID_MATRIX_TEMPLATE_PARAMETERS,
00087         INVALID_MATRIXBASE_TEMPLATE_PARAMETERS,
00088         BOTH_MATRICES_MUST_HAVE_THE_SAME_STORAGE_ORDER,
00089         THIS_METHOD_IS_ONLY_FOR_DIAGONAL_MATRIX,
00090         THE_MATRIX_OR_EXPRESSION_THAT_YOU_PASSED_DOES_NOT_HAVE_THE_EXPECTED_TYPE,
00091         THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_WITH_DIRECT_MEMORY_ACCESS_SUCH_AS_MAP_OR_PLAIN_MATRICES,
00092         YOU_ALREADY_SPECIFIED_THIS_STRIDE,
00093         INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION,
00094         THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD,
00095         PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1,
00096         THIS_METHOD_IS_ONLY_FOR_SPECIFIC_TRANSFORMATIONS,
00097         YOU_CANNOT_MIX_ARRAYS_AND_MATRICES,
00098         YOU_PERFORMED_AN_INVALID_TRANSFORMATION_CONVERSION,
00099         THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY,
00100         YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT,
00101         THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS,
00102         THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_OF_BOOL,
00103         THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES,
00104         YOU_PASSED_A_ROW_VECTOR_BUT_A_COLUMN_VECTOR_WAS_EXPECTED,
00105         YOU_PASSED_A_COLUMN_VECTOR_BUT_A_ROW_VECTOR_WAS_EXPECTED,
00106         THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE,
00107         THE_STORAGE_ORDER_OF_BOTH_SIDES_MUST_MATCH
00108       };
00109     };
00110 
00111     } // end namespace internal
00112 
00113     } // end namespace Eigen
00114 
00115     // Specialized implementation for MSVC to avoid "conditional
00116     // expression is constant" warnings.  This implementation doesn't
00117     // appear to work under GCC, hence the multiple implementations.
00118     #ifdef _MSC_VER
00119 
00120       #define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
00121         {Eigen::internal::static_assertion<bool(CONDITION)>::MSG;}
00122 
00123     #else
00124 
00125       #define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
00126         if (Eigen::internal::static_assertion<bool(CONDITION)>::MSG) {}
00127 
00128     #endif
00129 
00130   #endif // not CXX0X
00131 
00132 #else // EIGEN_NO_STATIC_ASSERT
00133 
00134   #define EIGEN_STATIC_ASSERT(CONDITION,MSG) eigen_assert((CONDITION) && #MSG);
00135 
00136 #endif // EIGEN_NO_STATIC_ASSERT
00137 
00138 
00139 // static assertion failing if the type \a TYPE is not a vector type
00140 #define EIGEN_STATIC_ASSERT_VECTOR_ONLY(TYPE) \
00141   EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime, \
00142                       YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX)
00143 
00144 // static assertion failing if the type \a TYPE is not fixed-size
00145 #define EIGEN_STATIC_ASSERT_FIXED_SIZE(TYPE) \
00146   EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime!=Eigen::Dynamic, \
00147                       YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR)
00148 
00149 // static assertion failing if the type \a TYPE is not dynamic-size
00150 #define EIGEN_STATIC_ASSERT_DYNAMIC_SIZE(TYPE) \
00151   EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime==Eigen::Dynamic, \
00152                       YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR)
00153 
00154 // static assertion failing if the type \a TYPE is not a vector type of the given size
00155 #define EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(TYPE, SIZE) \
00156   EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime && TYPE::SizeAtCompileTime==SIZE, \
00157                       THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE)
00158 
00159 // static assertion failing if the type \a TYPE is not a vector type of the given size
00160 #define EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE(TYPE, ROWS, COLS) \
00161   EIGEN_STATIC_ASSERT(TYPE::RowsAtCompileTime==ROWS && TYPE::ColsAtCompileTime==COLS, \
00162                       THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE)
00163 
00164 // static assertion failing if the two vector expression types are not compatible (same fixed-size or dynamic size)
00165 #define EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE(TYPE0,TYPE1) \
00166   EIGEN_STATIC_ASSERT( \
00167       (int(TYPE0::SizeAtCompileTime)==Eigen::Dynamic \
00168     || int(TYPE1::SizeAtCompileTime)==Eigen::Dynamic \
00169     || int(TYPE0::SizeAtCompileTime)==int(TYPE1::SizeAtCompileTime)),\
00170     YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES)
00171 
00172 #define EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
00173      ( \
00174         (int(TYPE0::SizeAtCompileTime)==0 && int(TYPE1::SizeAtCompileTime)==0) \
00175     || (\
00176           (int(TYPE0::RowsAtCompileTime)==Eigen::Dynamic \
00177         || int(TYPE1::RowsAtCompileTime)==Eigen::Dynamic \
00178         || int(TYPE0::RowsAtCompileTime)==int(TYPE1::RowsAtCompileTime)) \
00179       &&  (int(TYPE0::ColsAtCompileTime)==Eigen::Dynamic \
00180         || int(TYPE1::ColsAtCompileTime)==Eigen::Dynamic \
00181         || int(TYPE0::ColsAtCompileTime)==int(TYPE1::ColsAtCompileTime))\
00182        ) \
00183      )
00184 
00185 #ifdef EIGEN2_SUPPORT
00186   #define EIGEN_STATIC_ASSERT_NON_INTEGER(TYPE) \
00187     eigen_assert(!NumTraits<Scalar>::IsInteger);
00188 #else
00189   #define EIGEN_STATIC_ASSERT_NON_INTEGER(TYPE) \
00190     EIGEN_STATIC_ASSERT(!NumTraits<TYPE>::IsInteger, THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES)
00191 #endif
00192 
00193 
00194 // static assertion failing if it is guaranteed at compile-time that the two matrix expression types have different sizes
00195 #define EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
00196   EIGEN_STATIC_ASSERT( \
00197      EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1),\
00198     YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES)
00199 
00200 #define EIGEN_STATIC_ASSERT_SIZE_1x1(TYPE) \
00201       EIGEN_STATIC_ASSERT((TYPE::RowsAtCompileTime == 1 || TYPE::RowsAtCompileTime == Dynamic) && \
00202                           (TYPE::ColsAtCompileTime == 1 || TYPE::ColsAtCompileTime == Dynamic), \
00203                           THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS)
00204 
00205 #define EIGEN_STATIC_ASSERT_LVALUE(Derived) \
00206       EIGEN_STATIC_ASSERT(internal::is_lvalue<Derived>::value, \
00207                           THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY)
00208 
00209 #define EIGEN_STATIC_ASSERT_ARRAYXPR(Derived) \
00210       EIGEN_STATIC_ASSERT((internal::is_same<typename internal::traits<Derived>::XprKind, ArrayXpr>::value), \
00211                           THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES)
00212 
00213 #define EIGEN_STATIC_ASSERT_SAME_XPR_KIND(Derived1, Derived2) \
00214       EIGEN_STATIC_ASSERT((internal::is_same<typename internal::traits<Derived1>::XprKind, \
00215                                              typename internal::traits<Derived2>::XprKind \
00216                                             >::value), \
00217                           YOU_CANNOT_MIX_ARRAYS_AND_MATRICES)
00218 
00219 
00220 #endif // EIGEN_STATIC_ASSERT_H