Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Friends

PlainObjectBase< Derived > Class Template Reference


Detailed Description

template<typename Derived>
class PlainObjectBase< Derived >

Dense storage base class for matrices and arrays.

See also:
TopicClassHierarchy

Definition at line 48 of file PlainObjectBase.h.

#include <src/Core/PlainObjectBase.h>

Inheritance diagram for PlainObjectBase< Derived >:
Inheritance graph
[legend]

List of all members.

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 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 *this to a rows x cols matrix while leaving old values of *this untouched.
EIGEN_STRONG_INLINE void conservativeResize (Index rows, NoChange_t)
EIGEN_STRONG_INLINE void conservativeResize (NoChange_t, Index cols)
EIGEN_STRONG_INLINE void conservativeResize (Index size)
 Resizes *this to a vector of length size while retaining old values of *this.
template<typename OtherDerived >
EIGEN_STRONG_INLINE void conservativeResizeLike (const DenseBase< OtherDerived > &other)
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)

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

template<typename Derived>
typedef Eigen::Map<Derived, Aligned> PlainObjectBase< Derived >::AlignedMapType

Definition at line 74 of file PlainObjectBase.h.

template<typename Derived>
typedef internal::dense_xpr_base<Derived>::type PlainObjectBase< Derived >::Base

Reimplemented in Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, GeneralProduct< Lhs, Rhs, InnerProduct >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< Scalar, 3, 1 >, Matrix< internal::scalar_product_traits< Lhs::Scalar, Rhs::Scalar >::ReturnType, 1, 1 >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, ColsAtCompileTime >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Matrix< DenseIndex, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1 >, Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1 >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Matrix< Index, Dynamic, 1 >, Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< int, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1 >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Matrix< Scalar, DataRowsAtCompileTime, ColsAtCompileTime, Options &RowMajor?RowMajor:ColMajor >, Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >, and Matrix< Scalar, Rows, HDim >.

Definition at line 52 of file PlainObjectBase.h.

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

Definition at line 76 of file PlainObjectBase.h.

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

Definition at line 72 of file PlainObjectBase.h.

template<typename Derived>
typedef internal::traits<Derived>::Index PlainObjectBase< Derived >::Index

Definition at line 55 of file PlainObjectBase.h.

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

Definition at line 70 of file PlainObjectBase.h.

template<typename Derived>
typedef internal::packet_traits<Scalar>::type PlainObjectBase< Derived >::PacketScalar

Definition at line 57 of file PlainObjectBase.h.

template<typename Derived>
typedef NumTraits<Scalar>::Real PlainObjectBase< Derived >::RealScalar

Definition at line 58 of file PlainObjectBase.h.

template<typename Derived>
typedef internal::traits<Derived>::Scalar PlainObjectBase< Derived >::Scalar

Definition at line 56 of file PlainObjectBase.h.

template<typename Derived>
typedef internal::traits<Derived>::StorageKind PlainObjectBase< Derived >::StorageKind

Definition at line 54 of file PlainObjectBase.h.


Member Enumeration Documentation

template<typename Derived>
anonymous enum
Enumerator:
Options 

Definition at line 51 of file PlainObjectBase.h.

template<typename Derived>
anonymous enum
Enumerator:
NeedsToAlign 

Definition at line 82 of file PlainObjectBase.h.

template<typename Derived>
anonymous enum [private]
Enumerator:
ThisConstantIsPrivateInPlainObjectBase 

Definition at line 553 of file PlainObjectBase.h.


Constructor & Destructor Documentation

template<typename Derived>
EIGEN_STRONG_INLINE PlainObjectBase< Derived >::PlainObjectBase ( ) [inline, explicit]

Definition at line 343 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE PlainObjectBase< Derived >::PlainObjectBase ( Index  size,
Index  rows,
Index  cols 
) [inline]

Definition at line 359 of file PlainObjectBase.h.

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

Member Function Documentation

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

Definition at line 507 of file PlainObjectBase.h.

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

Definition at line 515 of file PlainObjectBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::_resize_to_match ( const EigenBase< OtherDerived > &  other) [inline, protected]
template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& PlainObjectBase< 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()

Definition at line 478 of file PlainObjectBase.h.

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

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

Definition at line 488 of file PlainObjectBase.h.

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

Definition at line 529 of file PlainObjectBase.h.

template<typename Derived>
const Base& PlainObjectBase< Derived >::base ( ) const [inline]

Definition at line 87 of file PlainObjectBase.h.

template<typename Derived>
Base& PlainObjectBase< Derived >::base ( ) [inline]

Definition at line 86 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const Scalar& PlainObjectBase< Derived >::coeff ( Index  row,
Index  col 
) const [inline]
template<typename Derived>
EIGEN_STRONG_INLINE const Scalar& PlainObjectBase< Derived >::coeff ( Index  index) const [inline]

Definition at line 100 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE Scalar& PlainObjectBase< Derived >::coeffRef ( Index  index) [inline]

Definition at line 113 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const Scalar& PlainObjectBase< Derived >::coeffRef ( Index  row,
Index  col 
) const [inline]

Definition at line 118 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const Scalar& PlainObjectBase< Derived >::coeffRef ( Index  index) const [inline]

Definition at line 126 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE Scalar& PlainObjectBase< Derived >::coeffRef ( Index  row,
Index  col 
) [inline]
template<typename Derived>
EIGEN_STRONG_INLINE Index PlainObjectBase< Derived >::cols ( void  ) const [inline]
template<typename Derived>
EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::conservativeResize ( Index  rows,
Index  cols 
) [inline]

Resizes *this to a rows x cols matrix while leaving old values of *this untouched.

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

The top-left part of the resized matrix will be the same as the overlapping top-left corner of *this. In case values need to be appended to the matrix they will be uninitialized.

Definition at line 284 of file PlainObjectBase.h.

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

template<typename Derived>
EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::conservativeResize ( Index  rows,
NoChange_t   
) [inline]

Definition at line 289 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::conservativeResize ( NoChange_t  ,
Index  cols 
) [inline]

Definition at line 295 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::conservativeResize ( Index  size) [inline]

Resizes *this to a vector of length size while retaining old values of *this.

. 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 309 of file PlainObjectBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::conservativeResizeLike ( const DenseBase< OtherDerived > &  other) [inline]

Definition at line 315 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE Scalar* PlainObjectBase< Derived >::data ( ) [inline]
Returns:
a pointer to the data array of this matrix

Definition at line 166 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE const Scalar* PlainObjectBase< Derived >::data ( ) const [inline]
Returns:
a const pointer to the data array of this matrix

Definition at line 162 of file PlainObjectBase.h.

Referenced by internal::UpperBidiagonalization< _MatrixType >::compute(), and Transform< _Scalar, _Dim, _Mode >::data().

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

Definition at line 330 of file PlainObjectBase.h.

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

template<typename Derived>
static MapType PlainObjectBase< Derived >::Map ( Scalar data) [inline, static]

Definition at line 398 of file PlainObjectBase.h.

template<typename Derived>
static ConstMapType PlainObjectBase< Derived >::Map ( const Scalar data,
Index  size 
) [inline, static]

Definition at line 400 of file PlainObjectBase.h.

template<typename Derived>
static MapType PlainObjectBase< Derived >::Map ( Scalar data,
Index  size 
) [inline, static]

Definition at line 402 of file PlainObjectBase.h.

template<typename Derived>
static ConstMapType PlainObjectBase< Derived >::Map ( const Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 404 of file PlainObjectBase.h.

template<typename Derived>
static MapType PlainObjectBase< Derived >::Map ( Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 406 of file PlainObjectBase.h.

template<typename Derived>
static ConstMapType PlainObjectBase< Derived >::Map ( const Scalar data) [inline, static]

Definition at line 396 of file PlainObjectBase.h.

template<typename Derived>
static ConstAlignedMapType PlainObjectBase< Derived >::MapAligned ( const Scalar data) [inline, static]

Definition at line 409 of file PlainObjectBase.h.

template<typename Derived>
static AlignedMapType PlainObjectBase< Derived >::MapAligned ( Scalar data) [inline, static]

Definition at line 411 of file PlainObjectBase.h.

template<typename Derived>
static AlignedMapType PlainObjectBase< Derived >::MapAligned ( Scalar data,
Index  size 
) [inline, static]

Definition at line 415 of file PlainObjectBase.h.

template<typename Derived>
static ConstAlignedMapType PlainObjectBase< Derived >::MapAligned ( const Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 417 of file PlainObjectBase.h.

template<typename Derived>
static AlignedMapType PlainObjectBase< Derived >::MapAligned ( Scalar data,
Index  rows,
Index  cols 
) [inline, static]

Definition at line 419 of file PlainObjectBase.h.

template<typename Derived>
static ConstAlignedMapType PlainObjectBase< Derived >::MapAligned ( const Scalar data,
Index  size 
) [inline, static]

Definition at line 413 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE Derived& PlainObjectBase< Derived >::operator= ( const PlainObjectBase< Derived > &  other) [inline]
template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& 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< Scalar, 3, 1 >, Matrix< internal::scalar_product_traits< Lhs::Scalar, Rhs::Scalar >::ReturnType, 1, 1 >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, ColsAtCompileTime >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Matrix< DenseIndex, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1 >, Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1 >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Matrix< Index, Dynamic, 1 >, Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< int, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1 >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Matrix< Scalar, DataRowsAtCompileTime, ColsAtCompileTime, Options &RowMajor?RowMajor:ColMajor >, Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >, and Matrix< Scalar, Rows, HDim >.

Definition at line 337 of file PlainObjectBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& PlainObjectBase< 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 Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< Scalar, 3, 1 >, Matrix< internal::scalar_product_traits< Lhs::Scalar, Rhs::Scalar >::ReturnType, 1, 1 >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, ColsAtCompileTime >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Matrix< DenseIndex, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1 >, Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1 >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Matrix< Index, Dynamic, 1 >, Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< int, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1 >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Matrix< Scalar, DataRowsAtCompileTime, ColsAtCompileTime, Options &RowMajor?RowMajor:ColMajor >, Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >, and Matrix< Scalar, Rows, HDim >.

Definition at line 369 of file PlainObjectBase.h.

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

Definition at line 141 of file PlainObjectBase.h.

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

Definition at line 132 of file PlainObjectBase.h.

template<typename Derived>
EIGEN_STRONG_INLINE void 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)

Definition at line 185 of file PlainObjectBase.h.

Referenced by HessenbergDecomposition< MatrixType >::_compute(), Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array(), Tridiagonalization< _MatrixType >::compute(), RealSchur< MatrixType >::compute(), HessenbergDecomposition< MatrixType >::compute(), HessenbergDecomposition< MatrixType >::HessenbergDecomposition(), internal::householder_qr_inplace_blocked(), internal::householder_qr_inplace_unblocked(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::operator=(), Transpositions< RowsAtCompileTime, MaxRowsAtCompileTime >::resize(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resize(), PermutationMatrix< RowsAtCompileTime, MaxRowsAtCompileTime >::resize(), and PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resizeLike().

template<typename Derived>
void 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)

Definition at line 208 of file PlainObjectBase.h.

template<typename Derived>
void 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)

Definition at line 245 of file PlainObjectBase.h.

template<typename Derived>
void 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)

Definition at line 232 of file PlainObjectBase.h.

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE void 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 258 of file PlainObjectBase.h.

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

template<typename Derived>
EIGEN_STRONG_INLINE Index PlainObjectBase< Derived >::rows ( void  ) const [inline]
template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< 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.

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 374 of file CwiseNullaryOp.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 355 of file CwiseNullaryOp.h.

Referenced by RealSchur< MatrixType >::computeShift(), and AlignedBox< _Scalar, _AmbientDim >::setEmpty().

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 630 of file CwiseNullaryOp.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 648 of file CwiseNullaryOp.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 157 of file Random.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 139 of file Random.h.

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 504 of file CwiseNullaryOp.h.

Referenced by Transform< _Scalar, _Dim, _Mode >::operator=().

template<typename Derived >
EIGEN_STRONG_INLINE Derived & PlainObjectBase< Derived >::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 522 of file CwiseNullaryOp.h.

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

Definition at line 147 of file PlainObjectBase.h.

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

Definition at line 156 of file PlainObjectBase.h.


Friends And Related Function Documentation

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

Definition at line 75 of file PlainObjectBase.h.

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

Definition at line 71 of file PlainObjectBase.h.

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

Definition at line 73 of file PlainObjectBase.h.

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

Definition at line 69 of file PlainObjectBase.h.

template<typename Derived>
friend struct internal::matrix_swap_impl [friend]

Member Data Documentation

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



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011