A distribution (or histogram) of values for a real variable. More...

#include <Distribution.h>

Inheritance diagram for Util::Distribution:

Public Member Functions
	Distribution ()
	Default constructor. More...

	Distribution (const Distribution &other)
	Copy constructor. More...

Distribution &	operator= (const Distribution &other)
	Assignment operator. More...

virtual	~Distribution ()
	Destructor. More...

virtual void	readParameters (std::istream &in)
	Read parameters from file and initialize. More...

void	setParam (double min, double max, int nBin)
	Set parameters and initialize. More...

virtual void	loadParameters (Serializable::IArchive &ar)
	Load internal state from an archive. More...

virtual void	save (Serializable::OArchive &ar)
	Save internal state to an archive. More...

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	Serialize this Distribution to/from an archive. More...

void	sample (double value)
	Sample a value. More...

virtual void	clear ()
	Clear (i.e., zero) previously allocated histogram. More...

void	output (std::ostream &out)
	Output the distribution to file. More...

int	binIndex (double value) const
	Return the index of the bin for a value. More...

double	min () const
	Get minimum value in range of histogram. More...

double	max () const
	Get maximum value in range of histogram. More...

double	binWidth () const
	Get binWidth, the width of each bin. More...

int	nBin () const
	Get the number of bins. More...

void	reduce (MPI::Intracomm &communicator, int root)
	Reduce (add) distributions from multiple MPI processors. More...

Public Member Functions inherited from Util::ParamComposite
	ParamComposite ()
	Constructor. More...

	ParamComposite (const ParamComposite &other)
	Copy constructor. More...

	ParamComposite (int capacity)
	Constructor. More...

virtual	~ParamComposite ()
	Virtual destructor. More...

void	resetParam ()
	Resets ParamComposite to its empty state. More...

virtual void	readParam (std::istream &in)
	Read the parameter file block. More...

virtual void	readParamOptional (std::istream &in)
	Read optional parameter file block. More...

virtual void	writeParam (std::ostream &out) const
	Write all parameters to an output stream. More...

virtual void	load (Serializable::IArchive &ar)
	Load all parameters from an input archive. More...

virtual void	loadOptional (Serializable::IArchive &ar)
	Load an optional ParamComposite. More...

void	saveOptional (Serializable::OArchive &ar)
	Saves isActive flag, and then calls save() iff isActive is true. More...

void	readParamComposite (std::istream &in, ParamComposite &child, bool next=true)
	Add and read a required child ParamComposite. More...

void	readParamCompositeOptional (std::istream &in, ParamComposite &child, bool next=true)
	Add and attempt to read an optional child ParamComposite. More...

template<typename Type >
ScalarParam< Type > &	read (std::istream &in, const char *label, Type &value)
	Add and read a new required ScalarParam < Type > object. More...

template<typename Type >
ScalarParam< Type > &	readOptional (std::istream &in, const char *label, Type &value)
	Add and read a new optional ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	readCArray (std::istream &in, const char label, Type value, int n)
	Add and read a required C array parameter. More...

template<typename Type >
CArrayParam< Type > &	readOptionalCArray (std::istream &in, const char label, Type value, int n)
	Add and read an optional C array parameter. More...

template<typename Type >
DArrayParam< Type > &	readDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read a required DArray < Type > parameter. More...

template<typename Type >
DArrayParam< Type > &	readOptionalDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read an optional DArray < Type > parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	readFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read a required FArray < Type, N > array parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	readOptionalFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read an optional FArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	readFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read a required FSArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	readOptionalFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read an optional FSArray < Type, N > array parameter. More...

template<typename Type >
CArray2DParam< Type > &	readCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read a required CArray2DParam < Type > 2D C-array. More...

template<typename Type >
CArray2DParam< Type > &	readOptionalCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read an optional CArray2DParam < Type > 2D C-array parameter. More...

template<typename Type >
DMatrixParam< Type > &	readDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read a required DMatrix < Type > matrix parameter. More...

template<typename Type >
DMatrixParam< Type > &	readOptionalDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read an optional DMatrix < Type > matrix parameter. More...

template<typename Type >
DSymmMatrixParam< Type > &	readDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read a required symmetrix DMatrix. More...

template<typename Type >
DSymmMatrixParam< Type > &	readOptionalDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read an optional DMatrix matrix parameter. More...

Begin &	readBegin (std::istream &in, const char *label, bool isRequired=true)
	Add and read a class label and opening bracket. More...

End &	readEnd (std::istream &in)
	Add and read the closing bracket. More...

Blank &	readBlank (std::istream &in)
	Add and read a new Blank object, representing a blank line. More...

void	loadParamComposite (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load a required child ParamComposite. More...

void	loadParamCompositeOptional (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load an optional child ParamComposite if isActive. More...

template<typename Type >
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value, bool isRequired)
	Add and load a new ScalarParam < Type > object. More...

template<typename Type >
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value)
	Add and load new required ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n, bool isRequired)
	Add a C array parameter and load its elements. More...

template<typename Type >
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n)
	Add and load a required CArrayParam< Type > array parameter. More...

template<typename Type >
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n, bool isRequired)
	Add an load a DArray < Type > array parameter. More...

template<typename Type >
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n)
	Add and load a required DArray< Type > array parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array, bool isRequired)
	Add and load an FArray < Type, N > fixed-size array parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array)
	Add and load a required FArray < Type > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size, bool isRequired)
	Add and load an FSArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size)
	Add and load a required FSArray < Type > array parameter. More...

template<typename Type >
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np, bool isRequired)
	Add and load a CArray2DParam < Type > C 2D array parameter. More...

template<typename Type >
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np)
	Add and load a required < Type > matrix parameter. More...

template<typename Type >
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired)
	Add and load a DMatrixParam < Type > matrix parameter. More...

template<typename Type >
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and load a required DMatrixParam < Type > matrix parameter. More...

template<typename Type >
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n, bool isRequired)
	Add and load a symmetric DSymmMatrixParam < Type > matrix parameter. More...

template<typename Type >
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n)
	Add and load a required DSymmMatrixParam < Type > matrix parameter. More...

void	addParamComposite (ParamComposite &child, bool next=true)
	Add a child ParamComposite object to the format array. More...

Begin &	addBegin (const char *label)
	Add a Begin object representing a class name and bracket. More...

End &	addEnd ()
	Add a closing bracket. More...

Blank &	addBlank ()
	Create and add a new Blank object, representing a blank line. More...

std::string	className () const
	Get class name string. More...

bool	isRequired () const
	Is this ParamComposite required in the input file? More...

bool	isActive () const
	Is this parameter active? More...

Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor. More...

virtual void	readParam (std::istream &in)=0
	Read parameter(s) from file. More...

virtual void	writeParam (std::ostream &out) const =0
	Read parameter(s) to file. More...

virtual void	load (Serializable::IArchive &ar)
	Load internal state from an archive. More...

virtual void	save (Serializable::OArchive &ar)
	Save internal state to an archive. More...

virtual void	resetParam ()
	Nontrivial implementation provided by ParamComposite subclass. More...

void	setIndent (const ParamComponent &parent, bool next=true)
	Set indent level. More...

std::string	indent () const
	Return indent string for this object (string of spaces). More...

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	Serialize this ParamComponent as a string. More...

Public Member Functions inherited from Util::Serializable
virtual	~Serializable ()
	Destructor. More...

virtual void	save (OArchive &ar)=0
	Save to an archive. More...

virtual void	load (IArchive &ar)=0
	Load from an archive. More...

Public Member Functions inherited from Util::MpiFileIo
	MpiFileIo ()
	Constructor. More...

	MpiFileIo (const MpiFileIo &other)
	Copy constructor. More...

bool	isIoProcessor () const
	Can this processor do file I/O ? More...

void	setIoCommunicator (MPI::Intracomm &communicator)
	Set the communicator. More...

void	clearCommunicator ()
	Clear (nullify) the communicator. More...

bool	hasIoCommunicator () const
	Does this object have an associated MPI communicator? More...

MPI::Intracomm &	ioCommunicator () const
	Get the MPI communicator by reference. More...

Protected Attributes
DArray< long >	histogram_
	Histogram of occurences, one element per bin. More...

double	min_
	minimum value. More...

double	max_
	maximum value. More...

double	binWidth_
	width of bin = (max_-min_)/nBin_ . More...

int	nBin_
	number of bins. More...

int	nSample_
	Number of sampled values in Histogram. More...

int	nReject_
	Number of sampled values that were out of range. More...

Additional Inherited Members
Public Types inherited from Util::Serializable
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method. More...

typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method. More...

Static Public Member Functions inherited from Util::ParamComponent
static void	initStatic ()
	Initialize static echo member to false. More...

static void	setEcho (bool echo=true)
	Enable or disable echoing for all subclasses of ParamComponent. More...

static bool	echo ()
	Get echo parameter. More...

Protected Member Functions inherited from Util::ParamComposite
void	setClassName (const char *className)
	Set class name string. More...

void	setIsRequired (bool isRequired)
	Set or unset the isActive flag. More...

void	setIsActive (bool isActive)
	Set or unset the isActive flag. More...

void	setParent (ParamComponent &param, bool next=true)
	Set this to the parent of a child component. More...

void	addComponent (ParamComponent &param, bool isLeaf=true)
	Add a new ParamComponent object to the format array. More...

template<typename Type >
ScalarParam< Type > &	add (std::istream &in, const char *label, Type &value, bool isRequired=true)
	Add a new required ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	addCArray (std::istream &in, const char label, Type value, int n, bool isRequired=true)
	Add (but do not read) a required C array parameter. More...

template<typename Type >
DArrayParam< Type > &	addDArray (std::istream &in, const char *label, DArray< Type > &array, int n, bool isRequired=true)
	Add (but do not read) a DArray < Type > parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	addFArray (std::istream &in, const char *label, FArray< Type, N > &array, bool isRequired=true)
	Add (but do not read) a FArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	addFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size, bool isRequired=true)
	Add (but do not read) a FSArray < Type, N > array parameter. More...

template<typename Type >
CArray2DParam< Type > &	addCArray2D (std::istream &in, const char label, Type value, int m, int n, int np, bool isRequired=true)
	Add (but do not read) a CArray2DParam < Type > 2D C-array. More...

template<typename Type >
DMatrixParam< Type > &	addDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired=true)
	Add and read a required DMatrix < Type > matrix parameter. More...

Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor. More...

	ParamComponent (const ParamComponent &other)
	Copy constructor. More...

Detailed Description

A distribution (or histogram) of values for a real variable.

Definition at line 23 of file Distribution.h.

Constructor & Destructor Documentation

◆ Distribution() [1/2]

Util::Distribution::Distribution ( )

Default constructor.

Definition at line 18 of file Distribution.cpp.

References Util::ParamComposite::setClassName().

◆ Distribution() [2/2]

Util::Distribution::Distribution ( const Distribution & other )

Copy constructor.

Parameters

other Distribution to be copied.

Definition at line 31 of file Distribution.cpp.

References Util::DArray< Data >::allocate(), Util::Array< Data >::capacity(), histogram_, nBin_, nReject_, and nSample_.

◆ ~Distribution()

Util::Distribution::~Distribution ( )

virtual

Destructor.

Definition at line 94 of file Distribution.cpp.

Member Function Documentation

◆ operator=()

Distribution & Util::Distribution::operator= ( const Distribution & other )

Assignment operator.

Parameters

other Distribution to be assigned.

Definition at line 57 of file Distribution.cpp.

References Util::DArray< Data >::allocate(), binWidth_, Util::Array< Data >::capacity(), histogram_, max_, min_, nBin_, nReject_, and nSample_.

Referenced by Util::RadialDistribution::operator=().

◆ readParameters()

void Util::Distribution::readParameters ( std::istream & in )

virtual

Read parameters from file and initialize.

Read values of min, max, and nBin from file. Allocate histogram array and clear all accumulators.

Parameters

in	input parameter file stream

Reimplemented from Util::ParamComposite.

Reimplemented in Util::RadialDistribution.

Definition at line 100 of file Distribution.cpp.

References Util::DArray< Data >::allocate(), binWidth_, clear(), histogram_, max_, min_, and nBin_.

◆ setParam()

void Util::Distribution::setParam	(	double	min,
		double	max,
		int	nBin
	)

Set parameters and initialize.

Parameters

min	lower bound of range
max	upper bound of range
nBin	number of bins in range [min, max]

Definition at line 117 of file Distribution.cpp.

References Util::DArray< Data >::allocate(), binWidth_, clear(), histogram_, max(), max_, min(), min_, nBin(), and nBin_.

◆ loadParameters()

void Util::Distribution::loadParameters ( Serializable::IArchive & ar )

virtual

Load internal state from an archive.

Parameters

ar	input/loading archive

Reimplemented from Util::ParamComposite.

Reimplemented in Util::RadialDistribution.

Definition at line 130 of file Distribution.cpp.

References binWidth_, Util::Array< Data >::capacity(), Util::feq(), histogram_, max_, min_, nBin_, nReject_, nSample_, and UTIL_THROW.

◆ save()

void Util::Distribution::save ( Serializable::OArchive & ar )

virtual

Save internal state to an archive.

Parameters

ar	output/saving archive

Reimplemented from Util::ParamComposite.

Reimplemented in Util::RadialDistribution.

Definition at line 152 of file Distribution.cpp.

◆ serialize()

template<class Archive >

void Util::Distribution::serialize	(	Archive &	ar,
		const unsigned int	version
	)

Serialize this Distribution to/from an archive.

Parameters

ar	input or output archive
version	file version id

Definition at line 198 of file Distribution.h.

References binWidth_, Util::Array< Data >::capacity(), Util::feq(), histogram_, max_, min_, nBin_, nReject_, nSample_, and UTIL_THROW.

Referenced by Util::RadialDistribution::serialize().

◆ sample()

void Util::Distribution::sample ( double value )

Sample a value.

Parameters

value current value

Definition at line 170 of file Distribution.cpp.

References binIndex(), histogram_, max_, min_, nReject_, and nSample_.

◆ clear()

void Util::Distribution::clear ( )

virtual

Clear (i.e., zero) previously allocated histogram.

Reimplemented in Util::RadialDistribution.

Definition at line 158 of file Distribution.cpp.

References histogram_, nBin_, nReject_, and nSample_.

Referenced by Util::RadialDistribution::clear(), readParameters(), and setParam().

◆ output()

void Util::Distribution::output ( std::ostream & out )

Output the distribution to file.

Parameters

out	output stream

Definition at line 185 of file Distribution.cpp.

References binWidth_, histogram_, min_, nBin_, and nSample_.

◆ binIndex()

int Util::Distribution::binIndex ( double value ) const

inline

Return the index of the bin for a value.

Parameters

value sampled value

Definition at line 167 of file Distribution.h.

References binWidth_, and min_.

Referenced by sample().

◆ min()

double Util::Distribution::min ( ) const

inline

Get minimum value in range of histogram.

Definition at line 173 of file Distribution.h.

References min_.

Referenced by setParam().

◆ max()

double Util::Distribution::max ( ) const

inline

Get maximum value in range of histogram.

Definition at line 179 of file Distribution.h.

References max_.

Referenced by Util::RadialDistribution::setParam(), and setParam().

◆ binWidth()

double Util::Distribution::binWidth ( ) const

inline

Get binWidth, the width of each bin.

Definition at line 185 of file Distribution.h.

References binWidth_.

◆ nBin()

int Util::Distribution::nBin ( ) const

inline

Get the number of bins.

Definition at line 191 of file Distribution.h.

References nBin_.

Referenced by Util::RadialDistribution::setParam(), and setParam().

◆ reduce()

void Util::Distribution::reduce	(	MPI::Intracomm &	communicator,
		int	root
	)

Reduce (add) distributions from multiple MPI processors.

Parameters

communicator	MPI communicator
root	rank of MPI root processor for reduction

Definition at line 200 of file Distribution.cpp.

References Util::Array< Data >::cArray(), histogram_, nBin_, nReject_, and nSample_.

Member Data Documentation

◆ histogram_

DArray<long> Util::Distribution::histogram_

protected

Histogram of occurences, one element per bin.

Definition at line 152 of file Distribution.h.

Referenced by clear(), Distribution(), loadParameters(), Util::RadialDistribution::loadParameters(), operator=(), output(), Util::RadialDistribution::output(), readParameters(), Util::RadialDistribution::readParameters(), reduce(), sample(), serialize(), Util::RadialDistribution::setParam(), and setParam().

◆ min_

double Util::Distribution::min_

protected

minimum value.

Definition at line 153 of file Distribution.h.

Referenced by binIndex(), loadParameters(), Util::RadialDistribution::loadParameters(), min(), operator=(), output(), readParameters(), Util::RadialDistribution::readParameters(), sample(), serialize(), Util::RadialDistribution::setParam(), and setParam().

◆ max_

double Util::Distribution::max_

protected

maximum value.

Definition at line 154 of file Distribution.h.

Referenced by loadParameters(), Util::RadialDistribution::loadParameters(), max(), operator=(), readParameters(), Util::RadialDistribution::readParameters(), sample(), serialize(), Util::RadialDistribution::setParam(), and setParam().

◆ binWidth_

double Util::Distribution::binWidth_

protected

width of bin = (max_-min_)/nBin_ .

Definition at line 155 of file Distribution.h.

Referenced by binIndex(), binWidth(), loadParameters(), Util::RadialDistribution::loadParameters(), operator=(), output(), Util::RadialDistribution::output(), readParameters(), Util::RadialDistribution::readParameters(), serialize(), Util::RadialDistribution::setParam(), and setParam().

◆ nBin_

int Util::Distribution::nBin_

protected

number of bins.

Definition at line 156 of file Distribution.h.

Referenced by clear(), Distribution(), loadParameters(), Util::RadialDistribution::loadParameters(), nBin(), operator=(), output(), Util::RadialDistribution::output(), readParameters(), Util::RadialDistribution::readParameters(), reduce(), serialize(), Util::RadialDistribution::setParam(), and setParam().

◆ nSample_

int Util::Distribution::nSample_

protected

Number of sampled values in Histogram.

Definition at line 157 of file Distribution.h.

Referenced by clear(), Distribution(), loadParameters(), Util::RadialDistribution::loadParameters(), operator=(), output(), reduce(), sample(), and serialize().

◆ nReject_

int Util::Distribution::nReject_

protected

Number of sampled values that were out of range.

Definition at line 158 of file Distribution.h.

Referenced by clear(), Distribution(), loadParameters(), Util::RadialDistribution::loadParameters(), operator=(), reduce(), sample(), and serialize().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Distribution() [1/2]

◆ Distribution() [2/2]

◆ ~Distribution()

Member Function Documentation

◆ operator=()

◆ readParameters()

◆ setParam()

◆ loadParameters()

◆ save()

◆ serialize()

◆ sample()

◆ clear()

◆ output()

◆ binIndex()

◆ min()

◆ max()

◆ binWidth()

◆ nBin()

◆ reduce()

Member Data Documentation

◆ histogram_

◆ min_

◆ max_

◆ binWidth_

◆ nBin_

◆ nSample_

◆ nReject_