DGtal::concepts::COrientationFunctor2< T > Struct Template Reference

Aim: This concept is a refinement of COrientationFunctor, useful for simple algebraic curves that can be uniquely defined by only two points.
More...

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

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

Public Member Functions
	BOOST_CONCEPT_USAGE (COrientationFunctor2)
Public Member Functions inherited from DGtal::concepts::COrientationFunctor< T >
	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 >
	BOOST_CONCEPT_USAGE (CUnaryFunctor)

Private Attributes
T	myX
T::Point	myA
T::Point	myB

Additional Inherited Members
Public Types inherited from DGtal::concepts::COrientationFunctor< T >
typedef T::PointArray	PointArray
typedef T::SizeArray	SizeArray
Public Types inherited from DGtal::concepts::CPointFunctor< T >
typedef T::Point	Point
typedef T::Value	Value

Detailed Description

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

Aim: This concept is a refinement of COrientationFunctor, useful for simple algebraic curves that can be uniquely defined by only two points.

Description of concept 'COrientationFunctor2'

Refinement of COrientationFunctor

Associated types

Notation

• X : A type that is a model of COrientationFunctor2
• x : object of type X
• a , b : objects of type Point

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
initialization	x.init(a,b)	a and b are points					constant

Models

InHalfPlaneBy2x2DetComputer InHalfPlaneBySimpleMatrix InGeneralizedDiskOfGivenRadius

Template Parameters

T	the type that should be a model of COrientationFunctor2.

Definition at line 84 of file COrientationFunctor2.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::COrientationFunctor2< T >::BOOST_CONCEPT_USAGE ( COrientationFunctor2< T > )

inline

Definition at line 89 of file COrientationFunctor2.h.

    {
      myX.init( myA, myB );
    }

References DGtal::concepts::COrientationFunctor2< T >::myA, DGtal::concepts::COrientationFunctor2< T >::myB, and DGtal::concepts::COrientationFunctor2< T >::myX.

Field Documentation

myA

template<typename T >

T::Point DGtal::concepts::COrientationFunctor2< T >::myA

private

Definition at line 96 of file COrientationFunctor2.h.

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

myB

template<typename T >

T::Point DGtal::concepts::COrientationFunctor2< T >::myB

private

Definition at line 96 of file COrientationFunctor2.h.

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

myX

template<typename T >

T DGtal::concepts::COrientationFunctor2< T >::myX

private

Definition at line 95 of file COrientationFunctor2.h.

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

---

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

• COrientationFunctor2.h