#include <OMP_ArrayElement.h>

Public Member Functions
	OMP_ArrayElement (const OMP_ArrayElement &S)
	create a new copy instance of the array element S More...

	OMP_ArrayElement (const T &v, const size_t &i)
	create an instance of Array Element with initial value More...

	OMP_ArrayElement ()
	create a default array element More...

	~OMP_ArrayElement ()
	destroy the array element More...

tBoolean	operator< (const OMP_ArrayElement< T > &elt) const
	compare 2 elements More...

tBoolean	operator<= (const OMP_ArrayElement< T > &elt) const
	compare 2 elements More...

tBoolean	operator> (const OMP_ArrayElement< T > &elt) const
	compare 2 elements More...

tBoolean	operator>= (const OMP_ArrayElement< T > &elt) const
	compare 2 elements More...

tBoolean	operator== (const OMP_ArrayElement< T > &elt) const
	compare 2 elements More...

tBoolean	operator!= (const OMP_ArrayElement< T > &elt) const
	compare 2 elements More...

const T &	value () const
	return the value of the element More...

T &	value ()
	return the value of the element More...

const size_t &	index () const
	return the index of the element More...

size_t &	index ()
	return the index of the element More...

void	setElement (const T &v, const size_t &i)
	set the value and index of the element More...

Static Public Member Functions
static const OMP_ArrayElement< T > &	min (const OMP_ArrayElement< T > &a, const OMP_ArrayElement< T > &b)
	return the min element of a & b More...

static const OMP_ArrayElement< T > &	max (const OMP_ArrayElement< T > &a, const OMP_ArrayElement< T > &b)
	return the max element of a & b More...

static const std::pair< T, tUIndex > &	pmin (const std::pair< T, tUIndex > &a, const std::pair< T, tUIndex > &b)
	return the min element of a & b More...

static const std::pair< T, tUIndex > &	pmax (const std::pair< T, tUIndex > &a, const std::pair< T, tUIndex > &b)
	return the max element of a & b More...

Private Attributes
T	mValue

size_t	mIndex

Constructor & Destructor Documentation

◆ OMP_ArrayElement() [1/3]

template<class T>

OMP_ArrayElement< T >::OMP_ArrayElement ( const OMP_ArrayElement< T > & S )

inline

create a new copy instance of the array element S

Parameters

S	the array element class to copy

References OMP_ArrayElement< T >::index(), and OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ OMP_ArrayElement() [2/3]

template<class T>

OMP_ArrayElement< T >::OMP_ArrayElement	(	const T &	v,
		const size_t &	i
	)

inline

create an instance of Array Element with initial value

Parameters

v	value of the element
i	index of the element

◆ OMP_ArrayElement() [3/3]

template<class T>

OMP_ArrayElement< T >::OMP_ArrayElement ( )

inline

create a default array element

◆ ~OMP_ArrayElement()

template<class T>

OMP_ArrayElement< T >::~OMP_ArrayElement ( )

inline

destroy the array element

Member Function Documentation

◆ index() [1/2]

template<class T>

const size_t& OMP_ArrayElement< T >::index ( ) const

inline

return the index of the element

Returns: the index of the element

References OMP_ArrayElement< T >::mIndex.

Referenced by OMP_ArrayElement< T >::OMP_ArrayElement().

Here is the caller graph for this function:

◆ index() [2/2]

template<class T>

size_t& OMP_ArrayElement< T >::index ( )

inline

return the index of the element

Returns: the index of the element

References OMP_ArrayElement< T >::mIndex.

◆ max()

template<class T>

static const OMP_ArrayElement<T>& OMP_ArrayElement< T >::max	(	const OMP_ArrayElement< T > &	a,
		const OMP_ArrayElement< T > &	b
	)

inlinestatic

return the max element of a & b

Parameters

a	element
b	element to compare return the element whose value is max

References OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ min()

template<class T>

static const OMP_ArrayElement<T>& OMP_ArrayElement< T >::min	(	const OMP_ArrayElement< T > &	a,
		const OMP_ArrayElement< T > &	b
	)

inlinestatic

return the min element of a & b

Parameters

a	element
b	element to compare return the element whose value is min

References OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ operator!=()

template<class T>

tBoolean OMP_ArrayElement< T >::operator!= ( const OMP_ArrayElement< T > & elt ) const

inline

compare 2 elements

Parameters

elt	the element to compare

Returns: true if the comparison is true

References OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ operator<()

template<class T>

tBoolean OMP_ArrayElement< T >::operator< ( const OMP_ArrayElement< T > & elt ) const

inline

compare 2 elements

Parameters

elt	the element to compare

Returns: true if the comparison is true

◆ operator<=()

template<class T>

tBoolean OMP_ArrayElement< T >::operator<= ( const OMP_ArrayElement< T > & elt ) const

inline

compare 2 elements

Parameters

elt	the element to compare

Returns: true if the comparison is true

◆ operator==()

template<class T>

tBoolean OMP_ArrayElement< T >::operator== ( const OMP_ArrayElement< T > & elt ) const

inline

compare 2 elements

Parameters

elt	the element to compare

Returns: true if the comparison is true

References OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ operator>()

template<class T>

tBoolean OMP_ArrayElement< T >::operator> ( const OMP_ArrayElement< T > & elt ) const

inline

compare 2 elements

Parameters

elt	the element to compare

Returns: true if the comparison is true

References OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ operator>=()

template<class T>

tBoolean OMP_ArrayElement< T >::operator>= ( const OMP_ArrayElement< T > & elt ) const

inline

compare 2 elements

Parameters

elt	the element to compare

Returns: true if the comparison is true

References OMP_ArrayElement< T >::value().

Here is the call graph for this function:

◆ pmax()

template<class T>

static const std::pair<T,tUIndex>& OMP_ArrayElement< T >::pmax	(	const std::pair< T, tUIndex > &	a,
		const std::pair< T, tUIndex > &	b
	)

inlinestatic

return the max element of a & b

Parameters

a	element
b	element to compare return the element whose value is max

◆ pmin()

template<class T>

static const std::pair<T,tUIndex>& OMP_ArrayElement< T >::pmin	(	const std::pair< T, tUIndex > &	a,
		const std::pair< T, tUIndex > &	b
	)

inlinestatic

return the min element of a & b

Parameters

a	element
b	element to compare return the element whose value is min

◆ setElement()

template<class T>

void OMP_ArrayElement< T >::setElement	(	const T &	v,
		const size_t &	i
	)

inline

set the value and index of the element

Parameters

v	value
i	index

◆ value() [1/2]

template<class T>

const T& OMP_ArrayElement< T >::value ( ) const

inline

return the value of the element

Returns: the value of the element

References OMP_ArrayElement< T >::mValue.

Referenced by OMP_ArrayElement< T >::max(), OMP_ArrayElement< T >::min(), OMP_ArrayElement< T >::OMP_ArrayElement(), OMP_ArrayElement< T >::operator!=(), OMP_ArrayElement< T >::operator==(), OMP_ArrayElement< T >::operator>(), and OMP_ArrayElement< T >::operator>=().

Here is the caller graph for this function:

◆ value() [2/2]

template<class T>

T& OMP_ArrayElement< T >::value ( )

inline

return the value of the element

Returns: the value of the element

References OMP_ArrayElement< T >::mValue.

Member Data Documentation

◆ mIndex

template<class T>

size_t OMP_ArrayElement< T >::mIndex

private

Referenced by OMP_ArrayElement< T >::index().

◆ mValue

template<class T>

T OMP_ArrayElement< T >::mValue

private

Referenced by OMP_ArrayElement< T >::value().

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

OMP_ArrayElement.h

Public Member Functions

Static Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ OMP_ArrayElement() [1/3]

◆ OMP_ArrayElement() [2/3]

◆ OMP_ArrayElement() [3/3]

◆ ~OMP_ArrayElement()

Member Function Documentation

◆ index() [1/2]

◆ index() [2/2]

◆ max()

◆ min()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ pmax()

◆ pmin()

◆ setElement()

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ mIndex

◆ mValue