UtilBlockedRunningAverageVector Class Reference
[Util]

Maintain a blocked running average of a vector value. More...

#include <UtilBlockedRunningAverageVector.h>

Inheritance diagram for UtilBlockedRunningAverageVector:

List of all members.

Public Member Functions
	UtilBlockedRunningAverageVector (int vector_size, int target_sample_size=10)
virtual	~UtilBlockedRunningAverageVector ()
void	SetSampleSize (int size)
int	Add (const std::vector< double > &val)
int	Add (const std::vector< double > &mean, const std::vector< double > &sigma, int nsamples)
std::vector< double >	LastSample () const
virtual void	Clear (bool clear_population=true)
Private Attributes
std::deque< std::vector< double > >	fMeans
std::deque< std::vector< double > >	fSigmas
std::deque< size_t >	fNsamples

---

Detailed Description

Maintain a blocked running average of a vector value.

This class is like a vectorized version of UtilRunningAverage. See that classes docs for an overview.

Author:

(last to touch it)

Author

bv

Version:

Revision

1.2

Date:

Date

2005/04/15 14:19:15

Contact: bv@bnl.gov

Created on: Fri Apr 15 10:13:39 2005

Id

UtilBlockedRunningAverageVector.h,v 1.2 2005/04/15 14:19:15 bv Exp

Definition at line 33 of file UtilBlockedRunningAverageVector.h.

---

Constructor & Destructor Documentation

UtilBlockedRunningAverageVector::UtilBlockedRunningAverageVector (  int  vector_size, int  target_sample_size = 10 )

Definition at line 5 of file UtilBlockedRunningAverageVector.cxx. : UtilRunningAverageVector(vector_size,target_sample_size) { }

virtual UtilBlockedRunningAverageVector::~UtilBlockedRunningAverageVector (   )  [inline, virtual]

Definition at line 36 of file UtilBlockedRunningAverageVector.h. {}

---

Member Function Documentation

int UtilBlockedRunningAverageVector::Add (  const std::vector< double > &  mean, const std::vector< double > &  sigma, int  nsamples )

Add a new block of samples. Return the size of the sample set after this addition. Note, this size be be smaller than before the addition if a larger block is pushed out of the set. However, once the sample size is larger than the target, it will never be allowed to go smaller than the target. Definition at line 47 of file UtilBlockedRunningAverageVector.cxx. References fMeans, fNsamples, fSigmas, and SetSampleSize(). { fNsamples.push_front(nsamples); fMeans.push_front(mean); fSigmas.push_front(sigma); size_t vsiz = fSx.size(); for (size_t ind=0; ind<vsiz; ++ind) { double x = nsamples*mean[ind]; double xx = sigma[ind]*sigma[ind]*(nsamples-1) + nsamples*mean[ind]*mean[ind]; fSx[ind] += x; fSxx[ind] += xx; fPx[ind] += x; fPxx[ind] += xx; } fPn += nsamples; fSn += nsamples; this->SetSampleSize(fSampleTargetSize); // remove any blocks if total sample is full return fSn; }

int UtilBlockedRunningAverageVector::Add (  const std::vector< double > &  val  )  [virtual]

Add a new single (not blocked!) value to the sample and population. Returns the size of the sample set after this addition. Reimplemented from UtilRunningAverageVector. Definition at line 43 of file UtilBlockedRunningAverageVector.cxx. Referenced by BDSwicPedAccessor::SetSpillTime(). { return this->Add(val,vector<double>(val.size(),0),1); }

void UtilBlockedRunningAverageVector::Clear (  bool  clear_population = true  )  [virtual]

Clear all samples. If clear_population is false, only the sample set is cleared. Reimplemented from UtilRunningAverageVector. Definition at line 80 of file UtilBlockedRunningAverageVector.cxx. References UtilRunningAverageVector::Clear(), fMeans, fNsamples, and fSigmas. Referenced by BDSwicPedAccessor::SetSpillTime(). { this->UtilRunningAverageVector::Clear(clear_population); fMeans.clear(); fSigmas.clear(); fNsamples.clear(); }

vector< double > UtilBlockedRunningAverageVector::LastSample (   )  const [virtual]

Return the last sample, ie, the last mean added. Returns 0.0 if samples are empty. Reimplemented from UtilRunningAverageVector. Definition at line 74 of file UtilBlockedRunningAverageVector.cxx. References fMeans. { if (!fMeans.size()) return vector<double>(); return fMeans.back(); }

void UtilBlockedRunningAverageVector::SetSampleSize (  int  size  )  [virtual]

Set the target sample size. The actual sample size may be temporarily smaller than this. Once full, the actual sample size will never go below this but in general will fluctuate higher as more blocks of samples are added or removed. Reimplemented from UtilRunningAverageVector. Definition at line 9 of file UtilBlockedRunningAverageVector.cxx. References fMeans, fNsamples, and fSigmas. Referenced by Add(). { fSampleTargetSize = size; // target size size_t vsiz = fSx.size(); size_t current_size = fNsamples.size(); if (!current_size) return; size_t nlost = fNsamples.back(); while (fSn - nlost >= fSampleTargetSize) { vector<double> lost_mean = fMeans.back(); vector<double> lost_sigma = fSigmas.back(); for (size_t ind=0; ind<vsiz; ++ind) { double x = nlost*lost_mean[ind]; double xx = lost_sigma[ind]*lost_sigma[ind]*(nlost-1) + nlost*lost_mean[ind]*lost_mean[ind]; fSn -= nlost; fSx[ind] -= x; fSxx[ind] -= xx; } fNsamples.pop_back(); fMeans.pop_back(); fSigmas.pop_back(); if (!fNsamples.size()) break; nlost = fNsamples.back(); } }

---

Member Data Documentation

std::deque<std::vector<double> > UtilBlockedRunningAverageVector::fMeans [private]

Definition at line 66 of file UtilBlockedRunningAverageVector.h. Referenced by Add(), Clear(), LastSample(), and SetSampleSize().

std::deque<size_t> UtilBlockedRunningAverageVector::fNsamples [private]

Definition at line 67 of file UtilBlockedRunningAverageVector.h. Referenced by Add(), Clear(), and SetSampleSize().

std::deque<std::vector<double> > UtilBlockedRunningAverageVector::fSigmas [private]

Definition at line 66 of file UtilBlockedRunningAverageVector.h. Referenced by Add(), Clear(), and SetSampleSize().

---

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

• UtilBlockedRunningAverageVector.h
• UtilBlockedRunningAverageVector.cxx

---