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 59 of file DisplacementVector2D.h.
Public Types | |
typedef Tag | CoordinateSystemTag |
typedef CoordSystem | CoordinateType |
typedef CoordSystem::Scalar | Scalar |
Public Member Functions | |
DisplacementVector2D () | |
Default constructor. | |
template<class OtherCoords > | |
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 > | |
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 > | |
DisplacementVector2D (const PositionVector2D< OtherCoords, Tag > &p) | |
Construct from a position vector expressed in different coordinates but with the same coordinate system tag. | |
DisplacementVector2D (Scalar a, Scalar b) | |
Construct from three values of type Scalar. | |
CoordSystem | Coordinates () const |
Retrieve a copy of the coordinates object. | |
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 |
#include <MathX/GenVectorX/DisplacementVector2D.h>
typedef Tag ROOT::ROOT_MATH_ARCH::DisplacementVector2D< CoordSystem, Tag >::CoordinateSystemTag |
Definition at line 64 of file DisplacementVector2D.h.
typedef CoordSystem ROOT::ROOT_MATH_ARCH::DisplacementVector2D< CoordSystem, Tag >::CoordinateType |
Definition at line 63 of file DisplacementVector2D.h.
typedef CoordSystem::Scalar ROOT::ROOT_MATH_ARCH::DisplacementVector2D< CoordSystem, Tag >::Scalar |
Definition at line 62 of file DisplacementVector2D.h.
|
inline |
Default constructor.
Construct an empty object with zero values
Definition at line 71 of file DisplacementVector2D.h.
|
inline |
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 78 of file DisplacementVector2D.h.
|
inlineexplicit |
Construct from a displacement vector expressed in different coordinates, or using a different Scalar type, but with same coordinate system tag.
Definition at line 85 of file DisplacementVector2D.h.
|
inlineexplicit |
Construct from a position vector expressed in different coordinates but with the same coordinate system tag.
Definition at line 94 of file DisplacementVector2D.h.
|
inlineexplicit |
Construct from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y()
Definition at line 103 of file DisplacementVector2D.h.
|
inlineexplicitprivate |
Definition at line 377 of file DisplacementVector2D.h.
|
inlineexplicitprivate |
Definition at line 382 of file DisplacementVector2D.h.
|
inline |
Retrieve a copy of the coordinates object.
Definition at line 148 of file DisplacementVector2D.h.
|
private |
|
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 270 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 280 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
Definition at line 164 of file DisplacementVector2D.h.
|
inline |
Magnitute squared ( r^2 in spherical coordinate)
Definition at line 212 of file DisplacementVector2D.h.
|
inline |
Definition at line 367 of file DisplacementVector2D.h.
|
inline |
Definition at line 183 of file DisplacementVector2D.h.
|
inline |
Multiply a vector by a real number.
Definition at line 329 of file DisplacementVector2D.h.
|
inline |
multiply this vector by a scalar quantity
Definition at line 308 of file DisplacementVector2D.h.
|
inline |
Positive of the vector, return itself.
Definition at line 344 of file DisplacementVector2D.h.
|
private |
|
inline |
Self Addition with a displacement vector.
Definition at line 289 of file DisplacementVector2D.h.
|
inline |
Negative of the vector.
Definition at line 339 of file DisplacementVector2D.h.
|
private |
|
inline |
Self Difference with a displacement vector.
Definition at line 299 of file DisplacementVector2D.h.
|
inline |
Division of a vector with a real number.
Definition at line 349 of file DisplacementVector2D.h.
|
inline |
divide this vector by a scalar quantity
Definition at line 317 of file DisplacementVector2D.h.
|
private |
|
inline |
Assignment operator from a displacement vector of arbitrary type.
Definition at line 115 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 137 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 126 of file DisplacementVector2D.h.
|
inline |
Exact equality.
Definition at line 182 of file DisplacementVector2D.h.
|
inline |
Polar phi, converting if necessary from internal coordinate system.
Definition at line 205 of file DisplacementVector2D.h.
|
inline |
Definition at line 366 of file DisplacementVector2D.h.
|
inline |
Polar R, converting if necessary from internal coordinate system.
Definition at line 200 of file DisplacementVector2D.h.
|
inline |
Definition at line 365 of file DisplacementVector2D.h.
|
inline |
Rotate by an angle.
Definition at line 359 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 154 of file DisplacementVector2D.h.
|
inline |
Change Phi - Polar2D coordinates.
Definition at line 255 of file DisplacementVector2D.h.
|
inline |
Change R - Polar2D coordinates only.
Definition at line 246 of file DisplacementVector2D.h.
|
inline |
Change X - Cartesian2D coordinates only.
Definition at line 228 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 171 of file DisplacementVector2D.h.
|
inline |
Change Y - Cartesian2D coordinates only.
Definition at line 237 of file DisplacementVector2D.h.
|
inline |
return unit vector parallel to this
Definition at line 217 of file DisplacementVector2D.h.
|
inline |
Definition at line 368 of file DisplacementVector2D.h.
|
inline |
Cartesian X, converting if necessary from internal coordinate system.
Definition at line 190 of file DisplacementVector2D.h.
|
inline |
Definition at line 363 of file DisplacementVector2D.h.
|
inline |
Cartesian Y, converting if necessary from internal coordinate system.
Definition at line 195 of file DisplacementVector2D.h.
|
inline |
Definition at line 364 of file DisplacementVector2D.h.
|
private |
Definition at line 371 of file DisplacementVector2D.h.