mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-07-27 15:22:00 +08:00
b7fc8746e0
Also safely assert in the non-implemented path that should never be taken in practice, and would return wrong results.
205 lines
9.2 KiB
C++
205 lines
9.2 KiB
C++
// This file is part of Eigen, a lightweight C++ template library
|
|
// for linear algebra.
|
|
//
|
|
// Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
|
|
// Copyright (C) 2008 Benoit Jacob <jacob.benoit.1@gmail.com>
|
|
//
|
|
// This Source Code Form is subject to the terms of the Mozilla
|
|
// Public License v. 2.0. If a copy of the MPL was not distributed
|
|
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
#ifndef EIGEN_STATIC_ASSERT_H
|
|
#define EIGEN_STATIC_ASSERT_H
|
|
|
|
/* Some notes on Eigen's static assertion mechanism:
|
|
*
|
|
* - in EIGEN_STATIC_ASSERT(CONDITION,MSG) the parameter CONDITION must be a compile time boolean
|
|
* expression, and MSG an enum listed in struct internal::static_assertion<true>
|
|
*
|
|
* - define EIGEN_NO_STATIC_ASSERT to disable them (and save compilation time)
|
|
* in that case, the static assertion is converted to the following runtime assert:
|
|
* eigen_assert(CONDITION && "MSG")
|
|
*
|
|
* - currently EIGEN_STATIC_ASSERT can only be used in function scope
|
|
*
|
|
*/
|
|
|
|
#ifndef EIGEN_NO_STATIC_ASSERT
|
|
|
|
#if defined(__GXX_EXPERIMENTAL_CXX0X__) || (EIGEN_COMP_MSVC >= 1600)
|
|
|
|
// if native static_assert is enabled, let's use it
|
|
#define EIGEN_STATIC_ASSERT(X,MSG) static_assert(X,#MSG);
|
|
|
|
#else // not CXX0X
|
|
|
|
namespace Eigen {
|
|
|
|
namespace internal {
|
|
|
|
template<bool condition>
|
|
struct static_assertion {};
|
|
|
|
template<>
|
|
struct static_assertion<true>
|
|
{
|
|
enum {
|
|
YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX,
|
|
YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES,
|
|
YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES,
|
|
THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE,
|
|
THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE,
|
|
THIS_METHOD_IS_ONLY_FOR_OBJECTS_OF_A_SPECIFIC_SIZE,
|
|
YOU_MADE_A_PROGRAMMING_MISTAKE,
|
|
EIGEN_INTERNAL_ERROR_PLEASE_FILE_A_BUG_REPORT,
|
|
EIGEN_INTERNAL_COMPILATION_ERROR_OR_YOU_MADE_A_PROGRAMMING_MISTAKE,
|
|
YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR,
|
|
YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR,
|
|
UNALIGNED_LOAD_AND_STORE_OPERATIONS_UNIMPLEMENTED_ON_ALTIVEC,
|
|
THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES,
|
|
FLOATING_POINT_ARGUMENT_PASSED__INTEGER_WAS_EXPECTED,
|
|
NUMERIC_TYPE_MUST_BE_REAL,
|
|
COEFFICIENT_WRITE_ACCESS_TO_SELFADJOINT_NOT_SUPPORTED,
|
|
WRITING_TO_TRIANGULAR_PART_WITH_UNIT_DIAGONAL_IS_NOT_SUPPORTED,
|
|
THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE,
|
|
INVALID_MATRIX_PRODUCT,
|
|
INVALID_VECTOR_VECTOR_PRODUCT__IF_YOU_WANTED_A_DOT_OR_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTIONS,
|
|
INVALID_MATRIX_PRODUCT__IF_YOU_WANTED_A_COEFF_WISE_PRODUCT_YOU_MUST_USE_THE_EXPLICIT_FUNCTION,
|
|
YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY,
|
|
THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES,
|
|
THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES,
|
|
INVALID_MATRIX_TEMPLATE_PARAMETERS,
|
|
INVALID_MATRIXBASE_TEMPLATE_PARAMETERS,
|
|
BOTH_MATRICES_MUST_HAVE_THE_SAME_STORAGE_ORDER,
|
|
THIS_METHOD_IS_ONLY_FOR_DIAGONAL_MATRIX,
|
|
THE_MATRIX_OR_EXPRESSION_THAT_YOU_PASSED_DOES_NOT_HAVE_THE_EXPECTED_TYPE,
|
|
THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_WITH_DIRECT_MEMORY_ACCESS_SUCH_AS_MAP_OR_PLAIN_MATRICES,
|
|
YOU_ALREADY_SPECIFIED_THIS_STRIDE,
|
|
INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION,
|
|
THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD,
|
|
PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1,
|
|
THIS_METHOD_IS_ONLY_FOR_SPECIFIC_TRANSFORMATIONS,
|
|
YOU_CANNOT_MIX_ARRAYS_AND_MATRICES,
|
|
YOU_PERFORMED_AN_INVALID_TRANSFORMATION_CONVERSION,
|
|
THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY,
|
|
YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT,
|
|
THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS,
|
|
THIS_METHOD_IS_ONLY_FOR_INNER_OR_LAZY_PRODUCTS,
|
|
THIS_METHOD_IS_ONLY_FOR_EXPRESSIONS_OF_BOOL,
|
|
THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES,
|
|
YOU_PASSED_A_ROW_VECTOR_BUT_A_COLUMN_VECTOR_WAS_EXPECTED,
|
|
YOU_PASSED_A_COLUMN_VECTOR_BUT_A_ROW_VECTOR_WAS_EXPECTED,
|
|
THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE,
|
|
THE_STORAGE_ORDER_OF_BOTH_SIDES_MUST_MATCH,
|
|
OBJECT_ALLOCATED_ON_STACK_IS_TOO_BIG,
|
|
IMPLICIT_CONVERSION_TO_SCALAR_IS_FOR_INNER_PRODUCT_ONLY,
|
|
STORAGE_LAYOUT_DOES_NOT_MATCH
|
|
};
|
|
};
|
|
|
|
} // end namespace internal
|
|
|
|
} // end namespace Eigen
|
|
|
|
// Specialized implementation for MSVC to avoid "conditional
|
|
// expression is constant" warnings. This implementation doesn't
|
|
// appear to work under GCC, hence the multiple implementations.
|
|
#if EIGEN_COMP_MSVC
|
|
|
|
#define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
|
|
{Eigen::internal::static_assertion<bool(CONDITION)>::MSG;}
|
|
|
|
#else
|
|
// In some cases clang interprets bool(CONDITION) as function declaration
|
|
#define EIGEN_STATIC_ASSERT(CONDITION,MSG) \
|
|
if (Eigen::internal::static_assertion<static_cast<bool>(CONDITION)>::MSG) {}
|
|
|
|
#endif
|
|
|
|
#endif // not CXX0X
|
|
|
|
#else // EIGEN_NO_STATIC_ASSERT
|
|
|
|
#define EIGEN_STATIC_ASSERT(CONDITION,MSG) eigen_assert((CONDITION) && #MSG);
|
|
|
|
#endif // EIGEN_NO_STATIC_ASSERT
|
|
|
|
|
|
// static assertion failing if the type \a TYPE is not a vector type
|
|
#define EIGEN_STATIC_ASSERT_VECTOR_ONLY(TYPE) \
|
|
EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime, \
|
|
YOU_TRIED_CALLING_A_VECTOR_METHOD_ON_A_MATRIX)
|
|
|
|
// static assertion failing if the type \a TYPE is not fixed-size
|
|
#define EIGEN_STATIC_ASSERT_FIXED_SIZE(TYPE) \
|
|
EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime!=Eigen::Dynamic, \
|
|
YOU_CALLED_A_FIXED_SIZE_METHOD_ON_A_DYNAMIC_SIZE_MATRIX_OR_VECTOR)
|
|
|
|
// static assertion failing if the type \a TYPE is not dynamic-size
|
|
#define EIGEN_STATIC_ASSERT_DYNAMIC_SIZE(TYPE) \
|
|
EIGEN_STATIC_ASSERT(TYPE::SizeAtCompileTime==Eigen::Dynamic, \
|
|
YOU_CALLED_A_DYNAMIC_SIZE_METHOD_ON_A_FIXED_SIZE_MATRIX_OR_VECTOR)
|
|
|
|
// static assertion failing if the type \a TYPE is not a vector type of the given size
|
|
#define EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(TYPE, SIZE) \
|
|
EIGEN_STATIC_ASSERT(TYPE::IsVectorAtCompileTime && TYPE::SizeAtCompileTime==SIZE, \
|
|
THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE)
|
|
|
|
// static assertion failing if the type \a TYPE is not a vector type of the given size
|
|
#define EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE(TYPE, ROWS, COLS) \
|
|
EIGEN_STATIC_ASSERT(TYPE::RowsAtCompileTime==ROWS && TYPE::ColsAtCompileTime==COLS, \
|
|
THIS_METHOD_IS_ONLY_FOR_MATRICES_OF_A_SPECIFIC_SIZE)
|
|
|
|
// static assertion failing if the two vector expression types are not compatible (same fixed-size or dynamic size)
|
|
#define EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE(TYPE0,TYPE1) \
|
|
EIGEN_STATIC_ASSERT( \
|
|
(int(TYPE0::SizeAtCompileTime)==Eigen::Dynamic \
|
|
|| int(TYPE1::SizeAtCompileTime)==Eigen::Dynamic \
|
|
|| int(TYPE0::SizeAtCompileTime)==int(TYPE1::SizeAtCompileTime)),\
|
|
YOU_MIXED_VECTORS_OF_DIFFERENT_SIZES)
|
|
|
|
#define EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
|
|
( \
|
|
(int(internal::size_of_xpr_at_compile_time<TYPE0>::ret)==0 && int(internal::size_of_xpr_at_compile_time<TYPE1>::ret)==0) \
|
|
|| (\
|
|
(int(TYPE0::RowsAtCompileTime)==Eigen::Dynamic \
|
|
|| int(TYPE1::RowsAtCompileTime)==Eigen::Dynamic \
|
|
|| int(TYPE0::RowsAtCompileTime)==int(TYPE1::RowsAtCompileTime)) \
|
|
&& (int(TYPE0::ColsAtCompileTime)==Eigen::Dynamic \
|
|
|| int(TYPE1::ColsAtCompileTime)==Eigen::Dynamic \
|
|
|| int(TYPE0::ColsAtCompileTime)==int(TYPE1::ColsAtCompileTime))\
|
|
) \
|
|
)
|
|
|
|
#define EIGEN_STATIC_ASSERT_NON_INTEGER(TYPE) \
|
|
EIGEN_STATIC_ASSERT(!NumTraits<TYPE>::IsInteger, THIS_FUNCTION_IS_NOT_FOR_INTEGER_NUMERIC_TYPES)
|
|
|
|
|
|
// static assertion failing if it is guaranteed at compile-time that the two matrix expression types have different sizes
|
|
#define EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(TYPE0,TYPE1) \
|
|
EIGEN_STATIC_ASSERT( \
|
|
EIGEN_PREDICATE_SAME_MATRIX_SIZE(TYPE0,TYPE1),\
|
|
YOU_MIXED_MATRICES_OF_DIFFERENT_SIZES)
|
|
|
|
#define EIGEN_STATIC_ASSERT_SIZE_1x1(TYPE) \
|
|
EIGEN_STATIC_ASSERT((TYPE::RowsAtCompileTime == 1 || TYPE::RowsAtCompileTime == Dynamic) && \
|
|
(TYPE::ColsAtCompileTime == 1 || TYPE::ColsAtCompileTime == Dynamic), \
|
|
THIS_METHOD_IS_ONLY_FOR_1x1_EXPRESSIONS)
|
|
|
|
#define EIGEN_STATIC_ASSERT_LVALUE(Derived) \
|
|
EIGEN_STATIC_ASSERT(internal::is_lvalue<Derived>::value, \
|
|
THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY)
|
|
|
|
#define EIGEN_STATIC_ASSERT_ARRAYXPR(Derived) \
|
|
EIGEN_STATIC_ASSERT((internal::is_same<typename internal::traits<Derived>::XprKind, ArrayXpr>::value), \
|
|
THIS_METHOD_IS_ONLY_FOR_ARRAYS_NOT_MATRICES)
|
|
|
|
#define EIGEN_STATIC_ASSERT_SAME_XPR_KIND(Derived1, Derived2) \
|
|
EIGEN_STATIC_ASSERT((internal::is_same<typename internal::traits<Derived1>::XprKind, \
|
|
typename internal::traits<Derived2>::XprKind \
|
|
>::value), \
|
|
YOU_CANNOT_MIX_ARRAYS_AND_MATRICES)
|
|
|
|
|
|
#endif // EIGEN_STATIC_ASSERT_H
|