npstat::OrderedPointND< Point > Class Template Reference

#include <OrderedPointND.hh>

Public Types
enum	{ dim_size = PointDimensionality<Point>::dim_size }
typedef Point::value_type	value_type

Public Member Functions
	OrderedPointND ()
	OrderedPointND (const Point &point)
template<typename Num2 >
	OrderedPointND (const Num2 *data, unsigned dataLen)
template<typename Num2 >
	OrderedPointND (const Num2 *data, const unsigned *indices, unsigned lenIndices)
	OrderedPointND (const Point &point, const unsigned long *number, unsigned lenNumber)
const Point &	point () const
const value_type *	coords () const
const unsigned long *	number () const
unsigned	dim () const
unsigned	size () const
value_type &	operator[] (unsigned i)
const value_type &	operator[] (unsigned i) const
void	setNumber (unsigned i, unsigned long value)
unsigned long	getNumber (unsigned i) const

Friends
bool	operator== (const OrderedPointND &, const OrderedPointND &)
bool	operator!= (const OrderedPointND &, const OrderedPointND &)

Detailed Description

template<class Point>
class npstat::OrderedPointND< Point >

Multivariate point which can remember its sequence number according to multiple sorting criteria. These points can be used, for example, to build composite distributions (i.e., modeled by copula and marginals).

Template parameter class Point must be subscriptable. It must also publish "value_type" typedef (std::array is a good candidate).

Constructor & Destructor Documentation

OrderedPointND() [1/5]

template<class Point >

npstat::OrderedPointND< Point >::OrderedPointND

(

)

Default constructor will invoke the default Point constructor

OrderedPointND() [2/5]

template<class Point >

npstat::OrderedPointND< Point >::OrderedPointND

(

const Point &

point

)

Constructor from the underlying point

OrderedPointND() [3/5]

template<class Point >

template<typename Num2 >

npstat::OrderedPointND< Point >::OrderedPointND	(	const Num2 *	data,
		unsigned	dataLen
	)

Costructor from a data array for the underlying point

OrderedPointND() [4/5]

template<class Point >

template<typename Num2 >

npstat::OrderedPointND< Point >::OrderedPointND	(	const Num2 *	data,
		const unsigned *	indices,
		unsigned	lenIndices
	)

Costructor from a flat data array and a set of indices into this array

OrderedPointND() [5/5]

template<class Point >

npstat::OrderedPointND< Point >::OrderedPointND	(	const Point &	point,
		const unsigned long *	number,
		unsigned	lenNumber
	)

Constructor from the underlying point and its numbers in several sorted sequences

Member Function Documentation

getNumber()

template<class Point >

unsigned long npstat::OrderedPointND< Point >::getNumber

(

unsigned

i

)

const

Get point number according to sorting criterion i

operator[]() [1/2]

template<class Point >

value_type& npstat::OrderedPointND< Point >::operator[] ( unsigned  i )

inline

Non-const subscripting

operator[]() [2/2]

template<class Point >

const value_type& npstat::OrderedPointND< Point >::operator[] ( unsigned  i ) const

inline

Const subscripting

point()

template<class Point >

const Point& npstat::OrderedPointND< Point >::point ( ) const

inline

Examine object properties

setNumber()

template<class Point >

void npstat::OrderedPointND< Point >::setNumber	(	unsigned	i,
		unsigned long	value
	)

Set point number according to sorting criterion i

---

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

• stat/OrderedPointND.hh