General purpose class for hash set of elements. More...

#include <JHashSet.hh>

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

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

Public Types
typedef JElement_t	value_type

typedef JEvaluator_t	evaluator_type

typedef JHashCollection< value_type, evaluator_type >	collection_type

typedef collection_type::container_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
	JHashSet (const JEvaluator_t &evaluator=JEvaluator_t())
	Constructor. More...

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

const JComparator &	getComparator () const
	Get comparator. More...

void	clear ()
	Clear. More...

void	swap (JHashCollection &collection)
	Swap hash collection. More...

const_iterator	find (const T &value) const
	Find element with given value. More...

iterator	find (const T &value)
	Find element with given value. More...

value_type &	get (const T &value)
	Get element with given value. More...

const value_type &	get (const T &value) const
	Get element with given value. More...

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...

bool	erase (const T &value)
	Erase element with given value. More...

bool	has (const T &value) const
	Test whether given value is present. More...

int	getIndex (const T &value) const
	Get index of given value. More...

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

Protected Attributes
JComparator	compare
	Function object for comparison. More...

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::JHashSet< JElement_t, JEvaluator_t >

General purpose class for hash set of elements.

The elements in a hash set are sorted 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 30 of file JHashSet.hh.

Member Typedef Documentation

◆ value_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 35 of file JHashSet.hh.

◆ evaluator_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 36 of file JHashSet.hh.

◆ collection_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

typedef JHashCollection<value_type, evaluator_type> JTOOLS::JHashSet< JElement_t, JEvaluator_t >::collection_type

Definition at line 38 of file JHashSet.hh.

◆ container_type

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

typedef collection_type::container_type JTOOLS::JHashSet< JElement_t, JEvaluator_t >::container_type

Definition at line 39 of file JHashSet.hh.

◆ const_iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 41 of file JHashSet.hh.

◆ const_reverse_iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 42 of file JHashSet.hh.

◆ iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 43 of file JHashSet.hh.

◆ reverse_iterator

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

Definition at line 44 of file JHashSet.hh.

Constructor & Destructor Documentation

◆ JHashSet()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

inline

Constructor.

Parameters

evaluator evaluator

Definition at line 87 of file JHashSet.hh.

                                                              :
       JHashCollection<JElement_t, JEvaluator_t>(evaluator),
       compare(evaluator)
     {}

Member Function Documentation

◆ insert() [1/2]

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

inlineoverridevirtual

Insert element.

Parameters

element element

Returns: true if inserted; else false

Reimplemented from JTOOLS::JHashCollection< JElement_t, JHashEvaluator >.

Definition at line 99 of file JHashSet.hh.

     {
       const int ival = this->getValue(element);
       
       if (!this->router.has(ival)) {
         
         iterator p = container_type::insert(lower_bound(this->begin(), this->end(), element, compare), element);
  
         this->router.put(ival, std::distance(this->begin(), p));
  
         for (iterator i = p; ++i != this->end(); ) {
           this->router.put(this->getValue(*i), std::distance(this->begin(), i));
         }
         
         return true;
       }
  
       return false;
     }

◆ getComparator()

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

const JComparator& JTOOLS::JHashSet< JElement_t, JEvaluator_t >::getComparator ( ) const

inline

Get comparator.

Returns: comparator

Definition at line 125 of file JHashSet.hh.

     {
       return compare;
     }

◆ clear()

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

inlineinherited

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

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

inlineinherited

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]

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

inlineinherited

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]

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

inlineinherited

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]

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

inlineinherited

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]

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

inlineinherited

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() [2/2]

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

inlineinherited

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]

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

inlineinherited

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]

void JTOOLS::JHashCollection< JElement_t, JHashEvaluator >::erase	(	iterator	__begin,
		iterator	__end
	)

inlineinherited

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]

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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[]()

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

privateinherited

◆ assign()

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

privateinherited

◆ resize()

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

privateinherited

◆ push_back()

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

privateinherited

◆ pop_back()

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

privateinherited

Member Data Documentation

◆ compare

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

JComparator JTOOLS::JHashSet< JElement_t, JEvaluator_t >::compare

protected

Function object for comparison.

Definition at line 135 of file JHashSet.hh.

◆ getValue

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

inherited

Function object for evaluation of element.

Definition at line 331 of file JHashCollection.hh.

◆ router

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

protectedinherited

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

JHashSet.hh

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ value_type

◆ evaluator_type

◆ collection_type

◆ container_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ JHashSet()

Member Function Documentation

◆ insert() [1/2]

◆ getComparator()

◆ clear()

◆ swap()

◆ find() [1/2]

◆ find() [2/2]

◆ get() [1/2]

◆ get() [2/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

◆ compare

◆ getValue

◆ router

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