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.

template<class JAllocator_t >
	JHashCollection (const array_type< JElement_t, JAllocator_t > &buffer, const JEvaluator_t &evaluator=JEvaluator_t())
	Constructor.

JHashCollection &	operator= (const JHashCollection &collection)
	Assignment operator.

void	clear ()
	Clear.

void	swap (JHashCollection &collection)
	Swap hash collection.

template<class T >
const_iterator	find (const T &value) const
	Find element with given value.

template<class T >
iterator	find (const T &value)
	Find element with given value.

template<class T >
value_type &	get (const T &value)
	Get element with given value.

template<class T >
const value_type &	get (const T &value) const
	Get element with given value.

virtual bool	insert (const value_type &element)
	Insert element.

template<class T >
void	insert (T __begin, T __end)
	Insert values.

void	erase (iterator pos)
	Erase element at given position.

void	erase (iterator __begin, iterator __end)
	Erase elements in given range.

template<class T >
bool	erase (const T &value)
	Erase element with given value.

template<class T >
bool	has (const T &value) const
	Test whether given value is present.

template<class T >
int	getIndex (const T &value) const
	Get index of given value.

Public Attributes
JEvaluator_t	getValue
	Function object for evaluation of element.

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

◆ value_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 41 of file JHashCollection.hh.

◆ evaluator_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 42 of file JHashCollection.hh.

◆ container_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 44 of file JHashCollection.hh.

◆ const_iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 46 of file JHashCollection.hh.

◆ const_reverse_iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 47 of file JHashCollection.hh.

◆ iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 48 of file JHashCollection.hh.

◆ reverse_iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 49 of file JHashCollection.hh.

Constructor & Destructor Documentation

◆ JHashCollection() [1/2]

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)
    {}

◆ JHashCollection() [2/2]

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

◆ operator=()

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;
    }

◆ clear()

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();
    }

◆ swap()

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);
    }

◆ find() [1/2]

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();
    }

◆ find() [2/2]

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();
    }

◆ get() [1/2]

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;
    }

◆ get() [2/2]

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.");
    }

◆ insert() [1/2]

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;
    }

◆ insert() [2/2]

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);
      }
    }

◆ erase() [1/3]

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));
      }
    }

◆ erase() [2/3]

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));
      }
    }

◆ erase() [3/3]

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;
    }

◆ has()

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));
    }

◆ getIndex()

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));
    }

◆ operator[]()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

private

◆ assign()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

private

◆ resize()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

private

◆ push_back()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

private

◆ pop_back()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

private

Member Data Documentation

◆ getValue

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.

◆ router

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ value_type

◆ evaluator_type

◆ container_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ JHashCollection() [1/2]

◆ JHashCollection() [2/2]

Member Function Documentation

◆ operator=()

◆ clear()

◆ swap()

◆ find() [1/2]

◆ find() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ insert() [1/2]

◆ insert() [2/2]

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ has()

◆ getIndex()

◆ operator[]()

◆ assign()

◆ resize()

◆ push_back()

◆ pop_back()

Member Data Documentation

◆ getValue

◆ router