DGtal  1.1.0
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CDenseVector< T > Struct Template Reference

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

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

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

Public Types

typedef T::Index Index
 
typedef T::Scalar Scalar
 
- Public Types inherited from DGtal::concepts::CVector< 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 (CDenseVector)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CVector< T >
 BOOST_CONCEPT_USAGE (CVector)
 
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
 

Detailed Description

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

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

Description of concept 'CDenseVector'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

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

Invariants

Models

Notes

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

Definition at line 88 of file CDenseVector.h.

Member Typedef Documentation

◆ Index

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

Definition at line 92 of file CDenseVector.h.

◆ Scalar

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

Definition at line 93 of file CDenseVector.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 95 of file CDenseVector.h.

96  {
97  Scalar& aa = z(i);
98  aa = aa; // to avoid compiler warning
99 
101  }

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

◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CDenseVector< T >::checkConstConstraints ( ) const
inline

Definition at line 103 of file CDenseVector.h.

104  {
105  Scalar bb = z(i);
106  bb = bb; // to avoid compiler warning
107  }

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

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

Field Documentation

◆ i

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

◆ z

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CDenseVector::i
Index i
Definition: CDenseVector.h:112
DGtal::concepts::CDenseVector::Scalar
T::Scalar Scalar
Definition: CDenseVector.h:93
DGtal::concepts::CDenseVector::z
T z
Definition: CDenseVector.h:111
DGtal::concepts::CDenseVector::checkConstConstraints
void checkConstConstraints() const
Definition: CDenseVector.h:103