Eigen  3.3.3
StaticAssert.h
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 // This Source Code Form is subject to the terms of the Mozilla
00008 // Public License v. 2.0. If a copy of the MPL was not distributed
00009 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
00010 
00011 #ifndef EIGEN_STATIC_ASSERT_H
00012 #define EIGEN_STATIC_ASSERT_H
00013 
00014 /* Some notes on Eigen's static assertion mechanism:
00015  *
00016  *  - in EIGEN_STATIC_ASSERT(CONDITION,MSG) the parameter CONDITION must be a compile time boolean
00017  *    expression, and MSG an enum listed in struct internal::static_assertion<true>
00018  *
00019  *  - define EIGEN_NO_STATIC_ASSERT to disable them (and save compilation time)
00020  *    in that case, the static assertion is converted to the following runtime assert:
00021  *      eigen_assert(CONDITION && "MSG")
00022  *
00023  *  - currently EIGEN_STATIC_ASSERT can only be used in function scope
00024  *
00025  */
00026 
00027 #ifndef EIGEN_NO_STATIC_ASSERT
00028 
00029   #if EIGEN_MAX_CPP_VER>=11 && (__has_feature(cxx_static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L) || (EIGEN_COMP_MSVC >= 1600))
00030 
00031     // if native static_assert is enabled, let's use it
00032     #define EIGEN_STATIC_ASSERT(X,MSG) static_assert(X,#MSG);
00033 
00034   #else // not CXX0X
00035 
00036     namespace Eigen {
00037 
00038     namespace internal {
00039 
00040     template<bool condition>
00041     struct static_assertion {};
00042 
00043     template<>
00044     struct static_assertion<true>
00045     {
00046       enum {
00047         YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX,
00048         YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES,
00049         YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES,
00050         THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE,
00051         THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE,
00052         THIS_METHOD_IS_ONLY_FOR_OBJECTS_OF_A_SPECIFIC_SIZE,
00053         OUT_OF_RANGE_ACCESS,
00054         YOU_MADE_A_PROGRAMMING_MISTAKE,
00055         EIGEN_INTERNAL_ERROR_PLEASE_FILE_A_BUG_REPORT,
00056         EIGEN_INTERNAL_COMPILATION_ERROR_OR_YOU_MADE_A_PROGRAMMING_MISTAKE,
00057         YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR,
00058         YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR,
00059         UNALIGNED_LOAD_AND_STORE_OPERATIONS_UNIMPLEMENTED_ON_ALTIVEC,
00060         THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES,
00061         FLOATING_POINT_ARGUMENT_PASSED__INTEGER_WAS_EXPECTED,
00062         NUMERIC_TYPE_MUST_BE_REAL,
00063         COEFFICIENT_WRITE_ACCESS_TO_SELFADJOINT_NOT_SUPPORTED,
00064         WRITING_TO_TRIANGULAR_PART_WITH_UNIT_DIAGONAL_IS_NOT_SUPPORTED,
00065         THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE,
00066         INVALID_MATRIX_PRODUCT,
00067         INVALID_VECTOR_VECTOR_PRODUCT__IF_YOU_WANTED_A_DOT_OR_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTIONS,
00068         INVALID_MATRIX_PRODUCT__IF_YOU_WANTED_A_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTION,
00069         YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY,
00070         THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES,
00071         THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES,
00072         INVALID_MATRIX_TEMPLATE_PARAMETERS,
00073         INVALID_MATRIXBASE_TEMPLATE_PARAMETERS,
00074         BOTH_MATRICES_MUST_HAVE_THE_SAME_STORAGE_ORDER,
00075         THIS_METHOD_IS_ONLY_FOR_DIAGONAL_MATRIX,
00076         THE_MATRIX_OR_EXPRESSION_THAT_YOU_PASSED_DOES_NOT_HAVE_THE_EXPECTED_TYPE,
00077         THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_WITH_DIRECT_MEMORY_ACCESS_SUCH_AS_MAP_OR_PLAIN_MATRICES,
00078         YOU_ALREADY_SPECIFIED_THIS_STRIDE,
00079         INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION,
00080         THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD,
00081         PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1,
00082         THIS_METHOD_IS_ONLY_FOR_SPECIFIC_TRANSFORMATIONS,
00083         YOU_CANNOT_MIX_ARRAYS_AND_MATRICES,
00084         YOU_PERFORMED_AN_INVALID_TRANSFORMATION_CONVERSION,
00085         THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY,
00086         YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT,
00087         THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS,
00088         THIS_METHOD_IS_ONLY_FOR_INNER_OR_LAZY_PRODUCTS,
00089         THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_OF_BOOL,
00090         THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES,
00091         YOU_PASSED_A_ROW_VECTOR_BUT_A_COLUMN_VECTOR_WAS_EXPECTED,
00092         YOU_PASSED_A_COLUMN_VECTOR_BUT_A_ROW_VECTOR_WAS_EXPECTED,
00093         THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE,
00094         THE_STORAGE_ORDER_OF_BOTH_SIDES_MUST_MATCH,
00095         OBJECT_ALLOCATED_ON_STACK_IS_TOO_BIG,
00096         IMPLICIT_CONVERSION_TO_SCALAR_IS_FOR_INNER_PRODUCT_ONLY,
00097         STORAGE_LAYOUT_DOES_NOT_MATCH,
00098         EIGEN_INTERNAL_ERROR_PLEASE_FILE_A_BUG_REPORT__INVALID_COST_VALUE,
00099         THIS_COEFFICIENT_ACCESSOR_TAKING_ONE_ACCESS_IS_ONLY_FOR_EXPRESSIONS_ALLOWING_LINEAR_ACCESS,
00100         MATRIX_FREE_CONJUGATE_GRADIENT_IS_COMPATIBLE_WITH_UPPER_UNION_LOWER_MODE_ONLY,
00101         THIS_TYPE_IS_NOT_SUPPORTED,
00102         STORAGE_KIND_MUST_MATCH,
00103         STORAGE_INDEX_MUST_MATCH,
00104         CHOLMOD_SUPPORTS_DOUBLE_PRECISION_ONLY
00105       };
00106     };
00107 
00108     } // end namespace internal
00109 
00110     } // end namespace Eigen
00111 
00112     // Specialized implementation for MSVC to avoid "conditional
00113     // expression is constant" warnings.  This implementation doesn't
00114     // appear to work under GCC, hence the multiple implementations.
00115     #if EIGEN_COMP_MSVC
00116 
00117       #define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
00118         {Eigen::internal::static_assertion<bool(CONDITION)>::MSG;}
00119 
00120     #else
00121       // In some cases clang interprets bool(CONDITION) as function declaration
00122       #define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
00123         if (Eigen::internal::static_assertion<static_cast<bool>(CONDITION)>::MSG) {}
00124 
00125     #endif
00126 
00127   #endif // not CXX0X
00128 
00129 #else // EIGEN_NO_STATIC_ASSERT
00130 
00131   #define EIGEN_STATIC_ASSERT(CONDITION,MSG) eigen_assert((CONDITION) && #MSG);
00132 
00133 #endif // EIGEN_NO_STATIC_ASSERT
00134 
00135 
00136 // static assertion failing if the type \a TYPE is not a vector type
00137 #define EIGEN_STATIC_ASSERT_VECTOR_ONLY(TYPE) \
00138   EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime, \
00139                       YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX)
00140 
00141 // static assertion failing if the type \a TYPE is not fixed-size
00142 #define EIGEN_STATIC_ASSERT_FIXED_SIZE(TYPE) \
00143   EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime!=Eigen::Dynamic, \
00144                       YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR)
00145 
00146 // static assertion failing if the type \a TYPE is not dynamic-size
00147 #define EIGEN_STATIC_ASSERT_DYNAMIC_SIZE(TYPE) \
00148   EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime==Eigen::Dynamic, \
00149                       YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR)
00150 
00151 // static assertion failing if the type \a TYPE is not a vector type of the given size
00152 #define EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(TYPE, SIZE) \
00153   EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime && TYPE::SizeAtCompileTime==SIZE, \
00154                       THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE)
00155 
00156 // static assertion failing if the type \a TYPE is not a vector type of the given size
00157 #define EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE(TYPE, ROWS, COLS) \
00158   EIGEN_STATIC_ASSERT(TYPE::RowsAtCompileTime==ROWS && TYPE::ColsAtCompileTime==COLS, \
00159                       THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE)
00160 
00161 // static assertion failing if the two vector expression types are not compatible (same fixed-size or dynamic size)
00162 #define EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE(TYPE0,TYPE1) \
00163   EIGEN_STATIC_ASSERT( \
00164       (int(TYPE0::SizeAtCompileTime)==Eigen::Dynamic \
00165     || int(TYPE1::SizeAtCompileTime)==Eigen::Dynamic \
00166     || int(TYPE0::SizeAtCompileTime)==int(TYPE1::SizeAtCompileTime)),\
00167     YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES)
00168 
00169 #define EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
00170      ( \
00171         (int(Eigen::internal::size_of_xpr_at_compile_time<TYPE0>::ret)==0 && int(Eigen::internal::size_of_xpr_at_compile_time<TYPE1>::ret)==0) \
00172     || (\
00173           (int(TYPE0::RowsAtCompileTime)==Eigen::Dynamic \
00174         || int(TYPE1::RowsAtCompileTime)==Eigen::Dynamic \
00175         || int(TYPE0::RowsAtCompileTime)==int(TYPE1::RowsAtCompileTime)) \
00176       &&  (int(TYPE0::ColsAtCompileTime)==Eigen::Dynamic \
00177         || int(TYPE1::ColsAtCompileTime)==Eigen::Dynamic \
00178         || int(TYPE0::ColsAtCompileTime)==int(TYPE1::ColsAtCompileTime))\
00179        ) \
00180      )
00181 
00182 #define EIGEN_STATIC_ASSERT_NON_INTEGER(TYPE) \
00183     EIGEN_STATIC_ASSERT(!NumTraits<TYPE>::IsInteger, THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES)
00184 
00185 
00186 // static assertion failing if it is guaranteed at compile-time that the two matrix expression types have different sizes
00187 #define EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
00188   EIGEN_STATIC_ASSERT( \
00189      EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1),\
00190     YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES)
00191 
00192 #define EIGEN_STATIC_ASSERT_SIZE_1x1(TYPE) \
00193       EIGEN_STATIC_ASSERT((TYPE::RowsAtCompileTime == 1 || TYPE::RowsAtCompileTime == Dynamic) && \
00194                           (TYPE::ColsAtCompileTime == 1 || TYPE::ColsAtCompileTime == Dynamic), \
00195                           THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS)
00196 
00197 #define EIGEN_STATIC_ASSERT_LVALUE(Derived) \
00198       EIGEN_STATIC_ASSERT(Eigen::internal::is_lvalue<Derived>::value, \
00199                           THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY)
00200 
00201 #define EIGEN_STATIC_ASSERT_ARRAYXPR(Derived) \
00202       EIGEN_STATIC_ASSERT((Eigen::internal::is_same<typename Eigen::internal::traits<Derived>::XprKind, ArrayXpr>::value), \
00203                           THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES)
00204 
00205 #define EIGEN_STATIC_ASSERT_SAME_XPR_KIND(Derived1, Derived2) \
00206       EIGEN_STATIC_ASSERT((Eigen::internal::is_same<typename Eigen::internal::traits<Derived1>::XprKind, \
00207                                              typename Eigen::internal::traits<Derived2>::XprKind \
00208                                             >::value), \
00209                           YOU_CANNOT_MIX_ARRAYS_AND_MATRICES)
00210 
00211 // Check that a cost value is positive, and that is stay within a reasonable range
00212 // TODO this check could be enabled for internal debugging only
00213 #define EIGEN_INTERNAL_CHECK_COST_VALUE(C) \
00214       EIGEN_STATIC_ASSERT((C)>=0 && (C)<=HugeCost*HugeCost, EIGEN_INTERNAL_ERROR_PLEASE_FILE_A_BUG_REPORT__INVALID_COST_VALUE);
00215 
00216 #endif // EIGEN_STATIC_ASSERT_H
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends