Iterate over a (dim-1)-dimensional slice. More...

#include <SliceIterator.hpp>

Public Member Functions
template<size_t Dim>
	SliceIterator (const Index< Dim > &extents, size_t fixed_dim, size_t fixed_index)

	operator bool () const
	Returns `true` if the iterator is valid.

SliceIterator &	operator++ ()
	Step to the next grid point.

size_t	volume_offset () const
	Offset into a Dim-dimensional DataVector at the current gridpoint. Note that the size of the DataVector is assumed to be the product of the extents used to construct this SliceIterator.

size_t	slice_offset () const
	Offset into a (Dim-1)-dimensional DataVector at the current gridpoint. Note that the size of the DataVector is assumed to be the product of the extents used to construct this SliceIterator divided by the extent in the fixed_dim used to construct this SliceIterator.

void	reset ()
	Reset the iterator.

Detailed Description

Iterate over a (dim-1)-dimensional slice.

Constructor & Destructor Documentation

template<size_t Dim>

SliceIterator::SliceIterator	(	const Index< Dim > &	extents,
		size_t	fixed_dim,
		size_t	fixed_index
	)

Parameters

extents	the number of grid points in each dimension
fixed_dim	the dimension to slice in
fixed_index	the index of the `fixed_dim` to slice at

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