Public Types | Public Member Functions | Private Attributes

DGtal::CAdjacency< Adj > Struct Template Reference
[DGtal concepts]

Aim: The concept CAdjacency defines an elementary adjacency relation between points of a digital space. More...

#include <CAdjacency.h>

Inheritance diagram for DGtal::CAdjacency< Adj >:
Inheritance graph
[legend]
Collaboration diagram for DGtal::CAdjacency< Adj >:
Collaboration graph
[legend]

Public Types

typedef Adj::Space Space
typedef Adj::Point Point
typedef Adj::Adjacency Adjacency

Public Member Functions

 BOOST_CONCEPT_USAGE (CAdjacency)

Private Attributes

Adj myAdj
Point myP1
Point myP2
bool myBool
std::back_insert_iterator
< std::vector< Point > > 
myInserter

Detailed Description

template<typename Adj>
struct DGtal::CAdjacency< Adj >

Aim: The concept CAdjacency defines an elementary adjacency relation between points of a digital space.

Description of concept 'CAdjacency'

It thus distinguishes which points are close and which points are further away in this space. Adjacency relations are used to define a digital topology, in the sense of Rosenfeld or in the sense of Herman. In other words, and adjacency relation define a neighborhood graph on the points of a digital domain.

Refinement of

Associated types (must be defined in the model):

Notations

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
adjacency test adj.isAdjacentTo( p1, p2 ) p1 and p2 of same type Point. bool Return 'true' when the two points are adjacent according to the adjacency relation adj

proper adjacency test adj.isProperlyAdjacentTo( p1, p2 ) p1 and p2 of same type Point. bool Return 'true' when the two points are adjacent according to the adjacency relation adj and if p1 different from p2

Invariants

Models

Notes


Member Typedef Documentation

template<typename Adj>
typedef Adj::Adjacency DGtal::CAdjacency< Adj >::Adjacency
template<typename Adj>
typedef Adj::Point DGtal::CAdjacency< Adj >::Point
template<typename Adj>
typedef Adj::Space DGtal::CAdjacency< Adj >::Space

Member Function Documentation

template<typename Adj>
DGtal::CAdjacency< Adj >::BOOST_CONCEPT_USAGE ( CAdjacency< Adj >   )  [inline]

Field Documentation

template<typename Adj>
Adj DGtal::CAdjacency< Adj >::myAdj [private]
template<typename Adj>
bool DGtal::CAdjacency< Adj >::myBool [private]
template<typename Adj>
std::back_insert_iterator< std::vector<Point> > DGtal::CAdjacency< Adj >::myInserter [private]
template<typename Adj>
Point DGtal::CAdjacency< Adj >::myP1 [private]
template<typename Adj>
Point DGtal::CAdjacency< Adj >::myP2 [private]

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