String geometry. More...

#include <JGeometry.hh>

Inheritance diagram for JACOUSTICS::JGEOMETRY::JString:

Public Types
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
	JString ()
	Default constructor. More...

	JString (const JVector3D &position)
	Constructor. More...

template<class T >
	JString (const JVector3D &position, T __begin, T __end, const JMechanics &mechanics)
	Constructor. More...

bool	hasFloor (int floor) const
	Check if this string has given floor. More...

double	getHeight (const int floor) const
	Get height of given floor. More...

JPosition3D	getPosition (const JMODEL::JString &parameters, const double height) const
	Get position at given height according to given string model parameters. More...

JPosition3D	getPosition (const JMODEL::JString &parameters, const int floor) const
	Get position of given floor according to given string model parameters. More...

JPosition3D	getPosition (const double height) const
	Get position at given height according to default string model parameters. More...

JPosition3D	getPosition (const int floor) const
	Get position of given floor according to default string model parameters. More...

double	getDistance (const JMODEL::JString &parameters, const JVector3D &position, const int floor) const
	Get distance between given position and floor according to given string model parameters. More...

JMODEL::JString	getGradient (const JMODEL::JString &parameters, const JVector3D &position, const int floor) const
	Get model gradient of distance between given position and floor according to given string model parameters. More...

const JPosition3D &	getPosition () const
	Get position. More...

JPosition3D &	getPosition ()
	Get position. More...

void	setPosition (const JVector3D &pos)
	Set position. More...

	operator JAngle3D () const
	Type conversion operator. More...

	operator JVersor3D () const
	Type conversion operator. More...

JPosition3D &	rotate (const JRotation3D &R)
	Rotate. More...

JPosition3D &	rotate (const JRotation3X &R)
	Rotate around X-axis. More...

JPosition3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis. More...

JPosition3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis. More...

JPosition3D &	rotate (const JQuaternion3D &Q)
	Rotate. More...

JPosition3D &	rotate_back (const JRotation3D &R)
	Rotate back. More...

JPosition3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis. More...

JPosition3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis. More...

JPosition3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis. More...

JPosition3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back. More...

void	transform (const JRotation3D &R, const JVector3D &pos)
	Transform position. More...

JVector3D &	transform (const JMatrix3D &T)
	Transform. More...

void	transform_back (const JRotation3D &R, const JVector3D &pos)
	Transform back position. More...

double	getDot (const JAngle3D &angle) const
	Get dot product. More...

double	getDot (const JVersor3D &dir) const
	Get dot product. More...

double	getDot (const JVersor3Z &dir) const
	Get dot product. More...

double	getDot (const JVector3D &vector) const
	Get dot product. More...

	operator JVector2D () const
	Type conversion operator. More...

double	getX () const
	Get x position. More...

double	getY () const
	Get y position. More...

double	getZ () const
	Get z position. More...

JVector3D &	negate ()
	Negate vector. More...

JVector3D &	add (const JVector3D &vector)
	Add vector. More...

JVector3D &	sub (const JVector3D &vector)
	Subtract vector. More...

JVector3D &	mul (const double factor)
	Scale vector. More...

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

JVector3D &	div (const double factor)
	Scale vector. More...

bool	equals (const JVector3D &vector, 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	getDistanceSquared (const JVector3D &pos) const
	Get squared of distance to point. More...

double	getDistance (const JVector3D &pos) const
	Get distance to point. More...

JVector3D &	getCross (const JVector3D &first, const JVector3D &second)
	Get cross product. More...

virtual void	clear () override
	Clear. 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
JPosition3D	hydrophone
	Hydrophone. More...

bool	has_hydrophone

JMechanics	mechanics
	Mechanical data. More...

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

Protected Attributes
double	__x

double	__y

double	__z

JTOOLS::JHashCollection::router_type	router

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

Detailed Description

String geometry.

This data structure provides for the implementation of the dynamical geometry of a detector string.
In this, the position of floor > 0 corresponds to the piezo sensor which is mounted in the optical module and the position of floor = 0 to the hydrophone which is optionally mounted on the anchor.
The reference position of a string corresponds to the top of the so-called T-bar located on the anchor.
The position of a piezo sensor depends on the tilt of the string and the mechanical model.
The position of the hydrophone is fixed. Its value is relative to the reference position of the string.

Definition at line 121 of file JGeometry.hh.

Member Typedef Documentation

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.

Constructor & Destructor Documentation

JACOUSTICS::JGEOMETRY::JString::JString ( )

inline

Default constructor.

Definition at line 132 of file JGeometry.hh.

                 :
         has_hydrophone(false)
       {}

JACOUSTICS::JGEOMETRY::JString::JString ( const JVector3D & position )

inline

Constructor.

The given position corresponds to the reference point of the string from which the positions of the piezo sensors and hydrophone are calculated.

Parameters

position position

Definition at line 145 of file JGeometry.hh.

                                          :
         JPosition3D(position),
         has_hydrophone(false)
       {}

template<class T >

JACOUSTICS::JGEOMETRY::JString::JString	(	const JVector3D &	position,
		T	__begin,
		T	__end,
		const JMechanics &	mechanics
	)

inline

Constructor.

The given position corresponds to the reference position of the string from which the positions of the piezo sensors and hydrophone are calculated.

The template parameter should correspond to a data type which implements the following policy methods.

    int                       getFloor();
    JGEOMETRY3d::JPosition3D  getPosition();

In this, the position should correspond to the center of the optical module.

Note that the position of the piezo is offset by JDETECTOR::getPiezoPosition with respect to the center of the optical module.
The position of the hydrophone should separately be set.

Parameters

position	position
__begin	begin of optical modules
__end	end of optical modules
mechanics	mechanical model parameters

Definition at line 173 of file JGeometry.hh.

                                            :
         JPosition3D(position),
         has_hydrophone(false),
         mechanics(mechanics)
       {
         for (T i = __begin; i != __end; ++i) {
           (*this)[i->getFloor()] = this->getDistance(i->getPosition() + JDETECTOR::getPiezoPosition());
         }
       }

Member Function Documentation

bool JACOUSTICS::JGEOMETRY::JString::hasFloor ( int floor ) const

inline

Check if this string has given floor.

Parameters

floor floor

Returns: true if floor present; else false

Definition at line 193 of file JGeometry.hh.

       {
         if (floor == 0)
           return has_hydrophone;
         else
           return this->has(floor);
       }

double JACOUSTICS::JGEOMETRY::JString::getHeight ( const int floor ) const

inline

Get height of given floor.

Parameters

floor floor

Returns: height

Definition at line 208 of file JGeometry.hh.

       {
         if (floor == 0) {
 
           if (has_hydrophone) {
             return hydrophone.getZ();
           }
 
         } else if (this->has(floor)) {
         
           return this->get(floor).getHeight();
         }
  
         THROW(JValueOutOfRange, "Invalid floor " << floor);
       }

JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition	(	const JMODEL::JString &	parameters,
		const double	height
	)		const

inline

Get position at given height according to given string model parameters.

Parameters

parameters	parameters
height	height

Returns: position

Definition at line 232 of file JGeometry.hh.

       {
         const double tx = parameters.tx;
         const double ty = parameters.ty;
         const double tz = sqrt(1.0 - tx*tx - ty*ty);
         const double dz = this->mechanics.getHeight(height);
 
         return JPosition3D(this->getX()  +  tx * dz,
                            this->getY()  +  ty * dz,
                            this->getZ()  +  tz * height);
       }

JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition	(	const JMODEL::JString &	parameters,
		const int	floor
	)		const

inline

Get position of given floor according to given string model parameters.

Parameters

parameters	parameters
floor	floor

Returns: position

Definition at line 253 of file JGeometry.hh.

       {
         if (floor == 0) {
 
           if (has_hydrophone) {
             return getPosition() + hydrophone.getPosition();
           }
 
         } else if (this->has(floor)) {
          
           return getPosition(parameters, this->get(floor).getHeight());
         }
 
         THROW(JValueOutOfRange, "Invalid floor " << floor);
       }

JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const double height ) const

inline

Get position at given height according to default string model parameters.

Parameters

height height

Returns: position

Definition at line 277 of file JGeometry.hh.

       {
         return getPosition(JMODEL::JString(), height);
       }

JPosition3D JACOUSTICS::JGEOMETRY::JString::getPosition ( const int floor ) const

inline

Get position of given floor according to default string model parameters.

Parameters

floor floor

Returns: position

Definition at line 289 of file JGeometry.hh.

       {
         return getPosition(JMODEL::JString(), floor);
       }

double JACOUSTICS::JGEOMETRY::JString::getDistance	(	const JMODEL::JString &	parameters,
		const JVector3D &	position,
		const int	floor
	)		const

inline

Get distance between given position and floor according to given string model parameters.

Parameters

parameters	parameters
position	position
floor	floor

Returns: distance

Definition at line 303 of file JGeometry.hh.

       {
         return this->getPosition(parameters, floor).getDistance(position);
       }

JMODEL::JString JACOUSTICS::JGEOMETRY::JString::getGradient	(	const JMODEL::JString &	parameters,
		const JVector3D &	position,
		const int	floor
	)		const

inline

Get model gradient of distance between given position and floor according to given string model parameters.

Parameters

parameters	parameters
position	position
floor	floor

Returns: gradient

Definition at line 319 of file JGeometry.hh.

       {
         if (floor == 0) {
 
           return JMODEL::JString();
 
         } else if (this->has(floor)) {
 
           const double      height = this->get(floor).getHeight();
           const JPosition3D pos    = this->getPosition(parameters, height);
           const double      hiswa  = this->mechanics.getHeight(height);
 
           const double tx = parameters.tx;
           const double ty = parameters.ty;
           const double tz = sqrt(1.0 - tx*tx - ty*ty);
 
           const double dx = pos.getX() - position.getX();
           const double dy = pos.getY() - position.getY();
           const double dz = pos.getZ() - position.getZ();
 
           const double D  = sqrt(dx*dx + dy*dy + dz*dz);
 
           return JMODEL::JString(hiswa * dx / D  -  height * (tx / tz) * dz / D,
                                  hiswa * dy / D  -  height * (ty / tz) * dz / D);
 
         } else {
 
           THROW(JValueOutOfRange, "Invalid floor " << floor);
         }       
       }

const JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 130 of file JPosition3D.hh.

     {
       return static_cast<const JPosition3D&>(*this);
     }

JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( )

inlineinherited

Get position.

Returns: position

Definition at line 141 of file JPosition3D.hh.

     {
       return static_cast<JPosition3D&>(*this);
     }

void JGEOMETRY3D::JPosition3D::setPosition ( const JVector3D & pos )

inlineinherited

Set position.

Parameters

pos position

Definition at line 152 of file JPosition3D.hh.

     {
       static_cast<JVector3D&>(*this) = pos;
     }

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 163 of file JPosition3D.hh.

     {
       return JAngle3D(getX(), getY(), getZ());
     }

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 174 of file JPosition3D.hh.

     {
       return JVersor3D(getX(), getY(), getZ());
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3D & R )

inlineinherited

Rotate.

Parameters

R	rotation matrix

Returns: this position

Definition at line 186 of file JPosition3D.hh.

     {
       R.rotate(__x, __y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3X & R )

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 214 of file JPosition3D.hh.

     {
       R.rotate(__y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Y & R )

inlineinherited

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 242 of file JPosition3D.hh.

     {
       R.rotate(__x, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Z & R )

inlineinherited

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 270 of file JPosition3D.hh.

     {
       R.rotate(__x, __y);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JQuaternion3D & Q )

inlineinherited

Rotate.

Parameters

Q	quaternion

Returns: this position

Definition at line 298 of file JPosition3D.hh.

     {
       Q.rotate(__x, __y, __z);
       
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3D & R )

inlineinherited

Rotate back.

Parameters

R	rotation matrix

Returns: this position

Definition at line 200 of file JPosition3D.hh.

     {
       R.rotate_back(__x, __y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3X & R )

inlineinherited

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 228 of file JPosition3D.hh.

     {
       R.rotate_back(__y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Y & R )

inlineinherited

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 256 of file JPosition3D.hh.

     {
       R.rotate_back(__x, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Z & R )

inlineinherited

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 284 of file JPosition3D.hh.

     {
       R.rotate_back(__x, __y);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JQuaternion3D & Q )

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns: this position

Definition at line 312 of file JPosition3D.hh.

     {
       Q.rotate_back(__x, __y, __z);
 
       return *this;
     }

void JGEOMETRY3D::JPosition3D::transform	(	const JRotation3D &	R,
		const JVector3D &	pos
	)

inlineinherited

Transform position.

The final position is obtained as follows:

rotation of the position according matrix R;
offset position with pos;
rotation of position around z-axis, such that final position lies in x-z plane;

Parameters

R	rotation matrix
pos	position of origin (after rotation)

Definition at line 331 of file JPosition3D.hh.

     {
       // rotate geometry to system with particle direction along z-axis
 
       rotate(R);
 
       // offset with respect to origin
 
       sub(pos);
 
       // rotate geometry to x-z plane
 
       __x = sqrt(__x*__x + __y*__y);
       __y = 0.0;
     }

JVector3D& JGEOMETRY3D::JVector3D::transform ( const JMatrix3D & T )

inlineinherited

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 206 of file JVector3D.hh.

     {
       T.transform(__x, __y, __z);
 
       return *this;
     }

void JGEOMETRY3D::JPosition3D::transform_back	(	const JRotation3D &	R,
		const JVector3D &	pos
	)

inlineinherited

Transform back position.

The final position is obtained as follows:

offset position with position pos;
rotation of postion according matrix R;

Parameters

R	rotation matrix
pos	position of origin (before rotation)

Definition at line 359 of file JPosition3D.hh.

     {
       // offset with respect to origin
 
       add(pos);
 
       // rotate back geometry to system with particle direction along z-axis
 
       rotate_back(R);
     }

double JGEOMETRY3D::JPosition3D::getDot ( const JAngle3D & angle ) const

inlineinherited

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 378 of file JPosition3D.hh.

     {
       return
         getX() * angle.getDX() +
         getY() * angle.getDY() +
         getZ() * angle.getDZ();
     }

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3D & dir ) const

inlineinherited

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 393 of file JPosition3D.hh.

     {
       return
         getX() * dir.getDX() +
         getY() * dir.getDY() +
         getZ() * dir.getDZ();
     }

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3Z & dir ) const

inlineinherited

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 408 of file JPosition3D.hh.

     {
       return
         getX() * dir.getDX() +
         getY() * dir.getDY() +
         getZ() * dir.getDZ();
     }

double JGEOMETRY3D::JVector3D::getDot ( const JVector3D & vector ) const

inlineinherited

Get dot product.

Parameters

vector vector

Returns: dot product

Definition at line 282 of file JVector3D.hh.

     {
       return
         getX() * vector.getX() +
         getY() * vector.getY() +
         getZ() * vector.getZ();
     }

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns: JVector2D

Definition at line 83 of file JVector3D.hh.

     {
       return JVector2D(this->getX(), this->getY());
     }

double JGEOMETRY3D::JVector3D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 94 of file JVector3D.hh.

     { 
       return __x;
     }

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 104 of file JVector3D.hh.

     { 
       return __y;
     }

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns: z position

Definition at line 115 of file JVector3D.hh.

     { 
       return __z;
     }

JVector3D& JGEOMETRY3D::JVector3D::negate ( )

inlineinherited

Negate vector.

Returns: this vector

Definition at line 126 of file JVector3D.hh.

     {
       __x = -__x;
       __y = -__y;
       __z = -__z;
 
       return *this;
     }

JVector3D& JGEOMETRY3D::JVector3D::add ( const JVector3D & vector )

inlineinherited

Add vector.

Parameters

vector vector

Returns: this vector

Definition at line 142 of file JVector3D.hh.

     {
       __x += vector.getX();
       __y += vector.getY();
       __z += vector.getZ();
 
       return *this;
     }

JVector3D& JGEOMETRY3D::JVector3D::sub ( const JVector3D & vector )

inlineinherited

Subtract vector.

Parameters

vector vector

Returns: this vector

Definition at line 158 of file JVector3D.hh.

     {
       __x -= vector.getX();
       __y -= vector.getY();
       __z -= vector.getZ();
 
       return *this;
     }

JVector3D& JGEOMETRY3D::JVector3D::mul ( const double factor )

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 174 of file JVector3D.hh.

     {
       __x *= factor;
       __y *= factor;
       __z *= factor;
 
       return *this;
     }

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

JVector3D& JGEOMETRY3D::JVector3D::div ( const double factor )

inlineinherited

Scale vector.

Parameters

factor division factor

Returns: this vector

Definition at line 190 of file JVector3D.hh.

     {
       __x /= factor;
       __y /= factor;
       __z /= factor;
 
       return *this;
     }

bool JGEOMETRY3D::JVector3D::equals	(	const JVector3D &	vector,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inlineinherited

Check equality.

Parameters

vector	vector
precision	precision

Returns: true if vectors are equal; else false

Definition at line 221 of file JVector3D.hh.

     {
       return (fabs(getX() - vector.getX()) <= precision &&
               fabs(getY() - vector.getY()) <= precision &&
               fabs(getZ() - vector.getZ()) <= precision);
     }

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns: square of length

Definition at line 235 of file JVector3D.hh.

     { 
       return getX()*getX() + getY()*getY() + getZ()*getZ();
     }

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 246 of file JVector3D.hh.

     { 
       return sqrt(getLengthSquared());
     }

double JGEOMETRY3D::JVector3D::getDistanceSquared ( const JVector3D & pos ) const

inlineinherited

Get squared of distance to point.

Parameters

pos position

Returns: square of distance

Definition at line 258 of file JVector3D.hh.

     {
       return JVector3D(pos).sub(*this).getLengthSquared();
     }

double JGEOMETRY3D::JVector3D::getDistance ( const JVector3D & pos ) const

inlineinherited

Get distance to point.

Parameters

pos position

Returns: distance

Definition at line 270 of file JVector3D.hh.

     {
       return sqrt(getDistanceSquared(pos));
     }

JVector3D& JGEOMETRY3D::JVector3D::getCross	(	const JVector3D &	first,
		const JVector3D &	second
	)

inlineinherited

Get cross product.

Note that this vector should not overlap with the first or second vector,

Parameters

first	first vector
second	second vector

Returns: this vector

Definition at line 299 of file JVector3D.hh.

     {
       __x = first .getY() * second.getZ()  -  second.getY() * first .getZ();
       __y = second.getX() * first .getZ()  -  first .getX() * second.getZ();
       __z = first .getX() * second.getY()  -  second.getX() * first .getY();
 
       return *this;
     }

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>

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 119 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 139 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, "JHasMap::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, "JHasCollection::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;
     }

Friends And Related Function Documentation

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 360 of file JGeometry.hh.

       {
         using namespace std;
 
         for (JString::const_iterator i = string.begin(); i != string.end(); ++i) {
           out << setw(2)    << i->first       << ' ' 
               << FIXED(7,3) << i->second      << " | " 
               << string.getPosition(i->first) << ' ' 
               << string.mechanics             << endl;
         }
 
         return out;
       }

Member Data Documentation

JPosition3D JACOUSTICS::JGEOMETRY::JString::hydrophone

Hydrophone.

The position of the hydrophone is relative to the reference position of the string.

Definition at line 380 of file JGeometry.hh.

bool JACOUSTICS::JGEOMETRY::JString::has_hydrophone

Definition at line 381 of file JGeometry.hh.

JMechanics JACOUSTICS::JGEOMETRY::JString::mechanics

Mechanical data.

Definition at line 386 of file JGeometry.hh.

double JGEOMETRY3D::JVector3D::__x

protectedinherited

Definition at line 310 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 311 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 312 of file JVector3D.hh.

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:

JGeometry.hh

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation