JTOOLS::JMultiKey< N, JKey_t > Class Template Reference

Forward declaration of template JMultiKey class. More...

#include <JMultiKey.hh>

Inheritance diagram for JTOOLS::JMultiKey< N, JKey_t >:

Public Types
typedef JKey_t	key_type
typedef JMultiKey< N-1, JKey_t >	mapped_type
typedef std::pair< key_type, mapped_type >	pair

Public Member Functions
	JMultiKey ()
	Default constructor. More...
	JMultiKey (typename JClass< mapped_type >::argument_type __first, typename JClass< key_type >::argument_type __second)
	Constructor. More...
	JMultiKey (typename JClass< key_type >::argument_type __first, typename JClass< mapped_type >::argument_type __second)
	Constructor. More...
	JMultiKey (typename JArgument< N, JKey_t >::argument_type key)
	Copy constructor. More...
bool	less (const JMultiKey< N, JKey_t > &key) const
	Less than method. More...
double	getLengthSquared () const
	Get length squared. More...
double	getLength () const
	Get length. More...
JMultiKey< N-1, JKey_t >	front () const
	Get frontend key. More...
key_type	back () const
	Get backend key. More...

Friends
std::istream &	operator>> (std::istream &in, JMultiKey< N, JKey_t > &key)
	Read key from input. More...
std::ostream &	operator<< (std::ostream &out, const JMultiKey< N, JKey_t > &key)
	Write key to output. More...

Detailed Description

template<unsigned int N, class JKey_t>
class JTOOLS::JMultiKey< N, JKey_t >

Forward declaration of template JMultiKey class.

Multidimensional key.

This class reproduces the key of a multidimensional map. The individual data members can be accessed as, e.g:

          JMultiKey<3, key_type>  key;

          key[[.second].second].first;

Definition at line 29 of file JMultiKey.hh.

Member Typedef Documentation

template<unsigned int N, class JKey_t>

typedef JKey_t JTOOLS::JMultiKey< N, JKey_t >::key_type

Definition at line 67 of file JMultiKey.hh.

template<unsigned int N, class JKey_t>

typedef JMultiKey<N-1, JKey_t> JTOOLS::JMultiKey< N, JKey_t >::mapped_type

Definition at line 68 of file JMultiKey.hh.

template<unsigned int N, class JKey_t>

typedef std::pair<key_type, mapped_type> JTOOLS::JMultiKey< N, JKey_t >::pair

Definition at line 69 of file JMultiKey.hh.

Constructor & Destructor Documentation

template<unsigned int N, class JKey_t>

JTOOLS::JMultiKey< N, JKey_t >::JMultiKey ( )

inline

Default constructor.

Definition at line 75 of file JMultiKey.hh.

                :
      pair()
    {}

template<unsigned int N, class JKey_t>

JTOOLS::JMultiKey< N, JKey_t >::JMultiKey ( 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
__second	secondary key

Definition at line 87 of file JMultiKey.hh.

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

template<unsigned int N, class JKey_t>

JTOOLS::JMultiKey< N, JKey_t >::JMultiKey ( 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

Definition at line 100 of file JMultiKey.hh.

                                                                  :           
      pair(__first, __second)
    {}

template<unsigned int N, class JKey_t>

JTOOLS::JMultiKey< N, JKey_t >::JMultiKey ( typename JArgument< N, JKey_t >::argument_type  key )

inline

Copy constructor.

Parameters

key

key

Definition at line 111 of file JMultiKey.hh.

                                                              :
      pair(key.first, key.second)
    {}

Member Function Documentation

template<unsigned int N, class JKey_t>

bool JTOOLS::JMultiKey< N, JKey_t >::less ( const JMultiKey< N, JKey_t > &  key ) const

inline

Less than method.

Parameters

key

key

Returns

true if this key less than given key; else false

Definition at line 122 of file JMultiKey.hh.

    {
      if (this->first == key.first)
        return this->second.less(key.second);
      else
        return this->first < key.first;
    }

template<unsigned int N, class JKey_t>

double JTOOLS::JMultiKey< N, JKey_t >::getLengthSquared ( ) const

inline

Get length squared.

Returns

square of length

Definition at line 136 of file JMultiKey.hh.

    {
      return this->first*this->first + this->second.getLengthSquared();
    }

template<unsigned int N, class JKey_t>

double JTOOLS::JMultiKey< N, JKey_t >::getLength ( ) const

inline

Get length.

Returns

length

Definition at line 147 of file JMultiKey.hh.

    {
      return sqrt(this->getLengthSquared());
    }

template<unsigned int N, class JKey_t>

JMultiKey<N-1, JKey_t> JTOOLS::JMultiKey< N, JKey_t >::front ( ) const

inline

Get frontend key.

Returns

frontend key

Definition at line 158 of file JMultiKey.hh.

    {
      return JMultiKey<N-1, JKey_t>(this->first, this->second.front());
    }

template<unsigned int N, class JKey_t>

key_type JTOOLS::JMultiKey< N, JKey_t >::back ( ) const

inline

Get backend key.

Returns

backend key

Definition at line 169 of file JMultiKey.hh.

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

Friends And Related Function Documentation

template<unsigned int N, class JKey_t>

std::istream& operator>> ( std::istream &  in, JMultiKey< N, JKey_t > &  key  )

friend

Read key from input.

Parameters

in	input stream
key	key

Returns

input stream

Definition at line 182 of file JMultiKey.hh.

    {
      in >> key.first;
      in >> key.second;

      return in;
    }

template<unsigned int N, class JKey_t>

std::ostream& operator<< ( std::ostream &  out, const JMultiKey< N, JKey_t > &  key  )

friend

Write key to output.

Parameters

out	output stream
key	key

Returns

output stream

Definition at line 198 of file JMultiKey.hh.

    {
      out << key.first;
      out << ' ';
      out << key.second;

      return out;
    }

---

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

• JMultiKey.hh