/data/refman/pasoursint/CMSSW_4_1_8_patch13/src/DataFormats/GeometryVector/interface/newBasic3DVector.h

Go to the documentation of this file.

#ifndef GeometryVector_newBasic3DVector_h
#define GeometryVector_newBasic3DVector_h

#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/SSEVec.h"
#include <iosfwd>
#include <cmath>

template < typename T> 
class Basic3DVector {
public:

  typedef T                                   ScalarType;
  typedef Geom::Cylindrical2Cartesian<T>      Cylindrical;
  typedef Geom::Spherical2Cartesian<T>        Spherical;
  typedef Spherical                           Polar; // synonym
    
  Basic3DVector() {}

  Basic3DVector( const Basic3DVector & p) : 
    v(p.x(),p.y(),p.z()) {}

  template <class U>
  Basic3DVector( const Basic3DVector<U> & p) : 
    v(p.x(),p.y(),p.z()) {}


  Basic3DVector( const Basic2DVector<T> & p) : 
    v(p.x(),p.y(),0) {}

 
  template <class OtherPoint> 
  explicit Basic3DVector( const OtherPoint& p) : 
        v(p.x(),p.y(),p.z()) {}


  // constructor from Vec3
  Basic3DVector(mathSSE::Vec4<T> const& iv) : v(iv){}

  Basic3DVector( const T& x, const T& y, const T& z) : 
    v(x,y,z){}

  template <typename U>
  Basic3DVector( const Geom::Theta<U>& theta, 
                 const Geom::Phi<U>& phi, const T& r) {
    Polar p( theta.value(), phi.value(), r);
    v.o.theX = p.x(); v.o.theY = p.y(); v.o.theZ = p.z();
  }

  T x() const { return v.o.theX;}

  T y() const { return v.o.theY;}

  T z() const { return v.o.theZ;}

  Basic2DVector<T> xy() const { return v.xy();}

  // equality
  bool operator==(const Basic3DVector& rh) const {
    return x()==rh.x() && y()==rh.y() && z()==rh.z();
  }

  T mag2() const { return  x()*x() + y()*y()+z()*z();}

  T mag() const  { return std::sqrt( mag2());}

  T perp2() const { return x()*x() + y()*y();}

  T perp() const { return std::sqrt( perp2());}

  T transverse() const { return perp();}

  T barePhi() const {return std::atan2(y(),x());}
  Geom::Phi<T> phi() const {return Geom::Phi<T>(barePhi());}

  T bareTheta() const {return std::atan2(perp(),z());}
  Geom::Theta<T> theta() const {return Geom::Theta<T>(std::atan2(perp(),z()));}

  // T eta() const { return -log( tan( theta()/2.));} 
  T eta() const { T x(z()/perp()); return std::log(x+std::sqrt(x*x+T(1)));} // faster 

  Basic3DVector unit() const {
    T my_mag = mag2();
    if (my_mag==0) return *this;
    my_mag = T(1)/std::sqrt(my_mag);
    return *this * my_mag;
  }

  template <class U> 
  Basic3DVector& operator+= ( const Basic3DVector<U>& p) {
    v.o.theX += p.x();
    v.o.theY += p.y();
    v.o.theZ += p.z();
    return *this;
  } 

  template <class U> 
  Basic3DVector& operator-= ( const Basic3DVector<U>& p) {
    v.o.theX -= p.x();
    v.o.theY -= p.y();
    v.o.theZ -= p.z();
    return *this;
  } 

  Basic3DVector operator-() const { return Basic3DVector(-x(),-y(),-z());}

  Basic3DVector& operator*= ( T t) {
    v.o.theX *= t;
    v.o.theY *= t;
    v.o.theZ *= t;
    return *this;
  } 

  Basic3DVector& operator/= ( T t) {
    t = T(1)/t;
    v.o.theX *= t;
    v.o.theY *= t;   
    v.o.theZ *= t;
    return *this;
  } 

  T dot( const Basic3DVector& v) const { 
    return x()*v.x() + y()*v.y() + z()*v.z();
  }

  template <class U> 
  typename PreciseFloatType<T,U>::Type dot( const Basic3DVector<U>& v) const { 
    return x()*v.x() + y()*v.y() + z()*v.z();
  }

  Basic3DVector cross( const Basic3DVector& v) const {
    return Basic3DVector( y()*v.z() - v.y()*z(), 
                          z()*v.x() - v.z()*x(), 
                          x()*v.y() - v.x()*y());
  }

  template <class U> 
  Basic3DVector<typename PreciseFloatType<T,U>::Type> 
  cross( const Basic3DVector<U>& v) const {
    return Basic3DVector<typename PreciseFloatType<T,U>::Type>( y()*v.z() - v.y()*z(), 
                                                                z()*v.x() - v.z()*x(), 
                                                                x()*v.y() - v.x()*y());
  }

public:
  mathSSE::Vec4<T> v;
}  __attribute__ ((aligned (16)));


namespace geometryDetails {
  std::ostream & print3D(std::ostream& s, double x, double y, double z);
}

template <class T>
inline std::ostream & operator<<( std::ostream& s, const Basic3DVector<T>& v) {
  return geometryDetails::print3D(s, v.x(),v.y(), v.z());
}


template <class T, class U>
inline Basic3DVector<typename PreciseFloatType<T,U>::Type>
operator+( const Basic3DVector<T>& a, const Basic3DVector<U>& b) {
  typedef Basic3DVector<typename PreciseFloatType<T,U>::Type> RT;
  return RT(a.x()+b.x(), a.y()+b.y(), a.z()+b.z());
}

template <class T, class U>
inline Basic3DVector<typename PreciseFloatType<T,U>::Type>
operator-( const Basic3DVector<T>& a, const Basic3DVector<U>& b) {
  typedef Basic3DVector<typename PreciseFloatType<T,U>::Type> RT;
  return RT(a.x()-b.x(), a.y()-b.y(), a.z()-b.z());
}

template <class T>
inline T operator*( const Basic3DVector<T>& v1, const Basic3DVector<T>& v2) {
  return v1.dot(v2);
}

template <class T, class U>
inline typename PreciseFloatType<T,U>::Type operator*( const Basic3DVector<T>& v1, 
                                                       const Basic3DVector<U>& v2) {
  return v1.x()*v2.x() + v1.y()*v2.y() + v1.z()*v2.z();
}

template <class T>
inline Basic3DVector<T> operator*( const Basic3DVector<T>& v, T t) {
  return Basic3DVector<T>(v.x()*t, v.y()*t, v.z()*t);
}

template <class T>
inline Basic3DVector<T> operator*(T t, const Basic3DVector<T>& v) {
  return Basic3DVector<T>(v.x()*t, v.y()*t, v.z()*t);
}

template <class T, typename S>
inline Basic3DVector<T> operator*(S t,  const Basic3DVector<T>& v) {
  return static_cast<T>(t)*v;
}

template <class T, typename S>
inline Basic3DVector<T> operator*(const Basic3DVector<T>& v, S t) {
  return static_cast<T>(t)*v;
}


template <class T, typename S>
inline Basic3DVector<T> operator/( const Basic3DVector<T>& v, S s) {
  T t = T(1)/s;
  return v*t;
}


typedef Basic3DVector<float> Basic3DVectorF;
typedef Basic3DVector<double> Basic3DVectorD;

#include "DataFormats/GeometryVector/interface/Basic3DVectorFSSE.icc"


#endif // GeometryVector_Basic3DVector_h