JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t > Struct Template Reference

General purpose class for hash map of (key, value) pairs. More...

#include <JHashMap.hh>

Inheritance diagram for JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >:

Classes
struct	JComparator
	Auxiliary class for ordering of objects in the collection by the hash value of their keys. More...

Public Types
typedef JKey_t	key_type
typedef JValue_t	mapped_type
typedef std::pair< JKey_t, JValue_t >	value_type
typedef JEvaluator_t	evaluator_type
typedef std::vector< value_type >	container_type
typedef container_type::const_iterator	const_iterator
typedef container_type::const_reverse_iterator	const_reverse_iterator
typedef container_type::iterator	iterator
typedef container_type::reverse_iterator	reverse_iterator
typedef std::pair < const_iterator, bool >	pair_type

Public Member Functions
	JHashMap (const JEvaluator_t &evaluator=JEvaluator_t())
	Constructor. More...
virtual void	clear ()
	Clear. More...
virtual mapped_type &	get (typename JClass< key_type >::argument_type key)
	Get mapped value. More...
const mapped_type &	get (typename JClass< key_type >::argument_type key) const
	Get mapped value. More...
pair_type	insert (const value_type &element)
	Insert element. More...
void	erase (iterator pos)
	Erase element at given position. More...
void	erase (iterator __begin, iterator __end)
	Erase elements in given range. More...
bool	erase (typename JClass< key_type >::argument_type key) const
	Erase element. More...
bool	has (typename JClass< key_type >::argument_type key) const
	Test whether key is present. More...
const JComparator &	getComparator () const
	Get comparator. More...
mapped_type &	operator[] (typename JClass< key_type >::argument_type key)
	Get mapped value. More...
void	put (typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
	Put pair-wise element (key,value) into collection. More...

Public Attributes
JEvaluator_t	getValue
	Function object for evaluation of key. More...

Protected Attributes
JComparator	compare
	Function object for comparison. More...
JRouter< int >	router

Private Member Functions
void	resize ()
void	push_back ()
void	pop_back ()

Friends
JReader &	operator>> (JReader &in, JHashMap &object)
	Read hash map from input. More...
JWriter &	operator<< (JWriter &out, const JHashMap &object)
	Write hash map to output. More...

Detailed Description

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>
struct JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >

General purpose class for hash map of (key, value) pairs.

The elements in a hash map are sorted according to the specified evaluation. The evaluation of elements corresponds to a unary method returning an integer value for a given key; The default evaluator is JHashEvaluator.

This class implements the JMappableCollection interface.

Definition at line 53 of file JHashMap.hh.

Member Typedef Documentation

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JKey_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::key_type

Definition at line 59 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JValue_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::mapped_type

Definition at line 60 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef std::pair<JKey_t, JValue_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::value_type

Definition at line 61 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JEvaluator_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::evaluator_type

Definition at line 62 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef std::vector<value_type> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::container_type

Definition at line 64 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_iterator

Definition at line 66 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_reverse_iterator

Definition at line 67 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::iterator

Definition at line 68 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::reverse_iterator

Definition at line 69 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef std::pair<const_iterator, bool> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::pair_type

Definition at line 71 of file JHashMap.hh.

Constructor & Destructor Documentation

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::JHashMap ( const JEvaluator_t &  evaluator = JEvaluator_t() )

inline

Constructor.

Parameters

evaluator

evaluator

Definition at line 131 of file JHashMap.hh.

                                                             :
      getValue(evaluator),
      compare (evaluator),
      router  (-1)             // default address
    {}

Member Function Documentation

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::clear ( )

inlinevirtual

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 141 of file JHashMap.hh.

    {
      // reset internal router
      
      for (iterator i = this->begin(); i != this->end(); ++i) {
        router.put(this->getValue(i->first), router.getDefaultAddress());
      }
      
      container_type::clear();
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type  key )

inlinevirtual

Get mapped value.

Parameters

key

key

Returns

mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 159 of file JHashMap.hh.

    {
      const int ival = this->getValue(key);
      
      if (!router.has(ival)) {
        insert(value_type(key, mapped_type()));
      }

      return container_type::operator[](router.get(ival)).second;
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

const mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type  key ) const

inline

Get mapped value.

This method will throw an exception if given key is not present following the prerequisite of constness.

Parameters

key

key

Returns

mapped value

Definition at line 179 of file JHashMap.hh.

    {
      const int ival = this->getValue(key);

      if (router.has(ival))
        return container_type::operator[](router.get(ival)).second;
      else
        THROW(JIndexOutOfRange, "JHasMap::get(): invalid key.");
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

pair_type JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::insert ( const value_type &  element )

inline

Insert element.

Parameters

element

element

Returns

(position, status), where status is true if inserted; else false

Definition at line 196 of file JHashMap.hh.

    {
      using namespace std;

      const int ival = this->getValue(element.first);

      if (!router.has(ival)) {
        
        iterator i = container_type::insert(lower_bound(this->begin(), this->end(), element.first, compare), element);
        
        router.put(ival, distance(this->begin(), i));
        
        for (iterator __i = i; ++__i != this->end(); ) {
          router.put(this->getValue(__i->first), distance(this->begin(), __i));
        }
        
        return pair_type(i, true);
        
      } else {

        return pair_type(this->end(), false);
      }
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::erase ( iterator  pos )

inline

Erase element at given position.

Parameters

pos	valid position

Definition at line 226 of file JHashMap.hh.

    {
      this->router.put(this->getValue(*pos), this->router.getDefaultAddress());

      iterator i = pos;

      container_type::erase(i++);

      for ( ; i != this->end(); ++i) {
        this->router.put(this->getValue(*i), distance(this->begin(), i));
      }
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::erase ( iterator  __begin, iterator  __end  )

inline

Erase elements in given range.

Parameters

__begin	begin position (included)
__end	end position (excluded)

Definition at line 246 of file JHashMap.hh.

    {
      iterator i = __begin;

      while (i != __end) {

        this->router.put(this->getValue(*i), this->router.getDefaultAddress());

        container_type::erase(i++);
      }

      for ( ; i != this->end(); ++i) {
        this->router.put(this->getValue(*i), distance(this->begin(), i));
      }
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

bool JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::erase ( typename JClass< key_type >::argument_type  key ) const

inline

Erase element.

Parameters

key

key

Returns

true if element with given key has been erased; else false

Definition at line 269 of file JHashMap.hh.

    {
      const int ival = this->getValue(key);

      if (router.has(ival)) {

        iterator pos = this->begin();

        std::advance(pos, this->router.get(ival));

        iterator i = container_type::erase(pos);

        for ( ; i != this->end(); ++i) {
          this->router.put(this->getValue(*i), distance(this->begin(), i));
        }

        return true;
      }

      return false;
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

bool JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::has ( typename JClass< key_type >::argument_type  key ) const

inline

Test whether key is present.

Parameters

key

key

Returns

true if present; else false

Definition at line 298 of file JHashMap.hh.

    {
      return router.has(this->getValue(key));
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

const JComparator& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::getComparator ( ) const

inline

Get comparator.

Returns

comparator

Definition at line 309 of file JHashMap.hh.

    {
      return compare;
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::resize ( )

private

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::push_back ( )

private

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::pop_back ( )

private

template<class JKey_t, class JValue_t>

mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type  key )

inlineinherited

Get mapped value.

Parameters

key

key

Returns

value

Definition at line 64 of file JMappableCollection.hh.

    {
      return get(key);
    }

template<class JKey_t, class JValue_t>

void JTOOLS::JMappableCollection< JKey_t, JValue_t >::put ( typename JClass< key_type >::argument_type  key, typename JClass< mapped_type >::argument_type  value  )

inlineinherited

Put pair-wise element (key,value) into collection.

Parameters

key	key
value	value

Definition at line 76 of file JMappableCollection.hh.

    {
      get(key) = value;
    }

Friends And Related Function Documentation

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

JReader& operator>> ( JReader &  in, JHashMap< JKey_t, JValue_t, JEvaluator_t > &  object  )

friend

Read hash map from input.

Parameters

in	reader
object	hash map

Returns

reader

Definition at line 322 of file JHashMap.hh.

    {
      using namespace JIO;
      
      int n;

      in >> n;

      object.resize(n);

      for (value_type element; n != 0 && in >> element; --n) {
        object.insert(element);
      }

      return in;
    }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

JWriter& operator<< ( JWriter &  out, const JHashMap< JKey_t, JValue_t, JEvaluator_t > &  object  )

friend

Write hash map to output.

Parameters

out	writer
object	hash map

Returns

writer

Definition at line 347 of file JHashMap.hh.

    {
      using namespace JIO;

      int n = object.size();

      out << n;

      for (typename JHashMap::const_iterator i = object.begin(); i != object.end(); ++i) {
        out << *i;
      }

      return out;
    }

Member Data Documentation

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

JEvaluator_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::getValue

Function object for evaluation of key.

Definition at line 366 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

JComparator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::compare

protected

Function object for comparison.

Definition at line 373 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

JRouter<int> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::router

protected

Definition at line 375 of file JHashMap.hh.

---

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

• JHashMap.hh