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, JKey_t >	mapped_type

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

Public Attributes
key_type	first

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

Detailed Description

template<class JKey_t>
class JTOOLS::JMultiKey< 1, JKey_t >

One-dimensional key.

Definition at line 374 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 379 of file JMultiKey.hh.

mapped_type

template<class JKey_t >

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

Definition at line 380 of file JMultiKey.hh.

Constructor & Destructor Documentation

JMultiKey() [1/5]

template<class JKey_t >

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

inline

Default constructor.

Definition at line 386 of file JMultiKey.hh.

                :
      first()
    {}

JMultiKey() [2/5]

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

Constructor.

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

Parameters

__first	primary key
__second	secondary key

Definition at line 398 of file JMultiKey.hh.

                                                                  :
      first(__second)
    {}

JMultiKey() [3/5]

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

Constructor.

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

Parameters

__first	primary key
__second	secondary key

Definition at line 411 of file JMultiKey.hh.

                                                                  :
      first(__first)
    {}

JMultiKey() [4/5]

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

                                                              :
      first(__first)
    {}

JMultiKey() [5/5]

template<class JKey_t >

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

inline

Copy constructor.

Parameters

key

key

Definition at line 432 of file JMultiKey.hh.

                                                              :
      first(key.first)
    {}

Member Function Documentation

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

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

getLengthSquared()

template<class JKey_t >

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

inline

Get length squared.

Returns

square of length

Definition at line 454 of file JMultiKey.hh.

    {
      return this->first*this->first;
    }

getLength()

template<class JKey_t >

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

inline

Get length.

Returns

length

Definition at line 465 of file JMultiKey.hh.

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

back()

template<class JKey_t >

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

inline

Get backend key.

Returns

backend key

Definition at line 476 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 489 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 504 of file JMultiKey.hh.

    {
      const JFormat format(out, getFormat< JMultiKey<1, JKey_t> >(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 514 of file JMultiKey.hh.

---

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

• JMultiKey.hh