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

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
typedef std::pair < const_iterator, bool >	pair_type

Public Member Functions
	JHashCollection (const JEvaluator_t &evaluator=JEvaluator_t())
	Constructor. More...
virtual 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...
virtual pair_type	insert (typename JClass< value_type >::argument_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...
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...

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

Protected Member Functions
iterator	insert (iterator pos, typename JClass< value_type >::argument_type element)
	Insert element. More...

Protected Attributes
JRouter< int >	router

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

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

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.

For the binary I/O of a collection of elements, the data structure of the elements should provide for an implementation of the following operators:

      JReader& operator>>(JReader& in);
      JWriter& operator<<(JWriter& out);

Definition at line 46 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 51 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 52 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 54 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 56 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 57 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 58 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 59 of file JHashCollection.hh.

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

typedef std::pair<const_iterator, bool> JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::pair_type

Definition at line 61 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 69 of file JHashCollection.hh.

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

Member Function Documentation

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

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

inlinevirtual

Clear.

Definition at line 78 of file JHashCollection.hh.

    {
      // reset internal router
      
      for (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>

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 97 of file JHashCollection.hh.

    {
      const int ival = this->getValue(value);
      
      if (router.has(ival)) {
        
        const_iterator i = this->begin();

        std::advance(i, router.get(ival));

        return i;
      }

      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 121 of file JHashCollection.hh.

    {
      const int ival = this->getValue(value);
      
      if (router.has(ival)) {
        
        iterator i = this->begin();

        std::advance(i, router.get(ival));

        return i;
      }

      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 147 of file JHashCollection.hh.

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

      if (!this->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 168 of file JHashCollection.hh.

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

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

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

virtual pair_type JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::insert ( typename JClass< value_type >::argument_type  element )

inlinevirtual

Insert element.

Parameters

element

element

Returns

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

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

Definition at line 185 of file JHashCollection.hh.

    {
      using namespace std;

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

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

        iterator i = this->rbegin().base();

        router.put(ival, distance(this->begin(), i));

        return pair_type(i, true);

      } else {

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

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 213 of file JHashCollection.hh.

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

      iterator i = container_type::erase(pos);

      for ( ; i != this->end(); ++i) {
        this->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 231 of file JHashCollection.hh.

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

      iterator i = container_type::erase(__begin, __end);

      for ( ; i != this->end(); ++i) {
        this->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 252 of file JHashCollection.hh.

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

      if (this->router.has(ival)) {
        
        iterator pos = this->begin();

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

        this->erase(pos);

        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 278 of file JHashCollection.hh.

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

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

iterator JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::insert ( iterator  pos, typename JClass< value_type >::argument_type  element  )

inlineprotected

Insert element.

Parameters

pos	position
element	element

Returns

position

Definition at line 340 of file JHashCollection.hh.

    {
      return container_type::insert(pos, element);
    }

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

Friends And Related Function Documentation

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

JReader& operator>> ( JReader &  in, JHashCollection< JElement_t, JEvaluator_t > &  object  )

friend

Read hash collection from input.

Parameters

in	reader
object	hash collection

Returns

reader

Definition at line 291 of file JHashCollection.hh.

    {
      int n;

      in >> n;

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

      return in;
    }

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

JWriter& operator<< ( JWriter &  out, const JHashCollection< JElement_t, JEvaluator_t > &  object  )

friend

Write hash collection to output.

Parameters

out	writer
object	hash collection

Returns

writer

Definition at line 312 of file JHashCollection.hh.

    {
      int n = object.size();

      out << n;

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

      return out;
    }

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 329 of file JHashCollection.hh.

template<class JElement_t , class JEvaluator_t = JHashEvaluator>

JRouter<int> JTOOLS::JHashCollection< JElement_t, JEvaluator_t >::router

protected

Definition at line 345 of file JHashCollection.hh.

---

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

• JHashCollection.hh