sheaf::stl_scoped_index< T > Class Template Reference

Wrapper for scoped_index used for standard template library tree containers (set, multiset, map, multimap). This class redefines operator< to guarantee strict work ordering regardless of the id space. More...

#include <stl_scoped_index.h>

Public Types
typedef T	compare_policy
	The type of compare policy. More...

Public Member Functions
	stl_scoped_index (const scoped_index &xindex)
	Creates a wrapper of scoped_index, xindex. More...
	~stl_scoped_index ()
	Destructor. Not virtual; this can not be a base class. More...
bool	invariant () const
	Class invariant. More...
const scoped_index &	index () const
	scoped_index being wrapped. More...
	operator scoped_index () const
	Conversion operator to scoped_index. More...
bool	operator< (const stl_scoped_index< T > &xother) const
	True if this is less than xother. More...
bool	operator== (const stl_scoped_index< T > &xother) const
	True if this is equivalent to xother. More...

Detailed Description

template<typename T = lexographical_compare_policy>
class sheaf::stl_scoped_index< T >

Wrapper for scoped_index used for standard template library tree containers (set, multiset, map, multimap). This class redefines operator< to guarantee strict work ordering regardless of the id space.

Definition at line 87 of file stl_scoped_index.h.

Member Typedef Documentation

compare_policy

template<typename T = lexographical_compare_policy>

typedef T sheaf::stl_scoped_index< T >::compare_policy

The type of compare policy.

Definition at line 98 of file stl_scoped_index.h.

Constructor & Destructor Documentation

stl_scoped_index()

template<typename T >

sheaf::stl_scoped_index< T >::stl_scoped_index

(

const scoped_index &

xindex

)

Creates a wrapper of scoped_index, xindex.

Postcondition

• invariant()

• index() == xindex

Definition at line 40 of file stl_scoped_index.impl.h.

~stl_scoped_index()

template<typename T >

sheaf::stl_scoped_index< T >::~stl_scoped_index

(

)

Destructor. Not virtual; this can not be a base class.

Definition at line 60 of file stl_scoped_index.impl.h.

Referenced by sheaf::stl_scoped_index<>::stl_scoped_index().

Member Function Documentation

index()

template<typename T = lexographical_compare_policy>

const scoped_index& sheaf::stl_scoped_index< T >::index ( ) const

inline

scoped_index being wrapped.

Definition at line 122 of file stl_scoped_index.h.

Referenced by sheaf::stl_scoped_index<>::operator<(), and sheaf::stl_scoped_index<>::operator==().

invariant()

template<typename T = lexographical_compare_policy>

bool sheaf::stl_scoped_index< T >::invariant ( ) const

inline

Class invariant.

Definition at line 114 of file stl_scoped_index.h.

operator scoped_index()

template<typename T >

sheaf::stl_scoped_index< T >::operator scoped_index

(

)

const

Conversion operator to scoped_index.

Definition at line 67 of file stl_scoped_index.impl.h.

operator<()

template<typename T>

bool sheaf::stl_scoped_index< T >::operator<

(

const stl_scoped_index< T > &

xother

)

const

True if this is less than xother.

Postcondition

• result == (compare_policy::less_than(index(), xother.index()))

Definition at line 75 of file stl_scoped_index.impl.h.

Referenced by sheaf::stl_scoped_index<>::operator scoped_index().

operator==()

template<typename T>

bool sheaf::stl_scoped_index< T >::operator==

(

const stl_scoped_index< T > &

xother

)

const

True if this is equivalent to xother.

Postcondition

• result == (compare_policy::equal(index(), xother.index()))

Definition at line 95 of file stl_scoped_index.impl.h.

Referenced by sheaf::stl_scoped_index<>::operator<().

---

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

• stl_scoped_index.h
• stl_scoped_index.impl.h