ant::vec2 Struct Reference

#include <vec2.h>

Public Member Functions
constexpr	vec2 () noexcept=default
constexpr	vec2 (const vec2 &) noexcept=default
constexpr	vec2 (vec2 &&) noexcept=default
constexpr	vec2 (const double X, const double Y) noexcept
vec2 &	operator= (const vec2 &) noexcept=default
vec2 &	operator= (vec2 &&) noexcept=default
	vec2 (const TVector2 &v) noexcept
vec2 &	operator= (const TVector2 &v) noexcept
	operator TVector2 () const noexcept
vec2 &	operator+= (const vec2 &other) noexcept
vec2 &	operator-= (const vec2 &other) noexcept
vec2	operator+ (const vec2 &other) const noexcept
vec2	operator- (const vec2 &other) const noexcept
vec2 &	operator*= (const double s) noexcept
vec2 &	operator/= (const double s) noexcept
vec2	operator* (const double s) const noexcept
vec2	operator/ (const double s) const noexcept
double	R2 () const noexcept
	Get the length or radius squared. More...
double	R () const noexcept
	Get the length or Radius of the vector. More...
double	Angle (const vec2 &other) const
	Calcualte the angle between two vec2. More...
double	Dot (const vec2 &other) const noexcept
	Dot product. More...
double	Phi () const
	Phi angle. More...
vec2	Unit () const noexcept
	vector parallel to this one with R() == 1.0 More...
bool	operator== (const vec2 &other) const noexcept
bool	operator!= (const vec2 &other) const noexcept

Static Public Member Functions
static vec2	RPhi (const double r, const double phi) noexcept
	Create vec2 from Radius and Angle. More...
static double	Phi_mpi_pi (double phi)
	Phi_mpi_pi returns phi angle in interval [-pi,pi) More...

Public Attributes
double	x = {}
double	y = {}

Constructor & Destructor Documentation

vec2() [1/5]

constexpr ant::vec2::vec2 ( )

defaultnoexcept

vec2() [2/5]

constexpr ant::vec2::vec2 ( const vec2 &  )

defaultnoexcept

vec2() [3/5]

constexpr ant::vec2::vec2 ( vec2 &&  )

defaultnoexcept

vec2() [4/5]

constexpr ant::vec2::vec2 ( const double  X, const double  Y  )

inlinenoexcept

vec2() [5/5]

vec2::vec2 ( const TVector2 &  v )

noexcept

Member Function Documentation

Angle()

double ant::vec2::Angle ( const vec2 &  other ) const

inline

Calcualte the angle between two vec2.

Parameters

other

Returns

angle in radians

Taken from ROOT TVector3

Dot()

double ant::vec2::Dot ( const vec2 &  other ) const

inlinenoexcept

Dot product.

Parameters

other

Returns

operator TVector2()

vec2::operator TVector2 ( ) const

noexcept

operator!=()

bool ant::vec2::operator!= ( const vec2 &  other ) const

inlinenoexcept

operator*()

vec2 ant::vec2::operator* ( const double  s ) const

inlinenoexcept

operator*=()

vec2& ant::vec2::operator*= ( const double  s )

inlinenoexcept

operator+()

vec2 ant::vec2::operator+ ( const vec2 &  other ) const

inlinenoexcept

operator+=()

vec2& ant::vec2::operator+= ( const vec2 &  other )

inlinenoexcept

operator-()

vec2 ant::vec2::operator- ( const vec2 &  other ) const

inlinenoexcept

operator-=()

vec2& ant::vec2::operator-= ( const vec2 &  other )

inlinenoexcept

operator/()

vec2 ant::vec2::operator/ ( const double  s ) const

inlinenoexcept

operator/=()

vec2& ant::vec2::operator/= ( const double  s )

inlinenoexcept

operator=() [1/3]

vec2& ant::vec2::operator= ( const vec2 &  )

defaultnoexcept

operator=() [2/3]

vec2& ant::vec2::operator= ( vec2 &&  )

defaultnoexcept

operator=() [3/3]

vec2 & vec2::operator= ( const TVector2 &  v )

noexcept

operator==()

bool ant::vec2::operator== ( const vec2 &  other ) const

inlinenoexcept

Phi()

double ant::vec2::Phi ( ) const

inline

Phi angle.

Returns

radians

Phi_mpi_pi()

static double ant::vec2::Phi_mpi_pi ( double  phi )

inlinestatic

Phi_mpi_pi returns phi angle in interval [-pi,pi)

Parameters

phi

Returns

Note

copied from TVector2::Phi_mpi_pi

R()

double ant::vec2::R ( ) const

inlinenoexcept

Get the length or Radius of the vector.

Returns

length

See also

R2()

R2()

double ant::vec2::R2 ( ) const

inlinenoexcept

Get the length or radius squared.

Returns

See also

R()

RPhi()

static vec2 ant::vec2::RPhi ( const double  r, const double  phi  )

inlinestaticnoexcept

Create vec2 from Radius and Angle.

Parameters

r	Radius
phi	Angle in radians

Returns

new vec2

Unit()

vec2 ant::vec2::Unit ( ) const

inlinenoexcept

vector parallel to this one with R() == 1.0

Returns

unit length vector

Member Data Documentation

x

double ant::vec2::x = {}

y

double ant::vec2::y = {}

---

The documentation for this struct was generated from the following files:

• src/base/vec/vec2.h
• src/base/vec/vec2.cc