wns::evaluation::statistics::DLRE Class Reference

Class DLRE: Discrete LRE (LRE III), base class.

#include <evaluation/statistics/dlre.hpp>

Inheritance diagram for wns::evaluation::statistics::DLRE:

Collaboration diagram for wns::evaluation::statistics::DLRE:

List of all members.

Public Member Functions

virtual void changeError (double newError)

Change error.

virtual double curXLev ()

Return current x level to be completed.

DLRE (const wns::pyconfig::View &config)

DLRE (double xMin, double xMax, double intSize, double error, double preFirst, std::string name, std::string description, bool forceRMinusAOk, int maxNrv, int skipInterval, formatType format)

Constructor for equi-distant x-values.

DLRE (std::vector< double > xValuesArr, int level, double error, double preFirst, std::string name, std::string description, bool forceRMinusAOk, int maxNrv, int skipInterval, formatType format)

Constructor for non-equi-distant x-values.

virtual void getResultLine (const int index, ResultLine &line) const =0

Return result line.

virtual int maxIndex () const

Return the index of the maximum x value to be evaluated.

virtual int minIndex () const

return the index of the minimum x value to be evaluated

virtual double p (double xt)

Returns the prob. of xt.

virtual void print (std::ostream &stream=std::cout) const =0

Print output.

virtual void put (double value)=0

Put new value to probe.

virtual void reset ()

Reset measurement results.

void setBase (double newBase)

Return factor for cond. prob.

~DLRE ()

Destructor.

Protected Types

enum ComparisonResult { noIndex = -3, greater = -2, lower = -1 }

Comparison result returned by getIndex(). More...

enum Phase { initialize, iterate, finish }

enum ReasonType { ok, minimum, last }

reason for status = finish More...

Protected Member Functions

bool checkLargeSample (int index) const

Large sample conditions are fulfilled?

int getIndex (double value) const

get index of current x

void printAll (std::ostream &stream, functionType functionType, const double yMin) const

Output function-specific evaluation results.

Protected Attributes

double base_

Needed for conditional probabilties.

int curIndex_

Index of current x-value.

int curLevelIndex_

Index of current x-level.

bool equiDist_

Equi-distant x values or user defined?

bool forceRminusAOK_

force last large sample criterion (r - av >= 10)

int h_

Run time control (rtc) counter.

int indexMax_

int indexMin_

double intSize_

distance between x values

int maxNrv_

Maximal number of trials.

enum
wns::evaluation::statistics::DLRE::Phase phase_

int preIndex_

Index of predecessor.

double preRv_

predecessor

ReasonType reason_

Reason for end reached.

double relErrMax_

Result * results_

Array of results.

int skipInterval_

Number of samples after which simulation is checked for completion.

int wastedLeft_

Values lower minimum.

int wastedRight_

Values greater maximum.

double xMax_

double xMin_

int xOffset_

Offset of x-values (step 1).

Static Protected Attributes

static const int largeSampleNumSortedValues_ = 100

number of sorted values for large sample conditions

static const int largeSampleNumTransitions_ = 10

Number of transitions for large sample conditions.

static const int largeSampleNumTrials_ = 1000

Number of trials for large sample conditions.

Private Member Functions

void initEqui (double xMin, double xMax, double intSize, double preFirst)

Initialization which creates equidistant x-values for the bins, which have a width of 'intSize' between 'xMin' and 'xMax'.

void initNonEqui (int level, std::vector< double > xValuesArr, double preFirst)

Initialization with an array of x-values for the bins.

void printLevel (std::ostream &stream, int level, const std::string &errorString, bool discretePointFlag, functionType functionType) const

Classes

class Result

Class DLRE::Result: results for one x interval. More...

class ResultLine

Class DLRE::resultLine: one line of evaluation results. More...

Detailed Description

Definition at line 42 of file dlre.hpp.

Member Enumeration Documentation

enum wns::evaluation::statistics::DLRE::ComparisonResult [protected]

Enumerator:

noIndex
greater
lower

Definition at line 234 of file dlre.hpp.

enum wns::evaluation::statistics::DLRE::Phase [protected]

Enumerator:

initialize
iterate
finish

Definition at line 175 of file dlre.hpp.

enum wns::evaluation::statistics::DLRE::ReasonType [protected]

Enumerator:

ok
minimum
last

Definition at line 244 of file dlre.hpp.

Constructor & Destructor Documentation

wns::evaluation::statistics::DLRE::DLRE	(	std::vector< double >	xValuesArr,
		int	level,
		double	error,
		double	preFirst,
		std::string	name,
		std::string	description,
		bool	forceRMinusAOk,
		int	maxNrv,
		int	skipInterval,
		formatType	format
	)

wns::evaluation::statistics::DLRE::DLRE	(	double	xMin,
		double	xMax,
		double	intSize,
		double	error,
		double	preFirst,
		std::string	name,
		std::string	description,
		bool	forceRMinusAOk,
		int	maxNrv,
		int	skipInterval,
		formatType	format
	)

DLRE::DLRE ( const wns::pyconfig::View & config )

Definition at line 240 of file dlre.cpp.

DLRE::~DLRE ( )

Definition at line 308 of file dlre.cpp.

Member Function Documentation

void DLRE::changeError ( double newError ) [virtual]

change maximum relative error

Reimplemented in wns::evaluation::statistics::DLREF, wns::evaluation::statistics::DLREG, and wns::evaluation::statistics::DLREP.

Definition at line 339 of file dlre.cpp.

bool DLRE::checkLargeSample ( int index ) const [protected]

check large sample conditions

Definition at line 812 of file dlre.cpp.

double DLRE::curXLev ( ) [virtual]

return current x level

Definition at line 345 of file dlre.cpp.

int DLRE::getIndex ( double value ) const [protected]

return index of x value

Definition at line 414 of file dlre.cpp.

virtual void wns::evaluation::statistics::DLRE::getResultLine	(	const int	index,
		ResultLine &	line
	)			const `[pure virtual]`

Implemented in wns::evaluation::statistics::DLREF, wns::evaluation::statistics::DLREG, and wns::evaluation::statistics::DLREP.

void DLRE::initEqui	(	double	xMin,
		double	xMax,
		double	intSize,
		double	preFirst
	)			`[private]`

Definition at line 191 of file dlre.cpp.

void DLRE::initNonEqui	(	int	level,
		std::vector< double >	xValuesArr,
		double	preFirst
	)			`[private]`

Definition at line 75 of file dlre.cpp.

int DLRE::maxIndex ( ) const [virtual]

return the index of the maximum x value to be evaluated

Definition at line 374 of file dlre.cpp.

int DLRE::minIndex ( ) const [virtual]

return the index of the minimum x value to be evaluated

Definition at line 368 of file dlre.cpp.

double DLRE::p ( double xt ) [virtual]

return percentage of values collected for interval xt

Definition at line 352 of file dlre.cpp.

virtual void wns::evaluation::statistics::DLRE::print ( std::ostream & stream = std::cout ) const [pure virtual]

Reimplemented from wns::evaluation::statistics::StatEval.

Implemented in wns::evaluation::statistics::DLREF, wns::evaluation::statistics::DLREG, and wns::evaluation::statistics::DLREP.

void wns::evaluation::statistics::DLRE::printAll	(	std::ostream &	stream,
		functionType	functionType,
		const double	yMin
	)			const `[protected]`

void wns::evaluation::statistics::DLRE::printLevel	(	std::ostream &	stream,
		int	level,
		const std::string &	errorString,
		bool	discretePointFlag,
		functionType	functionType
	)			const `[private]`

virtual void wns::evaluation::statistics::DLRE::put ( double value ) [pure virtual]

Reimplemented from wns::evaluation::statistics::StatEval.

Implemented in wns::evaluation::statistics::DLREF, wns::evaluation::statistics::DLREG, and wns::evaluation::statistics::DLREP.

void DLRE::reset ( ) [virtual]

reset collected data

Reimplemented from wns::evaluation::statistics::StatEval.

Definition at line 314 of file dlre.cpp.

void DLRE::setBase ( double newBase )

set base

Definition at line 333 of file dlre.cpp.

Member Data Documentation

double wns::evaluation::statistics::DLRE::base_ [protected]

Definition at line 319 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::curIndex_ [protected]

Definition at line 304 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::curLevelIndex_ [protected]

Definition at line 329 of file dlre.hpp.

bool wns::evaluation::statistics::DLRE::equiDist_ [protected]

Definition at line 294 of file dlre.hpp.

bool wns::evaluation::statistics::DLRE::forceRminusAOK_ [protected]

Definition at line 340 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::h_ [protected]

Definition at line 276 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::indexMax_ [protected]

Definition at line 289 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::indexMin_ [protected]

Definition at line 287 of file dlre.hpp.

double wns::evaluation::statistics::DLRE::intSize_ [protected]

Definition at line 299 of file dlre.hpp.

const int DLRE::largeSampleNumSortedValues_ = 100 [static, protected]

Definition at line 350 of file dlre.hpp.

const int DLRE::largeSampleNumTransitions_ = 10 [static, protected]

Definition at line 355 of file dlre.hpp.

const int DLRE::largeSampleNumTrials_ = 1000 [static, protected]

Definition at line 345 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::maxNrv_ [protected]

Definition at line 261 of file dlre.hpp.

enum wns::evaluation::statistics::DLRE::Phase wns::evaluation::statistics::DLRE::phase_ [protected]

int wns::evaluation::statistics::DLRE::preIndex_ [protected]

Definition at line 314 of file dlre.hpp.

double wns::evaluation::statistics::DLRE::preRv_ [protected]

Definition at line 309 of file dlre.hpp.

ReasonType wns::evaluation::statistics::DLRE::reason_ [protected]

Definition at line 324 of file dlre.hpp.

double wns::evaluation::statistics::DLRE::relErrMax_ [protected]

Definition at line 256 of file dlre.hpp.

Result* wns::evaluation::statistics::DLRE::results_ [protected]

Definition at line 254 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::skipInterval_ [protected]

Definition at line 335 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::wastedLeft_ [protected]

Definition at line 266 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::wastedRight_ [protected]

Definition at line 271 of file dlre.hpp.

double wns::evaluation::statistics::DLRE::xMax_ [protected]

Definition at line 285 of file dlre.hpp.

double wns::evaluation::statistics::DLRE::xMin_ [protected]

Definition at line 283 of file dlre.hpp.

int wns::evaluation::statistics::DLRE::xOffset_ [protected]

Definition at line 281 of file dlre.hpp.

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

framework/library/src/evaluation/statistics/dlre.hpp
framework/library/src/evaluation/statistics/dlre.cpp


Public Member Functions
virtual void	changeError (double newError)
	Change error.
virtual double	curXLev ()
	Return current x level to be completed.
	DLRE (const wns::pyconfig::View &config)
	DLRE (double xMin, double xMax, double intSize, double error, double preFirst, std::string name, std::string description, bool forceRMinusAOk, int maxNrv, int skipInterval, formatType format)
	Constructor for equi-distant x-values.
	DLRE (std::vector< double > xValuesArr, int level, double error, double preFirst, std::string name, std::string description, bool forceRMinusAOk, int maxNrv, int skipInterval, formatType format)
	Constructor for non-equi-distant x-values.
virtual void	getResultLine (const int index, ResultLine &line) const =0
	Return result line.
virtual int	maxIndex () const
	Return the index of the maximum x value to be evaluated.
virtual int	minIndex () const
	return the index of the minimum x value to be evaluated
virtual double	p (double xt)
	Returns the prob. of xt.
virtual void	print (std::ostream &stream=std::cout) const =0
	Print output.
virtual void	put (double value)=0
	Put new value to probe.
virtual void	reset ()
	Reset measurement results.
void	setBase (double newBase)
	Return factor for cond. prob.
	~DLRE ()
	Destructor.
Protected Types
enum	ComparisonResult { noIndex = -3, greater = -2, lower = -1 }
	Comparison result returned by getIndex(). More...
enum	Phase { initialize, iterate, finish }
enum	ReasonType { ok, minimum, last }
	reason for status = finish More...
Protected Member Functions
bool	checkLargeSample (int index) const
	Large sample conditions are fulfilled?
int	getIndex (double value) const
	get index of current x
void	printAll (std::ostream &stream, functionType functionType, const double yMin) const
	Output function-specific evaluation results.
Protected Attributes
double	base_
	Needed for conditional probabilties.
int	curIndex_
	Index of current x-value.
int	curLevelIndex_
	Index of current x-level.
bool	equiDist_
	Equi-distant x values or user defined?
bool	forceRminusAOK_
	force last large sample criterion (r - av >= 10)
int	h_
	Run time control (rtc) counter.
int	indexMax_
int	indexMin_
double	intSize_
	distance between x values
int	maxNrv_
	Maximal number of trials.
enum wns::evaluation::statistics::DLRE::Phase	phase_
int	preIndex_
	Index of predecessor.
double	preRv_
	predecessor
ReasonType	reason_
	Reason for end reached.
double	relErrMax_
Result *	results_
	Array of results.
int	skipInterval_
	Number of samples after which simulation is checked for completion.
int	wastedLeft_
	Values lower minimum.
int	wastedRight_
	Values greater maximum.
double	xMax_
double	xMin_
int	xOffset_
	Offset of x-values (step 1).
Static Protected Attributes
static const int	largeSampleNumSortedValues_ = 100
	number of sorted values for large sample conditions
static const int	largeSampleNumTransitions_ = 10
	Number of transitions for large sample conditions.
static const int	largeSampleNumTrials_ = 1000
	Number of trials for large sample conditions.
Private Member Functions
void	initEqui (double xMin, double xMax, double intSize, double preFirst)
	Initialization which creates equidistant x-values for the bins, which have a width of 'intSize' between 'xMin' and 'xMax'.
void	initNonEqui (int level, std::vector< double > xValuesArr, double preFirst)
	Initialization with an array of x-values for the bins.
void	printLevel (std::ostream &stream, int level, const std::string &errorString, bool discretePointFlag, functionType functionType) const
Classes
class	Result
	Class DLRE::Result: results for one x interval. More...
class	ResultLine
	Class DLRE::resultLine: one line of evaluation results. More...