Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
JTOOLS::JHashSet< JElement_t, JEvaluator_t > Class Template Reference

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

#include <JHashSet.hh>

Inheritance diagram for JTOOLS::JHashSet< JElement_t, JEvaluator_t >:
JTOOLS::JHashCollection< JElement_t, JEvaluator_t > std::vector< JElement_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)
 Insert element. More...
 
const JComparator & getComparator () const
 Get comparator. More...
 
void clear ()
 Clear. 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...
 
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

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

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

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.

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.

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.

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.

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.

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.

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.

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

template<class JElement_t , class JEvaluator_t = JHashEvaluator>
JTOOLS::JHashSet< JElement_t, JEvaluator_t >::JHashSet ( const JEvaluator_t &  evaluator = JEvaluator_t())
inline

Constructor.

Parameters
evaluatorevaluator

Definition at line 87 of file JHashSet.hh.

87  :
88  JHashCollection<JElement_t, JEvaluator_t>(evaluator),
89  compare(evaluator)
90  {}
JTOOLS::JHashSet::compare
JComparator compare
Function object for comparison.
Definition: JHashSet.hh:135
JTOOLS::JHashCollection
General purpose class for hash collection of unique elements.
Definition: JHashCollection.hh:33

Member Function Documentation

template<class JElement_t , class JEvaluator_t = JHashEvaluator>
virtual bool JTOOLS::JHashSet< JElement_t, JEvaluator_t >::insert ( const value_type &  element)
inlinevirtual

Insert element.

Parameters
elementelement
Returns
true if inserted; else false

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

Definition at line 99 of file JHashSet.hh.

100  {
101  const int ival = this->getValue(element);
102 
103  if (!this->router.has(ival)) {
104 
105  iterator p = container_type::insert(lower_bound(this->begin(), this->end(), element, compare), element);
106 
107  this->router.put(ival, std::distance(this->begin(), p));
108 
109  for (iterator i = p; ++i != this->end(); ) {
110  this->router.put(this->getValue(*i), std::distance(this->begin(), i));
111  }
112 
113  return true;
114  }
115 
116  return false;
117  }
distance
std::vector< T >::difference_type distance(typename std::vector< T >::const_iterator first, typename PhysicsEvent::const_iterator< T > second)
Specialisation of STL distance.
Definition: PhysicsEvent.hh:434
JTOOLS::JHashSet::iterator
container_type::iterator iterator
Definition: JHashSet.hh:43
JTOOLS::JHashSet::compare
JComparator compare
Function object for comparison.
Definition: JHashSet.hh:135
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
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.

126  {
127  return compare;
128  }
JTOOLS::JHashSet::compare
JComparator compare
Function object for comparison.
Definition: JHashSet.hh:135
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::clear ( )
inlineinherited

Clear.

Definition at line 87 of file JHashCollection.hh.

88  {
89  router.clear();
90 
91  container_type::clear();
92  }
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
template<class T >
const_iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::find ( const T &  value) const
inlineinherited

Find element with given value.

Parameters
valuevalue
Returns
position of element with given value or end()

Definition at line 102 of file JHashCollection.hh.

103  {
104  const int ival = this->getValue(value);
105 
106  if (router.has(ival))
107  return this->begin() + router.get(ival);
108  else
109  return this->end();
110  }
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
template<class T >
iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::find ( const T &  value)
inlineinherited

Find element with given value.

Parameters
valuevalue
Returns
position of element with given value or end()

Definition at line 120 of file JHashCollection.hh.

121  {
122  const int ival = this->getValue(value);
123 
124  if (router.has(ival))
125  return this->begin() + router.get(ival);
126  else
127  return this->end();
128  }
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
template<class T >
value_type& JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::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
valuevalue
Returns
element

Definition at line 140 of file JHashCollection.hh.

141  {
142  const int ival = this->getValue(value);
143 
144  if (!router.has(ival)) {
145  this->insert(value);
146  }
147 
148  return container_type::operator[](router.get(ival)).second;
149  }
JTOOLS::JHashCollection::insert
virtual bool insert(const value_type &element)
Insert element.
Definition: JHashCollection.hh:179
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
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
inlineinherited

Get element with given value.

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

Parameters
valuevalue
Returns
element

Definition at line 161 of file JHashCollection.hh.

162  {
163  const int ival = this->getValue(value);
164 
165  if (router.has(ival)) {
166  return container_type::operator[](router.get(ival)).second;
167  }
168 
169  THROW(JIndexOutOfRange, "JHasCollection::get(): invalid value.");
170  }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::erase ( iterator  pos)
inlineinherited

Erase element at given position.

Parameters
posvalid position

Definition at line 201 of file JHashCollection.hh.

202  {
203  router.put(this->getValue(*pos), router.getDefaultAddress());
204 
205  for (iterator i = container_type::erase(pos); i != this->end(); ++i) {
206  router.put(this->getValue(*i), distance(this->begin(), i));
207  }
208  }
distance
std::vector< T >::difference_type distance(typename std::vector< T >::const_iterator first, typename PhysicsEvent::const_iterator< T > second)
Specialisation of STL distance.
Definition: PhysicsEvent.hh:434
JTOOLS::JHashCollection::iterator
container_type::iterator iterator
Definition: JHashCollection.hh:45
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
void JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::erase ( iterator  __begin,
iterator  __end 
)
inlineinherited

Erase elements in given range.

Parameters
__beginbegin position (included)
__endend position (excluded)

Definition at line 217 of file JHashCollection.hh.

218  {
219  for (iterator i = __begin; i != __end; ++i) {
220  router.put(this->getValue(*i), router.getDefaultAddress());
221  }
222 
223  for (iterator i = container_type::erase(__begin, __end); i != this->end(); ++i) {
224  router.put(this->getValue(*i), distance(this->begin(), i));
225  }
226  }
distance
std::vector< T >::difference_type distance(typename std::vector< T >::const_iterator first, typename PhysicsEvent::const_iterator< T > second)
Specialisation of STL distance.
Definition: PhysicsEvent.hh:434
JTOOLS::JHashCollection::iterator
container_type::iterator iterator
Definition: JHashCollection.hh:45
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
template<class T >
bool JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::erase ( const T &  value)
inlineinherited

Erase element with given value.

Parameters
valuevalue
Returns
true if element has been erased; else false

Definition at line 236 of file JHashCollection.hh.

237  {
238  const int ival = this->getValue(value);
239 
240  if (router.has(ival)) {
241 
242  this->erase(this->begin() + router.get(ival));
243 
244  return true;
245  }
246 
247  return false;
248  }
JTOOLS::JHashCollection::erase
void erase(iterator pos)
Erase element at given position.
Definition: JHashCollection.hh:201
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
template<class T >
bool JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::has ( const T &  value) const
inlineinherited

Test whether given value is present.

Parameters
valuevalue
Returns
true if present; else false

Definition at line 258 of file JHashCollection.hh.

259  {
260  return router.has(this->getValue(value));
261  }
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280
template<class JElement_t, class JEvaluator_t = JHashEvaluator>
template<class T >
int JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::getIndex ( const T &  value) const
inlineinherited

Get index of given value.

Parameters
valuevalue
Returns
indecx

Definition at line 271 of file JHashCollection.hh.

272  {
273  return router.get(this->getValue(value));
274  }
JTOOLS::JHashCollection::getValue
JEvaluator_t getValue
Function object for evaluation of element.
Definition: JHashCollection.hh:280

Member Data Documentation

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.

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

Function object for evaluation of element.

Definition at line 280 of file JHashCollection.hh.

template<class JElement_t, class JEvaluator_t = JHashEvaluator>
JRouter<int> JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::router
protectedinherited

Definition at line 284 of file JHashCollection.hh.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5