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

One-dimensional key. More...

#include <JMultiKey.hh>

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

Public Types
typedef JKey_t	key_type
typedef JMultiKey< 0, key_type >	mapped_type
typedef std::array< key_type, 1 >	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 onstructor.
	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 (typename JClass< key_type >::argument_type first)
	Constructor.
	JMultiKey (const JMultiKey< 1, U > &key)
	Copy constructor.
	JMultiKey (const std::array< key_type, 1 > &array)
	Copy constructor.
	operator array_type () const
	Type conversion operator.
bool	less (const JMultiKey &key) const
	Less than method.
key_type	back () const
	Get backend key.

Public Attributes
key_type	first

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<class JKey_t>
class JTOOLS::JMultiKey< 1, JKey_t >

One-dimensional key.

Definition at line 253 of file JMultiKey.hh.

Member Typedef Documentation

key_type

template<class JKey_t >

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

Definition at line 258 of file JMultiKey.hh.

mapped_type

template<class JKey_t >

JMultiKey<0, key_type> JTOOLS::JMultiKey< 1, JKey_t >::mapped_type

Definition at line 259 of file JMultiKey.hh.

array_type

template<class JKey_t >

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

Definition at line 260 of file JMultiKey.hh.

U

template<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< 1, JKey_t >::U

Definition at line 264 of file JMultiKey.hh.

Constructor & Destructor Documentation

JMultiKey() [1/7]

template<class JKey_t >

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

inline

Default constructor.

Definition at line 270 of file JMultiKey.hh.

                :
      first()
    {}

JMultiKey() [2/7]

template<class JKey_t >

JTOOLS::JMultiKey< 1, JKey_t >::JMultiKey ( typename JClass< mapped_type >::argument_type first, typename JClass< key_type > ::argument_type second )

inline

Append onstructor.

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

Parameters

first	primary key
second	secondary key

Definition at line 282 of file JMultiKey.hh.

                                                                :
      first(second)
    {}

JMultiKey() [3/7]

template<class JKey_t >

JTOOLS::JMultiKey< 1, 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 key.

Parameters

first	primary key
second	secondary key

Definition at line 295 of file JMultiKey.hh.

                                                                :
      first(first)
    {}

JMultiKey() [4/7]

template<class JKey_t >

JTOOLS::JMultiKey< 1, JKey_t >::JMultiKey ( const JMultiKey< 1, 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 308 of file JMultiKey.hh.

                                                                                     :
      first(second)
    {}

JMultiKey() [5/7]

template<class JKey_t >

JTOOLS::JMultiKey< 1, JKey_t >::JMultiKey ( typename JClass< key_type >::argument_type first )

inline

Constructor.

Parameters

first

key

Definition at line 318 of file JMultiKey.hh.

                                                            :
      first(first)
    {}

JMultiKey() [6/7]

template<class JKey_t >

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

inline

Copy constructor.

Parameters

key

key

Definition at line 328 of file JMultiKey.hh.

                                          :
      first(key.first)
    {}

JMultiKey() [7/7]

template<class JKey_t >

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

inline

Copy constructor.

Parameters

array

array

Definition at line 338 of file JMultiKey.hh.

                                                  :
      first(array[0])
    {}

Member Function Documentation

operator array_type()

template<class JKey_t >

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

inline

Type conversion operator.

Returns

array

Definition at line 348 of file JMultiKey.hh.

    {
      return {this->first};
    }

less()

template<class JKey_t >

bool JTOOLS::JMultiKey< 1, JKey_t >::less ( const JMultiKey< 1, 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 360 of file JMultiKey.hh.

    {
      return this->first < key.first;
    }

back()

template<class JKey_t >

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

inline

Get backend key.

Returns

backend key

Definition at line 371 of file JMultiKey.hh.

    {
      return this->first;
    }

Friends And Related Symbol Documentation

operator>>

template<class JKey_t >

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

friend

Read key from input.

Parameters

in	input stream
key	key

Returns

input stream

Definition at line 384 of file JMultiKey.hh.

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

operator<<

template<class JKey_t >

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

friend

Write key to output.

Parameters

out	output stream
key	key

Returns

output stream

Definition at line 399 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;
 
      return out;
    }

Member Data Documentation

first

template<class JKey_t >

key_type JTOOLS::JMultiKey< 1, JKey_t >::first

Definition at line 409 of file JMultiKey.hh.

---

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

• JMultiKey.hh