Class describing a generic displacement vector in 2 dimensions.
Class template describing a 2D displacement vector.
This class is templated on the type of Coordinate system. One example is the XYVector which is a vector based on double precision x,y data members by using the ROOT::Math::Cartesian2D<double> Coordinate system. The class is having also an extra template parameter, the coordinate system tag, to be able to identify (tag) vector described in different reference coordinate system, like global or local coordinate systems.
Definition at line 58 of file DisplacementVector2D.h.
Public Types | |
typedef Tag | CoordinateSystemTag |
typedef CoordSystem | CoordinateType |
typedef CoordSystem::Scalar | Scalar |
Public Member Functions | |
constexpr | DisplacementVector2D () |
Default constructor. | |
template<class OtherCoords > | |
constexpr | DisplacementVector2D (const DisplacementVector2D< OtherCoords, Tag > &v) |
Construct from a displacement vector expressed in different coordinates, or using a different Scalar type, but with same coordinate system tag. | |
template<class ForeignVector > | |
constexpr | DisplacementVector2D (const ForeignVector &v) |
Construct from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y() | |
template<class OtherCoords > | |
constexpr | DisplacementVector2D (const PositionVector2D< OtherCoords, Tag > &p) |
Construct from a position vector expressed in different coordinates but with the same coordinate system tag. | |
constexpr | DisplacementVector2D (Scalar a, Scalar b) |
Construct from three values of type Scalar. | |
CoordSystem | Coordinates () const |
Retrieve a copy of the coordinates object. | |
unsigned int | Dimension () const |
Dimension. | |
template<class OtherCoords > | |
Scalar | Dot (const DisplacementVector2D< OtherCoords, Tag > &v) const |
Return the scalar (dot) product of two displacement vectors. | |
template<class OtherVector > | |
Scalar | Dot (const OtherVector &v) const |
Return the scalar (dot) product of two vectors. | |
void | GetCoordinates (Scalar &a, Scalar &b) const |
get internal data into 2 Scalar numbers. | |
Scalar | Mag2 () const |
Magnitute squared ( r^2 in spherical coordinate) | |
Scalar | mag2 () const |
bool | operator!= (const DisplacementVector2D &rhs) const |
DisplacementVector2D | operator* (Scalar a) const |
Multiply a vector by a real number. | |
DisplacementVector2D & | operator*= (Scalar a) |
multiply this vector by a scalar quantity | |
DisplacementVector2D | operator+ () const |
Positive of the vector, return itself. | |
template<class OtherCoords > | |
DisplacementVector2D & | operator+= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Self Addition with a displacement vector. | |
DisplacementVector2D | operator- () const |
Negative of the vector. | |
template<class OtherCoords > | |
DisplacementVector2D & | operator-= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Self Difference with a displacement vector. | |
DisplacementVector2D | operator/ (Scalar a) const |
Division of a vector with a real number. | |
DisplacementVector2D & | operator/= (Scalar a) |
divide this vector by a scalar quantity | |
template<class OtherCoords > | |
DisplacementVector2D & | operator= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Assignment operator from a displacement vector of arbitrary type. | |
template<class ForeignVector > | |
DisplacementVector2D & | operator= (const ForeignVector &v) |
Assignment from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y() | |
template<class OtherCoords > | |
DisplacementVector2D & | operator= (const PositionVector2D< OtherCoords, Tag > &rhs) |
Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian) | |
bool | operator== (const DisplacementVector2D &rhs) const |
Exact equality. | |
Scalar | Phi () const |
Polar phi, converting if necessary from internal coordinate system. | |
Scalar | phi () const |
Scalar | R () const |
Polar R, converting if necessary from internal coordinate system. | |
Scalar | r () const |
void | Rotate (Scalar angle) |
Rotate by an angle. | |
DisplacementVector2D< CoordSystem, Tag > & | SetCoordinates (Scalar a, Scalar b) |
Set internal data based on 2 Scalar numbers. | |
DisplacementVector2D< CoordSystem, Tag > & | SetPhi (Scalar ang) |
Change Phi - Polar2D coordinates. | |
DisplacementVector2D< CoordSystem, Tag > & | SetR (Scalar a) |
Change R - Polar2D coordinates only. | |
DisplacementVector2D< CoordSystem, Tag > & | SetX (Scalar a) |
Change X - Cartesian2D coordinates only. | |
DisplacementVector2D< CoordSystem, Tag > & | SetXY (Scalar a, Scalar b) |
set the values of the vector from the cartesian components (x,y) (if the vector is held in polar coordinates, then (x, y) are converted to that form) | |
DisplacementVector2D< CoordSystem, Tag > & | SetY (Scalar a) |
Change Y - Cartesian2D coordinates only. | |
DisplacementVector2D | Unit () const |
return unit vector parallel to this | |
DisplacementVector2D | unit () const |
Scalar | X () const |
Cartesian X, converting if necessary from internal coordinate system. | |
Scalar | x () const |
Scalar | Y () const |
Cartesian Y, converting if necessary from internal coordinate system. | |
Scalar | y () const |
Private Attributes | |
CoordSystem | fCoordinates |
Static Private Attributes | |
static constexpr unsigned int | fDimension = CoordinateType::Dimension |
#include <Math/GenVector/DisplacementVector2D.h>
typedef Tag ROOT::Math::DisplacementVector2D< CoordSystem, Tag >::CoordinateSystemTag |
Definition at line 64 of file DisplacementVector2D.h.
typedef CoordSystem ROOT::Math::DisplacementVector2D< CoordSystem, Tag >::CoordinateType |
Definition at line 63 of file DisplacementVector2D.h.
typedef CoordSystem::Scalar ROOT::Math::DisplacementVector2D< CoordSystem, Tag >::Scalar |
Definition at line 62 of file DisplacementVector2D.h.
|
inlineconstexpr |
Default constructor.
Construct an empty object with zero values
Definition at line 71 of file DisplacementVector2D.h.
|
inlineconstexpr |
Construct from three values of type Scalar.
In the case of a XYVector the values are x,y In the case of a polar vector they are r, phi
Definition at line 79 of file DisplacementVector2D.h.
|
inlineexplicitconstexpr |
Construct from a displacement vector expressed in different coordinates, or using a different Scalar type, but with same coordinate system tag.
Definition at line 87 of file DisplacementVector2D.h.
|
inlineexplicitconstexpr |
Construct from a position vector expressed in different coordinates but with the same coordinate system tag.
Definition at line 96 of file DisplacementVector2D.h.
|
inlineexplicitconstexpr |
Construct from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y()
Definition at line 105 of file DisplacementVector2D.h.
|
inlineexplicitconstexprprivate |
Definition at line 402 of file DisplacementVector2D.h.
|
inlineexplicitconstexprprivate |
Definition at line 405 of file DisplacementVector2D.h.
|
inline |
Retrieve a copy of the coordinates object.
Definition at line 152 of file DisplacementVector2D.h.
|
private |
|
inline |
Dimension.
Definition at line 202 of file DisplacementVector2D.h.
|
private |
|
inline |
Return the scalar (dot) product of two displacement vectors.
It is possible to perform the product for any type of vector coordinates, but they must have the same coordinate system tag
Definition at line 290 of file DisplacementVector2D.h.
|
inline |
Return the scalar (dot) product of two vectors.
It is possible to perform the product for any classes implementing x() and y() member functions
Definition at line 299 of file DisplacementVector2D.h.
|
inline |
get internal data into 2 Scalar numbers.
These are for example (x,y) for a cartesian vector or (r,phi) for a polar vector
auto const [a, b] = v
. Definition at line 171 of file DisplacementVector2D.h.
|
inline |
Magnitute squared ( r^2 in spherical coordinate)
Definition at line 232 of file DisplacementVector2D.h.
|
inline |
Definition at line 389 of file DisplacementVector2D.h.
|
inline |
Definition at line 193 of file DisplacementVector2D.h.
|
inline |
Multiply a vector by a real number.
Definition at line 348 of file DisplacementVector2D.h.
|
inline |
multiply this vector by a scalar quantity
Definition at line 329 of file DisplacementVector2D.h.
|
inline |
Positive of the vector, return itself.
Definition at line 364 of file DisplacementVector2D.h.
|
private |
|
inline |
Self Addition with a displacement vector.
Definition at line 309 of file DisplacementVector2D.h.
|
inline |
Negative of the vector.
Definition at line 357 of file DisplacementVector2D.h.
|
private |
|
inline |
Self Difference with a displacement vector.
Definition at line 319 of file DisplacementVector2D.h.
|
inline |
Division of a vector with a real number.
Definition at line 369 of file DisplacementVector2D.h.
|
inline |
divide this vector by a scalar quantity
Definition at line 337 of file DisplacementVector2D.h.
|
private |
|
inline |
Assignment operator from a displacement vector of arbitrary type.
Definition at line 118 of file DisplacementVector2D.h.
|
inline |
Assignment from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y()
Definition at line 141 of file DisplacementVector2D.h.
|
private |
|
inline |
Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian)
Definition at line 129 of file DisplacementVector2D.h.
|
inline |
Exact equality.
Definition at line 190 of file DisplacementVector2D.h.
|
inline |
Polar phi, converting if necessary from internal coordinate system.
Definition at line 224 of file DisplacementVector2D.h.
|
inline |
Definition at line 388 of file DisplacementVector2D.h.
|
inline |
Polar R, converting if necessary from internal coordinate system.
Definition at line 218 of file DisplacementVector2D.h.
|
inline |
Definition at line 387 of file DisplacementVector2D.h.
|
inline |
Rotate by an angle.
Definition at line 378 of file DisplacementVector2D.h.
|
inline |
Set internal data based on 2 Scalar numbers.
These are for example (x,y) for a cartesian vector or (r,phi) for a polar vector
Definition at line 160 of file DisplacementVector2D.h.
|
inline |
Change Phi - Polar2D coordinates.
Definition at line 274 of file DisplacementVector2D.h.
|
inline |
Change R - Polar2D coordinates only.
Definition at line 265 of file DisplacementVector2D.h.
|
inline |
Change X - Cartesian2D coordinates only.
Definition at line 248 of file DisplacementVector2D.h.
|
inline |
set the values of the vector from the cartesian components (x,y) (if the vector is held in polar coordinates, then (x, y) are converted to that form)
Definition at line 180 of file DisplacementVector2D.h.
|
inline |
Change Y - Cartesian2D coordinates only.
Definition at line 256 of file DisplacementVector2D.h.
|
inline |
return unit vector parallel to this
Definition at line 238 of file DisplacementVector2D.h.
|
inline |
Definition at line 390 of file DisplacementVector2D.h.
|
inline |
Cartesian X, converting if necessary from internal coordinate system.
Definition at line 207 of file DisplacementVector2D.h.
|
inline |
Definition at line 385 of file DisplacementVector2D.h.
|
inline |
Cartesian Y, converting if necessary from internal coordinate system.
Definition at line 212 of file DisplacementVector2D.h.
|
inline |
Definition at line 386 of file DisplacementVector2D.h.
|
private |
Definition at line 395 of file DisplacementVector2D.h.
|
staticconstexprprivate |
Definition at line 396 of file DisplacementVector2D.h.