DGtal  1.5.beta
DGtal::concepts::CDynamicMatrix< T > Struct Template Reference

Aim: Represent any dynamic sized matrix having sparse or dense representation. More...

#include <DGtal/math/linalg/CDynamicMatrix.h>

Inheritance diagram for DGtal::concepts::CDynamicMatrix< T >:
[legend]

Public Types

typedef T::Index Index
 
- Public Types inherited from DGtal::concepts::CMatrix< T >
typedef T::Scalar Scalar
 
typedef T::Index Index
 
- Public Types inherited from DGtal::concepts::CVectorSpace< T >
typedef T::Scalar Scalar
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CDynamicMatrix)
 
- Public Member Functions inherited from DGtal::concepts::CMatrix< T >
 BOOST_CONCEPT_USAGE (CMatrix)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CVectorSpace< T >
 BOOST_CONCEPT_ASSERT ((concepts::CEuclideanRing< Scalar >))
 
 BOOST_CONCEPT_USAGE (CVectorSpace)
 

Private Attributes

Index i
 
Index j
 

Detailed Description

template<typename T>
struct DGtal::concepts::CDynamicMatrix< T >

Aim: Represent any dynamic sized matrix having sparse or dense representation.

Description of concept 'CDynamicMatrix'

Refinement of

Associated types

Notation

  • DynamicMatrix : A type that is a model of CDynamicMatrix
  • x : object of type DynamicMatrix
  • i, j : object of type DynamicMatrix::Index

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Constructor x(i, j) DynamicVector

Invariants

Models

  • Eigen::MatrixXd, Eigen::SparseMatrix, Eigen::DenseMatrix

Notes

Template Parameters
Tthe type that should be a model of CDynamicMatrix.

Definition at line 88 of file CDynamicMatrix.h.

Member Typedef Documentation

◆ Index

template<typename T >
typedef T::Index DGtal::concepts::CDynamicMatrix< T >::Index

Definition at line 92 of file CDynamicMatrix.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CDynamicMatrix< T >::BOOST_CONCEPT_USAGE ( CDynamicMatrix< T >  )
inline

Field Documentation

◆ i

template<typename T >
Index DGtal::concepts::CDynamicMatrix< T >::i
private

◆ j

template<typename T >
Index DGtal::concepts::CDynamicMatrix< T >::j
private

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