DGtal  0.9.3beta
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends
DGtal::KhalimskyCell< dim, TInteger > Struct Template Reference

#include <DGtal/topology/KhalimskySpaceND.h>

Inheritance diagram for DGtal::KhalimskyCell< dim, TInteger >:
[legend]
Collaboration diagram for DGtal::KhalimskyCell< dim, TInteger >:
[legend]

Public Types

using Integer = TInteger
 
using UnsignedInteger = typename NumberTraits< Integer >::UnsignedVersion
 
using Point = PointVector< dim, Integer >
 
using PreCell = KhalimskyPreCell< dim, Integer >
 
using CellularGridSpace = KhalimskySpaceND< dim, TInteger >
 
using PreCellularGridSpace = KhalimskyPreSpaceND< dim, TInteger >
 
using Self = KhalimskyCell< dim, Integer >
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CInteger< TInteger >))
 
 operator PreCell const & () const
 
PreCell const & preCell () const
 
 KhalimskyCell (Integer dummy=0)
 
 KhalimskyCell (const KhalimskyCell &other)=default
 
KhalimskyCelloperator= (const KhalimskyCell &other)=default
 
 KhalimskyCell (KhalimskyCell &&other)=default
 
KhalimskyCelloperator= (KhalimskyCell &&other)=default
 
bool operator== (const KhalimskyCell &other) const
 
bool operator!= (const KhalimskyCell &other) const
 
bool operator< (const KhalimskyCell &other) const
 
std::string className () const
 

Private Member Functions

 KhalimskyCell (const Point &aPoint)
 
 KhalimskyCell (const PreCell &aCell)
 
 operator PreCell & ()
 

Private Attributes

PreCell myPreCell
 

Friends

class KhalimskySpaceND< dim, TInteger >
 
class KhalimskySpaceNDHelper< CellularGridSpace >
 

Detailed Description

template<Dimension dim, typename TInteger = DGtal::int32_t>
struct DGtal::KhalimskyCell< dim, TInteger >

Represents an (unsigned) cell in a cellular grid space by its Khalimsky coordinates.

Template Parameters
dimthe dimension of the digital space.
TIntegerthe Integer class used to specify the arithmetic computations (default type = int32).

Definition at line 82 of file KhalimskySpaceND.h.

Member Typedef Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::CellularGridSpace = KhalimskySpaceND< dim, TInteger >

Definition at line 95 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::Integer = TInteger

Definition at line 91 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::Point = PointVector< dim, Integer >

Definition at line 93 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::PreCell = KhalimskyPreCell< dim, Integer >

Definition at line 94 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::PreCellularGridSpace = KhalimskyPreSpaceND< dim, TInteger >

Definition at line 96 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::Self = KhalimskyCell< dim, Integer >

Definition at line 97 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyCell< dim, TInteger >::UnsignedInteger = typename NumberTraits<Integer>::UnsignedVersion

Definition at line 92 of file KhalimskySpaceND.h.

Constructor & Destructor Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( const Point aPoint)
explicitprivate

Explicit constructor from its Khalimsky coordinates.

Parameters
aPointIts Khalimsky coordinates as a point.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( const PreCell aCell)
explicitprivate

Explicit constructor from a KhalimskyPreCell.

Parameters
aCella pre-cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( Integer  dummy = 0)
explicit

Default constructor.

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( const KhalimskyCell< dim, TInteger > &  other)
default

Copy constructor.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::KhalimskyCell ( KhalimskyCell< dim, TInteger > &&  other)
default

Move constructor.

Parameters
otherany other cell.

Member Function Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CInteger< TInteger >)  )
template<Dimension dim, typename TInteger = DGtal::int32_t>
std::string DGtal::KhalimskyCell< dim, TInteger >::className ( ) const

Default drawing style object.

Returns
the dyn. alloc. default style for this object.
the style name used for drawing this object.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::operator PreCell & ( )
explicitprivate

Mutable conversion to KhalimskyPreCell.

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyCell< dim, TInteger >::operator PreCell const & ( ) const

Constant conversion to KhalimskyPreCell.

template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::KhalimskyCell< dim, TInteger >::operator!= ( const KhalimskyCell< dim, TInteger > &  other) const

Difference operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::KhalimskyCell< dim, TInteger >::operator< ( const KhalimskyCell< dim, TInteger > &  other) const

Inferior operator. (lexicographic order).

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
KhalimskyCell& DGtal::KhalimskyCell< dim, TInteger >::operator= ( const KhalimskyCell< dim, TInteger > &  other)
default

Copy operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
KhalimskyCell& DGtal::KhalimskyCell< dim, TInteger >::operator= ( KhalimskyCell< dim, TInteger > &&  other)
default

Move operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::KhalimskyCell< dim, TInteger >::operator== ( const KhalimskyCell< dim, TInteger > &  other) const

Equality operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
PreCell const& DGtal::KhalimskyCell< dim, TInteger >::preCell ( ) const

Friends And Related Function Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
friend class KhalimskySpaceND< dim, TInteger >
friend

Definition at line 100 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
friend class KhalimskySpaceNDHelper< CellularGridSpace >
friend

Definition at line 101 of file KhalimskySpaceND.h.

Field Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
PreCell DGtal::KhalimskyCell< dim, TInteger >::myPreCell
private

Definition at line 105 of file KhalimskySpaceND.h.


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