Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
PlainObjectBase< Derived > Class Template Reference

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

#include <PlainObjectBase.h>

Inherits dense_xpr_base_dispatcher_for_doxygen< Derived >.

List of all members.

Classes

struct  StridedAlignedMapType
struct  StridedConstAlignedMapType
struct  StridedConstMapType
struct  StridedMapType

Public Types

enum  { Options }
enum  { NeedsToAlign }
typedef Eigen::Map< Derived,
Aligned
AlignedMapType
typedef
internal::dense_xpr_base
< Derived >::type 
Base
typedef const Eigen::Map
< const Derived, Aligned
ConstAlignedMapType
typedef const Eigen::Map
< const Derived, Unaligned
ConstMapType
typedef Derived DenseType
typedef internal::traits
< Derived >::Index 
Index
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

Basebase ()
const Basebase () const
const Scalarcoeff (Index row, Index col) const
const Scalarcoeff (Index index) const
ScalarcoeffRef (Index row, Index col)
ScalarcoeffRef (Index index)
const ScalarcoeffRef (Index row, Index col) const
const ScalarcoeffRef (Index index) const
Index cols () const
void conservativeResize (Index rows, Index cols)
void conservativeResize (Index rows, NoChange_t)
void conservativeResize (NoChange_t, Index cols)
void conservativeResize (Index size)
template<typename OtherDerived >
void conservativeResizeLike (const DenseBase< OtherDerived > &other)
const Scalardata () const
Scalardata ()
template<typename OtherDerived >
Derived & lazyAssign (const DenseBase< OtherDerived > &other)
Derived & operator= (const PlainObjectBase &other)
template<typename OtherDerived >
Derived & operator= (const ReturnByValue< OtherDerived > &func)
template<typename OtherDerived >
Derived & operator= (const EigenBase< OtherDerived > &other)
template<int LoadMode>
PacketScalar packet (Index row, Index col) const
template<int LoadMode>
PacketScalar packet (Index index) const
 PlainObjectBase ()
 PlainObjectBase (Index size, Index rows, Index cols)
template<typename OtherDerived >
 PlainObjectBase (const EigenBase< OtherDerived > &other)
void resize (Index rows, Index cols)
void resize (Index size)
void resize (NoChange_t, Index cols)
void resize (Index rows, NoChange_t)
template<typename OtherDerived >
void resizeLike (const EigenBase< OtherDerived > &_other)
Index rows () const
Derived & setConstant (Index size, const Scalar &value)
Derived & setConstant (Index rows, Index cols, const Scalar &value)
Derived & setOnes (Index size)
Derived & setOnes (Index rows, Index cols)
Derived & setRandom (Index size)
Derived & setRandom (Index rows, Index cols)
Derived & setZero (Index size)
Derived & setZero (Index rows, Index cols)
template<int StoreMode>
void writePacket (Index row, Index col, const PacketScalar &x)
template<int StoreMode>
void writePacket (Index index, const PacketScalar &x)

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.

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 T0 , typename T1 >
void _init2 (Index rows, Index cols, typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *=0)
template<typename T0 , typename T1 >
void _init2 (const Scalar &x, const Scalar &y, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=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.
template<typename OtherDerived >
Derived & _set_noalias (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
void _set_selector (const OtherDerived &other, const internal::true_type &)
template<typename OtherDerived >
void _set_selector (const OtherDerived &other, const internal::false_type &)
template<typename OtherDerived >
void _swap (DenseBase< OtherDerived > const &other)

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 Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_PLAINOBJECTBASE_PLUGIN.

See also:
The class hierarchy

Member Typedef Documentation

typedef Eigen::Map<Derived, Aligned> AlignedMapType
typedef internal::dense_xpr_base<Derived>::type Base

Reimplemented in Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< RealScalar, Dynamic, 1 >, Matrix< int, 1, MatrixType::ColsAtCompileTime >, Matrix< int, MatrixType::RowsAtCompileTime, 1 >, Matrix< Index, MatrixType::RowsAtCompileTime, 1 >, Matrix< Scalar, 3, 1 >, Matrix< Scalar, AmbientDimAtCompileTime, 1, Options >, Matrix< internal::scalar_product_traits< Lhs::Scalar, Rhs::Scalar >::ReturnType, 1, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Matrix< Scalar, Dynamic, Dynamic >, Matrix< double, DPARM_SIZE, 1 >, Matrix< Scalar, Dynamic, 1 >, Matrix< RootType, _Deg, 1 >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< Index, Dynamic, 1 >, Matrix< int, Dynamic, 1 >, Matrix< Index, IPARM_SIZE, 1 >, Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1, Options >, Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >, Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, and Array< Index, 64, 1 >.

typedef const Eigen::Map<const Derived, Aligned> ConstAlignedMapType
typedef const Eigen::Map<const Derived, Unaligned> ConstMapType
typedef Derived DenseType
typedef internal::traits<Derived>::Index Index
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

Member Enumeration Documentation

anonymous enum
Enumerator:
Options 
anonymous enum
Enumerator:
NeedsToAlign 

Constructor & Destructor Documentation

PlainObjectBase ( ) [inline, explicit]
PlainObjectBase ( Index  size,
Index  rows,
Index  cols 
) [inline]
PlainObjectBase ( const EigenBase< OtherDerived > &  other) [inline]

Member Function Documentation

void _init2 ( Index  rows,
Index  cols,
typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *  = 0 
) [inline, protected]
void _init2 ( const Scalar x,
const Scalar y,
typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *  = 0 
) [inline, protected]
void _resize_to_match ( const EigenBase< OtherDerived > &  other) [inline, protected]
Derived& _set ( const DenseBase< OtherDerived > &  other) [inline, protected]

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

Referenced by Array< Index, 64, 1 >::operator=(), and PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=().

Derived& _set_noalias ( const DenseBase< OtherDerived > &  other) [inline, protected]
void _set_selector ( const OtherDerived &  other,
const internal::true_type &   
) [inline, protected]
void _set_selector ( const OtherDerived &  other,
const internal::false_type &   
) [inline, protected]
void _swap ( DenseBase< OtherDerived > const &  other) [inline, protected]
Base& base ( ) [inline]
const Base& base ( ) const [inline]
const Scalar& coeff ( Index  row,
Index  col 
) const [inline]
const Scalar& coeff ( Index  index) const [inline]
Scalar& coeffRef ( Index  row,
Index  col 
) [inline]
Scalar& coeffRef ( Index  index) [inline]
const Scalar& coeffRef ( Index  row,
Index  col 
) const [inline]
const Scalar& coeffRef ( Index  index) const [inline]
Index cols ( void  ) const [inline]
void 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.

Referenced by PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::conservativeResize().

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

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

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

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

const Scalar* data ( ) const [inline]
Scalar* data ( ) [inline]
Returns:
a pointer to the data array of this matrix
Derived& lazyAssign ( const DenseBase< OtherDerived > &  other) [inline]
static ConstMapType Map ( const Scalar data) [inline, static]
static MapType Map ( Scalar data) [inline, static]
static ConstMapType Map ( const Scalar data,
Index  size 
) [inline, static]
static MapType Map ( Scalar data,
Index  size 
) [inline, static]
static ConstMapType Map ( const Scalar data,
Index  rows,
Index  cols 
) [inline, static]
static MapType Map ( Scalar data,
Index  rows,
Index  cols 
) [inline, static]
static StridedConstMapType<Stride<Outer, Inner> >::type Map ( const Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedMapType<Stride<Outer, Inner> >::type Map ( Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedConstMapType<Stride<Outer, Inner> >::type Map ( const Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedMapType<Stride<Outer, Inner> >::type Map ( Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedConstMapType<Stride<Outer, Inner> >::type Map ( const Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedMapType<Stride<Outer, Inner> >::type Map ( Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static ConstAlignedMapType MapAligned ( const Scalar data) [inline, static]
static AlignedMapType MapAligned ( Scalar data) [inline, static]
static ConstAlignedMapType MapAligned ( const Scalar data,
Index  size 
) [inline, static]
static AlignedMapType MapAligned ( Scalar data,
Index  size 
) [inline, static]
static ConstAlignedMapType MapAligned ( const Scalar data,
Index  rows,
Index  cols 
) [inline, static]
static AlignedMapType MapAligned ( Scalar data,
Index  rows,
Index  cols 
) [inline, static]
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type MapAligned ( const Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedAlignedMapType<Stride<Outer, Inner> >::type MapAligned ( Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type MapAligned ( const Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedAlignedMapType<Stride<Outer, Inner> >::type MapAligned ( Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type MapAligned ( const Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
static StridedAlignedMapType<Stride<Outer, Inner> >::type MapAligned ( Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
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=.

Referenced by Array< Index, 64, 1 >::operator=(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=(), and PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::PlainObjectBase().

Derived& operator= ( const ReturnByValue< OtherDerived > &  func) [inline]

Reimplemented in Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< RealScalar, Dynamic, 1 >, Matrix< int, 1, MatrixType::ColsAtCompileTime >, Matrix< int, MatrixType::RowsAtCompileTime, 1 >, Matrix< Index, MatrixType::RowsAtCompileTime, 1 >, Matrix< Scalar, 3, 1 >, Matrix< Scalar, AmbientDimAtCompileTime, 1, Options >, Matrix< internal::scalar_product_traits< Lhs::Scalar, Rhs::Scalar >::ReturnType, 1, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Matrix< Scalar, Dynamic, Dynamic >, Matrix< double, DPARM_SIZE, 1 >, Matrix< Scalar, Dynamic, 1 >, Matrix< RootType, _Deg, 1 >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< Index, Dynamic, 1 >, Matrix< int, Dynamic, 1 >, Matrix< Index, IPARM_SIZE, 1 >, Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1, Options >, and Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >.

Derived& operator= ( const EigenBase< OtherDerived > &  other) [inline]

Copies the generic expression other into *this.

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.

Reimplemented in Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< RealScalar, Dynamic, 1 >, Matrix< int, 1, MatrixType::ColsAtCompileTime >, Matrix< int, MatrixType::RowsAtCompileTime, 1 >, Matrix< Index, MatrixType::RowsAtCompileTime, 1 >, Matrix< Scalar, 3, 1 >, Matrix< Scalar, AmbientDimAtCompileTime, 1, Options >, Matrix< internal::scalar_product_traits< Lhs::Scalar, Rhs::Scalar >::ReturnType, 1, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Matrix< Scalar, Dynamic, Dynamic >, Matrix< double, DPARM_SIZE, 1 >, Matrix< Scalar, Dynamic, 1 >, Matrix< RootType, _Deg, 1 >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< Index, Dynamic, 1 >, Matrix< int, Dynamic, 1 >, Matrix< Index, IPARM_SIZE, 1 >, Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1, Options >, Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >, Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, and Array< Index, 64, 1 >.

PacketScalar packet ( Index  row,
Index  col 
) const [inline]
PacketScalar packet ( Index  index) const [inline]
void 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:

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:
1 2
4 5
See also:
resize(Index) for vectors, resize(NoChange_t, Index), resize(Index, NoChange_t)

Referenced by Array< Index, 64, 1 >::Array(), HessenbergDecomposition< MatrixType >::compute(), Tridiagonalization< _MatrixType >::compute(), DiagonalPreconditioner< _Scalar >::factorize(), HessenbergDecomposition< MatrixType >::HessenbergDecomposition(), Eigen::internal::householder_qr_inplace_blocked(), Eigen::internal::householder_qr_inplace_unblocked(), SuperLUBase< _MatrixType, SuperILU< _MatrixType > >::initFactorization(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resize(), PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resizeLike(), and SparseMatrix< _Scalar, _Options, _Index >::sumupDuplicates().

void resize ( Index  size) [inline]

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)
void 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:

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)
void 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:

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

Referenced by PlainObjectBase< Matrix< int, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::_resize_to_match().

Index rows ( void  ) const [inline]
Derived & setConstant ( Index  size,
const Scalar value 
) [inline]

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

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&)

Referenced by AlignedBox< _Scalar, _AmbientDim >::setEmpty().

Derived & setConstant ( Index  rows,
Index  cols,
const Scalar value 
) [inline]

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

Parameters:
rowsthe new number of rows
colsthe new number of columns
valuethe 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&)
Derived & setOnes ( Index  size) [inline]

Resizes to the given size, 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()
Derived & setOnes ( Index  rows,
Index  cols 
) [inline]

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

Parameters:
rowsthe new number of rows
colsthe 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()
Derived & setRandom ( Index  size) [inline]

Resizes to the given size, and sets all coefficients in this expression to random 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.

Example:

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

Output:

0.68
-0.211
0.566
See also:
MatrixBase::setRandom(), setRandom(Index,Index), class CwiseNullaryOp, MatrixBase::Random()
Derived & setRandom ( Index  rows,
Index  cols 
) [inline]

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

Parameters:
rowsthe new number of rows
colsthe 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:
MatrixBase::setRandom(), setRandom(Index), class CwiseNullaryOp, MatrixBase::Random()
Derived & setZero ( Index  size) [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()

Referenced by main(), Translation< _Scalar, _Dim >::operator*(), Transform< _Scalar, _Dim, _Mode, _Options >::operator=(), PardisoImpl< PardisoLU< MatrixType > >::PardisoImpl(), and Eigen::internal::set_from_triplets().

Derived & setZero ( Index  rows,
Index  cols 
) [inline]

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

Parameters:
rowsthe new number of rows
colsthe 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()
void writePacket ( Index  row,
Index  col,
const PacketScalar x 
) [inline]
void writePacket ( Index  index,
const PacketScalar x 
) [inline]

Member Data Documentation

DenseStorage<Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options> m_storage [protected]

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