File failed to load: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/config/TeX-MML-AM_CHTML/MathJax.js
DGtal 2.0.0
DGtal::concepts::CVector< T > Struct Template Reference

Aim: Represent any static or dynamic sized column vector having sparse or dense representation. More...

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

Inheritance diagram for DGtal::concepts::CVector< 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 (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::CVector< T >

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

Description of concept 'CVector'

Refinement of

Associated types

Notation

  • Vector : A type that is a model of CVector
  • x : const object of type Vector
  • z : object of type Vector
  • i : object of type Vector::Index

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Number of rows x.rows() Index Returns the size of the vector

Invariants

Models

EigenLinearAlgebraBackend::DenseVector, SimpleMatrix::Vector

Notes

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

Definition at line 90 of file CVector.h.

Member Typedef Documentation

◆ Index

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

Definition at line 95 of file CVector.h.

◆ Scalar

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

Definition at line 94 of file CVector.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 97 of file CVector.h.

98 {
100 }
void checkConstConstraints() const
Definition CVector.h:102

References checkConstConstraints().

◆ checkConstConstraints()

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

Definition at line 102 of file CVector.h.

103 {
104 ConceptUtils::sameType(i, z.rows());
105 }
void sameType(const T &, const T &)

References i, DGtal::concepts::ConceptUtils::sameType(), and z.

Referenced by BOOST_CONCEPT_USAGE().

Field Documentation

◆ i

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

Definition at line 110 of file CVector.h.

Referenced by checkConstConstraints().

◆ z

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

Definition at line 109 of file CVector.h.

Referenced by checkConstConstraints().


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