Part< MatrixType, Mode > Class Template Reference

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

#include <Part.h>

Inheritance diagram for Part< MatrixType, Mode >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const MatrixType & _expression () const
Scalar coeff (int row, int col) const
ScalarcoeffRef (int row, int col)
const Block< Part,
RowsAtCompileTime, 1 > 
col (int i) const
const Block< Part,
RowsAtCompileTime, 1 > 
col (int i)
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
const Block< Part,
1, ColsAtCompileTime > 
row (int i)
int rows () const
int stride () const
template<typename OtherDerived >
void swap (const MatrixBase< OtherDerived > &other)

Protected Attributes

const MatrixType::Nested m_matrix

Private Member Functions

Partoperator= (const Part &)

Detailed Description

template<typename MatrixType, unsigned int Mode>
class Part< MatrixType, Mode >

Expression of a triangular matrix extracted from a given matrix.

Parameters:
MatrixType the type of the object in which we are taking the triangular part
Mode the 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()

Definition at line 57 of file Part.h.


Constructor & Destructor Documentation

template<typename MatrixType, unsigned int Mode>
Part< MatrixType, Mode >::Part ( const MatrixType &  matrix  )  [inline]

Definition at line 64 of file Part.h.


Member Function Documentation

template<typename MatrixType, unsigned int Mode>
const MatrixType& Part< MatrixType, Mode >::_expression (  )  const [inline]

Definition at line 111 of file Part.h.

template<typename MatrixType, unsigned int Mode>
Scalar Part< MatrixType, Mode >::coeff ( int  row,
int  col 
) const [inline]

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

Definition at line 85 of file Part.h.

template<typename MatrixType, unsigned int Mode>
Scalar& Part< MatrixType, Mode >::coeffRef ( int  row,
int  col 
) [inline]

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

Definition at line 99 of file Part.h.

template<typename MatrixType, unsigned int Mode>
const Block<Part, RowsAtCompileTime, 1> Part< MatrixType, Mode >::col ( int  i  )  const [inline]

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

Definition at line 118 of file Part.h.

template<typename MatrixType, unsigned int Mode>
const Block<Part, RowsAtCompileTime, 1> Part< MatrixType, Mode >::col ( int  i  )  [inline]

discard any writes to a column

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

Definition at line 117 of file Part.h.

template<typename MatrixType, unsigned int Mode>
int Part< MatrixType, Mode >::cols ( void   )  const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

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

Definition at line 82 of file Part.h.

template<typename MatrixType , unsigned int Mode>
template<typename Other >
void Part< MatrixType, Mode >::lazyAssign ( const Other &  other  )  [inline]
See also:
operator=(), MatrixBase::lazyAssign()

Definition at line 274 of file Part.h.

template<typename MatrixType , unsigned int Mode>
Part< MatrixType, Mode > & Part< MatrixType, Mode >::operator*= ( const typename ei_traits< MatrixType >::Scalar other  )  [inline]
See also:
MatrixBase::operator*=()

Definition at line 365 of file Part.h.

template<typename MatrixType , unsigned int Mode>
template<typename Other >
Part< MatrixType, Mode > & Part< MatrixType, Mode >::operator+= ( const Other &  other  )  [inline]
See also:
MatrixBase::operator+=()

Definition at line 351 of file Part.h.

template<typename MatrixType , unsigned int Mode>
template<typename Other >
Part< MatrixType, Mode > & Part< MatrixType, Mode >::operator-= ( const Other &  other  )  [inline]
See also:
MatrixBase::operator-=()

Definition at line 358 of file Part.h.

template<typename MatrixType , unsigned int Mode>
Part< MatrixType, Mode > & Part< MatrixType, Mode >::operator/= ( const typename ei_traits< MatrixType >::Scalar other  )  [inline]
See also:
MatrixBase::operator/=()

Definition at line 372 of file Part.h.

template<typename MatrixType, unsigned int Mode>
Part& Part< MatrixType, Mode >::operator= ( const Part< MatrixType, Mode > &   )  [private]
template<typename MatrixType , unsigned int Mode>
template<typename Other >
Part< MatrixType, Mode > & Part< MatrixType, Mode >::operator= ( const Other &  other  )  [inline]
See also:
MatrixBase::operator=()

Definition at line 155 of file Part.h.

template<typename MatrixType, unsigned int Mode>
const Block<Part, 1, ColsAtCompileTime> Part< MatrixType, Mode >::row ( int  i  )  const [inline]

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

Definition at line 115 of file Part.h.

template<typename MatrixType, unsigned int Mode>
const Block<Part, 1, ColsAtCompileTime> Part< MatrixType, Mode >::row ( int  i  )  [inline]

discard any writes to a row

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

Definition at line 114 of file Part.h.

template<typename MatrixType, unsigned int Mode>
int Part< MatrixType, Mode >::rows ( void   )  const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

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

Definition at line 81 of file Part.h.

template<typename MatrixType, unsigned int Mode>
int Part< MatrixType, Mode >::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 > >.

Definition at line 83 of file Part.h.

template<typename MatrixType, unsigned int Mode>
template<typename OtherDerived >
void Part< MatrixType, Mode >::swap ( const MatrixBase< OtherDerived > &  other  )  [inline]

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

Definition at line 121 of file Part.h.


Member Data Documentation

template<typename MatrixType, unsigned int Mode>
const MatrixType::Nested Part< MatrixType, Mode >::m_matrix [protected]

Definition at line 127 of file Part.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


vcglib
Author(s): Christian Bersch
autogenerated on Fri Jan 11 09:22:18 2013