DGtal  0.9.4beta
Public Types | Public Member Functions | Data Fields
DGtal::KhalimskyPreCell< dim, TInteger > Struct Template Reference

#include <DGtal/topology/KhalimskyPreSpaceND.h>

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

Public Types

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

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CInteger< TInteger >))
 
PreCell const & preCell () const
 
 KhalimskyPreCell (Integer dummy=0)
 
 KhalimskyPreCell (Point const &aPoint)
 
 KhalimskyPreCell (KhalimskyPreCell const &aCell)=default
 
KhalimskyPreCelloperator= (KhalimskyPreCell const &aCell)=default
 
 KhalimskyPreCell (KhalimskyPreCell &&aCell)=default
 
KhalimskyPreCelloperator= (KhalimskyPreCell &&aCell)=default
 
bool operator== (const KhalimskyPreCell &other) const
 
bool operator!= (const KhalimskyPreCell &other) const
 
bool operator< (const KhalimskyPreCell &other) const
 
std::string className () const
 

Data Fields

Point coordinates
 

Detailed Description

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

Represents an unsigned cell in an unbounded 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 72 of file KhalimskyPreSpaceND.h.

Member Typedef Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::KhalimskyPreCell< dim, TInteger >::CellularGridSpace = PreCellularGridSpace

Definition at line 86 of file KhalimskyPreSpaceND.h.

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

Definition at line 80 of file KhalimskyPreSpaceND.h.

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

Definition at line 82 of file KhalimskyPreSpaceND.h.

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

Definition at line 84 of file KhalimskyPreSpaceND.h.

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

Definition at line 85 of file KhalimskyPreSpaceND.h.

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

Definition at line 83 of file KhalimskyPreSpaceND.h.

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

Definition at line 81 of file KhalimskyPreSpaceND.h.

Constructor & Destructor Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyPreCell< dim, TInteger >::KhalimskyPreCell ( Integer  dummy = 0)
explicit

Default constructor.

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

Implicit constructor from its Khalimsky coordinates.

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

Copy constructor.

Parameters
aCellany other pre-cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyPreCell< dim, TInteger >::KhalimskyPreCell ( KhalimskyPreCell< dim, TInteger > &&  aCell)
default

Move constructor.

Parameters
aCellany other pre-cell.

Member Function Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::KhalimskyPreCell< dim, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CInteger< TInteger >)  )
template<Dimension dim, typename TInteger = DGtal::int32_t>
std::string DGtal::KhalimskyPreCell< dim, TInteger >::className ( ) const
Returns
the style name used for drawing this object.
template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::KhalimskyPreCell< dim, TInteger >::operator!= ( const KhalimskyPreCell< dim, TInteger > &  other) const

Difference operator.

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

Inferior operator. (lexicographic order).

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

Copy operator

Parameters
aCellany other pre-cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
KhalimskyPreCell& DGtal::KhalimskyPreCell< dim, TInteger >::operator= ( KhalimskyPreCell< dim, TInteger > &&  aCell)
default

Move operator

Parameters
aCellany other pre-cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::KhalimskyPreCell< dim, TInteger >::operator== ( const KhalimskyPreCell< dim, TInteger > &  other) const

Equality operator.

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

Returns the underlying constant pre-cell, itself in fact.

Field Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
Point DGtal::KhalimskyPreCell< dim, TInteger >::coordinates

Khalimsky coordinates of the cell. Public to allow easy coordinate manipulations.

Definition at line 90 of file KhalimskyPreSpaceND.h.


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