madness::BoxSurfaceDisplacementRange< NDIM >::Iterator Class Reference

Iterator class for lazy generation of surface points. More...

Collaboration diagram for madness::BoxSurfaceDisplacementRange< NDIM >::Iterator:

Public Types
using	difference_type = std::ptrdiff_t
using	iterator_category = std::input_iterator_tag
using	pointer = const Point *
using	reference = const Point &
enum	Type { Begin , End }
using	value_type = Point

Public Member Functions
	Iterator (const BoxSurfaceDisplacementRange *p, Type type)
	Constructs an iterator.
reference	operator* () const
	Dereferences the iterator.
Iterator &	operator++ ()
	Pre-increment operator.
Iterator	operator++ (int)
	Post-increment operator.
pointer	operator-> () const
	Arrow operator for member access.

Private Member Functions
void	advance ()
	Advances the iterator to the next surface point.
void	advance_till_valid ()
const std::optional< Displacement > &	displacement () const
bool	next_surface_layer ()
void	reset_along_dim (size_t dim)

Private Attributes
Box	box
	updated box bounds in each dimension, used to avoid duplicate displacements by excluding the surface displacements for each processed fixed dim
std::optional< Displacement >	disp
	Memoized displacement from parent->center_ to point, computed by displacement(), reset by advance()
bool	done
	Flag indicating iteration completion.
size_t	fixed_dim
	Current fixed dimension (i.e. faces perpendicular to this axis are being iterated over)
const BoxSurfaceDisplacementRange *	parent
	Pointer to parent box.
Point	point
	Current point.

Friends
bool	operator!= (const Iterator &a, const Iterator &b)
	Inequality comparison operator.
bool	operator== (const Iterator &a, const Iterator &b)
	Equality comparison operator.

Detailed Description

template<std::size_t NDIM>
class madness::BoxSurfaceDisplacementRange< NDIM >::Iterator

Iterator class for lazy generation of surface points.

This iterator generates surface points on-demand by tracking the current fixed dimension and positions in each dimension. It implements the InputIterator concept.

Member Typedef Documentation

difference_type

template<std::size_t NDIM>

using madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::difference_type = std::ptrdiff_t

iterator_category

template<std::size_t NDIM>

using madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::iterator_category = std::input_iterator_tag

pointer

template<std::size_t NDIM>

using madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::pointer = const Point*

reference

template<std::size_t NDIM>

using madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reference = const Point&

value_type

template<std::size_t NDIM>

using madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::value_type = Point

Member Enumeration Documentation

Type

template<std::size_t NDIM>

enum madness::BoxSurfaceDisplacementRange::Iterator::Type

Enumerator
Begin
End

Constructor & Destructor Documentation

Iterator()

template<std::size_t NDIM>

madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::Iterator ( const BoxSurfaceDisplacementRange *  p, Type  type  )

inline

Constructs an iterator.

Parameters

p	Pointer to the parent BoxSurfaceDisplacementRange
type	the type of iterator (Begin or End)

References madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::box, madness::BoxSurfaceDisplacementRange< NDIM >::box_, madness::BoxSurfaceDisplacementRange< NDIM >::box_radius_, d, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::End, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::fixed_dim, NDIM, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim(), madness::BoxSurfaceDisplacementRange< NDIM >::surface_thickness_, and madness::type().

Member Function Documentation

advance()

template<std::size_t NDIM>

void madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance ( )

inlineprivate

Advances the iterator to the next surface point.

This function implements the logic for traversing the box surface by:

1. Incrementing displacement in non-fixed dimensions
2. Switching sides in the fixed dimension when needed
3. Moving to the next fixed dimension when current one is exhausted

References madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::box, madness::BoxSurfaceDisplacementRange< NDIM >::box_, madness::BoxSurfaceDisplacementRange< NDIM >::box_radius_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::disp, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::done, madness::BoxSurfaceDisplacementRange< NDIM >::filter_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::fixed_dim, madness::BoxSurfaceDisplacementRange< NDIM >::hollowness_, MADNESS_ASSERT, NDIM, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::next_surface_layer(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::point, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim(), and madness::BoxSurfaceDisplacementRange< NDIM >::surface_thickness_.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid().

advance_till_valid()

template<std::size_t NDIM>

void madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid ( )

inlineprivate

References madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::disp, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::displacement(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::done, madness::BoxSurfaceDisplacementRange< NDIM >::filter_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent, and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::point.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::Iterator(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::operator++().

displacement()

template<std::size_t NDIM>

const std::optional< Displacement > & madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::displacement ( ) const

inlineprivate

Returns

displacement from the center to the current point

References madness::BoxSurfaceDisplacementRange< NDIM >::center_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::disp, madness::displacement(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent, and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::point.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::operator*().

next_surface_layer()

template<std::size_t NDIM>

bool madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::next_surface_layer ( )

inlineprivate

References madness::BoxSurfaceDisplacementRange< NDIM >::box_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::fixed_dim, madness::BoxSurfaceDisplacementRange< NDIM >::hollowness_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::point, and madness::BoxSurfaceDisplacementRange< NDIM >::surface_thickness_.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim().

operator*()

template<std::size_t NDIM>

reference madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::operator* ( ) const

inline

Dereferences the iterator.

Returns

A const reference to the current displacement

References madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::displacement().

operator++() [1/2]

template<std::size_t NDIM>

Iterator & madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::operator++ ( )

inline

Pre-increment operator.

Returns

Reference to this iterator after advancement

References madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid().

operator++() [2/2]

template<std::size_t NDIM>

Iterator madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::operator++ ( int  )

inline

Post-increment operator.

Returns

Copy of the iterator before advancement

operator->()

template<std::size_t NDIM>

pointer madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::operator-> ( ) const

inline

Arrow operator for member access.

Returns

A const pointer to the current displacement

reset_along_dim()

template<std::size_t NDIM>

void madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim ( size_t  dim )

inlineprivate

References madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::box, madness::BoxSurfaceDisplacementRange< NDIM >::box_, madness::BoxSurfaceDisplacementRange< NDIM >::center_, madness::BoxSurfaceDisplacementRange< NDIM >::filter_, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::fixed_dim, madness::BoxSurfaceDisplacementRange< NDIM >::hollowness_, madness::BoxSurfaceDisplacementRange< NDIM >::is_periodic_, MADNESS_ASSERT, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::next_surface_layer(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent, madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::point, and madness::BoxSurfaceDisplacementRange< NDIM >::surface_thickness_.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::Iterator(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance().

Friends And Related Symbol Documentation

operator!=

template<std::size_t NDIM>

bool operator!= ( const Iterator &  a, const Iterator &  b  )

friend

Inequality comparison operator.

Parameters

a	First iterator
b	Second iterator

Returns

true if iterators are not equivalent

operator==

template<std::size_t NDIM>

bool operator== ( const Iterator &  a, const Iterator &  b  )

friend

Equality comparison operator.

Parameters

a	First iterator
b	Second iterator

Returns

true if iterators are equivalent

Member Data Documentation

box

template<std::size_t NDIM>

Box madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::box

private

updated box bounds in each dimension, used to avoid duplicate displacements by excluding the surface displacements for each processed fixed dim

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::Iterator(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim().

disp

template<std::size_t NDIM>

std::optional<Displacement> madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::disp

mutableprivate

Memoized displacement from parent->center_ to point, computed by displacement(), reset by advance()

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::displacement().

done

template<std::size_t NDIM>

bool madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::done

private

Flag indicating iteration completion.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid().

fixed_dim

template<std::size_t NDIM>

size_t madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::fixed_dim

private

Current fixed dimension (i.e. faces perpendicular to this axis are being iterated over)

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::Iterator(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::next_surface_layer(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim().

parent

template<std::size_t NDIM>

const BoxSurfaceDisplacementRange* madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::parent

private

Pointer to parent box.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::Iterator(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::displacement(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::next_surface_layer(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim().

point

template<std::size_t NDIM>

Point madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::point

private

Current point.

Referenced by madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::advance_till_valid(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::displacement(), madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::next_surface_layer(), and madness::BoxSurfaceDisplacementRange< NDIM >::Iterator::reset_along_dim().

---

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

• displacements.h