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

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

• CVector

Associated types

Notation

• DenseVector : A type that is a model of CDenseVector
• i : object of type DenseVector::Index

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

• SimpleVector

Notes

Template Parameters

T	the 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.

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

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.

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

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

Definition at line 112 of file CDenseVector.h.

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

z

template<typename T >

T DGtal::concepts::CDenseVector< T >::z

private

Definition at line 111 of file CDenseVector.h.

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

---

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

• CDenseVector.h