DataFormats/GeometryVector/interface/private/Basic3DVectorLD.h - master - githubmirror/cmssw

DataFormats/GeometryVector/interface/private/Basic3DVectorLD.h
316 строк11 KB
aandvalenzuela
[SIMULATION] Define missing assignment operator
01 дек 2023, 11:15
01 дек 2023, 11:155a38d04
#ifndef GeometryVector_Basic3DVectorLD_h
#define GeometryVector_Basic3DVectorLD_h

#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-private-field"
#endif

#include "extBasic3DVector.h"
// long double specialization
template <>
class Basic3DVector<long double> {
public:
  typedef long double T;
  typedef T ScalarType;
  typedef Geom::Cylindrical2Cartesian<T> Cylindrical;
  typedef Geom::Spherical2Cartesian<T> Spherical;
  typedef Spherical Polar;  // synonym

  typedef Basic3DVector<T> MathVector;

  /** 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)
   */
  Basic3DVector() : theX(0), theY(0), theZ(0), theW(0) {}

  /// Copy constructor from same type. Should not be needed but for gcc bug 12685
  Basic3DVector(const Basic3DVector& p) : theX(p.x()), theY(p.y()), theZ(p.z()), theW(0) {}

  /// Copy constructor and implicit conversion from Basic3DVector of different precision
  template <class U>
  Basic3DVector(const Basic3DVector<U>& p) : theX(p.x()), theY(p.y()), theZ(p.z()), theW(0) {}

  /// constructor from 2D vector (X and Y from 2D vector, z set to zero)
  Basic3DVector(const Basic2DVector<T>& p) : theX(p.x()), theY(p.y()), theZ(0), theW(0) {}

  /// Assignment operator
  Basic3DVector& operator=(const Basic3DVector&) = default;

  /** 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
   *   <BR> construction from a Basic3DVector with different precision
   *   <BR> construction from a Hep3Vector
   *   <BR> construction from a coordinate system converter 
   */
  template <class OtherPoint>
  explicit Basic3DVector(const OtherPoint& p) : theX(p.x()), theY(p.y()), theZ(p.z()), theW(0) {}

#ifdef USE_SSEVECT
  // constructor from Vec4
  template <typename U>
  Basic3DVector(mathSSE::Vec4<U> const& iv) : theX(iv.arr[0]), theY(iv.arr[1]), theZ(iv.arr[2]), theW(0) {}
#endif
#ifdef USE_EXTVECT
  // constructor from Vec4
  template <typename U>
  Basic3DVector(Vec4<U> const& iv) : theX(iv[0]), theY(iv[1]), theZ(iv[2]), theW(0) {}
#endif

  /// construct from cartesian coordinates
  Basic3DVector(const T& x, const T& y, const T& z) : theX(x), theY(y), theZ(z), theW(0) {}

  /** Deprecated construct from polar coordinates, use 
   *  <BR> Basic3DVector<T>( Basic3DVector<T>::Polar( theta, phi, r))
   *  instead. 
   */
  template <typename U>
  Basic3DVector(const Geom::Theta<U>& theta, const Geom::Phi<U>& phi, const T& r) {
    Polar p(theta.value(), phi.value(), r);
    theX = p.x();
    theY = p.y();
    theZ = p.z();
  }

  /// Cartesian x coordinate
  T x() const { return theX; }

  /// Cartesian y coordinate
  T y() const { return theY; }

  /// Cartesian z coordinate
  T z() const { return theZ; }

  Basic2DVector<T> xy() const { return Basic2DVector<T>(theX, theY); }

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

  /// The vector magnitude squared. Equivalent to vec.dot(vec)
  T mag2() const { return x() * x() + y() * y() + z() * z(); }

  /// The vector magnitude. Equivalent to sqrt(vec.mag2())
  T mag() const { return std::sqrt(mag2()); }

  /// Squared magnitude of transverse component
  T perp2() const { return x() * x() + y() * y(); }

  /// Magnitude of transverse component
  T perp() const { return std::sqrt(perp2()); }

  /// Another name for perp()
  T transverse() const { return perp(); }

  /** 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.
   */
  T barePhi() const { return std::atan2(y(), x()); }
  Geom::Phi<T> phi() const { return Geom::Phi<T>(barePhi()); }

  /** 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.
   */
  T bareTheta() const { return std::atan2(perp(), z()); }
  Geom::Theta<T> theta() const { return Geom::Theta<T>(std::atan2(perp(), z())); }

  /** Pseudorapidity. 
   *  Does not check for zero transverse component; in this case the behavior 
   *  is as for divide-by zero, i.e. system-dependent.
   */
  // T eta() const { return -log( tan( theta()/2.));}
  T eta() const { return detailsBasic3DVector::eta(x(), y(), z()); }  // correct

  /** Unit vector parallel to this.
   *  If mag() is zero, a zero vector is returned.
   */
  Basic3DVector unit() const {
    T my_mag = mag2();
    if (my_mag == 0)
      return *this;
    my_mag = T(1) / std::sqrt(my_mag);
    Basic3DVector ret(*this);
    return ret *= my_mag;
  }

  /** Operator += with a Basic3DVector of possibly different precision.
   */
  template <class U>
  Basic3DVector& operator+=(const Basic3DVector<U>& p) {
    theX += p.x();
    theY += p.y();
    theZ += p.z();
    return *this;
  }

  /** Operator -= with a Basic3DVector of possibly different precision.
   */
  template <class U>
  Basic3DVector& operator-=(const Basic3DVector<U>& p) {
    theX -= p.x();
    theY -= p.y();
    theZ -= p.z();
    return *this;
  }

  /// Unary minus, returns a vector with components (-x(),-y(),-z())
  Basic3DVector operator-() const { return Basic3DVector(-x(), -y(), -z()); }

  /// Scaling by a scalar value (multiplication)
  Basic3DVector& operator*=(T t) {
    theX *= t;
    theY *= t;
    theZ *= t;
    return *this;
  }

  /// Scaling by a scalar value (division)
  Basic3DVector& operator/=(T t) {
    t = T(1) / t;
    theX *= t;
    theY *= t;
    theZ *= t;
    return *this;
  }

  /// Scalar product, or "dot" product, with a vector of same type.
  T dot(const Basic3DVector& v) const { return x() * v.x() + y() * v.y() + z() * v.z(); }

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

  /// Vector product, or "cross" product, with a vector of same type.
  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());
  }

  /** 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.   
   */
  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());
  }

private:
  T theX;
  T theY;
  T theZ;
  T theW;
}
#ifndef __CINT__
__attribute__((aligned(16)))
#endif
;

/// vector sum and subtraction of vectors of possibly different precision
inline Basic3DVector<long double> operator+(const Basic3DVector<long double>& a, const Basic3DVector<long double>& b) {
  typedef Basic3DVector<long double> RT;
  return RT(a.x() + b.x(), a.y() + b.y(), a.z() + b.z());
}
inline Basic3DVector<long double> operator-(const Basic3DVector<long double>& a, const Basic3DVector<long double>& b) {
  typedef Basic3DVector<long double> RT;
  return RT(a.x() - b.x(), a.y() - b.y(), a.z() - b.z());
}

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

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

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

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

/// scalar product of vectors of same precision
// template <>
inline long double operator*(const Basic3DVector<long double>& v1, const Basic3DVector<long double>& v2) {
  return v1.dot(v2);
}

/// scalar product of vectors of different precision
template <class U>
inline typename PreciseFloatType<long double, U>::Type operator*(const Basic3DVector<long double>& v1,
                                                                 const Basic3DVector<U>& v2) {
  return v1.x() * v2.x() + v1.y() * v2.y() + v1.z() * v2.z();
}

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

/** Multiplication by scalar, does not change the precision of the vector.
 *  The return type is the same as the type of the vector argument.
 */
//template <>
inline Basic3DVector<long double> operator*(const Basic3DVector<long double>& v, long double t) {
  return Basic3DVector<long double>(v.x() * t, v.y() * t, v.z() * t);
}

/// Same as operator*( Vector, Scalar)
// template <>
inline Basic3DVector<long double> operator*(long double t, const Basic3DVector<long double>& v) {
  return Basic3DVector<long double>(v.x() * t, v.y() * t, v.z() * t);
}

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

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

/** Division by scalar, does not change the precision of the vector.
 *  The return type is the same as the type of the vector argument.
 */
template <typename S>
inline Basic3DVector<long double> operator/(const Basic3DVector<long double>& v, S s) {
  long double t = 1 / s;
  return v * t;
}

typedef Basic3DVector<long double> Basic3DVectorLD;

#ifdef __clang__
#pragma clang diagnostic pop
#endif

#endif  // GeometryVector_Basic3DVectorLD_h