JTOOLS::JMultiPair< N, JKey_t, JValue_t > Class Template Reference

Multidimensional pair. More...

#include <JMultiPair.hh>

Public Types
typedef JKey_t	key_type
typedef JValue_t	value_type
typedef JMultiPair< N-1, key_type, value_type >	mapped_type
typedef JLANG::JClass< value_type >::reference_type	reference_type
typedef JMultiKey< N, key_type >	multikey_type

Public Member Functions
	JMultiPair ()
	Default constructor. More...
	JMultiPair (typename JClass< key_type > ::argument_type __first, typename JClass< mapped_type >::argument_type __second)
	Constructor. More...
	JMultiPair (typename JClass< mapped_type >::argument_type __first, typename JClass< key_type > ::argument_type __second)
	Constructor. More...
	JMultiPair (typename JClass< multikey_type >::argument_type key, typename JClass< value_type > ::argument_type value)
	Constructor. More...
multikey_type	getKey () const
	Get multidimensional key. More...
reference_type	getValue ()
	Get value. More...
const reference_type	getValue () const
	Get value. More...

Public Attributes
key_type	first
mapped_type	second

Detailed Description

template<unsigned int N, class JKey_t, class JValue_t>
class JTOOLS::JMultiPair< N, JKey_t, JValue_t >

Multidimensional pair.

This class reproduces the element of a multidimensional map. The individual data members can be accessed as:

          JMultiPair<3, key_type, mapped_type>  pair;

          pair[[.second].second].first;
          pair[[.second].second].second;

Definition at line 30 of file JMultiPair.hh.

Member Typedef Documentation

key_type

template<unsigned int N, class JKey_t , class JValue_t >

typedef JKey_t JTOOLS::JMultiPair< N, JKey_t, JValue_t >::key_type

Definition at line 34 of file JMultiPair.hh.

value_type

template<unsigned int N, class JKey_t , class JValue_t >

typedef JValue_t JTOOLS::JMultiPair< N, JKey_t, JValue_t >::value_type

Definition at line 35 of file JMultiPair.hh.

mapped_type

template<unsigned int N, class JKey_t , class JValue_t >

typedef JMultiPair<N-1, key_type, value_type> JTOOLS::JMultiPair< N, JKey_t, JValue_t >::mapped_type

Definition at line 36 of file JMultiPair.hh.

reference_type

template<unsigned int N, class JKey_t , class JValue_t >

typedef JLANG::JClass<value_type>::reference_type JTOOLS::JMultiPair< N, JKey_t, JValue_t >::reference_type

Definition at line 37 of file JMultiPair.hh.

multikey_type

template<unsigned int N, class JKey_t , class JValue_t >

typedef JMultiKey<N, key_type> JTOOLS::JMultiPair< N, JKey_t, JValue_t >::multikey_type

Definition at line 38 of file JMultiPair.hh.

Constructor & Destructor Documentation

JMultiPair() [1/4]

template<unsigned int N, class JKey_t , class JValue_t >

JTOOLS::JMultiPair< N, JKey_t, JValue_t >::JMultiPair ( )

inline

Default constructor.

Definition at line 44 of file JMultiPair.hh.

                 :
      first (),
      second()
    {}

JMultiPair() [2/4]

template<unsigned int N, class JKey_t , class JValue_t >

JTOOLS::JMultiPair< N, JKey_t, JValue_t >::JMultiPair ( typename JClass< key_type > ::argument_type  __first, typename JClass< mapped_type >::argument_type  __second  )

inline

Constructor.

The primary key is inserted at the start of the secondary keys.

Parameters

__first	primary key
__second	secondary keys and value

Definition at line 57 of file JMultiPair.hh.

                                                                   :
      first (__first),
      second(__second)
    {}

JMultiPair() [3/4]

template<unsigned int N, class JKey_t , class JValue_t >

JTOOLS::JMultiPair< N, JKey_t, JValue_t >::JMultiPair ( typename JClass< mapped_type >::argument_type  __first, typename JClass< key_type > ::argument_type  __second  )

inline

Constructor.

The secondary key is appended to the end of the primary keys.

Parameters

__first	primary keys and value
__second	secondary key

Definition at line 71 of file JMultiPair.hh.

                                                                   :
      first (__first.first),
      second(mapped_type(__first.second, __second))
    {}

JMultiPair() [4/4]

template<unsigned int N, class JKey_t , class JValue_t >

JTOOLS::JMultiPair< N, JKey_t, JValue_t >::JMultiPair ( typename JClass< multikey_type >::argument_type  key, typename JClass< value_type > ::argument_type  value  )

inline

Constructor.

Parameters

key	multidimensional key
value	value

Definition at line 84 of file JMultiPair.hh.

                                                                  :
      first (key.first),
      second(mapped_type(key.second, value))
    {}

Member Function Documentation

getKey()

template<unsigned int N, class JKey_t , class JValue_t >

multikey_type JTOOLS::JMultiPair< N, JKey_t, JValue_t >::getKey ( ) const

inline

Get multidimensional key.

Returns

multidimensional key

Definition at line 96 of file JMultiPair.hh.

    {
      return multikey_type(this->first, this->second.getKey());
    }

getValue() [1/2]

template<unsigned int N, class JKey_t , class JValue_t >

reference_type JTOOLS::JMultiPair< N, JKey_t, JValue_t >::getValue ( )

inline

Get value.

Returns

value

Definition at line 107 of file JMultiPair.hh.

    { 
      return this->second.getValue();
    }

getValue() [2/2]

template<unsigned int N, class JKey_t , class JValue_t >

const reference_type JTOOLS::JMultiPair< N, JKey_t, JValue_t >::getValue ( ) const

inline

Get value.

Returns

value

Definition at line 118 of file JMultiPair.hh.

    { 
      return this->second.getValue();
    }

Member Data Documentation

first

template<unsigned int N, class JKey_t , class JValue_t >

key_type JTOOLS::JMultiPair< N, JKey_t, JValue_t >::first

Definition at line 124 of file JMultiPair.hh.

second

template<unsigned int N, class JKey_t , class JValue_t >

mapped_type JTOOLS::JMultiPair< N, JKey_t, JValue_t >::second

Definition at line 125 of file JMultiPair.hh.

---

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

• JMultiPair.hh