Public Types | Private Member Functions | Private Attributes

DGtal::CDomainAdjacency< T > Struct Template Reference
[DGtal concepts]

Aim: Refines the concept CAdjacency by telling that the adjacency is specific to a given domain of the embedding digital space. More...

#include <CDomainAdjacency.h>

Inheritance diagram for DGtal::CDomainAdjacency< T >:
Inheritance graph
[legend]
Collaboration diagram for DGtal::CDomainAdjacency< T >:
Collaboration graph
[legend]

Public Types

typedef Adj::Domain Domain
typedef Adj::Predicate Predicate

Private Member Functions

 BOOST_CONCEPT_USAGE (CDomainAdjacency)

Private Attributes

myT
Domain myDomain
Predicate myPredicate

Detailed Description

template<typename T>
struct DGtal::CDomainAdjacency< T >

Aim: Refines the concept CAdjacency by telling that the adjacency is specific to a given domain of the embedding digital space.

Description of concept 'CDomainAdjacency'

This class is useful to define subspaces with restricted neighborhood relations. For instance, you can limit the adjacency to an object, then to its border, then to a subset of its border, etc.

Refinement of CAdjacency

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
embedding domain x.domain() const Domain & return a reference to the embedding domain. O(1)
"is in domain ?" predicate x.predicate() const Predicate & return a reference to the predicate object that is characteristic of the embedding domain. O(1)

Invariants

Models

Notes


Member Typedef Documentation

template<typename T >
typedef Adj::Domain DGtal::CDomainAdjacency< T >::Domain
template<typename T >
typedef Adj::Predicate DGtal::CDomainAdjacency< T >::Predicate

Member Function Documentation

template<typename T >
DGtal::CDomainAdjacency< T >::BOOST_CONCEPT_USAGE ( CDomainAdjacency< T >   )  [inline, private]

Field Documentation

template<typename T >
Domain DGtal::CDomainAdjacency< T >::myDomain [private]
template<typename T >
Predicate DGtal::CDomainAdjacency< T >::myPredicate [private]
template<typename T >
T DGtal::CDomainAdjacency< T >::myT [private]

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