Public Types | Public Member Functions | Protected Attributes | List of all members
DiagonalMatrix< CoeffsVectorType > Class Template Reference

Expression of a diagonal matrix. More...

Public Types

typedef CoeffsVectorType _CoeffsVectorType
 
- Public Types inherited from MatrixBase< DiagonalMatrix< CoeffsVectorType > >
enum  
 

Public Member Functions

const Scalar coeff (int row, int col) const
 
int cols () const
 
const CoeffsVectorType & diagonal () const
 
template<typename OtherCoeffsVectorType >
 DiagonalMatrix (const DiagonalMatrix< OtherCoeffsVectorType > &other)
 
 DiagonalMatrix (const CoeffsVectorType &coeffs)
 
int rows () const
 
- Public Member Functions inherited from MatrixBase< DiagonalMatrix< CoeffsVectorType > >
const AdjointReturnType adjoint () const
 
bool all (void) const
 
bool any (void) const
 
const DiagonalMatrix
< DiagonalMatrix
< CoeffsVectorType > > 
asDiagonal () const
 
const CwiseBinaryOp
< CustomBinaryOp,
DiagonalMatrix
< CoeffsVectorType >
, OtherDerived > 
binaryExpr (const MatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType > >::Type 
block (int startRow, int startCol, int blockRows, int blockCols)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType > >::Type 
block (int startRow, int startCol, int blockRows, int blockCols) const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >
, BlockRows, BlockCols >::Type 
block (int startRow, int startCol)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >
, BlockRows, BlockCols >::Type 
block (int startRow, int startCol) const
 
const CwiseUnaryOp
< ei_scalar_cast_op< typename
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar,
NewType >, DiagonalMatrix
< CoeffsVectorType > > 
cast () const
 
const Scalar coeff (int row, int col) const
 
const Scalar coeff (int index) const
 
Scalar & coeffRef (int row, int col)
 
Scalar & coeffRef (int index)
 
ColXpr col (int i)
 
const ColXpr col (int i) const
 
int cols () const
 
const PartialRedux
< DiagonalMatrix
< CoeffsVectorType >, Vertical > 
colwise () const
 
void computeInverse (MatrixBase< ResultType > *result) const
 
ConjugateReturnType conjugate () const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType > >::Type 
corner (CornerType type, int cRows, int cCols)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType > >::Type 
corner (CornerType type, int cRows, int cCols) const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, CRows,
CCols >::Type 
corner (CornerType type)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, CRows,
CCols >::Type 
corner (CornerType type) const
 
int count () const
 
PlainMatrixType cross (const MatrixBase< OtherDerived > &other) const
 
const Cwise< DiagonalMatrix
< CoeffsVectorType > > 
cwise () const
 
Cwise< DiagonalMatrix
< CoeffsVectorType > > 
cwise ()
 
Scalar determinant () const
 
DiagonalCoeffs< DiagonalMatrix
< CoeffsVectorType > > 
diagonal ()
 
const DiagonalCoeffs
< DiagonalMatrix
< CoeffsVectorType > > 
diagonal () const
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
EigenvaluesReturnType eigenvalues () const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Dynamic >
::SubVectorType 
end (int size)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Dynamic >
::SubVectorType 
end (int size) const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Size >
::SubVectorType 
end ()
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Size >
::SubVectorType 
end () const
 
Matrix< Scalar, 3, 1 > eulerAngles (int a0, int a1, int a2) const
 
const ei_eval< DiagonalMatrix
< CoeffsVectorType > >::type 
eval () const
 
void fill (const Scalar &value)
 
const WithFormat
< DiagonalMatrix
< CoeffsVectorType > > 
format (const IOFormat &fmt) const
 
const ImagReturnType imag () const
 
int innerSize () const
 
const PlainMatrixType inverse () const
 
bool isApprox (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
 
bool isApproxToConstant (const Scalar &value, RealScalar prec=precision< Scalar >()) const
 
bool isConstant (const Scalar &value, RealScalar prec=precision< Scalar >()) const
 
bool isDiagonal (RealScalar prec=precision< Scalar >()) const
 
bool isIdentity (RealScalar prec=precision< Scalar >()) const
 
bool isLowerTriangular (RealScalar prec=precision< Scalar >()) const
 
bool isMuchSmallerThan (const RealScalar &other, RealScalar prec=precision< Scalar >()) const
 
bool isMuchSmallerThan (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
 
bool isOnes (RealScalar prec=precision< Scalar >()) const
 
bool isOrthogonal (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
 
bool isUnitary (RealScalar prec=precision< Scalar >()) const
 
bool isUpperTriangular (RealScalar prec=precision< Scalar >()) const
 
bool isVector () const
 
bool isZero (RealScalar prec=precision< Scalar >()) const
 
const Flagged< DiagonalMatrix
< CoeffsVectorType >
, 0, EvalBeforeNestingBit|EvalBeforeAssigningBit > 
lazy () const
 
DiagonalMatrix
< CoeffsVectorType > & 
lazyAssign (const SparseProduct< Derived1, Derived2, SparseTimeDenseProduct > &product)
 
DiagonalMatrix
< CoeffsVectorType > & 
lazyAssign (const SparseProduct< Derived1, Derived2, DenseTimeSparseProduct > &product)
 
const LDLT< PlainMatrixType > ldlt () const
 
const LLT< PlainMatrixType > llt () const
 
RealScalar lpNorm () const
 
const LU< PlainMatrixType > lu () const
 
const Flagged< DiagonalMatrix
< CoeffsVectorType >, Added, 0 > 
marked () const
 
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar 
maxCoeff () const
 
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar 
maxCoeff (int *row, int *col) const
 
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar 
maxCoeff (int *index) const
 
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar 
minCoeff () const
 
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar 
minCoeff (int *row, int *col) const
 
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar 
minCoeff (int *index) const
 
Minor< DiagonalMatrix
< CoeffsVectorType > > 
minor (int row, int col)
 
const Minor< DiagonalMatrix
< CoeffsVectorType > > 
minor (int row, int col) const
 
const NestByValue
< DiagonalMatrix
< CoeffsVectorType > > 
nestByValue () const
 
int nonZeros () const
 
RealScalar norm () const
 
void normalize ()
 
const PlainMatrixType normalized () const
 
bool operator!= (const MatrixBase< OtherDerived > &other) const
 
const Scalar operator() (int row, int col) const
 
Scalar & operator() (int row, int col)
 
const Scalar operator() (int index) const
 
Scalar & operator() (int index)
 
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
 
const ProductReturnType
< DiagonalMatrix
< CoeffsVectorType >
, OtherDerived >::Type 
operator* (const MatrixBase< OtherDerived > &other) const
 
DiagonalMatrix
< CoeffsVectorType > & 
operator*= (const Scalar &other)
 
DiagonalMatrix
< CoeffsVectorType > & 
operator*= (const MatrixBase< OtherDerived > &other)
 
const CwiseBinaryOp
< ei_scalar_sum_op< typename
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar >
, DiagonalMatrix
< CoeffsVectorType >
, OtherDerived > 
operator+ (const MatrixBase< OtherDerived > &other) const
 
DiagonalMatrix
< CoeffsVectorType > & 
operator+= (const MatrixBase< OtherDerived > &other)
 
DiagonalMatrix
< CoeffsVectorType > & 
operator+= (const Flagged< Product< Lhs, Rhs, CacheFriendlyProduct >, 0, EvalBeforeNestingBit|EvalBeforeAssigningBit > &other)
 
const CwiseUnaryOp
< ei_scalar_opposite_op
< typename ei_traits
< DiagonalMatrix
< CoeffsVectorType > >::Scalar >
, DiagonalMatrix
< CoeffsVectorType > > 
operator- () const
 
const CwiseBinaryOp
< ei_scalar_difference_op
< typename ei_traits
< DiagonalMatrix
< CoeffsVectorType > >::Scalar >
, DiagonalMatrix
< CoeffsVectorType >
, OtherDerived > 
operator- (const MatrixBase< OtherDerived > &other) const
 
DiagonalMatrix
< CoeffsVectorType > & 
operator-= (const MatrixBase< OtherDerived > &other)
 
const CwiseUnaryOp
< ei_scalar_quotient1_op
< typename ei_traits
< DiagonalMatrix
< CoeffsVectorType > >::Scalar >
, DiagonalMatrix
< CoeffsVectorType > > 
operator/ (const Scalar &scalar) const
 
DiagonalMatrix
< CoeffsVectorType > & 
operator/= (const Scalar &other)
 
CommaInitializer
< DiagonalMatrix
< CoeffsVectorType > > 
operator<< (const Scalar &s)
 
CommaInitializer
< DiagonalMatrix
< CoeffsVectorType > > 
operator<< (const MatrixBase< OtherDerived > &other)
 
DiagonalMatrix
< CoeffsVectorType > & 
operator= (const MatrixBase< OtherDerived > &other)
 
DiagonalMatrix
< CoeffsVectorType > & 
operator= (const MatrixBase &other)
 
bool operator== (const MatrixBase< OtherDerived > &other) const
 
const Scalar operator[] (int index) const
 
Scalar & operator[] (int index)
 
RealScalar operatorNorm () const
 
int outerSize () const
 
PacketScalar packet (int row, int col) const
 
PacketScalar packet (int index) const
 
Part< DiagonalMatrix
< CoeffsVectorType >, Mode > 
part ()
 
const Part< DiagonalMatrix
< CoeffsVectorType >, Mode > 
part () const
 
const QR< PlainMatrixType > qr () const
 
const RealReturnType real () const
 
ei_result_of< BinaryOp(typename
ei_traits< DiagonalMatrix
< CoeffsVectorType > >::Scalar)>
::type 
redux (const BinaryOp &func) const
 
RowXpr row (int i)
 
const RowXpr row (int i) const
 
int rows () const
 
const PartialRedux
< DiagonalMatrix
< CoeffsVectorType >
, Horizontal > 
rowwise () const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >
>::SubVectorType 
segment (int start, int size)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >
>::SubVectorType 
segment (int start, int size) const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Size >
::SubVectorType 
segment (int start)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Size >
::SubVectorType 
segment (int start) const
 
const Select< DiagonalMatrix
< CoeffsVectorType >
, ThenDerived, ElseDerived > 
select (const MatrixBase< ThenDerived > &thenMatrix, const MatrixBase< ElseDerived > &elseMatrix) const
 
const Select< DiagonalMatrix
< CoeffsVectorType >
, ThenDerived, NestByValue
< typename
ThenDerived::ConstantReturnType > > 
select (const MatrixBase< ThenDerived > &thenMatrix, typename ThenDerived::Scalar elseScalar) const
 
const Select< DiagonalMatrix
< CoeffsVectorType >
, NestByValue< typename
ElseDerived::ConstantReturnType >
, ElseDerived > 
select (typename ElseDerived::Scalar thenScalar, const MatrixBase< ElseDerived > &elseMatrix) const
 
DiagonalMatrix
< CoeffsVectorType > & 
setConstant (const Scalar &value)
 
DiagonalMatrix
< CoeffsVectorType > & 
setIdentity ()
 
DiagonalMatrix
< CoeffsVectorType > & 
setOnes ()
 
DiagonalMatrix
< CoeffsVectorType > & 
setRandom ()
 
DiagonalMatrix
< CoeffsVectorType > & 
setZero ()
 
int size () const
 
ei_plain_matrix_type_column_major
< OtherDerived >::type 
solveTriangular (const MatrixBase< OtherDerived > &other) const
 
void solveTriangularInPlace (const MatrixBase< OtherDerived > &other) const
 
RealScalar squaredNorm () const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Dynamic >
::SubVectorType 
start (int size)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Dynamic >
::SubVectorType 
start (int size) const
 
BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Size >
::SubVectorType 
start (void)
 
const BlockReturnType
< DiagonalMatrix
< CoeffsVectorType >, Size >
::SubVectorType 
start () const
 
int stride (void) const
 
Scalar sum () const
 
SVD< PlainMatrixType > svd () const
 
void swap (const MatrixBase< OtherDerived > &other)
 
Scalar trace () const
 
Eigen::Transpose
< DiagonalMatrix
< CoeffsVectorType > > 
transpose ()
 
const Eigen::Transpose
< DiagonalMatrix
< CoeffsVectorType > > 
transpose () const
 
void transposeInPlace ()
 
const CwiseUnaryOp
< CustomUnaryOp,
DiagonalMatrix
< CoeffsVectorType > > 
unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 
PlainMatrixType unitOrthogonal (void) const
 
void visit (Visitor &func) const
 
const Scalar w () const
 
Scalar & w ()
 
void writePacket (int row, int col, const PacketScalar &x)
 
void writePacket (int index, const PacketScalar &x)
 
const Scalar x () const
 
Scalar & x ()
 
const Scalar y () const
 
Scalar & y ()
 
const Scalar z () const
 
Scalar & z ()
 

Protected Attributes

const CoeffsVectorType::Nested m_coeffs
 

Additional Inherited Members

- Static Public Member Functions inherited from MatrixBase< DiagonalMatrix< CoeffsVectorType > >
static const ConstantReturnType Constant (int rows, int cols, const Scalar &value)
 
static const ConstantReturnType Constant (int size, const Scalar &value)
 
static const ConstantReturnType Constant (const Scalar &value)
 
static const IdentityReturnType Identity ()
 
static const IdentityReturnType Identity (int rows, int cols)
 
static const CwiseNullaryOp
< CustomNullaryOp,
DiagonalMatrix
< CoeffsVectorType > > 
NullaryExpr (int rows, int cols, const CustomNullaryOp &func)
 
static const CwiseNullaryOp
< CustomNullaryOp,
DiagonalMatrix
< CoeffsVectorType > > 
NullaryExpr (int size, const CustomNullaryOp &func)
 
static const CwiseNullaryOp
< CustomNullaryOp,
DiagonalMatrix
< CoeffsVectorType > > 
NullaryExpr (const CustomNullaryOp &func)
 
static const ConstantReturnType Ones (int rows, int cols)
 
static const ConstantReturnType Ones (int size)
 
static const ConstantReturnType Ones ()
 
static const CwiseNullaryOp
< ei_scalar_random_op< Scalar >
, DiagonalMatrix
< CoeffsVectorType > > 
Random (int rows, int cols)
 
static const CwiseNullaryOp
< ei_scalar_random_op< Scalar >
, DiagonalMatrix
< CoeffsVectorType > > 
Random (int size)
 
static const CwiseNullaryOp
< ei_scalar_random_op< Scalar >
, DiagonalMatrix
< CoeffsVectorType > > 
Random ()
 
static const BasisReturnType Unit (int size, int i)
 
static const BasisReturnType Unit (int i)
 
static const BasisReturnType UnitW ()
 
static const BasisReturnType UnitX ()
 
static const BasisReturnType UnitY ()
 
static const BasisReturnType UnitZ ()
 
static const ConstantReturnType Zero (int rows, int cols)
 
static const ConstantReturnType Zero (int size)
 
static const ConstantReturnType Zero ()
 
- Protected Member Functions inherited from MatrixBase< DiagonalMatrix< CoeffsVectorType > >
 MatrixBase ()
 

Detailed Description

template<typename CoeffsVectorType>
class Eigen::DiagonalMatrix< CoeffsVectorType >

Expression of a diagonal 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
CoeffsVectorTypethe type of the vector of diagonal coefficients

This class is an expression of a diagonal matrix with given vector of diagonal coefficients. It is the return type of MatrixBase::diagonal(const OtherDerived&) and most of the time this is the only way it is used.

See Also
MatrixBase::diagonal(const OtherDerived&)

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