vtkArraySort Class Reference

#include <vtkArraySort.h>

Detailed Description

Controls sorting of sparse array coordinsates.

vtkArraySort stores an ordered set of dimensions along which the values stored in a sparse array should be sorted.

Convenience constructors are provided for specifying one, two, and three dimensions. To sort along more than three dimensions, use the default constructor, SetDimensions(), and operator[] to assign each dimension to be sorted.

See also:: vtkSparseArray

Thanks:: Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.

Definition at line 47 of file vtkArraySort.h.


bool	operator!= (const vtkArraySort &rhs) const
ostream &	operator<< (ostream &stream, const vtkArraySort &rhs)
Public Member Functions
	vtkArraySort ()
	vtkArraySort (vtkIdType i)
	vtkArraySort (vtkIdType i, vtkIdType j)
	vtkArraySort (vtkIdType i, vtkIdType j, vtkIdType k)
vtkIdType	GetDimensions () const
void	SetDimensions (vtkIdType dimensions)
vtkIdType &	operator[] (vtkIdType i)
const vtkIdType &	operator[] (vtkIdType i) const
bool	operator== (const vtkArraySort &rhs) const

Constructor & Destructor Documentation

vtkArraySort::vtkArraySort ( )

Create an empty set of dimensions. Use SetDimensions() and operator[] to populate them.

vtkArraySort::vtkArraySort ( vtkIdType i ) [explicit]

Sorts an array along one dimension.

vtkArraySort::vtkArraySort	(	vtkIdType	i,
		vtkIdType	j
	)

Sorts an array along two dimensions.

vtkArraySort::vtkArraySort	(	vtkIdType	i,
		vtkIdType	j,
		vtkIdType	k
	)

Sorts an array along three dimensions.

Member Function Documentation

vtkIdType vtkArraySort::GetDimensions ( ) const

Return the number of dimensions for sorting.

void vtkArraySort::SetDimensions ( vtkIdType dimensions )

Set the number of dimensions to be sorted. Note that this method resets every to zero, so you must set every dimension explicitly using operator[] after calling SetDimensions().

vtkIdType& vtkArraySort::operator[] ( vtkIdType i )

Returns the i-th dimension to be sorted.

const vtkIdType& vtkArraySort::operator[] ( vtkIdType i ) const

Returns the i-th dimension to be sorted.

bool vtkArraySort::operator== ( const vtkArraySort & rhs ) const

Equality comparison

bool vtkArraySort::operator!= ( const vtkArraySort & rhs ) const

Inequality comparison

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	stream,
		const vtkArraySort &	rhs
	)			`[friend]`