Multidimensional key. 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_type

typedef std::array< key_type, N >	array_type

typedef std::conditional< std::is_const< key_type >::value, typenamestd::remove_const< key_type >::type, typenamestd::add_const< key_type >::type >::type	U

Public Member Functions
	JMultiKey ()
	Default constructor.

	JMultiKey (typename JClass< mapped_type >::argument_type first, typename JClass< key_type > ::argument_type second)
	Append constructor.

	JMultiKey (typename JClass< key_type > ::argument_type first, typename JClass< mapped_type >::argument_type second)
	Insert constructor.

	JMultiKey (const JMultiKey &first, typename JClass< key_type >::argument_type second)
	Shift constructor.

	JMultiKey (const JMultiKey< N, U > &key)
	Copy constructor.

	JMultiKey (const std::array< key_type, N > &array)
	Copy constructor.

	operator array_type () const
	Type conversion operator.

bool	less (const JMultiKey &key) const
	Less than method.

JMultiKey< N-1, key_type >	front () const
	Get frontend key.

key_type	back () const
	Get backend key.

Private Member Functions
template<class ... Args>
std::array< key_type, N-1 >	pop_front (const key_type key, const Args &...args)
	Auxiliary method to pop front array.

template<size_t ... i>
std::array< key_type, N-1 >	pop_front (const std::array< key_type, N > &array, const std::index_sequence< i... > &ls)
	Pop front array.

Static Private Member Functions
template<size_t ... i>
static array_type	to_array (const key_type &key, const typename mapped_type::array_type &array, std::index_sequence< i... >)
	Auxiliary method to convert keys to array.

Friends
std::istream &	operator>> (std::istream &in, JMultiKey &key)
	Read key from input.

std::ostream &	operator<< (std::ostream &out, const JMultiKey &key)
	Write key to output.

Detailed Description

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

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 41 of file JMultiKey.hh.

Member Typedef Documentation

◆ key_type

template<unsigned int N, class JKey_t >

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

Definition at line 47 of file JMultiKey.hh.

◆ mapped_type

template<unsigned int N, class JKey_t >

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

Definition at line 48 of file JMultiKey.hh.

◆ pair_type

template<unsigned int N, class JKey_t >

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

Definition at line 49 of file JMultiKey.hh.

◆ array_type

template<unsigned int N, class JKey_t >

std::array<key_type, N> JTOOLS::JMultiKey< N, JKey_t >::array_type

Definition at line 50 of file JMultiKey.hh.

◆ U

template<unsigned int N, class JKey_t >

std::conditional<std::is_const<key_type>::value,typenamestd::remove_const<key_type>::type,typenamestd::add_const<key_type>::type>::type JTOOLS::JMultiKey< N, JKey_t >::U

Definition at line 54 of file JMultiKey.hh.

Constructor & Destructor Documentation

◆ JMultiKey() [1/6]

template<unsigned int N, class JKey_t >

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

inline

Default constructor.

Definition at line 59 of file JMultiKey.hh.

                :
      pair_type()
    {}

◆ JMultiKey() [2/6]

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

Append constructor.

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

Parameters

first	primary keys
second	secondary key

Definition at line 71 of file JMultiKey.hh.

                                                                :
      pair_type(first.first, mapped_type(first, second))
    {}

◆ JMultiKey() [3/6]

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

Insert constructor.

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

Parameters

first	primary key
second	secondary keys

Definition at line 84 of file JMultiKey.hh.

                                                                :
      pair_type(first, second)
    {}

◆ JMultiKey() [4/6]

template<unsigned int N, class JKey_t >

JTOOLS::JMultiKey< N, JKey_t >::JMultiKey	(	const JMultiKey< N, JKey_t > &	first,
		typename JClass< key_type >::argument_type	second )

inline

Shift constructor.

The first of the primary keys is removed and the secondary key is appended to the end of the remainder of the primary keys.

Parameters

first	primary keys
second	secondary key

Definition at line 97 of file JMultiKey.hh.

                                                                                     :
      JMultiKey(first.second, second)
    {}

◆ JMultiKey() [5/6]

template<unsigned int N, class JKey_t >

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

inline

Copy constructor.

Parameters

key key

Definition at line 107 of file JMultiKey.hh.

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

◆ JMultiKey() [6/6]

template<unsigned int N, class JKey_t >

JTOOLS::JMultiKey< N, JKey_t >::JMultiKey ( const std::array< key_type, N > & array )

inline

Copy constructor.

Parameters

array array

Definition at line 117 of file JMultiKey.hh.

                                                  :
      pair_type(array[0], pop_front(array, std::make_index_sequence<N>{}))
    {}

Member Function Documentation

◆ operator array_type()

template<unsigned int N, class JKey_t >

JTOOLS::JMultiKey< N, JKey_t >::operator array_type ( ) const

inline

Type conversion operator.

Returns: array

Definition at line 127 of file JMultiKey.hh.

    {
      return to_array(this->first, this->second, std::make_index_sequence<N-1>{});
    }

◆ less()

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 139 of file JMultiKey.hh.

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

◆ front()

template<unsigned int N, class JKey_t >

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

inline

Get frontend key.

Returns: frontend key

Definition at line 153 of file JMultiKey.hh.

    {
      return JMultiKey<0, key_type>::front(*this);
    }

◆ back()

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 164 of file JMultiKey.hh.

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

◆ to_array()

template<unsigned int N, class JKey_t >

template<size_t ... i>

static array_type JTOOLS::JMultiKey< N, JKey_t >::to_array	(	const key_type &	key,
		const typename mapped_type::array_type &	array,
		std::index_sequence< i... >	)

inlinestaticprivate

Auxiliary method to convert keys to array.

Parameters

key	key
array	array

Returns: array

Definition at line 214 of file JMultiKey.hh.

    {
      return {key, array[i]...};
    }

◆ pop_front() [1/2]

template<unsigned int N, class JKey_t >

template<class ... Args>

std::array< key_type, N-1 > JTOOLS::JMultiKey< N, JKey_t >::pop_front	(	const key_type	key,
		const Args &...	args )

inlineprivate

Auxiliary method to pop front array.

Parameters

key	key
args	values

Definition at line 229 of file JMultiKey.hh.

    {
      return std::array<key_type, N-1>({args...});
    }

◆ pop_front() [2/2]

template<unsigned int N, class JKey_t >

template<size_t ... i>

std::array< key_type, N-1 > JTOOLS::JMultiKey< N, JKey_t >::pop_front	(	const std::array< key_type, N > &	array,
		const std::index_sequence< i... > &	ls )

inlineprivate

Pop front array.

Parameters

array	array
ls	indices of array

Definition at line 242 of file JMultiKey.hh.

    {
      return pop_front(array[i]...);
    }

Friends And Related Symbol Documentation

◆ operator>>

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 177 of file JMultiKey.hh.

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

◆ operator<<

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 193 of file JMultiKey.hh.

    {
      const JFormat format(out, getFormat< JMultiKey<0, key_type> >(JFormat_t(9, 3, std::ios::fixed | std::ios::showpos)));
 
      out << format << key.first;
      out << ' ';
      out << key.second;
 
      return out;
    }

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

JMultiKey.hh

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ key_type

◆ mapped_type

◆ pair_type

◆ array_type

◆ U

Constructor & Destructor Documentation

◆ JMultiKey() [1/6]

◆ JMultiKey() [2/6]

◆ JMultiKey() [3/6]

◆ JMultiKey() [4/6]

◆ JMultiKey() [5/6]

◆ JMultiKey() [6/6]

Member Function Documentation

◆ operator array_type()

◆ less()

◆ front()

◆ back()

◆ to_array()

◆ pop_front() [1/2]

◆ pop_front() [2/2]

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<