A distribution (or histogram) of values for an int variable. More...

#include <IntDistribution.h>

Inheritance diagram for Util::IntDistribution:

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

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

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

virtual	~IntDistribution ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

const DArray< long > &	data () const
	Get histogram array. 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 array. More...

int	min_
	minimum value. More...

int	max_
	maximum value. 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 an int variable.

Definition at line 22 of file IntDistribution.h.

Constructor & Destructor Documentation

◆ IntDistribution() [1/2]

Util::IntDistribution::IntDistribution ( )

Default constructor.

Definition at line 18 of file IntDistribution.cpp.

References Util::ParamComposite::setClassName().

◆ IntDistribution() [2/2]

Util::IntDistribution::IntDistribution ( const IntDistribution & other )

Copy constructor.

Parameters

other object to be copied

Definition at line 30 of file IntDistribution.cpp.

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

◆ ~IntDistribution()

Util::IntDistribution::~IntDistribution ( )

virtual

Destructor.

Definition at line 96 of file IntDistribution.cpp.

Member Function Documentation

◆ operator=()

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

Assignment operator.

Parameters

other object to be assigned

Definition at line 57 of file IntDistribution.cpp.

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

◆ readParameters()

void Util::IntDistribution::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.

Definition at line 102 of file IntDistribution.cpp.

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

◆ setParam()

void Util::IntDistribution::setParam	(	int	min,
		int	max
	)

Set parameters and initialize.

Parameters

min	lower bound of range
max	upper bound of range

Definition at line 114 of file IntDistribution.cpp.

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

◆ loadParameters()

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

virtual

Load state from an archive.

Parameters

ar	binary loading (input) archive.

Reimplemented from Util::ParamComposite.

Definition at line 126 of file IntDistribution.cpp.

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

◆ save()

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

virtual

Save state to an archive.

Parameters

ar	binary saving (output) archive.

Reimplemented from Util::ParamComposite.

Definition at line 147 of file IntDistribution.cpp.

◆ serialize()

template<class Archive >

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

Serialize to/from an archive.

Parameters

ar	archive
version	archive version id

Definition at line 184 of file IntDistribution.h.

References histogram_, max_, min_, nBin_, nReject_, and nSample_.

◆ clear()

void Util::IntDistribution::clear ( )

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

Definition at line 153 of file IntDistribution.cpp.

References histogram_, nBin_, nReject_, and nSample_.

Referenced by readParameters(), and setParam().

◆ sample()

void Util::IntDistribution::sample ( int value )

Sample a value.

Parameters

value current value

Definition at line 165 of file IntDistribution.cpp.

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

◆ output()

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

Output the distribution to file.

Parameters

out	output stream

Definition at line 180 of file IntDistribution.cpp.

References histogram_, min_, and nBin_.

◆ binIndex()

int Util::IntDistribution::binIndex ( int value )

inline

Return the index of the bin for a value.

Parameters

value sampled value

Definition at line 159 of file IntDistribution.h.

References min_.

Referenced by sample().

◆ min()

int Util::IntDistribution::min ( ) const

inline

Get minimum value in range of histogram.

Definition at line 165 of file IntDistribution.h.

References min_.

Referenced by setParam().

◆ max()

int Util::IntDistribution::max ( ) const

inline

Get maximum value in range of histogram.

Definition at line 171 of file IntDistribution.h.

References max_.

Referenced by setParam().

◆ nBin()

int Util::IntDistribution::nBin ( ) const

inline

Get the number of bins.

Definition at line 177 of file IntDistribution.h.

References nBin_.

◆ data()

const DArray< long > & Util::IntDistribution::data ( ) const

inline

Get histogram array.

Each element of the histogram array simply contains the number of times that a particular value has been passed to the sample function since the histogram was last cleared.

Definition at line 140 of file IntDistribution.h.

References histogram_.

Referenced by pscfpp.field.Field::__init__(), pscfpp.field.Field::__str__(), pscfpp.field.Field::addColumn(), pscfpp.field.Field::deleteColumn(), pscfpp.field.Field::read(), and pscfpp.field.Field::reorder().

Member Data Documentation

◆ histogram_

DArray<long> Util::IntDistribution::histogram_

protected

Histogram array.

Definition at line 145 of file IntDistribution.h.

Referenced by clear(), data(), IntDistribution(), loadParameters(), operator=(), output(), readParameters(), sample(), serialize(), and setParam().

◆ min_

int Util::IntDistribution::min_

protected

minimum value.

Definition at line 146 of file IntDistribution.h.

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

◆ max_

int Util::IntDistribution::max_

protected

maximum value.

Definition at line 147 of file IntDistribution.h.

Referenced by IntDistribution(), loadParameters(), max(), operator=(), readParameters(), sample(), serialize(), and setParam().

◆ nBin_

int Util::IntDistribution::nBin_

protected

number of bins.

Definition at line 148 of file IntDistribution.h.

Referenced by clear(), IntDistribution(), loadParameters(), nBin(), operator=(), output(), readParameters(), serialize(), and setParam().

◆ nSample_

int Util::IntDistribution::nSample_

protected

Number of sampled values in Histogram.

Definition at line 149 of file IntDistribution.h.

Referenced by clear(), IntDistribution(), loadParameters(), operator=(), sample(), and serialize().

◆ nReject_

int Util::IntDistribution::nReject_

protected

Number of sampled values that were out of range.

Definition at line 150 of file IntDistribution.h.

Referenced by clear(), IntDistribution(), loadParameters(), operator=(), 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

◆ IntDistribution() [1/2]

◆ IntDistribution() [2/2]

◆ ~IntDistribution()

Member Function Documentation

◆ operator=()

◆ readParameters()

◆ setParam()

◆ loadParameters()

◆ save()

◆ serialize()

◆ clear()

◆ sample()

◆ output()

◆ binIndex()

◆ min()

◆ max()

◆ nBin()

◆ data()

Member Data Documentation

◆ histogram_

◆ min_

◆ max_

◆ nBin_

◆ nSample_

◆ nReject_