mbl_stats_1d Class Reference

#include <mbl_stats_1d.h>

List of all members.

---

Detailed Description

Simple statistics on a 1D variable.

   // A rather trivial example
   mbl_stats_1d stats,odd_stats,even_stats,sum_stats;

   const int n = 10;
   for (int i=0;i<n;i++)
   {
     stats.obs(i);
     if (i%2) even_stats.obs(i);
     else     odd_stats.obs(i);
   }

   vcl_cout << stats << "\nStats of odd numbers :\n" << odd_stats;

   sum_stats = odd_stats + even_stats;

   vcl_cout << "Sum of odd and even stats\n" << sum_stats;

Definition at line 37 of file mbl_stats_1d.h.

Public Member Functions
	mbl_stats_1d ()
	Default constructor.
	mbl_stats_1d (const vcl_vector< double > &observations)
	Construct with a set of observations.
void	clear ()
	Remove all data.
void	obs (double v)
	Add given observation.
int	nObs () const
	Number of observations.
double	mean () const
	Mean of current observations.
double	sd () const
	Standard deviation of current observations.
double	stdError () const
	Standard error (sd of estimate of mean) of current observations.
double	variance () const
	Variance of current observations.
double	min () const
	Min of current observations.
double	max () const
	Max of current observations.
double	sum () const
	Sum of current observations.
double	sumSq () const
	Sum of squares of current observations.
double	rms () const
	RMS of current observations;.
mbl_stats_1d &	operator+= (const mbl_stats_1d &s1)
	Add statistics together.
void	print_summary (vcl_ostream &os) const
short	version_no () const
	Version number for I/O.
void	b_write (vsl_b_ostream &bfs) const
void	b_read (vsl_b_istream &bfs)
bool	operator== (const mbl_stats_1d &s) const
	Test for equality.
Private Attributes
double	sum_
double	sum_sq_
double	min_v_
double	max_v_
int	n_obs_
Friends
mbl_stats_1d	operator+ (const mbl_stats_1d &s1, const mbl_stats_1d &s2)

---

Constructor & Destructor Documentation

mbl_stats_1d::mbl_stats_1d

(

)

Default constructor.

Definition at line 11 of file mbl_stats_1d.cxx.

mbl_stats_1d::mbl_stats_1d

(

const vcl_vector< double > &

observations

)

Construct with a set of observations.

Definition at line 16 of file mbl_stats_1d.cxx.

---

Member Function Documentation

void mbl_stats_1d::clear

(

)

Remove all data.

Definition at line 26 of file mbl_stats_1d.cxx.

void mbl_stats_1d::obs

(

double

v

)

Add given observation.

Definition at line 33 of file mbl_stats_1d.cxx.

int mbl_stats_1d::nObs

(

)

const

Number of observations.

Definition at line 52 of file mbl_stats_1d.cxx.

double mbl_stats_1d::mean

(

)

const

Mean of current observations.

Definition at line 57 of file mbl_stats_1d.cxx.

double mbl_stats_1d::sd

(

)

const

Standard deviation of current observations.

Definition at line 72 of file mbl_stats_1d.cxx.

double mbl_stats_1d::stdError

(

)

const

Standard error (sd of estimate of mean) of current observations.

Definition at line 80 of file mbl_stats_1d.cxx.

double mbl_stats_1d::variance

(

)

const

Variance of current observations.

Definition at line 63 of file mbl_stats_1d.cxx.

double mbl_stats_1d::min

(

)

const

Min of current observations.

Definition at line 88 of file mbl_stats_1d.cxx.

double mbl_stats_1d::max

(

)

const

Max of current observations.

Definition at line 94 of file mbl_stats_1d.cxx.

double mbl_stats_1d::sum

(

)

const

Sum of current observations.

Definition at line 100 of file mbl_stats_1d.cxx.

double mbl_stats_1d::sumSq

(

)

const

Sum of squares of current observations.

Definition at line 105 of file mbl_stats_1d.cxx.

double mbl_stats_1d::rms

(

)

const

RMS of current observations;.

Note:

If nobs==0, returns -1.0

Definition at line 110 of file mbl_stats_1d.cxx.

mbl_stats_1d & mbl_stats_1d::operator+=

(

const mbl_stats_1d &

s1

)

Add statistics together.

Definition at line 116 of file mbl_stats_1d.cxx.

void mbl_stats_1d::print_summary

(

vcl_ostream &

os

)

const

Definition at line 181 of file mbl_stats_1d.cxx.

short mbl_stats_1d::version_no

(

)

const

Version number for I/O.

Definition at line 139 of file mbl_stats_1d.cxx.

void mbl_stats_1d::b_write

(

vsl_b_ostream &

bfs

)

const

Definition at line 144 of file mbl_stats_1d.cxx.

void mbl_stats_1d::b_read

(

vsl_b_istream &

bfs

)

Definition at line 153 of file mbl_stats_1d.cxx.

bool mbl_stats_1d::operator==

(

const mbl_stats_1d &

s

)

const

Test for equality.

Definition at line 129 of file mbl_stats_1d.cxx.

---

Friends And Related Function Documentation

mbl_stats_1d operator+	(	const mbl_stats_1d &	s1,
		const mbl_stats_1d &	s2
	)			[friend]

Definition at line 206 of file mbl_stats_1d.cxx.

---

Member Data Documentation

double mbl_stats_1d::sum_ [private]

Definition at line 39 of file mbl_stats_1d.h.

double mbl_stats_1d::sum_sq_ [private]

Definition at line 40 of file mbl_stats_1d.h.

double mbl_stats_1d::min_v_ [private]

Definition at line 41 of file mbl_stats_1d.h.

double mbl_stats_1d::max_v_ [private]

Definition at line 42 of file mbl_stats_1d.h.

int mbl_stats_1d::n_obs_ [private]

Definition at line 43 of file mbl_stats_1d.h.

---

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

• contrib/mul/mbl/mbl_stats_1d.h
• contrib/mul/mbl/mbl_stats_1d.cxx

---