libFAUDES

Sections

Index

faudes::DiscreteDensityFunction Class Reference

#include <sp_densityfnct.h>

Inherited by faudes::SampledDensityFunction.

List of all members.


Detailed Description

Density Function.

A DiscreteDensityFnction models a piecewise constant map with non-negative support. It consists of a sorted vector (aka map) of disjoint time intervals with one associated value each.

The current implementation is rather incomplete, inefficient, and buggy. The ToDo list includes

  • we assume consecutive right open intervals, so either assert the restriction or implement more general
  • we assume an integer time type, so either assert the restriction or implement more general
  • fix token io
  • need proper access
  • implement method to evaluate random variable with given density
  • generalise to class DensityFunction to include some continuous functions eg exponential, gauss

Public Types

typedef std::map< tpTime::Type,
Entry >::const_iterator 
CIterator
typedef std::map< tpTime::Type,
Entry >::iterator 
Iterator

Public Member Functions

 DiscreteDensityFunction (void)
virtual ~DiscreteDensityFunction (void)
virtual void Clear (void)
double Value (tpTime::Type time) const
const TimeIntervalTimeInt (tpTime::Type time) const
CIterator Begin (void) const
CIterator End (void) const
CIterator At (tpTime::Type time) const
const TimeIntervalTimeInt (CIterator mit) const
const double & Value (CIterator mit) const
Iterator Begin (void)
Iterator End (void)
Iterator At (tpTime::Type time)
const Entry EntryAt (tpTime::Type time) const
const std::string & Name (void) const
void Name (const std::string &rName)
int Count (void) const
void Count (int count)
double MaxValue (void) const
double MinValue (void) const
tpTime::Type MaxTime (void) const
tpTime::Type MinTime (void) const
double Sum (void) const
double SquareSum (void) const
double Average (void) const
double Variance (void) const
double Quantile05 (void) const
double Quantile95 (void) const
void Write (TokenWriter &rTw) const
void Write (void) const
std::string ToString (void) const
void Read (TokenReader &rTr)
void Compile (void) const
std::string Str (void) const

Protected Member Functions

virtual void CompileNonConst (void)

Protected Attributes

std::map< tpTime::Type, EntrymValueMap
std::string mName
int mCount
double mMaxValue
double mMinValue
tpTime::Type mMaxTime
tpTime::Type mMinTime
double mSum
double mSquareSum
double mAverage
double mVariance
double mQuantile05
double mQuantile95

Classes

struct  Entry

Member Typedef Documentation


Constructor & Destructor Documentation

faudes::DiscreteDensityFunction::DiscreteDensityFunction ( void   ) 

virtual faudes::DiscreteDensityFunction::~DiscreteDensityFunction ( void   )  [inline, virtual]


Member Function Documentation

void faudes::DiscreteDensityFunction::Clear ( void   )  [virtual]

Reimplemented in faudes::SampledDensityFunction.

double faudes::DiscreteDensityFunction::Value ( tpTime::Type  time  )  const

const TimeInterval & faudes::DiscreteDensityFunction::TimeInt ( tpTime::Type  time  )  const

CIterator faudes::DiscreteDensityFunction::Begin ( void   )  const [inline]

CIterator faudes::DiscreteDensityFunction::End ( void   )  const [inline]

CIterator faudes::DiscreteDensityFunction::At ( tpTime::Type  time  )  const [inline]

const TimeInterval& faudes::DiscreteDensityFunction::TimeInt ( CIterator  mit  )  const [inline]

const double& faudes::DiscreteDensityFunction::Value ( CIterator  mit  )  const [inline]

Iterator faudes::DiscreteDensityFunction::Begin ( void   )  [inline]

Iterator faudes::DiscreteDensityFunction::End ( void   )  [inline]

Iterator faudes::DiscreteDensityFunction::At ( tpTime::Type  time  )  [inline]

const DiscreteDensityFunction::Entry faudes::DiscreteDensityFunction::EntryAt ( tpTime::Type  time  )  const

const std::string& faudes::DiscreteDensityFunction::Name ( void   )  const [inline]

void faudes::DiscreteDensityFunction::Name ( const std::string &  rName  )  [inline]

int faudes::DiscreteDensityFunction::Count ( void   )  const [inline]

void faudes::DiscreteDensityFunction::Count ( int  count  )  [inline]

double faudes::DiscreteDensityFunction::MaxValue ( void   )  const [inline]

double faudes::DiscreteDensityFunction::MinValue ( void   )  const [inline]

tpTime::Type faudes::DiscreteDensityFunction::MaxTime ( void   )  const [inline]

tpTime::Type faudes::DiscreteDensityFunction::MinTime ( void   )  const [inline]

double faudes::DiscreteDensityFunction::Sum ( void   )  const [inline]

double faudes::DiscreteDensityFunction::SquareSum ( void   )  const [inline]

double faudes::DiscreteDensityFunction::Average ( void   )  const [inline]

double faudes::DiscreteDensityFunction::Variance ( void   )  const [inline]

double faudes::DiscreteDensityFunction::Quantile05 ( void   )  const [inline]

double faudes::DiscreteDensityFunction::Quantile95 ( void   )  const [inline]

void faudes::DiscreteDensityFunction::Write ( TokenWriter rTw  )  const

void faudes::DiscreteDensityFunction::Write ( void   )  const

std::string faudes::DiscreteDensityFunction::ToString ( void   )  const

void faudes::DiscreteDensityFunction::Read ( TokenReader rTr  ) 

void faudes::DiscreteDensityFunction::Compile ( void   )  const

std::string faudes::DiscreteDensityFunction::Str ( void   )  const

void faudes::DiscreteDensityFunction::CompileNonConst ( void   )  [protected, virtual]

Reimplemented in faudes::SampledDensityFunction.


Member Data Documentation

std::string faudes::DiscreteDensityFunction::mName [protected]


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

libFAUDES 2.13a c++ source docu by doxygen 1.5.6