Main namespace for MaCh3 software. More...

Typedefs
using	float_t = double

using	int_t = int

using	uint_t = unsigned

Enumerations
enum	kInfCrit { kBIC , kDIC , kWAIC , kInfCrits }
	KS: Different Information Criterion tests mostly based Gelman paper. More...

Functions
template<typename T >
constexpr T	fmaf_t (T x, T y, T z)
	Function template for fused multiply-add. More...

int	GetNThreads ()
	number of threads which we need for example for TRandom3 More...

void	AddPath (std::string &FilePath)
	Prepends the MACH3 environment path to FilePath if it is not already present. More...

int	GetThreadIndex ()
	thread index inside parallel loop More...

TFile *	Open (const std::string &Name, const std::string &Type, const std::string &File, const int Line)
	Opens a ROOT file with the given name and mode. More...

void	ScaleHistogram (TH1 *Sample_Hist, const double scale)
	Scale histogram to get divided by bin width. More...

template<typename ObjectType >
std::unique_ptr< ObjectType >	Clone (const ObjectType *obj, const std::string &name="")
	KS: Creates a copy of a ROOT-like object and wraps it in a smart pointer. More...

double *	MatrixMult (double A, double B, int n)
	CW: Multi-threaded matrix multiplication. More...

double **	MatrixMult (double A, double B, int n)
	CW: Multi-threaded matrix multiplication. More...

TMatrixD	MatrixMult (TMatrixD A, TMatrixD B)
	CW: Multi-threaded matrix multiplication. More...

void	MatrixVectorMulti (double _restrict_ VecMulti, double _restrict_ matrix, const double _restrict_ vector, const int n)
	KS: Custom function to perform multiplication of matrix and vector with multithreading. More...

double	MatrixVectorMultiSingle (double *_restrict_ matrix, const double _restrict_ vector, const int Length, const int i)
	KS: Custom function to perform multiplication of matrix and single element which is thread safe. More...

void	FixSampleNamesQuotes (std::string &yamlStr)
	KS: Yaml emitter has problem and drops "", if you have special signs in you like * then there is problem. This bit hacky code adds these "". More...

void	AddTuneValues (YAML::Node &root, const std::vector< double > &Values, const std::string &Tune, const std::vector< std::string > &FancyNames={})
	KS: Add Tune values to YAML covariance matrix. More...

void	MakeCorrelationMatrix (YAML::Node &root, const std::vector< double > &Values, const std::vector< double > &Errors, const std::vector< std::vector< double >> &Correlation, const std::string &OutYAMLName, const std::vector< std::string > &FancyNames={})
	KS: Replace correlation matrix and tune values in YAML covariance matrix. More...

TMacro *	GetConfigMacroFromChain (TDirectory *CovarianceFolder)
	KS: We store configuration macros inside the chain. In the past, multiple configs were stored, which required error-prone hardcoding like "Config_xsec_cov". Therefore, this code maintains backward compatibility by checking the number of macros present and using a hardcoded name only if necessary. More...

TMatrixDSym *	GetCovMatrixFromChain (TDirectory *TempFile)
	KS: Retrieve the cross-section covariance matrix from the given TDirectory. Historically, multiple covariance matrices could be stored, requiring fragile hardcoded paths like "CovarianceFolder/xsec_cov". This function maintains backward compatibility by: More...

std::vector< std::vector< double > >	GetCholeskyDecomposedMatrix (const TMatrixDSym &matrix, const std::string &matrixName)
	Computes Cholesky decomposition of a symmetric positive definite matrix using custom function which can be even 20 times faster. More...

bool	CanDecomposeMatrix (const TMatrixDSym &matrix)
	Checks if a matrix can be Cholesky decomposed. More...

void	MakeMatrixPosDef (TMatrixDSym *cov)
	Makes sure that matrix is positive-definite by adding a small number to on-diagonal elements. More...

Variables
constexpr static const char *	float_t_str_repr = "D"

constexpr static const double	_BAD_DOUBLE_ = -999.99
	Default value used for double initialisation. More...

constexpr static const int	_BAD_INT_ = -999
	Default value used for int initialisation. More...

constexpr static const double	_DEFAULT_RETURN_VAL_ = -999999.123456

constexpr static const double	Unity_D = 1.
	Some commonly used variables to which we set pointers to. More...

constexpr static const float	Unity_F = 1.

constexpr static const float_t	Unity = Unity_D

constexpr static const double	Zero_D = 0.

constexpr static const float	Zero_F = 0.

constexpr static const float_t	Zero = Zero_D

constexpr static const double	KinematicLowBound = std::numeric_limits<double>::lowest()
	When parameter has no bound this serves as it. Lowest possible value the system. More...

constexpr static const double	KinematicUpBound = std::numeric_limits<double>::max()
	When parameter has no bound this serves as it. Highest possible value the system. More...

constexpr static const double	_LARGE_LOGL_ = 1234567890.0
	Large Likelihood is used it parameter go out of physical boundary, this indicates in MCMC that such step should be removed. More...

constexpr static const double	_LOW_MC_BOUND_ = .00001
	MC prediction lower bound in bin to identify problematic binning definitions and handle LogL calculation. More...

constexpr static const double	DefSplineKnotUpBound = 9999
	Default value for spline knot capping, default mean not capping is being applied. More...

constexpr static const double	DefSplineKnotLowBound = -9999
	Default value for spline knot capping, default mean not capping is being applied. More...

constexpr static const int	UnderOverFlowBin = -1
	Mark bin which is overflow or underflow in MaCh3 binning. More...

Detailed Description

Main namespace for MaCh3 software.

Typedef Documentation

◆ float_t

using M3::float_t = typedef double

Definition at line 37 of file Core.h.

◆ int_t

using M3::int_t = typedef int

Definition at line 38 of file Core.h.

◆ uint_t

using M3::uint_t = typedef unsigned

Definition at line 39 of file Core.h.

Enumeration Type Documentation

◆ kInfCrit

enum M3::kInfCrit

KS: Different Information Criterion tests mostly based Gelman paper.

Enumerator
kBIC	Bayesian Information Criterion.
kDIC	Deviance Information Criterion.
kWAIC	Watanabe-Akaike information criterion.
kInfCrits	This only enumerates.

Definition at line 10 of file SampleSummary.h.

                 {
     kBIC,      
     kDIC,      
     kWAIC,     
     kInfCrits  
   };

Function Documentation

◆ AddPath()

void M3::AddPath ( std::string & FilePath )

Prepends the MACH3 environment path to FilePath if it is not already present.

Parameters

FilePath Reference to the file path string to be modified.

Definition at line 382 of file Monitor.cpp.

                                   {
 // ***************************************************************************
   //KS:Most inputs are in ${MACH3}/inputs/blarb.root
   if (std::getenv("MACH3") == nullptr) {
     MACH3LOG_ERROR("MACH3 is not defined");
     MACH3LOG_ERROR("Please source your setup script");
     MACH3LOG_ERROR("Read more: https://github.com/mach3-software/MaCh3/wiki/0.-FAQ#error-need-mach3-environment-variable");
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   std::string MaCh3Path = std::string(std::getenv("MACH3")) + "/";
    // Check if FilePath does NOT start with MaCh3Path
   if (FilePath.find(MaCh3Path) != 0) {
     FilePath.insert(0, MaCh3Path);
   }
 }

◆ AddTuneValues()

void M3::AddTuneValues	(	YAML::Node &	root,
		const std::vector< double > &	Values,
		const std::string &	Tune,
		const std::vector< std::string > &	FancyNames = `{}`
	)

inline

KS: Add Tune values to YAML covariance matrix.

Parameters

root	The root YAML node to be updated.
Values	The values to add for the specified tune.
Tune	The name of the tune (e.g., "PostFit").
FancyNames	Optional list of fancy names to match systematics (must match Values size if provided).

Definition at line 187 of file ParameterHandlerUtils.h.

                                                                    {}) {
 // *************************************
   YAML::Node NodeCopy = YAML::Clone(root);
   YAML::Node systematics = NodeCopy["Systematics"];
  
   if (!systematics || !systematics.IsSequence()) {
     MACH3LOG_ERROR("'Systematics' node is missing or not a sequence in the YAML copy");
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   if (!FancyNames.empty() && FancyNames.size() != Values.size()) {
     MACH3LOG_ERROR("Mismatch in sizes: FancyNames has {}, but Values has {}", FancyNames.size(), Values.size());
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   if (FancyNames.empty() && systematics.size() != Values.size()) {
     MACH3LOG_ERROR("Mismatch in sizes: Values has {}, but YAML 'Systematics' has {} entries",
                    Values.size(), systematics.size());
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   if (!FancyNames.empty()) {
     for (std::size_t i = 0; i < FancyNames.size(); ++i) {
       bool matched = false;
       for (std::size_t j = 0; j < systematics.size(); ++j) {
         YAML::Node systematicNode = systematics[j]["Systematic"];
         if (!systematicNode) continue;
         auto nameNode = systematicNode["Names"];
         if (!nameNode || !nameNode["FancyName"]) continue;
         if (nameNode["FancyName"].as<std::string>() == FancyNames[i]) {
           if (!systematicNode["ParameterValues"]) {
             MACH3LOG_ERROR("Missing 'ParameterValues' for matched FancyName '{}'", FancyNames[i]);
             throw MaCh3Exception(__FILE__, __LINE__);
           }
           systematicNode["ParameterValues"][Tune] = MaCh3Utils::FormatDouble(Values[i], 4);
           matched = true;
           break;
         }
       }
       if (!matched) {
         MACH3LOG_ERROR("Could not find a matching FancyName '{}' in the systematics", FancyNames[i]);
         throw MaCh3Exception(__FILE__, __LINE__);
       }
     }
   } else {
     for (std::size_t i = 0; i < systematics.size(); ++i) {
       YAML::Node systematicNode = systematics[i]["Systematic"];
       if (!systematicNode || !systematicNode["ParameterValues"]) {
         MACH3LOG_ERROR("Missing 'Systematic' or 'ParameterValues' entry at index {}", i);
         throw MaCh3Exception(__FILE__, __LINE__);
       }
       systematicNode["ParameterValues"][Tune] = MaCh3Utils::FormatDouble(Values[i], 4);
     }
   }
  
   // Convert updated copy to string
   std::string YAMLString = YAMLtoSTRING(NodeCopy);
   FixSampleNamesQuotes(YAMLString);
   // Write to output file
   std::string OutName = "UpdatedMatrixWithTune" + Tune + ".yaml";
   std::ofstream outFile(OutName);
   if (!outFile) {
     MACH3LOG_ERROR("Failed to open file for writing: {}", OutName);
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   outFile << YAMLString;
   outFile.close();
 }

◆ CanDecomposeMatrix()

bool M3::CanDecomposeMatrix ( const TMatrixDSym & matrix )

inline

Checks if a matrix can be Cholesky decomposed.

Parameters

matrix Input symmetric matrix to test

Definition at line 498 of file ParameterHandlerUtils.h.

                                                           {
 // *************************************
   TDecompChol chdcmp(matrix);
   return chdcmp.Decompose();
 }

◆ Clone()

template<typename ObjectType >

std::unique_ptr<ObjectType> M3::Clone	(	const ObjectType *	obj,
		const std::string &	name = `""`
	)

KS: Creates a copy of a ROOT-like object and wraps it in a smart pointer.

Template Parameters

ObjectType The type of the object to clone for example TH1D or TH2Poly.

Parameters

obj	Pointer to the object to clone.
name	Optional argument allowing to set new name of cloned object

Returns: std::unique_ptr<ObjectType> Owning pointer to the cloned object.

Definition at line 142 of file HistogramUtils.h.

                                                                                    {
   std::string cloneName = name.empty() ? obj->GetName() : name;
  
   std::unique_ptr<ObjectType> Hist(static_cast<ObjectType*>(obj->Clone(cloneName.c_str())));
   // Disable ROOT memory management because it causes lot of headache especially as smart pointers are much smarter
   Hist->SetDirectory(nullptr);
  
   return Hist;
 }

◆ FixSampleNamesQuotes()

void M3::FixSampleNamesQuotes ( std::string & yamlStr )

inline

KS: Yaml emitter has problem and drops "", if you have special signs in you like * then there is problem. This bit hacky code adds these "".

Parameters

yamlStr The YAML string to be processed (modified in-place).

Definition at line 152 of file ParameterHandlerUtils.h.

                                                      {
 // *************************************
   std::stringstream input(yamlStr);
   std::string line;
   std::string fixedYaml;
   std::regex sampleNamesRegex(R"(SampleNames:\s*\[([^\]]+)\])");
  
   while (std::getline(input, line)) {
     std::smatch match;
     if (std::regex_search(line, match, sampleNamesRegex)) {
       std::string contents = match[1];  // inside the brackets
       std::stringstream ss(contents);
       std::string item;
       std::vector<std::string> quotedItems;
  
       while (std::getline(ss, item, ',')) {
         item = std::regex_replace(item, std::regex(R"(^\s+|\s+$)"), ""); // trim
         quotedItems.push_back("\"" + item + "\"");
       }
  
       std::string replacement = "SampleNames: [" + fmt::format("{}", fmt::join(quotedItems, ", ")) + "]";
       line = std::regex_replace(line, sampleNamesRegex, replacement);
     }
     fixedYaml += line + "\n";
   }
  
   yamlStr = fixedYaml;
 }

◆ fmaf_t()

template<typename T >

constexpr T M3::fmaf_t	(	T	x,
		T	y,
		T	z
	)

constexpr

Function template for fused multiply-add.

Definition at line 45 of file Core.h.

                                     {
     #ifdef _LOW_MEMORY_STRUCTS_
     return std::fmaf(x, y, z);
     #else
     return std::fma(x, y, z);
     #endif
   }

◆ GetCholeskyDecomposedMatrix()

std::vector<std::vector<double> > M3::GetCholeskyDecomposedMatrix	(	const TMatrixDSym &	matrix,
		const std::string &	matrixName
	)

inline

Computes Cholesky decomposition of a symmetric positive definite matrix using custom function which can be even 20 times faster.

Parameters

matrix	Input symmetric positive definite matrix
matrixName	Identifier for error reporting

Definition at line 462 of file ParameterHandlerUtils.h.

                                                                                                                         {
 // *************************************
   const Int_t n = matrix.GetNrows();
   std::vector<std::vector<double>> L(n, std::vector<double>(n, 0.0));
  
   for (Int_t j = 0; j < n; ++j) {
     // Compute diagonal element (must be serial)
     double sum_diag = matrix(j, j);
     for (Int_t k = 0; k < j; ++k) {
       sum_diag -= L[j][k] * L[j][k];
     }
     const double tol = 1e-15;
     if (sum_diag <= tol) {
       MACH3LOG_ERROR("Cholesky decomposition failed for {} (non-positive diagonal)", matrixName);
       throw MaCh3Exception(__FILE__, __LINE__);
     }
     L[j][j] = std::sqrt(sum_diag);
  
     // Compute the rest of the column in parallel
     #ifdef MULTITHREAD
     #pragma omp parallel for
     #endif
     for (Int_t i = j + 1; i < n; ++i) {
       double sum = matrix(i, j);
       for (Int_t k = 0; k < j; ++k) {
         sum -= L[i][k] * L[j][k];
       }
       L[i][j] = sum / L[j][j];
     }
   }
   return L;
 }

◆ GetConfigMacroFromChain()

TMacro* M3::GetConfigMacroFromChain ( TDirectory * CovarianceFolder )

inline

KS: We store configuration macros inside the chain. In the past, multiple configs were stored, which required error-prone hardcoding like "Config_xsec_cov". Therefore, this code maintains backward compatibility by checking the number of macros present and using a hardcoded name only if necessary.

Definition at line 382 of file ParameterHandlerUtils.h.

                                                                      {
 // *************************************
   if (!CovarianceFolder) {
     MACH3LOG_ERROR("Null TDirectory passed to {}", __func__);
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   TMacro* foundMacro = nullptr;
   int macroCount = 0;
  
   TIter next(CovarianceFolder->GetListOfKeys());
   TKey* key;
   while ((key = dynamic_cast<TKey*>(next()))) {
     if (std::string(key->GetClassName()) == "TMacro") {
       ++macroCount;
       if (macroCount == 1) {
         foundMacro = dynamic_cast<TMacro*>(key->ReadObj());
       }
     }
   }
  
   if (macroCount == 1 && foundMacro) {
     MACH3LOG_INFO("Found single TMacro in directory: using it.");
     return foundMacro;
   } else {
     MACH3LOG_WARN("Found {} TMacro objects. Using hardcoded macro name: Config_xsec_cov.", macroCount);
     TMacro* fallback = CovarianceFolder->Get<TMacro>("Config_xsec_cov");
     if (!fallback) {
       MACH3LOG_WARN("Fallback macro 'Config_xsec_cov' not found in directory.");
     }
     return fallback;
   }
 }

◆ GetCovMatrixFromChain()

TMatrixDSym* M3::GetCovMatrixFromChain ( TDirectory * TempFile )

inline

KS: Retrieve the cross-section covariance matrix from the given TDirectory. Historically, multiple covariance matrices could be stored, requiring fragile hardcoded paths like "CovarianceFolder/xsec_cov". This function maintains backward compatibility by:

Using the single matrix present if only one exists,
Otherwise falling back to the hardcoded path. This avoids error-prone assumptions while supporting both old and new formats.

Definition at line 423 of file ParameterHandlerUtils.h.

                                                                 {
 // *************************************
   if (!TempFile) {
     MACH3LOG_ERROR("Null TDirectory passed to {}.", __func__);
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   TMatrixDSym* foundMatrix = nullptr;
   int matrixCount = 0;
  
   TIter next(TempFile->GetListOfKeys());
   TKey* key;
   while ((key = dynamic_cast<TKey*>(next()))) {
     std::string className = key->GetClassName();
     if (className.find("TMatrix") != std::string::npos) {
       ++matrixCount;
       if (matrixCount == 1) {
         foundMatrix = dynamic_cast<TMatrixDSym*>(key->ReadObj());
       }
     }
   }
  
   if (matrixCount == 1 && foundMatrix) {
     MACH3LOG_INFO("Found single TMatrixDSym in directory: using it.");
     return foundMatrix;
   } else {
     MACH3LOG_WARN("Found {} TMatrixDSym objects. Using hardcoded path: xsec_cov.", matrixCount);
     TMatrixDSym* fallback = TempFile->Get<TMatrixDSym>("xsec_cov");
     if (!fallback) {
       MACH3LOG_WARN("Fallback matrix 'xsec_cov' not found.");
     }
     return fallback;
   }
 }

◆ GetNThreads()

int M3::GetNThreads ( )

number of threads which we need for example for TRandom3

Definition at line 372 of file Monitor.cpp.

                   {
 // ***************************************************************************
   #ifdef MULTITHREAD
   return omp_get_max_threads();
   #else
   return 1;
   #endif
 }

◆ GetThreadIndex()

int M3::GetThreadIndex ( )

inline

thread index inside parallel loop

Definition at line 86 of file Monitor.h.

                               {
     #ifdef MULTITHREAD
     return omp_get_thread_num();
     #else
     return 0;
     #endif
   }

◆ MakeCorrelationMatrix()

void M3::MakeCorrelationMatrix	(	YAML::Node &	root,
		const std::vector< double > &	Values,
		const std::vector< double > &	Errors,
		const std::vector< std::vector< double >> &	Correlation,
		const std::string &	OutYAMLName,
		const std::vector< std::string > &	FancyNames = `{}`
	)

inline

KS: Replace correlation matrix and tune values in YAML covariance matrix.

Parameters

root	The root YAML node to be updated.
Values	The new values for each systematic.
Errors	The new errors for each systematic.
Correlation	The new correlation matrix (must be square and match Values size).
OutYAMLName	The output filename for the updated YAML.
FancyNames	Optional list of fancy names to match systematics (must match Values size if provided).

Definition at line 268 of file ParameterHandlerUtils.h.

                                                                            {}) {
 // *************************************
   if (Values.size() != Errors.size() || Values.size() != Correlation.size()) {
     MACH3LOG_ERROR("Size mismatch between Values, Errors, and Correlation matrix");
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   for (const auto& row : Correlation) {
     if (row.size() != Correlation.size()) {
       MACH3LOG_ERROR("Correlation matrix is not square");
       throw MaCh3Exception(__FILE__, __LINE__);
     }
   }
  
   YAML::Node NodeCopy = YAML::Clone(root);
   YAML::Node systematics = NodeCopy["Systematics"];
  
   if (!systematics || !systematics.IsSequence()) {
     MACH3LOG_ERROR("'Systematics' node is missing or not a sequence");
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   if (!FancyNames.empty() && FancyNames.size() != Values.size()) {
     MACH3LOG_ERROR("FancyNames size ({}) does not match Values size ({})", FancyNames.size(), Values.size());
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   // Map from FancyName to Systematic node
   std::unordered_map<std::string, YAML::Node> nameToNode;
   for (std::size_t i = 0; i < systematics.size(); ++i) {
     YAML::Node syst = systematics[i]["Systematic"];
     if (!syst || !syst["Names"] || !syst["Names"]["FancyName"]) continue;
     std::string name = syst["Names"]["FancyName"].as<std::string>();
     nameToNode[name] = syst;
   }
  
   if (!FancyNames.empty()) {
     for (std::size_t i = 0; i < FancyNames.size(); ++i) {
       const std::string& name_i = FancyNames[i];
       auto it_i = nameToNode.find(name_i);
       if (it_i == nameToNode.end()) {
         MACH3LOG_ERROR("Could not find FancyName '{}' in YAML", name_i);
         throw MaCh3Exception(__FILE__, __LINE__);
       }
       YAML::Node& syst_i = it_i->second;
  
       syst_i["ParameterValues"]["PreFitValue"] = MaCh3Utils::FormatDouble(Values[i], 4);
       syst_i["Error"] = std::round(Errors[i] * 100.0) / 100.0;
  
       YAML::Node correlationsNode = YAML::Node(YAML::NodeType::Sequence);
       for (std::size_t j = 0; j < FancyNames.size(); ++j) {
         if (i == j) continue;
         // KS: Skip if value close to 0
         if (std::abs(Correlation[i][j]) < 1e-8) continue;
         YAML::Node singleEntry;
         singleEntry[FancyNames[j]] = MaCh3Utils::FormatDouble(Correlation[i][j], 4);
         correlationsNode.push_back(singleEntry);
       }
       syst_i["Correlations"] = correlationsNode;
     }
   } else {
     if (systematics.size() != Values.size()) {
       MACH3LOG_ERROR("Mismatch in sizes: Values has {}, but YAML 'Systematics' has {} entries",
                      Values.size(), systematics.size());
       throw MaCh3Exception(__FILE__, __LINE__);
     }
  
     for (std::size_t i = 0; i < systematics.size(); ++i) {
       YAML::Node syst = systematics[i]["Systematic"];
       if (!syst) {
         MACH3LOG_ERROR("Missing 'Systematic' node at index {}", i);
         throw MaCh3Exception(__FILE__, __LINE__);
       }
  
       syst["ParameterValues"]["PreFitValue"] = MaCh3Utils::FormatDouble(Values[i], 4);
       syst["Error"] = std::round(Errors[i] * 100.0) / 100.0;
  
       YAML::Node correlationsNode = YAML::Node(YAML::NodeType::Sequence);
       for (std::size_t j = 0; j < Correlation[i].size(); ++j) {
         if (i == j) continue;
         // KS: Skip if value close to 0
         if (std::abs(Correlation[i][j]) < 1e-8) continue;
         YAML::Node singleEntry;
         const std::string& otherName = systematics[j]["Systematic"]["Names"]["FancyName"].as<std::string>();
         singleEntry[otherName] = MaCh3Utils::FormatDouble(Correlation[i][j], 4);
         correlationsNode.push_back(singleEntry);
       }
       syst["Correlations"] = correlationsNode;
     }
   }
  
   // Convert and write
   std::string YAMLString = YAMLtoSTRING(NodeCopy);
   FixSampleNamesQuotes(YAMLString);
   std::ofstream outFile(OutYAMLName);
   if (!outFile) {
     MACH3LOG_ERROR("Failed to open file for writing: {}", OutYAMLName);
     throw MaCh3Exception(__FILE__, __LINE__);
   }
  
   outFile << YAMLString;
   outFile.close();
 }

◆ MakeMatrixPosDef()

void M3::MakeMatrixPosDef ( TMatrixDSym * cov )

inline

Makes sure that matrix is positive-definite by adding a small number to on-diagonal elements.

Definition at line 506 of file ParameterHandlerUtils.h.

                                                {
 // *************************************
   //DB Save original warning state and then increase it in this function to suppress 'matrix not positive definite' messages
   //Means we no longer need to overload
   int originalErrorWarning = gErrorIgnoreLevel;
   gErrorIgnoreLevel = kFatal;
  
   //DB Loop 1000 times adding 1e-9 which tops out at 1e-6 shift on the diagonal before throwing error
   constexpr int MaxAttempts = 1e5;
   const int matrixSize = cov->GetNrows();
   int iAttempt = 0;
   bool CanDecomp = false;
  
   for (iAttempt = 0; iAttempt < MaxAttempts; iAttempt++) {
     if (CanDecomposeMatrix(*cov)) {
       CanDecomp = true;
       break;
     } else {
       #ifdef MULTITHREAD
       #pragma omp parallel for
       #endif
       for (int iVar = 0 ; iVar < matrixSize; iVar++) {
         (*cov)(iVar, iVar) += 1e-9;
       }
     }
   }
  
   if (!CanDecomp) {
     MACH3LOG_ERROR("Tried {} times to shift diagonal but still can not decompose the matrix", MaxAttempts);
     MACH3LOG_ERROR("This indicates that something is wrong with the input matrix");
     throw MaCh3Exception(__FILE__ , __LINE__ );
   }
  
   //DB Resetting warning level
   gErrorIgnoreLevel = originalErrorWarning;
 }

◆ MatrixMult() [1/3]

double** M3::MatrixMult	(	double **	A,
		double **	B,
		int	n
	)

inline

CW: Multi-threaded matrix multiplication.

Definition at line 62 of file ParameterHandlerUtils.h.

                                                           {
   // First make into monolithic array
   double *A_mon = new double[n*n];
   double *B_mon = new double[n*n];
  
   #ifdef MULTITHREAD
   #pragma omp parallel for
   #endif
   for (int i = 0; i < n; ++i) {
     for (int j = 0; j < n; ++j) {
       A_mon[i*n+j] = A[i][j];
       B_mon[i*n+j] = B[i][j];
     }
   }
   //CW: Now call the monolithic calculator
   double *C_mon = MatrixMult(A_mon, B_mon, n);
   delete A_mon;
   delete B_mon;
  
   // Return the double pointer
   double **C = new double*[n];
   #ifdef MULTITHREAD
   #pragma omp parallel for
   #endif
   for (int i = 0; i < n; ++i) {
     C[i] = new double[n];
     for (int j = 0; j < n; ++j) {
       C[i][j] = C_mon[i*n+j];
     }
   }
   delete C_mon;
  
   return C;
 }

◆ MatrixMult() [2/3]

double* M3::MatrixMult	(	double *	A,
		double *	B,
		int	n
	)

inline

CW: Multi-threaded matrix multiplication.

Definition at line 30 of file ParameterHandlerUtils.h.

                                                        {
   //CW: First transpose to increse cache hits
   double *BT = new double[n*n];
   #ifdef MULTITHREAD
   #pragma omp parallel for
   #endif
   for (int i = 0; i < n; i++) {
     for (int j = 0; j < n; j++) {
       BT[j*n+i] = B[i*n+j];
     }
   }
  
   // Now multiply
   double *C = new double[n*n];
   #ifdef MULTITHREAD
   #pragma omp parallel for
   #endif
   for (int i = 0; i < n; i++) {
     for (int j = 0; j < n; j++) {
       double sum = 0;
       for (int k = 0; k < n; k++) {
         sum += A[i*n+k]*BT[j*n+k];
       }
       C[i*n+j] = sum;
     }
   }
   delete BT;
  
   return C;
 }

◆ MatrixMult() [3/3]

TMatrixD M3::MatrixMult	(	TMatrixD	A,
		TMatrixD	B
	)

inline

CW: Multi-threaded matrix multiplication.

Definition at line 98 of file ParameterHandlerUtils.h.

 {
   double *C_mon = MatrixMult(A.GetMatrixArray(), B.GetMatrixArray(), A.GetNcols());
   TMatrixD C;
   C.Use(A.GetNcols(), A.GetNrows(), C_mon);
   return C;
 }

◆ MatrixVectorMulti()

void M3::MatrixVectorMulti	(	double *_restrict_	VecMulti,
		double **_restrict_	matrix,
		const double *_restrict_	vector,
		const int	n
	)

inline

KS: Custom function to perform multiplication of matrix and vector with multithreading.

Parameters

VecMulti	Output Vector, VecMulti = matrix x vector
matrix	This matrix is used for multiplication VecMulti = matrix x vector
vector	This vector is used for multiplication VecMulti = matrix x vector
n	this is size of matrix and vector, we assume matrix is symmetric

Definition at line 112 of file ParameterHandlerUtils.h.

                                                                                                                                      {
 // ********************************************
   #ifdef MULTITHREAD
   #pragma omp parallel for
   #endif
   for (int i = 0; i < n; ++i)
   {
     double result = 0.0;
     #ifdef MULTITHREAD
     #pragma omp simd
     #endif
     for (int j = 0; j < n; ++j)
     {
       result += matrix[i][j]*vector[j];
     }
     VecMulti[i] = result;
   }
 }

◆ MatrixVectorMultiSingle()

double M3::MatrixVectorMultiSingle	(	double **_restrict_	matrix,
		const double *_restrict_	vector,
		const int	Length,
		const int	i
	)

inline

KS: Custom function to perform multiplication of matrix and single element which is thread safe.

Parameters

matrix	This matrix is used for multiplication VecMulti = matrix x vector
vector	This vector is used for multiplication VecMulti = matrix x vector
Length	this is size of matrix and vector, we assume matrix is symmetric
i	Element of matrix that we want to multiply

Definition at line 137 of file ParameterHandlerUtils.h.

                                                                                                                                   {
 // ********************************************
   double Element = 0.0;
   #ifdef MULTITHREAD
   #pragma omp simd
   #endif
   for (int j = 0; j < Length; ++j) {
     Element += matrix[i][j]*vector[j];
   }
   return Element;
 }

◆ Open()

TFile * M3::Open	(	const std::string &	Name,
		const std::string &	Type,
		const std::string &	File,
		const int	Line
	)

Opens a ROOT file with the given name and mode.

This function wraps ROOT’s TFile constructor and checks whether the file was opened successfully and give some useful debugging information

Parameters

Name	The name or path of the file to open.
Type	The file open mode (e.g., "READ", "RECREATE", "UPDATE").
File	The name of the file where the exception occurred.
Line	The line number where the exception occurred.

Returns: Pointer to the opened ROOT file.

Definition at line 627 of file HistogramUtils.cpp.

                                                                                                  {
 // **************************************************************************
   TFile* OutFile = new TFile(Name.c_str(), Type.c_str());
  
   // Check if the file is successfully opened and usable
   if (OutFile->IsZombie()) {
     MACH3LOG_ERROR("Failed to open file: {}", Name);
     std::string lowerType = Type;
     std::transform(lowerType.begin(), lowerType.end(), lowerType.begin(), ::tolower);
     if (lowerType == "recreate") {
       MACH3LOG_ERROR("Check if directory exist");
     }
     delete OutFile;
     throw MaCh3Exception(File, Line);
   }
   return OutFile;
 }

◆ ScaleHistogram()

void M3::ScaleHistogram	(	TH1 *	Sample_Hist,
		const double	scale
	)

Scale histogram to get divided by bin width.

Definition at line 645 of file HistogramUtils.cpp.

 {
   for (int j = 0; j <= Sample_Hist->GetNbinsX(); ++j)
   {
     double num = Sample_Hist->GetBinContent(j);
     double numErr = Sample_Hist->GetBinError(j);
     double den = Sample_Hist->GetBinWidth(j);
     double value = 0.;
     double valueErr = 0.;
     if (den != 0)
     {
       value = num/(den/scale);
       valueErr = numErr/(den/scale);
       Sample_Hist->SetBinContent(j,value);
       Sample_Hist->SetBinError(j,valueErr);
     }
   }
 }

Variable Documentation

◆ _BAD_DOUBLE_

constexpr static const double M3::_BAD_DOUBLE_ = -999.99

staticconstexpr

Default value used for double initialisation.

Definition at line 53 of file Core.h.

◆ _BAD_INT_

constexpr static const int M3::_BAD_INT_ = -999

staticconstexpr

Default value used for int initialisation.

Definition at line 55 of file Core.h.

◆ _DEFAULT_RETURN_VAL_

constexpr static const double M3::_DEFAULT_RETURN_VAL_ = -999999.123456

staticconstexpr

Definition at line 56 of file Core.h.

◆ _LARGE_LOGL_

constexpr static const double M3::_LARGE_LOGL_ = 1234567890.0

staticconstexpr

Large Likelihood is used it parameter go out of physical boundary, this indicates in MCMC that such step should be removed.

Definition at line 80 of file Core.h.

◆ _LOW_MC_BOUND_

constexpr static const double M3::_LOW_MC_BOUND_ = .00001

staticconstexpr

MC prediction lower bound in bin to identify problematic binning definitions and handle LogL calculation.

Definition at line 83 of file Core.h.

◆ DefSplineKnotLowBound

constexpr static const double M3::DefSplineKnotLowBound = -9999

staticconstexpr

Default value for spline knot capping, default mean not capping is being applied.

Definition at line 88 of file Core.h.

◆ DefSplineKnotUpBound

constexpr static const double M3::DefSplineKnotUpBound = 9999

staticconstexpr

Default value for spline knot capping, default mean not capping is being applied.

Definition at line 86 of file Core.h.

◆ float_t_str_repr

constexpr static const char* M3::float_t_str_repr = "D"

staticconstexpr

Definition at line 40 of file Core.h.

◆ KinematicLowBound

constexpr static const double M3::KinematicLowBound = std::numeric_limits<double>::lowest()

staticconstexpr

When parameter has no bound this serves as it. Lowest possible value the system.

Definition at line 75 of file Core.h.

◆ KinematicUpBound

constexpr static const double M3::KinematicUpBound = std::numeric_limits<double>::max()

staticconstexpr

When parameter has no bound this serves as it. Highest possible value the system.

Definition at line 77 of file Core.h.

◆ UnderOverFlowBin

constexpr static const int M3::UnderOverFlowBin = -1

staticconstexpr

Mark bin which is overflow or underflow in MaCh3 binning.

Definition at line 91 of file Core.h.

◆ Unity

constexpr static const float_t M3::Unity = Unity_D

staticconstexpr

Definition at line 64 of file Core.h.

◆ Unity_D

constexpr static const double M3::Unity_D = 1.

staticconstexpr

Some commonly used variables to which we set pointers to.

Definition at line 59 of file Core.h.

◆ Unity_F

constexpr static const float M3::Unity_F = 1.

staticconstexpr

Definition at line 60 of file Core.h.

◆ Zero

constexpr static const float_t M3::Zero = Zero_D

staticconstexpr

Definition at line 71 of file Core.h.

◆ Zero_D

constexpr static const double M3::Zero_D = 0.

staticconstexpr

Definition at line 66 of file Core.h.

◆ Zero_F

constexpr static const float M3::Zero_F = 0.

staticconstexpr

Definition at line 67 of file Core.h.

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ float_t

◆ int_t

◆ uint_t

Enumeration Type Documentation

◆ kInfCrit

Function Documentation

◆ AddPath()

◆ AddTuneValues()

◆ CanDecomposeMatrix()

◆ Clone()

◆ FixSampleNamesQuotes()

◆ fmaf_t()

◆ GetCholeskyDecomposedMatrix()

◆ GetConfigMacroFromChain()

◆ GetCovMatrixFromChain()

◆ GetNThreads()

◆ GetThreadIndex()

◆ MakeCorrelationMatrix()

◆ MakeMatrixPosDef()

◆ MatrixMult() [1/3]

◆ MatrixMult() [2/3]

◆ MatrixMult() [3/3]

◆ MatrixVectorMulti()

◆ MatrixVectorMultiSingle()

◆ Open()

◆ ScaleHistogram()

Variable Documentation

◆ _BAD_DOUBLE_

◆ _BAD_INT_

◆ _DEFAULT_RETURN_VAL_

◆ _LARGE_LOGL_

◆ _LOW_MC_BOUND_

◆ DefSplineKnotLowBound

◆ DefSplineKnotUpBound

◆ float_t_str_repr

◆ KinematicLowBound

◆ KinematicUpBound

◆ UnderOverFlowBin

◆ Unity

◆ Unity_D

◆ Unity_F

◆ Zero

◆ Zero_D

◆ Zero_F