Auxiliary data structure with extended functionality of hash-map. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >:

Public Types
typedef JHashMap< key_type, value_type, evaluator_type >	hashmap_type

typedef JKey_t	key_type

typedef JValue_t	mapped_type

typedef std::pair< JKey_t, JValue_t >	value_type

typedef JHashMapEvaluator < 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
size_t	getN (const JMODEL::JOption_t option) const
	Get number of fit parameters. More...

size_t	getIndex (const key_type key, double value_type::*p, const JMODEL::JOption_t option) const
	Get index of parameter. More...

double	getParameter (const size_t index, const JMODEL::JOption_t option) const
	Get read access to fit parameter value at given index in buffer. More...

double &	getParameter (const size_t index, const JMODEL::JOption_t option)
	Get read/write access to fit parameter value at given index in buffer. More...

void	evaluate (value_type &(value_type::*f1)())
	Evaluate arithmetic operation. More...

void	evaluate (const hash_map &buffer, value_type &(value_type::*f1)(const value_type &))
	Evaluate arithmetic operation. More...

void	evaluate (value_type &(value_type::*f1)(const double), const double factor)
	Evaluate arithmetic operation. More...

bool	equals (const hash_map &buffer) const
	Check equality of hash map. More...

bool	equals (const hash_map &buffer, const double precision) const
	Check equality of has map. More...

virtual void	clear () override
	Clear. More...

void	reset ()
	Reset values. More...

void	set (const JHashMap &source, const mapped_type &value)
	Set values corresponding to keys in given source. More...

virtual mapped_type &	get (typename JClass< key_type >::argument_type key) override
	Get mapped value. More...

virtual const mapped_type &	get (typename JClass< key_type >::argument_type key) const override
	Get mapped 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	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...

virtual bool	insert (const value_type &element)
	Insert element. 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...

const mapped_type &	operator[] (typename JClass< key_type >::argument_type key) const
	Get mapped value. More...

mapped_type &	operator[] (typename JClass< key_type >::argument_type key)
	Get mapped value. More...

void	put (typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
	Put pair-wise element (key,value) into collection. More...

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

Protected Attributes
JTOOLS::JHashCollection::router_type	router

Detailed Description

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>
struct JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >

Auxiliary data structure with extended functionality of hash-map.

Definition at line 809 of file JAcoustics/JModel.hh.

Member Typedef Documentation

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

typedef JHashMap<key_type, value_type, evaluator_type> JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::hashmap_type

Definition at line 812 of file JAcoustics/JModel.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JKey_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::key_type

inherited

Definition at line 78 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JValue_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::mapped_type

inherited

Definition at line 79 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef std::pair<JKey_t, JValue_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::value_type

inherited

Definition at line 80 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JHashMapEvaluator<JEvaluator_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::evaluator_type

inherited

Definition at line 81 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JHashCollection<value_type, evaluator_type> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::collection_type

inherited

Definition at line 83 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef collection_type::container_type JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::container_type

inherited

Definition at line 84 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_iterator

inherited

Definition at line 86 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_reverse_iterator

inherited

Definition at line 87 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::iterator

inherited

Definition at line 88 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::reverse_iterator

inherited

Definition at line 89 of file JHashMap.hh.

Member Function Documentation

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

size_t JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::getN ( const JMODEL::JOption_t option ) const

inline

Get number of fit parameters.

Parameters

option option

Returns: number of parameters

Definition at line 820 of file JAcoustics/JModel.hh.

       {
         return this->size() * value_type::getN(option);
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

size_t JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::getIndex	(	const key_type	key,
		double value_type::*	p,
		const JMODEL::JOption_t	option
	)		const

inline

Get index of parameter.

Parameters

key	key
p	pointer to data member
option	option

Returns: index

Definition at line 834 of file JAcoustics/JModel.hh.

       {
         value_type* __p__ = NULL;
 
         if (this->has(key))
           return static_cast<const hashmap_type&>(*this).getIndex(key) * value_type::getN(option)  +  ((double*) &(__p__->*p) - (double*) __p__);
         else
           THROW(JValueOutOfRange, "Invalid key " << key);
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

double JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::getParameter	(	const size_t	index,
		const JMODEL::JOption_t	option
	)		const

inline

Get read access to fit parameter value at given index in buffer.

Parameters

index	index
option	option

Returns: value

Definition at line 852 of file JAcoustics/JModel.hh.

       {
         const size_t pos        = index / value_type::getN(option);  // position of element in buffer
         const size_t offset     = index % value_type::getN(option);  // offset of parameter in element
 
         const value_type& value = this->data()[pos].second;          // value of element at given position
 
         return ((const double*) &value)[offset];                     // parameter at given offset
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

double& JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::getParameter	(	const size_t	index,
		const JMODEL::JOption_t	option
	)

inline

Get read/write access to fit parameter value at given index in buffer.

Parameters

index	index
option	option

Returns: value

Definition at line 870 of file JAcoustics/JModel.hh.

       {
         const size_t pos        = index / value_type::getN(option);  // position of element in buffer
         const size_t offset     = index % value_type::getN(option);  // offset of parameter in element
 
         value_type& value       = this->data()[pos].second;          // value of element at given position
 
         return ((double*) &value)[offset];                           // parameter at given offset
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

void JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::evaluate ( value_type &(value_type::*)() f1 )

inline

Evaluate arithmetic operation.

Parameters

f1 operation

Definition at line 886 of file JAcoustics/JModel.hh.

       {
         for (typename hashmap_type::iterator i = this->begin(); i != this->end(); ++i) {
           (i->second.*f1)();
         }
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

void JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::evaluate	(	const hash_map< key_type, value_type, evaluator_type > &	buffer,
		value_type &(value_type::*)(const value_type &)	f1
	)

inline

Evaluate arithmetic operation.

Parameters

buffer	buffer
f1	operation

Definition at line 900 of file JAcoustics/JModel.hh.

       {
         for (typename hashmap_type::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
           ((*this)[i->first].*f1)(i->second);
         }
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

void JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::evaluate	(	value_type &(value_type::*)(const double)	f1,
		const double	factor
	)

inline

Evaluate arithmetic operation.

Parameters

f1	operation
factor	factor

Definition at line 914 of file JAcoustics/JModel.hh.

       {
         for (typename hashmap_type::iterator i = this->begin(); i != this->end(); ++i) {
           (i->second.*f1)(factor);
         }
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

bool JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::equals ( const hash_map< key_type, value_type, evaluator_type > & buffer ) const

inline

Check equality of hash map.

Parameters

buffer buffer

Returns: true if hash map is equal; else false

Definition at line 928 of file JAcoustics/JModel.hh.

       {
         for (typename hashmap_type::const_iterator
                p = this->begin(),
                q = buffer.begin(); ; ++p, ++q) {
 
           if        (p != this->end() && q != buffer.end()) {
 
             if (p->first != q->first || p->second != q->second) {
               return false;
             }
 
           } else if (p == this->end() && q == buffer.end()) {
 
             return true;
 
           } else {
 
             return false;
           }
         }
       }

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>

bool JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >::equals	(	const hash_map< key_type, value_type, evaluator_type > &	buffer,
		const double	precision
	)		const

inline

Check equality of has map.

Parameters

buffer	buffer
precision	precision

Returns: true if hash map is equal; else false

Definition at line 959 of file JAcoustics/JModel.hh.

       {
         for (typename hashmap_type::const_iterator
                p = this->begin(),
                q = buffer.begin(); ; ++p, ++q) {
 
           if        (p != this->end() && q != buffer.end()) {
 
             if (p->first != q->first || !p->second.equals(q->second, precision)) {
               return false;
             }
 
           } else if (p == this->end() && q == buffer.end()) {
 
             return true;
 
           } else {
 
             return false;
           }
         }
       }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::clear ( )

inlineoverridevirtualinherited

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 107 of file JHashMap.hh.

     {
       collection_type::clear();
     }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::reset ( )

inlineinherited

Reset values.

Definition at line 116 of file JHashMap.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->second = mapped_type();
       }
     }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::set	(	const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	source,
		const mapped_type &	value
	)

inlineinherited

Set values corresponding to keys in given source.

Parameters

source	source
value	value

Definition at line 130 of file JHashMap.hh.

     {
       this->clear();
 
       for (const_iterator i = source.begin(); i != source.end(); ++i) {
         (*this)[i->first] = value;
       }
     }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type key )

inlineoverridevirtualinherited

Get mapped value.

Parameters

key key

Returns: mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 146 of file JHashMap.hh.

     {
       const int ival = this->getValue(key);
       
       if (!this->router.has(ival)) {
         collection_type::insert(value_type(key, mapped_type()));
       }
 
       return container_type::operator[](this->router.get(ival)).second;
     }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual const mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type key ) const

inlineoverridevirtualinherited

Get mapped value.

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

Parameters

key key

Returns: mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 166 of file JHashMap.hh.

     {
       const int ival = this->getValue(key);
 
       if (this->router.has(ival))
         return container_type::operator[](this->router.get(ival)).second;
       else
         THROW(JIndexOutOfRange, "JHashMap::get(): invalid key " << STREAM("?") << key);
     }

value_type& JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< 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

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

const value_type& JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< 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

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

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::swap ( JHashCollection< std::pair< JKey_t, JValue_t >, JHashMapEvaluator< JEvaluator_t > > & 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);
     }

const_iterator JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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();
     }

iterator JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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();
     }

virtual bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::insert ( const value_type & element )

inlinevirtualinherited

Insert element.

Parameters

element element

Returns: true if inserted; else false

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

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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);
       }
     }

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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));
       }
     }

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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));
       }
     }

bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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;
     }

bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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));
     }

int JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::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));
     }

template<class JKey_t, class JValue_t>

const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type key ) const

inlineinherited

Get mapped value.

Parameters

key key

Returns: value

Definition at line 73 of file JMappableCollection.hh.

     {
       return get(key);
     }

template<class JKey_t, class JValue_t>

mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type key )

inlineinherited

Get mapped value.

Parameters

key key

Returns: value

Definition at line 85 of file JMappableCollection.hh.

     {
       return get(key);
     }

template<class JKey_t, class JValue_t>

void JTOOLS::JMappableCollection< JKey_t, JValue_t >::put	(	typename JClass< key_type >::argument_type	key,
		typename JClass< mapped_type >::argument_type	value
	)

inlineinherited

Put pair-wise element (key,value) into collection.

Parameters

key	key
value	value

Definition at line 97 of file JMappableCollection.hh.

     {
       get(key) = value;
     }

Member Data Documentation

JHashMapEvaluator< JEvaluator_t > JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::getValue

inherited

Function object for evaluation of element.

Definition at line 331 of file JHashCollection.hh.

JTOOLS::JHashCollection::router_type JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::router

protectedinherited

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

JAcoustics/JModel.hh

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

template<class key_type, class value_type, class evaluator_type = JHashEvaluator> struct JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

template<class key_type, class value_type, class evaluator_type = JHashEvaluator>
struct JACOUSTICS::JModel::hash_map< key_type, value_type, evaluator_type >