Eigen::internal::FixedInt< N > Class Template Reference

#include <IntegralConstant.h>

Public Member Functions
constexpr	operator int () const
constexpr	FixedInt ()=default
constexpr	FixedInt (std::integral_constant< int, N >)
constexpr	FixedInt (VariableAndFixedInt< N > other)
constexpr FixedInt<-N >	operator- () const
template<int M>
constexpr FixedInt< N+M >	operator+ (FixedInt< M >) const
template<int M>
constexpr FixedInt< N - M >	operator- (FixedInt< M >) const
template<int M>
constexpr FixedInt< N *M >	operator* (FixedInt< M >) const
template<int M>
constexpr FixedInt< N/M >	operator/ (FixedInt< M >) const
template<int M>
constexpr FixedInt< N % M >	operator% (FixedInt< M >) const
template<int M>
constexpr FixedInt< N|M >	operator| (FixedInt< M >) const
template<int M>
constexpr FixedInt< N &M >	operator& (FixedInt< M >) const
constexpr FixedInt	operator() () const
constexpr VariableAndFixedInt< N >	operator() (int val) const

Static Public Attributes
static constexpr int	value = N

Detailed Description

template<int N>
class Eigen::internal::FixedInt< N >

This class embeds a compile-time integer N.

It is similar to c++11 std::integral_constant<int,N> but with some additional features such as:

• implicit conversion to int
• arithmetic and some bitwise operators: -, +, *, /, %, &, |
• c++98/14 compatibility with fix<N> and fix<N>() syntax to define integral constants.

It is strongly discouraged to directly deal with this class FixedInt. Instances are expected to be created by the user using Eigen::fix<N> or Eigen::fix<N>().

internal::cleanup_index_type<T>::type
internal::cleanup_index_type<T,DynamicKey>::type

where T can a FixedInt<N>, a pointer to function FixedInt<N> (*)(), or numerous other integer-like representations. DynamicKey is either Dynamic (default) or DynamicIndex and used to identify true compile-time values.

For convenience, you can extract the compile-time value N in a generic way using the following helper:

internal::get_fixed_value<T,DefaultVal>::value

that will give you N if T equals FixedInt<N> or FixedInt<N> (*)(), and DefaultVal if T does not embed any compile-time value (e.g., T==int).

See also

fix<N>, class VariableAndFixedInt

Constructor & Destructor Documentation

FixedInt() [1/3]

template<int N>

constexpr Eigen::internal::FixedInt< N >::FixedInt ( )

constexprdefault

FixedInt() [2/3]

template<int N>

constexpr Eigen::internal::FixedInt< N >::FixedInt ( std::integral_constant< int, N >  )

inlineconstexpr

{}

FixedInt() [3/3]

template<int N>

constexpr Eigen::internal::FixedInt< N >::FixedInt ( VariableAndFixedInt< N >  other )

inlineconstexpr

                                                   {
#ifndef EIGEN_INTERNAL_DEBUGGING
    EIGEN_UNUSED_VARIABLE(other);
#endif
    eigen_internal_assert(int(other) == N);
  }

References eigen_internal_assert, EIGEN_UNUSED_VARIABLE, and N.

Member Function Documentation

operator int()

template<int N>

constexpr Eigen::internal::FixedInt< N >::operator int ( ) const

inlineconstexpr

{ return N; }

References N.

operator%()

template<int N>

template<int M>

constexpr FixedInt<N % M> Eigen::internal::FixedInt< N >::operator% ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N % M>();
  }

operator&()

template<int N>

template<int M>

constexpr FixedInt<N & M> Eigen::internal::FixedInt< N >::operator& ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N & M>();
  }

operator()() [1/2]

template<int N>

constexpr FixedInt Eigen::internal::FixedInt< N >::operator() ( ) const

inlineconstexpr

{ return *this; }

operator()() [2/2]

template<int N>

constexpr VariableAndFixedInt<N> Eigen::internal::FixedInt< N >::operator() ( int  val ) const

inlineconstexpr

{ return VariableAndFixedInt<N>(val); }

References calibrate::val.

operator*()

template<int N>

template<int M>

constexpr FixedInt<N * M> Eigen::internal::FixedInt< N >::operator* ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N * M>();
  }

operator+()

template<int N>

template<int M>

constexpr FixedInt<N + M> Eigen::internal::FixedInt< N >::operator+ ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N + M>();
  }

operator-() [1/2]

template<int N>

constexpr FixedInt<-N> Eigen::internal::FixedInt< N >::operator- ( void  ) const

inlineconstexpr

{ return FixedInt<-N>(); }

References N.

operator-() [2/2]

template<int N>

template<int M>

constexpr FixedInt<N - M> Eigen::internal::FixedInt< N >::operator- ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N - M>();
  }

References N.

operator/()

template<int N>

template<int M>

constexpr FixedInt<N / M> Eigen::internal::FixedInt< N >::operator/ ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N / M>();
  }

References N.

operator|()

template<int N>

template<int M>

constexpr FixedInt<N | M> Eigen::internal::FixedInt< N >::operator| ( FixedInt< M >  ) const

inlineconstexpr

                                                         {
    return FixedInt<N | M>();
  }

Member Data Documentation

value

template<int N>

constexpr int Eigen::internal::FixedInt< N >::value = N

staticconstexpr

---

The documentation for this class was generated from the following file:

• IntegralConstant.h