JGEOMETRY2D::JDirection2D Class Reference

Data structure for direction in two dimensions. More...

#include <JDirection2D.hh>

Inheritance diagram for JGEOMETRY2D::JDirection2D:

Public Member Functions
	JDirection2D ()
	Default constructor.
	JDirection2D (const JVersor2D &dir)
	Constructor.
	JDirection2D (const JAngle2D &angle)
	Constructor.
	JDirection2D (const JVector2D &pos)
	Constructor.
	JDirection2D (const double dx, const double dy)
	Constructor.
const JDirection2D &	getDirection () const
	Get direction.
JDirection2D &	getDirection ()
	Get direction.
void	setDirection (const JDirection2D &dir)
	Set direction.
	operator JAngle2D () const
	Type conversion operator.
	operator JVector2D () const
	Type conversion operator.
JDirection2D &	transform (const JMatrix2D &T)
	Transform.
JDirection2D &	rotate (const JRotation2D &R)
	Rotate.
JDirection2D &	rotate_back (const JRotation2D &R)
	Rotate back.
double	getDot (const JAngle2D &angle) const
	Get dot product.
double	getDot (const JVector2D &pos) const
	Get dot product.
double	getPerpDot (const JAngle2D &angle) const
	Get perpendicular dot product.
double	getPerpDot (const JVector2D &pos) const
	Get perpendicular dot product.
double	getDot (const JVersor2D &versor) const
	Get dot product.
double	getPerpDot (const JVersor2D &versor) const
	Get perpendicular dot product.
double	getDX () const
	Get x direction.
double	getDY () const
	Get y direction.
double	getPhi () const
	Get phi angle.
JVersor2D &	negate ()
	Negate versor.
bool	equals (const JVersor2D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality.
JVersor2D &	normalise ()
	Normalise versor.

Protected Attributes
double	__dx
double	__dy

Friends
std::istream &	operator>> (std::istream &in, JDirection2D &direction)
	Read direction from input.
std::ostream &	operator<< (std::ostream &out, const JDirection2D &direction)
	Write direction to output.
JReader &	operator>> (JReader &in, JDirection2D &direction)
	Read direction from input.
JWriter &	operator<< (JWriter &out, const JDirection2D &direction)
	Write direction to output.

Detailed Description

Data structure for direction in two dimensions.

Definition at line 31 of file JDirection2D.hh.

Constructor & Destructor Documentation

JDirection2D() [1/5]

JGEOMETRY2D::JDirection2D::JDirection2D ( )

inline

Default constructor.

Definition at line 43 of file JDirection2D.hh.

                   :
      JVersor2D()
    {}

JDirection2D() [2/5]

JGEOMETRY2D::JDirection2D::JDirection2D ( const JVersor2D & dir )

inline

Constructor.

Parameters

dir

direction

Definition at line 53 of file JDirection2D.hh.

                                       :
      JVersor2D(dir.getDY(), dir.getDX())
    {}

JDirection2D() [3/5]

JGEOMETRY2D::JDirection2D::JDirection2D ( const JAngle2D & angle )

inline

Constructor.

Parameters

angle

angle

Definition at line 63 of file JDirection2D.hh.

                                        :
      JVersor2D(angle.getDX(), angle.getDY())
    {}

JDirection2D() [4/5]

JGEOMETRY2D::JDirection2D::JDirection2D ( const JVector2D & pos )

inline

Constructor.

Parameters

pos

position

Definition at line 73 of file JDirection2D.hh.

                                       :
      JVersor2D(pos.getY(),pos.getX())
    {}

JDirection2D() [5/5]

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

inline

Constructor.

Parameters

dx	dx value
dy	dy value

Definition at line 84 of file JDirection2D.hh.

                                  :
      JVersor2D(dx, dy)
    {}

Member Function Documentation

getDirection() [1/2]

const JDirection2D & JGEOMETRY2D::JDirection2D::getDirection ( ) const

inline

Get direction.

Returns

direction

Definition at line 95 of file JDirection2D.hh.

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

getDirection() [2/2]

JDirection2D & JGEOMETRY2D::JDirection2D::getDirection ( )

inline

Get direction.

Returns

direction

Definition at line 106 of file JDirection2D.hh.

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

setDirection()

void JGEOMETRY2D::JDirection2D::setDirection ( const JDirection2D & dir )

inline

Set direction.

Parameters

dir

direction

Definition at line 117 of file JDirection2D.hh.

    {
      static_cast<JDirection2D&>(*this) = dir;
    }

operator JAngle2D()

JGEOMETRY2D::JDirection2D::operator JAngle2D ( ) const

inline

Type conversion operator.

Returns

angle

Definition at line 128 of file JDirection2D.hh.

    {
      return JAngle2D(getDX(), getDY());
    }

operator JVector2D()

JGEOMETRY2D::JDirection2D::operator JVector2D ( ) const

inline

Type conversion operator.

Returns

position

Definition at line 139 of file JDirection2D.hh.

    {
      return JVector2D(getDX(), getDY());
    }

transform()

JDirection2D & JGEOMETRY2D::JDirection2D::transform ( const JMatrix2D & T )

inline

Transform.

Parameters

T

matrix

Returns

this direction

Definition at line 151 of file JDirection2D.hh.

    {
      T.transform(__dx, __dy);
 
      normalise();
 
      return *this;
    }

rotate()

JDirection2D & JGEOMETRY2D::JDirection2D::rotate ( const JRotation2D & R )

inline

Rotate.

Parameters

R	rotation matrix

Returns

this direction

Definition at line 167 of file JDirection2D.hh.

    {
      R.rotate(__dx, __dy);
 
      normalise();
 
      return *this;
    }

rotate_back()

JDirection2D & JGEOMETRY2D::JDirection2D::rotate_back ( const JRotation2D & R )

inline

Rotate back.

Parameters

R	rotation matrix

Returns

this direction

Definition at line 183 of file JDirection2D.hh.

    {
      R.rotate_back(__dx, __dy);
 
      normalise();
 
      return *this;
    }

getDot() [1/3]

double JGEOMETRY2D::JDirection2D::getDot ( const JAngle2D & angle ) const

inline

Get dot product.

Parameters

angle

angle

Returns

dot product

Definition at line 199 of file JDirection2D.hh.

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

getDot() [2/3]

double JGEOMETRY2D::JDirection2D::getDot ( const JVector2D & pos ) const

inline

Get dot product.

Parameters

pos

position

Returns

dot product

Definition at line 213 of file JDirection2D.hh.

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

getPerpDot() [1/3]

double JGEOMETRY2D::JDirection2D::getPerpDot ( const JAngle2D & angle ) const

inline

Get perpendicular dot product.

Parameters

angle

angle

Returns

perpendicular dot product

Definition at line 227 of file JDirection2D.hh.

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

getPerpDot() [2/3]

double JGEOMETRY2D::JDirection2D::getPerpDot ( const JVector2D & pos ) const

inline

Get perpendicular dot product.

Parameters

pos

position

Returns

perpendicular dot product

Definition at line 241 of file JDirection2D.hh.

    {
      return
        getDX() * pos.getY() -
        getDY() * pos.getX();
    }

getDot() [3/3]

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

getPerpDot() [3/3]

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

getDX()

double JGEOMETRY2D::JVersor2D::getDX ( ) const

inlineinherited

Get x direction.

Returns

x direction

Definition at line 53 of file JVersor2D.hh.

    {
      return __dx;
    }

getDY()

double JGEOMETRY2D::JVersor2D::getDY ( ) const

inlineinherited

Get y direction.

Returns

y direction

Definition at line 64 of file JVersor2D.hh.

    {
      return __dy;
    }

getPhi()

double JGEOMETRY2D::JVersor2D::getPhi ( ) const

inlineinherited

Get phi angle.

Returns

phi angle [rad]

Definition at line 75 of file JVersor2D.hh.

    { 
      return atan2(__dy, __dx);
    }

negate()

JVersor2D & JGEOMETRY2D::JVersor2D::negate ( )

inlineinherited

Negate versor.

Returns

this versor

Definition at line 86 of file JVersor2D.hh.

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

equals()

bool JGEOMETRY2D::JVersor2D::equals ( const JVersor2D & versor, const double precision = std::numeric_limits<double>::min() ) const

inlineinherited

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

normalise()

JVersor2D & JGEOMETRY2D::JVersor2D::normalise ( )

inlineinherited

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

Friends And Related Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JDirection2D & direction )

friend

Read direction from input.

Parameters

in	input stream
direction	direction

Returns

input stream

Definition at line 256 of file JDirection2D.hh.

    {
      in >> direction.__dx >> direction.__dy;
 
      direction.normalise();
 
      return in;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JDirection2D & direction )

friend

Write direction to output.

Parameters

out	output stream
direction	direction

Returns

output stream

Definition at line 273 of file JDirection2D.hh.

    {
      const JFormat format(out, getFormat<JDirection2D>(JFormat_t(9, 6, std::ios::fixed | std::ios::showpos)));
 
      out << format << direction.getDX() << ' ' 
          << format << direction.getDY();
 
      return out;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JDirection2D & direction )

friend

Read direction from input.

Parameters

in	reader
direction	direction

Returns

reader

Definition at line 291 of file JDirection2D.hh.

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

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JDirection2D & direction )

friend

Write direction to output.

Parameters

out	writer
direction	direction

Returns

writer

Definition at line 307 of file JDirection2D.hh.

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

Member Data Documentation

__dx

double JGEOMETRY2D::JVersor2D::__dx

protectedinherited

Definition at line 160 of file JVersor2D.hh.

__dy

double JGEOMETRY2D::JVersor2D::__dy

protectedinherited

Definition at line 161 of file JVersor2D.hh.

---

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

• JDirection2D.hh