Jpp  17.1.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
JACOUSTICS::JKatoomba_t::H_t Struct Reference

H-equation as per hit. More...

#include <JKatoomba.hh>

Inheritance diagram for JACOUSTICS::JKatoomba_t::H_t:
JACOUSTICS::JMODEL::JEmitter JACOUSTICS::JMODEL::JString JMATH::JMath< JFirst_t, JSecond_t > JMATH::JMath< JFirst_t, JSecond_t > JLANG::JEquals< JFirst_t, JSecond_t > JMATH::JMath< JFirst_t, JSecond_t > JLANG::JEquals< JFirst_t, JSecond_t >

Public Member Functions

 H_t ()
 Default constructor. More...
 
 H_t (const JMODEL::JEmitter &emitter, const JMODEL::JString &string)
 Constructor. More...
 
H_t & mul (const double factor)
 Scale H-equation. More...
 
JEmitter & negate ()
 Negate emitter. More...
 
JEmitter & add (const JEmitter &emitter)
 Add emitter. More...
 
JEmitter & sub (const JEmitter &emitter)
 Subtract emitter. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 
JEmitter & div (const double factor)
 Scale emitter. More...
 
bool equals (const JEmitter &emitter, const double precision=std::numeric_limits< double >::min()) const
 Check equality. More...
 
JString & negate ()
 Negate string. More...
 
JString & add (const JString &string)
 Add string. More...
 
JString & sub (const JString &string)
 Subtract string. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 
JString & div (const double factor)
 Scale string. More...
 
bool equals (const JString &string, const double precision=std::numeric_limits< double >::min()) const
 Check equality. More...
 
double getLengthSquared () const
 Get length squared. More...
 
double getLength () const
 Get length. More...
 
double getAngle () const
 Get angle. More...
 
double getDot (const JString &string) const
 Get dot product. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 

Static Public Member Functions

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

Public Attributes

double t1
 
double tx
 
double ty
 
double tx2
 
double ty2
 
double vs
 

Detailed Description

H-equation as per hit.

Definition at line 105 of file JKatoomba.hh.

Constructor & Destructor Documentation

JACOUSTICS::JKatoomba_t::H_t::H_t ( )
inline

Default constructor.

Definition at line 113 of file JKatoomba.hh.

113  :
114  JMODEL::JEmitter(),
115  JMODEL::JString ()
116  {}
JACOUSTICS::JKatoomba_t::H_t::H_t ( const JMODEL::JEmitter &  emitter,
const JMODEL::JString &  string 
)
inline

Constructor.

Parameters
emitteremitter
stringstring

Definition at line 125 of file JKatoomba.hh.

126  :
127  JMODEL::JEmitter(emitter),
128  JMODEL::JString (string)
129  {}

Member Function Documentation

H_t& JACOUSTICS::JKatoomba_t::H_t::mul ( const double  factor)
inline

Scale H-equation.

Parameters
factormultiplication factor
Returns
this H-equation

Definition at line 138 of file JKatoomba.hh.

139  {
140  static_cast<JMODEL::JEmitter&>(*this).mul(factor);
141  static_cast<JMODEL::JString&> (*this).mul(factor);
142 
143  return *this;
144  }
JACOUSTICS::JMODEL::JString::mul
JString & mul(const double factor)
Scale string.
Definition: JAcoustics/JModel.hh:240
JACOUSTICS::JMODEL::JEmitter::mul
JEmitter & mul(const double factor)
Scale emitter.
Definition: JAcoustics/JModel.hh:461
static size_t JACOUSTICS::JMODEL::JEmitter::getN ( )
inlinestaticinherited

Get number of fit parameters.

Returns
number of parameters

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

409  {
410  return 1;
411  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::negate ( )
inlineinherited

Negate emitter.

Returns
this emitter

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

420  {
421  t1 = -t1;
422 
423  return *this;
424  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::add ( const JEmitter &  emitter)
inlineinherited

Add emitter.

Parameters
emitteremitter
Returns
this emitter

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

434  {
435  t1 += emitter.t1;
436 
437  return *this;
438  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::sub ( const JEmitter &  emitter)
inlineinherited

Subtract emitter.

Parameters
emitteremitter
Returns
this emitter

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

448  {
449  t1 -= emitter.t1;
450 
451  return *this;
452  }
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
objectobject
Returns
result object

Definition at line 357 of file JMath.hh.

358  {
359  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
360  }
JMATH::JCalculator
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18
JEmitter& JACOUSTICS::JMODEL::JEmitter::div ( const double  factor)
inlineinherited

Scale emitter.

Parameters
factordivision factor
Returns
this emitter

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

476  {
477  t1 /= factor;
478 
479  return *this;
480  }
bool JACOUSTICS::JMODEL::JEmitter::equals ( const JEmitter &  emitter,
const double  precision = std::numeric_limits<double>::min() 
) const
inlineinherited

Check equality.

Parameters
emitteremitter
precisionprecision
Returns
true if emitters are equal; else false

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

492  {
493  return (fabs(t1 - emitter.t1) <= precision);
494  }
static size_t JACOUSTICS::JMODEL::JString::getN ( )
inlinestaticinherited

Get number of fit parameters.

Returns
number of parameters

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

160  {
161  switch (JMODEL::getOption()) {
162 
163  case fit_emitters_only_t:
164  return 0;
165 
166  case fit_emitters_and_strings_1st_order_t:
167  return 2;
168 
169  case fit_emitters_and_strings_2nd_order_t:
170  return 4;
171 
172  case fit_emitters_and_strings_2nd_order_and_stretching_t:
173  return 5;
174 
175  default:
176  THROW(JValueOutOfRange, "Invalid option " << JMODEL::getOption());
177  }
178  }
JACOUSTICS::JMODEL::fit_emitters_and_strings_2nd_order_and_stretching_t
fit times of emission of emitters and tilt angles of strings with second order correction and stretch...
Definition: JAcoustics/JModel.hh:51
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
JACOUSTICS::JMODEL::fit_emitters_and_strings_1st_order_t
fit times of emission of emitters and tilt angles of strings
Definition: JAcoustics/JModel.hh:49
JACOUSTICS::JMODEL::fit_emitters_and_strings_2nd_order_t
fit times of emission of emitters and tilt angles of strings with second order correction ...
Definition: JAcoustics/JModel.hh:50
JACOUSTICS::JMODEL::getOption
JOption_t getOption()
Get fit option.
Definition: JAcoustics/JModel.hh:85
JACOUSTICS::JMODEL::fit_emitters_only_t
fit only times of emission of emitters
Definition: JAcoustics/JModel.hh:48
JString& JACOUSTICS::JMODEL::JString::negate ( )
inlineinherited

Negate string.

Returns
this string

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

187  {
188  tx = -tx;
189  ty = -ty;
190  tx2 = -tx2;
191  ty2 = -ty2;
192  vs = -vs;
193 
194  return *this;
195  }
JString& JACOUSTICS::JMODEL::JString::add ( const JString &  string)
inlineinherited

Add string.

Parameters
stringstring
Returns
this string

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

205  {
206  tx += string.tx;
207  ty += string.ty;
208  tx2 += string.tx2;
209  ty2 += string.ty2;
210  vs += string.vs;
211 
212  return *this;
213  }
JString& JACOUSTICS::JMODEL::JString::sub ( const JString &  string)
inlineinherited

Subtract string.

Parameters
stringstring
Returns
this string

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

223  {
224  tx -= string.tx;
225  ty -= string.ty;
226  tx2 -= string.tx2;
227  ty2 -= string.ty2;
228  vs -= string.vs;
229 
230  return *this;
231  }
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
objectobject
Returns
result object

Definition at line 357 of file JMath.hh.

358  {
359  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
360  }
JMATH::JCalculator
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18
JString& JACOUSTICS::JMODEL::JString::div ( const double  factor)
inlineinherited

Scale string.

Parameters
factordivision factor
Returns
this string

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

259  {
260  tx /= factor;
261  ty /= factor;
262  tx2 /= factor;
263  ty2 /= factor;
264  vs /= factor;
265 
266  return *this;
267  }
bool JACOUSTICS::JMODEL::JString::equals ( const JString &  string,
const double  precision = std::numeric_limits<double>::min() 
) const
inlineinherited

Check equality.

Parameters
stringstring
precisionprecision
Returns
true if strings are equal; else false

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

279  {
280  return (fabs(tx - string.tx) <= precision &&
281  fabs(ty - string.ty) <= precision &&
282  fabs(tx2 - string.tx2) <= precision &&
283  fabs(ty2 - string.ty2) <= precision &&
284  fabs(vs - string.vs) <= precision);
285  }
double JACOUSTICS::JMODEL::JString::getLengthSquared ( ) const
inlineinherited

Get length squared.

Returns
square of length

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

294  {
295  return tx*tx + ty*ty;
296  }
double JACOUSTICS::JMODEL::JString::getLength ( ) const
inlineinherited

Get length.

Returns
length

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

305  {
306  return sqrt(getLengthSquared());
307  }
JACOUSTICS::JMODEL::JString::getLengthSquared
double getLengthSquared() const
Get length squared.
Definition: JAcoustics/JModel.hh:293
double JACOUSTICS::JMODEL::JString::getAngle ( ) const
inlineinherited

Get angle.

Returns
angle [rad]

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

316  {
317  return atan2(ty, tx);
318  }
double JACOUSTICS::JMODEL::JString::getDot ( const JString &  string) const
inlineinherited

Get dot product.

Parameters
stringstring
Returns
dot product

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

328  {
329  return (tx * string.tx +
330  ty * string.ty +
331  tx2 * string.tx2 +
332  ty2 * string.ty2 +
333  vs * string.vs);
334  }
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
objectobject
Returns
result object

Definition at line 357 of file JMath.hh.

358  {
359  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
360  }
JMATH::JCalculator
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18

Member Data Documentation

double JACOUSTICS::JMODEL::JEmitter::t1
inherited

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

double JACOUSTICS::JMODEL::JString::tx
inherited

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

double JACOUSTICS::JMODEL::JString::ty
inherited

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

double JACOUSTICS::JMODEL::JString::tx2
inherited

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

double JACOUSTICS::JMODEL::JString::ty2
inherited

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

double JACOUSTICS::JMODEL::JString::vs
inherited

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

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