DGtal  0.9.4beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CCurveLocalGeometricEstimator< T > Struct Template Reference

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

Inheritance diagram for DGtal::concepts::CCurveLocalGeometricEstimator< T >:
[legend]
Collaboration 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

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

Definition at line 108 of file CCurveLocalGeometricEstimator.h.

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

Definition at line 105 of file CCurveLocalGeometricEstimator.h.

Member Function Documentation

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

Definition at line 113 of file CCurveLocalGeometricEstimator.h.

References DGtal::concepts::CCurveLocalGeometricEstimator< T >::myH, DGtal::concepts::CCurveLocalGeometricEstimator< T >::myItb, DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIte, DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIto, DGtal::concepts::CCurveLocalGeometricEstimator< T >::myQ, DGtal::concepts::CCurveLocalGeometricEstimator< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

template<typename T >
double DGtal::concepts::CCurveLocalGeometricEstimator< T >::myH
private
template<typename T >
ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::myItb
private
template<typename T >
ConstIterator DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIte
private
template<typename T >
boost::iterator_archetype<Quantity, boost::iterator_archetypes::writable_iterator_t, boost::incrementable_traversal_tag > DGtal::concepts::CCurveLocalGeometricEstimator< T >::myIto
private
template<typename T >
Quantity DGtal::concepts::CCurveLocalGeometricEstimator< T >::myQ
private
template<typename T >
T DGtal::concepts::CCurveLocalGeometricEstimator< T >::myX
private

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