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::CCurveLocalGeometricEstimator< T > Struct Template Reference

Aim: This concept describes an object that can process a range so as to return one estimated quantity for each element of the range (or a given subrange). More...

#include <DGtal/geometry/curves/estimation/CCurveLocalGeometricEstimator.h>

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

Public Types

typedef T::Quantity Quantity
typedef T::ConstIterator ConstIterator

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CQuantity< Quantity >))
 BOOST_CONCEPT_ASSERT ((boost_concepts::ReadableIteratorConcept< ConstIterator >))
 BOOST_CONCEPT_ASSERT ((boost_concepts::ForwardTraversalConcept< ConstIterator >))
 BOOST_CONCEPT_USAGE (CCurveLocalGeometricEstimator)

Private Attributes

myX
double myH
ConstIterator myItb
ConstIterator myIte
Quantity myQ
boost::iterator_archetype< Quantity, boost::iterator_archetypes::writable_iterator_t, boost::incrementable_traversal_tag > myIto

Detailed Description

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

Aim: This concept describes an object that can process a range so as to return one estimated quantity for each element of the range (or a given subrange).

Description of concept 'CCurveLocalGeometricEstimator'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Return type Precondition Semantics Complexity
Initialization x.init( h, itb, ite ) void h > 0 Grid step and range initialization constant
Evaluation x.eval( it ) Quantity Estimation of the quantity at it model dependant
Evaluation ito = x.eval( itb, ite, ito ) a model of output iterator Estimation for each element of [itb, ite) model dependant

Invariants

Models

Notes

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

Definition at line 98 of file CCurveLocalGeometricEstimator.h.

Member Typedef Documentation

◆ ConstIterator

template<typename T>
typedef T::ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::ConstIterator

Definition at line 107 of file CCurveLocalGeometricEstimator.h.

◆ Quantity

template<typename T>
typedef T::Quantity DGtal::concepts::CCurveLocalGeometricEstimator< T >::Quantity

Definition at line 104 of file CCurveLocalGeometricEstimator.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/3]

◆ BOOST_CONCEPT_ASSERT() [2/3]

◆ BOOST_CONCEPT_ASSERT() [3/3]

template<typename T>
DGtal::concepts::CCurveLocalGeometricEstimator< T >::BOOST_CONCEPT_ASSERT ( (concepts::CQuantity< Quantity >) )

◆ BOOST_CONCEPT_USAGE()

Field Documentation

◆ myH

template<typename T>
double DGtal::concepts::CCurveLocalGeometricEstimator< T >::myH
private

Definition at line 122 of file CCurveLocalGeometricEstimator.h.

◆ myItb

template<typename T>
ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::myItb
private

Definition at line 123 of file CCurveLocalGeometricEstimator.h.

Referenced by BOOST_CONCEPT_USAGE().

◆ myIte

template<typename T>
ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIte
private

Definition at line 123 of file CCurveLocalGeometricEstimator.h.

Referenced by BOOST_CONCEPT_USAGE().

◆ myIto

template<typename T>
boost::iterator_archetype<Quantity, boost::iterator_archetypes::writable_iterator_t, boost::incrementable_traversal_tag > DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIto
private

Definition at line 127 of file CCurveLocalGeometricEstimator.h.

Referenced by BOOST_CONCEPT_USAGE().

◆ myQ

template<typename T>
Quantity DGtal::concepts::CCurveLocalGeometricEstimator< T >::myQ
private

Definition at line 124 of file CCurveLocalGeometricEstimator.h.

Referenced by BOOST_CONCEPT_USAGE().

◆ myX

template<typename T>
T DGtal::concepts::CCurveLocalGeometricEstimator< T >::myX
private

Definition at line 120 of file CCurveLocalGeometricEstimator.h.

Referenced by BOOST_CONCEPT_USAGE().


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