JACOUSTICS::JMODEL::JString Struct Reference

String parameters. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JMODEL::JString:

Public Member Functions
	JString ()
	Default constructor. More...
	JString (const double tx, const double ty)
	Constructor. More...
JString &	negate ()
	Negate string. More...
JString &	add (const JString &string)
	Add string. More...
JString &	sub (const JString &string)
	Subtract string. More...
JString &	mul (const double factor)
	Scale string. 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...

Public Attributes
double	tx
double	ty

Friends
std::istream &	operator>> (std::istream &in, JString &string)
	Read string parameters from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JString &string)
	Write string parameters to output stream. More...

Detailed Description

String parameters.

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

Constructor & Destructor Documentation

JACOUSTICS::JMODEL::JString::JString ( )

inline

Default constructor.

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

                :
        tx(0.0),
        ty(0.0)
      {}

JACOUSTICS::JMODEL::JString::JString ( const double  tx, const double  ty  )

inline

Constructor.

Parameters

tx	slope dx/dz
ty	slope dy/dz

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

                               :
        tx(tx),
        ty(ty)
      {}

Member Function Documentation

static size_t JACOUSTICS::JMODEL::JString::getN ( )

inlinestatic

Get number of fit parameters.

Returns

number of parameters

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

      {
        return 2;
      }

JString& JACOUSTICS::JMODEL::JString::negate ( )

inline

Negate string.

Returns

this string

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

      {
        tx = -tx;
        ty = -ty;

        return *this;
      }

JString& JACOUSTICS::JMODEL::JString::add ( const JString &  string )

inline

Add string.

Parameters

string

string

Returns

this string

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

      {
        tx += string.tx;
        ty += string.ty;

        return *this;
      }

JString& JACOUSTICS::JMODEL::JString::sub ( const JString &  string )

inline

Subtract string.

Parameters

string

string

Returns

this string

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

      {
        tx -= string.tx;
        ty -= string.ty;

        return *this;
      }

JString& JACOUSTICS::JMODEL::JString::mul ( const double  factor )

inline

Scale string.

Parameters

factor

multiplication factor

Returns

this string

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

      {
        tx *= factor;
        ty *= factor;

        return *this;
      }

JString& JACOUSTICS::JMODEL::JString::div ( const double  factor )

inline

Scale string.

Parameters

factor

division factor

Returns

this string

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

      {
        tx /= factor;
        ty /= factor;

        return *this;
      }

bool JACOUSTICS::JMODEL::JString::equals ( const JString &  string, const double  precision = std::numeric_limits<double>::min()  ) const

inline

Check equality.

Parameters

string	string
precision	precision

Returns

true if strings are equal; else false

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

      {
        return (fabs(tx - string.tx) <= precision &&
                fabs(ty - string.ty) <= precision);
      }

double JACOUSTICS::JMODEL::JString::getLengthSquared ( ) const

inline

Get length squared.

Returns

square of length

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

      {
        return tx*tx + ty*ty;
      }

double JACOUSTICS::JMODEL::JString::getLength ( ) const

inline

Get length.

Returns

length

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

      { 
        return sqrt(getLengthSquared());
      }

double JACOUSTICS::JMODEL::JString::getAngle ( ) const

inline

Get angle.

Returns

angle [rad]

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

      { 
        return atan2(ty, tx);
      }

double JACOUSTICS::JMODEL::JString::getDot ( const JString &  string ) const

inline

Get dot product.

Parameters

string

string

Returns

dot product

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

      {
        return (tx * string.tx +
                ty * string.ty);
      }

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

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JString &  string  )

friend

Read string parameters from input stream.

Parameters

in	input stream
string	string

Returns

input stream

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

      {
        return in >> string.tx >> string.ty;
      }

std::ostream& operator<< ( std::ostream &  out, const JString &  string  )

friend

Write string parameters to output stream.

Parameters

out	output stream
string	string

Returns

output stream

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

      {
        using namespace std;
        using namespace JPP;

        return out << FIXED(10,7) << string.tx << ' '
                   << FIXED(10,7) << string.ty;
      }

Member Data Documentation

double JACOUSTICS::JMODEL::JString::tx

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

double JACOUSTICS::JMODEL::JString::ty

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

---

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

• JAcoustics/JModel.hh