Skip to content

Commit 2e4c73c

Browse files
devajithvsdpiparo
authored andcommitted
[backport][math][Docs] Further improve GenVector documentation.
Changes similar to 23f2059
1 parent 3334371 commit 2e4c73c

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

math/experimental/genvectorx/inc/MathX/GenVectorX/LorentzVector.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ class LorentzVector {
772772
/**
773773
Scale of a LorentzVector with a scalar quantity a
774774
\param a scalar quantity of type a
775-
\param v mathcore::LorentzVector based on any coordinate system
775+
\param v LorentzVector based on any coordinate system
776776
\return a new mathcoreLorentzVector q = v * a same type as v
777777
*/
778778
template <class CoordSystem>

math/experimental/genvectorx/inc/MathX/GenVectorX/VectorUtil.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ namespace ROOT_MATH_ARCH {
4444

4545
namespace VectorUtil {
4646

47+
/// \addtogroup GenVector
48+
/// @{
49+
4750
// methods for 3D vectors
4851

4952
/**
@@ -259,6 +262,8 @@ inline typename Vector1::Scalar InvariantMass(const Vector1 &v1, const Vector2 &
259262
// return ( v1 + v2).mag();
260263
}
261264

265+
/// @brief Returns the square of what InvariantMass(const Vector1&, const Vector2&) would return.
266+
/// This is mostly useful for speed optimisations, because the expensive sqrt operation is skipped.
262267
template <class Vector1, class Vector2>
263268
inline typename Vector1::Scalar InvariantMass2(const Vector1 &v1, const Vector2 &v2)
264269
{
@@ -561,6 +566,9 @@ double Phi_0_2pi(double phi);
561566
*/
562567
double Phi_mpi_pi(double phi);
563568

569+
// Close of doxygen group:
570+
/// @}
571+
564572
} // namespace VectorUtil
565573

566574
} // namespace ROOT_MATH_ARCH

0 commit comments

Comments
 (0)