FitQuality.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/

// FitQuality.h, (c) ATLAS Detector software
 
#ifndef TRKEVENTPRIMITIVES_TRKFITQUALITY_H
#define TRKEVENTPRIMITIVES_TRKFITQUALITY_H
 
#include <cmath> //for std::floor in the included .icc file
#include <iosfwd>
#include <memory>
class MsgStream;
 
namespace Trk {
 
class FitQualityImpl
{
public:
  FitQualityImpl() = default;
  FitQualityImpl(const FitQualityImpl&) = default;
  FitQualityImpl(FitQualityImpl&&) = default;
  FitQualityImpl& operator=(const FitQualityImpl&) = default;
  FitQualityImpl& operator=(FitQualityImpl&&) = default;

  FitQualityImpl(double chiSquared, int numberDoF)
    : m_chiSquared(chiSquared)
    , m_numberDoF(numberDoF)
  {
  }

  FitQualityImpl(double chiSquared, double numberDoF)
    : m_chiSquared(chiSquared)
    , m_numberDoF(numberDoF)
  {
  }

  double chiSquared() const { return m_chiSquared; }

  int numberDoF() const
  {
 
    return static_cast<int>(std::floor(m_numberDoF + 0.5));
  }

  double doubleNumberDoF() const { return m_numberDoF; }

  void setChiSquared(double chiSquared) { m_chiSquared = chiSquared; }

  void setNumberDoF(double numberDoF) { m_numberDoF = numberDoF; }
 
protected:
  //Protected
  //We do not want to create/destroy
  //objects via this class
  ~FitQualityImpl() = default;
  double m_chiSquared{};
  double m_numberDoF{};
 
}; // end of class definitions

class FitQuality : public FitQualityImpl
{
public:
  using FitQualityImpl::FitQualityImpl;
  using FitQualityImpl::operator=;
  using FitQualityImpl::chiSquared;
  using FitQualityImpl::doubleNumberDoF;
  using FitQualityImpl::numberDoF;
  using FitQualityImpl::setChiSquared;
  using FitQualityImpl::setNumberDoF;
 
  // Needed for T/P since we used to have only
  // FitQuality, This copies the  payload
  // we set to the persistent type
  // i.e FitQuality_p1.
  FitQuality(const FitQualityImpl& fq)
    : FitQualityImpl(fq.chiSquared(), fq.doubleNumberDoF())
  {
  }
 
  virtual ~FitQuality() = default;

  virtual FitQuality* clone() const;

  std::unique_ptr<FitQuality> uniqueClone() const;
 
}; // end of class definitions

MsgStream&
operator<<(MsgStream& sl, const FitQualityImpl& fq);
std::ostream&
operator<<(std::ostream& sl, const FitQualityImpl& fq);
 
} // end ns
#include "TrkEventPrimitives/FitQuality.icc"
#endif // TRKEVENTPRIMITIVES_FITQUALITY_H