Eigen::PlainObjectBase< Derived > Class Template Reference

Dense storage base class for matrices and arrays. More...

Inheritance diagram for Eigen::PlainObjectBase< Derived >:

Classes
struct	StridedAlignedMapType
struct	StridedConstAlignedMapType
struct	StridedConstMapType
struct	StridedMapType

Public Types
enum	{ Options }
enum	{ NeedsToAlign }
typedef Eigen::Map< Derived, AlignedMax >	AlignedMapType
typedef internal::dense_xpr_base< Derived >::type	Base
typedef const Eigen::Map< const Derived, AlignedMax >	ConstAlignedMapType
typedef const Eigen::Map< const Derived, Unaligned >	ConstMapType
typedef Derived	DenseType
typedef Eigen::Map< Derived, Unaligned >	MapType
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
const Base &	base () const
const Scalar &	coeff (Index index) const
constexpr const Scalar &	coeff (Index rowId, Index colId) const
constexpr Scalar &	coeffRef (Index index)
constexpr const Scalar &	coeffRef (Index index) const
constexpr Scalar &	coeffRef (Index rowId, Index colId)
constexpr const Scalar &	coeffRef (Index rowId, Index colId) const
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
void	conservativeResize (Index rows, Index cols)
void	conservativeResize (Index rows, NoChange_t)
void	conservativeResize (Index size)
void	conservativeResize (NoChange_t, Index cols)
template<typename OtherDerived >
void	conservativeResizeLike (const DenseBase< OtherDerived > &other)
Scalar *	data ()
const Scalar *	data () const
	EIGEN_STATIC_ASSERT (internal::check_implication(MaxRowsAtCompileTime==1 &&MaxColsAtCompileTime!=1,(int(Options)&RowMajor)==RowMajor), INVALID_MATRIX_TEMPLATE_PARAMETERS) EIGEN_STATIC_ASSERT(internal
template<typename OtherDerived >
Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...
Derived &	operator= (const PlainObjectBase &other)
template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &func)
template<int LoadMode>
PacketScalar	packet (Index index) const
template<int LoadMode>
PacketScalar	packet (Index rowId, Index colId) const
constexpr void	resize (Index rows, Index cols)
constexpr void	resize (Index rows, NoChange_t)
constexpr void	resize (Index size)
constexpr void	resize (NoChange_t, Index cols)
template<typename OtherDerived >
void	resizeLike (const EigenBase< OtherDerived > &_other)
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
Derived &	setConstant (Index rows, Index cols, const Scalar &val)
Derived &	setConstant (Index rows, NoChange_t, const Scalar &val)
Derived &	setConstant (Index size, const Scalar &val)
Derived &	setConstant (NoChange_t, Index cols, const Scalar &val)
Derived &	setOnes (Index rows, Index cols)
Derived &	setOnes (Index rows, NoChange_t)
Derived &	setOnes (Index size)
Derived &	setOnes (NoChange_t, Index cols)
Derived &	setRandom (Index rows, Index cols)
Derived &	setRandom (Index rows, NoChange_t)
Derived &	setRandom (Index size)
Derived &	setRandom (NoChange_t, Index cols)
Derived &	setZero (Index rows, Index cols)
Derived &	setZero (Index rows, NoChange_t)
Derived &	setZero (Index size)
Derived &	setZero (NoChange_t, Index cols)
template<int StoreMode>
void	writePacket (Index index, const PacketScalar &val)
template<int StoreMode>
void	writePacket (Index rowId, Index colId, const PacketScalar &val)

Static Public Member Functions
Map
These are convenience functions returning Map objects. The Map() static functions return unaligned Map objects, while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned data pointers. Here is an example using strides: Matrix4i A; A << 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16; std::cout << Matrix2i::Map(&A(1,1),Stride<8,2>()) << std::endl; Output: 6 8 14 16 See also class Map
static ConstMapType	Map (const Scalar *data)
static MapType	Map (Scalar *data)
static ConstMapType	Map (const Scalar *data, Index size)
static MapType	Map (Scalar *data, Index size)
static ConstMapType	Map (const Scalar *data, Index rows, Index cols)
static MapType	Map (Scalar *data, Index rows, Index cols)
static ConstAlignedMapType	MapAligned (const Scalar *data)
static AlignedMapType	MapAligned (Scalar *data)
static ConstAlignedMapType	MapAligned (const Scalar *data, Index size)
static AlignedMapType	MapAligned (Scalar *data, Index size)
static ConstAlignedMapType	MapAligned (const Scalar *data, Index rows, Index cols)
static AlignedMapType	MapAligned (Scalar *data, Index rows, Index cols)
template<int Outer, int Inner>
static StridedConstMapType< Stride< Outer, Inner > >::type	Map (const Scalar *data, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedMapType< Stride< Outer, Inner > >::type	Map (Scalar *data, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedConstMapType< Stride< Outer, Inner > >::type	Map (const Scalar *data, Index size, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedMapType< Stride< Outer, Inner > >::type	Map (Scalar *data, Index size, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedConstMapType< Stride< Outer, Inner > >::type	Map (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedMapType< Stride< Outer, Inner > >::type	Map (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (const Scalar *data, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (Scalar *data, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (const Scalar *data, Index size, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (Scalar *data, Index size, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
template<int Outer, int Inner>
static StridedAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)

Protected Member Functions
template<typename T , typename OtherDerived >
void	_init1 (const DenseBase< OtherDerived > &other)
template<typename T >
void	_init1 (const Derived &other)
template<typename T , typename OtherDerived >
void	_init1 (const EigenBase< OtherDerived > &other)
template<typename T >
void	_init1 (const Index &val0, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T * > *=0)
template<typename T >
void	_init1 (const Index &val0, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * > *=0)
template<typename T , typename OtherDerived >
void	_init1 (const ReturnByValue< OtherDerived > &other)
template<typename T , typename OtherDerived , int ColsAtCompileTime>
void	_init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
template<typename T >
void	_init1 (const Scalar &val0, std::enable_if_t< Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T > *=0)
template<typename T >
void	_init1 (const Scalar &val0, std::enable_if_t< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T > *=0)
template<typename T >
void	_init1 (const Scalar *data)
template<typename T >
void	_init1 (Index size, std::enable_if_t<(Base::SizeAtCompileTime!=1||!internal::is_convertible< T, Scalar >::value) &&((!internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value||Base::SizeAtCompileTime==Dynamic)), T > *=0)
template<typename T0 , typename T1 >
void	_init2 (const Index &val0, const Index &val1, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 > *=0)
template<typename T0 , typename T1 >
void	_init2 (const T0 &val0, const T1 &val1, std::enable_if_t< Base::SizeAtCompileTime==2, T0 > *=0)
template<typename T0 , typename T1 >
void	_init2 (Index rows, Index cols, std::enable_if_t< Base::SizeAtCompileTime!=2, T0 > *=0)
template<typename OtherDerived >
void	_resize_to_match (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	_set (const DenseBase< OtherDerived > &other)
	Copies the value of the expression other into *this with automatic resizing. More...
template<typename OtherDerived >
Derived &	_set_noalias (const DenseBase< OtherDerived > &other)
PlainObjectBase &	operator= (PlainObjectBase &&other) EIGEN_NOEXCEPT
	PlainObjectBase ()
template<typename OtherDerived >
	PlainObjectBase (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
	PlainObjectBase (const EigenBase< OtherDerived > &other)
	PlainObjectBase (const PlainObjectBase &other)
template<typename OtherDerived >
	PlainObjectBase (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...
template<typename... ArgTypes>
	PlainObjectBase (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
	Construct a row of column vector with fixed size from an arbitrary number of coefficients. More...
constexpr	PlainObjectBase (const std::initializer_list< std::initializer_list< Scalar >> &list)
	Constructs a Matrix or Array and initializes it by elements given by an initializer list of initializer lists. More...
	PlainObjectBase (Index size, Index rows, Index cols)
	PlainObjectBase (PlainObjectBase &&other) EIGEN_NOEXCEPT

Protected Attributes
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage

Detailed Description

template<typename Derived>
class Eigen::PlainObjectBase< Derived >

Dense storage base class for matrices and arrays.

This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_PLAINOBJECTBASE_PLUGIN.

Template Parameters

Derived

is the derived type, e.g., a Matrix or Array

See also

The class hierarchy

Definition at line 111 of file PlainObjectBase.h.

Member Typedef Documentation

AlignedMapType

template<typename Derived >

typedef Eigen::Map<Derived, AlignedMax> Eigen::PlainObjectBase< Derived >::AlignedMapType

Definition at line 139 of file PlainObjectBase.h.

Base

template<typename Derived >

typedef internal::dense_xpr_base<Derived>::type Eigen::PlainObjectBase< Derived >::Base

Definition at line 119 of file PlainObjectBase.h.

ConstAlignedMapType

template<typename Derived >

typedef const Eigen::Map<const Derived, AlignedMax> Eigen::PlainObjectBase< Derived >::ConstAlignedMapType

Definition at line 140 of file PlainObjectBase.h.

ConstMapType

template<typename Derived >

typedef const Eigen::Map<const Derived, Unaligned> Eigen::PlainObjectBase< Derived >::ConstMapType

Definition at line 138 of file PlainObjectBase.h.

DenseType

template<typename Derived >

typedef Derived Eigen::PlainObjectBase< Derived >::DenseType

Definition at line 126 of file PlainObjectBase.h.

MapType

template<typename Derived >

typedef Eigen::Map<Derived, Unaligned> Eigen::PlainObjectBase< Derived >::MapType

Definition at line 137 of file PlainObjectBase.h.

PacketScalar

template<typename Derived >

typedef internal::packet_traits<Scalar>::type Eigen::PlainObjectBase< Derived >::PacketScalar

Definition at line 124 of file PlainObjectBase.h.

RealScalar

template<typename Derived >

typedef NumTraits<Scalar>::Real Eigen::PlainObjectBase< Derived >::RealScalar

Definition at line 125 of file PlainObjectBase.h.

Scalar

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::PlainObjectBase< Derived >::Scalar

Definition at line 122 of file PlainObjectBase.h.

StorageKind

template<typename Derived >

typedef internal::traits<Derived>::StorageKind Eigen::PlainObjectBase< Derived >::StorageKind

Definition at line 121 of file PlainObjectBase.h.

Member Enumeration Documentation

anonymous enum

template<typename Derived >

anonymous enum

Enumerator
Options

Definition at line 118 of file PlainObjectBase.h.

{ Options = internal::traits<Derived>::Options };

anonymous enum

template<typename Derived >

anonymous enum

Enumerator
NeedsToAlign

Definition at line 150 of file PlainObjectBase.h.

{ NeedsToAlign = (SizeAtCompileTime != Dynamic) && (internal::traits<Derived>::Alignment>0) };

Constructor & Destructor Documentation

PlainObjectBase() [1/9]

template<typename Derived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( )

inlineprotected

Definition at line 481 of file PlainObjectBase.h.

                                          : m_storage()
    {
//       EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
    }

PlainObjectBase() [2/9]

template<typename Derived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( PlainObjectBase< Derived > &&  other )

inlineprotected

Definition at line 498 of file PlainObjectBase.h.

      : m_storage( std::move(other.m_storage) )
    {
    }

PlainObjectBase() [3/9]

template<typename Derived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( const PlainObjectBase< Derived > &  other )

inlineprotected

Copy constructor

Definition at line 512 of file PlainObjectBase.h.

      : Base(), m_storage(other.m_storage) { }

PlainObjectBase() [4/9]

template<typename Derived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( Index  size, Index  rows, Index  cols  )

inlineprotected

Definition at line 515 of file PlainObjectBase.h.

      : m_storage(size, rows, cols)
    {
//       EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
    }

PlainObjectBase() [5/9]

template<typename Derived >

template<typename... ArgTypes>

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( const Scalar &  a0, const Scalar &  a1, const Scalar &  a2, const Scalar &  a3, const ArgTypes &...  args  )

inlineprotected

Construct a row of column vector with fixed size from an arbitrary number of coefficients.

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.

This constructor is for 1D array or vectors with more than 4 coefficients.

Warning

To construct a column (resp. row) vector of fixed length, the number of values passed to this constructor must match the the fixed number of rows (resp. columns) of *this.

Definition at line 532 of file PlainObjectBase.h.

      : m_storage()
    {
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(PlainObjectBase, sizeof...(args) + 4);
      m_storage.data()[0] = a0;
      m_storage.data()[1] = a1;
      m_storage.data()[2] = a2;
      m_storage.data()[3] = a3;
      Index i = 4;
      auto x = {(m_storage.data()[i++] = args, 0)...};
      static_cast<void>(x);
    }

PlainObjectBase() [6/9]

template<typename Derived >

constexpr Eigen::PlainObjectBase< Derived >::PlainObjectBase ( const std::initializer_list< std::initializer_list< Scalar >> &  list )

inlineexplicitconstexprprotected

Constructs a Matrix or Array and initializes it by elements given by an initializer list of initializer lists.

Definition at line 548 of file PlainObjectBase.h.

        : m_storage() {
      size_t list_size = 0;
      if (list.begin() != list.end()) {
        list_size = list.begin()->size();
      }
 
      // This is to allow syntax like VectorXi {{1, 2, 3, 4}}
      if (ColsAtCompileTime == 1 && list.size() == 1) {
        eigen_assert(list_size == static_cast<size_t>(RowsAtCompileTime) || RowsAtCompileTime == Dynamic);
        resize(list_size, ColsAtCompileTime);
        if (list.begin()->begin() != nullptr) {
          std::copy(list.begin()->begin(), list.begin()->end(), m_storage.data());
        }
      } else {
        eigen_assert(list.size() == static_cast<size_t>(RowsAtCompileTime) || RowsAtCompileTime == Dynamic);
        eigen_assert(list_size == static_cast<size_t>(ColsAtCompileTime) || ColsAtCompileTime == Dynamic);
        resize(list.size(), list_size);
 
        Index row_index = 0;
        for (const std::initializer_list<Scalar>& row : list) {
          eigen_assert(list_size == row.size());
          Index col_index = 0;
          for (const Scalar& e : row) {
            coeffRef(row_index, col_index) = e;
            ++col_index;
          }
          ++row_index;
        }
      }
    }

PlainObjectBase() [7/9]

template<typename Derived >

template<typename OtherDerived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( const DenseBase< OtherDerived > &  other )

inlineprotected

See also

PlainObjectBase::operator=(const EigenBase<OtherDerived>&)

Definition at line 584 of file PlainObjectBase.h.

      : m_storage()
    {
      resizeLike(other);
      _set_noalias(other);
    }

PlainObjectBase() [8/9]

template<typename Derived >

template<typename OtherDerived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( const EigenBase< OtherDerived > &  other )

inlineprotected

See also

PlainObjectBase::operator=(const EigenBase<OtherDerived>&)

Definition at line 594 of file PlainObjectBase.h.

      : m_storage()
    {
      resizeLike(other);
      *this = other.derived();
    }

PlainObjectBase() [9/9]

template<typename Derived >

template<typename OtherDerived >

Eigen::PlainObjectBase< Derived >::PlainObjectBase ( const ReturnByValue< OtherDerived > &  other )

inlineprotected

Copy constructor with in-place evaluation.

Definition at line 603 of file PlainObjectBase.h.

    {
      // FIXME this does not automatically transpose vectors if necessary
      resize(other.rows(), other.cols());
      other.evalTo(this->derived());
    }

Member Function Documentation

_init1() [1/11]

template<typename Derived >

template<typename T , typename OtherDerived >

void Eigen::PlainObjectBase< Derived >::_init1 ( const DenseBase< OtherDerived > &  other )

inlineprotected

Definition at line 872 of file PlainObjectBase.h.

                                                                         {
      this->_set_noalias(other);
    }

_init1() [2/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( const Derived &  other )

inlineprotected

Definition at line 879 of file PlainObjectBase.h.

                                                         {
      this->_set_noalias(other);
    }

_init1() [3/11]

template<typename Derived >

template<typename T , typename OtherDerived >

void Eigen::PlainObjectBase< Derived >::_init1 ( const EigenBase< OtherDerived > &  other )

inlineprotected

Definition at line 886 of file PlainObjectBase.h.

                                                                         {
      this->derived() = other;
    }

_init1() [4/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( const Index &  val0, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T * > *  = 0  )

inlineprotected

Definition at line 920 of file PlainObjectBase.h.

    {
      Base::setConstant(val0);
    }

_init1() [5/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( const Index &  val0, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * > *  = 0  )

inlineprotected

Definition at line 852 of file PlainObjectBase.h.

    {
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(PlainObjectBase, 1)
      m_storage.data()[0] = Scalar(val0);
    }

_init1() [6/11]

template<typename Derived >

template<typename T , typename OtherDerived >

void Eigen::PlainObjectBase< Derived >::_init1 ( const ReturnByValue< OtherDerived > &  other )

inlineprotected

Definition at line 892 of file PlainObjectBase.h.

    {
      resize(other.rows(), other.cols());
      other.evalTo(this->derived());
    }

_init1() [7/11]

template<typename Derived >

template<typename T , typename OtherDerived , int ColsAtCompileTime>

void Eigen::PlainObjectBase< Derived >::_init1 ( const RotationBase< OtherDerived, ColsAtCompileTime > &  r )

inlineprotected

Definition at line 900 of file PlainObjectBase.h.

    {
      this->derived() = r;
    }

_init1() [8/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( const Scalar &  val0, std::enable_if_t< Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T > *  = 0  )

inlineprotected

Definition at line 908 of file PlainObjectBase.h.

    {
      Base::setConstant(val0);
    }

_init1() [9/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( const Scalar &  val0, std::enable_if_t< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T > *  = 0  )

inlineprotected

Definition at line 843 of file PlainObjectBase.h.

    {
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(PlainObjectBase, 1)
      m_storage.data()[0] = val0;
    }

_init1() [10/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( const Scalar *  data )

inlineprotected

Definition at line 865 of file PlainObjectBase.h.

                                                       {
      this->_set_noalias(ConstMapType(data));
    }

_init1() [11/11]

template<typename Derived >

template<typename T >

void Eigen::PlainObjectBase< Derived >::_init1 ( Index  size, std::enable_if_t<(Base::SizeAtCompileTime!=1||!internal::is_convertible< T, Scalar >::value) &&((!internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value||Base::SizeAtCompileTime==Dynamic)), T > *  = 0  )

inlineprotected

Definition at line 829 of file PlainObjectBase.h.

    {
      // NOTE MSVC 2008 complains if we directly put bool(NumTraits<T>::IsInteger) as the EIGEN_STATIC_ASSERT argument.
      const bool is_integer_alike = internal::is_valid_index_type<T>::value;
      EIGEN_UNUSED_VARIABLE(is_integer_alike);
      EIGEN_STATIC_ASSERT(is_integer_alike,
                          FLOATING_POINT_ARGUMENT_PASSED__INTEGER_WAS_EXPECTED)
      resize(size);
    }

_init2() [1/3]

template<typename Derived >

template<typename T0 , typename T1 >

void Eigen::PlainObjectBase< Derived >::_init2 ( const Index &  val0, const Index &  val1, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 > *  = 0  )

inlineprotected

Definition at line 814 of file PlainObjectBase.h.

    {
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(PlainObjectBase, 2)
      m_storage.data()[0] = Scalar(val0);
      m_storage.data()[1] = Scalar(val1);
    }

_init2() [2/3]

template<typename Derived >

template<typename T0 , typename T1 >

void Eigen::PlainObjectBase< Derived >::_init2 ( const T0 &  val0, const T1 &  val1, std::enable_if_t< Base::SizeAtCompileTime==2, T0 > *  = 0  )

inlineprotected

Definition at line 805 of file PlainObjectBase.h.

    {
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(PlainObjectBase, 2)
      m_storage.data()[0] = Scalar(val0);
      m_storage.data()[1] = Scalar(val1);
    }

_init2() [3/3]

template<typename Derived >

template<typename T0 , typename T1 >

void Eigen::PlainObjectBase< Derived >::_init2 ( Index  rows, Index  cols, std::enable_if_t< Base::SizeAtCompileTime!=2, T0 > *  = 0  )

inlineprotected

Definition at line 795 of file PlainObjectBase.h.

    {
      EIGEN_STATIC_ASSERT(internal::is_valid_index_type<T0>::value &&
                          internal::is_valid_index_type<T1>::value,
                          T0 AND T1 MUST BE INTEGER TYPES)
      resize(rows,cols);
    }

_resize_to_match()

template<typename Derived >

template<typename OtherDerived >

void Eigen::PlainObjectBase< Derived >::_resize_to_match ( const EigenBase< OtherDerived > &  other )

inlineprotected

Definition at line 739 of file PlainObjectBase.h.

    {
      #ifdef EIGEN_NO_AUTOMATIC_RESIZING
      eigen_assert((this->size()==0 || (IsVectorAtCompileTime ? (this->size() == other.size())
                 : (rows() == other.rows() && cols() == other.cols())))
        && "Size mismatch. Automatic resizing is disabled because EIGEN_NO_AUTOMATIC_RESIZING is defined");
      EIGEN_ONLY_USED_FOR_DEBUG(other);
      #else
      resizeLike(other);
      #endif
    }

_set()

template<typename Derived >

template<typename OtherDerived >

Derived& Eigen::PlainObjectBase< Derived >::_set ( const DenseBase< OtherDerived > &  other )

inlineprotected

Copies the value of the expression other into *this with automatic resizing.

*this might be resized to match the dimensions of other. If *this was a null matrix (not already initialized), it will be initialized.

Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.

See also

operator=(const MatrixBase<OtherDerived>&), _set_noalias()

Definition at line 769 of file PlainObjectBase.h.

    {
      internal::call_assignment(this->derived(), other.derived());
      return this->derived();
    }

_set_noalias()

template<typename Derived >

template<typename OtherDerived >

Derived& Eigen::PlainObjectBase< Derived >::_set_noalias ( const DenseBase< OtherDerived > &  other )

inlineprotected

Definition at line 782 of file PlainObjectBase.h.

    {
      // I don't think we need this resize call since the lazyAssign will anyways resize
      // and lazyAssign will be called by the assign selector.
      //_resize_to_match(other);
      // the 'false' below means to enforce lazy evaluation. We don't use lazyAssign() because
      // it wouldn't allow to copy a row-vector into a column-vector.
      internal::call_assignment_no_alias(this->derived(), other.derived(), internal::assign_op<Scalar,typename OtherDerived::Scalar>());
      return this->derived();
    }

base()

template<typename Derived >

const Base& Eigen::PlainObjectBase< Derived >::base ( ) const

inline

Definition at line 166 of file PlainObjectBase.h.

{ return *static_cast<const Base*>(this); }

coeff() [1/2]

template<typename Derived >

const Scalar& Eigen::PlainObjectBase< Derived >::coeff ( Index  index ) const

inline

This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details.

Definition at line 189 of file PlainObjectBase.h.

    {
      return m_storage.data()[index];
    }

coeff() [2/2]

template<typename Derived >

constexpr const Scalar& Eigen::PlainObjectBase< Derived >::coeff ( Index  rowId, Index  colId  ) const

inlineconstexpr

This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details.

Definition at line 177 of file PlainObjectBase.h.

                                                                                                        {
      if (Flags & RowMajorBit)
        return m_storage.data()[colId + rowId * m_storage.cols()];
      else  // column-major
        return m_storage.data()[rowId + colId * m_storage.rows()];
    }

coeffRef() [1/4]

template<typename Derived >

constexpr Scalar& Eigen::PlainObjectBase< Derived >::coeffRef ( Index  index )

inlineconstexpr

This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const for details.

Definition at line 209 of file PlainObjectBase.h.

{ return m_storage.data()[index]; }

coeffRef() [2/4]

template<typename Derived >

constexpr const Scalar& Eigen::PlainObjectBase< Derived >::coeffRef ( Index  index ) const

inlineconstexpr

This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). It is provided for convenience.

Definition at line 222 of file PlainObjectBase.h.

                                                                                              {
      return m_storage.data()[index];
    }

coeffRef() [3/4]

template<typename Derived >

constexpr Scalar& Eigen::PlainObjectBase< Derived >::coeffRef ( Index  rowId, Index  colId  )

inlineconstexpr

This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const for details.

Definition at line 198 of file PlainObjectBase.h.

                                                                                               {
      if (Flags & RowMajorBit)
        return m_storage.data()[colId + rowId * m_storage.cols()];
      else  // column-major
        return m_storage.data()[rowId + colId * m_storage.rows()];
    }

coeffRef() [4/4]

template<typename Derived >

constexpr const Scalar& Eigen::PlainObjectBase< Derived >::coeffRef ( Index  rowId, Index  colId  ) const

inlineconstexpr

This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). It is provided for convenience.

Definition at line 213 of file PlainObjectBase.h.

                                                                                                           {
      if (Flags & RowMajorBit)
        return m_storage.data()[colId + rowId * m_storage.cols()];
      else  // column-major
        return m_storage.data()[rowId + colId * m_storage.rows()];
    }

cols()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::PlainObjectBase< Derived >::cols ( void  ) const

inline

Definition at line 171 of file PlainObjectBase.h.

{ return m_storage.cols(); }

conservativeResize() [1/4]

template<typename Derived >

void Eigen::PlainObjectBase< Derived >::conservativeResize ( Index  rows, Index  cols  )

inline

Resizes the matrix to rows x cols while leaving old values untouched.

The method is intended for matrices of dynamic size. If you only want to change the number of rows and/or of columns, you can use conservativeResize(NoChange_t, Index) or conservativeResize(Index, NoChange_t).

Matrices are resized relative to the top-left element. In case values need to be appended to the matrix they will be uninitialized.

Definition at line 387 of file PlainObjectBase.h.

    {
      internal::conservative_resize_like_impl<Derived>::run(*this, rows, cols);
    }

conservativeResize() [2/4]

template<typename Derived >

void Eigen::PlainObjectBase< Derived >::conservativeResize ( Index  rows, NoChange_t    )

inline

Resizes the matrix to rows x cols while leaving old values untouched.

As opposed to conservativeResize(Index rows, Index cols), this version leaves the number of columns unchanged.

In case the matrix is growing, new rows will be uninitialized.

Definition at line 400 of file PlainObjectBase.h.

    {
      // Note: see the comment in conservativeResize(Index,Index)
      conservativeResize(rows, cols());
    }

conservativeResize() [3/4]

template<typename Derived >

void Eigen::PlainObjectBase< Derived >::conservativeResize ( Index  size )

inline

Resizes the vector to size while retaining old values.

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.. This method does not work for partially dynamic matrices when the static dimension is anything other than 1. For example it will not work with Matrix<double, 2, Dynamic>.

When values are appended, they will be uninitialized.

Definition at line 429 of file PlainObjectBase.h.

    {
      internal::conservative_resize_like_impl<Derived>::run(*this, size);
    }

conservativeResize() [4/4]

template<typename Derived >

void Eigen::PlainObjectBase< Derived >::conservativeResize ( NoChange_t  , Index  cols  )

inline

Resizes the matrix to rows x cols while leaving old values untouched.

As opposed to conservativeResize(Index rows, Index cols), this version leaves the number of rows unchanged.

In case the matrix is growing, new columns will be uninitialized.

Definition at line 414 of file PlainObjectBase.h.

    {
      // Note: see the comment in conservativeResize(Index,Index)
      conservativeResize(rows(), cols);
    }

conservativeResizeLike()

template<typename Derived >

template<typename OtherDerived >

void Eigen::PlainObjectBase< Derived >::conservativeResizeLike ( const DenseBase< OtherDerived > &  other )

inline

Resizes the matrix to rows x cols of other, while leaving old values untouched.

The method is intended for matrices of dynamic size. If you only want to change the number of rows and/or of columns, you can use conservativeResize(NoChange_t, Index) or conservativeResize(Index, NoChange_t).

Matrices are resized relative to the top-left element. In case values need to be appended to the matrix they will copied from other.

Definition at line 445 of file PlainObjectBase.h.

    {
      internal::conservative_resize_like_impl<Derived,OtherDerived>::run(*this, other);
    }

data() [1/2]

template<typename Derived >

Scalar* Eigen::PlainObjectBase< Derived >::data ( )

inline

Returns

a pointer to the data array of this matrix

Definition at line 265 of file PlainObjectBase.h.

    { return m_storage.data(); }

data() [2/2]

template<typename Derived >

const Scalar* Eigen::PlainObjectBase< Derived >::data ( ) const

inline

Returns

a const pointer to the data array of this matrix

Definition at line 261 of file PlainObjectBase.h.

    { return m_storage.data(); }

EIGEN_STATIC_ASSERT()

template<typename Derived >

Eigen::PlainObjectBase< Derived >::EIGEN_STATIC_ASSERT ( internal::check_implication(MaxRowsAtCompileTime==1 &&MaxColsAtCompileTime!=1,(int(Options)&RowMajor)==RowMajor)  , INVALID_MATRIX_TEMPLATE_PARAMETERS    )

inline

Definition at line 153 of file PlainObjectBase.h.

                 { return *static_cast<Base*>(this); }

lazyAssign()

template<typename Derived >

template<typename OtherDerived >

Derived& Eigen::PlainObjectBase< Derived >::lazyAssign ( const DenseBase< OtherDerived > &  other )

inline

See also

MatrixBase::lazyAssign()

Definition at line 462 of file PlainObjectBase.h.

    {
      _resize_to_match(other);
      return Base::lazyAssign(other.derived());
    }

Map() [1/12]

template<typename Derived >

static ConstMapType Eigen::PlainObjectBase< Derived >::Map ( const Scalar *  data )

inlinestatic

Definition at line 636 of file PlainObjectBase.h.

    { return ConstMapType(data); }

Map() [2/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map ( const Scalar *  data, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 663 of file PlainObjectBase.h.

    { return typename StridedConstMapType<Stride<Outer, Inner> >::type(data, stride); }

Map() [3/12]

template<typename Derived >

static ConstMapType Eigen::PlainObjectBase< Derived >::Map ( const Scalar *  data, Index  rows, Index  cols  )

inlinestatic

Definition at line 644 of file PlainObjectBase.h.

    { return ConstMapType(data, rows, cols); }

Map() [4/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map ( const Scalar *  data, Index  rows, Index  cols, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 675 of file PlainObjectBase.h.

    { return typename StridedConstMapType<Stride<Outer, Inner> >::type(data, rows, cols, stride); }

Map() [5/12]

template<typename Derived >

static ConstMapType Eigen::PlainObjectBase< Derived >::Map ( const Scalar *  data, Index  size  )

inlinestatic

Definition at line 640 of file PlainObjectBase.h.

    { return ConstMapType(data, size); }

Map() [6/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map ( const Scalar *  data, Index  size, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 669 of file PlainObjectBase.h.

    { return typename StridedConstMapType<Stride<Outer, Inner> >::type(data, size, stride); }

Map() [7/12]

template<typename Derived >

static MapType Eigen::PlainObjectBase< Derived >::Map ( Scalar *  data )

inlinestatic

Definition at line 638 of file PlainObjectBase.h.

    { return MapType(data); }

Map() [8/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map ( Scalar *  data, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 666 of file PlainObjectBase.h.

    { return typename StridedMapType<Stride<Outer, Inner> >::type(data, stride); }

Map() [9/12]

template<typename Derived >

static MapType Eigen::PlainObjectBase< Derived >::Map ( Scalar *  data, Index  rows, Index  cols  )

inlinestatic

Definition at line 646 of file PlainObjectBase.h.

    { return MapType(data, rows, cols); }

Map() [10/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map ( Scalar *  data, Index  rows, Index  cols, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 678 of file PlainObjectBase.h.

    { return typename StridedMapType<Stride<Outer, Inner> >::type(data, rows, cols, stride); }

Map() [11/12]

template<typename Derived >

static MapType Eigen::PlainObjectBase< Derived >::Map ( Scalar *  data, Index  size  )

inlinestatic

Definition at line 642 of file PlainObjectBase.h.

    { return MapType(data, size); }

Map() [12/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map ( Scalar *  data, Index  size, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 672 of file PlainObjectBase.h.

    { return typename StridedMapType<Stride<Outer, Inner> >::type(data, size, stride); }

MapAligned() [1/12]

template<typename Derived >

static ConstAlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned ( const Scalar *  data )

inlinestatic

Definition at line 649 of file PlainObjectBase.h.

    { return ConstAlignedMapType(data); }

MapAligned() [2/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned ( const Scalar *  data, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 682 of file PlainObjectBase.h.

    { return typename StridedConstAlignedMapType<Stride<Outer, Inner> >::type(data, stride); }

MapAligned() [3/12]

template<typename Derived >

static ConstAlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned ( const Scalar *  data, Index  rows, Index  cols  )

inlinestatic

Definition at line 657 of file PlainObjectBase.h.

    { return ConstAlignedMapType(data, rows, cols); }

MapAligned() [4/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned ( const Scalar *  data, Index  rows, Index  cols, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 694 of file PlainObjectBase.h.

    { return typename StridedConstAlignedMapType<Stride<Outer, Inner> >::type(data, rows, cols, stride); }

MapAligned() [5/12]

template<typename Derived >

static ConstAlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned ( const Scalar *  data, Index  size  )

inlinestatic

Definition at line 653 of file PlainObjectBase.h.

    { return ConstAlignedMapType(data, size); }

MapAligned() [6/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned ( const Scalar *  data, Index  size, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 688 of file PlainObjectBase.h.

    { return typename StridedConstAlignedMapType<Stride<Outer, Inner> >::type(data, size, stride); }

MapAligned() [7/12]

template<typename Derived >

static AlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned ( Scalar *  data )

inlinestatic

Definition at line 651 of file PlainObjectBase.h.

    { return AlignedMapType(data); }

MapAligned() [8/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned ( Scalar *  data, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 685 of file PlainObjectBase.h.

    { return typename StridedAlignedMapType<Stride<Outer, Inner> >::type(data, stride); }

MapAligned() [9/12]

template<typename Derived >

static AlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned ( Scalar *  data, Index  rows, Index  cols  )

inlinestatic

Definition at line 659 of file PlainObjectBase.h.

    { return AlignedMapType(data, rows, cols); }

MapAligned() [10/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned ( Scalar *  data, Index  rows, Index  cols, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 697 of file PlainObjectBase.h.

    { return typename StridedAlignedMapType<Stride<Outer, Inner> >::type(data, rows, cols, stride); }

MapAligned() [11/12]

template<typename Derived >

static AlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned ( Scalar *  data, Index  size  )

inlinestatic

Definition at line 655 of file PlainObjectBase.h.

    { return AlignedMapType(data, size); }

MapAligned() [12/12]

template<typename Derived >

template<int Outer, int Inner>

static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned ( Scalar *  data, Index  size, const Stride< Outer, Inner > &  stride  )

inlinestatic

Definition at line 691 of file PlainObjectBase.h.

    { return typename StridedAlignedMapType<Stride<Outer, Inner> >::type(data, size, stride); }

operator=() [1/4]

template<typename Derived >

template<typename OtherDerived >

Derived& Eigen::PlainObjectBase< Derived >::operator= ( const EigenBase< OtherDerived > &  other )

inline

Copies the generic expression other into *this.

Implementation of matrix base methods

The expression must provide a (templated) evalTo(Derived& dst) const function which does the actual job. In practice, this allows any user to write its own special matrix without having to modify MatrixBase

Returns

a reference to *this.

Definition at line 617 of file PlainObjectBase.h.

    {
      _resize_to_match(other);
      Base::operator=(other.derived());
      return this->derived();
    }

operator=() [2/4]

template<typename Derived >

Derived& Eigen::PlainObjectBase< Derived >::operator= ( const PlainObjectBase< Derived > &  other )

inline

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

Definition at line 454 of file PlainObjectBase.h.

    {
      return _set(other);
    }

operator=() [3/4]

template<typename Derived >

template<typename OtherDerived >

Derived& Eigen::PlainObjectBase< Derived >::operator= ( const ReturnByValue< OtherDerived > &  func )

inline

Definition at line 470 of file PlainObjectBase.h.

    {
      resize(func.rows(), func.cols());
      return Base::operator=(func);
    }

operator=() [4/4]

template<typename Derived >

PlainObjectBase& Eigen::PlainObjectBase< Derived >::operator= ( PlainObjectBase< Derived > &&  other )

inlineprotected

Definition at line 504 of file PlainObjectBase.h.

    {
      m_storage = std::move(other.m_storage);
      return *this;
    }

packet() [1/2]

template<typename Derived >

template<int LoadMode>

PacketScalar Eigen::PlainObjectBase< Derived >::packet ( Index  index ) const

inline

Definition at line 238 of file PlainObjectBase.h.

    {
      return internal::ploadt<PacketScalar, LoadMode>(m_storage.data() + index);
    }

packet() [2/2]

template<typename Derived >

template<int LoadMode>

PacketScalar Eigen::PlainObjectBase< Derived >::packet ( Index  rowId, Index  colId  ) const

inline

Definition at line 228 of file PlainObjectBase.h.

    {
      return internal::ploadt<PacketScalar, LoadMode>
               (m_storage.data() + (Flags & RowMajorBit
                                   ? colId + rowId * m_storage.cols()
                                   : rowId + colId * m_storage.rows()));
    }

resize() [1/4]

template<typename Derived >

constexpr void Eigen::PlainObjectBase< Derived >::resize ( Index  rows, Index  cols  )

inlineconstexpr

Resizes *this to a rows x cols matrix.

This method is intended for dynamic-size matrices, although it is legal to call it on any matrix as long as fixed dimensions are left unchanged. If you only want to change the number of rows and/or of columns, you can use resize(NoChange_t, Index), resize(Index, NoChange_t).

If the current number of coefficients of *this exactly matches the product rows * cols, then no memory allocation is performed and the current values are left unchanged. In all other cases, including shrinking, the data is reallocated and all previous values are lost.

Example:

MatrixXd m(2,3);
m << 1,2,3,4,5,6;
cout << "here's the 2x3 matrix m:" << endl << m << endl;
cout << "let's resize m to 3x2. This is a conservative resizing because 2*3==3*2." << endl;
m.resize(3,2);
cout << "here's the 3x2 matrix m:" << endl << m << endl;
cout << "now let's resize m to size 2x2. This is NOT a conservative resizing, so it becomes uninitialized:" << endl;
m.resize(2,2);
cout << m << endl;

Output:

here's the 2x3 matrix m:
1 2 3
4 5 6
let's resize m to 3x2. This is a conservative resizing because 2*3==3*2.
here's the 3x2 matrix m:
1 5
4 3
2 6
now let's resize m to size 2x2. This is NOT a conservative resizing, so it becomes uninitialized:
0 0
0 0

See also

resize(Index) for vectors, resize(NoChange_t, Index), resize(Index, NoChange_t)

Definition at line 284 of file PlainObjectBase.h.

                                                                                        {
      eigen_assert(internal::check_implication(RowsAtCompileTime!=Dynamic, rows==RowsAtCompileTime)
                   && internal::check_implication(ColsAtCompileTime!=Dynamic, cols==ColsAtCompileTime)
                   && internal::check_implication(RowsAtCompileTime==Dynamic && MaxRowsAtCompileTime!=Dynamic, rows<=MaxRowsAtCompileTime)
                   && internal::check_implication(ColsAtCompileTime==Dynamic && MaxColsAtCompileTime!=Dynamic, cols<=MaxColsAtCompileTime)
                   && rows>=0 && cols>=0 && "Invalid sizes when resizing a matrix or array.");
      internal::check_rows_cols_for_overflow<MaxSizeAtCompileTime, MaxRowsAtCompileTime, MaxColsAtCompileTime>::run(rows, cols);
      #ifdef EIGEN_INITIALIZE_COEFFS
        Index size = rows*cols;
        bool size_changed = size != this->size();
        m_storage.resize(size, rows, cols);
        if(size_changed) EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
      #else
        m_storage.resize(rows*cols, rows, cols);
      #endif
    }

resize() [2/4]

template<typename Derived >

constexpr void Eigen::PlainObjectBase< Derived >::resize ( Index  rows, NoChange_t    )

inlineconstexpr

Resizes the matrix, changing only the number of rows. For the parameter of type NoChange_t, just pass the special value NoChange as in the example below.

Example:

MatrixXd m(3,4);
m.resize(5, NoChange);
cout << "m: " << m.rows() << " rows, " << m.cols() << " cols" << endl;

Output:

m: 5 rows, 4 cols

See also

resize(Index,Index)

Definition at line 348 of file PlainObjectBase.h.

{ resize(rows, cols()); }

resize() [3/4]

template<typename Derived >

constexpr void Eigen::PlainObjectBase< Derived >::resize ( Index  size )

inlineconstexpr

Resizes *this to a vector of length size

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.. This method does not work for partially dynamic matrices when the static dimension is anything other than 1. For example it will not work with Matrix<double, 2, Dynamic>.

Example:

VectorXd v(10);
v.resize(3);
RowVector3d w;
w.resize(3); // this is legal, but has no effect
cout << "v: " << v.rows() << " rows, " << v.cols() << " cols" << endl;
cout << "w: " << w.rows() << " rows, " << w.cols() << " cols" << endl;

Output:

v: 3 rows, 1 cols
w: 1 rows, 3 cols

See also

resize(Index,Index), resize(NoChange_t, Index), resize(Index, NoChange_t)

Definition at line 312 of file PlainObjectBase.h.

                                                               {
        EIGEN_STATIC_ASSERT_VECTOR_ONLY(PlainObjectBase)
        eigen_assert(
            ((SizeAtCompileTime == Dynamic && (MaxSizeAtCompileTime == Dynamic || size <= MaxSizeAtCompileTime)) ||
             SizeAtCompileTime == size) &&
            size >= 0);
#ifdef EIGEN_INITIALIZE_COEFFS
        bool size_changed = size != this->size();
      #endif
      if(RowsAtCompileTime == 1)
        m_storage.resize(size, 1, size);
      else
        m_storage.resize(size, size, 1);
      #ifdef EIGEN_INITIALIZE_COEFFS
        if(size_changed) EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
      #endif
    }

resize() [4/4]

template<typename Derived >

constexpr void Eigen::PlainObjectBase< Derived >::resize ( NoChange_t  , Index  cols  )

inlineconstexpr

Resizes the matrix, changing only the number of columns. For the parameter of type NoChange_t, just pass the special value NoChange as in the example below.

Example:

MatrixXd m(3,4);
m.resize(NoChange, 5);
cout << "m: " << m.rows() << " rows, " << m.cols() << " cols" << endl;

Output:

m: 3 rows, 5 cols

See also

resize(Index,Index)

Definition at line 338 of file PlainObjectBase.h.

{ resize(rows(), cols); }

resizeLike()

template<typename Derived >

template<typename OtherDerived >

void Eigen::PlainObjectBase< Derived >::resizeLike ( const EigenBase< OtherDerived > &  _other )

inline

Resizes *this to have the same dimensions as other. Takes care of doing all the checking that's needed.

Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.

Definition at line 359 of file PlainObjectBase.h.

    {
      const OtherDerived& other = _other.derived();
      internal::check_rows_cols_for_overflow<MaxSizeAtCompileTime, MaxRowsAtCompileTime, MaxColsAtCompileTime>::run(other.rows(), other.cols());
      const Index othersize = other.rows()*other.cols();
      if(RowsAtCompileTime == 1)
      {
        eigen_assert(other.rows() == 1 || other.cols() == 1);
        resize(1, othersize);
      }
      else if(ColsAtCompileTime == 1)
      {
        eigen_assert(other.rows() == 1 || other.cols() == 1);
        resize(othersize, 1);
      }
      else resize(other.rows(), other.cols());
    }

rows()

template<typename Derived >

EIGEN_CONSTEXPR Index Eigen::PlainObjectBase< Derived >::rows ( void  ) const

inline

Definition at line 169 of file PlainObjectBase.h.

{ return m_storage.rows(); }

setConstant() [1/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setConstant ( Index  rows, Index  cols, const Scalar &  val  )

inline

Resizes to the given size, and sets all coefficients in this expression to the given value val.

Parameters

rows	the new number of rows
cols	the new number of columns
val	the value to which all coefficients are set

Example:

MatrixXf m;
m.setConstant(3, 3, 5);
cout << m << endl;

Output:

5 5 5
5 5 5
5 5 5

See also

MatrixBase::setConstant(const Scalar&), setConstant(Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)

Definition at line 396 of file CwiseNullaryOp.h.

{
  resize(rows, cols);
  return setConstant(val);
}

setConstant() [2/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setConstant ( Index  rows, NoChange_t  , const Scalar &  val  )

inline

Resizes to the given size, changing only the number of rows, and sets all coefficients in this expression to the given value val. For the parameter of type NoChange_t, just pass the special value NoChange.

See also

MatrixBase::setConstant(const Scalar&), setConstant(Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)

Definition at line 423 of file CwiseNullaryOp.h.

{
  return setConstant(rows, cols(), val);
}

setConstant() [3/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setConstant ( Index  size, const Scalar &  val  )

inline

Resizes to the given size, and sets all coefficients in this expression to the given value val.

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.

Example:

VectorXf v;
v.setConstant(3, 5);
cout << v << endl;

Output:

5
5
5

See also

MatrixBase::setConstant(const Scalar&), setConstant(Index,Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)

Definition at line 377 of file CwiseNullaryOp.h.

{
  resize(size);
  return setConstant(val);
}

setConstant() [4/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setConstant ( NoChange_t  , Index  cols, const Scalar &  val  )

inline

Resizes to the given size, changing only the number of columns, and sets all coefficients in this expression to the given value val. For the parameter of type NoChange_t, just pass the special value NoChange.

See also

MatrixBase::setConstant(const Scalar&), setConstant(Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)

Definition at line 410 of file CwiseNullaryOp.h.

{
  return setConstant(rows(), cols, val);
}

setOnes() [1/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setOnes ( Index  rows, Index  cols  )

inline

Resizes to the given size, and sets all coefficients in this expression to one.

Parameters

rows	the new number of rows
cols	the new number of columns

Example:

MatrixXf m;
m.setOnes(3, 3);
cout << m << endl;

Output:

1 1 1
1 1 1
1 1 1

See also

MatrixBase::setOnes(), setOnes(Index), class CwiseNullaryOp, MatrixBase::Ones()

Definition at line 761 of file CwiseNullaryOp.h.

{
  resize(rows, cols);
  return setConstant(Scalar(1));
}

setOnes() [2/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setOnes ( Index  rows, NoChange_t    )

inline

Resizes to the given size, changing only the number of rows, and sets all coefficients in this expression to one. For the parameter of type NoChange_t, just pass the special value NoChange.

See also

MatrixBase::setOnes(), setOnes(Index), setOnes(Index, Index), setOnes(NoChange_t, Index), class CwiseNullaryOp, MatrixBase::Ones()

Definition at line 775 of file CwiseNullaryOp.h.

{
  return setOnes(rows, cols());
}

setOnes() [3/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setOnes ( Index  newSize )

inline

Resizes to the given newSize, and sets all coefficients in this expression to one.

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.

Example:

VectorXf v;
v.setOnes(3);
cout << v << endl;

Output:

1
1
1

See also

MatrixBase::setOnes(), setOnes(Index,Index), class CwiseNullaryOp, MatrixBase::Ones()

Definition at line 743 of file CwiseNullaryOp.h.

{
  resize(newSize);
  return setConstant(Scalar(1));
}

setOnes() [4/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setOnes ( NoChange_t  , Index  cols  )

inline

Resizes to the given size, changing only the number of columns, and sets all coefficients in this expression to one. For the parameter of type NoChange_t, just pass the special value NoChange.

See also

MatrixBase::setOnes(), setOnes(Index), setOnes(Index, Index), setOnes(Index, NoChange_t) class CwiseNullaryOp, MatrixBase::Ones()

Definition at line 788 of file CwiseNullaryOp.h.

{
  return setOnes(rows(), cols);
}

setRandom() [1/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setRandom ( Index  rows, Index  cols  )

inline

Resizes to the given size, and sets all coefficients in this expression to random values.

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

Warning

This function is not re-entrant.

Parameters

rows	the new number of rows
cols	the new number of columns

Example:

MatrixXf m;
m.setRandom(3, 3);
cout << m << endl;

Output:

  0.68  0.597  -0.33
-0.211  0.823  0.536
 0.566 -0.605 -0.444

See also

DenseBase::setRandom(), setRandom(Index), class CwiseNullaryOp, DenseBase::Random()

Definition at line 175 of file Random.h.

{
  resize(rows, cols);
  return setRandom();
}

setRandom() [2/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setRandom ( Index  rows, NoChange_t    )

inline

Resizes to the given size, changing only the number of rows, and sets all coefficients in this expression to random values. For the parameter of type NoChange_t, just pass the special value NoChange.

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

Warning

This function is not re-entrant.

See also

DenseBase::setRandom(), setRandom(Index), setRandom(NoChange_t, Index), class CwiseNullaryOp, DenseBase::Random()

Definition at line 212 of file Random.h.

{
  return setRandom(rows, cols());
}

setRandom() [3/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setRandom ( Index  newSize )

inline

Resizes to the given newSize, and sets all coefficients in this expression to random values.

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.

Warning

This function is not re-entrant.

Example:

VectorXf v;
v.setRandom(3);
cout << v << endl;

Output:

  0.68
-0.211
 0.566

See also

DenseBase::setRandom(), setRandom(Index,Index), class CwiseNullaryOp, DenseBase::Random()

Definition at line 152 of file Random.h.

{
  resize(newSize);
  return setRandom();
}

setRandom() [4/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setRandom ( NoChange_t  , Index  cols  )

inline

Resizes to the given size, changing only the number of columns, and sets all coefficients in this expression to random values. For the parameter of type NoChange_t, just pass the special value NoChange.

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

Warning

This function is not re-entrant.

See also

DenseBase::setRandom(), setRandom(Index), setRandom(Index, NoChange_t), class CwiseNullaryOp, DenseBase::Random()

Definition at line 194 of file Random.h.

{
  return setRandom(rows(), cols);
}

setZero() [1/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setZero ( Index  rows, Index  cols  )

inline

Resizes to the given size, and sets all coefficients in this expression to zero.

Parameters

rows	the new number of rows
cols	the new number of columns

Example:

MatrixXf m;
m.setZero(3, 3);
cout << m << endl;

Output:

0 0 0
0 0 0
0 0 0

See also

DenseBase::setZero(), setZero(Index), class CwiseNullaryOp, DenseBase::Zero()

Definition at line 609 of file CwiseNullaryOp.h.

{
  resize(rows, cols);
  return setConstant(Scalar(0));
}

setZero() [2/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setZero ( Index  rows, NoChange_t    )

inline

Resizes to the given size, changing only the number of rows, and sets all coefficients in this expression to zero. For the parameter of type NoChange_t, just pass the special value NoChange.

See also

DenseBase::setZero(), setZero(Index), setZero(Index, Index), setZero(NoChange_t, Index), class CwiseNullaryOp, DenseBase::Zero()

Definition at line 636 of file CwiseNullaryOp.h.

{
  return setZero(rows, cols());
}

setZero() [3/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setZero ( Index  newSize )

inline

Resizes to the given size, and sets all coefficients in this expression to zero.

This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.

Example:

VectorXf v;
v.setZero(3);
cout << v << endl;

Output:

0
0
0

See also

DenseBase::setZero(), setZero(Index,Index), class CwiseNullaryOp, DenseBase::Zero()

Definition at line 591 of file CwiseNullaryOp.h.

{
  resize(newSize);
  return setConstant(Scalar(0));
}

setZero() [4/4]

template<typename Derived >

Derived & Eigen::PlainObjectBase< Derived >::setZero ( NoChange_t  , Index  cols  )

inline

Resizes to the given size, changing only the number of columns, and sets all coefficients in this expression to zero. For the parameter of type NoChange_t, just pass the special value NoChange.

See also

DenseBase::setZero(), setZero(Index), setZero(Index, Index), setZero(Index, NoChange_t), class CwiseNullaryOp, DenseBase::Zero()

Definition at line 623 of file CwiseNullaryOp.h.

{
  return setZero(rows(), cols);
}

writePacket() [1/2]

template<typename Derived >

template<int StoreMode>

void Eigen::PlainObjectBase< Derived >::writePacket ( Index  index, const PacketScalar &  val  )

inline

Definition at line 255 of file PlainObjectBase.h.

    {
      internal::pstoret<Scalar, PacketScalar, StoreMode>(m_storage.data() + index, val);
    }

writePacket() [2/2]

template<typename Derived >

template<int StoreMode>

void Eigen::PlainObjectBase< Derived >::writePacket ( Index  rowId, Index  colId, const PacketScalar &  val  )

inline

Definition at line 245 of file PlainObjectBase.h.

    {
      internal::pstoret<Scalar, PacketScalar, StoreMode>
              (m_storage.data() + (Flags & RowMajorBit
                                   ? colId + rowId * m_storage.cols()
                                   : rowId + colId * m_storage.rows()), val);
    }

Member Data Documentation

m_storage

template<typename Derived >

DenseStorage<Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options> Eigen::PlainObjectBase< Derived >::m_storage

protected

Definition at line 147 of file PlainObjectBase.h.

---

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

• PlainObjectBase.h
• CwiseNullaryOp.h
• Random.h