Namespaces
	Eigen
	iterative scaling algorithm to equilibrate rows and column norms in matrices

	Eigen::internal

Macros
#define	EIGEN_ALIGN 1

#define	EIGEN_ALIGN16 EIGEN_ALIGN_TO_BOUNDARY(16)

#define	EIGEN_ALIGN_STATICALLY 1

#define	EIGEN_ALWAYS_INLINE EIGEN_STRONG_INLINE

#define	EIGEN_ARCH_WANTS_STACK_ALIGNMENT 1

#define	EIGEN_ASM_COMMENT(X)

#define	eigen_assert(x) eigen_plain_assert(x)

#define	EIGEN_CAT(a, b) EIGEN_CAT2(a,b)

#define	EIGEN_CAT2(a, b) a ## b

#define	EIGEN_CWISE_PRODUCT_RETURN_TYPE(LHS, RHS)

#define	EIGEN_DEBUG_VAR(x) std::cerr << #x << " = " << x << std::endl;

#define	EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS

#define	EIGEN_DEFAULT_DENSE_INDEX_TYPE std::ptrdiff_t

#define	EIGEN_DEFAULT_IO_FORMAT Eigen::IOFormat()

#define	EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ColMajor

#define	EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS inline

#define	EIGEN_DENSE_PUBLIC_INTERFACE(Derived)

#define	EIGEN_DEPRECATED

#define	EIGEN_DONT_INLINE

#define	EIGEN_EMPTY

#define	EIGEN_FAST_MATH 1

#define	EIGEN_GCC3_OR_OLDER 0

#define	EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 0

#define	EIGEN_GENERIC_PUBLIC_INTERFACE(Derived)

#define	EIGEN_GNUC_AT_LEAST(x, y) 0

#define	EIGEN_GNUC_AT_MOST(x, y) 0

#define	EIGEN_IMPLIES(a, b) (!(a) \|\| (b))

#define	EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived)

#define	EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Derived) EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived)

#define	eigen_internal_assert(x)

#define	EIGEN_LOGICAL_XOR(a, b) (((a) \|\| (b)) && !((a) && (b)))

#define	EIGEN_MAJOR_VERSION 2

#define	EIGEN_MAKE_CWISE_BINARY_OP(METHOD, FUNCTOR)

#define	EIGEN_MAKESTRING(a) EIGEN_MAKESTRING2(a)

#define	EIGEN_MAKESTRING2(a) #a

#define	EIGEN_MINOR_VERSION 0

#define	EIGEN_ONLY_USED_FOR_DEBUG(x)

#define	EIGEN_PERMISSIVE_EXPR

#define	eigen_plain_assert(x) assert(x)

#define	EIGEN_PLAIN_ENUM_MAX(a, b) (((int)a >= (int)b) ? (int)a : (int)b)

#define	EIGEN_PLAIN_ENUM_MIN(a, b) (((int)a <= (int)b) ? (int)a : (int)b)

#define	EIGEN_RESTRICT __restrict

#define	EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO 1

#define	EIGEN_SIZE_MAX(a, b)

#define	EIGEN_SIZE_MIN_PREFER_DYNAMIC(a, b)

#define	EIGEN_SIZE_MIN_PREFER_FIXED(a, b)

#define	EIGEN_STACK_ALLOCATION_LIMIT 20000

#define	EIGEN_STRONG_INLINE inline

#define	EIGEN_UNUSED

#define	EIGEN_UNUSED_VARIABLE(var) (void)var;

#define	EIGEN_USER_ALIGN16 EIGEN_ALIGN16

#define	EIGEN_USER_ALIGN_TO_BOUNDARY(n) EIGEN_ALIGN_TO_BOUNDARY(n)

#define	EIGEN_VERSION_AT_LEAST(x, y, z)

#define	EIGEN_WORLD_VERSION 3

Functions
bool	Eigen::internal::copy_bool (bool b)

Macro Definition Documentation

#define EIGEN_ALIGN 1

Definition at line 75 of file Core/util/Macros.h.

#define EIGEN_ALIGN16 EIGEN_ALIGN_TO_BOUNDARY(16)

Definition at line 269 of file Core/util/Macros.h.

#define EIGEN_ALIGN_STATICALLY 1

Definition at line 81 of file Core/util/Macros.h.

#define EIGEN_ALWAYS_INLINE EIGEN_STRONG_INLINE

Definition at line 137 of file Core/util/Macros.h.

#define EIGEN_ARCH_WANTS_STACK_ALIGNMENT 1

Definition at line 64 of file Core/util/Macros.h.

#define EIGEN_ASM_COMMENT ( X )

Definition at line 247 of file Core/util/Macros.h.

#define eigen_assert ( x ) eigen_plain_assert(x)

Definition at line 207 of file Core/util/Macros.h.

#define EIGEN_CAT	(	a,
		b
	)	EIGEN_CAT2(a,b)

Definition at line 112 of file Core/util/Macros.h.

#define EIGEN_CAT2	(	a,
		b
	)	a ## b

Definition at line 111 of file Core/util/Macros.h.

#define EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	LHS,
		RHS
	)

Value:

CwiseBinaryOp< \
      internal::scalar_product_op< \
          typename internal::traits<LHS>::Scalar, \
          typename internal::traits<RHS>::Scalar \
      >, \
      const LHS, \
      const RHS \
    >

Definition at line 408 of file Core/util/Macros.h.

#define EIGEN_DEBUG_VAR ( x ) std::cerr << #x << " = " << x << std::endl;

Definition at line 108 of file Core/util/Macros.h.

#define EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS

Definition at line 158 of file Core/util/Macros.h.

#define EIGEN_DEFAULT_DENSE_INDEX_TYPE std::ptrdiff_t

Definition at line 96 of file Core/util/Macros.h.

#define EIGEN_DEFAULT_IO_FORMAT Eigen::IOFormat()

Definition at line 296 of file Core/util/Macros.h.

#define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ColMajor

Definition at line 92 of file Core/util/Macros.h.

#define EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS inline

Definition at line 159 of file Core/util/Macros.h.

#define EIGEN_DENSE_PUBLIC_INTERFACE ( Derived )

Value:

typedef typename Eigen::internal::traits<Derived>::Scalar Scalar;  \
  typedef typename Eigen::NumTraits<Scalar>::Real RealScalar;  \
  typedef typename Base::PacketScalar PacketScalar; \
  typedef typename Base::CoeffReturnType CoeffReturnType;  \
  typedef typename Eigen::internal::nested<Derived>::type Nested; \
  typedef typename Eigen::internal::traits<Derived>::StorageKind StorageKind; \
  typedef typename Eigen::internal::traits<Derived>::Index Index; \
  enum { RowsAtCompileTime = Eigen::internal::traits<Derived>::RowsAtCompileTime, \
        ColsAtCompileTime = Eigen::internal::traits<Derived>::ColsAtCompileTime, \
        MaxRowsAtCompileTime = Eigen::internal::traits<Derived>::MaxRowsAtCompileTime, \
        MaxColsAtCompileTime = Eigen::internal::traits<Derived>::MaxColsAtCompileTime, \
        Flags = Eigen::internal::traits<Derived>::Flags, \
        CoeffReadCost = Eigen::internal::traits<Derived>::CoeffReadCost, \
        SizeAtCompileTime = Base::SizeAtCompileTime, \
        MaxSizeAtCompileTime = Base::MaxSizeAtCompileTime, \
        IsVectorAtCompileTime = Base::IsVectorAtCompileTime }; \
  using Base::derived; \
  using Base::const_cast_derived;

Definition at line 349 of file Core/util/Macros.h.

#define EIGEN_DEPRECATED

Definition at line 228 of file Core/util/Macros.h.

#define EIGEN_DONT_INLINE

Definition at line 145 of file Core/util/Macros.h.

#define EIGEN_EMPTY

Definition at line 301 of file Core/util/Macros.h.

#define EIGEN_FAST_MATH 1

Allows to disable some optimizations which might affect the accuracy of the result. Such optimization are enabled by default, and set EIGEN_FAST_MATH to 0 to disable them. They currently include:

single precision Cwise::sin() and Cwise::cos() when SSE vectorization is enabled.

Definition at line 105 of file Core/util/Macros.h.

#define EIGEN_GCC3_OR_OLDER 0

Definition at line 43 of file Core/util/Macros.h.

#define EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 0

Definition at line 56 of file Core/util/Macros.h.

#define EIGEN_GENERIC_PUBLIC_INTERFACE ( Derived )

Value:

typedef typename Eigen::internal::traits<Derived>::Scalar Scalar;  \
  typedef typename Eigen::NumTraits<Scalar>::Real RealScalar;  \
  typedef typename Base::CoeffReturnType CoeffReturnType;  \
  typedef typename Eigen::internal::nested<Derived>::type Nested; \
  typedef typename Eigen::internal::traits<Derived>::StorageKind StorageKind; \
  typedef typename Eigen::internal::traits<Derived>::Index Index; \
  enum { RowsAtCompileTime = Eigen::internal::traits<Derived>::RowsAtCompileTime, \
        ColsAtCompileTime = Eigen::internal::traits<Derived>::ColsAtCompileTime, \
        Flags = Eigen::internal::traits<Derived>::Flags, \
        CoeffReadCost = Eigen::internal::traits<Derived>::CoeffReadCost, \
        SizeAtCompileTime = Base::SizeAtCompileTime, \
        MaxSizeAtCompileTime = Base::MaxSizeAtCompileTime, \
        IsVectorAtCompileTime = Base::IsVectorAtCompileTime };

Just a side note. Commenting within defines works only by documenting behind the object (via '!<'). Comments cannot be multi-line and thus we have these extra long lines. What is confusing doxygen over here is that we use '\' and basically have a bunch of typedefs with their documentation in a single line.

Definition at line 333 of file Core/util/Macros.h.

#define EIGEN_GNUC_AT_LEAST	(	x,
		y
	)	0

Definition at line 24 of file Core/util/Macros.h.

#define EIGEN_GNUC_AT_MOST	(	x,
		y
	)	0

Definition at line 30 of file Core/util/Macros.h.

#define EIGEN_IMPLIES	(	a,
		b
	)	(!(a) \|\| (b))

Definition at line 397 of file Core/util/Macros.h.

#define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR ( Derived )

Value:

using Base::operator =; \
  EIGEN_STRONG_INLINE Derived& operator=(const Derived& other) \
  { \
    Base::operator=(other); \
    return *this; \
  }

Definition at line 313 of file Core/util/Macros.h.

#define EIGEN_INHERIT_ASSIGNMENT_OPERATORS ( Derived ) EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived)

Definition at line 322 of file Core/util/Macros.h.

#define eigen_internal_assert ( x )

Definition at line 213 of file Core/util/Macros.h.

#define EIGEN_LOGICAL_XOR	(	a,
		b
	)	(((a) \|\| (b)) && !((a) && (b)))

Definition at line 395 of file Core/util/Macros.h.

#define EIGEN_MAJOR_VERSION 2

Definition at line 15 of file Core/util/Macros.h.

#define EIGEN_MAKE_CWISE_BINARY_OP	(	METHOD,
		FUNCTOR
	)

Value:

template<typename OtherDerived> \
  EIGEN_STRONG_INLINE const CwiseBinaryOp<FUNCTOR<Scalar>, const Derived, const OtherDerived> \
  (METHOD)(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const \
  { \
    return CwiseBinaryOp<FUNCTOR<Scalar>, const Derived, const OtherDerived>(derived(), other.derived()); \
  }

Definition at line 399 of file Core/util/Macros.h.

#define EIGEN_MAKESTRING ( a ) EIGEN_MAKESTRING2(a)

Definition at line 116 of file Core/util/Macros.h.

#define EIGEN_MAKESTRING2 ( a ) #a

Definition at line 115 of file Core/util/Macros.h.

#define EIGEN_MINOR_VERSION 0

Definition at line 16 of file Core/util/Macros.h.

#define EIGEN_ONLY_USED_FOR_DEBUG ( x )

Definition at line 219 of file Core/util/Macros.h.

#define EIGEN_PERMISSIVE_EXPR

Definition at line 151 of file Core/util/Macros.h.

#define eigen_plain_assert ( x ) assert(x)

Definition at line 177 of file Core/util/Macros.h.

#define EIGEN_PLAIN_ENUM_MAX	(	a,
		b
	)	(((int)a >= (int)b) ? (int)a : (int)b)

Definition at line 371 of file Core/util/Macros.h.

#define EIGEN_PLAIN_ENUM_MIN	(	a,
		b
	)	(((int)a <= (int)b) ? (int)a : (int)b)

Definition at line 370 of file Core/util/Macros.h.

#define EIGEN_RESTRICT __restrict

Definition at line 283 of file Core/util/Macros.h.

#define EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO 1

Definition at line 37 of file Core/util/Macros.h.

#define EIGEN_SIZE_MAX	(	a,
		b
	)

Value:

(((int)a == Dynamic || (int)b == Dynamic) ? Dynamic \

: ((int)a >= (int)b) ? (int)a : (int)b)

Eigen::Dynamic

const int Dynamic

Definition: eigen3/Eigen/src/Core/util/Constants.h:21

Definition at line 392 of file Core/util/Macros.h.

#define EIGEN_SIZE_MIN_PREFER_DYNAMIC	(	a,
		b
	)

Value:

(((int)a == 0 || (int)b == 0) ? 0 \
                           : ((int)a == 1 || (int)b == 1) ? 1 \
                           : ((int)a == Dynamic || (int)b == Dynamic) ? Dynamic \
                           : ((int)a <= (int)b) ? (int)a : (int)b)

Definition at line 376 of file Core/util/Macros.h.

#define EIGEN_SIZE_MIN_PREFER_FIXED	(	a,
		b
	)

Value:

(((int)a == 0 || (int)b == 0) ? 0 \
                           : ((int)a == 1 || (int)b == 1) ? 1 \
                           : ((int)a == Dynamic && (int)b == Dynamic) ? Dynamic \
                           : ((int)a == Dynamic) ? (int)b \
                           : ((int)b == Dynamic) ? (int)a \
                           : ((int)a <= (int)b) ? (int)a : (int)b)

Definition at line 384 of file Core/util/Macros.h.

#define EIGEN_STACK_ALLOCATION_LIMIT 20000

Definition at line 287 of file Core/util/Macros.h.

#define EIGEN_STRONG_INLINE inline

Definition at line 124 of file Core/util/Macros.h.

#define EIGEN_UNUSED

Definition at line 237 of file Core/util/Macros.h.

#define EIGEN_UNUSED_VARIABLE ( var ) (void)var;

Definition at line 241 of file Core/util/Macros.h.

#define EIGEN_USER_ALIGN16 EIGEN_ALIGN16

Definition at line 273 of file Core/util/Macros.h.

#define EIGEN_USER_ALIGN_TO_BOUNDARY ( n ) EIGEN_ALIGN_TO_BOUNDARY(n)

Definition at line 272 of file Core/util/Macros.h.

#define EIGEN_VERSION_AT_LEAST	(	x,
		y,
		z
	)

Value:

(EIGEN_WORLD_VERSION>x || (EIGEN_WORLD_VERSION>=x && \
                                      (EIGEN_MAJOR_VERSION>y || (EIGEN_MAJOR_VERSION>=y && \
                                                                 EIGEN_MINOR_VERSION>=z))))

Definition at line 18 of file Core/util/Macros.h.

#define EIGEN_WORLD_VERSION 3

Definition at line 14 of file Core/util/Macros.h.

Namespaces

Macros

Functions

Macro Definition Documentation