nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator Class Reference

Iterator iterating the nodes in a Quadtree inside a Mask. More...

#include <ntree.h>

Collaboration diagram for nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator:

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = std::pair< Position< D >, T >
using	pointer = value_type *
using	reference = value_type &
using	difference_type = long int

Public Member Functions
	masked_iterator ()
	Initialize an invalid iterator.
	masked_iterator (Ntree &q, const Mask< D > &mask, const Position< D > &anchor)
	Initialize an iterator to point to the first leaf node inside the mask within the tree below this Ntree.
value_type &	operator* ()
value_type *	operator-> ()
masked_iterator &	operator++ ()
	Move the iterator to the next node inside the mask within the tree.
masked_iterator	operator++ (int)
	Postfix increment operator.
bool	operator== (const masked_iterator &other) const
	Iterators are equal if they point to the same node in the same ntree.
bool	operator!= (const masked_iterator &other) const

Protected Member Functions
void	init_ ()
	Initialize.
void	next_leaf_ ()
	Find the next leaf which is not outside the mask.
void	first_leaf_ ()
	Find the first leaf which is not outside the mask.
void	first_leaf_inside_ ()
	Set the allin_top_ to the current quadrant, and find the first leaf below the current quadrant.
void	next_anchor_ ()
	Go to the next anchor image.
bool	anchored_position_inside_mask (const Position< D > &position)

Protected Attributes
Ntree *	ntree_
Ntree *	top_
Ntree *	allin_top_
size_t	node_
const Mask< D > *	mask_
Position< D >	anchor_
Position< D >	anchored_position_
std::vector< Position< D > >	anchors_
size_t	current_anchor_

Detailed Description

template<int D, class T, int max_capacity = 100, int max_depth = 10>
class nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator

Iterator iterating the nodes in a Quadtree inside a Mask.

Member Typedef Documentation

difference_type

template<int D, class T , int max_capacity = 100, int max_depth = 10>

using nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::difference_type = long int

iterator_category

template<int D, class T , int max_capacity = 100, int max_depth = 10>

using nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::iterator_category = std::forward_iterator_tag

pointer

template<int D, class T , int max_capacity = 100, int max_depth = 10>

using nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::pointer = value_type*

reference

template<int D, class T , int max_capacity = 100, int max_depth = 10>

using nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::reference = value_type&

value_type

template<int D, class T , int max_capacity = 100, int max_depth = 10>

using nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::value_type = std::pair< Position< D >, T >

Constructor & Destructor Documentation

masked_iterator() [1/2]

template<int D, class T , int max_capacity = 100, int max_depth = 10>

nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator ( )

inline

Initialize an invalid iterator.

masked_iterator() [2/2]

template<int D, class T , int max_capacity, int max_depth>

nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator	(	Ntree &	q,
		const Mask< D > &	mask,
		const Position< D > &	anchor
	)

Initialize an iterator to point to the first leaf node inside the mask within the tree below this Ntree.

References nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchor_, nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchors_, nest::Ntree< D, T, max_capacity, max_depth >::extent_, nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::init_(), nest::Box< D >::lower_left, nest::Ntree< D, T, max_capacity, max_depth >::lower_left_, nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::mask_, nest::mod(), nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::ntree_, nest::Ntree< D, T, max_capacity, max_depth >::periodic_, and nest::Box< D >::upper_right.

Here is the call graph for this function:

Member Function Documentation

anchored_position_inside_mask()

template<int D, class T , int max_capacity = 100, int max_depth = 10>

bool nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchored_position_inside_mask ( const Position< D > &  position )

inlineprotected

References nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchor_, nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchored_position_, and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::mask_.

first_leaf_()

template<int D, class T , int max_capacity, int max_depth>

void nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::first_leaf_ ( )

protected

Find the first leaf which is not outside the mask.

If no leaf is found below the current quadrant, will continue to next_leaf_().

first_leaf_inside_()

template<int D, class T , int max_capacity, int max_depth>

void nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::first_leaf_inside_ ( )

protected

Set the allin_top_ to the current quadrant, and find the first leaf below the current quadrant.

init_()

template<int D, class T , int max_capacity, int max_depth>

void nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::init_ ( )

protected

Initialize.

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator().

Here is the caller graph for this function:

next_anchor_()

template<int D, class T , int max_capacity, int max_depth>

void nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::next_anchor_ ( )

protected

Go to the next anchor image.

next_leaf_()

template<int D, class T , int max_capacity, int max_depth>

void nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::next_leaf_ ( )

protected

Find the next leaf which is not outside the mask.

References nest::Ntree< D, T, max_capacity, max_depth >::N.

operator!=()

template<int D, class T , int max_capacity = 100, int max_depth = 10>

bool nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator!= ( const masked_iterator &  other ) const

inline

References nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::node_, and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::ntree_.

operator*()

template<int D, class T , int max_capacity = 100, int max_depth = 10>

value_type & nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator* ( )

inline

References nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::node_, nest::Ntree< D, T, max_capacity, max_depth >::nodes_, and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::ntree_.

operator++() [1/2]

template<int D, class T , int max_capacity, int max_depth>

Ntree< D, T, max_capacity, max_depth >::masked_iterator & nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator++

(

)

Move the iterator to the next node inside the mask within the tree.

May cause the iterator to become invalid if there are no more nodes.

References nest::Ntree< D, T, max_capacity, max_depth >::nodes_.

operator++() [2/2]

template<int D, class T , int max_capacity = 100, int max_depth = 10>

masked_iterator nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator++ ( int  )

inline

Postfix increment operator.

operator->()

template<int D, class T , int max_capacity = 100, int max_depth = 10>

value_type * nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator-> ( )

inline

References nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::node_, nest::Ntree< D, T, max_capacity, max_depth >::nodes_, and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::ntree_.

operator==()

template<int D, class T , int max_capacity = 100, int max_depth = 10>

bool nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator== ( const masked_iterator &  other ) const

inline

Iterators are equal if they point to the same node in the same ntree.

References nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::node_, and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::ntree_.

Member Data Documentation

allin_top_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

Ntree* nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::allin_top_

protected

anchor_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

Position< D > nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchor_

protected

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchored_position_inside_mask(), and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator().

anchored_position_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

Position< D > nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchored_position_

protected

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchored_position_inside_mask().

anchors_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

std::vector< Position< D > > nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchors_

protected

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator().

current_anchor_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

size_t nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::current_anchor_

protected

mask_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

const Mask< D >* nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::mask_

protected

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::anchored_position_inside_mask(), and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator().

node_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

size_t nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::node_

protected

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator!=(), nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator*(), nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator->(), and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator==().

ntree_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

Ntree* nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::ntree_

protected

Referenced by nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::masked_iterator(), nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator!=(), nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator*(), nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator->(), and nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::operator==().

top_

template<int D, class T , int max_capacity = 100, int max_depth = 10>

Ntree* nest::Ntree< D, T, max_capacity, max_depth >::masked_iterator::top_

protected

---

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

• ntree.h
• ntree_impl.h