JGEOMETRY3D::JVersor3D Class Reference

Data structure for normalised vector in three dimensions. More...

#include <JVersor3D.hh>

Inheritance diagram for JGEOMETRY3D::JVersor3D:

Public Member Functions
	JVersor3D ()
	Default constructor. More...
	JVersor3D (const double dx, const double dy, const double dz)
	Constructor. More...
JVersor3D &	negate ()
	Negate versor. More...
bool	equals (const JVersor3D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...
double	getDX () const
	Get x direction. More...
double	getDY () const
	Get y direction. More...
double	getDZ () const
	Get z direction. More...
double	getTheta () const
	Get theta angle. More...
double	getPhi () const
	Get phi angle. More...
double	getDot (const JVersor3D &versor) const
	Get dot product. More...
JVersor3D &	getCross (const JVersor3D &first, const JVersor3D &second)
	Get cross product. More...
JVersor3D &	normalise ()
	Normalise versor. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Protected Attributes
double	__dx
double	__dy
double	__dz

Detailed Description

Data structure for normalised vector in three dimensions.

Definition at line 26 of file JVersor3D.hh.

Constructor & Destructor Documentation

JGEOMETRY3D::JVersor3D::JVersor3D ( )

inline

Default constructor.

This constructor yields a unit z-vector.

Definition at line 34 of file JVersor3D.hh.

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

JGEOMETRY3D::JVersor3D::JVersor3D ( const double  dx, const double  dy, const double  dz  )

inline

Constructor.

Parameters

dx	dx value
dy	dy value
dz	dz value

Definition at line 48 of file JVersor3D.hh.

                               :
      __dx(dx),
      __dy(dy),
      __dz(dz)
    {
      normalise();
    }

Member Function Documentation

JVersor3D& JGEOMETRY3D::JVersor3D::negate ( )

inline

Negate versor.

Returns

this versor

Definition at line 64 of file JVersor3D.hh.

    {
      __dx = -__dx;
      __dy = -__dy;
      __dz = -__dz;

      return *this;
    }

bool JGEOMETRY3D::JVersor3D::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 81 of file JVersor3D.hh.

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

double JGEOMETRY3D::JVersor3D::getDX ( ) const

inline

Get x direction.

Returns

x direction

Definition at line 95 of file JVersor3D.hh.

    {
      return __dx;
    }

double JGEOMETRY3D::JVersor3D::getDY ( ) const

inline

Get y direction.

Returns

y direction

Definition at line 106 of file JVersor3D.hh.

    {
      return __dy;
    }

double JGEOMETRY3D::JVersor3D::getDZ ( ) const

inline

Get z direction.

Returns

z direction

Definition at line 117 of file JVersor3D.hh.

    {
      return __dz;
    }

double JGEOMETRY3D::JVersor3D::getTheta ( ) const

inline

Get theta angle.

Returns

theta angle [rad]

Definition at line 128 of file JVersor3D.hh.

    {
      if      (__dz > +1.0)
        return 0.0;
      else if (__dz < -1.0)
        return JMATH::PI;
      else
        return acos(__dz);
    }

double JGEOMETRY3D::JVersor3D::getPhi ( ) const

inline

Get phi angle.

Returns

phi angle [rad]

Definition at line 144 of file JVersor3D.hh.

    { 
      return atan2(__dy, __dx);
    }

double JGEOMETRY3D::JVersor3D::getDot ( const JVersor3D &  versor ) const

inline

Get dot product.

Parameters

versor

versor

Returns

dot product

Definition at line 156 of file JVersor3D.hh.

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

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

inline

Get cross product.

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

Parameters

first	first versor
second	second versor

Returns

this versor

Definition at line 173 of file JVersor3D.hh.

    {
      __dx = first .getDY() * second.getDZ()  -  second.getDY() * first .getDZ();
      __dy = second.getDX() * first .getDZ()  -  first .getDX() * second.getDZ();
      __dz = first .getDX() * second.getDY()  -  second.getDX() * first .getDY();

      normalise();

      return *this;
    }

JVersor3D& JGEOMETRY3D::JVersor3D::normalise ( )

inline

Normalise versor.

This operation may set the result to the unit z-vector.

Returns

this versor

Definition at line 192 of file JVersor3D.hh.

    {
      const double v = sqrt(getDX()*getDX() + getDY()*getDY() + getDZ()*getDZ());

      if (v != 0.0) {
        __dx /= v;
        __dy /= v;
        __dz /= v;
      }

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

Member Data Documentation

double JGEOMETRY3D::JVersor3D::__dx

protected

Definition at line 206 of file JVersor3D.hh.

double JGEOMETRY3D::JVersor3D::__dy

protected

Definition at line 207 of file JVersor3D.hh.

double JGEOMETRY3D::JVersor3D::__dz

protected

Definition at line 208 of file JVersor3D.hh.

---

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

• JVersor3D.hh