BIE::SampleDistribution Class Reference

Abstract: estimate distribution from accumulated data. More...

#include <Distribution.h>

Inheritance diagram for BIE::SampleDistribution:
Collaboration diagram for BIE::SampleDistribution:

List of all members.

Public Member Functions

virtual ~SampleDistribution ()
 Force runtime binding of inherited destructor.
virtual double CDF (vector< double > &)
 Cumulative distribution function P(>x).
virtual SampleDistributionNew ()
 Clone (factory) function.
virtual bool AccumData (double value, vector< double > &state)
 Accumlulate data: Value or state may be dummy in some applications.
virtual bool AccumData (double v, RecordBuffer *datapoint)
 Accumlulate data from a data point held in a record buffer and increment data set size.
virtual void ComputeDistribution ()
 Compute distribution estimate as needed.
virtual RecordTypegetRecordType ()
 Returns the record type describing the fields used by a distribution.
virtual int getDataSetSize ()
 Returns the total number of data points used in distribution.
Iterators
Need this for iterating through data list.

Can be either bins, points, coefficients, etc.

virtual int numberData ()
 Number of datums.
virtual double getValue (int i)
 Value for the ith component.
virtual int getdim (int i)
 Dimension for the ith component.

Protected Member Functions

 SampleDistribution ()
 Constructor - should only be used by subclasses during their creation, and not by other classes.
virtual bool AccumulateData (double v, RecordBuffer *datapoint)
 This is implemented in subclasses.

Protected Attributes

int datasetsize
 The number of data points used whilst building the binned distribution.
RecordTyperecordtype
 The type describing the data stored in the distribution.

Friends

class boost::serialization::access


Detailed Description

Abstract: estimate distribution from accumulated data.

Constructor & Destructor Documentation

BIE::SampleDistribution::SampleDistribution (  )  [inline, protected]

Constructor - should only be used by subclasses during their creation, and not by other classes.


Member Function Documentation

virtual double BIE::SampleDistribution::CDF ( vector< double > &   )  [inline, virtual]

Cumulative distribution function P(>x).

Throws exception if not appropriate.

Reimplemented in BIE::BinnedDistribution, BIE::PointDistribution, BIE::Histogram1D, and BIE::HistogramNDCache.

virtual bool BIE::SampleDistribution::AccumData ( double  value,
vector< double > &  state 
) [inline, virtual]

Accumlulate data: Value or state may be dummy in some applications.

returns true if data is used in distribution

Reimplemented in BIE::SimpleStat.


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

Send suggestions, questions, and feedback to WEINBERG at ASTRO dot UMASS dot EDU.
Documentation generated at Fri Mar 26 00:35:12 2010 by doxygen