Spatial C++ Library
Generic Multi-Dimensional Containers and Spatial Operations
spatial::quadrance_neighbor_iterator_pair< Ct, DistanceType, Diff > Class Template Reference

Facilitate the creation of an iterator range representing a sequence from closest to furthest from the target key position, in quadrance space. More...

#include <spatial_quadrance_neighbor.hpp>

Inherits spatial::neighbor_iterator_pair< Ct, quadrance< Ct, DistanceType, Diff > >.

Public Member Functions

 quadrance_neighbor_iterator_pair ()
 
 quadrance_neighbor_iterator_pair (const quadrance_neighbor_iterator< Ct, DistanceType, Diff > &a, const quadrance_neighbor_iterator< Ct, DistanceType, Diff > &b)
 
template<typename AnyDistanceType >
 quadrance_neighbor_iterator_pair (const neighbor_iterator_pair< Ct, quadrance< Ct, AnyDistanceType, Diff > > &other)
 
- Public Member Functions inherited from spatial::neighbor_iterator_pair< Ct, quadrance< Ct, DistanceType, Diff > >
 neighbor_iterator_pair ()
 Empty constructor. More...
 
 neighbor_iterator_pair (const neighbor_iterator< Ct, quadrance< Ct, DistanceType, Diff > > &a, const neighbor_iterator< Ct, quadrance< Ct, DistanceType, Diff > > &b)
 Regular constructor that builds a neighbor_iterator_pair out of 2 neighbor_iterators. More...
 

Private Types

typedef enable_if< import::is_arithmetic< DistanceType > > check_concept_distance_type_is_arithmetic
 

Additional Inherited Members

- Public Types inherited from spatial::neighbor_iterator_pair< Ct, quadrance< Ct, DistanceType, Diff > >
typedef std::pair< neighbor_iterator< Ct, quadrance< Ct, DistanceType, Diff > >, neighbor_iterator< Ct, quadrance< Ct, DistanceType, Diff > > > Base
 A pair of iterators that represents a range (that is: a range of elements to iterate, and not an orthogonal range). More...
 

Detailed Description

template<typename Ct, typename DistanceType, typename Diff = typename details::with_builtin_difference<Ct>::type>
class spatial::quadrance_neighbor_iterator_pair< Ct, DistanceType, Diff >

Facilitate the creation of an iterator range representing a sequence from closest to furthest from the target key position, in quadrance space.

Template Parameters
CtThe container to iterator.
DistanceTypeThe type used to represent the distance, it must be a primitive arithmetic type.
DiffThe difference functor that will compute the difference between 2 key element in the container, along a specific dimension. See Difference for further explanation.

This class has an associated group of functions designed to initialize the iterator position at the beginning, end, lower bound or upper bound of the container to iterate.

Definition at line 111 of file spatial_quadrance_neighbor.hpp.

Member Typedef Documentation

template<typename Ct , typename DistanceType , typename Diff = typename details::with_builtin_difference<Ct>::type>
typedef enable_if<import::is_arithmetic<DistanceType> > spatial::quadrance_neighbor_iterator_pair< Ct, DistanceType, Diff >::check_concept_distance_type_is_arithmetic
private

Definition at line 116 of file spatial_quadrance_neighbor.hpp.

Constructor & Destructor Documentation

template<typename Ct , typename DistanceType , typename Diff = typename details::with_builtin_difference<Ct>::type>
spatial::quadrance_neighbor_iterator_pair< Ct, DistanceType, Diff >::quadrance_neighbor_iterator_pair ( )

Definition at line 119 of file spatial_quadrance_neighbor.hpp.

template<typename Ct , typename DistanceType , typename Diff = typename details::with_builtin_difference<Ct>::type>
spatial::quadrance_neighbor_iterator_pair< Ct, DistanceType, Diff >::quadrance_neighbor_iterator_pair ( const quadrance_neighbor_iterator< Ct, DistanceType, Diff > &  a,
const quadrance_neighbor_iterator< Ct, DistanceType, Diff > &  b 
)

Definition at line 122 of file spatial_quadrance_neighbor.hpp.

template<typename Ct , typename DistanceType , typename Diff = typename details::with_builtin_difference<Ct>::type>
template<typename AnyDistanceType >
spatial::quadrance_neighbor_iterator_pair< Ct, DistanceType, Diff >::quadrance_neighbor_iterator_pair ( const neighbor_iterator_pair< Ct, quadrance< Ct, AnyDistanceType, Diff > > &  other)

Definition at line 129 of file spatial_quadrance_neighbor.hpp.


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