MnPrint.cxx

Go to the documentation of this file.

// @(#)root/minuit2:$Id$
// Authors: M. Winkler, F. James, L. Moneta, A. Zsenei   2003-2005
 
/**********************************************************************
 *                                                                    *
 * Copyright (c) 2005 LCG ROOT Math team,  CERN/PH-SFT                *
 *                                                                    *
 **********************************************************************/
 
#include "Minuit2/MnPrint.h"
#include "Minuit2/FunctionMinimum.h"
#include "Minuit2/MnUserParameters.h"
#include "Minuit2/MnUserCovariance.h"
#include "Minuit2/MnGlobalCorrelationCoeff.h"
#include "Minuit2/MnUserParameterState.h"
#include "Minuit2/MinuitParameter.h"
#include "Minuit2/MnMachinePrecision.h"
#include "Minuit2/MinosError.h"
#include "Minuit2/ContoursError.h"
#include "Minuit2/MnPlot.h"
 
#include <iomanip>
#include <utility>
#include <cstring>
#include <vector>
#include <algorithm>
 
constexpr int PRECISION = 10;
constexpr int WIDTH = PRECISION + 7;
 
namespace ROOT {
namespace Minuit2 {
 
// we don't use a std::vector or std::array here, because we want a mix of the two;
// a stack-allocated container with fixed capacity but dynamic size, i.e. the equivalent
// of static_vector from the Boost Container library
template <class T>
class PrefixStack {
public:
   using const_pointer = const T *;
   using const_reference = const T &;
 
   void Push(T prefix)
   {
      if (fSize < fMaxSize)
         fData[fSize] = prefix;
      else {
         // crop the stack when it becomes too deep as a last resort, but this should not
         // happen, fMaxSize should be increased instead if this occurs
         fData[fMaxSize - 1] = prefix;
         fData[fMaxSize - 2] = "...";
      }
      ++fSize;
   }
 
   void Pop()
   {
      assert(fSize > 0);
      --fSize;
   }
 
   const_pointer begin() const { return fData; }
   const_pointer end() const { return fData + (fSize < fMaxSize ? fSize : fMaxSize); }
   const_reference back() const { return *(end() - 1); }
 
private:
   static constexpr unsigned fMaxSize = 10; // increase as needed
   T fData[fMaxSize];
   unsigned fSize = 0;
};
 
// gShowPrefixStack determines how messages are printed, it acts on all threads;
// race conditions when writing to this do not cause failures
bool gShowPrefixStack = false;
 
// writing to gPrefixFilter is not thread-safe, should be done only from main thread
std::vector<std::string> gPrefixFilter;
 
// gPrintLevel must be thread-local, because it may be manipulated by a thread to
// temporarily turn logging on or off; Minuit2Minimizer does this, for example
thread_local int gPrintLevel = 0;
 
// gPrefixStack must be thread-local
thread_local PrefixStack<const char *> gPrefixStack;
 
MnPrint::MnPrint(const char *prefix, int level) : fLevel{level}
{
   gPrefixStack.Push(prefix);
}
 
MnPrint::~MnPrint()
{
   gPrefixStack.Pop();
}
 
void MnPrint::ShowPrefixStack(bool yes)
{
   gShowPrefixStack = yes;
}
 
void MnPrint::AddFilter(const char *filter)
{
   gPrefixFilter.emplace_back(filter);
}
 
void MnPrint::ClearFilter()
{
   gPrefixFilter.clear();
}
 
int MnPrint::SetGlobalLevel(int level)
{
   // should use std::exchange or boost::exchange
   std::swap(gPrintLevel, level);
   return level;
}
 
int MnPrint::GlobalLevel()
{
   return gPrintLevel;
}
 
int MnPrint::SetLevel(int level)
{
   // should use std::exchange or boost::exchange
   std::swap(fLevel, level);
   return level;
}
 
int MnPrint::Level() const
{
   return fLevel;
}
 
void StreamFullPrefix(std::ostringstream &os)
{
   const char *prev = "";
   for (const auto cs : gPrefixStack) {
      // skip repeated prefixes; repetition happens when class method calls another
      // method of the same class and both set up a MnPrint instance
      if (std::strcmp(cs, prev) != 0)
         os << cs << ":";
      prev = cs;
   }
}
 
void MnPrint::StreamPrefix(std::ostringstream &os)
{
   if (gShowPrefixStack) {
      // show full prefix stack, useful to set sharp filters and to see what calls what
      StreamFullPrefix(os);
   } else {
      // show only the top of the prefix stack (the prefix of the innermost scope)
      os << gPrefixStack.back();
   }
}
 
bool MnPrint::Hidden()
{
   // Filtering is not implemented a very efficient way to keep it simple, but the
   // implementation ensures that the performance drop is opt-in. Only when filters are
   // used there is a performance loss.
 
   // The intended use case of filtering is for debugging, when highest performance
   // does not matter. Filtering is only every attempted if the message passes the
   // threshold level.
 
   // Filtering is very fast when the filter is empty.
   if (gPrefixFilter.empty())
      return false;
 
   std::ostringstream os;
   os << "^";
   StreamFullPrefix(os);
   std::string prefix = os.str();
   // Filtering works like grep, the message is shown if any of the filter strings match.
   // To only match the beginning of the prefix, use "^". For example "^MnHesse" only
   // matches direct execution of MnHesse, but not MnHesse called by MnMigrad.
   for (const auto &s : gPrefixFilter) {
      if (prefix.find(s) != std::string::npos)
         return false;
   }
   return true;
}
 
MnPrint::Oneline::Oneline(double fcn, double edm, int ncalls, int iter)
   : fFcn(fcn), fEdm(edm), fNcalls(ncalls), fIter(iter)
{
}
 
MnPrint::Oneline::Oneline(const MinimumState &state, int iter)
   : MnPrint::Oneline(state.Fval(), state.Edm(), state.NFcn(), iter)
{
}
 
MnPrint::Oneline::Oneline(const FunctionMinimum &fmin, int iter) : MnPrint::Oneline(fmin.State(), iter) {}
 
std::ostream &operator<<(std::ostream &os, const MnPrint::Oneline &x)
{
   // print iteration, function value, edm and ncalls in one single line
   if (x.fIter >= 0)
      os << std::setw(4) << x.fIter << " - ";
   const int pr = os.precision(PRECISION);
   os << "FCN = " << std::setw(WIDTH) << x.fFcn << " Edm = " << std::setw(WIDTH) << x.fEdm
      << " NCalls = " << std::setw(6) << x.fNcalls;
   os.precision(pr);
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MnUserParameters &par)
{
   // print the MnUserParameter object
   os << "\n  Pos |    Name    |  type   |      Value       |    Error +/-";
 
   int pr = os.precision();
 
   const double eps2 = par.Precision().Eps2();
   for (auto &&p : par.Parameters()) {
      os << "\n" << std::setw(5) << p.Number() << " | " << std::setw(10) << p.Name() << " |";
      if (p.IsConst())
         os << "  const  |";
      else if (p.IsFixed())
         os << "  fixed  |";
      else if (p.HasLimits())
         os << " limited |";
      else
         os << "  free   |";
      os.precision(PRECISION);
      os.width(WIDTH);
      os << p.Value() << " | " << std::setw(12);
      if (p.Error() > 0) {
         os << p.Error();
         if (p.HasLimits()) {
            if (std::fabs(p.Value() - p.LowerLimit()) < eps2) {
               os << " (at lower limit)";
            } else if (std::fabs(p.Value() - p.UpperLimit()) < eps2) {
               os << " (at upper limit)";
            }
         }
      }
   }
   os.precision(pr);
 
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MnUserCovariance &matrix)
{
   // print the MnUserCovariance
   const int pr = os.precision(6);
 
   unsigned int n = matrix.Nrow();
   for (unsigned int i = 0; i < n; i++) {
      os << '\n';
      for (unsigned int j = 0; j < n; j++) {
         os.width(13);
         os << matrix(i, j);
      }
      os << " | ";
      double di = matrix(i, i);
      for (unsigned int j = 0; j < n; j++) {
         double dj = matrix(j, j);
         os.width(13);
         os << matrix(i, j) / std::sqrt(std::fabs(di * dj));
      }
   }
   os.precision(pr);
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MnGlobalCorrelationCoeff &coeff)
{
   // print the global correlation coefficient
   const int pr = os.precision(6);
   for (auto &&x : coeff.GlobalCC()) {
      os << '\n';
      os.width(6 + 7);
      os << x;
   }
   os.precision(pr);
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MnUserParameterState &state)
{
   // print the MnUserParameterState
   const int pr = os.precision(PRECISION);
   os << "\n  Valid         : " << (state.IsValid() ? "yes" : "NO") << "\n  Function calls: " << state.NFcn()
      << "\n  Minimum value : " << state.Fval() << "\n  Edm           : " << state.Edm()
      << "\n  Parameters    : " << state.Parameters() << "\n  CovarianceStatus: " << state.CovarianceStatus()
      << "\n  Covariance and correlation matrix: ";
   if (state.HasCovariance())
      os << state.Covariance();
   else
      os << "matrix is not present or not valid";
   if (state.HasGlobalCC())
      os << "\n  Global correlation coefficients: " << state.GlobalCC();
 
   os.precision(pr);
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const FunctionMinimum &min)
{
   // print the FunctionMinimum
   const int pr = os.precision(PRECISION);
   os << "\n  Valid         : " << (min.IsValid() ? "yes" : "NO") << "\n  Function calls: " << min.NFcn()
      << "\n  Minimum value : " << min.Fval() << "\n  Edm           : " << min.Edm()
      << "\n  Internal parameters: " << min.Parameters().Vec();
   if (min.HasValidCovariance())
      os << "\n  Internal covariance matrix: " << min.Error().Matrix();
   os << "\n  External parameters: " << min.UserParameters();
   // os << min.UserCovariance() << '\n';
   // os << min.UserState().GlobalCC() << '\n';
 
   if (!min.IsValid()) {
      os << "\n  FunctionMinimum is invalid:";
      if (!min.State().IsValid())
         os << "\n    State is invalid";
      if (min.IsAboveMaxEdm())
         os << "\n    Edm is above max";
      if (min.HasReachedCallLimit())
         os << "\n    Reached call limit";
   }
 
   os.precision(pr);
 
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MinimumState &min)
{
   const int pr = os.precision(PRECISION);
   os << "\n  Minimum value : " << min.Fval() << "\n  Edm           : " << min.Edm()
      << "\n  Internal parameters:" << min.Vec() << "\n  Internal gradient  :" << min.Gradient().Vec();
   if (min.HasCovariance())
      os << "\n  Internal covariance matrix:" << min.Error().Matrix();
   os.precision(pr);
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MnMachinePrecision &prec)
{
   // print the Precision
   int pr = os.precision(PRECISION);
   os << "MnMachinePrecision " << prec.Eps() << '\n';
   os.precision(pr);
 
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const MinosError &me)
{
   // print the Minos Error
   os << "Minos # of function calls: " << me.NFcn() << '\n';
 
   if (!me.IsValid())
      os << "Minos Error is not valid." << '\n';
   if (!me.LowerValid())
      os << "lower Minos Error is not valid." << '\n';
   if (!me.UpperValid())
      os << "upper Minos Error is not valid." << '\n';
   if (me.AtLowerLimit())
      os << "Minos Error is Lower limit of Parameter " << me.Parameter() << "." << '\n';
   if (me.AtUpperLimit())
      os << "Minos Error is Upper limit of Parameter " << me.Parameter() << "." << '\n';
   if (me.AtLowerMaxFcn())
      os << "Minos number of function calls for Lower Error exhausted." << '\n';
   if (me.AtUpperMaxFcn())
      os << "Minos number of function calls for Upper Error exhausted." << '\n';
   if (me.LowerNewMin()) {
      os << "Minos found a new Minimum in negative direction." << '\n';
      os << me.LowerState() << '\n';
   }
   if (me.UpperNewMin()) {
      os << "Minos found a new Minimum in positive direction." << '\n';
      os << me.UpperState() << '\n';
   }
 
   int pr = os.precision();
 
   os << "No  |"
      << "|   Name    |"
      << "|   Value@min   |"
      << "|    negative   |"
      << "|   positive  " << '\n';
   os << std::setw(4) << me.Parameter() << std::setw(5) << "||";
   os << std::setw(10) << me.LowerState().Name(me.Parameter()) << std::setw(3) << "||";
   os << std::setprecision(PRECISION) << std::setw(WIDTH) << me.Min() << " ||" << std::setprecision(PRECISION)
      << std::setw(WIDTH) << me.Lower() << " ||" << std::setw(WIDTH) << me.Upper() << '\n';
 
   os << '\n';
   os.precision(pr);
 
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const ContoursError &ce)
{
   // print the ContoursError
   os << "Contours # of function calls: " << ce.NFcn() << '\n';
   os << "MinosError in x: " << '\n';
   os << ce.XMinosError() << '\n';
   os << "MinosError in y: " << '\n';
   os << ce.YMinosError() << '\n';
   MnPlot plot;
   plot(ce.XMin(), ce.YMin(), ce());
   for (auto ipar = ce().begin(); ipar != ce().end(); ++ipar) {
      os << ipar - ce().begin() << "  " << (*ipar).first << "  " << (*ipar).second << '\n';
   }
   os << '\n';
 
   return os;
}
 
std::ostream &operator<<(std::ostream &os, const std::pair<double, double> &point)
{
   os << "\t x = " << point.first << "  y = " << point.second << std::endl;
   return os;
}
 
} // namespace Minuit2
} // namespace ROOT