DGtal  0.9.3beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CMatrix< T > Struct Template Reference

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

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

Public Types

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

z
 
Index i
 
Index j
 

Detailed Description

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

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

Description of concept 'CMatrix'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Identity setter x.setIdentity()
Number of rows x.rows() Index
Number of columns x.cols() Index

Invariants

Models

Notes

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

Definition at line 90 of file CMatrix.h.

Member Typedef Documentation

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

Definition at line 95 of file CMatrix.h.

template<typename T >
typedef T::Scalar DGtal::concepts::CMatrix< T >::Scalar

Definition at line 94 of file CMatrix.h.

Member Function Documentation

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

Definition at line 97 of file CMatrix.h.

References DGtal::concepts::CMatrix< T >::checkConstConstraints().

98  {
99  z.setIdentity();
101  }
void checkConstConstraints() const
Definition: CMatrix.h:103
template<typename T >
void DGtal::concepts::CMatrix< T >::checkConstConstraints ( ) const
inline

Field Documentation

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

Definition at line 111 of file CMatrix.h.

Referenced by DGtal::concepts::CMatrix< T >::checkConstConstraints().

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

Definition at line 111 of file CMatrix.h.

Referenced by DGtal::concepts::CMatrix< T >::checkConstConstraints().

template<typename T >
T DGtal::concepts::CMatrix< T >::z
private

Definition at line 110 of file CMatrix.h.


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