DGtal::concepts::CDenseMatrix< T > Struct Template Reference

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

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

Inheritance diagram for DGtal::concepts::CDenseMatrix< T >:

Public Types
typedef T::Index	Index
typedef T::Scalar	Scalar
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 (CDenseMatrix)
void	checkConstConstraints () const
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
T	z
Index	i
Index	j

Detailed Description

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

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

Description of concept 'CDenseMatrix'

Refinement of

• CMatrix

Associated types

Notation

• DenseMatrix : A type that is a model of CDenseMatrix
• i, j : object of type DenseMatrix::Index

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Constant ref random accessor	x(i, j)		const Scalar&
Ref random accessor	z(i, j)		Scalar&

Invariants

Models

• SimpleMatrix

Notes

Template Parameters

T	the type that should be a model of CDenseMatrix.

Definition at line 88 of file CDenseMatrix.h.

Member Typedef Documentation

Index

template<typename T >

typedef T::Index DGtal::concepts::CDenseMatrix< T >::Index

Definition at line 92 of file CDenseMatrix.h.

Scalar

template<typename T >

typedef T::Scalar DGtal::concepts::CDenseMatrix< T >::Scalar

Definition at line 93 of file CDenseMatrix.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CDenseMatrix< T >::BOOST_CONCEPT_USAGE ( CDenseMatrix< T >  )

inline

Definition at line 95 of file CDenseMatrix.h.

    {
      Scalar& aa = z(i, j);
      (void)aa; // to avoid compiler warning     
      checkConstConstraints();
    }

References DGtal::concepts::CDenseMatrix< T >::checkConstConstraints(), DGtal::concepts::CDenseMatrix< T >::i, DGtal::concepts::CDenseMatrix< T >::j, and DGtal::concepts::CDenseMatrix< T >::z.

checkConstConstraints()

template<typename T >

void DGtal::concepts::CDenseMatrix< T >::checkConstConstraints ( ) const

inline

Definition at line 102 of file CDenseMatrix.h.

    {
      Scalar bb = z(i, j);
      (void)bb; // to avoid compiler warning
    }

References DGtal::concepts::CDenseMatrix< T >::i, DGtal::concepts::CDenseMatrix< T >::j, and DGtal::concepts::CDenseMatrix< T >::z.

Referenced by DGtal::concepts::CDenseMatrix< T >::BOOST_CONCEPT_USAGE().

Field Documentation

i

template<typename T >

Index DGtal::concepts::CDenseMatrix< T >::i

private

Definition at line 111 of file CDenseMatrix.h.

Referenced by DGtal::concepts::CDenseMatrix< T >::BOOST_CONCEPT_USAGE(), and DGtal::concepts::CDenseMatrix< T >::checkConstConstraints().

j

template<typename T >

Index DGtal::concepts::CDenseMatrix< T >::j

private

Definition at line 111 of file CDenseMatrix.h.

Referenced by DGtal::concepts::CDenseMatrix< T >::BOOST_CONCEPT_USAGE(), and DGtal::concepts::CDenseMatrix< T >::checkConstConstraints().

z

template<typename T >

T DGtal::concepts::CDenseMatrix< T >::z

private

Definition at line 110 of file CDenseMatrix.h.

Referenced by DGtal::concepts::CDenseMatrix< T >::BOOST_CONCEPT_USAGE(), and DGtal::concepts::CDenseMatrix< T >::checkConstConstraints().

---

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

• CDenseMatrix.h