til::Neighborhood_list Class Reference

Neighborhood as a list of vectors. More...

#include <til/Neighborhood.h>

Inheritance diagram for til::Neighborhood_list:

Collaboration diagram for til::Neighborhood_list:

Public Types
typedef Neighborhood_list	Self
typedef std::vector< numeric_array< int, 3 > >	NeighborList
typedef NeighborList::iterator	iterator
typedef NeighborList::const_iterator	const_iterator

Public Member Functions
	Neighborhood_list ()
	Default constructor, empty neighborhood. More...
template<class TNeighborhood >
	Neighborhood_list (const TNeighborhood &nh)
	Copy constructor from any type of neighborhood. More...
	Neighborhood_list (const bool array[3 *3 *3])
	From C array. More...
template<class TNeighborhood >
enable_if< is_Neighborhood< TNeighborhood > >::type	init (const TNeighborhood &nh)
void	init (const bool array[3 *3 *3])
	From C array. More...
template<typename TFunctor >
void	for_all_neighbors (const TFunctor &functor)
	A loop to execute something per neighbor. More...
Self::iterator	begin ()
Self::iterator	end ()
Self::const_iterator	begin () const
Self::const_iterator	end () const
void	set (const numeric_array< int, 3 > &v)
void	reset (const numeric_array< int, 3 > &v)
void	reset ()

Detailed Description

Neighborhood as a list of vectors.

Definition at line 80 of file Neighborhood.h.

Member Typedef Documentation

const_iterator

typedef NeighborList::const_iterator til::Neighborhood_list::const_iterator

Definition at line 87 of file Neighborhood.h.

iterator

typedef NeighborList::iterator til::Neighborhood_list::iterator

Definition at line 86 of file Neighborhood.h.

NeighborList

typedef std::vector<numeric_array<int,3> > til::Neighborhood_list::NeighborList

Definition at line 85 of file Neighborhood.h.

Self

typedef Neighborhood_list til::Neighborhood_list::Self

Definition at line 84 of file Neighborhood.h.

Constructor & Destructor Documentation

Neighborhood_list() [1/3]

til::Neighborhood_list::Neighborhood_list ( )

inline

Default constructor, empty neighborhood.

Definition at line 92 of file Neighborhood.h.

Neighborhood_list() [2/3]

template<class TNeighborhood >

til::Neighborhood_list::Neighborhood_list ( const TNeighborhood &  nh )

inline

Copy constructor from any type of neighborhood.

Definition at line 96 of file Neighborhood.h.

Neighborhood_list() [3/3]

til::Neighborhood_list::Neighborhood_list ( const bool  array[3 *3 *3] )

inline

From C array.

Definition at line 99 of file Neighborhood.h.

Member Function Documentation

begin() [1/2]

Self::iterator til::Neighborhood_list::begin ( )

inline

Definition at line 147 of file Neighborhood.h.

begin() [2/2]

Self::const_iterator til::Neighborhood_list::begin ( ) const

inline

Definition at line 149 of file Neighborhood.h.

end() [1/2]

Self::iterator til::Neighborhood_list::end ( )

inline

Definition at line 148 of file Neighborhood.h.

end() [2/2]

Self::const_iterator til::Neighborhood_list::end ( ) const

inline

Definition at line 150 of file Neighborhood.h.

for_all_neighbors()

template<typename TFunctor >

void til::Neighborhood_list::for_all_neighbors ( const TFunctor &  functor )

inline

A loop to execute something per neighbor.

Definition at line 134 of file Neighborhood.h.

References til::detail::numeric_array_impl< T, D >::begin().

init() [1/2]

template<class TNeighborhood >

enable_if<is_Neighborhood<TNeighborhood> >::type til::Neighborhood_list::init ( const TNeighborhood &  nh )

inline

Definition at line 105 of file Neighborhood.h.

init() [2/2]

void til::Neighborhood_list::init ( const bool  array[3 *3 *3] )

inline

From C array.

Definition at line 122 of file Neighborhood.h.

References COFFSET, and FOR_ALL_NEIGHBORS.

reset() [1/2]

void til::Neighborhood_list::reset ( const numeric_array< int, 3 > &  v )

inline

Definition at line 163 of file Neighborhood.h.

reset() [2/2]

void til::Neighborhood_list::reset ( )

inline

Definition at line 180 of file Neighborhood.h.

set()

void til::Neighborhood_list::set ( const numeric_array< int, 3 > &  v )

inline

Definition at line 154 of file Neighborhood.h.

---

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

• til/Neighborhood.h