MultiIndex.hpp File Reference

The multiindex classes for managing grid points for grids of the arbitrary dimensionality. More...

#include <iostream>
#include "Array.hpp"

Include dependency graph for MultiIndex.hpp:

This graph shows which files directly or indirectly include this file:

Classes
class	SelectedDim
	Provides a tool for selecting subgrids correspoding to given dimensions. More...
class	MultiIndex
	Provides functions for shifting to the 'next' position under the lexicographical and some other oderings and elementar multiindex operations (the abs. value and the factorial). More...
Functions
std::ostream &	PrintSize (const Array< int > &sizes, std::ostream &s=std::cout)
	Output for size arrays.
std::ostream &	operator<< (std::ostream &s, const MultiIndex &I)
	Output of MultiIndex objects.

---

Detailed Description

The multiindex classes for managing grid points for grids of the arbitrary dimensionality.

Class SelectedDim is derived from Array<bool> and provides a tool for selecting subgrids correspoding to given dimensions.

Class MultiIndex is derived from Array<int> by providing

• functions for shifting to the 'next' position under the
  lexicographical and some other oderings;
• the elementar multiindex operations (the abs. value and the factorial).

REMARK:

1. The 'next position' operators get the sizes of the array as an
   argument. Note that the array may have more dimensions than the
   multiindex. Then we consider that the multiindex references subarrays.
   Analogously, if a subgrid is selected (by dimensions) than its
   dimensionality can be even less than that of the multiindex.
2. If CHECK_ARRAY_RANGE is defined (cf. Array.hpp) then the consistency
   of the multiindices and the other involved arrays is checked.

---

Function Documentation

std::ostream& operator<<	(	std::ostream &	s,
		const MultiIndex &	I
	)			[inline]

Output of MultiIndex objects.

std::ostream& PrintSize	(	const Array< int > &	sizes,
		std::ostream &	s = std::cout
	)			[inline]

Output for size arrays.

Parameters:

[in]	sizes	The array to print.
[in]	s	The stream (optional).

Returns:

Reference to the stream.

---