ROOT 6.13/01 Reference Guide |
Class describing a generic position vector (point) in 2 dimensions.
Class describing a 2D Position vector.
This class is templated on the type of Coordinate system. One example is the XYPoint 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 48 of file PositionVector2D.h.
Public Types | |
typedef Tag | CoordinateSystemTag |
typedef CoordSystem | CoordinateType |
typedef CoordSystem::Scalar | Scalar |
Public Member Functions | |
PositionVector2D () | |
Default constructor. More... | |
PositionVector2D (const Scalar &a, const Scalar &b) | |
Construct from three values of type Scalar. More... | |
template<class T > | |
PositionVector2D (const PositionVector2D< T, Tag > &v) | |
Construct from a position vector expressed in different coordinates, or using a different Scalar type. More... | |
template<class T > | |
PositionVector2D (const DisplacementVector2D< T, Tag > &p) | |
Construct from an arbitrary displacement vector. More... | |
template<class ForeignVector > | |
PositionVector2D (const ForeignVector &v) | |
Construct from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y() More... | |
const CoordSystem & | Coordinates () const |
Retrieve a copy of the coordinates object. More... | |
template<class OtherCoords > | |
Scalar | Dot (const DisplacementVector2D< OtherCoords, Tag > &v) const |
Return the scalar (Dot) product of this with a displacement vector in any coordinate system, but with the same tag. More... | |
void | GetCoordinates (Scalar &a, Scalar &b) const |
get internal data into 2 Scalar numbers. More... | |
Scalar | Mag2 () const |
Magnitute squared ( r^2 in spherical coordinate) More... | |
Scalar | mag2 () const |
bool | operator!= (const PositionVector2D &rhs) const |
PositionVector2D | operator* (Scalar a) const |
Multiply a vector by a real number. More... | |
PositionVector2D & | operator*= (Scalar a) |
multiply this vector by a scalar quantity More... | |
template<class OtherCoords > | |
PositionVector2D & | operator+= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Self Addition with a displacement vector. More... | |
template<class OtherCoords > | |
PositionVector2D & | operator-= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Self Difference with a displacement vector. More... | |
PositionVector2D | operator/ (Scalar a) const |
Division of a vector with a real number. More... | |
PositionVector2D & | operator/= (Scalar a) |
divide this vector by a scalar quantity More... | |
template<class OtherCoords > | |
PositionVector2D & | operator= (const PositionVector2D< OtherCoords, Tag > &v) |
Assignment operator from a position vector of arbitrary type. More... | |
template<class OtherCoords > | |
PositionVector2D & | operator= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Assignment operator from a displacement vector of arbitrary type. More... | |
template<class ForeignVector > | |
PositionVector2D & | operator= (const ForeignVector &v) |
Assignment from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y() More... | |
bool | operator== (const PositionVector2D &rhs) const |
Exact equality. More... | |
Scalar | Phi () const |
Polar phi, converting if necessary from internal coordinate system. More... | |
Scalar | phi () const |
Scalar | R () const |
Polar R, converting if necessary from internal coordinate system. More... | |
Scalar | r () const |
void | Rotate (Scalar angle) |
Rotate by an angle. More... | |
PositionVector2D< CoordSystem, Tag > & | SetCoordinates (Scalar a, Scalar b) |
Set internal data based on 2 Scalar numbers. More... | |
PositionVector2D< CoordSystem, Tag > & | SetPhi (Scalar ang) |
Change Phi - Polar2D coordinates. More... | |
PositionVector2D< CoordSystem, Tag > & | SetR (Scalar a) |
Change R - Polar2D coordinates only. More... | |
PositionVector2D< CoordSystem, Tag > & | SetX (Scalar a) |
Change X - Cartesian2D coordinates only. More... | |
PositionVector2D< 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) More... | |
PositionVector2D< CoordSystem, Tag > & | SetY (Scalar a) |
Change Y - Cartesian2D coordinates only. More... | |
Scalar | X () const |
Cartesian X, converting if necessary from internal coordinate system. More... | |
Scalar | x () const |
Scalar | Y () const |
Cartesian Y, converting if necessary from internal coordinate system. More... | |
Scalar | y () const |
Private Member Functions | |
template<class OtherCoords , class OtherTag > | |
PositionVector2D (const PositionVector2D< OtherCoords, OtherTag > &) | |
template<class OtherCoords , class OtherTag > | |
PositionVector2D (const DisplacementVector2D< OtherCoords, OtherTag > &) | |
template<class OtherCoords , class OtherTag > | |
PositionVector2D & | operator+= (const DisplacementVector2D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector2D & | operator-= (const DisplacementVector2D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector2D & | operator= (const PositionVector2D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
PositionVector2D & | operator= (const DisplacementVector2D< OtherCoords, OtherTag > &) |
Private Attributes | |
CoordSystem | fCoordinates |
#include <Math/GenVector/PositionVector2D.h>
typedef Tag ROOT::Math::PositionVector2D< CoordSystem, Tag >::CoordinateSystemTag |
Definition at line 54 of file PositionVector2D.h.
typedef CoordSystem ROOT::Math::PositionVector2D< CoordSystem, Tag >::CoordinateType |
Definition at line 53 of file PositionVector2D.h.
typedef CoordSystem::Scalar ROOT::Math::PositionVector2D< CoordSystem, Tag >::Scalar |
Definition at line 52 of file PositionVector2D.h.
|
inline |
Default constructor.
Construct an empty object with zero values
Definition at line 62 of file PositionVector2D.h.
|
inline |
Construct from three values of type Scalar.
In the case of a XYPoint the values are x,y In the case of a polar vector they are r,phi
Definition at line 69 of file PositionVector2D.h.
|
inlineexplicit |
Construct from a position vector expressed in different coordinates, or using a different Scalar type.
Definition at line 77 of file PositionVector2D.h.
|
inlineexplicit |
Construct from an arbitrary displacement vector.
Definition at line 84 of file PositionVector2D.h.
|
inlineexplicit |
Construct from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y()
Definition at line 92 of file PositionVector2D.h.
|
explicitprivate |
|
explicitprivate |
|
inline |
Retrieve a copy of the coordinates object.
Definition at line 132 of file PositionVector2D.h.
|
inline |
Return the scalar (Dot) product of this with a displacement vector in any coordinate system, but with the same tag.
Definition at line 251 of file PositionVector2D.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 150 of file PositionVector2D.h.
|
inline |
Magnitute squared ( r^2 in spherical coordinate)
Definition at line 201 of file PositionVector2D.h.
|
inline |
Definition at line 329 of file PositionVector2D.h.
|
inline |
Definition at line 172 of file PositionVector2D.h.
|
inline |
Multiply a vector by a real number.
Definition at line 301 of file PositionVector2D.h.
|
inline |
multiply this vector by a scalar quantity
Definition at line 283 of file PositionVector2D.h.
|
inline |
Self Addition with a displacement vector.
Definition at line 264 of file PositionVector2D.h.
|
private |
|
inline |
Self Difference with a displacement vector.
Definition at line 274 of file PositionVector2D.h.
|
private |
|
inline |
Division of a vector with a real number.
Definition at line 310 of file PositionVector2D.h.
|
inline |
divide this vector by a scalar quantity
Definition at line 291 of file PositionVector2D.h.
|
inline |
Assignment operator from a position vector of arbitrary type.
Definition at line 104 of file PositionVector2D.h.
|
inline |
Assignment operator from a displacement vector of arbitrary type.
Definition at line 114 of file PositionVector2D.h.
|
inline |
Assignment from a foreign 2D vector type, for example, Hep2Vector Precondition: v must implement methods x() and y()
Definition at line 124 of file PositionVector2D.h.
|
private |
|
private |
|
inline |
Exact equality.
Definition at line 169 of file PositionVector2D.h.
|
inline |
Polar phi, converting if necessary from internal coordinate system.
Definition at line 196 of file PositionVector2D.h.
|
inline |
Definition at line 328 of file PositionVector2D.h.
|
inline |
Polar R, converting if necessary from internal coordinate system.
Definition at line 191 of file PositionVector2D.h.
|
inline |
Definition at line 327 of file PositionVector2D.h.
|
inline |
Rotate by an angle.
Definition at line 319 of file PositionVector2D.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 140 of file PositionVector2D.h.
|
inline |
Change Phi - Polar2D coordinates.
Definition at line 237 of file PositionVector2D.h.
|
inline |
Change R - Polar2D coordinates only.
Definition at line 229 of file PositionVector2D.h.
|
inline |
Change X - Cartesian2D coordinates only.
Definition at line 212 of file PositionVector2D.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 159 of file PositionVector2D.h.
|
inline |
Change Y - Cartesian2D coordinates only.
Definition at line 220 of file PositionVector2D.h.
|
inline |
Cartesian X, converting if necessary from internal coordinate system.
Definition at line 181 of file PositionVector2D.h.
|
inline |
Definition at line 325 of file PositionVector2D.h.
|
inline |
Cartesian Y, converting if necessary from internal coordinate system.
Definition at line 186 of file PositionVector2D.h.
|
inline |
Definition at line 326 of file PositionVector2D.h.
|
private |
Definition at line 333 of file PositionVector2D.h.