CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Classes | Namespaces | Typedefs | Functions | Variables
extBasic3DVector.h File Reference
#include "DataFormats/GeometryVector/interface/Basic2DVector.h"
#include "DataFormats/GeometryVector/interface/Theta.h"
#include "DataFormats/GeometryVector/interface/Phi.h"
#include "DataFormats/GeometryVector/interface/PreciseFloatType.h"
#include "DataFormats/GeometryVector/interface/CoordinateSets.h"
#include "DataFormats/Math/interface/ExtVec.h"
#include <iosfwd>
#include <cmath>
#include "Basic3DVectorLD.h"

Go to the source code of this file.

Classes

class  Basic3DVector< T >
 

Namespaces

 detailsBasic3DVector
 
 geometryDetails
 

Typedefs

typedef Basic3DVector< double > Basic3DVectorD
 
typedef Basic3DVector< float > Basic3DVectorF
 
typedef
Geom::Cylindrical2Cartesian< T > 		Cylindrical
 
typedef Vec4< T > MathVector
 
typedef Spherical Polar
 
typedef T ScalarType
 
typedef
Geom::Spherical2Cartesian< T > 		Spherical
 
typedef Vec4< T > VectorType
 

Functions

float detailsBasic3DVector::__attribute__ ((always_inline)) __attribute__((pure)) eta(float x
 
template<typename T >
class Basic3DVector __attribute__ ((aligned(16)))
 
T barePhi () const
 
T bareTheta () const
 
 Basic3DVector ()
 
 Basic3DVector (const Basic3DVector &p)
 Copy constructor from same type. Should not be needed but for gcc bug 12685. More...
 
template<class U >
 Basic3DVector (const Basic3DVector< U > &p)
 Copy constructor and implicit conversion from Basic3DVector of different precision. More...
 
 Basic3DVector (const Basic2DVector< T > &p)
 constructor from 2D vector (X and Y from 2D vector, z set to zero) More...
 
template<class OtherPoint >
 Basic3DVector (const OtherPoint &p)
 
template<class U >
 Basic3DVector (Vec4< U > const &iv)
 
 Basic3DVector (const T &x, const T &y, const T &z, const T &w=0)
 construct from cartesian coordinates More...
 
template<typename U >
 Basic3DVector (const Geom::Theta< U > &theta, const Geom::Phi< U > &phi, const T &r)
 
Basic3DVector cross (const Basic3DVector &lh) const
 Vector product, or "cross" product, with a vector of same type. More...
 
template<class U >
Basic3DVector< typename
PreciseFloatType< T, U >::Type > 		cross (const Basic3DVector< U > &lh) const
 
T dot (const Basic3DVector &rh) const
 Scalar product, or "dot" product, with a vector of same type. More...
 
template<class U >
PreciseFloatType< T, U >::Type dot (const Basic3DVector< U > &lh) const
 
T eta () const
 
T mag () const
 The vector magnitude. Equivalent to sqrt(vec.mag2()) More...
 
T mag2 () const
 The vector magnitude squared. Equivalent to vec.dot(vec) More...
 
MathVector const & mathVector () const
 
template<class T >
T operator* (const Basic3DVector< T > &v1, const Basic3DVector< T > &v2)
 scalar product of vectors of same precision More...
 
template<class T , class U >
PreciseFloatType< T, U >::Type operator* (const Basic3DVector< T > &v1, const Basic3DVector< U > &v2)
 scalar product of vectors of different precision More...
 
template<class T >
Basic3DVector< T > operator* (const Basic3DVector< T > &v, T t)
 
template<class T >
Basic3DVector< T > operator* (T t, const Basic3DVector< T > &v)
 Same as operator*( Vector, Scalar) More...
 
template<class T , typename S >
Basic3DVector< T > operator* (S t, const Basic3DVector< T > &v)
 
template<class T , typename S >
Basic3DVector< T > operator* (const Basic3DVector< T > &v, S t)
 
Basic3DVector & operator*= (T t)
 Scaling by a scalar value (multiplication) More...
 
template<class T >
Basic3DVector< T > operator+ (const Basic3DVector< T > &a, const Basic3DVector< T > &b)
 vector sum and subtraction of vectors of possibly different precision More...
 
template<class T , class U >
Basic3DVector< typename
PreciseFloatType< T, U >::Type > 		operator+ (const Basic3DVector< T > &a, const Basic3DVector< U > &b)
 
template<class U >
Basic3DVector & operator+= (const Basic3DVector< U > &p)
 
template<class T >
Basic3DVector< T > operator- (const Basic3DVector< T > &a, const Basic3DVector< T > &b)
 
template<class T , class U >
Basic3DVector< typename
PreciseFloatType< T, U >::Type > 		operator- (const Basic3DVector< T > &a, const Basic3DVector< U > &b)
 
Basic3DVector operator- () const
 Unary minus, returns a vector with components (-x(),-y(),-z()) More...
 
template<class U >
Basic3DVector & operator-= (const Basic3DVector< U > &p)
 
template<class T >
Basic3DVector< T > operator/ (const Basic3DVector< T > &v, T t)
 
template<class T , typename S >
Basic3DVector< T > operator/ (const Basic3DVector< T > &v, S s)
 
Basic3DVector & operator/= (T t)
 Scaling by a scalar value (division) More...
 
template<class T >
std::ostream & operator<< (std::ostream &s, const Basic3DVector< T > &v)
 simple text output to standard streams More...
 
bool operator== (const Basic3DVector &rh) const
 
T operator[] (int i) const
 
T perp () const
 Magnitude of transverse component. More...
 
T perp2 () const
 Squared magnitude of transverse component. More...
 
Geom::Phi< T > phi () const
 
std::ostream & geometryDetails::print3D (std::ostream &s, double x, double y, double z)
 
Geom::Theta< T > theta () const
 
T transverse () const
 Another name for perp() More...
 
Basic3DVector unit () const
 
T w () const
 
T x () const
 Cartesian x coordinate. More...
 
Basic2DVector< T > xy () const
 
T y () const
 Cartesian y coordinate. More...
 
T z () const
 Cartesian z coordinate. More...
 

Variables

Vec4< T > v
 
float float detailsBasic3DVector::y
 
float float float detailsBasic3DVector::z { float t(z/std::sqrt(x*x+y*y))
 

Typedef Documentation

typedef Basic3DVector<double> Basic3DVectorD

Definition at line 326 of file extBasic3DVector.h.

typedef Basic3DVector<float> Basic3DVectorF

Definition at line 325 of file extBasic3DVector.h.

typedef Geom::Cylindrical2Cartesian<T> Cylindrical

Definition at line 168 of file extBasic3DVector.h.

typedef Vec4<T> MathVector

Definition at line 167 of file extBasic3DVector.h.

typedef Spherical Polar

Definition at line 170 of file extBasic3DVector.h.

typedef T ScalarType

Definition at line 165 of file extBasic3DVector.h.

typedef Geom::Spherical2Cartesian<T> Spherical

Definition at line 169 of file extBasic3DVector.h.

typedef Vec4<T> VectorType

Definition at line 166 of file extBasic3DVector.h.

Function Documentation

template<typename T >
class Basic3DVector __attribute__ ( (aligned(16))  )
T __attribute__::barePhi ( ) const

Azimuthal angle. The value is returned in radians, in the range (-pi,pi]. Same precision as the system atan2(x,y) function. The return type is Geom::Phi<T>, see it's documentation.

Definition at line 274 of file extBasic3DVector.h.

T __attribute__::bareTheta ( ) const

Polar angle. The value is returned in radians, in the range [0,pi] Same precision as the system atan2(x,y) function. The return type is Geom::Phi<T>, see it's documentation.

Definition at line 281 of file extBasic3DVector.h.

286 {
__attribute__::Basic3DVector ( )

default constructor uses default constructor of T to initialize the components. For built-in floating-point types this means initialization to zero??? (force init to 0)

Definition at line 176 of file extBasic3DVector.h.

178 { return Basic3DVector(-v);}
Basic3DVector
Basic3DVector()
Definition: Basic3DVectorLD.h:69
__attribute__::Basic3DVector ( const Basic3DVector &  p)

Copy constructor from same type. Should not be needed but for gcc bug 12685.

Definition at line 179 of file extBasic3DVector.h.

181  {
template<class U >
__attribute__::Basic3DVector ( const Basic3DVector< U > &  p)

Copy constructor and implicit conversion from Basic3DVector of different precision.

Definition at line 184 of file extBasic3DVector.h.

187  {
__attribute__::Basic3DVector ( const Basic2DVector< T > &  p)

constructor from 2D vector (X and Y from 2D vector, z set to zero)

Definition at line 189 of file extBasic3DVector.h.

194  {
template<class OtherPoint >
__attribute__::Basic3DVector ( const OtherPoint &  p)
explicit

Explicit constructor from other (possibly unrelated) vector classes The only constraint on the argument type is that it has methods x(), y() and z(), and that these methods return a type convertible to T. Examples of use are
construction from a Basic3DVector with different precision
construction from a Hep3Vector
construction from a coordinate system converter

Definition at line 202 of file extBasic3DVector.h.

template<class U >
__attribute__::Basic3DVector ( Vec4< U > const &  iv)

Definition at line 211 of file extBasic3DVector.h.

__attribute__::Basic3DVector ( const T &  x,
const T &  y,
const T &  z,
const T &  w = 0 
)

construct from cartesian coordinates

Definition at line 215 of file extBasic3DVector.h.

template<typename U >
__attribute__::Basic3DVector ( const Geom::Theta< U > &  theta,
const Geom::Phi< U > &  phi,
const T &  r 
)

Deprecated construct from polar coordinates, use
Basic3DVector<T>( Basic3DVector<T>::Polar( theta, phi, r)) instead.

Definition at line 223 of file extBasic3DVector.h.

227  :
228  Vec4<T> v;
Vec4
ExtVec< T, 4 > Vec4
Definition: ExtVec.h:74
Basic3DVector __attribute__::cross ( const Basic3DVector &  lh) const

Vector product, or "cross" product, with a vector of same type.

Definition at line 348 of file extBasic3DVector.h.

template<class U >
Basic3DVector<typename PreciseFloatType<T,U>::Type> __attribute__::cross ( const Basic3DVector< U > &  lh) const

Vector (or cross) product with a vector of different precision. The product is computed without loss of precision. The type of the returned vector is the more precise of the types of the two vectors.

Definition at line 360 of file extBasic3DVector.h.

T __attribute__::dot ( const Basic3DVector &  rh) const

Scalar product, or "dot" product, with a vector of same type.

Definition at line 332 of file extBasic3DVector.h.

template<class U >
PreciseFloatType<T,U>::Type __attribute__::dot ( const Basic3DVector< U > &  lh) const

Scalar (or dot) product with a vector of different precision. The product is computed without loss of precision. The type of the returned scalar is the more precise of the scalar types of the two vectors.

Definition at line 342 of file extBasic3DVector.h.

T __attribute__::eta ( ) const

Pseudorapidity. Does not check for zero transverse component; in this case the behavior is as for divide-by zero, i.e. system-dependent.

Definition at line 289 of file extBasic3DVector.h.

292 {
T __attribute__::mag ( ) const

The vector magnitude. Equivalent to sqrt(vec.mag2())

Definition at line 259 of file extBasic3DVector.h.

T __attribute__::mag2 ( ) const

The vector magnitude squared. Equivalent to vec.dot(vec)

Definition at line 256 of file extBasic3DVector.h.

257 {
MathVector & mathVector ( ) const

Definition at line 229 of file extBasic3DVector.h.

232 {
template<class T >
T operator* ( const Basic3DVector< T > &  v1,
const Basic3DVector< T > &  v2 
)
inline

scalar product of vectors of same precision

Definition at line 271 of file extBasic3DVector.h.

References Basic3DVector< T >::dot().

271  {
272  return v1.dot(v2);
273 }
Basic3DVector::dot
T dot(const Basic3DVector &rh) const
Scalar product, or &quot;dot&quot; product, with a vector of same type.
Definition: extBasic3DVector.h:194
template<class T , class U >
PreciseFloatType<T,U>::Type operator* ( const Basic3DVector< T > &  v1,
const Basic3DVector< U > &  v2 
)
inline

scalar product of vectors of different precision

Definition at line 277 of file extBasic3DVector.h.

References Basic3DVector< T >::dot().

278  {
279  return v1.dot(v2);
280 }
Basic3DVector::dot
T dot(const Basic3DVector &rh) const
Scalar product, or &quot;dot&quot; product, with a vector of same type.
Definition: extBasic3DVector.h:194
template<class T >
Basic3DVector<T> operator* ( const Basic3DVector< T > &  v,
T  t 
)
inline

Multiplication by scalar, does not change the precision of the vector. The return type is the same as the type of the vector argument.

Definition at line 286 of file extBasic3DVector.h.

References tree::t, and Basic3DVector< T >::v.

286  {
287  return v.v*t;
288 }
tree.t
tuple t
Definition: tree.py:139
template<class T >
Basic3DVector<T> operator* ( T  t,
const Basic3DVector< T > &  v 
)
inline

Same as operator*( Vector, Scalar)

Definition at line 292 of file extBasic3DVector.h.

References tree::t, and Basic3DVector< T >::v.

292  {
293  return v.v*t;
294 }
tree.t
tuple t
Definition: tree.py:139
template<class T , typename S >
Basic3DVector<T> operator* ( S  t,
const Basic3DVector< T > &  v 
)
inline

Definition at line 299 of file extBasic3DVector.h.

References tree::t.

299  {
300  return static_cast<T>(t)*v;
301 }
tree.t
tuple t
Definition: tree.py:139
T
long double T
Definition: Basic3DVectorLD.h:57
template<class T , typename S >
Basic3DVector<T> operator* ( const Basic3DVector< T > &  v,
S  t 
)
inline

Definition at line 304 of file extBasic3DVector.h.

References tree::t.

304  {
305  return static_cast<T>(t)*v;
306 }
tree.t
tuple t
Definition: tree.py:139
T
long double T
Definition: Basic3DVectorLD.h:57
Basic3DVector& __attribute__::operator*= ( T  t)

Scaling by a scalar value (multiplication)

Definition at line 319 of file extBasic3DVector.h.

template<class T >
Basic3DVector<T> operator+ ( const Basic3DVector< T > &  a,
const Basic3DVector< T > &  b 
)
inline

vector sum and subtraction of vectors of possibly different precision

Definition at line 246 of file extBasic3DVector.h.

246  {
247  return a.v+b.v;
248 }
template<class T , class U >
Basic3DVector<typename PreciseFloatType<T,U>::Type> operator+ ( const Basic3DVector< T > &  a,
const Basic3DVector< U > &  b 
)
inline

Definition at line 257 of file extBasic3DVector.h.

257  {
258  typedef Basic3DVector<typename PreciseFloatType<T,U>::Type> RT;
259  return RT(a).v+RT(b).v;
260 }
template<class U >
Basic3DVector& __attribute__::operator+= ( const Basic3DVector< U > &  p)

Operator += with a Basic3DVector of possibly different precision.

Definition at line 302 of file extBasic3DVector.h.

304  {
305  return static_cast<T>(t)*v;
tree.t
tuple t
Definition: tree.py:139
T
long double T
Definition: Basic3DVectorLD.h:57
template<class T >
Basic3DVector<T> operator- ( const Basic3DVector< T > &  a,
const Basic3DVector< T > &  b 
)
inline

Definition at line 251 of file extBasic3DVector.h.

References Basic3DVector< T >::v.

251  {
252  return a.v-b.v;
253 }
template<class T , class U >
Basic3DVector<typename PreciseFloatType<T,U>::Type> operator- ( const Basic3DVector< T > &  a,
const Basic3DVector< U > &  b 
)
inline

Definition at line 264 of file extBasic3DVector.h.

264  {
265  typedef Basic3DVector<typename PreciseFloatType<T,U>::Type> RT;
266  return RT(a).v-RT(b).v;
267 }
Basic3DVector __attribute__::operator- ( ) const

Unary minus, returns a vector with components (-x(),-y(),-z())

Definition at line 316 of file extBasic3DVector.h.

318 {
template<class U >
Basic3DVector& __attribute__::operator-= ( const Basic3DVector< U > &  p)

Operator -= with a Basic3DVector of possibly different precision.

Definition at line 310 of file extBasic3DVector.h.

313  {
template<class T >
Basic3DVector<T> operator/ ( const Basic3DVector< T > &  v,
T  t 
)
inline

Division by scalar, does not change the precision of the vector. The return type is the same as the type of the vector argument.

Definition at line 313 of file extBasic3DVector.h.

References tree::t, and Basic3DVector< T >::v.

313  {
314  return v.v/t;
315 }
tree.t
tuple t
Definition: tree.py:139
template<class T , typename S >
Basic3DVector<T> operator/ ( const Basic3DVector< T > &  v,
S  s 
)
inline

Definition at line 318 of file extBasic3DVector.h.

318  {
319  // T t = S(1)/s; return v*t;
320  T t = s;
321  return v/t;
322 }
tree.t
tuple t
Definition: tree.py:139
T
long double T
Definition: Basic3DVectorLD.h:57
Basic3DVector& __attribute__::operator/= ( T  t)

Scaling by a scalar value (division)

Definition at line 325 of file extBasic3DVector.h.

template<class T >
std::ostream& operator<< ( std::ostream &  s,
const Basic3DVector< T > &  v 
)
inline

simple text output to standard streams

Definition at line 238 of file extBasic3DVector.h.

References geometryDetails::print3D(), alignCSCRings::s, and Basic3DVector< T >::v.

238  {
239  return geometryDetails::print3D(s, v.x(),v.y(), v.z());
240 }
Basic3DVector::y
T y() const
Cartesian y coordinate.
Definition: extBasic3DVector.h:102
Basic3DVector::x
T x() const
Cartesian x coordinate.
Definition: extBasic3DVector.h:99
Basic3DVector::z
T z() const
Cartesian z coordinate.
Definition: extBasic3DVector.h:105
geometryDetails::print3D
std::ostream & print3D(std::ostream &s, double x, double y, double z)
Definition: print.cc:5
bool __attribute__::operator== ( const Basic3DVector &  rh) const

Definition at line 250 of file extBasic3DVector.h.

251  {
252  return a.v-b.v;
253 }
b
double b
Definition: hdecay.h:120
a
double a
Definition: hdecay.h:121
T & operator[] ( int  i) const

Definition at line 232 of file extBasic3DVector.h.

References geometryDetails::print3D(), and alignCSCRings::s.

Referenced by OrderedHitPairs::operator[](), OrderedMultiHits::operator[](), OrderedHitTriplets::operator[](), OrderedHitSeeds::operator[](), OrderedLaserHitPairs::operator[](), and ReadMapType< std::map< std::string, double > >::operator[]().

232 {
T __attribute__::perp ( ) const

Magnitude of transverse component.

Definition at line 265 of file extBasic3DVector.h.

271 {
T __attribute__::perp2 ( ) const

Squared magnitude of transverse component.

Definition at line 262 of file extBasic3DVector.h.

Geom::Phi<T> __attribute__::phi ( ) const

Definition at line 275 of file extBasic3DVector.h.

Geom::Theta<T> __attribute__::theta ( ) const

Definition at line 282 of file extBasic3DVector.h.

286 {
T __attribute__::transverse ( ) const

Another name for perp()

Definition at line 268 of file extBasic3DVector.h.

271 {
Basic3DVector __attribute__::unit ( ) const

Unit vector parallel to this. If mag() is zero, a zero vector is returned.

Definition at line 294 of file extBasic3DVector.h.

299  {
T __attribute__::w ( ) const

Definition at line 245 of file extBasic3DVector.h.

246 {
T __attribute__::x ( ) const

Cartesian x coordinate.

Definition at line 237 of file extBasic3DVector.h.

Basic2DVector<T> __attribute__::xy ( ) const

Definition at line 247 of file extBasic3DVector.h.

251 {
T __attribute__::y ( ) const

Cartesian y coordinate.

Definition at line 240 of file extBasic3DVector.h.

246 {
T __attribute__::z ( ) const

Cartesian z coordinate.

Definition at line 243 of file extBasic3DVector.h.

246 {

Variable Documentation

Vec4<T> v

Definition at line 366 of file extBasic3DVector.h.

Generated for CMSSW Reference Manual by doxygen 1.8.5