ug::MultiIndex< N, TSingleIndexType > Class Template Reference

#include <multi_index.h>

Public Types
typedef TSingleIndexType	single_index_type

Public Member Functions
bool	operator!= (const MultiIndex &o) const
bool	operator== (const MultiIndex &o) const
	comparison operator More...
single_index_type &	operator[] (size_t i)
	access to index component More...
const single_index_type &	operator[] (size_t i) const
	const access to index component More...
size_t	size () const
	number of indices in multi index More...

Private Attributes
single_index_type	m_indices [N]

Detailed Description

template<int N, typename TSingleIndexType = size_t>
class ug::MultiIndex< N, TSingleIndexType >

A MultiIndex is just a vector of integers.

Member Typedef Documentation

single_index_type

template<int N, typename TSingleIndexType = size_t>

typedef TSingleIndexType ug::MultiIndex< N, TSingleIndexType >::single_index_type

Member Function Documentation

operator!=()

template<int N, typename TSingleIndexType = size_t>

bool ug::MultiIndex< N, TSingleIndexType >::operator!= ( const MultiIndex< N, TSingleIndexType > &  o ) const

inline

operator==()

template<int N, typename TSingleIndexType = size_t>

bool ug::MultiIndex< N, TSingleIndexType >::operator== ( const MultiIndex< N, TSingleIndexType > &  o ) const

inline

comparison operator

References ug::MultiIndex< N, TSingleIndexType >::m_indices.

operator[]() [1/2]

template<int N, typename TSingleIndexType = size_t>

single_index_type& ug::MultiIndex< N, TSingleIndexType >::operator[] ( size_t  i )

inline

access to index component

References ug::MultiIndex< N, TSingleIndexType >::m_indices, and UG_ASSERT.

operator[]() [2/2]

template<int N, typename TSingleIndexType = size_t>

const single_index_type& ug::MultiIndex< N, TSingleIndexType >::operator[] ( size_t  i ) const

inline

const access to index component

References ug::MultiIndex< N, TSingleIndexType >::m_indices, and UG_ASSERT.

size()

template<int N, typename TSingleIndexType = size_t>

size_t ug::MultiIndex< N, TSingleIndexType >::size ( ) const

inline

number of indices in multi index

Member Data Documentation

m_indices

template<int N, typename TSingleIndexType = size_t>

single_index_type ug::MultiIndex< N, TSingleIndexType >::m_indices[N]

private

Referenced by ug::MultiIndex< 2, size_t >::MultiIndex(), ug::MultiIndex< 3, size_t >::MultiIndex(), ug::MultiIndex< 2, size_t >::operator!=(), ug::MultiIndex< 2, size_t >::operator<(), ug::MultiIndex< N, TSingleIndexType >::operator==(), ug::MultiIndex< 1, size_t >::operator==(), ug::MultiIndex< 2, size_t >::operator==(), ug::MultiIndex< 3, size_t >::operator==(), ug::MultiIndex< 2, size_t >::operator>(), ug::MultiIndex< N, TSingleIndexType >::operator[](), ug::MultiIndex< 1, size_t >::operator[](), ug::MultiIndex< 2, size_t >::operator[](), and ug::MultiIndex< 3, size_t >::operator[]().

---

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

• ugbase/lib_disc/common/multi_index.h