Stokhos Package Browser (Single Doxygen Collection): Stokhos::LexographicLess< term_type, compare_type > Class Template Reference

Stokhos Package Browser (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

A comparison functor implementing a strict weak ordering based lexographic ordering. More...

#include <Stokhos_ProductBasisUtils.hpp>

Public Types
typedef term_type	product_element_type

typedef term_type::ordinal_type	ordinal_type

typedef term_type::element_type	element_type

Public Member Functions
	LexographicLess (const compare_type &cmp_=compare_type())
	Constructor. More...

bool	operator() (const term_type &a, const term_type &b) const
	Determine if `a` is less than `b`. More...

Protected Member Functions
bool	equal (const element_type &a, const element_type &b) const
	Determine if two elements `a` and `b` are equal. More...

Protected Attributes
compare_type	cmp
	Element comparison functor. More...

Detailed Description

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>
class Stokhos::LexographicLess< term_type, compare_type >

A comparison functor implementing a strict weak ordering based lexographic ordering.

Definition at line 799 of file Stokhos_ProductBasisUtils.hpp.

Member Typedef Documentation

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

typedef term_type Stokhos::LexographicLess< term_type, compare_type >::product_element_type

Definition at line 802 of file Stokhos_ProductBasisUtils.hpp.

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

typedef term_type::ordinal_type Stokhos::LexographicLess< term_type, compare_type >::ordinal_type

Definition at line 803 of file Stokhos_ProductBasisUtils.hpp.

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

typedef term_type::element_type Stokhos::LexographicLess< term_type, compare_type >::element_type

Definition at line 804 of file Stokhos_ProductBasisUtils.hpp.

Constructor & Destructor Documentation

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

Stokhos::LexographicLess< term_type, compare_type >::LexographicLess ( const compare_type & cmp_ = compare_type() )

inline

Constructor.

Definition at line 807 of file Stokhos_ProductBasisUtils.hpp.

Member Function Documentation

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

bool Stokhos::LexographicLess< term_type, compare_type >::operator()	(	const term_type &	a,
		const term_type &	b
	)		const

inline

Determine if a is less than b.

Definition at line 810 of file Stokhos_ProductBasisUtils.hpp.

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

bool Stokhos::LexographicLess< term_type, compare_type >::equal	(	const element_type &	a,
		const element_type &	b
	)		const

inlineprotected

Determine if two elements a and b are equal.

Definition at line 832 of file Stokhos_ProductBasisUtils.hpp.

Member Data Documentation

template<typename term_type, typename compare_type = std::less<typename term_type::element_type>>

compare_type Stokhos::LexographicLess< term_type, compare_type >::cmp

protected

Element comparison functor.

Definition at line 829 of file Stokhos_ProductBasisUtils.hpp.

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

Stokhos_ProductBasisUtils.hpp