Base class of any skyline matrices or skyline expressions. More...

#include <SkylineMatrixBase.h>

Inheritance diagram for Eigen::SkylineMatrixBase< Derived >:

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 }
typedef internal::index < StorageKind >::type	Index
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits < Derived >::Scalar	Scalar
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) >	SquareMatrixType
typedef internal::traits < Derived >::StorageKind	StorageKind
Public Member Functions
template<typename OtherDerived >
void	assignGeneric (const OtherDerived &other)
Index	cols () const
Derived &	const_cast_derived () const
const Derived &	derived () const
Derived &	derived ()
EIGEN_STRONG_INLINE const internal::eval< Derived, IsSkyline >::type	eval () const
template<typename DenseDerived >
void	evalTo (MatrixBase< DenseDerived > &dst) const
Index	innerSize () const
bool	isRValue () const
Derived &	markAsRValue ()
Index	nonZeros () const
template<typename OtherDerived >
const SkylineProductReturnType < Derived, OtherDerived > ::Type	operator* (const MatrixBase< OtherDerived > &other) const
Derived &	operator= (const Derived &other)
template<typename OtherDerived >
Derived &	operator= (const SkylineMatrixBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
Derived &	operator= (const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &product)
Index	outerSize () const
Index	rows () const
Index	size () const
	SkylineMatrixBase ()
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () const
Protected Attributes
bool	m_isRValue
Friends
std::ostream &	operator<< (std::ostream &s, const SkylineMatrixBase &m)

Detailed Description

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

Base class of any skyline matrices or skyline expressions.

Parameters:

Derived

Definition at line 26 of file SkylineMatrixBase.h.

Member Typedef Documentation

template<typename Derived>

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

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 31 of file SkylineMatrixBase.h.

template<typename Derived>

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

This is the "real scalar" type; if the Scalar type is already real numbers (e.g. int, float or double) then RealScalar is just the same as Scalar. If Scalar is std::complex<T> then RealScalar is T.

See also:: class NumTraits

Definition at line 85 of file SkylineMatrixBase.h.

template<typename Derived>

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

Definition at line 29 of file SkylineMatrixBase.h.

template<typename Derived>

typedef Matrix<Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) > Eigen::SkylineMatrixBase< Derived >::SquareMatrixType

type of the equivalent square matrix

Definition at line 89 of file SkylineMatrixBase.h.

template<typename Derived>

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

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 30 of file SkylineMatrixBase.h.

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 33 of file SkylineMatrixBase.h.

Constructor & Destructor Documentation

template<typename Derived>

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

Definition at line 147 of file SkylineMatrixBase.h.

Member Function Documentation

template<typename Derived>

template<typename OtherDerived >

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

Definition at line 157 of file SkylineMatrixBase.h.

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 110 of file SkylineMatrixBase.h.

template<typename Derived>

Derived& Eigen::SkylineMatrixBase< Derived >::const_cast_derived ( ) const [inline]

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 99 of file SkylineMatrixBase.h.

template<typename Derived>

const Derived& Eigen::SkylineMatrixBase< Derived >::derived ( ) const [inline]

Returns:: a const reference to the derived object

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 91 of file SkylineMatrixBase.h.

template<typename Derived>

Derived& Eigen::SkylineMatrixBase< Derived >::derived ( ) [inline]

Returns:: a reference to the derived object

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 95 of file SkylineMatrixBase.h.

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 202 of file SkylineMatrixBase.h.

template<typename Derived>

template<typename DenseDerived >

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

Definition at line 186 of file SkylineMatrixBase.h.

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 134 of file SkylineMatrixBase.h.

template<typename Derived>

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

Definition at line 138 of file SkylineMatrixBase.h.

template<typename Derived>

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

Definition at line 142 of file SkylineMatrixBase.h.

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 122 of file SkylineMatrixBase.h.

template<typename Derived >

template<typename OtherDerived >

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