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

DataFormats/GeometryVector/interface/private/extBasic2DVector.h
246 строк8 KB
Vincenzo Innocente
remove unused non const accessor
02 май 2024, 12:21
02 май 2024, 12:2199410bd
#ifndef GeometryVector_newBasic2DVector_h
#define GeometryVector_newBasic2DVector_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 <cmath>
#include <iosfwd>

template <class T>
class Basic2DVector {
public:
  typedef T ScalarType;
  typedef Vec2<T> VectorType;
  typedef Vec2<T> MathVector;
  typedef Geom::Polar2Cartesian<T> Polar;

  /** default constructor uses default constructor of T to initialize the 
   *  components. For built-in floating-point types this means initialization 
   * to zero
   */
  Basic2DVector() : v{0, 0} {}

  /// Copy constructor from same type. Should not be needed but for gcc bug 12685
  Basic2DVector(const Basic2DVector& p) : v(p.v) {}

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

  template <typename U>
  Basic2DVector(const Basic2DVector<U>& p) : v{T(p.v[0]), T(p.v[1])} {}

  /** Explicit constructor from other (possibly unrelated) vector classes 
   *  The only constraint on the argument type is that it has methods
   *  x() and y(), and that these methods return a type convertible to T.
   *  Examples of use are
   *   <BR> construction from a Basic2DVector with different precision
   *   <BR> construction from a coordinate system converter 
   */
  template <class Other>
  explicit Basic2DVector(const Other& p) : v{T(p.x()), T(p.y())} {}

  /// construct from cartesian coordinates
  Basic2DVector(const T& x, const T& y) : v{x, y} {}

  // constructor from Vec2 or vec4
  Basic2DVector(MathVector const& iv) : v(iv) {}
  template <typename U>
  Basic2DVector(Vec2<U> const& iv) : v{iv[0], iv[1]} {}
  template <typename U>
  Basic2DVector(Vec4<U> const& iv) : v{iv[0], iv[1]} {}

  MathVector const& mathVector() const { return v; }
  MathVector& mathVector() { return v; }

  T operator[](int i) const { return v[i]; }

  /// Cartesian x coordinate
  T x() const { return v[0]; }

  /// Cartesian y coordinate
  T y() const { return v[1]; }

  /// The vector magnitude squared. Equivalent to vec.dot(vec)
  T mag2() const { return ::dot(v, v); }

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

  /// Radius, same as mag()
  T r() const { return mag(); }

  /** 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>(atan2(y(), x())); }

  /** Unit vector parallel to this.
   *  If mag() is zero, a zero vector is returned.
   */
  Basic2DVector unit() const {
    T my_mag = mag();
    return my_mag == 0 ? *this : *this / my_mag;
  }

  /** Operator += with a Basic2DVector of possibly different precision.
   */
  template <class U>
  Basic2DVector& operator+=(const Basic2DVector<U>& p) {
    v = v + p.v;
    return *this;
  }

  /** Operator -= with a Basic2DVector of possibly different precision.
   */
  template <class U>
  Basic2DVector& operator-=(const Basic2DVector<U>& p) {
    v = v - p.v;
    return *this;
  }

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

  /// Scaling by a scalar value (multiplication)
  Basic2DVector& operator*=(T t) {
    v = v * t;
    return *this;
  }

  /// Scaling by a scalar value (division)
  Basic2DVector& operator/=(T t) {
    t = T(1) / t;
    v = v * t;
    return *this;
  }

  /// Scalar product, or "dot" product, with a vector of same type.
  T dot(const Basic2DVector& lh) const { return ::dot(v, lh.v); }

  /** 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 Basic2DVector<U>& lh) const {
    return Basic2DVector<typename PreciseFloatType<T, U>::Type>(*this).dot(
        Basic2DVector<typename PreciseFloatType<T, U>::Type>(lh));
  }

  /// Vector product, or "cross" product, with a vector of same type.
  T cross(const Basic2DVector& lh) const { return ::cross2(v, lh.v); }

  /** Vector (or cross) 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 cross(const Basic2DVector<U>& lh) const {
    return Basic2DVector<typename PreciseFloatType<T, U>::Type>(*this).cross(
        Basic2DVector<typename PreciseFloatType<T, U>::Type>(lh));
  }

public:
  Vec2<T> v;
};

namespace geometryDetails {
  std::ostream& print2D(std::ostream& s, double x, double y);

}

/// simple text output to standard streams
template <class T>
inline std::ostream& operator<<(std::ostream& s, const Basic2DVector<T>& v) {
  return geometryDetails::print2D(s, v.x(), v.y());
}

/// vector sum and subtraction of vectors of possibly different precision
template <class T>
inline Basic2DVector<T> operator+(const Basic2DVector<T>& a, const Basic2DVector<T>& b) {
  return a.v + b.v;
}
template <class T>
inline Basic2DVector<T> operator-(const Basic2DVector<T>& a, const Basic2DVector<T>& b) {
  return a.v - b.v;
}

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

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

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

/// scalar product of vectors of different precision
template <class T, class U>
inline typename PreciseFloatType<T, U>::Type operator*(const Basic2DVector<T>& v1, const Basic2DVector<U>& v2) {
  return v1.dot(v2);
}

/** 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 <class T>
inline Basic2DVector<T> operator*(const Basic2DVector<T>& v, T t) {
  return v.v * t;
}

/// Same as operator*( Vector, Scalar)
template <class T>
inline Basic2DVector<T> operator*(T t, const Basic2DVector<T>& v) {
  return v.v * t;
}

template <class T, class Scalar>
inline Basic2DVector<T> operator*(const Basic2DVector<T>& v, const Scalar& s) {
  T t = static_cast<T>(s);
  return v * t;
}

/// Same as operator*( Vector, Scalar)
template <class T, class Scalar>
inline Basic2DVector<T> operator*(const Scalar& s, const Basic2DVector<T>& v) {
  T t = static_cast<T>(s);
  return v * t;
}

/** 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 <class T>
inline Basic2DVector<T> operator/(const Basic2DVector<T>& v, T t) {
  return v.v / t;
}

template <class T, class Scalar>
inline Basic2DVector<T> operator/(const Basic2DVector<T>& v, const Scalar& s) {
  //   T t = static_cast<T>(Scalar(1)/s); return v*t;
  T t = static_cast<T>(s);
  return v / t;
}

typedef Basic2DVector<float> Basic2DVectorF;
typedef Basic2DVector<double> Basic2DVectorD;

#endif  // GeometryVector_Basic2DVector_h