Data structure for normalised vector in positive z-direction. More...

#include <JVersor3Z.hh>

Inheritance diagram for JGEOMETRY3D::JVersor3Z:

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

	JVersor3Z (const JVersor2D &dir)
	Constructor. More...

	JVersor3Z (const double dx, const double dy)
	Constructor. More...

const JVersor3Z &	getDirection () const
	Get direction. More...

JVersor3Z &	getDirection ()
	Get direction. More...

void	setDirection (const JVersor3Z &direction)
	Set direction. More...

	operator JAngle3D () const
	Get angle. More...

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

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

double	getDX () const
	Get x direction. More...

double	getDY () const
	Get y direction. More...

double	getDZ () const
	Get z direction. More...

JVersor3Z &	negate ()
	Prefix unary minus. More...

JVersor3Z &	add (const JVersor3Z &value)
	Addition operator. More...

JVersor3Z &	sub (const JVersor3Z &value)
	Subtraction operator. More...

JVersor3Z &	mul (const double value)
	Multiplication operator. More...

JVersor3Z &	div (const double value)
	Division operator. More...

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

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

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

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

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

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

Protected Attributes
double	__dx

double	__dy

Friends
std::istream &	operator>> (std::istream &in, JVersor3Z &versor)
	Read versor from input. More...

std::ostream &	operator<< (std::ostream &out, const JVersor3Z &versor)
	Write versor to output. More...

JReader &	operator>> (JReader &in, JVersor3Z &versor)
	Read versor from input. More...

JWriter &	operator<< (JWriter &out, const JVersor3Z &versor)
	Write versor to output. More...

Detailed Description

Data structure for normalised vector in positive z-direction.

The member methods getDX() and getDY() refer to the corresponding direction cosines. Note that the direction cosines may have any value. The method getDZ() will simply return 0 if the sum of the squares of the direction cosines is larger than 1.

Definition at line 37 of file JVersor3Z.hh.

Constructor & Destructor Documentation

◆ JVersor3Z() [1/3]

JGEOMETRY3D::JVersor3Z::JVersor3Z ( )

inline

Default constructor.

Definition at line 44 of file JVersor3Z.hh.

                 :
       __dx(0.0),
       __dy(0.0)
     {}

◆ JVersor3Z() [2/3]

JGEOMETRY3D::JVersor3Z::JVersor3Z ( const JVersor2D & dir )

inline

Constructor.

Parameters

dir	direction cosines

Definition at line 55 of file JVersor3Z.hh.

                                     :
       __dx(dir.getDX()),
       __dy(dir.getDY())
     {}

◆ JVersor3Z() [3/3]

JGEOMETRY3D::JVersor3Z::JVersor3Z	(	const double	dx,
		const double	dy
	)

inline

Constructor.

Parameters

dx	direction cosine dx/dz
dy	direction cosine dy/dz

Definition at line 67 of file JVersor3Z.hh.

                                :
       __dx(dx),
       __dy(dy)
     {}

Member Function Documentation

◆ getDirection() [1/2]

const JVersor3Z& JGEOMETRY3D::JVersor3Z::getDirection ( ) const

inline

Get direction.

Returns: direction

Definition at line 79 of file JVersor3Z.hh.

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

◆ getDirection() [2/2]

JVersor3Z& JGEOMETRY3D::JVersor3Z::getDirection ( )

inline

Get direction.

Returns: direction

Definition at line 90 of file JVersor3Z.hh.

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

◆ setDirection()

void JGEOMETRY3D::JVersor3Z::setDirection ( const JVersor3Z & direction )

inline

Set direction.

Parameters

direction direction

Definition at line 101 of file JVersor3Z.hh.

     { 
       static_cast<JVersor3Z&>(*this) = direction;
     }

◆ operator JAngle3D()

JGEOMETRY3D::JVersor3Z::operator JAngle3D ( ) const

inline

Get angle.

Returns: angle

Definition at line 112 of file JVersor3Z.hh.

     { 
       return JAngle3D(getDX(), getDY(), getDZ());
     }

◆ operator JVector3D()

JGEOMETRY3D::JVersor3Z::operator JVector3D ( ) const

inline

Type conversion operator.

Returns: position

Definition at line 123 of file JVersor3Z.hh.

     {
       return JVector3D(getDX(), getDY(), getDZ());
     }

◆ operator JVersor3D()

JGEOMETRY3D::JVersor3Z::operator JVersor3D ( ) const

inline

Type conversion operator.

Returns: direction

Definition at line 134 of file JVersor3Z.hh.

     {
       return JVersor3D(getDX(), getDY(), getDZ());
     }

◆ getDX()

double JGEOMETRY3D::JVersor3Z::getDX ( ) const

inline

Get x direction.

Returns: x direction

Definition at line 145 of file JVersor3Z.hh.

     {
       return __dx;
     }

◆ getDY()

double JGEOMETRY3D::JVersor3Z::getDY ( ) const

inline

Get y direction.

Returns: y direction

Definition at line 156 of file JVersor3Z.hh.

     {
       return __dy;
     }

◆ getDZ()

double JGEOMETRY3D::JVersor3Z::getDZ ( ) const

inline

Get z direction.

Returns: z direction

Definition at line 167 of file JVersor3Z.hh.

     {
       const double v = getDX()*getDX() + getDY()*getDY();
  
       if (v <= 1.0) 
         return sqrt(1.0 - v);
       else
         return 0.0;
     }

◆ negate()

JVersor3Z& JGEOMETRY3D::JVersor3Z::negate ( )

inline

Prefix unary minus.

Returns: this versor

Definition at line 183 of file JVersor3Z.hh.

     {
       __dx = -__dx;
       __dy = -__dy;
  
       return *this;
     }

◆ add()

JVersor3Z& JGEOMETRY3D::JVersor3Z::add ( const JVersor3Z & value )

inline

Addition operator.

Parameters

value versor

Returns: this versor

Definition at line 198 of file JVersor3Z.hh.

     {
       __dx += value.getDX();
       __dy += value.getDY();
  
       return *this;
     }

◆ sub()

JVersor3Z& JGEOMETRY3D::JVersor3Z::sub ( const JVersor3Z & value )

inline

Subtraction operator.

Parameters

value versor

Returns: this versor

Definition at line 213 of file JVersor3Z.hh.

     {
       __dx -= value.getDX();
       __dy -= value.getDY();
  
       return *this;
     }

◆ mul() [1/2]

JVersor3Z& JGEOMETRY3D::JVersor3Z::mul ( const double value )

inline

Multiplication operator.

Parameters

value multiplication factor

Returns: this versor

Definition at line 228 of file JVersor3Z.hh.

     {
       __dx *= value;
       __dy *= value;
  
       return *this;
     }

◆ div()

JVersor3Z& JGEOMETRY3D::JVersor3Z::div ( const double value )

inline

Division operator.

Parameters

value multiplication factor

Returns: this versor

Definition at line 243 of file JVersor3Z.hh.

     {
       __dx /= value;
       __dy /= value;
  
       return *this;
     }

◆ equals()

bool JGEOMETRY3D::JVersor3Z::equals	(	const JVersor3D &	versor,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inline

Check equality.

Parameters

versor	versor
precision	precision

Returns: true if versors are equal; else false

Definition at line 259 of file JVersor3Z.hh.

     {
       return (fabs(getDX() - versor.getDX()) <= precision &&
               fabs(getDY() - versor.getDY()) <= precision);
     }

◆ getDot() [1/4]

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

inline

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 273 of file JVersor3Z.hh.

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

◆ getDot() [2/4]

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

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 288 of file JVersor3Z.hh.

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

◆ getDot() [3/4]

double JGEOMETRY3D::JVersor3Z::getDot ( const JVector3D & pos ) const

inline

Get dot product.

Parameters

pos position

Returns: dot product

Definition at line 303 of file JVersor3Z.hh.

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

◆ getDot() [4/4]

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

inline

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 318 of file JVersor3Z.hh.

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

◆ mul() [2/2]

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

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 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

◆ operator>> [1/2]

std::istream& operator>>	(	std::istream &	in,
		JVersor3Z &	versor
	)

friend

Read versor from input.

Parameters

in	input stream
versor	versor

Returns: input stream

Definition at line 334 of file JVersor3Z.hh.

     {
       return in >> versor.__dx >> versor.__dy;
     }

◆ operator<< [1/2]

std::ostream& operator<<	(	std::ostream &	out,
		const JVersor3Z &	versor
	)

friend

Write versor to output.

Parameters

out	output stream
versor	versor

Returns: output stream

Definition at line 347 of file JVersor3Z.hh.

     {
       return out << versor.getDX() << ' ' << versor.getDY();
     }

◆ operator>> [2/2]

JReader& operator>>	(	JReader &	in,
		JVersor3Z &	versor
	)

friend

Read versor from input.

Parameters

in	reader
versor	versor

Returns: reader

Definition at line 360 of file JVersor3Z.hh.

     {
       return in >> versor.__dx >> versor.__dy;
     }

◆ operator<< [2/2]

JWriter& operator<<	(	JWriter &	out,
		const JVersor3Z &	versor
	)

friend

Write versor to output.

Parameters

out	writer
versor	versor

Returns: writer

Definition at line 373 of file JVersor3Z.hh.

     {
       return out << versor.__dx << versor.__dy;
     }

Member Data Documentation

◆ __dx

double JGEOMETRY3D::JVersor3Z::__dx

protected

Definition at line 379 of file JVersor3Z.hh.

◆ __dy

double JGEOMETRY3D::JVersor3Z::__dy

protected

Definition at line 380 of file JVersor3Z.hh.

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

JVersor3Z.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JVersor3Z() [1/3]

◆ JVersor3Z() [2/3]

◆ JVersor3Z() [3/3]

Member Function Documentation

◆ getDirection() [1/2]

◆ getDirection() [2/2]

◆ setDirection()

◆ operator JAngle3D()

◆ operator JVector3D()

◆ operator JVersor3D()

◆ getDX()

◆ getDY()

◆ getDZ()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ equals()

◆ getDot() [1/4]

◆ getDot() [2/4]

◆ getDot() [3/4]

◆ getDot() [4/4]

◆ mul() [2/2]

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ __dx

◆ __dy