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::traits< Derived >::Scalar	Scalar

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

typedef internal::index< StorageKind >::type	Index

typedef NumTraits< Scalar >::Real	RealScalar
	This is the "real scalar" type; if the Scalar type is already real numbers (e.g. More...

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) >	SquareMatrixType
	type of the equivalent square matrix

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

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

Public Member Functions
const Derived &	derived () const

Derived &	derived ()

Derived &	const_cast_derived () const

Index	rows () const

Index	cols () const

Index	size () const

Index	nonZeros () const

Index	outerSize () const

Index	innerSize () const

bool	isRValue () const

Derived &	markAsRValue ()

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

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

Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC Index	size () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) 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

Member Typedef Documentation

§ RealScalar

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

Member Enumeration Documentation

§ anonymous enum

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

Member Function Documentation

§ cols()

template<typename Derived>

Index Eigen::SkylineMatrixBase< Derived >::cols ( void ) const

inline

Returns: the number of columns.

See also: rows(), ColsAtCompileTime

§ eval()

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.

§ innerSize()

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

§ nonZeros()

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.

§ outerSize()

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

§ rows()

template<typename Derived>

Index Eigen::SkylineMatrixBase< Derived >::rows ( void ) const

inline

Returns: the number of rows.

See also: cols(), RowsAtCompileTime

§ size()

template<typename Derived>

Index Eigen::SkylineMatrixBase< Derived >::size ( ) const

inline

Returns: the number of coefficients, which is rows()*cols().

See also: rows(), cols(), SizeAtCompileTime.

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

third-party-libs/eigen3/unsupported/Eigen/src/Skyline/SkylineMatrixBase.h
third-party-libs/eigen3/unsupported/Eigen/src/Skyline/SkylineProduct.h

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

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

Member Typedef Documentation

§ RealScalar

Member Enumeration Documentation

§ anonymous enum

Member Function Documentation

§ cols()

§ eval()

§ innerSize()

§ nonZeros()

§ outerSize()

§ rows()

§ size()

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