STK means the Statistical ToolKit. More...

Namespaces
namespace	Law
	This is the namespace containing the class handling the usual probabilities Laws.
namespace	DManager
namespace	Csv
	The STK::Csv namespace contains the constants used in the DManager project when using csv files.
namespace	Import
	The STK::Import namespace contains the constants used in the DManager project when importing data in STK containers.
namespace	Reduct
namespace	Regress
namespace	Const
	This is the namespace containing the usual mathematical constants.
namespace	Funct
	The namespace Funct enclose all usual and special functions.
namespace	Stat
	this is the namespace for the statistical treatment.
namespace	StatModel
namespace	Chrono
	The namespace Chrono is an utility namespace for computing elapsed time during the execution of a program.
Classes
class	AAModelFactory
	@ More...
class	IAAModel
	@ More...
class	LinearAAModel
	A Linear AutoAssociative Model (LAAM) is a generalization of the PCA model for projecting variables on an affine plane of lower dimension. More...
class	EigenvaluesSymmetric
	The class EigenvaluesSymmetric compute the eigenvalue Decomposition of a symmetric Matrix. More...
class	GinvSymmetric
	The GinvSymmetric class is a functor allowing to compute the generalized inverse of a symmetric matrix. More...
class	Array2D< Real >
	Specialization of the Array2D class for Real values. More...
class	MatrixDiagonal
class	MatrixLowerTriangular
	Declaration of the lower triangular matrix class. More...
class	MatrixSquare
	Derivation of the MatrixSquare class for square arrays of Real. More...
class	MatrixUpperTriangular
	Declaration of the upper triangular matrix class. More...
class	ArrayHo< Real >
	Specialization of the templated class `ArrayHo` for Real. More...
class	Qr
	The class Qr perform the QR decomposition of a Matrix. More...
class	Svd
	The class Svd compute the Singular Value Decomposition of a Matrix with the Golub-Reinsch Algorithm. More...
class	BinOpBase
	Binary Operator bbase class. More...
class	BinOpBase< Op, Real, ExpRight >
	Specialized Binary Operator Base class for the case Real Op Exp. More...
class	BinOpBase< Op, ExpLeft, Real >
	Specialized Binary Operator Base class for the case Exp Op Real. More...
class	BinOpBase< Mult, Matrix, ExpRight >
	Specialized Binary Operator Base class for the case Matrix * ExpRight. More...
class	BinOpBase< Mult, ExpLeft, Matrix >
	Specialized Binary Operator Base class for the case ExpLeft * Matrix. More...
class	BinOpBase< Mult, MatrixSquare, ExpRight >
	Specialized Binary Operator Base class for the case Matrix * ExpRight. More...
class	BinOpBase< Mult, ExpLeft, MatrixSquare >
	Specialized Binary Operator Base class for the case ExpLeft * MatrixSquare. More...
class	BinOpBase< Mult, MatrixUpperTriangular, ExpRight >
	Specialized Binary Operator Base class for the case MatrixUpperTriangular * ExpRight. More...
class	BinOpBase< Mult, ExpLeft, MatrixUpperTriangular >
	Specialized Binary Operator Base class for the case ExpLeft * MatrixUpperTriangular. More...
class	BinOpBase< Mult, MatrixLowerTriangular, ExpRight >
	Specialized Binary Operator Base class for the case MatrixLowerTriangular * ExpRight. More...
class	BinOpBase< Mult, ExpLeft, MatrixLowerTriangular >
	Specialized Binary Operator Base class for the case ExpLeft * MatrixLowerTriangular. More...
class	BinOp
	Binary Operator class derived from BinOpBase class which is specialized. More...
class	UnOp
	UnOp class for unary operators. More...
struct	Plus
	Binary Operator Plus. More...
struct	Minus
	Binary Operator Minus. More...
struct	Mult
	Binary Operator Mult. More...
struct	Div
	Binary Operator Div. More...
struct	Uplus
	Unary Operator Plus. More...
struct	Uminus
	Unary Operator Minus. More...
class	Array1D< Real >
	Specialization of the templated class `Array1D` for Real. More...
class	DataFrame
	DataFrame is a List of Variable with the same number of rows. More...
class	ExportToArray2D
	The ExportToArray2D class allow to export the data of some `TYPE` stored in a `DataFrame` to be exported in an Array2D container. More...
class	ExportToCsv
	Export data to a Csv stream. More...
class	ImportFromCsv
	import data from a Csv File. More...
class	IPage
	A IPage is an interface base class for reading and/or writing a page of option in a file. More...
class	IVariable
	IVariable is an Interface class for all Variables classes. More...
class	Option
	the `Option` class allow to store the value of an option from a IPage. More...
class	ReadWriteCsv
	the ReadWriteCsv class : allow to write and/or to read a csv file. More...
class	ReadWritePages
	The ReadWritePages class allow to handle a file of option containing pages. More...
class	Variable
	Variable is an implementation of the Base class IVariable using The Array1D class for storing the data. More...
class	ILinearReduct
	A ILinearReduct is an interface base class for criteria to maximize in order to find the axis of a linear reduction. More...
class	IReduct
	A IReduct is an interface base class for dimension reduction techniques. More...
class	LocalVariance
	A LocalVariance is an implementation of the abstract `ILinearReduct` class. More...
class	ProjectedVariance
	A ProjectedVariance is an implementation of the abstract `ILinearReduct` class. More...
class	AdditiveBSplineCoefficients
	Compute the regression splines coefficients of an additive model. More...
class	AdditiveBSplineRegression
	Compute an additive BSpline, multivalued, regression function using BSpline basis. More...
class	BSplineCoefficients
	Compute the regression splines coefficients. More...
class	BSplineRegression
	Compute a BSpline, multivalued, regression function using BSpline basis. More...
class	IRegress
	Interface base class for Regression methods. More...
class	IRegress< YContainer, Matrix >
	Partial specialization of the base class IRegress for the Multidimensional case. More...
class	MultidimRegression
	The `MultidimRegression` class allows to regress a multidimensional output variable among a multivariate explanation variable. More...
class	IRecursiveTemplate
	Interface base class for all classes implementing the curious recursive template paradigm. More...
class	IRunnerBase
	Abstract base class for all classes having a. More...
class	IRunnerPtr2D
	Abstract base class for all classes having a. More...
class	IRunnerRef2D
	Abstract base class for all classes having a. More...
class	ISerie
	Interface base class for Series. More...
class	RandBase
	class for the Base random generator. More...
class	AICCriterion
	Derived class of Criterion for computing the AIC Criterion The AIC criteria is a penalization of the likelihood given by the formula $-2 \cdot \ln{p(x\|k)} \approx \mathrm{AIC} = {-2 \cdot \ln{L} +2 D }$ where represents the likelihood of the observations and the number of free parameter of the model. More...
class	BICCriterion
	Derived class of Criterion for computing the BIC Criterion The Bic criteria is a penalization of the likelihood given by the formula $-2 \cdot \ln{p(x\|k)} \approx \mathrm{BIC} = {-2 \cdot \ln{L} + D \ln(n) }$ where represents the likelihood of the observations, the number of free parameter of the model and the number of sample. More...
class	Gaussian2BlocksStatModel
	Compute the the maximum likelihood estimates of a Gaussian tow blocks statistical model. More...
class	GaussianStatModel
	Compute the the maximum likelihood estimates of a Gaussian statistical model. More...
class	ICriterion
	Interface base class for the selection model criterions. More...
class	IStatModelBase
	Interface base class for all statistical models. More...
class	ITStatModel
	Interface base class for all statistical models. More...
struct	Arithmetic
	Arithmetic properties of STK fundamental types. More...
class	Array1D
	Templated one dimensional Array. More...
class	Array2D
	Templated two dimensional column (vertically) oriented Array. More...
class	ArrayHo
	Templated one dimensional horizontal Array. More...
struct	Arithmetic< Binary >
	Specialization for Binary. More...
struct	IdTypeImpl< Binary >
	Specialization of the IdTypeImpl for the Type Binary. More...
class	CellBase
	Templated Base class for the Cell in a list . More...
class	CellVe
	Templated class for the Vertical Cell of a Vertical List. More...
class	CellHo
	Templated class for the Horizontal Cell of a Horizontal List. More...
class	Cell2D
	Templated class for the 2 Dimensional Cells. More...
struct	Arithmetic< Char >
	Specialization of the struct Arithmetic for Char. More...
struct	IdTypeImpl< Char >
	Specialization of the IdTypeImpl for the Type Char. More...
class	IArray1DBase
	Templated Interface base class for uni-dimensional arrays. More...
class	IArray2D
	Templated interface base class for two-dimensional arrays. More...
class	IArray2DBase
	Templated interface base class for two-dimensional arrays. More...
class	IArrayBase
	Templated Interface base class for all Arrays classes. More...
class	IContainer1D
	Interface base class for homogeneous 1D containers. More...
class	IContainer2D
	Interface class for 2D containers. More...
class	IContainerBase
	Interface base class for all containers implementing the curious recursive template paradigm. More...
class	IContainerRef
	Base class for all referencing containers. More...
struct	IdTypeImpl
	Implementation of the return type. More...
struct	Arithmetic< Integer >
	Specialization for Integer (long). More...
struct	IdTypeImpl< Integer >
	Specialization of the IdTypeImpl for the Type Integer. More...
class	ITContainer1D
	Interface base class for homogeneous 1D containers. More...
class	ITContainer2D
	Interface class for homogeneous 2D containers. More...
class	ITContainer2DBase
	Interface base class for homogeneous 2D containers. More...
class	List1D
	Templated One dimensional Horizontal List. More...
struct	Arithmetic< NotAvailable >
	Specialization for NotAvailable. More...
struct	IdTypeImpl< NotAvailable >
	Specialization of the IdTypeImpl for the Type NotAvailable. More...
struct	IProxy
	The IProxy classes is an interface class for wrapping the fundamental types. More...
class	ConstProxy
	The ConstProxy class allow to surdefine operators and methods for every kind of constant class and type without using `dynamic_cast`. More...
class	Proxy
	The Proxy classe allow to surdefine operators and methods for every kind of class without using dynamic_cast. More...
class	Range
	Index sub-vector region. More...
struct	Arithmetic< Real >
	Specialization for Real. More...
struct	IdTypeImpl< Real >
	Specialization of the IdTypeImpl for the Type Real. More...
class	RecursiveArray1D
	Templated one dimensional Array. More...
class	RecursiveArray2D
	Templated two dimensional column (vertically) oriented Array. More...
struct	Arithmetic< Sign >
	Specialization for Sign. More...
struct	IdTypeImpl< Sign >
	Specialization of the IdTypeImpl for the Type Sign. More...
struct	Arithmetic< String >
	Specialization for String. More...
struct	IdTypeImpl< String >
	Specialization of the IdTypeImpl for the Type String. More...
class	Category
	The Category class specifies a category in FreeMiner's tool box component. More...
class	Connection
	A connection between two distinct Steps in a program. More...
class	GProgram
	A GProgram is a succession of Step connected. More...
class	IPropertySource
	Interface to an object which is capable of supplying properties for display by the standard property sheet page implementation (`PropertySheetPage`). More...
class	IStep
	Interface Base class for Steps. More...
class	PropertyDescriptor
	A descriptor for a property to be presented by a standard property sheet page (`PropertySheetPage`). More...
class	Tool
	The Tool class specified a tool in FreeMiner's tool box component. More...
Typedefs
typedef Array2D< Real >	Matrix
	Specialization of the Array2D class for Real values.
typedef ArrayHo< Real >	Point
	final class for a Real horizontal container.
typedef Array1D< Real >	Vector
	Real one dimensional Vertical Array.
typedef IRunnerPtr2D< Real, Point, Vector, Matrix >	IRunnerMatrix
	predefined type for the Matrix container
typedef char	Char
	STK fundamental type of a Char.
typedef long	Integer
	STK fundamental type of discrete values.
typedef double	Real
	STK fundamental type of Real values.
typedef std::basic_ios< Char >	ios
	ios for Char
typedef std::basic_streambuf < Char >	streambuf
	streambuf for Char
typedef std::basic_istream< Char >	istream
	istream for Char
typedef std::basic_ostream< Char >	ostream
	ostream for Char
typedef std::basic_iostream< Char >	iostream
	iostream for Char
typedef std::basic_stringbuf < Char >	stringbuf
	stringbuf for Char
typedef std::basic_istringstream< Char >	istringstream
	istringstream (istringstream) for Char
typedef std::basic_ostringstream< Char >	ostringstream
	ostringstream (ostringstream) for Char
typedef std::basic_stringstream< Char >	stringstream
	stringstream (stringstream) for Char
typedef std::basic_filebuf< Char >	filebuf
	filebuf for Char
typedef std::basic_ifstream< Char >	ifstream
	ifstream for Char
typedef std::basic_ofstream< Char >	ofstream
	ofstream for Char
typedef std::basic_fstream< Char >	fstream
	fstream for Char
typedef std::basic_string< Char >	String
	STK fundamental type of a String.
Enumerations
enum	Binary { zero = 0, one = 1, binaryNA }
	STK fundamental type of a binary. More...
enum	IdType { unknown = 0, character, real, discrete, binary, signof, string, notavailable }
	Id for the Type of a variable. More...
enum	NotAvailable { missing }
	STK fundamental type of a NA value. More...
enum	Sign { negative = -1, positive = 1, SignNA }
	STK fundamental type of a sign. More...
Functions
Real	compGivens (Real const &y, Real const &z, Real &cosinus, Real &sinus)
	Compute Givens rotation.
template<class TContainerHo , class TContainerVe , class TContainer2D >
void	rightGivens (const ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &M, Integer const &col1, Integer const &col2, Real const &cosinus, Real const &sinus)
	Apply Givens rotation.
template<class TContainerHo , class TContainerVe , class TContainer2D >
void	leftGivens (const ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &M, Integer const &row1, Integer const &row2, Real const &cosinus, Real const &sinus)
	left multiplication by a Givens Matrix.
template<class TContainerHo , class TContainerVe , class TContainer2D >
void	gramSchmidt (ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &A)
	The gramSchmidt method perform the Gram Schmidt orthonormalization of a ITContainer2D of Real.
template<class TContainer1D >
Real	house (ITContainer1D< Real, TContainer1D > &x)
	Compute the Householder vector v of a vector x.
template<class TContainer1D_1 , class TContainer1D_2 >
Real	dotHouse (const ITContainer1D< Real, TContainer1D_1 > &x, const ITContainer1D< Real, TContainer1D_2 > &v)
	dot product with a Householder vector.
template<class TContainerHo , class TContainerVe , class TContainer2D , class TContainer1D >
void	leftHouseholder (const ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &M, const ITContainer1D< Real, TContainer1D > &v)
	left multiplication by a Householder vector.
template<class TContainerHo , class TContainerVe , class TContainer2D , class TContainer1D >
void	rightHouseholder (const ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &M, const ITContainer1D< Real, TContainer1D > &v)
	right multiplication by a Householder vector.
template<class TContainerHo , class TContainerVe , class TContainer2D >
void	leftHouseholder (const ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &M, Matrix const &H)
	left multiplication by a Householder Matrix.
template<class TContainerHo , class TContainerVe , class TContainer2D >
void	rightHouseholder (const ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &M, Matrix const &H)
	left multiplication by a Householder Matrix.
template<class Container1D >
Real	sum (ITContainer1D< Real, Container1D > const &x)
	Sum the element of the container.
template<class Container1D1 , class Container1D2 >
Real	weightedSum (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &w)
	Weighted sum of the element of the container.
template<class Container1D >
Real	normInf (ITContainer1D< Real, Container1D > const &x)
	Compute the infinite norm.
template<class Container1D1 , class Container1D2 >
Real	weightedNormInf (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &w)
	Compute the weighted infinite norm.
template<class Container1D >
Real	normTwo (ITContainer1D< Real, Container1D > const &x)
	compute the norm two
template<class Container1D1 , class Container1D2 >
Real	weightedNormTwo (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &w)
	compute the weighted norm two
template<class Container1D >
Real	normTwo2 (ITContainer1D< Real, Container1D > const &x)
	Compute the squared norm two.
template<class Container1D1 , class Container1D2 >
Real	weightedNormTwo2 (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &w)
	Compute the squared norm two.
template<class Container1D1 , class Container1D2 >
Real	dot (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &y)
	Compute the dot product.
template<class Container1D1 , class Container1D2 , class Container1D3 >
Real	weightedDot (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &y, ITContainer1D< Real, Container1D3 > const &w)
	Compute the dot product.
template<class Container1D1 , class Container1D2 >
Real	dist (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &y)
	Compute the distance between two vectors.
template<class Container1D1 , class Container1D2 , class Container1D3 >
Real	weightedDist (ITContainer1D< Real, Container1D1 > const &x, ITContainer1D< Real, Container1D2 > const &y, ITContainer1D< Real, Container1D3 > const &w)
	Compute the weighted distance between two vectors.
Real	trace (MatrixSquare const &A)
	trace of a square matrix
MatrixSquare *	mult (MatrixSquare const &A, MatrixSquare const &B)
	MatrixSquare multiplication.
Matrix *	mult (Matrix const &A, Matrix const &B)
	Matrix multiplication.
Matrix *	mult (MatrixSquare const &A, Matrix const &B)
	Matrix multiplication.
template<class Container1D >
Vector *	mult (Matrix const &A, ITContainer1D< Real, Container1D > const &X)
	Matrix multiplication by a Vector.
template<class TContainerHo , class TContainerVe , class TContainer2D , class TContainer1D >
void	mult (ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > const &A, ITContainer1D< Real, TContainer1D > const &X, ITContainer1D< Real, TContainer1D > &Y)
	Matrix multiplication by a Vector.
template<class Container1D >
void	mult (MatrixSquare const &A, ITContainer1D< Real, Container1D > const &X, ITContainer1D< Real, Container1D > &Y)
	Square Matrix multiplication by a Vector.
template<class TContainerHo , class TContainerVe , class TContainer2D , class TContainer1D >
void	multLefTranspose (ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > const &A, ITContainer1D< Real, TContainer1D > const &X, ITContainer1D< Real, TContainer1D > &Y)
	Matrix multiplication by a Vector.
template<class Container1D >
void	multLeftTranspose (MatrixSquare const &A, ITContainer1D< Real, Container1D > const &X, ITContainer1D< Real, Container1D > &Y)
	transposed square Matrix multiplication by a Vector.
Matrix *	multLeftTranspose (Matrix const &A, Matrix const &B)
	Matrix multiplication.
template<class Container1D >
Vector *	multLeftTranspose (Matrix const &A, ITContainer1D< Real, Container1D > const &X)
	Matrix by Vector multiplication.
Matrix *	weightedMultLeftTranspose (Matrix const &A, Matrix const &B, Vector const &weights)
	Weighted matrix multiplication.
MatrixSquare *	multLeftTranspose (Matrix const &A)
	Matrix multiplication.
MatrixSquare *	multRightTranspose (Matrix const &A)
	Matrix multiplication.
MatrixSquare *	weightedMultLeftTranspose (Matrix const &A, Vector const &weights)
	Weighted matrix multiplication.
template<class TContainerHo , class TContainerVe , class TContainer2D >
Real	normInf (ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > const &A)
	Compute the infinity norm of a 2D container.
template<class TContainerHo_1 , class TContainerVe_1 , class TContainer2D_1 , class TContainerHo_2 , class TContainerVe_2 , class TContainer2D_2 >
void	transpose (ITContainer2D< Real, TContainerHo_1, TContainerVe_1, TContainer2D_1 > const &A, ITContainer2D< Real, TContainerHo_2, TContainerVe_2, TContainer2D_2 > &At)
	transpose a matrix
template<class TContainerHo , class TContainerVe , class TContainer2D >
ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &	transpose (ITContainer2D< Real, TContainerHo, TContainerVe, TContainer2D > &Q)
	Transpose a Matrix.
template<class TContainerHo1 , class TContainerVe1 , class TContainer2D1 , class TContainerHo2 , class TContainerVe2 , class TContainer2D2 , class TContainerHo3 , class TContainerVe3 , class TContainer2D3 >
void	mult (ITContainer2D< Real, TContainerHo1, TContainerVe1, TContainer2D1 > &C, const ITContainer2D< Real, TContainerHo2, TContainerVe2, TContainer2D2 > &A, const ITContainer2D< Real, TContainerHo3, TContainerVe3, TContainer2D3 > &B)
	Matrix multiplication.
template<class ExpLeft , class ExpRight >
BinOp< Plus, ExpLeft, ExpRight >	operator+ (const ExpLeft &lhs, const ExpRight &rhs)
	Adding two Expressions.
template<class ExpLeft , class ExpRight >
BinOp< Minus, ExpLeft, ExpRight >	operator- (const ExpLeft &lhs, const ExpRight &rhs)
	soustracting A ExpRight to An Expression.
template<class ExpLeft , class ExpRight >
BinOp< Mult, ExpLeft, ExpRight >	operator* (const ExpLeft &lhs, const ExpRight &rhs)
	Mult A ExpRight to An Expression.
template<class ExpLeft , class ExpRight >
BinOp< Div, ExpLeft, ExpRight >	operator/ (const ExpLeft &lhs, const ExpRight &rhs)
	Div A ExpRight to An Expression.
template<class ExpRight >
UnOp< Uminus, ExpRight >	operator- (const ExpRight &rhs)
	Unary Minus Operator.
template<class ExpRight >
UnOp< Uplus, ExpRight >	operator+ (const ExpRight &rhs)
	Unary Plus Operator.
Vector *	multLeftTranspose (Matrix const &A, Vector const &X)
	*
ostream &	operator<< (ostream &s, const DataFrame &V)
	Print a DataFrame.
template<class TYPE , class TContainer1D >
void	heapSort (ITContainer1D< TYPE, TContainer1D > &T)
	Sort the container T in ascending order.
template<class TYPE , class TContainer1D >
void	heapSort (const ITContainer1D< TYPE, TContainer1D > &T, ITContainer1D< TYPE, TContainer1D > &Tsort)
	Sort the container T in ascending order and return the result in the container Tsort.
template<class TYPE , class TContainer1D >
void	heapSort (Array1D< Integer > &I, const ITContainer1D< TYPE, TContainer1D > &T)
	Sort the container T in ascending order using index array.
template<class TYPE , class TContainer1D >
void	applySort (ITContainer1D< TYPE, TContainer1D > &T, const Array1D< Integer > &I)
	Apply a sorting index array to the 1D container T.
template<class TYPE , class TContainerHo , class TContainerVe , class TContainer2D >
void	applySort (ITContainer2D< TYPE, TContainerHo, TContainerVe, TContainer2D > &T, const Array1D< Integer > &I)
	Apply a sorting index array to the 2D container T row by row.
istream &	operator>> (istream &is, ReadWriteCsv &df)
	Read the data from the stream and returns the stream when done.
ostream &	operator<< (ostream &os, ReadWriteCsv const &df)
	write the data into the stream and returns the stream when done.
static void	removeComments (String &str, Char c)
static void	createKeyWord (String &str, Integer const &level)
static Integer	maxLength (const Variable< String > &V)
	Compute the maximal Length of the strings in V.
static Integer	CountCols (String const &line, String const &delimiters, Variable< String > &typeDelimiter)
	Counts the number of columns in a line stored in a String and return the position of the delimiters and its types.
template<class Serie >
home iovleff Developpement workspace stkpp projects STatistiK include STK_Algo h Real	sumAlternateSerie (const ISerie< Serie > &f, Integer const &n=0)
	Sum an alternating serie using the Chebichev polynomials.
template<class Serie >
Real	sumSerie (const ISerie< Serie > &f, Integer const &iter_max=10)
	Sum a serie using the epsilon acceleration process.
template<class Seriea , class Serieb >
Real	continuedFraction (const ISerie< Seriea > &a, const ISerie< Serieb > &b, Integer const &iter_max=100)
	Evaluate a continued fraction.
ostream &	operator<< (ostream &os, const Binary &output)
	Overloading of the ostream << for the type Binary.
istream &	operator>> (istream &is, Proxy< Binary > &input)
	Overloading of the istream >> for the type Binary.
template<class TYPE , template< class TYPE > class Container1D>
ostream &	out1D (ostream &s, const Container1D< TYPE > &V)
	Write a Container1D.
template<template< class > class Container1D>
ostream &	out1D (ostream &s, const Container1D< Real > &V)
	Specialization for Real.
template<template< class > class Container1D>
ostream &	out1D (ostream &s, const Container1D< Integer > &V)
	Specialization for Integer.
template<class TYPE >
ostream &	operator<< (ostream &s, const Array1D< TYPE > &V)
	ostream for Array1D.
template<class TYPE >
ostream &	operator<< (ostream &s, const ArrayHo< TYPE > &V)
	ostream for ArrayHo.
template<class TYPE >
ostream &	operator<< (ostream &s, const List1D< TYPE > &V)
	ostream for List1D.
template<class TYPE , class TContainer2D >
void	out2D (ostream &os, const IArray2D< TYPE, TContainer2D > &V)
	Method for displaying any two dimensional 2D Array derived from the interface IArray2D.
template<class TYPE , class TContainer2D >
ostream &	operator<< (ostream &os, const IArray2D< TYPE, TContainer2D > &V)
	ostream for IArray2D.
template<class TYPE >
TYPE	sign (TYPE const &x, TYPE const &y=1)
	templated sign value sign(x) * y: TYPE should be Integer , long, float or Real
template<class TYPE >
void	swap (TYPE &x, TYPE &y)
	templated swap method.
template<class TYPE >
TYPE const &	min (TYPE const &x, TYPE const &y)
	templated minimum for class having defined <.
template<class TYPE >
TYPE const &	max (TYPE const &x, TYPE const &y)
	templated maximum for class having defined <.
template<class TYPE >
TYPE	abs (TYPE const &x)
	templated absolute value: TYPE should be Integer , long, float or Real.
Real	frand ()
	frand() generate a Real uniform number.
bool	isOdd (Integer const &x)
	is x a odd number ?
bool	isEven (Integer const &x)
	is x an even number ?
Integer	round (Real const &x)
	Computation of round off : return an Integer value.
Real	norm (Real const &x, Real const &y)
	Computation of sqrt(x^2 + y^2) without underflow or overflow.
ostream &	operator<< (ostream &os, const NotAvailable &output)
	Overloading of the ostream << for the type NotAvailable.
istream &	operator>> (istream &is, Proxy< NotAvailable > &input)
	Overloading of the istream >> for the type NotAvailable.
ostream &	operator<< (ostream &os, const Sign &output)
	Overloading of the ostream << for the type Sign.
istream &	operator>> (istream &is, Proxy< Sign > &input)
	Overloading of the istream >> for the type Sign.
template<class TYPE >
bool	stringToType (TYPE &t, String const &s, std::ios_base &(*f)(std::ios_base &)=std::dec)
	convert a String to TYPE
template<class TYPE >
String	typeToString (TYPE const &t, std::ios_base &(*f)(std::ios_base &)=std::dec)
	convert a TYPE to String
template<class TYPE >
ostream &	operator<< (ostream &os, const ConstProxy< TYPE > &output)
	Overloading of the operator << for the type TYPE using a constant Proxy.
template<class TYPE >
istream &	operator>> (istream &is, Proxy< TYPE > &input)
	Overloading of the operator >> for the type TYPE using a Proxy.
istream &	operator>> (istream &is, Proxy< String > &input)
	Overloading of the istream >> for the type String.
String &	toUpperString (String &s)
	convert the characters of the String to upper case
String	toUpperString (String const &s)
	convert the characters of the String to upper case
ostream &	operator<< (ostream &s, Range const &I)
	Print a Range using the colon notation.
istream &	operator>> (istream &s, Range &I)
	Read a Range in the form first:last (MATLAB-like form) from an input stream.
Variables
static const String	STRING_EMPTY = String()
	Representation of Not Available String value.
static const String	STRING_NL = _T("\n")
	Representation of a New Line String.
static const String	STRING_BLANK = _T(" ")
	Representation of a blank value.
static const String	STRING_VAR = _T("Var")
	default prefix of a variable name.
static const Char	CHAR_COMMENT = _T('#')
	The char indicating the beginning of a comment in an option file.
static const Char	CHAR_EQUAL = _T('=')
	The char indicating an equality in an option file.
static const Char	CHAR_BLANK = _T(' ')
	The blank space char.
static const Char	CHAR_TAB = _T('\t')
	The tab char.
static const Char	CHAR_SEP = _T(',')
	The default separator char in list of option.
static const Char	CHAR_OPENBRACKET = _T('[')
	The open bracket char.
static const Char	CHAR_CLOSEBRACKET = _T(']')
	The close bracket char.
static const std::string	ERRORCODES []
	some errors messages.
static const String	STRING_NA = String(_T("."))
	Representation of a Not Available value.
static const int	STRING_NA_SIZE = 1
	Size (in number of Char) of a Not Available value.

Detailed Description

STK means the Statistical ToolKit.

The namespace STK is the main domain space of the Statistical ToolKit project (STK++). All methods and classes are enclosed in this namespace.

Function Documentation

template<class ExpLeft , class ExpRight >

BinOp<Plus, ExpLeft, ExpRight > STK::operator+	(	const ExpLeft &	lhs,
		const ExpRight &	rhs
	)

Adding two Expressions.

Definition at line 108 of file STK_TOperator.h.

{ return BinOp<Plus, ExpLeft, ExpRight >(lhs, rhs);}

template<class ExpLeft , class ExpRight >

BinOp<Minus, ExpLeft, ExpRight > STK::operator-	(	const ExpLeft &	lhs,
		const ExpRight &	rhs
	)

soustracting A ExpRight to An Expression.

Definition at line 114 of file STK_TOperator.h.

{ return BinOp<Minus, ExpLeft, ExpRight >(lhs, rhs);}

template<class ExpLeft , class ExpRight >

BinOp<Mult, ExpLeft, ExpRight > STK::operator*	(	const ExpLeft &	lhs,
		const ExpRight &	rhs
	)

Mult A ExpRight to An Expression.

Definition at line 120 of file STK_TOperator.h.

{ return BinOp<Mult, ExpLeft, ExpRight >(lhs, rhs);}

template<class ExpLeft , class ExpRight >

BinOp<Div, ExpLeft, ExpRight > STK::operator/	(	const ExpLeft &	lhs,
		const ExpRight &	rhs
	)

Div A ExpRight to An Expression.

Definition at line 126 of file STK_TOperator.h.

{ return BinOp<Div, ExpLeft, ExpRight >(lhs, rhs);}

template<class ExpRight >

UnOp<Uminus, ExpRight > STK::operator- ( const ExpRight & rhs )

Unary Minus Operator.

Definition at line 131 of file STK_TOperator.h.

{ return UnOp<Uminus, ExpRight >(rhs);}

template<class ExpRight >

UnOp<Uplus, ExpRight > STK::operator+ ( const ExpRight & rhs )

Unary Plus Operator.

Definition at line 136 of file STK_TOperator.h.

{ return UnOp<Uplus, ExpRight >(rhs);}

ostream & STK::operator<<	(	ostream &	s,
		const DataFrame &	V
	)

Print a DataFrame.

Definition at line 465 of file STK_DataFrame.cpp.

References STK::IContainer2D::firstCol(), STK::IContainer2D::lastCol(), and STK::DataFrame::writeDataFrame().

{
  s << std::right;
  V.writeDataFrame(s, V.firstCol(), V.lastCol());

  return s;
}

static void STK::removeComments	(	String &	str,
		Char	c
	)		`[static]`

Definition at line 54 of file STK_IPage.cpp.

Referenced by STK::IPage::findKeyword(), and STK::IPage::read().

{
  String::size_type pos = str.find(c);
  if (pos < str.size())
  {
    str.resize(pos);
  }
}

static void STK::createKeyWord	(	String &	str,
		Integer const &	level
	)		`[static]`

Definition at line 64 of file STK_IPage.cpp.

References CHAR_CLOSEBRACKET, and CHAR_OPENBRACKET.

Referenced by STK::IPage::addPage(), and STK::IPage::IPage().

{
  // remove all occurrences of CHAR_OPENBRACKET
  str.erase( std::remove( str.begin(), str.end(), CHAR_OPENBRACKET ), str.end() );
  // remove all occurrences of CHAR_CLOSEBRACKET
  str.erase( std::remove( str.begin(), str.end(), CHAR_CLOSEBRACKET ), str.end() );
  // add CHAR_OPENBRACKET and CHAR_CLOSEBRACKET
  str.insert(0, level, CHAR_OPENBRACKET).append(level, CHAR_CLOSEBRACKET);
}

template<class TYPE , template< class TYPE > class Container1D>

ostream& STK::out1D	(	ostream &	s,
		const Container1D< TYPE > &	V
	)

Write a Container1D.

Parameters:

s	the output stream
V	the Container to write

Definition at line 53 of file STK_Display1D.h.

References _T.

Referenced by operator<<().

{
  Integer rbeg = V.first(), rend = V.last();

  s << std::right;
//    << std::setprecision(1);
  for (Integer i=rbeg; i<=rend; i++)
  { s << ConstProxy<TYPE>(V[i]) << _T(' ') ; }
  return s;
}

template<template< class > class Container1D>

ostream& STK::out1D	(	ostream &	s,
		const Container1D< Real > &	V
	)

Specialization for Real.

Parameters:

s	the output stream
V	the Container to write

Definition at line 70 of file STK_Display1D.h.

References _T.

{
  Integer rbeg = V.first(), rend = V.last();

  s << std::right;
//    << std::setprecision(1);
  for (Integer i=rbeg; i<=rend; i++)
  { s << std::setw(12) << ConstProxy<Real>(V[i]) << _T(' ') ; }

  return s;

}

template<template< class > class Container1D>

ostream& STK::out1D	(	ostream &	s,
		const Container1D< Integer > &	V
	)

Specialization for Integer.

Parameters:

s	the output stream
V	the Array1D to write

Definition at line 88 of file STK_Display1D.h.

References _T.

{
  Integer rbeg = V.first(), rend = V.last();

  s << std::right;
  for (Integer i=rbeg; i<=rend; i++)
  { s << std::setw(5) << ConstProxy<Integer> (V[i]) << _T(' ') ; }
  return s;
}

template<class TYPE >

ostream& STK::operator<<	(	ostream &	s,
		const Array1D< TYPE > &	V
	)

ostream for Array1D.

Parameters:

s	the output stream
V	the Array1D to write

Definition at line 103 of file STK_Display1D.h.

References out1D().

{ return out1D(s,V);}

template<class TYPE >

ostream& STK::operator<<	(	ostream &	s,
		const ArrayHo< TYPE > &	V
	)

ostream for ArrayHo.

Parameters:

s	the output stream
V	the ArrayHo to write

Definition at line 111 of file STK_Display1D.h.

References out1D().

{ return out1D(s,V);}

template<class TYPE >

ostream& STK::operator<<	(	ostream &	s,
		const List1D< TYPE > &	V
	)

ostream for List1D.

Parameters:

s	the output stream
V	the List1D to write

Definition at line 119 of file STK_Display1D.h.

References out1D().

{ return out1D(s,V);}

template<class TYPE , class TContainer2D >

void STK::out2D	(	ostream &	os,
		const IArray2D< TYPE, TContainer2D > &	V
	)

Method for displaying any two dimensional 2D Array derived from the interface IArray2D.

The Container is exported in ReadWriteCsv and the the csv is written in the output stream.

Parameters:

os	the output stream
V	the 2D container to write

Definition at line 52 of file STK_Display2D.h.

References _T, STK::ExportToCsv::p_readWriteCsv(), STK::ReadWriteCsv::setDelimiters(), and STK::ReadWriteCsv::write().

Referenced by operator<<().

{
  // Export  to csv the Array
  ExportToCsv exportcsv(V);
  // get the csv
  ReadWriteCsv* pData = exportcsv.p_readWriteCsv();
  // set delimiters to blank
  pData->setDelimiters(_T(" "));
  // write the csv in os
  pData->write(os);
}

template<class TYPE , class TContainer2D >

ostream& STK::operator<<	(	ostream &	os,
		const IArray2D< TYPE, TContainer2D > &	V
	)

ostream for IArray2D.

Parameters:

os	the output stream
V	the 2D container to write

Definition at line 69 of file STK_Display2D.h.

References out2D().

{
  out2D(os, V);
  return os;
}

ostream& STK::operator<<	(	ostream &	s,
		Range const &	I
	)

Print a Range using the colon notation.

Write a Range in the form first:last (MATLAB-like form) in an output stream.

Parameters:

s	output stream
I	the Range to write

Definition at line 228 of file STK_Range.cpp.

References _T, STK::Range::first_, and STK::Range::last_.

{
  s << I.first_ << _T(":") << I.last_;
  return s;
}

istream& STK::operator>>	(	istream &	s,
		Range &	I
	)

Read a Range in the form first:last (MATLAB-like form) from an input stream.

The input stream can also be a number (say n). In this case the range will be 1:n. If the range cannot be read the method return the default range 1:0. FIXME? should be NA value, but NA value is not defined for Range.

Parameters:

s	the input stream
I	the range to set

Definition at line 242 of file STK_Range.cpp.

References _T, STK::Range::first_, STK::Range::last_, and stringToType().

{
  String num;
  s >> std::skipws;
  // get first number
  std::getline(s, num, _T(':'));
  // check if the istream is exhausted
  if (s.eof())
  {
    I.first_ = 1;
    if (!stringToType(I.last_, num)) I.last_ =0;
    return s;
  }
  // otherwise we encounter a ":", thus skip the current char
  if (!stringToType(I.first_, num)) I.first_ =1;
  s.peek();
  if ((s >> I.last_).fail())
  {
    I.first_ =1; I.last_ =0;
  }
  return s;
}

STK Namespace Reference

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Function Documentation