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. 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 JClass< key_type >::argument_type __first)
	Constructor. More...
	JMultiKey (typename JArgument< 1, JKey_t >::argument_type key)
	Copy constructor. More...
bool	less (const JMultiKey< 1, JKey_t > &key) const
	Less than method. More...
double	getLengthSquared () const
	Get length squared. More...
double	getLength () const
	Get length. More...
key_type	back () const
	Get backend key. More...

Public Attributes
key_type	first

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

Detailed Description

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

One-dimensional key.

Definition at line 365 of file JMultiKey.hh.

Member Typedef Documentation

template<class JKey_t >

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

Definition at line 370 of file JMultiKey.hh.

template<class JKey_t >

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

Definition at line 371 of file JMultiKey.hh.

Constructor & Destructor Documentation

template<class JKey_t >

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

inline

Default constructor.

Definition at line 377 of file JMultiKey.hh.

                :
      first()
    {}

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

                                                                  :
      first(__second)
    {}

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

                                                                  :
      first(__first)
    {}

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

                                                              :
      first(__first)
    {}

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

                                                              :
      first(key.first)
    {}

Member Function Documentation

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

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

template<class JKey_t >

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

inline

Get length squared.

Returns

square of length

Definition at line 445 of file JMultiKey.hh.

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

template<class JKey_t >

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

inline

Get length.

Returns

length

Definition at line 456 of file JMultiKey.hh.

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

template<class JKey_t >

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

inline

Get backend key.

Returns

backend key

Definition at line 467 of file JMultiKey.hh.

    {
      return this->first;
    }

Friends And Related Function Documentation

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

    {
      in >> key.first;

      return in;
    }

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

    {
      out << key.first;

      return out;
    }

Member Data Documentation

template<class JKey_t >

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

Definition at line 503 of file JMultiKey.hh.

---

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

• JMultiKey.hh