Public Member Functions | Protected Attributes
Part Class Reference

Expression of a triangular matrix extracted from a given matrix. More...

List of all members.

Public Member Functions

const MatrixType & _expression () const
Scalar coeff (int row, int col) const
Scalar & coeffRef (int row, int col)
const Block< Part,
RowsAtCompileTime, 1 > 
col (int i)
const Block< Part,
RowsAtCompileTime, 1 > 
col (int i) const
int cols () const
template<typename Other >
void lazyAssign (const Other &other)
Partoperator*= (const typename ei_traits< MatrixType >::Scalar &other)
template<typename Other >
Partoperator+= (const Other &other)
template<typename Other >
Partoperator-= (const Other &other)
Partoperator/= (const typename ei_traits< MatrixType >::Scalar &other)
template<typename Other >
Partoperator= (const Other &other)
 Part (const MatrixType &matrix)
const Block< Part,
1, ColsAtCompileTime > 
row (int i)
const Block< Part,
1, ColsAtCompileTime > 
row (int i) const
int rows () const
int stride () const
template<typename OtherDerived >
void swap (const MatrixBase< OtherDerived > &other)

Protected Attributes

const MatrixType::Nested m_matrix

Detailed Description

Expression of a triangular matrix extracted from a given matrix.

Warning:
This is not considered to be part of the stable public API yet. Changes may happen in future releases. See Experimental parts of Eigen
Parameters:
MatrixTypethe type of the object in which we are taking the triangular part
Modethe kind of triangular matrix expression to construct. Can be UpperTriangular, StrictlyUpperTriangular, UnitUpperTriangular, LowerTriangular, StrictlyLowerTriangular, UnitLowerTriangular. This is in fact a bit field; it must have either UpperTriangularBit or LowerTriangularBit, and additionnaly it may have either ZeroDiagBit or UnitDiagBit.

This class represents an expression of the upper or lower triangular part of a square matrix, possibly with a further assumption on the diagonal. It is the return type of MatrixBase::part() and most of the time this is the only way it is used.

See also:
MatrixBase::part()

Member Function Documentation

const Block<Part, RowsAtCompileTime, 1> col ( int  i) [inline]

discard any writes to a column

Reimplemented from MatrixBase< Part< MatrixType, Mode > >.

int cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from MatrixBase< Part< MatrixType, Mode > >.

void lazyAssign ( const Other &  other)
See also:
operator=(), MatrixBase::lazyAssign()
Part< MatrixType, Mode > & operator*= ( const typename ei_traits< MatrixType >::Scalar &  other) [inline]
See also:
MatrixBase::operator*=()
Part< MatrixType, Mode > & operator+= ( const Other &  other) [inline]
Part< MatrixType, Mode > & operator-= ( const Other &  other) [inline]
Part< MatrixType, Mode > & operator/= ( const typename ei_traits< MatrixType >::Scalar &  other) [inline]
See also:
MatrixBase::operator/=()
Part< MatrixType, Mode > & operator= ( const Other &  other) [inline]
const Block<Part, 1, ColsAtCompileTime> row ( int  i) [inline]

discard any writes to a row

Reimplemented from MatrixBase< Part< MatrixType, Mode > >.

int rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from MatrixBase< Part< MatrixType, Mode > >.

int stride ( void  ) const [inline]
Returns:
number of elements to skip to pass from one row (resp. column) to another for a row-major (resp. column-major) matrix. Combined with coeffRef() and the flags flags, it allows a direct access to the data of the underlying matrix.

Reimplemented from MatrixBase< Part< MatrixType, Mode > >.


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