JGEOMETRY2D::JVersor2D Class Reference

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

#include <JVersor2D.hh>

Inheritance diagram for JGEOMETRY2D::JVersor2D:

Public Member Functions
	JVersor2D ()
	Default constructor. More...
	JVersor2D (const double dx, const double dy)
	Constructor. More...
double	getDX () const
	Get x direction. More...
double	getDY () const
	Get y direction. More...
double	getPhi () const
	Get phi angle. More...
JVersor2D &	negate ()
	Negate versor. More...
bool	equals (const JVersor2D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...
double	getDot (const JVersor2D &versor) const
	Get dot product. More...
double	getPerpDot (const JVersor2D &versor) const
	Get perpendicular dot product. More...
JVersor2D &	normalise ()
	Normalise versor. More...

Protected Attributes
double	__dx
double	__dy

Detailed Description

Data structure for normalised vector in two dimensions.

Definition at line 20 of file JVersor2D.hh.

Constructor & Destructor Documentation

JGEOMETRY2D::JVersor2D::JVersor2D ( )

inline

Default constructor.

This constructor yields a unit y-vector.

Definition at line 27 of file JVersor2D.hh.

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

JGEOMETRY2D::JVersor2D::JVersor2D ( const double  dx, const double  dy  )

inline

Constructor.

Parameters

dx	dx value
dy	dy value

Definition at line 39 of file JVersor2D.hh.

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

Member Function Documentation

double JGEOMETRY2D::JVersor2D::getDX ( ) const

inline

Get x direction.

Returns

x direction

Definition at line 53 of file JVersor2D.hh.

    {
      return __dx;
    }

double JGEOMETRY2D::JVersor2D::getDY ( ) const

inline

Get y direction.

Returns

y direction

Definition at line 64 of file JVersor2D.hh.

    {
      return __dy;
    }

double JGEOMETRY2D::JVersor2D::getPhi ( ) const

inline

Get phi angle.

Returns

phi angle [rad]

Definition at line 75 of file JVersor2D.hh.

    { 
      return atan2(__dy, __dx);
    }

JVersor2D& JGEOMETRY2D::JVersor2D::negate ( )

inline

Negate versor.

Returns

this versor

Definition at line 86 of file JVersor2D.hh.

    {
      __dx = -__dx;
      __dy = -__dy;

      return *this;
    }

bool JGEOMETRY2D::JVersor2D::equals ( const JVersor2D &  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 102 of file JVersor2D.hh.

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

double JGEOMETRY2D::JVersor2D::getDot ( const JVersor2D &  versor ) const

inline

Get dot product.

Parameters

versor

versor

Returns

dot product

Definition at line 116 of file JVersor2D.hh.

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

double JGEOMETRY2D::JVersor2D::getPerpDot ( const JVersor2D &  versor ) const

inline

Get perpendicular dot product.

Parameters

versor

versor

Returns

perpendicular dot product

Definition at line 130 of file JVersor2D.hh.

    {
      return
        getDX() * versor.getDY() - 
        getDY() * versor.getDX();
    }

JVersor2D& JGEOMETRY2D::JVersor2D::normalise ( )

inline

Normalise versor.

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

Returns

this versor

Definition at line 144 of file JVersor2D.hh.

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

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

      return *this;
    }

Member Data Documentation

double JGEOMETRY2D::JVersor2D::__dx

protected

Definition at line 160 of file JVersor2D.hh.

double JGEOMETRY2D::JVersor2D::__dy

protected

Definition at line 161 of file JVersor2D.hh.

---

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

• JVersor2D.hh