Main MRPT website > C++ reference
MRPT logo
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Friends
Eigen::PlainObjectBase Class Reference

Detailed Description

Dense storage base class for matrices and arrays.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_PLAINOBJECTBASE_PLUGIN.

See also:
TopicClassHierarchy
Inheritance diagram for Eigen::PlainObjectBase:
Inheritance graph
[legend]

List of all members.

Classes

struct  StridedAlignedMapType
struct  StridedConstAlignedMapType
struct  StridedConstMapType
struct  StridedMapType

Public Types

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

Public Member Functions

Basebase ()
const Basebase () const
EIGEN_STRONG_INLINE Index rows () const
EIGEN_STRONG_INLINE Index cols () const
EIGEN_STRONG_INLINE const Scalarcoeff (Index row, Index col) const
EIGEN_STRONG_INLINE const Scalarcoeff (Index index) const
EIGEN_STRONG_INLINE ScalarcoeffRef (Index row, Index col)
EIGEN_STRONG_INLINE ScalarcoeffRef (Index index)
EIGEN_STRONG_INLINE const ScalarcoeffRef (Index row, Index col) const
EIGEN_STRONG_INLINE const ScalarcoeffRef (Index index) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index row, Index col) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index index) const
template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket (Index row, Index col, const PacketScalar &x)
template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket (Index index, const PacketScalar &x)
EIGEN_STRONG_INLINE const Scalardata () const
EIGEN_STRONG_INLINE Scalardata ()
EIGEN_STRONG_INLINE void resize (Index rows, Index cols)
 Resizes *this to a rows x cols matrix.
void resize (Index size)
 Resizes *this to a vector of length size.
void resize (NoChange_t, Index cols)
 Resizes the matrix, changing only the number of columns.
void resize (Index rows, NoChange_t)
 Resizes the matrix, changing only the number of rows.
template<typename OtherDerived >
EIGEN_STRONG_INLINE void resizeLike (const EigenBase< OtherDerived > &_other)
 Resizes *this to have the same dimensions as other.
EIGEN_STRONG_INLINE void conservativeResize (Index rows, Index cols)
 Resizes the matrix to rows x cols while leaving old values untouched.
EIGEN_STRONG_INLINE void conservativeResize (Index rows, NoChange_t)
 Resizes the matrix to rows x cols while leaving old values untouched.
EIGEN_STRONG_INLINE void conservativeResize (NoChange_t, Index cols)
 Resizes the matrix to rows x cols while leaving old values untouched.
EIGEN_STRONG_INLINE void conservativeResize (Index size)
 Resizes the vector to size while retaining old values.
template<typename OtherDerived >
EIGEN_STRONG_INLINE void conservativeResizeLike (const DenseBase< OtherDerived > &other)
 Resizes the matrix to rows x cols of other, while leaving old values untouched.
EIGEN_STRONG_INLINE Derived & operator= (const PlainObjectBase &other)
 This is a special case of the templated operator=.
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & lazyAssign (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & operator= (const ReturnByValue< OtherDerived > &func)
EIGEN_STRONG_INLINE PlainObjectBase ()
EIGEN_STRONG_INLINE PlainObjectBase (Index size, Index rows, Index cols)
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & operator= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE PlainObjectBase (const EigenBase< OtherDerived > &other)
Derived & setConstant (Index size, const Scalar &value)
 Resizes to the given size, and sets all coefficients in this expression to the given value.
Derived & setConstant (Index rows, Index cols, const Scalar &value)
 Resizes to the given size, and sets all coefficients in this expression to the given value.
Derived & setZero (Index size)
 Resizes to the given size, and sets all coefficients in this expression to zero.
Derived & setZero (Index rows, Index cols)
 Resizes to the given size, and sets all coefficients in this expression to zero.
Derived & setOnes (Index size)
 Resizes to the given size, and sets all coefficients in this expression to one.
Derived & setOnes (Index rows, Index cols)
 Resizes to the given size, and sets all coefficients in this expression to one.
Derived & setRandom (Index size)
 Resizes to the given size, and sets all coefficients in this expression to random values.
Derived & setRandom (Index rows, Index cols)
 Resizes to the given size, and sets all coefficients in this expression to random values.

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.

These methods do not allow to specify strides. If you need to specify strides, you have to use the Map class directly.

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 OtherDerived >
EIGEN_STRONG_INLINE void _resize_to_match (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & _set (const DenseBase< OtherDerived > &other)
 Copies the value of the expression other into *this with automatic resizing.
template<typename OtherDerived >
EIGEN_STRONG_INLINE void _set_selector (const OtherDerived &other, const internal::true_type &)
template<typename OtherDerived >
EIGEN_STRONG_INLINE void _set_selector (const OtherDerived &other, const internal::false_type &)
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived & _set_noalias (const DenseBase< OtherDerived > &other)
template<typename T0 , typename T1 >
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_STRONG_INLINE void _init2 (const Scalar &x, const Scalar &y, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=0)
template<typename OtherDerived >
void _swap (DenseBase< OtherDerived > const &other)

Protected Attributes

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

Private Types

enum  { ThisConstantIsPrivateInPlainObjectBase }

Friends

class Eigen::Map
class Eigen::Map< Derived, Unaligned >
class Eigen::Map< const Derived, Unaligned >
class Eigen::Map< Derived, Aligned >
class Eigen::Map< const Derived, Aligned >
struct internal::matrix_swap_impl

Member Typedef Documentation

Definition at line 81 of file Core.

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

Definition at line 83 of file Core.

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

Definition at line 79 of file Core.

Definition at line 64 of file Core.

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

Definition at line 60 of file Core.

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

Definition at line 77 of file Core.

Definition at line 62 of file Core.

Definition at line 63 of file Core.

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

Definition at line 61 of file Core.

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

Definition at line 59 of file Core.


Member Enumeration Documentation

anonymous enum
Enumerator:
Options 

Definition at line 56 of file Core.

anonymous enum
Enumerator:
NeedsToAlign 

Definition at line 94 of file Core.

anonymous enum [private]
Enumerator:
ThisConstantIsPrivateInPlainObjectBase 

Definition at line 630 of file Core.


Constructor & Destructor Documentation

EIGEN_STRONG_INLINE Eigen::PlainObjectBase::PlainObjectBase ( ) [inline, explicit]

Definition at line 382 of file Core.

EIGEN_STRONG_INLINE Eigen::PlainObjectBase::PlainObjectBase ( Index  size,
Index  rows,
Index  cols 
) [inline]

Definition at line 398 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE Eigen::PlainObjectBase::PlainObjectBase ( const EigenBase< OtherDerived > &  other) [inline]
See also:
MatrixBase::operator=(const EigenBase<OtherDerived>&)

Definition at line 417 of file Core.


Member Function Documentation

template<typename T0 , typename T1 >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_init2 ( Index  rows,
Index  cols,
typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *  = 0 
) [inline, protected]

Definition at line 584 of file Core.

template<typename T0 , typename T1 >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_init2 ( const Scalar x,
const Scalar y,
typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *  = 0 
) [inline, protected]

Definition at line 592 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_resize_to_match ( const EigenBase< OtherDerived > &  other) [inline, protected]

Definition at line 529 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::_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()

Definition at line 555 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::_set_noalias ( const DenseBase< OtherDerived > &  other) [inline, protected]

Definition at line 573 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_set_selector ( const OtherDerived &  other,
const internal::true_type  
) [inline, protected]

Definition at line 562 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_set_selector ( const OtherDerived &  other,
const internal::false_type  
) [inline, protected]

Definition at line 565 of file Core.

template<typename OtherDerived >
void Eigen::PlainObjectBase::_swap ( DenseBase< OtherDerived > const &  other) [inline, protected]

Definition at line 606 of file Core.

Base& Eigen::PlainObjectBase::base ( ) [inline]

Definition at line 98 of file Core.

const Base& Eigen::PlainObjectBase::base ( ) const [inline]

Definition at line 99 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeff ( Index  row,
Index  col 
) const [inline]

Definition at line 104 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeff ( Index  index) const [inline]

Definition at line 112 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase::coeffRef ( Index  row,
Index  col 
) [inline]

Definition at line 117 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase::coeffRef ( Index  index) [inline]

Definition at line 125 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeffRef ( Index  row,
Index  col 
) const [inline]

Definition at line 130 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeffRef ( Index  index) const [inline]

Definition at line 138 of file Core.

EIGEN_STRONG_INLINE Index Eigen::PlainObjectBase::cols ( void  ) const [inline]

Definition at line 102 of file Core.

Referenced by mrpt::math::operator>>().

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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 300 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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 312 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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 325 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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.

Definition at line 339 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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 354 of file Core.

EIGEN_STRONG_INLINE const Scalar* Eigen::PlainObjectBase::data ( ) const [inline]
Returns:
a const pointer to the data array of this matrix

Definition at line 178 of file Core.

EIGEN_STRONG_INLINE Scalar* Eigen::PlainObjectBase::data ( ) [inline]
Returns:
a pointer to the data array of this matrix

Definition at line 182 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::lazyAssign ( const DenseBase< OtherDerived > &  other) [inline]
See also:
MatrixBase::lazyAssign()

Definition at line 369 of file Core.

static ConstMapType Eigen::PlainObjectBase::Map ( const Scalar data) [inline, static]

Definition at line 435 of file Core.

static MapType Eigen::PlainObjectBase::Map ( Scalar data) [inline, static]

Definition at line 437 of file Core.

static ConstMapType Eigen::PlainObjectBase::Map ( const Scalar data,
Index  size 
) [inline, static]

Definition at line 439 of file Core.

static MapType Eigen::PlainObjectBase::Map ( Scalar data,
Index  size 
) [inline, static]

Definition at line 441 of file Core.

static ConstMapType Eigen::PlainObjectBase::Map ( const Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 443 of file Core.

static MapType Eigen::PlainObjectBase::Map ( Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 445 of file Core.

template<int Outer, int Inner>
static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map ( const Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 462 of file Core.

template<int Outer, int Inner>
static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map ( Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 465 of file Core.

template<int Outer, int Inner>
static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map ( const Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 468 of file Core.

template<int Outer, int Inner>
static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map ( Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 471 of file Core.

template<int Outer, int Inner>
static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map ( const Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 474 of file Core.

template<int Outer, int Inner>
static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map ( Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 477 of file Core.

static ConstAlignedMapType Eigen::PlainObjectBase::MapAligned ( const Scalar data) [inline, static]

Definition at line 448 of file Core.

static AlignedMapType Eigen::PlainObjectBase::MapAligned ( Scalar data) [inline, static]

Definition at line 450 of file Core.

static ConstAlignedMapType Eigen::PlainObjectBase::MapAligned ( const Scalar data,
Index  size 
) [inline, static]

Definition at line 452 of file Core.

static AlignedMapType Eigen::PlainObjectBase::MapAligned ( Scalar data,
Index  size 
) [inline, static]

Definition at line 454 of file Core.

static ConstAlignedMapType Eigen::PlainObjectBase::MapAligned ( const Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 456 of file Core.

static AlignedMapType Eigen::PlainObjectBase::MapAligned ( Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 458 of file Core.

template<int Outer, int Inner>
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned ( const Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 481 of file Core.

template<int Outer, int Inner>
static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned ( Scalar data,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 484 of file Core.

template<int Outer, int Inner>
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned ( const Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 487 of file Core.

template<int Outer, int Inner>
static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned ( Scalar data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 490 of file Core.

template<int Outer, int Inner>
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned ( const Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 493 of file Core.

template<int Outer, int Inner>
static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned ( Scalar data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]

Definition at line 496 of file Core.

EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::operator= ( const PlainObjectBase 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 362 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::operator= ( const ReturnByValue< OtherDerived > &  func) [inline]

Reimplemented in Eigen::Matrix.

Definition at line 376 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::operator= ( const EigenBase< OtherDerived > &  other) [inline]

Reimplemented in Eigen::Matrix, and Eigen::Array.

Definition at line 408 of file Core.

template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar Eigen::PlainObjectBase::packet ( Index  row,
Index  col 
) const [inline]

Definition at line 145 of file Core.

template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar Eigen::PlainObjectBase::packet ( Index  index) const [inline]

Definition at line 155 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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)

Definition at line 201 of file Core.

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

Definition at line 224 of file Core.

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

Definition at line 248 of file Core.

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

Definition at line 261 of file Core.

template<typename OtherDerived >
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::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 274 of file Core.

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

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

Example:

Output:

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

Definition at line 359 of file Core.

EIGEN_STRONG_INLINE Derived & Eigen::PlainObjectBase::setConstant ( Index  rows,
Index  cols,
const Scalar value 
)

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:

Output:

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

Definition at line 378 of file Core.

EIGEN_STRONG_INLINE Derived & Eigen::PlainObjectBase::setOnes ( Index  size)

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

Example:

Output:

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

Definition at line 634 of file Core.

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

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:

Output:

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

Definition at line 652 of file Core.

EIGEN_STRONG_INLINE Derived & Eigen::PlainObjectBase::setRandom ( Index  size)

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

Example:

Output:

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

Definition at line 140 of file Core.

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

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:

Output:

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

Definition at line 158 of file Core.

EIGEN_STRONG_INLINE Derived & Eigen::PlainObjectBase::setZero ( Index  size)

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

Definition at line 508 of file Core.

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

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:

Output:

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

Definition at line 526 of file Core.

template<int StoreMode>
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::writePacket ( Index  row,
Index  col,
const PacketScalar x 
) [inline]

Definition at line 162 of file Core.

template<int StoreMode>
EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::writePacket ( Index  index,
const PacketScalar x 
) [inline]

Definition at line 172 of file Core.


Friends And Related Function Documentation

friend class Eigen::Map [friend]

Definition at line 75 of file Core.

friend class Eigen::Map< const Derived, Aligned > [friend]

Definition at line 82 of file Core.

friend class Eigen::Map< const Derived, Unaligned > [friend]

Definition at line 78 of file Core.

friend class Eigen::Map< Derived, Aligned > [friend]

Definition at line 80 of file Core.

friend class Eigen::Map< Derived, Unaligned > [friend]

Definition at line 76 of file Core.

friend struct internal::matrix_swap_impl [friend]

Reimplemented in Eigen::Array.

Definition at line 600 of file Core.


Member Data Documentation

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

Definition at line 91 of file Core.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011