Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::PlainObjectBase< Derived > Class Template Reference

#include <PlainObjectBase.h>

Inherits type< Derived >.

Inherited by Eigen::Array< bool, Eigen::Dynamic, 1 >, Eigen::Array< double, DPARM_SIZE, 1 >, Eigen::Array< double, UMFPACK_CONTROL, 1 >, Eigen::Array< double, UMFPACK_INFO, 1 >, Eigen::Array< Index, 1, Dynamic >, Eigen::Array< int, IPARM_SIZE, 1 >, Eigen::Array< RealScalar, Dynamic, 1 >, Eigen::Array< Scalar, Eigen::Dynamic, 1 >, Eigen::Array< StorageIndex, 2, 1 >, Eigen::Array< StorageIndex, 64, 1, DontAlign >, Eigen::Array< unsigned char, Eigen::Dynamic, 1 >, Eigen::Matrix< Complex, Eigen::Dynamic, 1 >, Eigen::Matrix< Complex, Eigen::Dynamic, Eigen::Dynamic >, Eigen::Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &(~RowMajor), MaxColsAtCompileTime, 1 >, Eigen::Matrix< ComplexScalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Eigen::Matrix< ComplexScalar, Dynamic, Dynamic, 0, MatrixType::RowsAtCompileTime, MatrixType::ColsAtCompileTime >, Eigen::Matrix< ComplexScalar, RowsAtCompileTime, ColsAtCompileTime, Options, MaxRowsAtCompileTime, MaxColsAtCompileTime >, Eigen::Matrix< double, 12, 1 >, Eigen::Matrix< double, 15, 15 >, Eigen::Matrix< double, 9, 3 >, Eigen::Matrix< double, 9, 9 >, Eigen::Matrix< double, dim, 1 >, Eigen::Matrix< double, Dim, 1 >, Eigen::Matrix< double, N, 1 >, Eigen::Matrix< double, N, N >, Eigen::Matrix< double, Rot::dimension, Rot::dimension >, Eigen::Matrix< Eigen::Triplet, N, 1, Eigen::DontAlign >, Eigen::Matrix< float, 2, 2, DontAlign >, Eigen::Matrix< float, 8, 1 >, Eigen::Matrix< Index, Eigen::Dynamic, 1 >, Eigen::Matrix< int, 1, MatrixType::ColsAtCompileTime >, Eigen::Matrix< int, MatrixType::RowsAtCompileTime, 1 >, Eigen::Matrix< RealScalar, Dynamic, 1 >, Eigen::Matrix< RealScalar, Dynamic, Dynamic, ColMajor >, Eigen::Matrix< RootType, _Deg, 1 >, Eigen::Matrix< Scalar, 1, RowsAtCompileTime, RowMajor, 1, MaxRowsAtCompileTime >, Eigen::Matrix< Scalar, 1, Size, Options|RowMajor, 1, MaxSize >, Eigen::Matrix< Scalar, 3, 1 >, Eigen::Matrix< Scalar, 3, Eigen::Dynamic >, Eigen::Matrix< Scalar, AmbientDimAtCompileTime, 1 >, Eigen::Matrix< Scalar, AmbientDimAtCompileTime, 1, Options >, Eigen::Matrix< Scalar, ColsAtCompileTime, 1, Options &~RowMajor, MaxColsAtCompileTime, 1 >, Eigen::Matrix< Scalar, ColsAtCompileTime, ColsAtCompileTime, MatrixOptions, MaxColsAtCompileTime, MaxColsAtCompileTime >, Eigen::Matrix< Scalar, ColsAtCompileTime, RowsAtCompileTime, Options, MaxColsAtCompileTime, MaxRowsAtCompileTime >, Eigen::Matrix< Scalar, ColsAtCompileTime, RowsAtCompileTime, TrOptions, MaxColsAtCompileTime, MaxRowsAtCompileTime >, Eigen::Matrix< Scalar, Deg, 1 >, Eigen::Matrix< Scalar, Deg_1, 1 >, Eigen::Matrix< Scalar, DiagSizeAtCompileTime, DiagSizeAtCompileTime, MatrixOptions, MaxDiagSizeAtCompileTime, MaxDiagSizeAtCompileTime >, Eigen::Matrix< Scalar, Dim, 1 >, Eigen::Matrix< Scalar, Dynamic, 1 >, Eigen::Matrix< Scalar, Dynamic, Dynamic >, Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >, Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >, Eigen::Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1, 1, Options >, Eigen::Matrix< Scalar, RowsAtCompileTime, 1, 0, MaxRowsAtCompileTime, 1 >, Eigen::Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime, MatrixOptions, MaxRowsAtCompileTime, MaxRowsAtCompileTime >, Eigen::Matrix< Scalar, Size, Size, ColMajor, MaxColsAtCompileTime, MaxColsAtCompileTime >, Eigen::Matrix< Scalar, SizeMinusOne, 1, Options &~RowMajor, MaxSizeMinusOne, 1 >, Eigen::Matrix< StorageIndex, 1, EIGEN_SIZE_MIN_PREFER_DYNAMIC(ColsAtCompileTime, RowsAtCompileTime), RowMajor, 1, EIGEN_SIZE_MIN_PREFER_FIXED(MaxColsAtCompileTime, MaxRowsAtCompileTime)>, Eigen::Matrix< StorageIndex, Dynamic, 1 >, and Eigen::Matrix< StorageIndex, MatrixType::RowsAtCompileTime, 1 >.

Classes

struct  StridedAlignedMapType
 
struct  StridedConstAlignedMapType
 
struct  StridedConstMapType
 
struct  StridedMapType
 

Public Types

enum  { Options = internal::traits<Derived>::Options }
 
enum  { NeedsToAlign = (SizeAtCompileTime != Dynamic) && (internal::traits<Derived>::Alignment>0) }
 
enum  { IsPlainObjectBase = 1 }
 
typedef Eigen::Map< Derived, AlignedMax > AlignedMapType
 
typedef internal::dense_xpr_base< Derived >::type Base
 
typedef const Eigen::Map< const Derived, AlignedMax > ConstAlignedMapType
 
typedef const Eigen::Map< const Derived, Unaligned > ConstMapType
 
typedef Derived DenseType
 
typedef Eigen::Map< Derived, Unaligned > MapType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

EIGEN_DEVICE_FUNC Base & base ()
 
EIGEN_DEVICE_FUNC const Base & base () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar & coeff (Index rowId, Index colId) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar & coeff (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index rowId, Index colId)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar & coeffRef (Index index)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar & coeffRef (Index rowId, Index colId) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar & coeffRef (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index cols () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResize (Index rows, Index cols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResize (Index rows, NoChange_t)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResize (NoChange_t, Index cols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResize (Index size)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResizeLike (const DenseBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar * data () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar * data ()
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & lazyAssign (const DenseBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator= (const PlainObjectBase &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator= (const ReturnByValue< OtherDerived > &func)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this. More...
 
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index rowId, Index colId) const
 
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index index) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void resize (Index rows, Index cols)
 
EIGEN_DEVICE_FUNC void resize (Index size)
 
EIGEN_DEVICE_FUNC void resize (NoChange_t, Index cols)
 
EIGEN_DEVICE_FUNC void resize (Index rows, NoChange_t)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void resizeLike (const EigenBase< OtherDerived > &_other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index rows () const
 
EIGEN_DEVICE_FUNC Derived & setConstant (Index size, const Scalar &val)
 
EIGEN_DEVICE_FUNC Derived & setConstant (Index rows, Index cols, const Scalar &val)
 
EIGEN_DEVICE_FUNC Derived & setOnes (Index size)
 
EIGEN_DEVICE_FUNC Derived & setOnes (Index rows, Index cols)
 
Derived & setRandom (Index size)
 
Derived & setRandom (Index rows, Index cols)
 
EIGEN_DEVICE_FUNC Derived & setZero (Index size)
 
EIGEN_DEVICE_FUNC Derived & setZero (Index rows, Index cols)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC void swap (DenseBase< OtherDerived > &other)
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC void swap (DenseBase< OtherDerived > const &other)
 
template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket (Index rowId, Index colId, const PacketScalar &val)
 
template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket (Index index, const PacketScalar &val)
 

Static Public Member Functions

static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _check_template_params ()
 
Map

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

Here is an example using strides:

Matrix4i A;
A << 1, 2, 3, 4,
5, 6, 7, 8,
9, 10, 11, 12,
13, 14, 15, 16;
std::cout << Matrix2i::Map(&A(1,1),Stride<8,2>()) << std::endl;

Output: 

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


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


 


template<typename T > 


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


 


template<typename T > 


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


 


template<typename T > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const Scalar *data)


 


template<typename T , typename OtherDerived > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const DenseBase< OtherDerived > &other)


 


template<typename T > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const Derived &other)


 


template<typename T , typename OtherDerived > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const EigenBase< OtherDerived > &other)


 


template<typename T , typename OtherDerived > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const ReturnByValue< OtherDerived > &other)


 


template<typename T , typename OtherDerived , int ColsAtCompileTime> 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)


 


template<typename T > 


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


 


template<typename T > 


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


 


template<typename T0 , typename T1 > 


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


 


template<typename T0 , typename T1 > 


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


 


template<typename T0 , typename T1 > 


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


 


template<typename OtherDerived > 


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


 


template<typename OtherDerived > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & _set (const DenseBase< OtherDerived > &other)


 Copies the value of the expression other into *this with automatic resizing.  More...


 


template<typename OtherDerived > 


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


 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PlainObjectBase ()


 


EIGEN_DEVICE_FUNC PlainObjectBase (internal::constructor_without_unaligned_array_assert)


 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PlainObjectBase (const PlainObjectBase &other)


 


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


 


template<typename OtherDerived > 


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


 


template<typename OtherDerived > 


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


 


template<typename OtherDerived > 


EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PlainObjectBase (const ReturnByValue< OtherDerived > &other)


 Copy constructor with in-place evaluation.  More...


 





Protected Attributes


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


 





Friends


template<typename PlainObjectType , int MapOptions, typename StrideType > 


class Eigen::Map


 


class Eigen::Map< const Derived, Unaligned >


 


class Eigen::Map< Derived, Unaligned >


 


template<typename MatrixTypeA , typename MatrixTypeB , bool SwapPointers> 


struct internal::matrix_swap_impl


 




Detailed Description


template<typename Derived>

class Eigen::PlainObjectBase< Derived >




Definition at line 98 of file PlainObjectBase.h.


Member Typedef Documentation








template<typename Derived> 

      

        

          typedef Eigen::Map<Derived, AlignedMax> Eigen::PlainObjectBase< Derived >::AlignedMapType
        

      





Definition at line 131 of file PlainObjectBase.h.













template<typename Derived> 

      

        

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

      





Definition at line 103 of file PlainObjectBase.h.













template<typename Derived> 

      

        

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

      





Definition at line 132 of file PlainObjectBase.h.













template<typename Derived> 

      

        

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

      





Definition at line 125 of file PlainObjectBase.h.













template<typename Derived> 

      

        

          typedef Derived Eigen::PlainObjectBase< Derived >::DenseType
        

      





Definition at line 110 of file PlainObjectBase.h.













template<typename Derived> 

      

        

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

      





Definition at line 123 of file PlainObjectBase.h.













template<typename Derived> 

      

        

          typedef internal::packet_traits<Scalar>::type Eigen::PlainObjectBase< Derived >::PacketScalar
        

      





Definition at line 108 of file PlainObjectBase.h.













template<typename Derived> 

      

        

          typedef NumTraits<Scalar>::Real Eigen::PlainObjectBase< Derived >::RealScalar
        

      





Definition at line 109 of file PlainObjectBase.h.













template<typename Derived> 

      

        

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

      





Definition at line 106 of file PlainObjectBase.h.













template<typename Derived> 

      

        

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

      





Definition at line 105 of file PlainObjectBase.h.







Member Enumeration Documentation








template<typename Derived> 

      

        

          anonymous enum
        

      






Enumerator
Options 






Definition at line 102 of file PlainObjectBase.h.













template<typename Derived> 

      

        

          anonymous enum
        

      






Enumerator
NeedsToAlign 






Definition at line 142 of file PlainObjectBase.h.













template<typename Derived> 

      

        

          anonymous enum
        

      






Enumerator
IsPlainObjectBase 






Definition at line 915 of file PlainObjectBase.h.







Constructor & Destructor Documentation








template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::PlainObjectBase< Derived >::PlainObjectBase 
          (
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 484 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC Eigen::PlainObjectBase< Derived >::PlainObjectBase 
          (
          internal::constructor_without_unaligned_array_assert 
          )
          
        

      

  		
  
inlineexplicitprotected  
  







Definition at line 494 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inlineprotected  
  






Copy constructor 



Definition at line 519 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::PlainObjectBase< Derived >::PlainObjectBase 
          (
          Index 
          size, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 522 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  






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



Definition at line 532 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  






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



Definition at line 543 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Copy constructor with in-place evaluation. 



Definition at line 553 of file PlainObjectBase.h.







Member Function Documentation








template<typename Derived> 



  

  
      

        

          static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_check_template_params 
          (
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 901 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          Index 
          size, 
        

        

          
          
          typename internal::enable_if< (Base::SizeAtCompileTime!=1||!internal::is_convertible< T, Scalar >::value)&&((!internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value||Base::SizeAtCompileTime==Dynamic)), T >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 772 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const Scalar & 
          val0, 
        

        

          
          
          typename internal::enable_if< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 786 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const Index & 
          val0, 
        

        

          
          
          typename internal::enable_if< (!internal::is_same< Index, Scalar >::value)&&(internal::is_same< Index, T >::value)&&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 795 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Definition at line 808 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T , typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Definition at line 815 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const Derived & 
          other)
          
        

      

  		
  
inlineprotected  
  







Definition at line 822 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T , typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Definition at line 829 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T , typename OtherDerived > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const ReturnByValue< OtherDerived > & 
          other)
          
        

      

  		
  
inlineprotected  
  







Definition at line 835 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T , typename OtherDerived , int ColsAtCompileTime> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const RotationBase< OtherDerived, ColsAtCompileTime > & 
          r)
          
        

      

  		
  
inlineprotected  
  







Definition at line 843 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const Scalar & 
          val0, 
        

        

          
          
          typename internal::enable_if< Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 851 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init1 
          (
          const Index & 
          val0, 
        

        

          
          
          typename internal::enable_if< (!internal::is_same< Index, Scalar >::value)&&(internal::is_same< Index, T >::value)&&Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Derived >::XprKind, ArrayXpr >::value, T * >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 863 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T0 , typename T1 > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init2 
          (
          Index 
          rows, 
        

        

          
          
          Index 
          cols, 
        

        

          
          
          typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 738 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T0 , typename T1 > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init2 
          (
          const T0 & 
          val0, 
        

        

          
          
          const T1 & 
          val1, 
        

        

          
          
          typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 748 of file PlainObjectBase.h.













template<typename Derived> 



template<typename T0 , typename T1 > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::_init2 
          (
          const Index & 
          val0, 
        

        

          
          
          const Index & 
          val1, 
        

        

          
          
          typename internal::enable_if< (!internal::is_same< Index, Scalar >::value)&&(internal::is_same< T0, Index >::value)&&(internal::is_same< T1, Index >::value)&&Base::SizeAtCompileTime==2, T1 >::type * 
           = 0 
        

        

          
          )
          
        

      

  		
  
inlineprotected  
  







Definition at line 757 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Definition at line 682 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Copies the value of the expression other into *this with automatic resizing. 


*this might be resized to match the dimensions of other. If *this was a null matrix (not already initialized), it will be initialized.


Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.


See also
operator=(const MatrixBase<OtherDerived>&), _set_noalias() 



Definition at line 712 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inlineprotected  
  







Definition at line 725 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC Base& Eigen::PlainObjectBase< Derived >::base 
          (
          )
          
        

      

  		
  
inline  
  







Definition at line 146 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC const Base& Eigen::PlainObjectBase< Derived >::base 
          (
          )
           const
        

      

  		
  
inline  
  







Definition at line 148 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

        

          
          
          Index 
          colId 
        

        

          
          )
           const
        

      

  		
  
inline  
  






This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.


See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details. 



Definition at line 160 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.


See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details. 



Definition at line 173 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

        

          
          
          Index 
          colId 
        

        

          
          )
          
        

      

  		
  
inline  
  






This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.


See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const for details. 



Definition at line 183 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.


See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const for details. 



Definition at line 196 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

        

          
          
          Index 
          colId 
        

        

          
          )
           const
        

      

  		
  
inline  
  






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



Definition at line 204 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). It is provided for convenience. 



Definition at line 215 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index Eigen::PlainObjectBase< Derived >::cols 
          (
          void 
          )
           const
        

      

  		
  
inline  
  







Definition at line 153 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::conservativeResize 
          (
          Index 
          rows, 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inline  
  






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


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


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



Definition at line 390 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::conservativeResize 
          (
          Index 
          rows, 
        

        

          
          
          NoChange_t 
           
        

        

          
          )
          
        

      

  		
  
inline  
  






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


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


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



Definition at line 403 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::conservativeResize 
          (
          NoChange_t 
          , 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inline  
  






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


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


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



Definition at line 417 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






Resizes the vector to size while retaining old values.


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


When values are appended, they will be uninitialized. 



Definition at line 432 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inline  
  






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


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


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



Definition at line 448 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






Returns
a const pointer to the data array of this matrix 



Definition at line 255 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






Returns
a pointer to the data array of this matrix 



Definition at line 259 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inline  
  






See also
MatrixBase::lazyAssign() 



Definition at line 465 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static ConstMapType Eigen::PlainObjectBase< Derived >::Map 
          (
          const Scalar * 
          data)
          
        

      

  		
  
inlinestatic  
  







Definition at line 587 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static MapType Eigen::PlainObjectBase< Derived >::Map 
          (
          Scalar * 
          data)
          
        

      

  		
  
inlinestatic  
  







Definition at line 589 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static ConstMapType Eigen::PlainObjectBase< Derived >::Map 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          size 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 591 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static MapType Eigen::PlainObjectBase< Derived >::Map 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          size 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 593 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static ConstMapType Eigen::PlainObjectBase< Derived >::Map 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 595 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static MapType Eigen::PlainObjectBase< Derived >::Map 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 597 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map 
          (
          const Scalar * 
          data, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 614 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map 
          (
          Scalar * 
          data, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 617 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          size, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 620 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          size, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 623 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 626 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::Map 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 629 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static ConstAlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          const Scalar * 
          data)
          
        

      

  		
  
inlinestatic  
  







Definition at line 600 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static AlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          Scalar * 
          data)
          
        

      

  		
  
inlinestatic  
  







Definition at line 602 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static ConstAlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          size 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 604 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static AlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          size 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 606 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static ConstAlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 608 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          static AlignedMapType Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 610 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          const Scalar * 
          data, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 633 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          Scalar * 
          data, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 636 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          size, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 639 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          size, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 642 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          const Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 645 of file PlainObjectBase.h.













template<typename Derived> 



template<int Outer, int Inner> 



  

  
      

        

          static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase< Derived >::MapAligned 
          (
          Scalar * 
          data, 
        

        

          
          
          Index 
          rows, 
        

        

          
          
          Index 
          cols, 
        

        

          
          
          const Stride< Outer, Inner > & 
          stride 
        

        

          
          )
          
        

      

  		
  
inlinestatic  
  







Definition at line 648 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






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



Definition at line 457 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase< Derived >::operator= 
          (
          const ReturnByValue< OtherDerived > & 
          func)
          
        

      

  		
  
inline  
  







Definition at line 473 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::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. 



Definition at line 568 of file PlainObjectBase.h.













template<typename Derived> 



template<int LoadMode> 



  

  
      

        

          EIGEN_STRONG_INLINE PacketScalar Eigen::PlainObjectBase< Derived >::packet 
          (
          Index 
          rowId, 
        

        

          
          
          Index 
          colId 
        

        

          
          )
           const
        

      

  		
  
inline  
  







Definition at line 222 of file PlainObjectBase.h.













template<typename Derived> 



template<int LoadMode> 



  

  
      

        

          EIGEN_STRONG_INLINE PacketScalar Eigen::PlainObjectBase< Derived >::packet 
          (
          Index 
          index)
           const
        

      

  		
  
inline  
  







Definition at line 232 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inline  
  






Resizes *this to a rows x cols matrix.


This method is intended for dynamic-size matrices, although it is legal to call it on any matrix as long as fixed dimensions are left unchanged. If you only want to change the number of rows and/or of columns, you can use resize(NoChange_t, Index), resize(Index, NoChange_t).


If the current number of coefficients of *this exactly matches the product rows * cols, then no memory allocation is performed and the current values are left unchanged. In all other cases, including shrinking, the data is reallocated and all previous values are lost.


Example: 
MatrixXd m(2,3);
m << 1,2,3,4,5,6;
cout << "here's the 2x3 matrix m:" << endl << m << endl;
cout << "let's resize m to 3x2. This is a conservative resizing because 2*3==3*2." << endl;
m.resize(3,2);
cout << "here's the 3x2 matrix m:" << endl << m << endl;
cout << "now let's resize m to size 2x2. This is NOT a conservative resizing, so it becomes uninitialized:" << endl;
m.resize(2,2);
cout << m << endl;
 Output: 
See also
resize(Index) for vectors, resize(NoChange_t, Index), resize(Index, NoChange_t) 



Definition at line 279 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
inline  
  






Resizes *this to a vector of length size 


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


Example: 
VectorXd v(10);
v.resize(3);
RowVector3d w;
w.resize(3); // this is legal, but has no effect
cout << "v: " << v.rows() << " rows, " << v.cols() << " cols" << endl;
cout << "w: " << w.rows() << " rows, " << w.cols() << " cols" << endl;
 Output: 
See also
resize(Index,Index), resize(NoChange_t, Index), resize(Index, NoChange_t) 



Definition at line 309 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      

  		
  
inline  
  






Resizes the matrix, changing only the number of columns. For the parameter of type NoChange_t, just pass the special value NoChange as in the example below.


Example: 
MatrixXd m(3,4);
m.resize(NoChange, 5);
cout << "m: " << m.rows() << " rows, " << m.cols() << " cols" << endl;
 Output: 
See also
resize(Index,Index) 



Definition at line 334 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

        

          
          
          NoChange_t 
           
        

        

          
          )
          
        

      

  		
  
inline  
  






Resizes the matrix, changing only the number of rows. For the parameter of type NoChange_t, just pass the special value NoChange as in the example below.


Example: 
MatrixXd m(3,4);
m.resize(5, NoChange);
cout << "m: " << m.rows() << " rows, " << m.cols() << " cols" << endl;
 Output: 
See also
resize(Index,Index) 



Definition at line 348 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::resizeLike 
          (
          const EigenBase< OtherDerived > & 
          _other)
          
        

      

  		
  
inline  
  






Resizes *this to have the same dimensions as other. Takes care of doing all the checking that's needed.


Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors. 



Definition at line 362 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index Eigen::PlainObjectBase< Derived >::rows 
          (
          void 
          )
           const
        

      

  		
  
inline  
  







Definition at line 151 of file PlainObjectBase.h.













template<typename Derived > 

      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::PlainObjectBase< Derived >::setConstant 
          (
          Index 
          size, 
        

        

          
          
          const Scalar & 
          val 
        

        

          
          )
          
        

      




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


Example: 
VectorXf v;
v.setConstant(3, 5);
cout << v << endl;
 Output: 
See also
MatrixBase::setConstant(const Scalar&), setConstant(Index,Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&) 



Definition at line 341 of file CwiseNullaryOp.h.













template<typename Derived > 

      

        

          EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::PlainObjectBase< Derived >::setConstant 
          (
          Index 
          rows, 
        

        

          
          
          Index 
          cols, 
        

        

          
          
          const Scalar & 
          val 
        

        

          
          )
          
        

      




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


Parameters

  

    
rowsthe new number of rows 

    
colsthe new number of columns 

    
valthe value to which all coefficients are set

  

  




Example: 
MatrixXf m;
m.setConstant(3, 3, 5);
cout << m << endl;
 Output: 
See also
MatrixBase::setConstant(const Scalar&), setConstant(Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&) 



Definition at line 360 of file CwiseNullaryOp.h.













template<typename Derived > 

      

        

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

      




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


Example: 
VectorXf v;
v.setOnes(3);
cout << v << endl;
 Output: 
See also
MatrixBase::setOnes(), setOnes(Index,Index), class CwiseNullaryOp, MatrixBase::Ones() 



Definition at line 641 of file CwiseNullaryOp.h.













template<typename Derived > 

      

        

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

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      




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


Parameters

  

    
rowsthe new number of rows 

    
colsthe new number of columns

  

  




Example: 
MatrixXf m;
m.setOnes(3, 3);
cout << m << endl;
 Output: 
See also
MatrixBase::setOnes(), setOnes(Index), class CwiseNullaryOp, MatrixBase::Ones() 



Definition at line 659 of file CwiseNullaryOp.h.













template<typename Derived > 

      

        

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

      




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


Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.


Example: 
VectorXf v;
v.setRandom(3);
cout << v << endl;
 Output: 
See also
DenseBase::setRandom(), setRandom(Index,Index), class CwiseNullaryOp, DenseBase::Random() 



Definition at line 151 of file Random.h.













template<typename Derived > 

      

        

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

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      




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


Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.


Parameters

  

    
rowsthe new number of rows 

    
colsthe new number of columns

  

  




Example: 
MatrixXf m;
m.setRandom(3, 3);
cout << m << endl;
 Output: 
See also
DenseBase::setRandom(), setRandom(Index), class CwiseNullaryOp, DenseBase::Random() 



Definition at line 174 of file Random.h.













template<typename Derived > 

      

        

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

      




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


Example: 
VectorXf v;
v.setZero(3);
cout << v << endl;
 Output: 
See also
DenseBase::setZero(), setZero(Index,Index), class CwiseNullaryOp, DenseBase::Zero() 



Definition at line 515 of file CwiseNullaryOp.h.













template<typename Derived > 

      

        

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

        

          
          
          Index 
          cols 
        

        

          
          )
          
        

      




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


Parameters

  

    
rowsthe new number of rows 

    
colsthe new number of columns

  

  




Example: 
MatrixXf m;
m.setZero(3, 3);
cout << m << endl;
 Output: 
See also
DenseBase::setZero(), setZero(Index), class CwiseNullaryOp, DenseBase::Zero() 



Definition at line 533 of file CwiseNullaryOp.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

          EIGEN_DEVICE_FUNC void Eigen::PlainObjectBase< Derived >::swap 
          (
          DenseBase< OtherDerived > & 
          other)
          
        

      

  		
  
inline  
  







Definition at line 886 of file PlainObjectBase.h.













template<typename Derived> 



template<typename OtherDerived > 



  

  
      

        

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

      

  		
  
inline  
  







Definition at line 897 of file PlainObjectBase.h.













template<typename Derived> 



template<int StoreMode> 



  

  
      

        

          EIGEN_STRONG_INLINE void Eigen::PlainObjectBase< Derived >::writePacket 
          (
          Index 
          rowId, 
        

        

          
          
          Index 
          colId, 
        

        

          
          
          const PacketScalar & 
          val 
        

        

          
          )
          
        

      

  		
  
inline  
  







Definition at line 239 of file PlainObjectBase.h.













template<typename Derived> 



template<int StoreMode> 



  

  
      

        

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

        

          
          
          const PacketScalar & 
          val 
        

        

          
          )
          
        

      

  		
  
inline  
  







Definition at line 249 of file PlainObjectBase.h.







Friends And Related Function Documentation








template<typename Derived> 



template<typename PlainObjectType , int MapOptions, typename StrideType > 



  

  
      

        

          friend class Eigen::Map
        

      

  		
  
friend  
  







Definition at line 121 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

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

      

  		
  
friend  
  







Definition at line 124 of file PlainObjectBase.h.













template<typename Derived> 



  

  
      

        

          friend class Eigen::Map< Derived, Unaligned >
        

      

  		
  
friend  
  







Definition at line 122 of file PlainObjectBase.h.













template<typename Derived> 



template<typename MatrixTypeA , typename MatrixTypeB , bool SwapPointers> 



  

  
      

        

          friend struct internal::matrix_swap_impl
        

      

  		
  
friend  
  







Definition at line 875 of file PlainObjectBase.h.







Member Data Documentation








template<typename Derived> 



  

  
      

        

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

      

  		
  
protected  
  







Definition at line 139 of file PlainObjectBase.h.







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







gtsam

Author(s): 

autogenerated on Sat May 8 2021 02:54:13