geo_vectors_utils_TVector.h

Go to the documentation of this file.

#ifndef LARCOREALG_GEOMETRY_GEO_VECTORS_UTILS_TVECTOR_H
#define LARCOREALG_GEOMETRY_GEO_VECTORS_UTILS_TVECTOR_H

// LArSoft libraries
#include "larcorealg/Geometry/geo_vectors_utils.h"

// ROOT library
#include "TLorentzVector.h"
#include "TVector2.h"
#include "TVector3.h"

// C/C++ standard library
#include <ostream>

namespace geo::vect {

  // --- BEGIN TVector3 conversions --------------------------------------------

  //----------------------------------------------------------------------------
  template <typename Vector>
  TVector3 toTVector3(Vector const& v)
  {
    return convertTo<TVector3>(v);
  }

  // --- END TVector3 conversions ----------------------------------------------

  //----------------------------------------------------------------------------

  namespace dump {

    // --- BEGIN Output of old-style ROOT vectors (TVector3 etc.) ------------

    template <typename Stream>
    void Vector2(Stream&& out, TVector2 const& v)
    {
      out << "( " << v.X() << ", " << v.Y() << " )";
    }

    template <typename Stream>
    void Vector3(Stream&& out, TVector3 const& v)
    {
      out << "( " << v.X() << ", " << v.Y() << ", " << v.Z() << " )";
    }

    template <typename Stream>
    void LorentzVector(Stream&& out, TLorentzVector const& v)
    {
      out << "( " << v.X() << ", " << v.Y() << ", " << v.Z() << "; " << v.T() << " )";
    } // LorentzVector()

    inline std::ostream& operator<<(std::ostream& out, TVector2 const& v)
    {
      Vector2(out, v);
      return out;
    }

    inline std::ostream& operator<<(std::ostream& out, TVector3 const& v)
    {
      Vector3(out, v);
      return out;
    }

    inline std::ostream& operator<<(std::ostream& out, TLorentzVector const& v)
    {
      LorentzVector(out, v);
      return out;
    }

    // --- END Output of old-style ROOT vectors (TVector3 etc.) ----------------

  } // namespace dump
  //----------------------------------------------------------------------------

} // namespace geo::vect

// The only way some generic code has to see the operator<< is for them to be
// exposed in the same namespace as the vectors they dump are; in TVector case,
// that's the global namespace... (Boost unit test checks still fail though)
using geo::vect::dump::operator<<;

//------------------------------------------------------------------------------
//--- Specialisations
//---
namespace geo::vect {

  //----------------------------------------------------------------------------
  // Specialisations for: TVector2
  template <>
  inline auto mag2<TVector2>(TVector2 const& v)
  {
    return v.Mod2();
  }

  //----------------------------------------------------------------------------

} // namespace geo::vect

//------------------------------------------------------------------------------
//---  STL specialization for ROOT vectors
//------------------------------------------------------------------------------


// in the golden global namespace, as in old ROOT tradition

// --- BEGIN 2D vectors --------------------------------------------------------
inline decltype(auto) begin(TVector2 const& v)
{
  return geo::vect::vector_cbegin(v);
}

inline decltype(auto) cbegin(TVector2 const& v)
{
  return geo::vect::vector_cbegin(v);
}

inline decltype(auto) end(TVector2 const& v)
{
  return geo::vect::vector_cend(v);
}

inline decltype(auto) cend(TVector2 const& v)
{
  return geo::vect::vector_cend(v);
}

// --- END 2D vectors ----------------------------------------------------------

// --- BEGIN 3D vectors --------------------------------------------------------
inline decltype(auto) begin(TVector3 const& v)
{
  return geo::vect::vector_cbegin(v);
}

inline decltype(auto) cbegin(TVector3 const& v)
{
  return geo::vect::vector_cbegin(v);
}

inline decltype(auto) end(TVector3 const& v)
{
  return geo::vect::vector_cend(v);
}

inline decltype(auto) cend(TVector3 const& v)
{
  return geo::vect::vector_cend(v);
}

// --- END 3D vectors ----------------------------------------------------------

// --- BEGIN 4D vectors --------------------------------------------------------
inline decltype(auto) begin(TLorentzVector const& v)
{
  return geo::vect::vector_cbegin(v);
}

inline decltype(auto) cbegin(TLorentzVector const& v)
{
  return geo::vect::vector_cbegin(v);
}

inline decltype(auto) end(TLorentzVector const& v)
{
  return geo::vect::vector_cend(v);
}

inline decltype(auto) cend(TLorentzVector const& v)
{
  return geo::vect::vector_cend(v);
}

// --- END 4D vectors ----------------------------------------------------------


//------------------------------------------------------------------------------

#endif // LARCOREALG_GEOMETRY_GEO_VECTORS_UTILS_TVECTOR_H