ROOT 6.10/09 Reference Guide |
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 56 of file DisplacementVector2D.h.
Public Types | |
typedef Tag | CoordinateSystemTag |
typedef CoordSystem | CoordinateType |
typedef CoordSystem::Scalar | Scalar |
Public Member Functions | |
DisplacementVector2D () | |
Default constructor. More... | |
DisplacementVector2D (Scalar a, Scalar b) | |
Construct from three values of type Scalar. More... | |
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. More... | |
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. More... | |
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() More... | |
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 two displacement vectors. More... | |
template<class OtherVector > | |
Scalar | Dot (const OtherVector &v) const |
Return the scalar (dot) product of two vectors. 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 DisplacementVector2D &rhs) const |
DisplacementVector2D | operator* (Scalar a) const |
Multiply a vector by a real number. More... | |
DisplacementVector2D & | operator*= (Scalar a) |
multiply this vector by a scalar quantity More... | |
DisplacementVector2D | operator+ () const |
Positive of the vector, return itself. More... | |
template<class OtherCoords > | |
DisplacementVector2D & | operator+= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Self Addition with a displacement vector. More... | |
DisplacementVector2D | operator- () const |
Negative of the vector. More... | |
template<class OtherCoords > | |
DisplacementVector2D & | operator-= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Self Difference with a displacement vector. More... | |
DisplacementVector2D | operator/ (Scalar a) const |
Division of a vector with a real number. More... | |
DisplacementVector2D & | operator/= (Scalar a) |
divide this vector by a scalar quantity More... | |
template<class OtherCoords > | |
DisplacementVector2D & | operator= (const DisplacementVector2D< OtherCoords, Tag > &v) |
Assignment operator from a displacement vector of arbitrary type. More... | |
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) More... | |
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() More... | |
bool | operator== (const DisplacementVector2D &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... | |
DisplacementVector2D< CoordSystem, Tag > & | SetCoordinates (Scalar a, Scalar b) |
Set internal data based on 2 Scalar numbers. More... | |
DisplacementVector2D< CoordSystem, Tag > & | SetPhi (Scalar ang) |
Change Phi - Polar2D coordinates. More... | |
DisplacementVector2D< CoordSystem, Tag > & | SetR (Scalar a) |
Change R - Polar2D coordinates only. More... | |
DisplacementVector2D< CoordSystem, Tag > & | SetX (Scalar a) |
Change X - Cartesian2D coordinates only. More... | |
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) More... | |
DisplacementVector2D< CoordSystem, Tag > & | SetY (Scalar a) |
Change Y - Cartesian2D coordinates only. More... | |
DisplacementVector2D | Unit () const |
return unit vector parallel to this More... | |
DisplacementVector2D | unit () const |
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 > | |
DisplacementVector2D (const DisplacementVector2D< OtherCoords, OtherTag > &) | |
template<class OtherCoords , class OtherTag > | |
DisplacementVector2D (const PositionVector2D< OtherCoords, OtherTag > &) | |
template<class OtherCoords , class OtherTag > | |
DisplacementVector2D | Cross (const DisplacementVector2D< OtherCoords, OtherTag > &) const |
template<class OtherCoords , class OtherTag > | |
Scalar | Dot (const DisplacementVector2D< OtherCoords, OtherTag > &) const |
template<class OtherCoords , class OtherTag > | |
DisplacementVector2D & | operator+= (const DisplacementVector2D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
DisplacementVector2D & | operator-= (const DisplacementVector2D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
DisplacementVector2D & | operator= (const DisplacementVector2D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
DisplacementVector2D & | operator= (const PositionVector2D< OtherCoords, OtherTag > &) |
Private Attributes | |
CoordSystem | fCoordinates |
#include <Math/GenVector/DisplacementVector2D.h>
typedef Tag ROOT::Math::DisplacementVector2D< CoordSystem, Tag >::CoordinateSystemTag |
Definition at line 62 of file DisplacementVector2D.h.
typedef CoordSystem ROOT::Math::DisplacementVector2D< CoordSystem, Tag >::CoordinateType |
Definition at line 61 of file DisplacementVector2D.h.
typedef CoordSystem::Scalar ROOT::Math::DisplacementVector2D< CoordSystem, Tag >::Scalar |
Definition at line 60 of file DisplacementVector2D.h.
|
inline |
Default constructor.
Construct an empty object with zero values
Definition at line 69 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 77 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 394 of file DisplacementVector2D.h.
|
inlineexplicitprivate |
Definition at line 397 of file DisplacementVector2D.h.
|
inline |
Retrieve a copy of the coordinates object.
Definition at line 150 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 282 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 291 of file DisplacementVector2D.h.
|
private |
|
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 168 of file DisplacementVector2D.h.
|
inline |
Magnitute squared ( r^2 in spherical coordinate)
Definition at line 224 of file DisplacementVector2D.h.
|
inline |
Definition at line 381 of file DisplacementVector2D.h.
|
inline |
Definition at line 190 of file DisplacementVector2D.h.
|
inline |
Multiply a vector by a real number.
Definition at line 340 of file DisplacementVector2D.h.
|
inline |
multiply this vector by a scalar quantity
Definition at line 321 of file DisplacementVector2D.h.
|
inline |
Positive of the vector, return itself.
Definition at line 356 of file DisplacementVector2D.h.
|
inline |
Self Addition with a displacement vector.
Definition at line 302 of file DisplacementVector2D.h.
|
private |
|
inline |
Negative of the vector.
Definition at line 349 of file DisplacementVector2D.h.
|
inline |
Self Difference with a displacement vector.
Definition at line 312 of file DisplacementVector2D.h.
|
private |
|
inline |
Division of a vector with a real number.
Definition at line 361 of file DisplacementVector2D.h.
|
inline |
divide this vector by a scalar quantity
Definition at line 329 of file DisplacementVector2D.h.
|
inline |
Assignment operator from a displacement vector of arbitrary type.
Definition at line 117 of file DisplacementVector2D.h.
|
inline |
Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian)
Definition at line 128 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 139 of file DisplacementVector2D.h.
|
private |
|
private |
|
inline |
Exact equality.
Definition at line 187 of file DisplacementVector2D.h.
|
inline |
Polar phi, converting if necessary from internal coordinate system.
Definition at line 216 of file DisplacementVector2D.h.
|
inline |
Definition at line 380 of file DisplacementVector2D.h.
|
inline |
Polar R, converting if necessary from internal coordinate system.
Definition at line 210 of file DisplacementVector2D.h.
|
inline |
Definition at line 379 of file DisplacementVector2D.h.
|
inline |
Rotate by an angle.
Definition at line 370 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 158 of file DisplacementVector2D.h.
|
inline |
Change Phi - Polar2D coordinates.
Definition at line 266 of file DisplacementVector2D.h.
|
inline |
Change R - Polar2D coordinates only.
Definition at line 257 of file DisplacementVector2D.h.
|
inline |
Change X - Cartesian2D coordinates only.
Definition at line 240 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 177 of file DisplacementVector2D.h.
|
inline |
Change Y - Cartesian2D coordinates only.
Definition at line 248 of file DisplacementVector2D.h.
|
inline |
return unit vector parallel to this
Definition at line 230 of file DisplacementVector2D.h.
|
inline |
Definition at line 382 of file DisplacementVector2D.h.
|
inline |
Cartesian X, converting if necessary from internal coordinate system.
Definition at line 199 of file DisplacementVector2D.h.
|
inline |
Definition at line 377 of file DisplacementVector2D.h.
|
inline |
Cartesian Y, converting if necessary from internal coordinate system.
Definition at line 204 of file DisplacementVector2D.h.
|
inline |
Definition at line 378 of file DisplacementVector2D.h.
|
private |
Definition at line 387 of file DisplacementVector2D.h.