JTOOLS::JHashCollection< JElement_t, JEvaluator_t > Class Template Reference

General purpose class for hash collection of unique elements. More...

#include <JHashCollection.hh>

Inheritance diagram for JTOOLS::JHashCollection< JElement_t, JEvaluator_t >:

Classes
struct	router_type
	Internal router. More...

Public Types
typedef JElement_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

Public Member Functions
	JHashCollection (const JEvaluator_t &evaluator=JEvaluator_t())
	Constructor. More...
template<class JAllocator_t >
	JHashCollection (const array_type< JElement_t, JAllocator_t > &buffer, const JEvaluator_t &evaluator=JEvaluator_t())
	Constructor. More...
JHashCollection &	operator= (const JHashCollection &collection)
	Assignment operator. More...
void	clear ()
	Clear. More...
void	swap (JHashCollection &collection)
	Swap hash collection. More...
template<class T >
const_iterator	find (const T &value) const
	Find element with given value. More...
template<class T >
iterator	find (const T &value)
	Find element with given value. More...
template<class T >
value_type &	get (const T &value)
	Get element with given value. More...
template<class T >
const value_type &	get (const T &value) const
	Get element with given value. More...
virtual bool	insert (const value_type &element)
	Insert element. More...
template<class T >
void	insert (T __begin, T __end)
	Insert values. More...
void	erase (iterator pos)
	Erase element at given position. More...
void	erase (iterator __begin, iterator __end)
	Erase elements in given range. More...
template<class T >
bool	erase (const T &value)
	Erase element with given value. More...
template<class T >
bool	has (const T &value) const
	Test whether given value is present. More...
template<class T >
int	getIndex (const T &value) const
	Get index of given value. More...

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

Protected Attributes
JTOOLS::JHashCollection::router_type	router

Private Member Functions
void	operator[] (int)
void	assign ()
void	resize ()
void	push_back ()
void	pop_back ()

Detailed Description

template<class JElement_t, class JEvaluator_t = JHashEvaluator>
class JTOOLS::JHashCollection< JElement_t, JEvaluator_t >

General purpose class for hash collection of unique elements.

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

Definition at line 36 of file JHashCollection.hh.

Member Typedef Documentation

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef JElement_t JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::value_type

Definition at line 41 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef JEvaluator_t JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::evaluator_type

Definition at line 42 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef std::vector<value_type> JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::container_type

Definition at line 44 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::const_iterator

Definition at line 46 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_reverse_iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::const_reverse_iterator

Definition at line 47 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::iterator

Definition at line 48 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::reverse_iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::reverse_iterator

Definition at line 49 of file JHashCollection.hh.

Constructor & Destructor Documentation

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::JHashCollection ( const JEvaluator_t &  evaluator = JEvaluator_t() )

inline

Constructor.

Parameters

evaluator

evaluator

Definition at line 57 of file JHashCollection.hh.

                                                                    :
      getValue(evaluator)
    {}

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class JAllocator_t >

JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::JHashCollection ( const array_type< JElement_t, JAllocator_t > &  buffer, const JEvaluator_t &  evaluator = JEvaluator_t()  )

inline

Constructor.

Parameters

buffer	input data
evaluator	evaluator

Definition at line 69 of file JHashCollection.hh.

                                                                    :
      getValue(evaluator)
    {
      for (typename array_type<JElement_t, JAllocator_t>::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
        insert(*i);
      }
    }

Member Function Documentation

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

JHashCollection& JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::operator= ( const JHashCollection< JElement_t, JEvaluator_t > &  collection )

inline

Assignment operator.

Parameters

collection

hash collection

Returns

this hash collection

Definition at line 85 of file JHashCollection.hh.

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

      container_type::assign(collection.begin(), collection.end());

      router.align(collection.router);

      getValue = collection.getValue;

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

      return *this;
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::clear ( )

inline

Clear.

Definition at line 108 of file JHashCollection.hh.

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

      container_type::clear();
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::swap ( JHashCollection< JElement_t, JEvaluator_t > &  collection )

inline

Swap hash collection.

Parameters

collection

hash collection

Definition at line 123 of file JHashCollection.hh.

    {
      router.swap(collection.router);

      container_type::swap(collection);
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

const_iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::find ( const T &  value ) const

inline

Find element with given value.

Parameters

value

value

Returns

position of element with given value or end()

Definition at line 138 of file JHashCollection.hh.

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

      if (router.has(ival))
        return this->begin() + router.get(ival);
      else
        return this->end();
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::find ( const T &  value )

inline

Find element with given value.

Parameters

value

value

Returns

position of element with given value or end()

Definition at line 156 of file JHashCollection.hh.

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

      if (router.has(ival))
        return this->begin() + router.get(ival);
      else
        return this->end();
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

value_type& JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::get ( const T &  value )

inline

Get element with given value.

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

Parameters

value

value

Returns

element

Definition at line 176 of file JHashCollection.hh.

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

      if (!router.has(ival)) {
        this->insert(value);
      }

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

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

const value_type& JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::get ( const T &  value ) const

inline

Get element with given value.

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

Parameters

value

value

Returns

element

Definition at line 197 of file JHashCollection.hh.

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

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

      THROW(JIndexOutOfRange, "JHashCollection::get(): invalid value.");
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

virtual bool JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::insert ( const value_type &  element )

inlinevirtual

Insert element.

Parameters

element

element

Returns

true if inserted; else false

Reimplemented in JTOOLS::JHashSet< JElement_t, JEvaluator_t >.

Definition at line 215 of file JHashCollection.hh.

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

      if (!router.has(ival)) {
        
        container_type::push_back(element);

        router.put(ival, this->size() - 1);

        return true;
      }

      return false;
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::insert ( T  __begin, T  __end  )

inline

Insert values.

Parameters

__begin	begin of values
__end	end of values

Definition at line 239 of file JHashCollection.hh.

    {
      for (T i = __begin; i != __end; ++i) {
        insert(*i);
      }
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::erase ( iterator  pos )

inline

Erase element at given position.

Parameters

pos	valid position

Definition at line 252 of file JHashCollection.hh.

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

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

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_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 268 of file JHashCollection.hh.

    {
      for (iterator i = __begin; i != __end; ++i) {
        router.put(this->getValue(*i), router.getDefaultAddress());
      }

      for (iterator i = container_type::erase(__begin, __end); i != this->end(); ++i) {
        router.put(this->getValue(*i), distance(this->begin(), i));
      }
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

bool JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::erase ( const T &  value )

inline

Erase element with given value.

Parameters

value

value

Returns

true if element has been erased; else false

Definition at line 287 of file JHashCollection.hh.

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

      if (router.has(ival)) {

        this->erase(this->begin() + router.get(ival)); 

        return true;
      }

      return false;
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

bool JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::has ( const T &  value ) const

inline

Test whether given value is present.

Parameters

value

value

Returns

true if present; else false

Definition at line 309 of file JHashCollection.hh.

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

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

template<class T >

int JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::getIndex ( const T &  value ) const

inline

Get index of given value.

Parameters

value

value

Returns

indecx

Definition at line 322 of file JHashCollection.hh.

    {
      return router.get(this->getValue(value));
    }

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::operator[] ( int  )

private

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::assign ( )

private

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::resize ( )

private

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::push_back ( )

private

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::pop_back ( )

private

Member Data Documentation

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

JEvaluator_t JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::getValue

Function object for evaluation of element.

Definition at line 331 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>

JTOOLS::JHashCollection::router_type JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::router

protected

---

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

• JHashCollection.hh