vtkArraySort Class Reference

Controls sorting of sparse array coordinates. More...

#include <vtkArraySort.h>

List of all members.

Public Types
typedef vtkArrayCoordinates::DimensionT	DimensionT
Public Member Functions
	vtkArraySort ()
	vtkArraySort (DimensionT i)
	vtkArraySort (DimensionT i, DimensionT j)
	vtkArraySort (DimensionT i, DimensionT j, DimensionT k)
DimensionT	GetDimensions () const
void	SetDimensions (DimensionT dimensions)
DimensionT &	operator[] (DimensionT i)
const DimensionT &	operator[] (DimensionT i) const
bool	operator== (const vtkArraySort &rhs) const
bool	operator!= (const vtkArraySort &rhs) const
Friends
VTKCOMMONCORE_EXPORT friend ostream &	operator<< (ostream &stream, const vtkArraySort &rhs)

---

Detailed Description

Controls sorting of sparse array coordinates.

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 (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Tests:

vtkArraySort (Tests)

Definition at line 53 of file vtkArraySort.h.

---

Member Typedef Documentation

typedef vtkArrayCoordinates::DimensionT vtkArraySort::DimensionT

Definition at line 56 of file vtkArraySort.h.

---

Constructor & Destructor Documentation

vtkArraySort::vtkArraySort

(

)

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

vtkArraySort::vtkArraySort

(

DimensionT

i

)

[explicit]

Sorts an array along one dimension.

vtkArraySort::vtkArraySort	(	DimensionT	i,
		DimensionT	j
	)

Sorts an array along two dimensions.

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

Sorts an array along three dimensions.

---

Member Function Documentation

DimensionT vtkArraySort::GetDimensions

(

)

const

Return the number of dimensions for sorting.

void vtkArraySort::SetDimensions

(

DimensionT

dimensions

)

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

DimensionT& vtkArraySort::operator[]

(

DimensionT

i

)

Returns the i-th dimension to be sorted.

const DimensionT& vtkArraySort::operator[]

(

DimensionT

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

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

Serialization

---

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

• dox/Common/Core/vtkArraySort.h