Utility classes for scientific computation. More...

Namespaces
namespace	BracketPolicy
	Namespace to define of policies for brackets on arrays and matrices.

Classes
class	Ar1Process
	Generator for a discrete AR(1) Markov process. More...
class	Array
	Array container class template. More...
class	ArrayIterator
	Forward iterator for an Array or a C array. More...
class	ArrayParam
	An array-valued parameter in a parameter file. More...
class	ArraySet
	A set of pointers to a subset of elements of an array. More...
class	ArrayStack
	A stack of fixed capacity, which stores pointers to elements. More...
class	AutoCorr
	Auto-correlation function for one sequence of Data values. More...
class	AutoCorrArray
	Auto-correlation function for an ensemble of sequences. More...
class	AutoCorrelation
	Auto-correlation function, using hierarchical algorithm. More...
class	AutoCorrStage
	Hierarchical auto-correlation function algorithm. More...
class	Average
	Calculates the average and variance of a sampled property. More...
class	AverageStage
	Evaluate average with hierarchical blocking error analysis. More...
class	Begin
	Beginning line of a composite parameter block. More...
class	BinaryFileIArchive
	Loading (input) archive for binary istream. More...
class	BinaryFileOArchive
	Saving / output archive for binary ostream. More...
class	Binomial
	Class for binomial coefficients (all static members) More...
class	Bit
	Represents a specific bit location within an unsigned int. More...
class	Blank
	An empty line within a parameter file. More...
class	Bool
	Wrapper for an bool value, for formatted ostream output. More...
class	CardinalBSpline
	A cardinal B-spline basis function. More...
class	CArray2DParam
	A Parameter associated with a 2D built-in C array. More...
class	CArrayParam
	A Parameter associated with a 1D C array. More...
class	Constants
	Mathematical constants. More...
class	ConstArrayIterator
	Forward const iterator for an Array or a C array. More...
class	ConstPArrayIterator
	Forward iterator for a PArray. More...
class	DArray
	Dynamically allocatable contiguous array template. More...
class	DArrayParam
	A Parameter associated with a DArray container. More...
class	Dbl
	Wrapper for a double precision number, for formatted ostream output. More...
class	Distribution
	A distribution (or histogram) of values for a real variable. More...
class	DMatrix
	Dynamically allocated Matrix. More...
class	DMatrixParam
	A Parameter associated with a 2D built-in C array. More...
class	DPArray
	A dynamic array that only holds pointers to its elements. More...
class	DRaggedMatrix
	Dynamically allocated RaggedMatrix. More...
class	DSArray
	Dynamically allocated array with variable logical size. More...
class	DSymmMatrixParam
	A Parameter associated with a square symmetric DMatrix. More...
class	End
	End bracket of a ParamComposite parameter block. More...
class	Exception
	A user-defined exception. More...
class	Factory
	Factory template. More...
class	FArray
	A fixed size (static) contiguous array template. More...
class	FArrayParam
	A Parameter associated with a FArray container. More...
class	FileMaster
	A FileMaster manages input and output files for a simulation. More...
class	FlagSet
	A set of boolean variables represented by characters. More...
class	FlexPtr
	A pointer that may or may not own the object to which it points. More...
class	FMatrix
	Fixed Size Matrix. More...
class	Format
	Base class for output wrappers for formatted C++ ostream output. More...
class	FPArray
	Statically allocated pointer array. More...
class	FSArray
	A fixed capacity (static) contiguous array with a variable logical size. More...
class	FSArrayParam
	A Parameter associated with a FSArray container. More...
class	GArray
	An automatically growable array, analogous to a std::vector. More...
class	GPArray
	An automatically growable PArray. More...
class	Grid
	A grid of points indexed by integer coordinates. More...
class	GridArray
	Multi-dimensional array with the dimensionality of space. More...
class	GStack
	An automatically growable Stack. More...
class	IFunctor
	Interface for functor that wraps a void function with one argument (abstract). More...
class	IFunctor< void >
	Interface for functor that wraps a void function with no arguments (abstract). More...
class	Int
	Wrapper for an int, for formatted ostream output. More...
class	IntDistribution
	A distribution (or histogram) of values for an int variable. More...
class	IntVector
	An IntVector is an integer Cartesian vector. More...
class	Label
	A label string in a file format. More...
class	List
	Linked list class template. More...
class	list
	STL class. More...
class	ListArray
	An array of objects that are accessible by one or more linked List objects. More...
class	ListIterator
	Bidirectional iterator for a List. More...
class	Lng
	Wrapper for a long int, for formatted ostream output. More...
class	Log
	A static class that holds a log output stream. More...
class	Manager
	Template container for pointers to objects with a common base class. More...
class	Matrix
	Two-dimensional array container template (abstract). More...
class	MatrixParam
	An array-valued parameter in a parameter file. More...
class	MeanSqDispArray
	Mean-squared displacement (MSD) vs. More...
class	Memory
	Provides method to allocate array. More...
class	MemoryCounter
	Archive to computed packed size of a sequence of objects, in bytes. More...
class	MemoryIArchive
	Input archive for packed heterogeneous binary data. More...
class	MemoryOArchive
	Save archive for packed heterogeneous binary data. More...
class	MethodFunctor
	Functor that wraps a one-argument class member function. More...
class	MethodFunctor< Object, void >
	Functor that wraps a class member function with no arguments. More...
class	MpiFileIo
	Identifies whether this processor may do file I/O. More...
class	MpiLoader
	Provides methods for MPI-aware loading of data from input archive. More...
class	MTRand
	Generates double floating point numbers in the half-open interval [0, 1) More...
class	MTRand53
	generates 53 bit resolution doubles in the half-open interval [0, 1) More...
class	MTRand_closed
	Generates double floating point numbers in the closed interval [0, 1]. More...
class	MTRand_int32
	Mersenne Twister random number generator engine. More...
class	MTRand_open
	Generates double floating point numbers in the open interval (0, 1). More...
class	Node
	Linked List Node, class template. More...
class	Notifier
	Abstract template for a notifier (or subject) in the Observer design pattern. More...
class	Observer
	Abstract class template for observer in the observer design pattern. More...
class	OptionalLabel
	An optional Label string in a file format. More...
class	Pair
	An array of exactly 2 objects. More...
class	ParamComponent
	Abstract base class for classes that input and ouput parameters to file. More...
class	ParamComposite
	An object that can read multiple parameters from file. More...
class	Parameter
	A single variable in a parameter file. More...
class	PArray
	An array that only holds pointers to its elements. More...
class	PArrayIterator
	Forward iterator for a PArray. More...
class	Polynomial
	A Polynomial (i.e,. More...
class	RadialDistribution
	Distribution (or histogram) of values for particle separations. More...
class	RaggedMatrix
	A 2D array in which different rows can have different lengths. More...
class	Random
	Random number generator. More...
class	RArray
	An Array that acts as a reference to another Array or C array. More...
class	Rational
	A Rational number (a ratio of integers). More...
class	RingBuffer
	Class for storing history of previous values in an array. More...
class	ScalarParam
	Template for a Parameter object associated with a scalar variable. More...
class	ScopedPtr
	A very simple RAII pointer. More...
class	Serializable
	Abstract class for serializable objects. More...
class	Setable
	Template for a value that can be set or declared null (i.e., unknown). More...
class	Signal
	Notifier (or subject) in the Observer design pattern. More...
class	Signal< void >
	Notifier (or subject) in the Observer design pattern (zero parameters). More...
class	SSet
	Statically allocated array of pointers to an unordered set. More...
class	Str
	Wrapper for a std::string, for formatted ostream output. More...
class	SymmTensorAverage
	Calculates averages of all components of a Tensor-valued variable. More...
class	Tensor
	A Tensor represents a Cartesian tensor. More...
class	TensorAverage
	Calculates averages of all components of a Tensor-valued variable. More...
class	TextFileIArchive
	Loading archive for text istream. More...
class	TextFileOArchive
	Saving archive for character based ostream. More...
class	Timer
	Wall clock timer. More...
class	Vector
	A Vector is a Cartesian vector. More...
class	XdrFileIArchive
	Loading / input archive for binary XDR file. More...
class	XdrFileOArchive
	Saving / output archive for binary XDR file. More...
class	XmlAttribute
	Parser for an XML attribute. More...
class	XmlBase
	Base class for classes that parse XML markup tags. More...
class	XmlEndTag
	Parser for an XML end tag. More...
class	XmlStartTag
	Parser for an XML start tag. More...
class	XmlXmlTag
	Parser for an XML file declaration tag (first line in file). More...

Typedefs
typedef unsigned char	Byte
	Define a "Byte" type.

Functions
float	product (float a, float b)
	Product for float Data.
double	product (double a, double b)
	Product for double Data.
double	product (const Vector &a, const Vector &b)
	Dot product for Vector Data.
double	product (const Tensor &a, const Tensor &b)
	Double contraction for Tensor Data.
complex< float >	product (complex< float > a, complex< float > b)
	Inner product for complex<float> Data.
complex< double >	product (complex< double > a, complex< double > b)
	Inner product for complex<double> Data.
void	setToZero (int &value)
	Set an int variable to zero.
void	setToZero (float &value)
	Set a float variable to zero.
void	setToZero (double &value)
	Set a double variable to zero.
void	setToZero (Vector &value)
	Set a Vector variable to zero.
void	setToZero (Tensor &value)
	Set a Vector variable to zero.
void	setToZero (complex< float > &value)
	Set a complex<float> variable to zero.
void	setToZero (complex< double > &value)
	Set a complex<double> variable to zero.
template<typename T>
int	memorySize (T &data)
	Function template to compute memory size of one object.
template<class Archive, typename T>
void	serialize (Archive &ar, T &data, const unsigned int version)
	Serialize one instance of class T.
template<class Archive, typename T, size_t N>
void	serialize (Archive &ar, T data[N], const unsigned int version)
	Serialize a fixed size array with elements of type T.
template<class Archive, typename T>
void	serializeEnum (Archive &ar, T &data, const unsigned int version=0)
	Serialize an enumeration value.
template<class Archive, typename T>
void	serializeCheck (Archive &ar, T &data, const char *label="")
	Save a value, or save and check correctness on loading.
template<typename Data>
std::istream &	operator>> (std::istream &in, Pair< Data > &pair)
	Input a Pair from an istream.
template<typename Data>
std::ostream &	operator<< (std::ostream &out, const Pair< Data > &pair)
	Output a Pair to an ostream, without line breaks.
std::istream &	operator>> (std::istream &in, Bool &object)
	Input stream extractor for an Bool object.
std::ostream &	operator<< (std::ostream &out, const Bool &object)
	Output stream inserter for an Bool object.
std::istream &	operator>> (std::istream &in, Dbl &object)
	Input stream extractor for an Dbl object.
std::ostream &	operator<< (std::ostream &out, const Dbl &object)
	Output stream inserter for an Dbl object.
std::istream &	operator>> (std::istream &in, Int &object)
	Input stream extractor for an Int object.
std::ostream &	operator<< (std::ostream &out, const Int &object)
	Output stream inserter for an Int object.
std::istream &	operator>> (std::istream &in, Lng &object)
	Input stream extractor for an Lng object.
std::ostream &	operator<< (std::ostream &out, const Lng &object)
	Output stream inserter for an Lng object.
std::istream &	operator>> (std::istream &in, Str &object)
	Input stream extractor for an Str object.
std::ostream &	operator<< (std::ostream &out, const Str &object)
	Output stream inserter for an Str object.
template<>
void	write (std::ostream &out, double data)
	Explicit specialization of write for double data.
template<>
void	write (std::ostream &out, std::complex< double > data)
	Explicit specialization of write for double data.
template<>
void	write (std::ostream &out, int data)
	Explicit specialization of write for int data.
template<>
void	write (std::ostream &out, long data)
	Explicit specialization of write for long data.
template<>
void	write (std::ostream &out, bool data)
	Explicit specialization of write for bool data.
template<typename Type>
void	write (std::ostream &out, Type data)
	Function template for output in a standard format.
template<>
void	write (std::ostream &out, double data)
	Explicit specialization of write for double data.
template<>
void	write (std::ostream &out, std::complex< double > data)
	Explicit specialization of write for double data.
template<>
void	write (std::ostream &out, int data)
	Explicit specialization of write for int data.
template<>
void	write (std::ostream &out, long data)
	Explicit specialization of write for long data.
template<>
void	write (std::ostream &out, bool data)
	Explicit specialization of write for bool data.
template<>
void	write (std::ostream &out, std::string data)
	Explicit specialization of write for std::string data.
bool	feq (double x, double y, double eps=1.0E-10)
	Are two floating point numbers equal to within round-off error?
int	gcd (int a, int b)
	Compute greatest common divisor (gcd) of two integers.
template<typename T>
bool	operator== (Polynomial< T > const &a, Polynomial< T > const &b)
	Equality operator for polynomials.
template<typename T>
bool	operator!= (Polynomial< T > const &a, Polynomial< T > const &b)
	Inequality operator for polynomials.
template<typename T>
Polynomial< T >	operator- (Polynomial< T > const &a)
	Unary negation of polynomial.
std::ostream &	operator<< (std::ostream &out, Rational const &rational)
	Output stream inserter for a Rational.
Rational	operator+ (Rational const &a, Rational const &b)
	Compute sum of two rationals.
Rational	operator+ (Rational const &a, int b)
	Compute sum of rational and integer.
Rational	operator+ (int b, Rational const &a)
	Compute sum of integer and integer.
Rational	operator- (Rational const &a, Rational const &b)
	Compute difference of rationals.
Rational	operator- (Rational const &a, int b)
	Compute difference of rational and integer.
Rational	operator- (int b, Rational const &a)
	Compute difference of integer and rational.
Rational	operator* (Rational const &a, Rational const &b)
	Compute product of rationals.
Rational	operator* (Rational const &a, int b)
	Compute product of rational and integer.
Rational	operator* (int b, Rational const &a)
	Compute product of integer and rational.
Rational	operator/ (Rational const &a, Rational const &b)
	Compute quotient of two rationals.
Rational	operator/ (Rational const &a, int b)
	Compute quotient Rational divided by integer.
Rational	operator/ (int b, Rational const &a)
	Compute quotient integer divided by Rational.
Rational	operator- (Rational const &a)
	Unary negation of Rational.
bool	operator== (Rational const &a, Rational const &b)
	Equality operators.
bool	operator== (Rational const &a, int b)
	Equality operator for a Rational and an integer.
bool	operator== (int b, Rational const &a)
	Equality operator for an integer and a Rational.
bool	operator!= (Rational const &a, Rational const &b)
	Inequality operators.
bool	operator!= (Rational const &a, int b)
	Inequality operator for a Rational and an integer.
bool	operator!= (int b, Rational const &a)
	Inequality operator for an integer and a Rational.
void	initStatic ()
	Guarantee initialization of all static class members in Util namespace.
int	rStrip (std::string &string)
	Strip trailing whitespace from a string.
void	checkString (std::istream &in, const std::string &expected)
	Extract string from stream, and compare to expected value.
std::string	toString (int n)
	Return string representation of an integer.
bool	getLine (std::istream &in, std::stringstream &line)
	Read the next line into a stringstream.
bool	getNextLine (std::istream &in, std::string &line)
	Read the next non-empty line into a string, strip trailing whitespace.
bool	getNextLine (std::istream &in, std::stringstream &line)
	Read next non-empty line into a stringstream, strip trailing whitespace.
void	checkRequiredIstream (std::istream &in)
	Check status of a std::istream just before reading required variable.
template<typename D, typename B, typename M>
ptrdiff_t	memberOffset (D &object, M B::*memPtr)
	Template for calculating offsets of data members.
template<typename D, typename B>
ptrdiff_t	baseOffset (D &object)
	Template for calculating offsets of base class subobjects.
std::istream &	operator>> (std::istream &in, Label label)
	Extractor for Label.
std::ostream &	operator<< (std::ostream &out, Label label)
	Inserter for Label.
template<typename T>
bool	isNull (FlexPtr< T > p)
	Return true iff the enclosed built-in pointer is null.
template<typename T>
bool	isNull (T *ptr)
	Return true iff a built-in pointer is null.
template<typename T>
bool	isNull (ScopedPtr< T > p)
	Return true iff the enclosed built-in pointer is null.
bool	operator== (const IntVector &v1, const IntVector &v2)
	Equality for IntVectors.
bool	operator== (const IntVector &v1, const int *v2)
	Equality of IntVector and C array.
bool	operator== (const int *v1, const IntVector &v2)
	Equality of C array and IntVector.
bool	operator!= (const IntVector &v1, const IntVector &v2)
	Inequality of two IntVectors.
bool	operator!= (const IntVector &v1, const int *v2)
	Inequality of IntVector and C array.
bool	operator!= (const int *v1, const IntVector &v2)
	Inequality of C array and IntVector.
std::istream &	operator>> (std::istream &in, IntVector &vector)
	istream extractor for a IntVector.
std::ostream &	operator<< (std::ostream &out, const IntVector &vector)
	ostream inserter for a IntVector.
bool	operator== (const Tensor &t1, const Tensor &t2)
	Equality for Tensors.
bool	operator== (const Tensor &t1, const double a2[][Dimension])
	Equality of Tensor and 2D C array.
bool	operator== (const double t1[][Dimension], const Tensor &t2)
	Equality of C array and Tensor.
bool	operator!= (const Tensor &t1, const Tensor &t2)
	Negation of t1 == t2 (tensors t1 and t2)
bool	operator!= (const Tensor &t1, const double a2[][Dimension])
	Negation of t1 == a2 (tensor t1, 2D array a2)
bool	operator!= (const double a1[][Dimension], const Tensor &t2)
	Negation of t1 == a2 (tensor t2, 2D array a1)
std::istream &	operator>> (std::istream &in, Tensor &tensor)
	istream extractor for a Tensor.
std::ostream &	operator<< (std::ostream &out, const Tensor &tensor)
	ostream inserter for a Tensor.
bool	operator== (const Vector &v1, const Vector &v2)
	Equality for Vectors.
bool	operator== (const Vector &v1, const double *v2)
	Equality of Vector and C array.
bool	operator== (const double *v1, const Vector &v2)
	Equality of C array and Vector.
bool	operator!= (const Vector &v1, const Vector &v2)
	Inequality of two Vectors.
bool	operator!= (const Vector &v1, const double *v2)
	Inequality of Vector and C array.
bool	operator!= (const double *v1, const Vector &v2)
	Inequality of C array and Vector.
std::istream &	operator>> (std::istream &in, Vector &vector)
	istream extractor for a Vector.
std::ostream &	operator<< (std::ostream &out, const Vector &vector)
	ostream inserter for a Vector.

Variables
const int	Dimension = 3
	Dimensionality of space.
const int	DimensionSq = Dimension*Dimension
	Square of Dimensionality of space.

Detailed Description

Utility classes for scientific computation.

Typedef Documentation

◆ Byte

typedef unsigned char Util::Byte

Define a "Byte" type.

Definition at line 19 of file Byte.h.

Function Documentation

◆ product() [1/6]

float Util::product	(	float	a,
		float	b )

inline

Product for float Data.

Definition at line 22 of file product.h.

Referenced by Util::AutoCorr< Data, Product >::autoCorrelation(), Util::AutoCorr< Data, Product >::corrTime(), Util::AutoCorrArray< Data, Product >::corrTime(), Util::AutoCorr< Data, Product >::output(), Util::AutoCorr< Data, Product >::sample(), Util::AutoCorrArray< Data, Product >::sample(), Util::AutoCorrStage< Data, Product >::sample(), and Pscf::R1d::FieldIo::writeVertexQ().

◆ product() [2/6]

double Util::product	(	double	a,
		double	b )

inline

Product for double Data.

Definition at line 28 of file product.h.

◆ product() [3/6]

double Util::product	(	const Vector &	a,
		const Vector &	b )

inline

Dot product for Vector Data.

Definition at line 34 of file product.h.

References Util::Vector::dot().

◆ product() [4/6]

double Util::product	(	const Tensor &	a,
		const Tensor &	b )

inline

Double contraction for Tensor Data.

Definition at line 40 of file product.h.

References Dimension.

◆ product() [5/6]

complex< float > Util::product	(	complex< float >	a,
		complex< float >	b )

inline

Inner product for complex<float> Data.

Definition at line 55 of file product.h.

◆ product() [6/6]

complex< double > Util::product	(	complex< double >	a,
		complex< double >	b )

inline

Inner product for complex<double> Data.

Definition at line 61 of file product.h.

◆ setToZero() [1/7]

void Util::setToZero ( int & value )

inline

Set an int variable to zero.

Parameters

value value to be zeroed.

Definition at line 25 of file setToZero.h.

Referenced by Util::AutoCorr< Data, Product >::AutoCorr(), Util::AutoCorrArray< Data, Product >::AutoCorrArray(), Util::AutoCorrStage< Data, Product >::autoCorrelation(), Util::AutoCorrStage< Data, Product >::AutoCorrStage(), Util::AutoCorr< Data, Product >::clear(), Util::AutoCorrArray< Data, Product >::clear(), Util::AutoCorrStage< Data, Product >::clear(), Util::MeanSqDispArray< Data >::clear(), Util::AutoCorr< Data, Product >::corrTime(), Util::AutoCorrArray< Data, Product >::corrTime(), Util::AutoCorrStage< Data, Product >::corrTime(), Util::AutoCorrStage< Data, Product >::corrTime(), Pscf::dot(), Util::Polynomial< T >::operator*=(), Util::Polynomial< T >::operator=(), Util::AutoCorrStage< Data, Product >::output(), Util::AutoCorrStage< Data, Product >::sample(), and Pscf::Vec< D, T >::setToZero().

◆ setToZero() [2/7]

void Util::setToZero ( float & value )

inline

Set a float variable to zero.

Parameters

value value to be zeroed.

Definition at line 33 of file setToZero.h.

◆ setToZero() [3/7]

void Util::setToZero ( double & value )

inline

Set a double variable to zero.

Parameters

value value to be zeroed.

Definition at line 41 of file setToZero.h.

◆ setToZero() [4/7]

void Util::setToZero ( Vector & value )

inline

Set a Vector variable to zero.

Parameters

value value to be zeroed.

Definition at line 49 of file setToZero.h.

References Util::Vector::zero().

◆ setToZero() [5/7]

void Util::setToZero ( Tensor & value )

inline

Set a Vector variable to zero.

Parameters

value value to be zeroed.

Definition at line 57 of file setToZero.h.

References Util::Tensor::zero().

◆ setToZero() [6/7]

void Util::setToZero ( complex< float > & value )

inline

Set a complex<float> variable to zero.

Parameters

value value to be zeroed.

Definition at line 65 of file setToZero.h.

◆ setToZero() [7/7]

void Util::setToZero ( complex< double > & value )

inline

Set a complex<double> variable to zero.

Parameters

value value to be zeroed.

Definition at line 73 of file setToZero.h.

◆ memorySize()

template<typename T>

int Util::memorySize ( T & data )

Function template to compute memory size of one object.

Definition at line 150 of file MemoryCounter.h.

References Util::MemoryCounter::size().

◆ operator>>() [1/10]

template<typename Data>

std::istream & Util::operator>>	(	std::istream &	in,
		Pair< Data > &	pair )

Input a Pair from an istream.

Parameters

in	istream from which to read
pair	Pair to be read

Definition at line 44 of file Pair.h.

◆ operator<<() [1/11]

template<typename Data>

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Pair< Data > &	pair )

Output a Pair to an ostream, without line breaks.

Parameters

out	ostream to which to write
pair	Pair to be written

Definition at line 57 of file Pair.h.

◆ operator>>() [2/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Bool &	object )

Input stream extractor for an Bool object.

Parameters

in	input stream
object	Bool object to be read from stream

Returns: modified input stream

Definition at line 47 of file Bool.cpp.

◆ operator<<() [2/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Bool &	object )

Output stream inserter for an Bool object.

Parameters

out	output stream
object	Bool to be written to stream

Returns: modified output stream

Definition at line 56 of file Bool.cpp.

◆ operator>>() [3/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Dbl &	object )

Input stream extractor for an Dbl object.

Parameters

in	input stream
object	Dbl object to be read from stream

Returns: modified input stream

Definition at line 73 of file Dbl.cpp.

◆ operator<<() [3/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Dbl &	object )

Output stream inserter for an Dbl object.

Parameters

out	output stream
object	Dbl to be written to stream

Returns: modified output stream

Definition at line 86 of file Dbl.cpp.

◆ operator>>() [4/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Int &	object )

Input stream extractor for an Int object.

Parameters

in	input stream
object	Int object to be read from stream

Returns: modified input stream

Definition at line 71 of file Int.cpp.

◆ operator<<() [4/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Int &	object )

Output stream inserter for an Int object.

Parameters

out	output stream
object	Int to be written to stream

Returns: modified output stream

Definition at line 84 of file Int.cpp.

◆ operator>>() [5/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Lng &	object )

Input stream extractor for an Lng object.

Parameters

in	input stream
object	Lng object to be read from stream

Returns: modified input stream

Definition at line 53 of file Lng.cpp.

◆ operator<<() [5/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Lng &	object )

Output stream inserter for an Lng object.

Parameters

out	output stream
object	Lng to be written to stream

Returns: modified output stream

Definition at line 66 of file Lng.cpp.

◆ operator>>() [6/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Str &	object )

Input stream extractor for an Str object.

Parameters

in	input stream
object	Str object to be read from stream

Returns: modified input stream

Definition at line 49 of file Str.cpp.

◆ operator<<() [6/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Str &	object )

Output stream inserter for an Str object.

Parameters

out	output stream
object	Str to be written to stream

Returns: modified output stream

Definition at line 58 of file Str.cpp.

◆ write() [1/11]

template<>

void Util::write	(	std::ostream &	out,
		double	data )

Explicit specialization of write for double data.

Definition at line 20 of file write.cpp.

Referenced by Util::AutoCorr< Data, Product >::output(), and Util::AutoCorrStage< Data, Product >::output().

◆ write() [2/11]

template<>

void Util::write	(	std::ostream &	out,
		std::complex< double >	data )

Explicit specialization of write for double data.

Definition at line 24 of file write.cpp.

◆ write() [3/11]

template<>

void Util::write	(	std::ostream &	out,
		int	data )

Explicit specialization of write for int data.

Definition at line 28 of file write.cpp.

◆ write() [4/11]

template<>

void Util::write	(	std::ostream &	out,
		long	data )

Explicit specialization of write for long data.

Definition at line 32 of file write.cpp.

◆ write() [5/11]

template<>

void Util::write	(	std::ostream &	out,
		bool	data )

Explicit specialization of write for bool data.

Definition at line 36 of file write.cpp.

◆ write() [6/11]

template<>

void Util::write	(	std::ostream &	out,
		double	data )

Explicit specialization of write for double data.

Definition at line 20 of file write.cpp.

Referenced by Util::AutoCorr< Data, Product >::output(), and Util::AutoCorrStage< Data, Product >::output().

◆ write() [7/11]

template<>

void Util::write	(	std::ostream &	out,
		std::complex< double >	data )

Explicit specialization of write for double data.

Definition at line 24 of file write.cpp.

◆ write() [8/11]

template<>

void Util::write	(	std::ostream &	out,
		int	data )

Explicit specialization of write for int data.

Definition at line 28 of file write.cpp.

◆ write() [9/11]

template<>

void Util::write	(	std::ostream &	out,
		long	data )

Explicit specialization of write for long data.

Definition at line 32 of file write.cpp.

◆ write() [10/11]

template<>

void Util::write	(	std::ostream &	out,
		bool	data )

Explicit specialization of write for bool data.

Definition at line 36 of file write.cpp.

◆ write() [11/11]

template<>

void Util::write	(	std::ostream &	out,
		std::string	data )

Explicit specialization of write for std::string data.

◆ operator==() [1/13]

template<typename T>

bool Util::operator==	(	Polynomial< T > const &	a,
		Polynomial< T > const &	b )

Equality operator for polynomials.

Two polynomials are equal iff they have the same degree and the the same values for all coefficients.

Parameters

a	1st polynomial
b	2nd polynomial

Returns: true if a != b

Definition at line 675 of file Polynomial.h.

◆ operator!=() [1/13]

template<typename T>

bool Util::operator!=	(	Polynomial< T > const &	a,
		Polynomial< T > const &	b )

Inequality operator for polynomials.

Parameters

a	1st polynomial
b	2nd polynomial

Returns: true if a != b

Definition at line 694 of file Polynomial.h.

◆ operator-() [1/5]

template<typename T>

Polynomial< T > Util::operator- ( Polynomial< T > const & a )

inline

Unary negation of polynomial.

Parameters

a	input polynomial

Returns: negated polynomial -a

Definition at line 705 of file Polynomial.h.

◆ operator<<() [7/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		Rational const &	rational )

Output stream inserter for a Rational.

Output elements of a rational to stream, without line breaks.

Parameters

out	output stream
rational	Rational to be written to stream

Returns: modified output stream

Definition at line 16 of file Rational.cpp.

◆ operator+() [1/3]

Rational Util::operator+	(	Rational const &	a,
		Rational const &	b )

inline

Compute sum of two rationals.

Parameters

a	1st argument
b	2st argument

Returns: sum a + b

Definition at line 490 of file Rational.h.

◆ operator+() [2/3]

Rational Util::operator+	(	Rational const &	a,
		int	b )

inline

Compute sum of rational and integer.

Parameters

a	Rational argument
b	integer argument

Returns: sum a + b

Definition at line 505 of file Rational.h.

◆ operator+() [3/3]

Rational Util::operator+	(	int	b,
		Rational const &	a )

inline

Compute sum of integer and integer.

Parameters

b	integer argument
a	Rational argument

Returns: sum a + b

Definition at line 519 of file Rational.h.

◆ operator-() [2/5]

Rational Util::operator-	(	Rational const &	a,
		Rational const &	b )

inline

Compute difference of rationals.

Parameters

a	1st argument
b	2st argument

Returns: difference a - b

Definition at line 530 of file Rational.h.

◆ operator-() [3/5]

Rational Util::operator-	(	Rational const &	a,
		int	b )

inline

Compute difference of rational and integer.

Parameters

a	Rational argument
b	integer argument

Returns: difference a - b

Definition at line 545 of file Rational.h.

◆ operator-() [4/5]

Rational Util::operator-	(	int	b,
		Rational const &	a )

inline

Compute difference of integer and rational.

Parameters

b	integer argument
a	Rational argument

Returns: difference b - a

Definition at line 559 of file Rational.h.

◆ operator*() [1/3]

Rational Util::operator*	(	Rational const &	a,
		Rational const &	b )

inline

Compute product of rationals.

Parameters

a	1st Rational argument
b	2st Rational argument

Returns: product a*b

Definition at line 573 of file Rational.h.

◆ operator*() [2/3]

Rational Util::operator*	(	Rational const &	a,
		int	b )

inline

Compute product of rational and integer.

Parameters

a	Rational argument
b	integer argument

Returns: product a*b

Definition at line 588 of file Rational.h.

◆ operator*() [3/3]

Rational Util::operator*	(	int	b,
		Rational const &	a )

inline

Compute product of integer and rational.

Parameters

b	integer argument
a	Rational argument

Returns: product a*b

Definition at line 599 of file Rational.h.

◆ operator/() [1/3]

Rational Util::operator/	(	Rational const &	a,
		Rational const &	b )

inline

Compute quotient of two rationals.

Parameters

a	1st Rational argument (numerator)
b	2st Rational argument (denominator)

Returns: ratio a/b

Definition at line 610 of file Rational.h.

◆ operator/() [2/3]

Rational Util::operator/	(	Rational const &	a,
		int	b )

inline

Compute quotient Rational divided by integer.

Parameters

a	Rational argument (numerator)
b	integer argument (denominator)

Returns: ratio a/b

Definition at line 628 of file Rational.h.

◆ operator/() [3/3]

Rational Util::operator/	(	int	b,
		Rational const &	a )

inline

Compute quotient integer divided by Rational.

Parameters

b	integer argument (numerator)
a	Rational argument (denominator)

Returns: ratio b/a

Definition at line 644 of file Rational.h.

◆ operator-() [5/5]

Rational Util::operator- ( Rational const & a )

inline

Unary negation of Rational.

Parameters

a	Rational number

Returns: negation -a

Definition at line 661 of file Rational.h.

◆ operator==() [2/13]

bool Util::operator==	(	Rational const &	a,
		Rational const &	b )

inline

Equality operators.

Equality operator for two Rational numbers.

Parameters

a	1st Rational
b	2nd Rational

Returns: true if equal, false otherwise

Definition at line 674 of file Rational.h.

◆ operator==() [3/13]

bool Util::operator==	(	Rational const &	a,
		int	b )

inline

Equality operator for a Rational and an integer.

Parameters

a	Rational number
b	integer number

Returns: true if equal, false otherwise

Definition at line 684 of file Rational.h.

◆ operator==() [4/13]

bool Util::operator==	(	int	b,
		Rational const &	a )

inline

Equality operator for an integer and a Rational.

Parameters

b	integer number
a	Rational number

Returns: true if equal, false otherwise

Definition at line 694 of file Rational.h.

◆ operator!=() [2/13]

bool Util::operator!=	(	Rational const &	a,
		Rational const &	b )

inline

Inequality operators.

Inequality operator for two Rational numbers.

Parameters

a	1st Rational
b	2nd Rational

Returns: true if unequal, false if equal

Definition at line 706 of file Rational.h.

◆ operator!=() [3/13]

bool Util::operator!=	(	Rational const &	a,
		int	b )

inline

Inequality operator for a Rational and an integer.

Parameters

a	Rational number
b	integer number

Returns: true if unequal, false if equal

Definition at line 716 of file Rational.h.

◆ operator!=() [4/13]

bool Util::operator!=	(	int	b,
		Rational const &	a )

inline

Inequality operator for an integer and a Rational.

Parameters

b	integer number
a	Rational number

Returns: true if unequal, false if equal

Definition at line 726 of file Rational.h.

◆ initStatic()

void Util::initStatic ( )

Guarantee initialization of all static class members in Util namespace.

Definition at line 26 of file initStatic.cpp.

References Util::Constants::initStatic(), Util::Format::initStatic(), Util::IntVector::initStatic(), Util::Log::initStatic(), Util::Memory::initStatic(), Util::ParamComponent::initStatic(), Util::Tensor::initStatic(), and Util::Vector::initStatic().

◆ checkRequiredIstream()

void Util::checkRequiredIstream ( std::istream & in )

Check status of a std::istream just before reading required variable.

Throw Exception with appropriate error message if not good.

Parameters

in	input stream from which to read.

Definition at line 124 of file ioUtil.cpp.

References UTIL_THROW.

◆ baseOffset()

template<typename D, typename B>

ptrdiff_t Util::baseOffset ( D & object )

Template for calculating offsets of base class subobjects.

Types: D - derived class B - base class

Definition at line 40 of file Offset.h.

◆ operator>>() [7/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Label	label )

Extractor for Label.

Parameters

in	input stream
label	Label to be read from file

Definition at line 126 of file Label.cpp.

◆ operator<<() [8/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		Label	label )

Inserter for Label.

Parameters

out	output stream
label	Label to be written to file

Definition at line 169 of file Label.cpp.

◆ isNull() [1/3]

template<typename T>

bool Util::isNull ( FlexPtr< T > p )

inline

Return true iff the enclosed built-in pointer is null.

Definition at line 143 of file FlexPtr.h.

References Util::FlexPtr< T >::get().

◆ isNull() [2/3]

template<typename T>

bool Util::isNull ( T * ptr )

inline

Return true iff a built-in pointer is null.

Definition at line 18 of file isNull.h.

◆ isNull() [3/3]

template<typename T>

bool Util::isNull ( ScopedPtr< T > p )

inline

Return true iff the enclosed built-in pointer is null.

Definition at line 90 of file ScopedPtr.h.

References Util::ScopedPtr< T >::get().

◆ operator==() [5/13]

bool Util::operator==	(	const IntVector &	v1,
		const IntVector &	v2 )

Equality for IntVectors.

Definition at line 24 of file IntVector.cpp.

◆ operator==() [6/13]

bool Util::operator==	(	const IntVector &	v1,
		const int *	v2 )

Equality of IntVector and C array.

Definition at line 35 of file IntVector.cpp.

◆ operator==() [7/13]

bool Util::operator==	(	const int *	v1,
		const IntVector &	v2 )

Equality of C array and IntVector.

Definition at line 45 of file IntVector.cpp.

◆ operator!=() [5/13]

bool Util::operator!=	(	const IntVector &	v1,
		const IntVector &	v2 )

Inequality of two IntVectors.

Definition at line 50 of file IntVector.cpp.

◆ operator!=() [6/13]

bool Util::operator!=	(	const IntVector &	v1,
		const int *	v2 )

Inequality of IntVector and C array.

Definition at line 54 of file IntVector.cpp.

◆ operator!=() [7/13]

bool Util::operator!=	(	const int *	v1,
		const IntVector &	v2 )

Inequality of C array and IntVector.

Definition at line 58 of file IntVector.cpp.

◆ operator>>() [8/10]

std::istream & Util::operator>>	(	std::istream &	in,
		IntVector &	vector )

istream extractor for a IntVector.

Input elements of a vector from stream, without line breaks.

Parameters

in	input stream
vector	IntVector to be read from stream

Returns: modified input stream

Definition at line 64 of file IntVector.cpp.

◆ operator<<() [9/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const IntVector &	vector )

ostream inserter for a IntVector.

Output elements of a vector to stream, without line breaks.

Parameters

out	output stream
vector	IntVector to be written to stream

Returns: modified output stream

Definition at line 75 of file IntVector.cpp.

◆ operator==() [8/13]

bool Util::operator==	(	const Tensor &	t1,
		const Tensor &	t2 )

Equality for Tensors.

Definition at line 41 of file Tensor.cpp.

◆ operator==() [9/13]

bool Util::operator==	(	const Tensor &	t1,
		const double	a2[][Dimension] )

Equality of Tensor and 2D C array.

Definition at line 54 of file Tensor.cpp.

◆ operator==() [10/13]

bool Util::operator==	(	const double	a1[][Dimension],
		const Tensor &	t2 )

Equality of C array and Tensor.

Definition at line 69 of file Tensor.cpp.

References Dimension.

◆ operator!=() [8/13]

bool Util::operator!=	(	const Tensor &	t1,
		const Tensor &	t2 )

Negation of t1 == t2 (tensors t1 and t2)

Inequality of two Tensors.

Definition at line 77 of file Tensor.cpp.

◆ operator!=() [9/13]

bool Util::operator!=	(	const Tensor &	t1,
		const double	a2[][Dimension] )

Negation of t1 == a2 (tensor t1, 2D array a2)

Inequality of Tensor and C array.

Definition at line 81 of file Tensor.cpp.

References Dimension.

◆ operator!=() [10/13]

bool Util::operator!=	(	const double	a1[][Dimension],
		const Tensor &	t2 )

Negation of t1 == a2 (tensor t2, 2D array a1)

Inequality of C array and Tensor.

Definition at line 85 of file Tensor.cpp.

References Dimension.

◆ operator>>() [9/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Tensor &	tensor )

istream extractor for a Tensor.

Input elements of a tensor from stream, without line breaks.

Parameters

in	input stream
tensor	Tensor to be read from stream

Returns: modified input stream

Definition at line 91 of file Tensor.cpp.

◆ operator<<() [10/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Tensor &	tensor )

ostream inserter for a Tensor.

Output elements of a tensor to stream, without line breaks.

Parameters

out	output stream
tensor	Tensor to be written to stream

Returns: modified output stream

Definition at line 102 of file Tensor.cpp.

◆ operator==() [11/13]

bool Util::operator==	(	const Vector &	v1,
		const Vector &	v2 )

Equality for Vectors.

Definition at line 26 of file Vector.cpp.

◆ operator==() [12/13]

bool Util::operator==	(	const Vector &	v1,
		const double *	v2 )

Equality of Vector and C array.

Definition at line 36 of file Vector.cpp.

◆ operator==() [13/13]

bool Util::operator==	(	const double *	v1,
		const Vector &	v2 )

Equality of C array and Vector.

Definition at line 48 of file Vector.cpp.

◆ operator!=() [11/13]

bool Util::operator!=	(	const Vector &	v1,
		const Vector &	v2 )

Inequality of two Vectors.

Definition at line 53 of file Vector.cpp.

◆ operator!=() [12/13]

bool Util::operator!=	(	const Vector &	v1,
		const double *	v2 )

Inequality of Vector and C array.

Definition at line 56 of file Vector.cpp.

◆ operator!=() [13/13]

bool Util::operator!=	(	const double *	v1,
		const Vector &	v2 )

Inequality of C array and Vector.

Definition at line 59 of file Vector.cpp.

◆ operator>>() [10/10]

std::istream & Util::operator>>	(	std::istream &	in,
		Vector &	vector )

istream extractor for a Vector.

Input elements of a vector from stream, without line breaks.

Parameters

in	input stream
vector	Vector to be read from stream

Returns: modified input stream

Definition at line 65 of file Vector.cpp.

◆ operator<<() [11/11]

std::ostream & Util::operator<<	(	std::ostream &	out,
		const Vector &	vector )

ostream inserter for a Vector.

Output elements of a vector to stream, without line breaks.

Parameters

out	output stream
vector	Vector to be written to stream

Returns: modified output stream

Definition at line 76 of file Vector.cpp.

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ Byte

Function Documentation

◆ product() [1/6]

◆ product() [2/6]

◆ product() [3/6]

◆ product() [4/6]

◆ product() [5/6]

◆ product() [6/6]

◆ setToZero() [1/7]

◆ setToZero() [2/7]

◆ setToZero() [3/7]

◆ setToZero() [4/7]

◆ setToZero() [5/7]

◆ setToZero() [6/7]

◆ setToZero() [7/7]

◆ memorySize()

◆ operator>>() [1/10]

◆ operator<<() [1/11]

◆ operator>>() [2/10]

◆ operator<<() [2/11]

◆ operator>>() [3/10]

◆ operator<<() [3/11]

◆ operator>>() [4/10]

◆ operator<<() [4/11]

◆ operator>>() [5/10]

◆ operator<<() [5/11]

◆ operator>>() [6/10]

◆ operator<<() [6/11]

◆ write() [1/11]

◆ write() [2/11]

◆ write() [3/11]

◆ write() [4/11]

◆ write() [5/11]

◆ write() [6/11]

◆ write() [7/11]

◆ write() [8/11]

◆ write() [9/11]

◆ write() [10/11]

◆ write() [11/11]

◆ operator==() [1/13]

◆ operator!=() [1/13]

◆ operator-() [1/5]

◆ operator<<() [7/11]

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator-() [2/5]

◆ operator-() [3/5]

◆ operator-() [4/5]

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator/() [1/3]

◆ operator/() [2/3]

◆ operator/() [3/3]

◆ operator-() [5/5]

◆ operator==() [2/13]

◆ operator==() [3/13]

◆ operator==() [4/13]

◆ operator!=() [2/13]

◆ operator!=() [3/13]

◆ operator!=() [4/13]

◆ initStatic()

◆ checkRequiredIstream()

◆ baseOffset()

◆ operator>>() [7/10]

◆ operator<<() [8/11]

◆ isNull() [1/3]

◆ isNull() [2/3]

◆ isNull() [3/3]

◆ operator==() [5/13]

◆ operator==() [6/13]

◆ operator==() [7/13]