Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Attributes | Friends
Eigen::SkylineMatrixBase< Derived > Class Template Reference

Detailed Description

template<typename Derived>
class Eigen::SkylineMatrixBase< Derived >

Base class of any skyline matrices or skyline expressions.

Parameters:
Derived

Definition at line 39 of file Skyline.

Inheritance diagram for Eigen::SkylineMatrixBase< Derived >:
Inheritance graph
[legend]

List of all members.

Public Types

enum  {
  RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime,
  MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1, Flags = internal::traits<Derived>::Flags,
  CoeffReadCost = internal::traits<Derived>::CoeffReadCost, IsRowMajor = Flags & RowMajorBit ? 1 : 0
}
enum  {
  RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime,
  MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1, Flags = internal::traits<Derived>::Flags,
  CoeffReadCost = internal::traits<Derived>::CoeffReadCost, IsRowMajor = Flags & RowMajorBit ? 1 : 0
}
typedef internal::traits
< Derived >::Scalar 
Scalar
typedef internal::traits
< Derived >::StorageKind 
StorageKind
typedef internal::index
< StorageKind >::type 
Index
typedef internal::traits
< Derived >::Scalar 
Scalar
typedef internal::traits
< Derived >::StorageKind 
StorageKind
typedef internal::index
< StorageKind >::type 
Index

Public Member Functions

Index rows () const
Index cols () const
Index size () const
Index nonZeros () const
Index outerSize () const
Index innerSize () const
bool isRValue () const
Derived & markAsRValue ()
 SkylineMatrixBase ()
Derived & operator= (const Derived &other)
template<typename OtherDerived >
void assignGeneric (const OtherDerived &other)
template<typename OtherDerived >
Derived & operator= (const SkylineMatrixBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
Derived & operator= (const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &product)
template<typename OtherDerived >
const SkylineProductReturnType
< Derived, OtherDerived >
::Type 
operator* (const MatrixBase< OtherDerived > &other) const
template<typename DenseDerived >
void evalTo (MatrixBase< DenseDerived > &dst) const
Matrix< Scalar,
RowsAtCompileTime,
ColsAtCompileTime > 
toDense () const
EIGEN_STRONG_INLINE const
internal::eval< Derived,
IsSkyline >::type 
eval () const
Index rows () const
Index cols () const
Index size () const
Index nonZeros () const
Index outerSize () const
Index innerSize () const
bool isRValue () const
Derived & markAsRValue ()
 SkylineMatrixBase ()
Derived & operator= (const Derived &other)
template<typename OtherDerived >
void assignGeneric (const OtherDerived &other)
template<typename OtherDerived >
Derived & operator= (const SkylineMatrixBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
Derived & operator= (const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &product)
template<typename OtherDerived >
const SkylineProductReturnType
< Derived, OtherDerived >
::Type 
operator* (const MatrixBase< OtherDerived > &other) const
template<typename DenseDerived >
void evalTo (MatrixBase< DenseDerived > &dst) const
Matrix< Scalar,
RowsAtCompileTime,
ColsAtCompileTime > 
toDense () const
EIGEN_STRONG_INLINE const
internal::eval< Derived,
IsSkyline >::type 
eval () const
Derived & derived ()
const Derived & derived () const
Derived & const_cast_derived () const
const Derived & const_derived () const
template<typename Dest >
void evalTo (Dest &dst) const
template<typename Dest >
void addTo (Dest &dst) const
template<typename Dest >
void subTo (Dest &dst) const
template<typename Dest >
void applyThisOnTheRight (Dest &dst) const
template<typename Dest >
void applyThisOnTheLeft (Dest &dst) const

Protected Attributes

bool m_isRValue

Friends

std::ostream & operator<< (std::ostream &s, const SkylineMatrixBase &m)
std::ostream & operator<< (std::ostream &s, const SkylineMatrixBase &m)

Member Typedef Documentation

template<typename Derived>
typedef internal::index<StorageKind>::type Eigen::SkylineMatrixBase< Derived >::Index

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 44 of file Skyline.

template<typename Derived>
typedef internal::index<StorageKind>::type Eigen::SkylineMatrixBase< Derived >::Index

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 44 of file Skyline.

template<typename Derived>
typedef internal::traits<Derived>::Scalar Eigen::SkylineMatrixBase< Derived >::Scalar

Definition at line 42 of file Skyline.

template<typename Derived>
typedef internal::traits<Derived>::Scalar Eigen::SkylineMatrixBase< Derived >::Scalar

Definition at line 42 of file Skyline.

template<typename Derived>
typedef internal::traits<Derived>::StorageKind Eigen::SkylineMatrixBase< Derived >::StorageKind

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 43 of file Skyline.

template<typename Derived>
typedef internal::traits<Derived>::StorageKind Eigen::SkylineMatrixBase< Derived >::StorageKind

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 43 of file Skyline.


Member Enumeration Documentation

template<typename Derived>
anonymous enum
Enumerator:
RowsAtCompileTime 

The number of rows at compile-time.

This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also:
MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
ColsAtCompileTime 

The number of columns at compile-time.

This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also:
MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
SizeAtCompileTime 

This is equal to the number of coefficients, i.e.

the number of rows times the number of columns, or to Dynamic if this is not known at compile-time.

See also:
RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
MaxSizeAtCompileTime 
IsVectorAtCompileTime 

This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1.

Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).

Flags 

This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one.

See the list of flags.

CoeffReadCost 

This is a rough measure of how expensive it is to read one coefficient from this expression.

IsRowMajor 

Definition at line 46 of file Skyline.

template<typename Derived>
anonymous enum
Enumerator:
RowsAtCompileTime 

The number of rows at compile-time.

This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also:
MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
ColsAtCompileTime 

The number of columns at compile-time.

This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also:
MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
SizeAtCompileTime 

This is equal to the number of coefficients, i.e.

the number of rows times the number of columns, or to Dynamic if this is not known at compile-time.

See also:
RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
MaxSizeAtCompileTime 
IsVectorAtCompileTime 

This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1.

Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).

Flags 

This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one.

See the list of flags.

CoeffReadCost 

This is a rough measure of how expensive it is to read one coefficient from this expression.

IsRowMajor 

Definition at line 46 of file Skyline.


Constructor & Destructor Documentation

template<typename Derived>
Eigen::SkylineMatrixBase< Derived >::SkylineMatrixBase ( ) [inline]

Definition at line 160 of file Skyline.

template<typename Derived>
Eigen::SkylineMatrixBase< Derived >::SkylineMatrixBase ( ) [inline]

Definition at line 160 of file Skyline.


Member Function Documentation

template<typename Derived>
template<typename Dest >
void Eigen::EigenBase< Derived >::addTo ( Dest &  dst) const [inline, inherited]

Definition at line 71 of file Core.

template<typename Derived>
template<typename Dest >
void Eigen::EigenBase< Derived >::applyThisOnTheLeft ( Dest &  dst) const [inline, inherited]

Reimplemented in Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >.

Definition at line 99 of file Core.

template<typename Derived>
template<typename Dest >
void Eigen::EigenBase< Derived >::applyThisOnTheRight ( Dest &  dst) const [inline, inherited]

Reimplemented in Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >.

Definition at line 91 of file Core.

template<typename Derived>
template<typename OtherDerived >
void Eigen::SkylineMatrixBase< Derived >::assignGeneric ( const OtherDerived &  other) [inline]

Definition at line 170 of file Skyline.

template<typename Derived>
template<typename OtherDerived >
void Eigen::SkylineMatrixBase< Derived >::assignGeneric ( const OtherDerived &  other) [inline]

Definition at line 170 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 123 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 123 of file Skyline.

template<typename Derived>
Derived& Eigen::EigenBase< Derived >::const_cast_derived ( ) const [inline, inherited]

Definition at line 53 of file Core.

template<typename Derived>
const Derived& Eigen::EigenBase< Derived >::const_derived ( ) const [inline, inherited]

Definition at line 55 of file Core.

template<typename Derived>
Derived& Eigen::EigenBase< Derived >::derived ( ) [inline, inherited]
Returns:
a reference to the derived object

Definition at line 49 of file Core.

Referenced by mrpt::math::loadVector().

template<typename Derived>
const Derived& Eigen::EigenBase< Derived >::derived ( ) const [inline, inherited]
Returns:
a const reference to the derived object

Definition at line 51 of file Core.

template<typename Derived>
EIGEN_STRONG_INLINE const internal::eval<Derived, IsSkyline>::type Eigen::SkylineMatrixBase< Derived >::eval ( ) const [inline]
Returns:
the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

Definition at line 215 of file Skyline.

template<typename Derived>
EIGEN_STRONG_INLINE const internal::eval<Derived, IsSkyline>::type Eigen::SkylineMatrixBase< Derived >::eval ( ) const [inline]
Returns:
the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

Definition at line 215 of file Skyline.

template<typename Derived>
template<typename Dest >
void Eigen::EigenBase< Derived >::evalTo ( Dest &  dst) const [inline, inherited]
template<typename Derived>
template<typename DenseDerived >
void Eigen::SkylineMatrixBase< Derived >::evalTo ( MatrixBase< DenseDerived > &  dst) const [inline]

Definition at line 199 of file Skyline.

template<typename Derived>
template<typename DenseDerived >
void Eigen::SkylineMatrixBase< Derived >::evalTo ( MatrixBase< DenseDerived > &  dst) const [inline]

Definition at line 199 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::innerSize ( ) const [inline]
Returns:
the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 147 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::innerSize ( ) const [inline]
Returns:
the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 147 of file Skyline.

template<typename Derived>
bool Eigen::SkylineMatrixBase< Derived >::isRValue ( ) const [inline]

Definition at line 151 of file Skyline.

template<typename Derived>
bool Eigen::SkylineMatrixBase< Derived >::isRValue ( ) const [inline]

Definition at line 151 of file Skyline.

template<typename Derived>
Derived& Eigen::SkylineMatrixBase< Derived >::markAsRValue ( ) [inline]

Definition at line 155 of file Skyline.

template<typename Derived>
Derived& Eigen::SkylineMatrixBase< Derived >::markAsRValue ( ) [inline]

Definition at line 155 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::nonZeros ( ) const [inline]
Returns:
the number of nonzero coefficients which is in practice the number of stored coefficients.

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 135 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::nonZeros ( ) const [inline]
Returns:
the number of nonzero coefficients which is in practice the number of stored coefficients.

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 135 of file Skyline.

template<typename Derived>
template<typename OtherDerived >
const SkylineProductReturnType<Derived, OtherDerived>::Type Eigen::SkylineMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > &  other) const
template<typename Derived >
template<typename OtherDerived >
EIGEN_STRONG_INLINE const SkylineProductReturnType< Derived, OtherDerived >::Type Eigen::SkylineMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > &  other) const

Definition at line 302 of file Skyline.

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

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 181 of file Skyline.

template<typename Derived>
template<typename Lhs , typename Rhs >
Derived& Eigen::SkylineMatrixBase< Derived >::operator= ( const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &  product) [inline]
template<typename Derived>
template<typename OtherDerived >
Derived& Eigen::SkylineMatrixBase< Derived >::operator= ( const SkylineMatrixBase< OtherDerived > &  other) [inline]

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 181 of file Skyline.

template<typename Derived>
Derived& Eigen::SkylineMatrixBase< Derived >::operator= ( const Derived &  other) [inline]

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 164 of file Skyline.

template<typename Derived>
template<typename Lhs , typename Rhs >
Derived& Eigen::SkylineMatrixBase< Derived >::operator= ( const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &  product) [inline]
template<typename Derived>
Derived& Eigen::SkylineMatrixBase< Derived >::operator= ( const Derived &  other) [inline]

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 164 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::outerSize ( ) const [inline]
Returns:
the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 141 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::outerSize ( ) const [inline]
Returns:
the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 141 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 118 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::SkylineMatrix< _Scalar, _Options >.

Definition at line 118 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::size ( ) const [inline]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 129 of file Skyline.

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::size ( ) const [inline]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 129 of file Skyline.

template<typename Derived>
template<typename Dest >
void Eigen::EigenBase< Derived >::subTo ( Dest &  dst) const [inline, inherited]

Definition at line 81 of file Core.

template<typename Derived>
Matrix<Scalar, RowsAtCompileTime, ColsAtCompileTime> Eigen::SkylineMatrixBase< Derived >::toDense ( ) const [inline]

Definition at line 206 of file Skyline.

template<typename Derived>
Matrix<Scalar, RowsAtCompileTime, ColsAtCompileTime> Eigen::SkylineMatrixBase< Derived >::toDense ( ) const [inline]

Definition at line 206 of file Skyline.


Friends And Related Function Documentation

template<typename Derived>
std::ostream& operator<< ( std::ostream &  s,
const SkylineMatrixBase< Derived > &  m 
) [friend]

Definition at line 188 of file Skyline.

template<typename Derived>
std::ostream& operator<< ( std::ostream &  s,
const SkylineMatrixBase< Derived > &  m 
) [friend]

Definition at line 188 of file Skyline.


Member Data Documentation

template<typename Derived>
bool Eigen::SkylineMatrixBase< Derived >::m_isRValue [protected]

Definition at line 220 of file Skyline.




Page generated by Doxygen 1.7.4 for MRPT 0.9.5 SVN:2717 at Sun Oct 16 16:08:03 PDT 2011 Hosted on:
SourceForge.net Logo