DGtal  1.5.beta
DGtal::concepts::CPrimitiveComputer< T > Struct Template Reference

Aim: Defines the concept describing an object that computes some primitive from input points, 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/CPrimitiveComputer.h>

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

Public Types

typedef T::Primitive Primitive
 
typedef T::Space Space
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CPrimitiveComputer)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
Primitive myP
 

Detailed Description

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

Aim: Defines the concept describing an object that computes some primitive from input points, 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 'CPrimitiveComputer'

Refinement of boost::DefaultConstructible<T>, boost::CopyConstructible<T>, boost::Assignable<T>

Associated types

  • Space, the type that defines the digital space.
  • Primitive, the type that defines the primitive.

Notation

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
access to primitive x.primitive() Primitive returns a primitive that represents the current solution O(1)

Invariants

Models

Notes

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

Definition at line 95 of file CPrimitiveComputer.h.

Member Typedef Documentation

◆ Primitive

template<typename T >
typedef T::Primitive DGtal::concepts::CPrimitiveComputer< T >::Primitive

Definition at line 100 of file CPrimitiveComputer.h.

◆ Space

template<typename T >
typedef T::Space DGtal::concepts::CPrimitiveComputer< T >::Space

Definition at line 101 of file CPrimitiveComputer.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

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

◆ checkConstConstraints()

Field Documentation

◆ myP

template<typename T >
Primitive DGtal::concepts::CPrimitiveComputer< T >::myP
private

◆ myX

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

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