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

#include <JAngle2D.hh>

Inheritance diagram for JGEOMETRY2D::JAngle2D:

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

	JAngle2D (const double phi)
	Constructor. More...

	JAngle2D (const double x, const double y)
	Constructor. More...

double	getPhi () const
	Get phi angle. More...

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

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

JAngle2D &	negate ()
	Negate angle. More...

JAngle2D &	add (const JAngle2D &angle)
	Add angle. More...

JAngle2D &	sub (const JAngle2D &angle)
	Subtract angle. More...

JAngle2D &	mul (const double factor)
	Scale angle. More...

JAngle2D &	div (const double factor)
	Scale angle. More...

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

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

JAngle2D &	normalise ()
	Normalise angle. More...

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

Protected Attributes
double	__phi

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

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

JReader &	operator>> (JReader &in, JAngle2D &angle)
	Read angle from input. More...

JWriter &	operator<< (JWriter &out, const JAngle2D &angle)
	Write angle to output. More...

Detailed Description

Data structure for angle in two dimensions.

This class serves as input to the rotation matrix JRotation2D.

Definition at line 31 of file JAngle2D.hh.

Constructor & Destructor Documentation

◆ JAngle2D() [1/3]

JGEOMETRY2D::JAngle2D::JAngle2D ( )

inline

Default constructor.

Definition at line 38 of file JAngle2D.hh.

                :
       __phi(0.0)
     {}

◆ JAngle2D() [2/3]

JGEOMETRY2D::JAngle2D::JAngle2D ( const double phi )

inline

Constructor.

Parameters

phi	phi angle [rad]

Definition at line 48 of file JAngle2D.hh.

                                :
       __phi(phi)
     {}

◆ JAngle2D() [3/3]

JGEOMETRY2D::JAngle2D::JAngle2D	(	const double	x,
		const double	y
	)

inline

Constructor.

Parameters

x	x value
y	y value

Definition at line 59 of file JAngle2D.hh.

                              :
       __phi(atan2(y,x))
     {}

Member Function Documentation

◆ getPhi()

double JGEOMETRY2D::JAngle2D::getPhi ( ) const

inline

Get phi angle.

Returns: phi angle

Definition at line 70 of file JAngle2D.hh.

     { 
       return __phi;
     }

◆ getDX()

double JGEOMETRY2D::JAngle2D::getDX ( ) const

inline

Get x direction.

Returns: x direction

Definition at line 81 of file JAngle2D.hh.

     { 
       return cos(__phi);
     }

◆ getDY()

double JGEOMETRY2D::JAngle2D::getDY ( ) const

inline

Get y direction.

Returns: y direction

Definition at line 92 of file JAngle2D.hh.

     { 
       return sin(__phi);
     }

◆ negate()

JAngle2D& JGEOMETRY2D::JAngle2D::negate ( )

inline

Negate angle.

Returns: this angle

Definition at line 103 of file JAngle2D.hh.

     {
       __phi = -__phi;
  
       return *this;
     }

◆ add()

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

inline

Add angle.

Parameters

angle angle

Returns: this angle

Definition at line 117 of file JAngle2D.hh.

     {
       __phi += angle.getPhi();
  
       return *this;
     }

◆ sub()

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

inline

Subtract angle.

Parameters

angle angle

Returns: this angle

Definition at line 131 of file JAngle2D.hh.

     {
       __phi -= angle.getPhi();
  
       return *this;
     }

◆ mul() [1/2]

JAngle2D& JGEOMETRY2D::JAngle2D::mul ( const double factor )

inline

Scale angle.

Parameters

factor multiplication factor

Returns: this angle

Definition at line 145 of file JAngle2D.hh.

     {
       __phi *= factor;
  
       return *this;
     }

◆ div()

JAngle2D& JGEOMETRY2D::JAngle2D::div ( const double factor )

inline

Scale angle.

Parameters

factor division factor

Returns: this angle

Definition at line 159 of file JAngle2D.hh.

     {
       __phi /= factor;
  
       return *this;
     }

◆ equals()

bool JGEOMETRY2D::JAngle2D::equals	(	const JAngle2D &	angle,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inline

Check equality.

Parameters

angle angle

Returns: true if angles are equal; else false

Definition at line 173 of file JAngle2D.hh.

     {
       return fabs(getPhi()   - angle.getPhi())   <= precision;
     }

◆ getDot()

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

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 186 of file JAngle2D.hh.

     {
       return cos(getPhi() - angle.getPhi());
     }

◆ normalise()

JAngle2D& JGEOMETRY2D::JAngle2D::normalise ( )

inline

Normalise angle.

phi angle will be between 0 and 2π

Returns: this angle

Definition at line 199 of file JAngle2D.hh.

     {
       using JTOOLS::PI;
  
       if (__phi > 2*PI) { do { __phi -= 2*PI; } while (__phi > 2*PI); }
       if (__phi < 0.0)  { do { __phi += 2*PI; } while (__phi < 0.0); }
  
       return *this;
     }

◆ mul() [2/2]

JAngle2D & JMATH::JMath< JAngle2D , 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,
		JAngle2D &	angle
	)

friend

Read angle from input.

Parameters

in	input stream
angle	angle

Returns: input stream

Definition at line 217 of file JAngle2D.hh.

     {
       return in >> angle.__phi;
     }

◆ operator<< [1/2]

std::ostream& operator<<	(	std::ostream &	out,
		const JAngle2D &	angle
	)

friend

Write angle to output.

Parameters

out	output stream
angle	angle

Returns: output stream

Definition at line 230 of file JAngle2D.hh.

     {
       return out << angle.getPhi();
     }

◆ operator>> [2/2]

JReader& operator>>	(	JReader &	in,
		JAngle2D &	angle
	)

friend

Read angle from input.

Parameters

in	reader
angle	angle

Returns: reader

Definition at line 243 of file JAngle2D.hh.

     {
       return in >> angle.__phi;
     }

◆ operator<< [2/2]

JWriter& operator<<	(	JWriter &	out,
		const JAngle2D &	angle
	)

friend

Write angle to output.

Parameters

out	writer
angle	angle

Returns: writer

Definition at line 256 of file JAngle2D.hh.

     {
       return out << angle.__phi;
     }

Member Data Documentation

◆ __phi

double JGEOMETRY2D::JAngle2D::__phi

protected

Definition at line 262 of file JAngle2D.hh.

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

JAngle2D.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JAngle2D() [1/3]

◆ JAngle2D() [2/3]

◆ JAngle2D() [3/3]

Member Function Documentation

◆ getPhi()

◆ getDX()

◆ getDY()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ equals()

◆ getDot()

◆ normalise()

◆ mul() [2/2]

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ __phi