Spatial C++ Library
Generic Multi-Dimensional Containers and Spatial Operations
spatial::neighbor_iterator_pair< const Ct, Metric > Struct Template Reference

This structure defines a pair of constant neighbor iterator. More...

#include <spatial_neighbor.hpp>

Inherits pair< neighbor_iterator< const Ct, Metric >, neighbor_iterator< const Ct, Metric > >.

Public Types

typedef std::pair< neighbor_iterator< const Ct, Metric >, neighbor_iterator< const Ct, Metric > > Base
 A pair of iterators that represents a range (that is: a range of elements to iterate, and not an orthogonal range). More...
 

Public Member Functions

 neighbor_iterator_pair ()
 Empty constructor. More...
 
 neighbor_iterator_pair (const neighbor_iterator< const Ct, Metric > &a, const neighbor_iterator< const Ct, Metric > &b)
 Regular constructor that builds a neighbor_iterator_pair out of 2 neighbor_iterators. More...
 
 neighbor_iterator_pair (const neighbor_iterator_pair< Ct, Metric > &p)
 Convert a mutable neighbor iterator pair into a const neighbor iterator pair. More...
 

Detailed Description

template<typename Ct, typename Metric>
struct spatial::neighbor_iterator_pair< const Ct, Metric >

This structure defines a pair of constant neighbor iterator.

Template Parameters
CtThe container to which these iterator relate to.
MetricThe metric used by the iterator.
See also
neighbor_iterator

Definition at line 598 of file spatial_neighbor.hpp.

Member Typedef Documentation

template<typename Ct , typename Metric >
typedef std::pair<neighbor_iterator<const Ct, Metric>, neighbor_iterator<const Ct, Metric> > spatial::neighbor_iterator_pair< const Ct, Metric >::Base

A pair of iterators that represents a range (that is: a range of elements to iterate, and not an orthogonal range).

Definition at line 607 of file spatial_neighbor.hpp.

Constructor & Destructor Documentation

template<typename Ct , typename Metric >
spatial::neighbor_iterator_pair< const Ct, Metric >::neighbor_iterator_pair ( )

Empty constructor.

Definition at line 610 of file spatial_neighbor.hpp.

template<typename Ct , typename Metric >
spatial::neighbor_iterator_pair< const Ct, Metric >::neighbor_iterator_pair ( const neighbor_iterator< const Ct, Metric > &  a,
const neighbor_iterator< const Ct, Metric > &  b 
)

Regular constructor that builds a neighbor_iterator_pair out of 2 neighbor_iterators.

Definition at line 614 of file spatial_neighbor.hpp.

template<typename Ct , typename Metric >
spatial::neighbor_iterator_pair< const Ct, Metric >::neighbor_iterator_pair ( const neighbor_iterator_pair< Ct, Metric > &  p)

Convert a mutable neighbor iterator pair into a const neighbor iterator pair.

Definition at line 621 of file spatial_neighbor.hpp.


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