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

Aim: This concept gathers models implementing an orientation test of \( k+1 \) points in a space of dimension \( n \). More...

#include <DGtal/geometry/tools/determinant/COrientationFunctor.h>

Inheritance diagram for DGtal::concepts::COrientationFunctor< T >:

Public Types

typedef T::PointArray PointArray
typedef T::SizeArray SizeArray
- Public Types inherited from DGtal::concepts::CPointFunctor< T >
typedef T::Point Point
typedef T::Value Value

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CSignedNumber< typename T::Value >))
 BOOST_CONCEPT_USAGE (COrientationFunctor)
- Public Member Functions inherited from DGtal::concepts::CUnaryFunctor< T, T::Point, T::Value >

Private Attributes

PointArray myA
SizeArray myS

Detailed Description

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

Aim: This concept gathers models implementing an orientation test of \( k+1 \) points in a space of dimension \( n \).

Description of concept 'COrientationFunctor'

The orientation of \( k+1 \) points \( (p_1, \ldots, p_{k+1}) \) is given by the sign of the algebraic distance between \( p_{k+1} \) and an algebraic variety, chosen such that it is uniquely defined by the first \( k \) points \( (p_1, \ldots, p_{k}) \).

These \( k+1 \) points are provided in two steps so that this concept is a refinement of CPointFunctor:

The returned value, which is a model of CSignedNumber, is guaranteed to be:

Refinement of CPointFunctor

Associated types

As a refinement of CPointFunctor, it has the following nested types:

In addition it has the following inner types:



Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
array dimension X::size SizeArray size of the array, equal to k
initialization x.init(a) a is of type PointArray void implicitely set the algebraic curve model-dependent


InHalfPlaneBy2x2DetComputer InHalfPlaneBySimpleMatrix InGeneralizedDiskOfGivenRadius

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

Definition at line 113 of file COrientationFunctor.h.

Member Typedef Documentation

◆ PointArray

template<typename T >
typedef T::PointArray DGtal::concepts::COrientationFunctor< T >::PointArray

Definition at line 120 of file COrientationFunctor.h.

◆ SizeArray

template<typename T >
typedef T::SizeArray DGtal::concepts::COrientationFunctor< T >::SizeArray

Definition at line 121 of file COrientationFunctor.h.

Member Function Documentation


template<typename T >
DGtal::concepts::COrientationFunctor< T >::BOOST_CONCEPT_ASSERT ( (concepts::CSignedNumber< typename T::Value >)  )


template<typename T >
DGtal::concepts::COrientationFunctor< T >::BOOST_CONCEPT_USAGE ( COrientationFunctor< T >  )

Field Documentation

◆ myA

template<typename T >
PointArray DGtal::concepts::COrientationFunctor< T >::myA

◆ myS

template<typename T >
SizeArray DGtal::concepts::COrientationFunctor< T >::myS

◆ myX

template<typename T >
T DGtal::concepts::COrientationFunctor< T >::myX

The documentation for this struct was generated from the following file:
SizeArray myS
Definition: COrientationFunctor.h:132
T myX
Definition: COrientationFunctor.h:130
PointArray myA
Definition: COrientationFunctor.h:131
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117