AmgMatrixBasePlugin.h File Reference

#include <cmath>

Include dependency graph for AmgMatrixBasePlugin.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
const PlainObject	unit () const
	This is a plugin that makes Eigen look like CLHEP & defines some convenience methods. More...
Scalar	mag () const
	mag method More...
Scalar	mag2 () const
	mag2 method - forward to squaredNorm() More...
Scalar	perp2 () const
	perp2 method - perpendicular length squared More...
Scalar	perp () const
	perp method - perpenticular length More...
Scalar	perp2 (const MatrixBase< Derived > &vec)
	perp2 method wrt another vector More...
Scalar	perp (const MatrixBase< Derived > &vec)
	perp2 method wrt another vector More...
Scalar	phi () const
	phi method More...
Scalar	theta () const
	theta method More...
Scalar	eta () const
	pseudorapidity method More...
Scalar	deltaR (const MatrixBase< Derived > &vec) const
Scalar	deltaPhi (const MatrixBase< Derived > &vec) const
void	fillSymmetric (size_t i, size_t j, Scalar value)
	method to fill elements for a symmetric matrix More...
template<typename OtherDerived >
Matrix< Scalar, OtherDerived::RowsAtCompileTime, OtherDerived::RowsAtCompileTime >	similarity (const MatrixBase< OtherDerived > &m) const
	similarity method : yields ms = m*s*m^T More...
template<typename OtherDerived >
Matrix< Scalar, OtherDerived::RowsAtCompileTime, OtherDerived::RowsAtCompileTime >	similarityT (const MatrixBase< OtherDerived > &m) const
	similarityT method : yields ms = m^T*s*m More...

Function Documentation

deltaPhi()

Scalar deltaPhi ( const MatrixBase< Derived > &  vec ) const

inline

Definition at line 112 of file AmgMatrixBasePlugin.h.

                                                             {
  //we assert in eta/phi methods
  double dphi = vec.phi() - this->phi();
  if (dphi > M_PI) {
    dphi -= M_PI * 2;
  } else if (dphi <= -M_PI) {
    dphi += M_PI * 2;
  }
  return dphi;
}

deltaR()

Scalar deltaR ( const MatrixBase< Derived > &  vec ) const

inline

Definition at line 105 of file AmgMatrixBasePlugin.h.

                                                           {
  //we assert in eta/phi methods
  double a = this->eta() - vec.eta();
  double b = this->deltaPhi(vec);
  return std::sqrt(a * a + b * b);
}

eta()

Scalar eta ( ) const

inline

pseudorapidity method

Definition at line 83 of file AmgMatrixBasePlugin.h.

                          {
  constexpr int size = Eigen::MatrixBase<Derived>::SizeAtCompileTime;
  constexpr int isVector = Eigen::MatrixBase<Derived>::IsVectorAtCompileTime;
  static_assert(isVector && size>=3, "Method applicable for vectors of size >=3");
  const Scalar rho2 = (*this).x() * (*this).x() + (*this).y() * (*this).y();
  const Scalar z = (*this).z();
  const Scalar z2 = z * z;
  constexpr Scalar epsilon = 2. * std::numeric_limits<Scalar>::epsilon();
  // avoid magnitude being parallel to z
  if (rho2 >  z2 * epsilon) {
    const double m = std::sqrt(rho2 + z2);
    return 0.5 * std::log((m + z) / (m - z));
  }
  if (z == 0) {
    return 0.0;
  }
  // Following math/genvector/inc/Math/GenVector/etaMax.h in ROOT 6.26
  constexpr Scalar s_etaMax = static_cast<Scalar>(22756.0);
  // Following math/genvector/inc/Math/GenVector/eta.h in ROOT 6.26
  return (z > 0) ? z + s_etaMax : z - s_etaMax;
}

fillSymmetric()

void fillSymmetric ( size_t  i, size_t  j, Scalar  value  )

inline

method to fill elements for a symmetric matrix

Definition at line 124 of file AmgMatrixBasePlugin.h.

                                                            {
  (*this)(i, j) = value;
  (*this)(j, i) = value;
}

mag()

Scalar mag ( ) const

inline

mag method

Definition at line 26 of file AmgMatrixBasePlugin.h.

                          {
  return (*this).norm();
}

mag2()

Scalar mag2 ( ) const

inline

mag2 method - forward to squaredNorm()

Definition at line 31 of file AmgMatrixBasePlugin.h.

                           {
  return (*this).squaredNorm();
}

perp() [1/2]

Scalar perp ( ) const

inline

perp method - perpenticular length

Definition at line 44 of file AmgMatrixBasePlugin.h.

                           {
  constexpr int size = Eigen::MatrixBase<Derived>::SizeAtCompileTime;
  constexpr int isVector = Eigen::MatrixBase<Derived>::IsVectorAtCompileTime;
  static_assert(isVector && size>=2, "Method applicable for vectors of size >=2");
  return std::sqrt(this->perp2());
}

perp() [2/2]

Scalar perp ( const MatrixBase< Derived > &  vec )

inline

perp2 method wrt another vector

Definition at line 62 of file AmgMatrixBasePlugin.h.

                                                   {
  return std::sqrt(this->perp2(vec));
}

perp2() [1/2]

Scalar perp2 ( ) const

inline

perp2 method - perpendicular length squared

Definition at line 36 of file AmgMatrixBasePlugin.h.

                            {
  constexpr int size = Eigen::MatrixBase<Derived>::SizeAtCompileTime;
  constexpr int isVector = Eigen::MatrixBase<Derived>::IsVectorAtCompileTime;
  static_assert(isVector && size>=2, "Method applicable for vectors of size >=2");
  return ((*this)[0] * (*this)[0] + (*this)[1] * (*this)[1]);
}

perp2() [2/2]

Scalar perp2 ( const MatrixBase< Derived > &  vec )

inline

perp2 method wrt another vector

Definition at line 52 of file AmgMatrixBasePlugin.h.

                                                    {
  Scalar tot = vec.mag2();
  if (tot > 0) {
    Scalar s = this->dot(vec);
    return this->mag2() - s * s / tot;
  }
  return this->mag2();
}

phi()

Scalar phi ( ) const

inline

phi method

Definition at line 67 of file AmgMatrixBasePlugin.h.

                          {
  constexpr int size = Eigen::MatrixBase<Derived>::SizeAtCompileTime;
  constexpr int isVector = Eigen::MatrixBase<Derived>::IsVectorAtCompileTime;
  static_assert(isVector && size>=2, "Method applicable for vectors of size >=2");
  return std::atan2((*this)[1], (*this)[0]);
}

similarity()

template<typename OtherDerived >

Matrix<Scalar, OtherDerived::RowsAtCompileTime, OtherDerived::RowsAtCompileTime> similarity ( const MatrixBase< OtherDerived > &  m ) const

inline

similarity method : yields ms = m*s*m^T

Definition at line 133 of file AmgMatrixBasePlugin.h.

                                                    {
  return m * (this->derived() * m.transpose());
}

similarityT()

template<typename OtherDerived >

Matrix<Scalar, OtherDerived::RowsAtCompileTime, OtherDerived::RowsAtCompileTime> similarityT ( const MatrixBase< OtherDerived > &  m ) const

inline

similarityT method : yields ms = m^T*s*m

Definition at line 141 of file AmgMatrixBasePlugin.h.

                                                     {
  return m.transpose() * (this->derived() * m);
}

theta()

Scalar theta ( ) const

inline

theta method

Definition at line 75 of file AmgMatrixBasePlugin.h.

                            {
  constexpr int size = Eigen::MatrixBase<Derived>::SizeAtCompileTime;
  constexpr int isVector = Eigen::MatrixBase<Derived>::IsVectorAtCompileTime;
  static_assert(isVector && size>=3, "Method applicable for vectors of size >=3");
  return std::atan2(this->perp(), (*this)[2]);
}

unit()

const PlainObject unit ( ) const

inline

This is a plugin that makes Eigen look like CLHEP & defines some convenience methods.

unit method - forward normalized()

Definition at line 21 of file AmgMatrixBasePlugin.h.

                                      {
  return (*this).normalized();
}