DGtal  1.3.beta
Public Member Functions | Data Fields
DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State Struct Reference

#include <DGtal/topology/UmbrellaComputer.h>

Public Member Functions

 State ()
 
 State (const Surfel &_surfel, Dimension _k, bool _epsilon, Dimension _j)
 
bool operator== (const State &other) const
 
bool operator< (const State &other) const
 

Data Fields

Surfel surfel
 Current surfel. More...
 
Dimension k
 Direction to find separator, k in sDirs(surfel). More...
 
bool epsilon
 Orientation to find separator (true = positively along k-axis) More...
 
Dimension j
 Track direction (j != k), j in sDirs(surfel). More...
 

Detailed Description

template<typename TDigitalSurfaceTracker>
struct DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State

Stores (the main part of) the state when visiting an umbrella.

See also
UmbrellaComputer

Definition at line 104 of file UmbrellaComputer.h.

Constructor & Destructor Documentation

◆ State() [1/2]

template<typename TDigitalSurfaceTracker >
DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::State ( )
inline

Definition at line 114 of file UmbrellaComputer.h.

114 {}

◆ State() [2/2]

template<typename TDigitalSurfaceTracker >
DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::State ( const Surfel _surfel,
Dimension  _k,
bool  _epsilon,
Dimension  _j 
)
inline

Definition at line 115 of file UmbrellaComputer.h.

117  : surfel( _surfel ), k( _k ), epsilon( _epsilon ), j( _j )
118  {}

Member Function Documentation

◆ operator<()

template<typename TDigitalSurfaceTracker >
bool DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::operator< ( const State other) const
inline

Definition at line 126 of file UmbrellaComputer.h.

127  {
128  return ( surfel < other.surfel )
129  || ( ( surfel == other.surfel )
130  && ( ( k < other.k )
131  || ( ( k == other.k )
132  && ( ( epsilon < other.epsilon )
133  || ( ( epsilon == other.epsilon)
134  && ( j < other.j ) ) ) ) ) );
135  }

References DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::epsilon, DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::j, DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::k, and DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::surfel.

◆ operator==()

template<typename TDigitalSurfaceTracker >
bool DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::operator== ( const State other) const
inline

Field Documentation

◆ epsilon

template<typename TDigitalSurfaceTracker >
bool DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::epsilon

Orientation to find separator (true = positively along k-axis)

Definition at line 111 of file UmbrellaComputer.h.

Referenced by DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::operator<(), and DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::operator==().

◆ j

template<typename TDigitalSurfaceTracker >
Dimension DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::j

◆ k

template<typename TDigitalSurfaceTracker >
Dimension DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::k

◆ surfel

template<typename TDigitalSurfaceTracker >
Surfel DGtal::UmbrellaComputer< TDigitalSurfaceTracker >::State::surfel

The documentation for this struct was generated from the following file:
DGtal::UmbrellaComputer::State::epsilon
bool epsilon
Orientation to find separator (true = positively along k-axis)
Definition: UmbrellaComputer.h:111
DGtal::UmbrellaComputer::State::k
Dimension k
Direction to find separator, k in sDirs(surfel).
Definition: UmbrellaComputer.h:109
DGtal::UmbrellaComputer::State::j
Dimension j
Track direction (j != k), j in sDirs(surfel).
Definition: UmbrellaComputer.h:113
DGtal::UmbrellaComputer::State::surfel
Surfel surfel
Current surfel.
Definition: UmbrellaComputer.h:107