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

#include <PlainObjectBase.h>

Inheritance diagram for Eigen::PlainObjectBase< Derived >:

Classes
struct	StridedAlignedMapType

struct	StridedConstAlignedMapType

struct	StridedConstMapType

struct	StridedMapType

Public Types
enum	{ Options = internal::traits<Derived>::Options }

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

enum	{ IsPlainObjectBase = 1 }

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

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

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

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef NumTraits< Scalar >::Real	RealScalar

typedef Derived	DenseType

typedef Eigen::Map< Derived, Unaligned >	MapType

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

typedef Eigen::Map< Derived, AlignedMax >	AlignedMapType

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

Public Member Functions
EIGEN_DEVICE_FUNC Base &	base ()

EIGEN_DEVICE_FUNC const Base &	base () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rows () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	cols () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff (Index rowId, Index colId) const
	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. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff (Index index) const
	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. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId)
	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. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
	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. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeffRef (Index rowId, Index colId) const
	This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeffRef (Index index) const
	This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). More...

template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar	packet (Index rowId, Index colId) const

template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar	packet (Index index) const

template<int StoreMode>
EIGEN_STRONG_INLINE void	writePacket (Index rowId, Index colId, const PacketScalar &val)

template<int StoreMode>
EIGEN_STRONG_INLINE void	writePacket (Index index, const PacketScalar &val)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar *	data () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar *	data ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resize (Index rows, Index cols)
	Resizes `this` to a rows* x cols matrix. More...

EIGEN_DEVICE_FUNC void	resize (Index size)
	Resizes `this` to a vector of length size*. More...

EIGEN_DEVICE_FUNC void	resize (NoChange_t, Index cols)
	Resizes the matrix, changing only the number of columns. More...

EIGEN_DEVICE_FUNC void	resize (Index rows, NoChange_t)
	Resizes the matrix, changing only the number of rows. More...

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resizeLike (const EigenBase< OtherDerived > &_other)
	Resizes `this` to have the same dimensions as other*. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, Index cols)
	Resizes the matrix to rows x cols while leaving old values untouched. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, NoChange_t)
	Resizes the matrix to rows x cols while leaving old values untouched. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (NoChange_t, Index cols)
	Resizes the matrix to rows x cols while leaving old values untouched. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index size)
	Resizes the vector to size while retaining old values. More...

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResizeLike (const DenseBase< OtherDerived > &other)
	Resizes the matrix to rows x cols of `other`, while leaving old values untouched. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const PlainObjectBase &other)
	This is a special case of the templated operator=. More...

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	lazyAssign (const DenseBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const ReturnByValue< OtherDerived > &func)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const EigenBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC Derived &	setConstant (Index size, const Scalar &val)
	Resizes to the given size, and sets all coefficients in this expression to the given value val. More...

EIGEN_DEVICE_FUNC Derived &	setConstant (Index rows, Index cols, const Scalar &val)
	Resizes to the given size, and sets all coefficients in this expression to the given value val. More...

EIGEN_DEVICE_FUNC Derived &	setZero (Index size)
	Resizes to the given size, and sets all coefficients in this expression to zero. More...

EIGEN_DEVICE_FUNC Derived &	setZero (Index rows, Index cols)
	Resizes to the given size, and sets all coefficients in this expression to zero. More...

EIGEN_DEVICE_FUNC Derived &	setOnes (Index size)
	Resizes to the given newSize, and sets all coefficients in this expression to one. More...

EIGEN_DEVICE_FUNC Derived &	setOnes (Index rows, Index cols)
	Resizes to the given size, and sets all coefficients in this expression to one. More...

Derived &	setRandom (Index size)
	Resizes to the given newSize, and sets all coefficients in this expression to random values. More...

Derived &	setRandom (Index rows, Index cols)
	Resizes to the given size, and sets all coefficients in this expression to random values. More...

template<typename OtherDerived >
EIGEN_DEVICE_FUNC void	swap (DenseBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC void	swap (DenseBase< OtherDerived > const &other)

Static Public Member Functions
static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_check_template_params ()

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. 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
EIGEN_DEVICE_FUNC	PlainObjectBase (internal::constructor_without_unaligned_array_assert)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const PlainObjectBase &other)
	Copy constructor.

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (Index size, Index rows, Index cols)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const DenseBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation.

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_resize_to_match (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	_set (const DenseBase< OtherDerived > &other)
	Copies the value of the expression other into `*this` with automatic resizing. More...

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	_set_noalias (const DenseBase< OtherDerived > &other)

template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (Index rows, Index cols, typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *=0)

template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (const T0 &val0, const T1 &val1, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=0)

template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (const Index &val0, const Index &val1, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 >::type *=0)

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (Index size, typename internal::enable_if<(Base::SizeAtCompileTime!=1\|\|!internal::is_convertible< T, Scalar >::value) &&((!internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value\|\|Base::SizeAtCompileTime==Dynamic)), T >::type *=0)

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T >::type *=0)

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Index &val0, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T >::type =0)

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar *data)

template<typename T , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const DenseBase< OtherDerived > &other)

template<typename T , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const EigenBase< OtherDerived > &other)

template<typename T , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const ReturnByValue< OtherDerived > &other)

template<typename T , typename OtherDerived , int ColsAtCompileTime>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T >::type *=0)

template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Index &val0, typename internal::enable_if<(!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 >::type =0)

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

Friends
template<typename PlainObjectType , int MapOptions, typename StrideType >
class	Eigen::Map

class	Eigen::Map< Derived, Unaligned >

class	Eigen::Map< const Derived, Unaligned >

template<typename MatrixTypeA , typename MatrixTypeB , bool SwapPointers>
struct	internal::matrix_swap_impl

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.

See also: The class hierarchy

Constructor & Destructor Documentation

§ PlainObjectBase() [1/2]

template<typename Derived>

template<typename OtherDerived >

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

inlineprotected

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

§ PlainObjectBase() [2/2]

template<typename Derived>

template<typename OtherDerived >

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

inlineprotected

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

Member Function Documentation

§ _set()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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()

§ coeff() [1/2]

template<typename Derived>

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

inline

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.

§ coeff() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

§ coeffRef() [1/4]

template<typename Derived>

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

inline

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.

§ coeffRef() [2/4]

template<typename Derived>

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

inline

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.

§ coeffRef() [3/4]

template<typename Derived>

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

inline

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

It is provided for convenience.

§ coeffRef() [4/4]

template<typename Derived>

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

inline

This is the const version of coeffRef(Index) which is thus synonym of coeff(Index).

It is provided for convenience.

§ conservativeResize() [1/4]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

§ conservativeResize() [2/4]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

§ conservativeResize() [3/4]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

§ conservativeResize() [4/4]

template<typename Derived>

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

inline

Resizes the vector to size while retaining old values.

. 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.

§ conservativeResizeLike()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

§ data() [1/2]

template<typename Derived>

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

inline

Returns: a const pointer to the data array of this matrix

§ data() [2/2]

template<typename Derived>

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

inline

Returns: a pointer to the data array of this matrix

§ lazyAssign()

template<typename Derived>

template<typename OtherDerived >

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

inline

See also: MatrixBase::lazyAssign()

§ operator=() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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=.

§ operator=() [2/2]

template<typename Derived>

template<typename OtherDerived >

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

inline

§ resize() [1/4]

template<typename Derived>

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

inline

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:

Output:

See also: resize(Index) for vectors, resize(NoChange_t, Index), resize(Index, NoChange_t)

§ resize() [2/4]

template<typename Derived>

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

inline

Resizes *this to a vector of length size.

. 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:

Output:

See also: resize(Index,Index), resize(NoChange_t, Index), resize(Index, NoChange_t)

§ resize() [3/4]

template<typename Derived>

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

inline

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:

Output:

See also: resize(Index,Index)

§ resize() [4/4]

template<typename Derived>

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

inline

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:

Output:

See also: resize(Index,Index)

§ resizeLike()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

§ setConstant() [1/2]

template<typename Derived >

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

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

Example:

Output:

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

§ setConstant() [2/2]

template<typename Derived >

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

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:

Output:

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

§ setOnes() [1/2]

template<typename Derived >

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

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

Example:

Output:

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

§ setOnes() [2/2]

template<typename Derived >

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

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:

Output:

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

§ setRandom() [1/2]

template<typename Derived >

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

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.

Example:

Output:

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

§ setRandom() [2/2]

template<typename Derived >

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

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.

Parameters

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

Example:

Output:

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

§ setZero() [1/2]

template<typename Derived >

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

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

Example:

Output:

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

§ setZero() [2/2]

template<typename Derived >

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

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:

Output:

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

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

third-party-libs/eigen3/Eigen/src/Core/PlainObjectBase.h
third-party-libs/eigen3/Eigen/src/Core/CwiseNullaryOp.h
third-party-libs/eigen3/Eigen/src/Core/Random.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

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

Constructor & Destructor Documentation

§ PlainObjectBase() [1/2]

§ PlainObjectBase() [2/2]

Member Function Documentation

§ _set()

§ coeff() [1/2]

§ coeff() [2/2]

§ coeffRef() [1/4]

§ coeffRef() [2/4]

§ coeffRef() [3/4]

§ coeffRef() [4/4]

§ conservativeResize() [1/4]

§ conservativeResize() [2/4]

§ conservativeResize() [3/4]

§ conservativeResize() [4/4]

§ conservativeResizeLike()

§ data() [1/2]

§ data() [2/2]

§ lazyAssign()

§ operator=() [1/2]

§ operator=() [2/2]

§ resize() [1/4]

§ resize() [2/4]

§ resize() [3/4]

§ resize() [4/4]

§ resizeLike()

§ setConstant() [1/2]

§ setConstant() [2/2]

§ setOnes() [1/2]

§ setOnes() [2/2]

§ setRandom() [1/2]

§ setRandom() [2/2]

§ setZero() [1/2]

§ setZero() [2/2]

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