The namespace of the functions and classes of internal auxiliary use More...

Classes
class	Distribution
	The class CombinedDistribution. More...

class	Exception
	The class Exception. More...

class	FuncGrid
	The class FuncGrid. More...

class	FuncGrid2D
	The class FuncGrid2D. More...

class	Histogram
	The class Histogram. More...

class	Histogram2D
	The class Histogram2D. More...

class	LegendrePolynomials
	The class LegendrePolynomials. More...

class	ParameterFile
	The class ParameterFile. More...

class	ReadParameters
	The class ReadParameters. More...

class	SphericalHarmonics_Coefficients
	The class SphericalHarmonics_Coefficients. More...

Typedefs
typedef std::unordered_map< std::string, std::vector< std::string > >	parameter_map
	Map type used in ParameterFile class.

Enumerations
enum class	DistributionType { _Constant_ , _Uniform_ , _Gaussian_ , _Poisson_ , _Custom_ , _Interpolated_ , _Discrete_ }
	the distribution type More...

enum class	ExitCode { _error_ , _IO_ , _workInProgress_ }
	the exit status More...

enum class	HistogramType { _N_V_ , _n_V_ , _dn_dV_ , _dn_dlogV_ , _dn_dlnV_ }
	the histogram type More...

Functions
std::vector< std::string >	DistributionTypeNames ()
	return a vector containing the DistributionType names More...

DistributionType	DistributionTypeCast (const int distributionTypeIndex)
	cast an enum of type DistributionType from its index More...

DistributionType	DistributionTypeCast (const std::string distributionTypeName)
	cast an enum of type DistributionType from its name More...

std::vector< DistributionType >	DistributionTypeCast (const std::vector< int > distributionTypeIndeces)
	cast an enum of type DistributionType from indeces More...

std::vector< DistributionType >	DistributionTypeCast (const std::vector< std::string > distributionTypeNames)
	cast an enum of type DistributionType from thier names More...

std::vector< std::string >	ExitCodeNames ()
	return a std::vector containing the ExitCode names More...

ExitCode	ExitCodeCast (const int exitCodeIndex)
	cast an enum of type ExitCode from its index More...

ExitCode	ExitCodeCast (const std::string exitCodeName)
	cast an enum of type ExitCode from its name More...

std::vector< ExitCode >	ExitCodeCast (const std::vector< int > exitCodeIndeces)
	cast an enum of type ExitCode from indeces More...

std::vector< ExitCode >	ExitCodeCast (const std::vector< std::string > exitCodeNames)
	cast an enum of type ExitCode from thier names More...

std::vector< std::string >	HistogramTypeNames ()
	return a vector containing the HistogramType names More...

HistogramType	HistogramTypeCast (const int histogramTypeIndex)
	cast an enum of type HistogramType from its index More...

HistogramType	HistogramTypeCast (const std::string histogramTypeName)
	cast an enum of type HistogramType from its name More...

std::vector< HistogramType >	HistogramTypeCast (const std::vector< int > histogramTypeIndeces)
	cast an enum of type HistogramType from indeces More...

std::vector< HistogramType >	HistogramTypeCast (const std::vector< std::string > histogramTypeNames)
	cast an enum of type HistogramType from thier names More...

Detailed Description

The namespace of the functions and classes of internal auxiliary use

The glob namespace contains all classes, structures and functions of internal auxiliary use

Enumeration Type Documentation

◆ DistributionType

enum cbl::glob::DistributionType

strong

the distribution type

Enumerator
_Constant_	Constant function.
_Uniform_	Identity function.
_Gaussian_	Gaussian function.
_Poisson_	Poisson function.
_Custom_	Custom function.
_Interpolated_	User defined Tabulated Function.
_Discrete_	Discrete distribution.

Definition at line 51 of file Distribution.h.

◆ ExitCode

enum cbl::glob::ExitCode

strong

the exit status

Enumerator
_error_	generic error
_IO_	error related to the Input/Output
_workInProgress_	error due to work in progress

Definition at line 45 of file Exception.h.

◆ HistogramType

enum cbl::glob::HistogramType

strong

the histogram type

Enumerator
_N_V_	the binned counts, \(N_V[i]\)
_n_V_	the normalised binned counts, i.e. \(n_V[i]=N_V[i]/fact\), where the factor \(fact\) is a number provided in input
_dn_dV_	\(n_V[i]/(edge[i+1]-edge[i])\), where \(edge\) are the bin limits
_dn_dlogV_	\(n_V[i]/(\log_{10}(edge[i+1])-\log_{10}(edge[i]))\), where \(edge\) are the bin limits
_dn_dlnV_	\(n_V[i]/(\ln(edge[i+1])-\ln(edge[i]))\), where \(edge\) are the bin limits

Definition at line 49 of file Histogram.h.

Function Documentation

◆ DistributionTypeCast() [1/4]

DistributionType cbl::glob::DistributionTypeCast ( const int distributionTypeIndex )

inline

cast an enum of type DistributionType from its index

Parameters

distributionTypeIndex the distributionType index

Returns: object of class DistributionType

Definition at line 90 of file Distribution.h.

◆ DistributionTypeCast() [2/4]

DistributionType cbl::glob::DistributionTypeCast ( const std::string distributionTypeName )

inline

cast an enum of type DistributionType from its name

Parameters

distributionTypeName the distributionType name

Returns: object of class DistributionType

Definition at line 98 of file Distribution.h.

◆ DistributionTypeCast() [3/4]

std::vector<DistributionType> cbl::glob::DistributionTypeCast ( const std::vector< int > distributionTypeIndeces )

inline

cast an enum of type DistributionType from indeces

Parameters

distributionTypeIndeces the distributionType indeces

Returns: vector of objects of class DistributionType

Definition at line 106 of file Distribution.h.

◆ DistributionTypeCast() [4/4]

std::vector<DistributionType> cbl::glob::DistributionTypeCast ( const std::vector< std::string > distributionTypeNames )

inline

cast an enum of type DistributionType from thier names

Parameters

distributionTypeNames the distributionType names

Returns: vector of objects of class DistributionType

Definition at line 114 of file Distribution.h.

◆ DistributionTypeNames()

std::vector<std::string> cbl::glob::DistributionTypeNames ( )

inline

return a vector containing the DistributionType names

Returns: a vector containing the DistributionType names

Definition at line 82 of file Distribution.h.

◆ ExitCodeCast() [1/4]

ExitCode cbl::glob::ExitCodeCast ( const int exitCodeIndex )

inline

cast an enum of type ExitCode from its index

Parameters

exitCodeIndex the exitCode index

Returns: object of class ExitCode

Definition at line 73 of file Exception.h.

◆ ExitCodeCast() [2/4]

ExitCode cbl::glob::ExitCodeCast ( const std::string exitCodeName )

inline

cast an enum of type ExitCode from its name

Parameters

exitCodeName the exitCode name

Returns: object of class ExitCode

Definition at line 82 of file Exception.h.

◆ ExitCodeCast() [3/4]

std::vector<ExitCode> cbl::glob::ExitCodeCast ( const std::vector< int > exitCodeIndeces )

inline

cast an enum of type ExitCode from indeces

Parameters

exitCodeIndeces the exitCode indeces

Returns: std::vector of objects of class ExitCode

Definition at line 90 of file Exception.h.

◆ ExitCodeCast() [4/4]

std::vector<ExitCode> cbl::glob::ExitCodeCast ( const std::vector< std::string > exitCodeNames )

inline

cast an enum of type ExitCode from thier names

Parameters

exitCodeNames the exitCode names

Returns: std::vector of objects of class ExitCode

Definition at line 99 of file Exception.h.

◆ ExitCodeNames()

std::vector<std::string> cbl::glob::ExitCodeNames ( )

inline

return a std::vector containing the ExitCode names

Returns: a std::vector containing the ExitCode names

Definition at line 64 of file Exception.h.

◆ HistogramTypeCast() [1/4]

HistogramType cbl::glob::HistogramTypeCast ( const int histogramTypeIndex )

inline

cast an enum of type HistogramType from its index

Parameters

histogramTypeIndex the histogramType index

Returns: object of class HistogramType

Definition at line 83 of file Histogram.h.

◆ HistogramTypeCast() [2/4]

HistogramType cbl::glob::HistogramTypeCast ( const std::string histogramTypeName )

inline

cast an enum of type HistogramType from its name

Parameters

histogramTypeName the histogramType name

Returns: object of class HistogramType

Definition at line 92 of file Histogram.h.

◆ HistogramTypeCast() [3/4]

std::vector<HistogramType> cbl::glob::HistogramTypeCast ( const std::vector< int > histogramTypeIndeces )

inline

cast an enum of type HistogramType from indeces

Parameters

histogramTypeIndeces the histogramType indeces

Returns: vector of objects of class HistogramType

Definition at line 101 of file Histogram.h.

◆ HistogramTypeCast() [4/4]

std::vector<HistogramType> cbl::glob::HistogramTypeCast ( const std::vector< std::string > histogramTypeNames )

inline

cast an enum of type HistogramType from thier names

Parameters

histogramTypeNames the histogramType names

Returns: vector of objects of class HistogramType

Definition at line 110 of file Histogram.h.

◆ HistogramTypeNames()

std::vector<std::string> cbl::glob::HistogramTypeNames ( )

inline

return a vector containing the HistogramType names

Returns: a vector containing the HistogramType names

Definition at line 74 of file Histogram.h.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ DistributionType

◆ ExitCode

◆ HistogramType

Function Documentation

◆ DistributionTypeCast() [1/4]

◆ DistributionTypeCast() [2/4]

◆ DistributionTypeCast() [3/4]

◆ DistributionTypeCast() [4/4]

◆ DistributionTypeNames()

◆ ExitCodeCast() [1/4]

◆ ExitCodeCast() [2/4]

◆ ExitCodeCast() [3/4]

◆ ExitCodeCast() [4/4]

◆ ExitCodeNames()

◆ HistogramTypeCast() [1/4]

◆ HistogramTypeCast() [2/4]

◆ HistogramTypeCast() [3/4]

◆ HistogramTypeCast() [4/4]

◆ HistogramTypeNames()