DGtal  1.4.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CSparseMatrix< T, TripletInterator > Struct Template Reference

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

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

Inheritance diagram for DGtal::concepts::CSparseMatrix< T, TripletInterator >:
[legend]

Public Types

typedef T::Index Index
 
- 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_ASSERT ((boost::InputIterator< TripletInterator >))
 
 BOOST_CONCEPT_USAGE (CSparseMatrix)
 
- 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

z
 
TripletInterator ti
 
TripletInterator te
 

Detailed Description

template<typename T, typename TripletInterator>
struct DGtal::concepts::CSparseMatrix< T, TripletInterator >

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

Description of concept 'CSparseMatrix'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Fill from triplets x.setFromTriplets(ti,te)

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CSparseMatrix.
TripletInteratorthe type that should be a model of boost::InputIterator<Triplet>

Definition at line 89 of file CSparseMatrix.h.

Member Typedef Documentation

◆ Index

template<typename T , typename TripletInterator >
typedef T::Index DGtal::concepts::CSparseMatrix< T, TripletInterator >::Index

Definition at line 93 of file CSparseMatrix.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename T , typename TripletInterator >
DGtal::concepts::CSparseMatrix< T, TripletInterator >::BOOST_CONCEPT_ASSERT ( (boost::InputIterator< TripletInterator >)  )

◆ BOOST_CONCEPT_USAGE()

template<typename T , typename TripletInterator >
DGtal::concepts::CSparseMatrix< T, TripletInterator >::BOOST_CONCEPT_USAGE ( CSparseMatrix< T, TripletInterator >  )
inline

Definition at line 97 of file CSparseMatrix.h.

98  {
99  z.setFromTriplets(ti, te);
100  }

References DGtal::concepts::CSparseMatrix< T, TripletInterator >::te, and DGtal::concepts::CSparseMatrix< T, TripletInterator >::ti.

Field Documentation

◆ te

template<typename T , typename TripletInterator >
TripletInterator DGtal::concepts::CSparseMatrix< T, TripletInterator >::te
private

◆ ti

template<typename T , typename TripletInterator >
TripletInterator DGtal::concepts::CSparseMatrix< T, TripletInterator >::ti
private

◆ z

template<typename T , typename TripletInterator >
T DGtal::concepts::CSparseMatrix< T, TripletInterator >::z
private

Definition at line 104 of file CSparseMatrix.h.


The documentation for this struct was generated from the following file:
DGtal::concepts::CSparseMatrix::ti
TripletInterator ti
Definition: CSparseMatrix.h:105
DGtal::concepts::CSparseMatrix::te
TripletInterator te
Definition: CSparseMatrix.h:105