DGtal  1.5.beta
DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue > Struct Template Reference

Create a point functor from a point predicate and a domain. More...

#include <DGtal/kernel/BasicPointFunctors.h>

Public Types

typedef TPointPredicate PointPredicate
 
typedef TDomain Domain
 
typedef TValue Value
 
typedef Domain::Point Point
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CPointPredicate< PointPredicate >))
 
 BOOST_CONCEPT_ASSERT ((concepts::CDomain< Domain >))
 
 BOOST_CONCEPT_ASSERT ((concepts::CQuantity< Value >))
 
 PointFunctorFromPointPredicateAndDomain (ConstAlias< PointPredicate > aPtrPredicate, ConstAlias< Domain > aDomain, const Value aTrueValue, const Value aFalseValue)
 Constructor. More...
 
 PointFunctorFromPointPredicateAndDomain (const PointFunctorFromPointPredicateAndDomain &other)
 
Value operator() (const Point &aPoint) const
 operator () More...
 
PointFunctorFromPointPredicateAndDomainoperator= (const PointFunctorFromPointPredicateAndDomain &other)
 

Private Attributes

const PointPredicatemyPtrPredicate
 
const DomainmyDomain
 
Value myTrueValue
 
Value myFalseValue
 

Detailed Description

template<typename TPointPredicate, typename TDomain, typename TValue = typename TDomain::Integer>
struct DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >

Create a point functor from a point predicate and a domain.

Definition at line 570 of file BasicPointFunctors.h.

Member Typedef Documentation

◆ Domain

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
typedef TDomain DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::Domain

Definition at line 573 of file BasicPointFunctors.h.

◆ Point

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
typedef Domain::Point DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::Point

Definition at line 575 of file BasicPointFunctors.h.

◆ PointPredicate

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
typedef TPointPredicate DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::PointPredicate

Definition at line 572 of file BasicPointFunctors.h.

◆ Value

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
typedef TValue DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::Value

Definition at line 574 of file BasicPointFunctors.h.

Constructor & Destructor Documentation

◆ PointFunctorFromPointPredicateAndDomain() [1/2]

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::PointFunctorFromPointPredicateAndDomain ( ConstAlias< PointPredicate aPtrPredicate,
ConstAlias< Domain aDomain,
const Value  aTrueValue,
const Value  aFalseValue 
)

Constructor.

Parameters
[in]aPtrPredicatea predicate on digital point
[in]aDomaina domain on digital point
[in]aTrueValuethe returned value when a given point is inside the domain and when the predicate return true
[in]aFalseValuethe returned value when a given point is outside the domain or when the predicate return false

◆ PointFunctorFromPointPredicateAndDomain() [2/2]

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::PointFunctorFromPointPredicateAndDomain ( const PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue > &  other)

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/3]

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::BOOST_CONCEPT_ASSERT ( (concepts::CDomain< Domain >)  )

◆ BOOST_CONCEPT_ASSERT() [2/3]

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::BOOST_CONCEPT_ASSERT ( (concepts::CPointPredicate< PointPredicate >)  )

◆ BOOST_CONCEPT_ASSERT() [3/3]

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::BOOST_CONCEPT_ASSERT ( (concepts::CQuantity< Value >)  )

◆ operator()()

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
Value DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::operator() ( const Point aPoint) const

operator ()

Parameters
[in]aPointevaluated digital point.
Returns
aTrueValue when aPoint is inside the domain and when the predicate return true, aFalseValue else.

◆ operator=()

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
PointFunctorFromPointPredicateAndDomain& DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::operator= ( const PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue > &  other)

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.

Field Documentation

◆ myDomain

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
const Domain* DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::myDomain
private

Definition at line 610 of file BasicPointFunctors.h.

◆ myFalseValue

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
Value DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::myFalseValue
private

Definition at line 612 of file BasicPointFunctors.h.

◆ myPtrPredicate

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
const PointPredicate* DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::myPtrPredicate
private

Definition at line 609 of file BasicPointFunctors.h.

◆ myTrueValue

template<typename TPointPredicate , typename TDomain , typename TValue = typename TDomain::Integer>
Value DGtal::functors::PointFunctorFromPointPredicateAndDomain< TPointPredicate, TDomain, TValue >::myTrueValue
private

Definition at line 611 of file BasicPointFunctors.h.


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