Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends

PlainObjectBase< Derived > Class Template Reference

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

#include <PlainObjectBase.h>

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

Base & base ()
const Base & base () const
EIGEN_STRONG_INLINE Index rows () const
EIGEN_STRONG_INLINE Index cols () const
EIGEN_STRONG_INLINE const Scalar & coeff (Index row, Index col) const
EIGEN_STRONG_INLINE const Scalar & coeff (Index index) const
EIGEN_STRONG_INLINE Scalar & coeffRef (Index row, Index col)
EIGEN_STRONG_INLINE Scalar & coeffRef (Index index)
EIGEN_STRONG_INLINE const Scalar & coeffRef (Index row, Index col) const
EIGEN_STRONG_INLINE const Scalar & coeffRef (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 Scalar * data () const
EIGEN_STRONG_INLINE Scalar * data ()
EIGEN_STRONG_INLINE 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 >
EIGEN_STRONG_INLINE void resizeLike (const EigenBase< OtherDerived > &_other)
EIGEN_STRONG_INLINE void conservativeResize (Index rows, Index cols)
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)
template<typename OtherDerived >
EIGEN_STRONG_INLINE void conservativeResizeLike (const DenseBase< OtherDerived > &other)
EIGEN_STRONG_INLINE Derived & operator= (const PlainObjectBase &other)
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 ()
 PlainObjectBase (internal::constructor_without_unaligned_array_assert)
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)
Derived & setConstant (Index rows, Index cols, const Scalar &value)
Derived & setZero (Index size)
Derived & setZero (Index rows, Index cols)
Derived & setOnes (Index size)
Derived & setOnes (Index rows, Index cols)
Derived & setRandom (Index size)
Derived & setRandom (Index rows, Index cols)

Static Public Member Functions

static EIGEN_STRONG_INLINE void _check_template_params ()
Map

These are convenience functions returning Map objects. The Map() static functions return unaligned Map objects, while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned data pointers.

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

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

Detailed Description

template<typename Derived>
class 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 TopicCustomizingEigen by defining the preprocessor symbol EIGEN_PLAINOBJECTBASE_PLUGIN.

See also:
TopicClassHierarchy

Member Typedef Documentation

template<typename Derived>
typedef Eigen::Map<Derived, Aligned> PlainObjectBase< Derived >::AlignedMapType
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 >, Matrix< Scalar, MatrixType::RowsAtCompileTime, MinSize >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< Scalar, 4, 1 >, Matrix< Scalar, HDim, HDim >, Matrix< Scalar, 3, 1 >, 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, MatrixType::ColsAtCompileTime, MatrixType::ColsAtCompileTime >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, MinSize, 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, int(AmbientDimAtCompileTime)==Dynamic?Dynamic:int(AmbientDimAtCompileTime)+1, 1 >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, and Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >.

template<typename Derived>
typedef const Eigen::Map<const Derived, Aligned> PlainObjectBase< Derived >::ConstAlignedMapType
template<typename Derived>
typedef const Eigen::Map<const Derived, Unaligned> PlainObjectBase< Derived >::ConstMapType
template<typename Derived>
typedef Derived PlainObjectBase< Derived >::DenseType
template<typename Derived>
typedef internal::traits<Derived>::Index PlainObjectBase< Derived >::Index
template<typename Derived>
typedef Eigen::Map<Derived, Unaligned> PlainObjectBase< Derived >::MapType
template<typename Derived>
typedef internal::packet_traits<Scalar>::type PlainObjectBase< Derived >::PacketScalar
template<typename Derived>
typedef NumTraits<Scalar>::Real PlainObjectBase< Derived >::RealScalar
template<typename Derived>
typedef internal::traits<Derived>::Scalar PlainObjectBase< Derived >::Scalar
template<typename Derived>
typedef internal::traits<Derived>::StorageKind PlainObjectBase< Derived >::StorageKind

Member Enumeration Documentation

template<typename Derived>
anonymous enum
Enumerator:
Options 
template<typename Derived>
anonymous enum
Enumerator:
NeedsToAlign 

Constructor & Destructor Documentation

template<typename Derived>
EIGEN_STRONG_INLINE PlainObjectBase< Derived >::PlainObjectBase (  )  [inline, explicit]
template<typename Derived>
PlainObjectBase< Derived >::PlainObjectBase ( internal::constructor_without_unaligned_array_assert   )  [inline]
template<typename Derived>
EIGEN_STRONG_INLINE PlainObjectBase< Derived >::PlainObjectBase ( Index  size,
Index  rows,
Index  cols 
) [inline]
template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE PlainObjectBase< Derived >::PlainObjectBase ( const EigenBase< OtherDerived > &  other  )  [inline]
See also:
MatrixBase::operator=(const EigenBase<OtherDerived>&)

Member Function Documentation

template<typename Derived>
static EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::_check_template_params (  )  [inline, static]
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]
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]
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()
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::false_type &   
) [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 >
void PlainObjectBase< Derived >::_swap ( DenseBase< OtherDerived > const &  other  )  [inline, protected]
template<typename Derived>
const Base& PlainObjectBase< Derived >::base (  )  const [inline]
template<typename Derived>
Base& PlainObjectBase< Derived >::base (  )  [inline]
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]
template<typename Derived>
EIGEN_STRONG_INLINE Scalar& PlainObjectBase< Derived >::coeffRef ( Index  index  )  [inline]
template<typename Derived>
EIGEN_STRONG_INLINE const Scalar& PlainObjectBase< Derived >::coeffRef ( Index  row,
Index  col 
) const [inline]
template<typename Derived>
EIGEN_STRONG_INLINE const Scalar& PlainObjectBase< Derived >::coeffRef ( Index  index  )  const [inline]
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 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.

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

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

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

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

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

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

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

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

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

Resizes the vector to size while retaining old values.

. This method does not work for partially dynamic matrices when the static dimension is anything other than 1. For example it will not work with Matrix<double, 2, Dynamic>.

When values are appended, they will be uninitialized.

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

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

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

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

template<typename Derived>
EIGEN_STRONG_INLINE Scalar* PlainObjectBase< Derived >::data (  )  [inline]
Returns:
a pointer to the data array of this matrix
template<typename Derived>
EIGEN_STRONG_INLINE const Scalar* PlainObjectBase< Derived >::data (  )  const [inline]
Returns:
a const pointer to the data array of this matrix
template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived& PlainObjectBase< Derived >::lazyAssign ( const DenseBase< OtherDerived > &  other  )  [inline]
See also:
MatrixBase::lazyAssign()
template<typename Derived>
static MapType PlainObjectBase< Derived >::Map ( Scalar *  data  )  [inline, static]
template<typename Derived>
static ConstMapType PlainObjectBase< Derived >::Map ( const Scalar *  data,
Index  size 
) [inline, static]
template<typename Derived>
static MapType PlainObjectBase< Derived >::Map ( Scalar *  data,
Index  size 
) [inline, static]
template<typename Derived>
static ConstMapType PlainObjectBase< Derived >::Map ( const Scalar *  data,
Index  rows,
Index  cols 
) [inline, static]
template<typename Derived>
static MapType PlainObjectBase< Derived >::Map ( Scalar *  data,
Index  rows,
Index  cols 
) [inline, static]
template<typename Derived>
static ConstMapType PlainObjectBase< Derived >::Map ( const Scalar *  data  )  [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedConstMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::Map ( const Scalar *  data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::Map ( Scalar *  data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedConstMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::Map ( const Scalar *  data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::Map ( Scalar *  data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedConstMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::Map ( const Scalar *  data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::Map ( Scalar *  data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::MapAligned ( const Scalar *  data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
static ConstAlignedMapType PlainObjectBase< Derived >::MapAligned ( const Scalar *  data  )  [inline, static]
template<typename Derived>
static AlignedMapType PlainObjectBase< Derived >::MapAligned ( Scalar *  data  )  [inline, static]
template<typename Derived>
static AlignedMapType PlainObjectBase< Derived >::MapAligned ( Scalar *  data,
Index  size 
) [inline, static]
template<typename Derived>
static ConstAlignedMapType PlainObjectBase< Derived >::MapAligned ( const Scalar *  data,
Index  rows,
Index  cols 
) [inline, static]
template<typename Derived>
static AlignedMapType PlainObjectBase< Derived >::MapAligned ( Scalar *  data,
Index  rows,
Index  cols 
) [inline, static]
template<typename Derived>
static ConstAlignedMapType PlainObjectBase< Derived >::MapAligned ( const Scalar *  data,
Index  size 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedAlignedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::MapAligned ( Scalar *  data,
Index  rows,
Index  cols,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::MapAligned ( const Scalar *  data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedConstAlignedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::MapAligned ( const Scalar *  data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedAlignedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::MapAligned ( Scalar *  data,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
template<int Outer, int Inner>
static StridedAlignedMapType<Stride<Outer, Inner> >::type PlainObjectBase< Derived >::MapAligned ( Scalar *  data,
Index  size,
const Stride< Outer, Inner > &  stride 
) [inline, static]
template<typename Derived>
EIGEN_STRONG_INLINE Derived& PlainObjectBase< Derived >::operator= ( const PlainObjectBase< Derived > &  other  )  [inline]

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

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, MatrixType::RowsAtCompileTime, MinSize >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< Scalar, 4, 1 >, Matrix< Scalar, HDim, HDim >, Matrix< Scalar, 3, 1 >, 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, MatrixType::ColsAtCompileTime, MatrixType::ColsAtCompileTime >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, MinSize, 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, int(AmbientDimAtCompileTime)==Dynamic?Dynamic:int(AmbientDimAtCompileTime)+1, 1 >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, and Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >.

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, MatrixType::RowsAtCompileTime, MinSize >, Matrix< Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1 >, Matrix< Scalar, 4, 1 >, Matrix< Scalar, HDim, HDim >, Matrix< Scalar, 3, 1 >, 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, MatrixType::ColsAtCompileTime, MatrixType::ColsAtCompileTime >, Matrix< Scalar, Dim, 1 >, Matrix< Scalar, MinSize, 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, int(AmbientDimAtCompileTime)==Dynamic?Dynamic:int(AmbientDimAtCompileTime)+1, 1 >, Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Matrix< Scalar, AmbientDimAtCompileTime, 1 >, and Matrix< Index, 1, ColsAtCompileTime, RowMajor, 1, MaxColsAtCompileTime >.

template<typename Derived>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar PlainObjectBase< Derived >::packet ( Index  row,
Index  col 
) const [inline]
template<typename Derived>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar PlainObjectBase< Derived >::packet ( Index  index  )  const [inline]
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) 













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) 













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) 













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) 













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. 













template<typename Derived> 

      

        

          EIGEN_STRONG_INLINE Index PlainObjectBase< Derived >::rows 
          (
          void 
          
           ) 
           const [inline]
        

      

















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













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:

  

    
rows the new number of rows 

    
cols the new number of columns 

    
value the value to which all coefficients are set

  

  




Example: 


 Output: 


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













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:

  

    
rows the new number of rows 

    
cols the new number of columns

  

  




Example: 


 Output: 


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













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













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













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:

  

    
rows the new number of rows 

    
cols the new number of columns

  

  




Example: 


 Output: 


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













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













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:

  

    
rows the new number of rows 

    
cols the new number of columns

  

  




Example: 


 Output: 


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













template<typename Derived> 



template<int StoreMode> 

      

        

          EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::writePacket 
          (
          Index 
           index, 
        

        

          
          
          const PacketScalar & 
           x 
        

        

          
          )
           [inline]
        

      

















template<typename Derived> 



template<int StoreMode> 

      

        

          EIGEN_STRONG_INLINE void PlainObjectBase< Derived >::writePacket 
          (
          Index 
           row, 
        

        

          
          
          Index 
           col, 
        

        

          
          
          const PacketScalar & 
           x 
        

        

          
          )
           [inline]
        

      











Friends And Related Function Documentation








template<typename Derived> 

      

        

          friend class Eigen::Map [friend]
        

      

















template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

          friend struct internal::matrix_swap_impl [friend]
        

      







Reimplemented in Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >.







Member Data Documentation








template<typename Derived> 

      

        

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

      











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



Generated on Thu Dec 1 2011 12:54:35 for HUMIM Tracker by 

doxygen 1.7.1