NuisanceSpec.h File Reference

Data structures for nuisance-parameter specifications. More...

#include <ostream>
#include <utility>
#include <unordered_map>
#include "ParamID.h"
#include "MarginalType.h"

Include dependency graph for NuisanceSpec.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	NuisanceSpec
	Specification of one nuisance parameter. More...
struct	NuisanceRegistryPrintable
	Lightweight wrapper enabling pretty-printing of a nuisance registry. More...

Typedefs
using	NuisanceRegistry = std::unordered_map< ParamId, NuisanceSpec >
	Registry of nuisance specifications indexed by parameter id.

Functions
const char *	to_string (MarginalType type)
	Converts a marginal type to a stable diagnostic string.
std::ostream &	operator<< (std::ostream &os, const NuisanceSpec &spec)
	Streams a compact representation of one nuisance specification.
NuisanceRegistryPrintable	as_printable (const NuisanceRegistry &registry)
	Wraps a registry for formatted stream output.
std::ostream &	operator<< (std::ostream &os, const NuisanceRegistryPrintable &printable)
	Streams a multi-line representation of a nuisance registry.

Detailed Description

Data structures for nuisance-parameter specifications.

Nuisance specifications associate an LHA parameter id with allowed bounds and the marginal distribution used when building nuisance constraints.

Definition in file NuisanceSpec.h.

Typedef Documentation

NuisanceRegistry

using NuisanceRegistry = std::unordered_map<ParamId, NuisanceSpec>

Registry of nuisance specifications indexed by parameter id.

Definition at line 36 of file NuisanceSpec.h.

Function Documentation

as_printable()

NuisanceRegistryPrintable as_printable ( const NuisanceRegistry &  registry )

inline

Wraps a registry for formatted stream output.

Parameters

registry

Registry to print.

Returns

Non-owning printable wrapper around registry.

Definition at line 91 of file NuisanceSpec.h.

operator<<() [1/2]

std::ostream & operator<< ( std::ostream &  os, const NuisanceRegistryPrintable &  printable  )

inline

Streams a multi-line representation of a nuisance registry.

Parameters

os	Output stream.
printable	Printable registry wrapper.

Returns

Reference to os.

Definition at line 103 of file NuisanceSpec.h.

operator<<() [2/2]

std::ostream & operator<< ( std::ostream &  os, const NuisanceSpec &  spec  )

inline

Streams a compact representation of one nuisance specification.

Parameters

os	Output stream.
spec	Nuisance specification to print.

Returns

Reference to os.

Definition at line 64 of file NuisanceSpec.h.

to_string()

const char * to_string ( MarginalType  type )

inline

Converts a marginal type to a stable diagnostic string.

Parameters

type	Marginal type to stringify.

Returns

String literal representing type, or "UNKNOWN" for unrecognized values.

Definition at line 46 of file NuisanceSpec.h.