casacore::SortKey Class Reference

Define a Sort key. More...

#include <Sort.h>

Public Member Functions
	SortKey (const void *data, const CountedPtr< BaseCompare > &, uInt increment, int order)
	Define a sort key in a given data array using the indicated comparison object, stride and sort order. More...
	SortKey (const SortKey &)
	Copy constructor (copy semantics). More...
	~SortKey ()
SortKey &	operator= (const SortKey &)
	Assignment (copy semantics). More...
uInt	tryGenSort (Vector< uInt > &indexVector, uInt nrrec, int opt) const
	Try if GenSort can be used for this single key. More...
int	order () const
	Get the sort order. More...

Protected Attributes
int	order_p
	sort order; -1 = ascending, 1 = descending More...
const void *	data_p
	address of first data point More...
uInt	incr_p
	increment for next data point More...
CountedPtr< BaseCompare >	ccmpObj_p
	comparison object; use CountedPtr for memory management More...
BaseCompare *	cmpObj_p
	comparison object; use raw pointer for performance More...

Friends
class	Sort

Detailed Description

Define a Sort key.

Intended use:

Internal

Review Status

Reviewed By:

Friso Olnon

Date Reviewed:

1995/03/01

Test programs:

tSort, tSort_1

Synopsis

SortKey is a helper class for the Sort class. It holds the following information about a sort key:

• Address of the data array containing the sort key;
• A CountedPtr to a comparison object to be used (of a class derived from the abstract base class BaseCompare).
• Increment for the next data point – this lets you specify a stride for keys embedded in a struct;
• Sort order – ascending or descending;

Definition at line 62 of file Sort.h.

Constructor & Destructor Documentation

casacore::SortKey::SortKey	(	const void *	data,
		const CountedPtr< BaseCompare > &	,
		uInt	increment,
		int	order
	)

Define a sort key in a given data array using the indicated comparison object, stride and sort order.

casacore::SortKey::SortKey

(

const SortKey &

)

Copy constructor (copy semantics).

casacore::SortKey::~SortKey

(

)

Member Function Documentation

SortKey& casacore::SortKey::operator=

(

const SortKey &

)

Assignment (copy semantics).

int casacore::SortKey::order ( ) const

inline

Get the sort order.

Definition at line 86 of file Sort.h.

References order_p.

uInt casacore::SortKey::tryGenSort	(	Vector< uInt > &	indexVector,
		uInt	nrrec,
		int	opt
	)		const

Try if GenSort can be used for this single key.

If it succeeds, it returns the resulting number of elements. Otherwise it returns 0.

Friends And Related Function Documentation

friend class Sort

friend

Definition at line 65 of file Sort.h.

Member Data Documentation

CountedPtr<BaseCompare> casacore::SortKey::ccmpObj_p

protected

comparison object; use CountedPtr for memory management

Definition at line 97 of file Sort.h.

BaseCompare* casacore::SortKey::cmpObj_p

protected

comparison object; use raw pointer for performance

Definition at line 99 of file Sort.h.

const void* casacore::SortKey::data_p

protected

address of first data point

Definition at line 93 of file Sort.h.

uInt casacore::SortKey::incr_p

protected

increment for next data point

Definition at line 95 of file Sort.h.

int casacore::SortKey::order_p

protected

sort order; -1 = ascending, 1 = descending

Definition at line 91 of file Sort.h.

Referenced by order().

---

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

• casa/casacore/casa/Utilities/Sort.h