DGtal  1.5.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CIncrementalPrimitiveComputer< T > Struct Template Reference
DGtal Concepts

Aim: Defines the concept describing an object that computes some primitive from input points given one at a time, while keeping some internal state. At any moment, the object is supposed to store at least one valid primitive for the formerly given input points. A primitive is an informal word that describes some family of objects that share common characteristics. Often, the primitives are geometric, e.g. digital planes. More...

#include <DGtal/geometry/surfaces/CIncrementalPrimitiveComputer.h>

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

Public Types

typedef T::Point Point
 
- Public Types inherited from DGtal::concepts::CPrimitiveComputer< T >
typedef T::Primitive Primitive
 
typedef T::Space Space
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CIncrementalPrimitiveComputer)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CPrimitiveComputer< T >
 BOOST_CONCEPT_USAGE (CPrimitiveComputer)
 
void checkConstConstraints () const
 

Private Attributes

T myX
 
Point myPoint
 
bool myBool
 

Detailed Description

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

Aim: Defines the concept describing an object that computes some primitive from input points given one at a time, while keeping some internal state. At any moment, the object is supposed to store at least one valid primitive for the formerly given input points. A primitive is an informal word that describes some family of objects that share common characteristics. Often, the primitives are geometric, e.g. digital planes.

Description of concept 'CIncrementalPrimitiveComputer'

Refinement of CPrimitiveComputer

Associated types

  • Primitive, the type that defines the primitive.
  • Point: the type of the input points.

Notation

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
insert new point x.extend(p) bool tries to find a primitive that matches the new point p and all formerly given input points, return true on success (state may change), false otherwise (state is unchanged)
check new point x.isExtendable(p) bool tries to find a primitive that matches the new point p and all formerly given input points, return true only if it possible, the state is always unchanged

Invariants

Models

Notes

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

Definition at line 99 of file CIncrementalPrimitiveComputer.h.

Member Typedef Documentation

◆ Point

template<typename T >
typedef T::Point DGtal::concepts::CIncrementalPrimitiveComputer< T >::Point

Definition at line 104 of file CIncrementalPrimitiveComputer.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

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

Definition at line 107 of file CIncrementalPrimitiveComputer.h.

108  {
109  ConceptUtils::sameType( myBool, myX.extend( myPoint ) );
110  checkConstConstraints();
111  }
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117

References DGtal::concepts::CIncrementalPrimitiveComputer< T >::checkConstConstraints(), DGtal::concepts::CIncrementalPrimitiveComputer< T >::myBool, DGtal::concepts::CIncrementalPrimitiveComputer< T >::myPoint, DGtal::concepts::CIncrementalPrimitiveComputer< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

◆ checkConstConstraints()

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

Definition at line 112 of file CIncrementalPrimitiveComputer.h.

113  {
114  ConceptUtils::sameType( myBool, myX.isExtendable( myPoint ) );
115  }

References DGtal::concepts::CIncrementalPrimitiveComputer< T >::myBool, DGtal::concepts::CIncrementalPrimitiveComputer< T >::myPoint, DGtal::concepts::CIncrementalPrimitiveComputer< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

Referenced by DGtal::concepts::CIncrementalPrimitiveComputer< T >::BOOST_CONCEPT_USAGE().

Field Documentation

◆ myBool

template<typename T >
bool DGtal::concepts::CIncrementalPrimitiveComputer< T >::myBool
private

Definition at line 120 of file CIncrementalPrimitiveComputer.h.

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

◆ myPoint

template<typename T >
Point DGtal::concepts::CIncrementalPrimitiveComputer< T >::myPoint
private

Definition at line 119 of file CIncrementalPrimitiveComputer.h.

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

◆ myX

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

Definition at line 118 of file CIncrementalPrimitiveComputer.h.

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

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