Model for fit to acoustics data. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JModel:

Classes
struct	emitter_type
	Map emitter key to model parameters of emitter. More...

struct	string_type
	Map string identifier to model parameters of string. More...

Public Types
typedef JMODEL::JString	JString

typedef JMODEL::JEmitter	JEmitter

typedef size_t	parameter_type
	Type definition of fit parameter. More...

Public Member Functions
	JModel ()
	Default constructor. More...

template<class T >
	JModel (T __begin, T __end)
	Constructor. More...

JModel &	operator= (const JMATH::JZero &zero)
	Reset parameters. More...

void	clear ()
	Clear parameters. More...

void	reset ()
	Reset parameters. More...

JModel &	negate ()
	Negate model. More...

JModel &	add (const JModel &model)
	Add model. More...

JModel &	sub (const JModel &model)
	Subtract model. More...

JModel &	mul (const double factor)
	Scale model. More...

JModel &	div (const double factor)
	Scale model. More...

bool	equals (const JModel &model, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

size_t	getN () const
	Get number of fit parameters. More...

size_t	getIndex (int id, double JString::*p) const
	Get index of fit parameter for given string. More...

size_t	getIndex (const JEKey &id, double JEmitter::*p) const
	Get index of fit parameter for given emitter. More...

double	operator[] (const size_t index) const
	Read access to fit parameter value by index. More...

double &	operator[] (const size_t index)
	Read/write access to fit parameter value by index. More...

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Static Public Member Functions
template<class JKey_t , class JValue_t , class JEvaluator_t >
static void	reset (JHashMap< JKey_t, JValue_t, JEvaluator_t > &buffer)
	Reset buffer. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static void	set (JHashMap< JKey_t, JValue_t, JEvaluator_t > &target, const JHashMap< JKey_t, JValue_t, JEvaluator_t > &source, const JValue_t &value)
	Set values in target corresponding to keys in source. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static void	evaluate (JHashMap< JKey_t, JValue_t, JEvaluator_t > &buffer, JValue_t &(JValue_t::*f1)())
	Evaluate arithmetic operation on buffer. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static void	evaluate (JHashMap< JKey_t, JValue_t, JEvaluator_t > &first, const JHashMap< JKey_t, JValue_t, JEvaluator_t > &second, JValue_t &(JValue_t::*f1)(const JValue_t &))
	Evaluate arithmetic operation on buffers. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static void	evaluate (JHashMap< JKey_t, JValue_t, JEvaluator_t > &buffer, JValue_t &(JValue_t::*f1)(const double), const double factor)
	Evaluate arithmetic operation on buffer. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static bool	equals (const JHashMap< JKey_t, JValue_t, JEvaluator_t > &first, const JHashMap< JKey_t, JValue_t, JEvaluator_t > &second)
	Check equality of buffers. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static bool	equals (const JHashMap< JKey_t, JValue_t, JEvaluator_t > &first, const JHashMap< JKey_t, JValue_t, JEvaluator_t > &second, const double precision)
	Check equality of buffers. More...

Public Attributes
JACOUSTICS::JModel::emitter_type	emitter

JACOUSTICS::JModel::string_type	string

Static Private Member Functions
template<class T >
static size_t	getIndex (double T::*p)
	Get index of fit parameter in given data structure. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static double	getParameter (const JHashMap< JKey_t, JValue_t, JEvaluator_t > &buffer, const size_t index)
	Get read access to fit parameter value at given index in buffer. More...

template<class JKey_t , class JValue_t , class JEvaluator_t >
static double &	getParameter (JHashMap< JKey_t, JValue_t, JEvaluator_t > &buffer, const size_t index)
	Get read/write access to fit parameter value at given index in buffer. More...

Friends
std::ostream &	operator<< (std::ostream &out, const JModel &model)
	Write model parameters to output stream. More...

Detailed Description

Model for fit to acoustics data.

The model consists of string parameters and emitter parameters.
These parameters relate to the string identifer and emitter key, respectively.

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

Member Typedef Documentation

typedef JMODEL::JString JACOUSTICS::JModel::JString

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

typedef JMODEL::JEmitter JACOUSTICS::JModel::JEmitter

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

typedef size_t JACOUSTICS::JModel::parameter_type

Type definition of fit parameter.

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

Constructor & Destructor Documentation

JACOUSTICS::JModel::JModel ( )

inline

Default constructor.

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

547 {}

template<class T >

JACOUSTICS::JModel::JModel	(	T	__begin,
		T	__end
	)

inline

Constructor.

This constructor can be used to set up a default model (i.e. all values at zero) for the given set of hits.
The data type corresponding to the hits should provide for the following policy methods.

   int      getString();        // get string identifier
   JEkey    getEKey();          // get emitter key

Parameters

__begin	begin of hits
__end	end of hits

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

     {
       for (T hit = __begin; hit != __end; ++hit) {
 
         if (!this->string.has(hit->getString())) {
           this->string[hit->getString()] = JString();
         }
 
         if (!this->emitter.has(hit->getEKey())) {
           this->emitter[hit->getEKey()]  = JEmitter();
         }
       }
     }

Member Function Documentation

JModel& JACOUSTICS::JModel::operator= ( const JMATH::JZero & zero )

inline

Reset parameters.

Parameters

zero zero

Returns: this model

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

     {
       this->reset();
 
       return *this;
     }

void JACOUSTICS::JModel::clear ( )

inline

Clear parameters.

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

     {
       string .clear();
       emitter.clear();
     }

void JACOUSTICS::JModel::reset ( )

inline

Reset parameters.

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

     {
       reset(string);
       reset(emitter);
     }

JModel& JACOUSTICS::JModel::negate ( )

inline

Negate model.

Returns: this model

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

     {
       evaluate(this->string,  &JString ::negate);
       evaluate(this->emitter, &JEmitter::negate);
 
       return *this;
     }

JModel& JACOUSTICS::JModel::add ( const JModel & model )

inline

Add model.

Parameters

model model

Returns: this model

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

     {
       evaluate(this->string,  model.string,  &JString ::add);
       evaluate(this->emitter, model.emitter, &JEmitter::add);
 
       return *this;
     }

JModel& JACOUSTICS::JModel::sub ( const JModel & model )

inline

Subtract model.

Parameters

model model

Returns: this model

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

     {
       evaluate(this->string,  model.string,  &JString ::sub);
       evaluate(this->emitter, model.emitter, &JEmitter::sub);
 
       return *this;
     }

JModel& JACOUSTICS::JModel::mul ( const double factor )

inline

Scale model.

Parameters

factor multiplication factor

Returns: this model

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

     {
       evaluate(this->string,  &JString ::mul, factor);
       evaluate(this->emitter, &JEmitter::mul, factor);
 
       return *this;
     }

JModel& JACOUSTICS::JModel::div ( const double factor )

inline

Scale model.

Parameters

factor division factor

Returns: this model

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

     {
       evaluate(this->string,  &JString ::div, factor);
       evaluate(this->emitter, &JEmitter::div, factor);
 
       return *this;
     }

bool JACOUSTICS::JModel::equals	(	const JModel &	model,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inline

Check equality.

Parameters

model	model
precision	precision

Returns: true if models are equal; else false

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

     {
       return (equals(this->string,  model.string,  precision) &&
               equals(this->emitter, model.emitter, precision));
     }

size_t JACOUSTICS::JModel::getN ( ) const

inline

Get number of fit parameters.

Returns: number of parameters

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

     {
       return emitter.getN() + string.getN();
     }

size_t JACOUSTICS::JModel::getIndex	(	int	id,
		double JString::*	p
	)		const

inline

Get index of fit parameter for given string.

Parameters

id	string identifier
p	pointer to data member

Returns: parameter

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

     {
       if (string.has(id))
         return emitter.getN()  +  string.getIndex(id) * JString::getN()  +  getIndex(p);
       else
         THROW(JValueOutOfRange, "Invalid identifier " << id);
     }

size_t JACOUSTICS::JModel::getIndex	(	const JEKey &	id,
		double JEmitter::*	p
	)		const

inline

Get index of fit parameter for given emitter.

Parameters

id	emitter key
p	pointer to data member

Returns: parameter

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

     {
       if (emitter.has(id))
         return emitter.getIndex(id) * JEmitter::getN()  +  getIndex(p);
       else
         THROW(JValueOutOfRange, "Invalid identifier " << id);
     }

double JACOUSTICS::JModel::operator[] ( const size_t index ) const

inline

Read access to fit parameter value by index.

Parameters

index index

Returns: value

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

     {
       size_t i = index;
 
       if (i < emitter.getN()) { return getParameter(emitter, i); }
 
       i -= emitter.getN();
 
       if (i < string .getN()) { return getParameter(string,  i); }
 
       THROW(JIndexOutOfRange, "Invalid index " << index << " >= " << getN());
     }

double& JACOUSTICS::JModel::operator[] ( const size_t index )

inline

Read/write access to fit parameter value by index.

Parameters

index index

Returns: value

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

     {
       size_t i = index;
 
       if (i < emitter.getN()) { return getParameter(emitter, i); }
 
       i -= emitter.getN();
 
       if (i < string .getN()) { return getParameter(string,  i); }
 
       THROW(JIndexOutOfRange, "Invalid index " << index << " >= " << getN());
     }

template<class T >

static size_t JACOUSTICS::JModel::getIndex ( double T::* p )

inlinestaticprivate

Get index of fit parameter in given data structure.

Parameters

p	pointer to data member

Returns: index

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

     {
       T* __p__ = NULL;
 
       return ((double*) &(__p__->*p) - (double*) __p__);
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static double JACOUSTICS::JModel::getParameter	(	const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	buffer,
		const size_t	index
	)

inlinestaticprivate

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

Parameters

buffer	buffer
index	index

Returns: value

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

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

template<class JKey_t , class JValue_t , class JEvaluator_t >

static double& JACOUSTICS::JModel::getParameter	(	JHashMap< JKey_t, JValue_t, JEvaluator_t > &	buffer,
		const size_t	index
	)

inlinestaticprivate

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

Parameters

buffer	buffer
index	index

Returns: value

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

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

template<class JFirst_t, class JSecond_t = JNullType>

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 357 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static void JTOOLS::JHashMapToolkit::reset ( JHashMap< JKey_t, JValue_t, JEvaluator_t > & buffer )

inlinestaticinherited

Reset buffer.

Parameters

buffer buffer

Definition at line 32 of file JHashMapToolkit.hh.

     {
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::iterator i = buffer.begin(); i != buffer.end(); ++i) {
         i->second = JValue_t();
       }
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

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

inlinestaticinherited

Set values in target corresponding to keys in source.

Parameters

target	target buffer
source	source buffer
value	value

Definition at line 48 of file JHashMapToolkit.hh.

     {
       target.clear();
 
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::const_iterator i = source.begin(); i != source.end(); ++i) {
         target[i->first] = value;
       }
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static void JTOOLS::JHashMapToolkit::evaluate	(	JHashMap< JKey_t, JValue_t, JEvaluator_t > &	buffer,
		JValue_t &(JValue_t::*)()	f1
	)

inlinestaticinherited

Evaluate arithmetic operation on buffer.

Parameters

buffer	buffer
f1	operation

Definition at line 67 of file JHashMapToolkit.hh.

     {
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::iterator i = buffer.begin(); i != buffer.end(); ++i) {
         (i->second.*f1)();
       }
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static void JTOOLS::JHashMapToolkit::evaluate	(	JHashMap< JKey_t, JValue_t, JEvaluator_t > &	first,
		const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	second,
		JValue_t &(JValue_t::*)(const JValue_t &)	f1
	)

inlinestaticinherited

Evaluate arithmetic operation on buffers.

Parameters

first	first buffer
second	second buffer
f1	operation

Definition at line 84 of file JHashMapToolkit.hh.

     {
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::const_iterator i = second.begin(); i != second.end(); ++i) {
         (first[i->first].*f1)(i->second);
       }
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static void JTOOLS::JHashMapToolkit::evaluate	(	JHashMap< JKey_t, JValue_t, JEvaluator_t > &	buffer,
		JValue_t &(JValue_t::*)(const double)	f1,
		const double	factor
	)

inlinestaticinherited

Evaluate arithmetic operation on buffer.

Parameters

buffer	buffer
f1	operation
factor	factor

Definition at line 102 of file JHashMapToolkit.hh.

     {
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::iterator i = buffer.begin(); i != buffer.end(); ++i) {
         (i->second.*f1)(factor);
       }
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static bool JTOOLS::JHashMapToolkit::equals	(	const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	first,
		const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	second
	)

inlinestaticinherited

Check equality of buffers.

Parameters

first	first buffer
second	second buffer

Returns: true if buffers are equal; else false

Definition at line 120 of file JHashMapToolkit.hh.

     {
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::const_iterator 
              p = first .begin(),
              q = second.begin(); ; ++p, ++q) {
 
         if        (p != first.end() && q != second.end()) {
 
           if (p->first != q->first || p->second != q->second) {
             return false;
           }
 
         } else if (p == first.end() && q == second.end()) {
           
           return true;
 
         } else {
 
           return false;
         }
       }
     }

template<class JKey_t , class JValue_t , class JEvaluator_t >

static bool JTOOLS::JHashMapToolkit::equals	(	const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	first,
		const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	second,
		const double	precision
	)

inlinestaticinherited

Check equality of buffers.

Parameters

first	first buffer
second	second buffer
precision	precision

Returns: true if buffers are equal; else false

Definition at line 154 of file JHashMapToolkit.hh.

     {
       for (typename JHashMap<JKey_t, JValue_t, JEvaluator_t>::const_iterator 
              p = first .begin(),
              q = second.begin(); ; ++p, ++q) {
 
         if        (p != first.end() && q != second.end()) {
 
           if (p->first != q->first || !p->second.equals(q->second, precision)) {
             return false;
           }
 
         } else if (p == first.end() && q == second.end()) {
           
           return true;
 
         } else {
 
           return false;
         }
       }
     }

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out,
		const JModel &	model
	)

friend

Write model parameters to output stream.

Parameters

out	output stream
model	model

Returns: output stream

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

     {
       using namespace std;
       using namespace JPP;
 
       for (JHashMap<int, JString>::const_iterator i = model.string.begin(); i != model.string.end(); ++i) {
         out << "string:  " << setw(4) << i->first << ' ' << i->second << endl;
       }
 
       for (JHashMap<JEKey, JEmitter>::const_iterator i = model.emitter.begin(); i != model.emitter.end(); ++i) {
         out << "emitter: " << setw(3) << i->first << ' ' << i->second << endl;
       }
 
       return out;
     }

Member Data Documentation

JACOUSTICS::JModel::emitter_type JACOUSTICS::JModel::emitter

JACOUSTICS::JModel::string_type JACOUSTICS::JModel::string

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

JAcoustics/JModel.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation