ROOT 6.08/07 Reference Guide |
Class describing a generic displacement vector in 3 dimensions.
Class template describing a 3D displacement vector.
This class is templated on the type of Coordinate system. One example is the XYZVector which is a vector based on double precision x,y,z data members by using the ROOT::Math::Cartesian3D<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 77 of file DisplacementVector3D.h.
Public Types | |
typedef Tag | CoordinateSystemTag |
typedef CoordSystem | CoordinateType |
typedef CoordSystem::Scalar | Scalar |
Public Member Functions | |
DisplacementVector3D () | |
Default constructor. More... | |
DisplacementVector3D (Scalar a, Scalar b, Scalar c) | |
Construct from three values of type Scalar. More... | |
template<class OtherCoords > | |
DisplacementVector3D (const DisplacementVector3D< 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 > | |
DisplacementVector3D (const PositionVector3D< OtherCoords, Tag > &p) | |
Construct from a position vector expressed in different coordinates but with the same coordinate system tag. More... | |
template<class ForeignVector > | |
DisplacementVector3D (const ForeignVector &v) | |
Construct from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z() More... | |
CoordSystem | Coordinates () const |
Retrieve a copy of the coordinates object. More... | |
template<class OtherCoords > | |
DisplacementVector3D | Cross (const DisplacementVector3D< OtherCoords, Tag > &v) const |
Return vector (cross) product of two displacement vectors, as a vector in the coordinate system of this class. More... | |
template<class OtherVector > | |
DisplacementVector3D | Cross (const OtherVector &v) const |
Return vector (cross) product of two vectors, as a vector in the coordinate system of this class. More... | |
template<class OtherCoords > | |
Scalar | Dot (const DisplacementVector3D< 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... | |
Scalar | Eta () const |
Polar eta, converting if necessary from internal coordinate system. More... | |
Scalar | eta () const |
void | GetCoordinates (Scalar &a, Scalar &b, Scalar &c) const |
get internal data into 3 Scalar numbers More... | |
void | GetCoordinates (Scalar dest[]) const |
get internal data into a C-style array of 3 Scalar numbers More... | |
template<class IT > | |
void | GetCoordinates (IT begin, IT end) const |
get internal data into 3 Scalars at *begin to *end (3 past begin) More... | |
template<class IT > | |
void | GetCoordinates (IT begin) const |
get internal data into 3 Scalars starting at *begin More... | |
Scalar | Mag2 () const |
Magnitute squared ( r^2 in spherical coordinate) More... | |
Scalar | mag2 () const |
bool | operator!= (const DisplacementVector3D &rhs) const |
DisplacementVector3D | operator* (Scalar a) const |
Multiply a vector by a real number. More... | |
DisplacementVector3D & | operator*= (Scalar a) |
multiply this vector by a scalar quantity More... | |
DisplacementVector3D | operator+ () const |
Positive of the vector, return itself. More... | |
template<class OtherCoords > | |
DisplacementVector3D & | operator+= (const DisplacementVector3D< OtherCoords, Tag > &v) |
Self Addition with a displacement vector. More... | |
DisplacementVector3D | operator- () const |
Negative of the vector. More... | |
template<class OtherCoords > | |
DisplacementVector3D & | operator-= (const DisplacementVector3D< OtherCoords, Tag > &v) |
Self Difference with a displacement vector. More... | |
DisplacementVector3D | operator/ (Scalar a) const |
Division of a vector with a real number. More... | |
DisplacementVector3D & | operator/= (Scalar a) |
divide this vector by a scalar quantity More... | |
template<class OtherCoords > | |
DisplacementVector3D & | operator= (const DisplacementVector3D< OtherCoords, Tag > &v) |
Assignment operator from a displacement vector of arbitrary type. More... | |
template<class OtherCoords > | |
DisplacementVector3D & | operator= (const PositionVector3D< OtherCoords, Tag > &rhs) |
Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian) More... | |
template<class ForeignVector > | |
DisplacementVector3D & | operator= (const ForeignVector &v) |
Assignment from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z() More... | |
bool | operator== (const DisplacementVector3D &rhs) const |
Exact equality. More... | |
Scalar | Perp2 () const |
Transverse component squared (rho^2 in cylindrical coordinates. More... | |
Scalar | perp2 () const |
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 |
Scalar | Rho () const |
Cylindrical transverse component rho. More... | |
Scalar | rho () const |
DisplacementVector3D< CoordSystem, Tag > & | SetCoordinates (const Scalar src[]) |
Set internal data based on a C-style array of 3 Scalar numbers. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetCoordinates (Scalar a, Scalar b, Scalar c) |
Set internal data based on 3 Scalar numbers. More... | |
template<class IT > | |
DisplacementVector3D< CoordSystem, Tag > & | SetCoordinates (IT begin, IT end) |
Set internal data based on 3 Scalars at *begin to *end. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetEta (Scalar etaval) |
Change Eta - CylindricalEta3D coordinates only. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetPhi (Scalar ang) |
Change Phi - Polar3D or CylindricalEta3D coordinates. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetR (Scalar rr) |
Change R - Polar3D coordinates only. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetRho (Scalar rr) |
Change Rho - CylindricalEta3D coordinates only. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetTheta (Scalar ang) |
Change Theta - Polar3D coordinates only. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetX (Scalar xx) |
Change X - Cartesian3D coordinates only. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetXYZ (Scalar a, Scalar b, Scalar c) |
set the values of the vector from the cartesian components (x,y,z) (if the vector is held in polar or cylindrical eta coordinates, then (x, y, z) are converted to that form) More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetY (Scalar yy) |
Change Y - Cartesian3D coordinates only. More... | |
DisplacementVector3D< CoordSystem, Tag > & | SetZ (Scalar zz) |
Change Z - Cartesian3D coordinates only. More... | |
Scalar | Theta () const |
Polar theta, converting if necessary from internal coordinate system. More... | |
Scalar | theta () const |
DisplacementVector3D | Unit () const |
return unit vector parallel to this More... | |
DisplacementVector3D | 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 |
Scalar | Z () const |
Cartesian Z, converting if necessary from internal coordinate system. More... | |
Scalar | z () const |
Private Member Functions | |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D (const DisplacementVector3D< OtherCoords, OtherTag > &) | |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D (const PositionVector3D< OtherCoords, OtherTag > &) | |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D | Cross (const DisplacementVector3D< OtherCoords, OtherTag > &) const |
template<class OtherCoords , class OtherTag > | |
Scalar | Dot (const DisplacementVector3D< OtherCoords, OtherTag > &) const |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D & | operator+= (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D & | operator-= (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D & | operator= (const DisplacementVector3D< OtherCoords, OtherTag > &) |
template<class OtherCoords , class OtherTag > | |
DisplacementVector3D & | operator= (const PositionVector3D< OtherCoords, OtherTag > &) |
Private Attributes | |
CoordSystem | fCoordinates |
#include <Math/GenVector/DisplacementVector3D.h>
typedef Tag ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::CoordinateSystemTag |
Definition at line 83 of file DisplacementVector3D.h.
typedef CoordSystem ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::CoordinateType |
Definition at line 82 of file DisplacementVector3D.h.
typedef CoordSystem::Scalar ROOT::Math::DisplacementVector3D< CoordSystem, Tag >::Scalar |
Definition at line 81 of file DisplacementVector3D.h.
|
inline |
Default constructor.
Construct an empty object with zero values
Definition at line 90 of file DisplacementVector3D.h.
|
inline |
Construct from three values of type Scalar.
In the case of a XYZVector the values are x,y,z In the case of a polar vector they are r,theta, phi
Definition at line 98 of file DisplacementVector3D.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 106 of file DisplacementVector3D.h.
|
inlineexplicit |
Construct from a position vector expressed in different coordinates but with the same coordinate system tag.
Definition at line 115 of file DisplacementVector3D.h.
|
inlineexplicit |
Construct from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()
Definition at line 124 of file DisplacementVector3D.h.
|
inlineexplicitprivate |
Definition at line 551 of file DisplacementVector3D.h.
|
inlineexplicitprivate |
Definition at line 554 of file DisplacementVector3D.h.
|
inline |
Retrieve a copy of the coordinates object.
Definition at line 201 of file DisplacementVector3D.h.
|
inline |
Return vector (cross) product of two displacement vectors, as a vector in the coordinate system of this class.
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 425 of file DisplacementVector3D.h.
|
inline |
Return vector (cross) product of two vectors, as a vector in the coordinate system of this class.
It is possible to perform the product for any classes implementing X(), Y() and Z() member functions
Definition at line 439 of file DisplacementVector3D.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 405 of file DisplacementVector3D.h.
|
inline |
Return the scalar (dot) product of two vectors.
It is possible to perform the product for any classes implementing x(), y() and z() member functions
Definition at line 414 of file DisplacementVector3D.h.
|
private |
|
inline |
Polar eta, converting if necessary from internal coordinate system.
Definition at line 326 of file DisplacementVector3D.h.
|
inline |
Definition at line 528 of file DisplacementVector3D.h.
|
inline |
get internal data into 3 Scalar numbers
Definition at line 235 of file DisplacementVector3D.h.
|
inline |
get internal data into a C-style array of 3 Scalar numbers
Definition at line 241 of file DisplacementVector3D.h.
|
inline |
get internal data into 3 Scalars at *begin to *end (3 past begin)
Definition at line 249 of file DisplacementVector3D.h.
|
inline |
get internal data into 3 Scalars starting at *begin
Definition at line 261 of file DisplacementVector3D.h.
|
inline |
Magnitute squared ( r^2 in spherical coordinate)
Definition at line 338 of file DisplacementVector3D.h.
|
inline |
Definition at line 530 of file DisplacementVector3D.h.
|
inline |
Definition at line 287 of file DisplacementVector3D.h.
|
inline |
Multiply a vector by a real number.
Definition at line 492 of file DisplacementVector3D.h.
|
inline |
multiply this vector by a scalar quantity
Definition at line 473 of file DisplacementVector3D.h.
|
inline |
Positive of the vector, return itself.
Definition at line 508 of file DisplacementVector3D.h.
|
inline |
Self Addition with a displacement vector.
Definition at line 454 of file DisplacementVector3D.h.
|
private |
|
inline |
Negative of the vector.
Definition at line 501 of file DisplacementVector3D.h.
|
inline |
Self Difference with a displacement vector.
Definition at line 464 of file DisplacementVector3D.h.
|
private |
|
inline |
Division of a vector with a real number.
Definition at line 513 of file DisplacementVector3D.h.
|
inline |
divide this vector by a scalar quantity
Definition at line 481 of file DisplacementVector3D.h.
|
inline |
Assignment operator from a displacement vector of arbitrary type.
Definition at line 152 of file DisplacementVector3D.h.
|
inline |
Assignment operator from a position vector (not necessarily efficient unless one or the other is Cartesian)
Definition at line 163 of file DisplacementVector3D.h.
|
inline |
Assignment from a foreign 3D vector type, for example, Hep3Vector Precondition: v must implement methods x(), y() and z()
Definition at line 174 of file DisplacementVector3D.h.
|
private |
|
private |
|
inline |
Exact equality.
Definition at line 284 of file DisplacementVector3D.h.
|
inline |
Transverse component squared (rho^2 in cylindrical coordinates.
Definition at line 343 of file DisplacementVector3D.h.
|
inline |
Definition at line 531 of file DisplacementVector3D.h.
|
inline |
Polar phi, converting if necessary from internal coordinate system.
Definition at line 321 of file DisplacementVector3D.h.
|
inline |
Definition at line 527 of file DisplacementVector3D.h.
|
inline |
Polar R, converting if necessary from internal coordinate system.
Definition at line 311 of file DisplacementVector3D.h.
|
inline |
Definition at line 525 of file DisplacementVector3D.h.
|
inline |
Cylindrical transverse component rho.
Definition at line 331 of file DisplacementVector3D.h.
|
inline |
Definition at line 529 of file DisplacementVector3D.h.
|
inline |
Set internal data based on a C-style array of 3 Scalar numbers.
Definition at line 208 of file DisplacementVector3D.h.
|
inline |
Set internal data based on 3 Scalar numbers.
Definition at line 214 of file DisplacementVector3D.h.
|
inline |
Set internal data based on 3 Scalars at *begin to *end.
Definition at line 222 of file DisplacementVector3D.h.
|
inline |
Change Eta - CylindricalEta3D coordinates only.
Definition at line 393 of file DisplacementVector3D.h.
|
inline |
Change Phi - Polar3D or CylindricalEta3D coordinates.
Definition at line 383 of file DisplacementVector3D.h.
|
inline |
Change R - Polar3D coordinates only.
Definition at line 373 of file DisplacementVector3D.h.
|
inline |
Change Rho - CylindricalEta3D coordinates only.
Definition at line 388 of file DisplacementVector3D.h.
|
inline |
Change Theta - Polar3D coordinates only.
Definition at line 378 of file DisplacementVector3D.h.
|
inline |
Change X - Cartesian3D coordinates only.
Definition at line 358 of file DisplacementVector3D.h.
|
inline |
set the values of the vector from the cartesian components (x,y,z) (if the vector is held in polar or cylindrical eta coordinates, then (x, y, z) are converted to that form)
Definition at line 274 of file DisplacementVector3D.h.
|
inline |
Change Y - Cartesian3D coordinates only.
Definition at line 363 of file DisplacementVector3D.h.
|
inline |
Change Z - Cartesian3D coordinates only.
Definition at line 368 of file DisplacementVector3D.h.
|
inline |
Polar theta, converting if necessary from internal coordinate system.
Definition at line 316 of file DisplacementVector3D.h.
|
inline |
Definition at line 526 of file DisplacementVector3D.h.
|
inline |
return unit vector parallel to this
Definition at line 348 of file DisplacementVector3D.h.
|
inline |
Definition at line 532 of file DisplacementVector3D.h.
|
inline |
Cartesian X, converting if necessary from internal coordinate system.
Definition at line 296 of file DisplacementVector3D.h.
|
inline |
Definition at line 522 of file DisplacementVector3D.h.
|
inline |
Cartesian Y, converting if necessary from internal coordinate system.
Definition at line 301 of file DisplacementVector3D.h.
|
inline |
Definition at line 523 of file DisplacementVector3D.h.
|
inline |
Cartesian Z, converting if necessary from internal coordinate system.
Definition at line 306 of file DisplacementVector3D.h.
|
inline |
Definition at line 524 of file DisplacementVector3D.h.
|
private |
Definition at line 537 of file DisplacementVector3D.h.