Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | Friends | List of all members
JACOUSTICS::JModel::JString Struct Reference

String parameters. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JModel::JString:
JMATH::JMath< JString > JLANG::JEquals< JString >

Public Member Functions

 JString ()
 Default constructor. More...
 
 JString (const double tx, const double ty)
 Constructor. More...
 
JStringnegate ()
 Negate string. More...
 
JStringadd (const JString &string)
 Add string. More...
 
JStringsub (const JString &string)
 Subtract string. More...
 
JStringmul (const double factor)
 Scale string. More...
 
JStringdiv (const double factor)
 Scale string. More...
 
bool equals (const JString &string, const double precision=std::numeric_limits< double >::min()) const
 Check equality. More...
 
double getDot (const JString &string) const
 Get dot product. More...
 
JStringmul (const JNullType &object)
 Multiply with object. More...
 

Public Attributes

double tx
 
double ty
 

Friends

std::ostream & operator<< (std::ostream &out, const JString &string)
 Write string parameters to output stream. More...
 

Detailed Description

String parameters.

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

Constructor & Destructor Documentation

JACOUSTICS::JModel::JString::JString ( )
inline

Default constructor.

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

68  :
69  tx(0.0),
70  ty(0.0)
71  {}
JACOUSTICS::JModel::JString::JString ( const double  tx,
const double  ty 
)
inline

Constructor.

Parameters
txslope dx/dz
tyslope dy/dz

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

Member Function Documentation

JString& JACOUSTICS::JModel::JString::negate ( )
inline

Negate string.

Returns
this string

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

93  {
94  tx = -tx;
95  ty = -ty;
96 
97  return *this;
98  }
JString& JACOUSTICS::JModel::JString::add ( const JString string)
inline

Add string.

Parameters
stringstring
Returns
this string

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

108  {
109  tx += string.tx;
110  ty += string.ty;
111 
112  return *this;
113  }
JString& JACOUSTICS::JModel::JString::sub ( const JString string)
inline

Subtract string.

Parameters
stringstring
Returns
this string

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

123  {
124  tx -= string.tx;
125  ty -= string.ty;
126 
127  return *this;
128  }
JString& JACOUSTICS::JModel::JString::mul ( const double  factor)
inline

Scale string.

Parameters
factormultiplication factor
Returns
this string

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

138  {
139  tx *= factor;
140  ty *= factor;
141 
142  return *this;
143  }
JString& JACOUSTICS::JModel::JString::div ( const double  factor)
inline

Scale string.

Parameters
factordivision factor
Returns
this string

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

153  {
154  tx /= factor;
155  ty /= factor;
156 
157  return *this;
158  }
bool JACOUSTICS::JModel::JString::equals ( const JString string,
const double  precision = std::numeric_limits<double>::min() 
) const
inline

Check equality.

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

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

170  {
171  return (fabs(tx - string.tx) <= precision &&
172  fabs(ty - string.ty) <= precision);
173  }
double JACOUSTICS::JModel::JString::getDot ( const JString string) const
inline

Get dot product.

Parameters
stringstring
Returns
dot product

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

183  {
184  return (tx * string.tx +
185  ty * string.ty);
186  }
JString & JMATH::JMath< JString , JNullType >::mul ( const JNullType object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 273 of file JMath.hh.

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

Friends And Related Function Documentation

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

Write string parameters to output stream.

Parameters
outoutput stream
stringstring
Returns
output stream

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

196  {
197  using namespace std;
198  using namespace JPP;
199 
200  return out << FIXED(10,7) << string.tx << ' '
201  << FIXED(10,7) << string.ty;
202  }
Auxiliary data structure for floating point format specification.
Definition: JPrint.hh:481

Member Data Documentation

double JACOUSTICS::JModel::JString::tx

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

double JACOUSTICS::JModel::JString::ty

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


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