Calculator Class Reference

Calculator is designed for vector arithmetics, including linear and circular variables like wind directions. For circular variables, input and output are both in degrees. The conversion between degrees and radiance is carried out internally. More...

#include <Calculator.h>

Public Member Functions
	Calculator ()
	Calculator (bool)
	Calculator (bool, std::size_t)
	Calculator (const Calculator &orig)
virtual	~Calculator ()
void	setCircular (bool)
bool	isCircular () const
void	reserve (std::size_t)
void	pushValue (double)
void	clearValues ()
void	reset ()
double	mean ()
double	variance ()
double	sd ()

Static Public Attributes
static const double	_DEG2RAD = M_PI / 180
static const double	_RAD2DEG = 180 / M_PI

Protected Member Functions
double	estimatorYamartino_ ()

Protected Attributes
bool	circular_
double	mean_sin_
double	mean_cos_
double	mean_linear_
double	S_
std::vector< double >	values_

Detailed Description

Calculator is designed for vector arithmetics, including linear and circular variables like wind directions. For circular variables, input and output are both in degrees. The conversion between degrees and radiance is carried out internally.

Constructor & Destructor Documentation

Calculator() [1/4]

Calculator::Calculator

(

)

Calculator() [2/4]

Calculator::Calculator

(

bool

circular

)

Calculator() [3/4]

Calculator::Calculator	(	bool	,
		std::size_t
	)

Calculator() [4/4]

Calculator::Calculator

(

const Calculator &

orig

)

~Calculator()

Calculator::~Calculator ( )

virtual

Member Function Documentation

clearValues()

void Calculator::clearValues

(

)

Clear all values in the calculator.

estimatorYamartino_()

double Calculator::estimatorYamartino_ ( )

protected

isCircular()

bool Calculator::isCircular

(

)

const

mean()

double Calculator::mean

(

)

Get the running average of all pushed values.

Returns

An average

pushValue()

void Calculator::pushValue

(

double

value

)

Add a value into the calculation queue

Parameters

A	double value

reserve()

void Calculator::reserve

(

std::size_t

)

Reserve space inside the calculator. This will make adding numbers to the calculator sequence in constant time.

Parameters

The	size of the space to be reserved

reset()

void Calculator::reset

(

)

Clear all values and reset the circular status.

sd()

double Calculator::sd

(

)

Get the running standard deviation of all pushed values

Returns

A standard deviation

setCircular()

void Calculator::setCircular

(

bool

circular

)

Change the circular status of the variable we are calculating.

Parameters

A

boolean.

variance()

double Calculator::variance

(

)

Get the running variance of all pushed values.

Returns

A variance

Member Data Documentation

_DEG2RAD

const double Calculator::_DEG2RAD = M_PI / 180

static

_RAD2DEG

const double Calculator::_RAD2DEG = 180 / M_PI

static

circular_

bool Calculator::circular_

protected

mean_cos_

double Calculator::mean_cos_

protected

mean_linear_

double Calculator::mean_linear_

protected

mean_sin_

double Calculator::mean_sin_

protected

S_

double Calculator::S_

protected

values_

std::vector<double> Calculator::values_

protected

---

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

• /Users/weiming/github/AnalogsEnsemble/CAnEn/include/Calculator.h
• /Users/weiming/github/AnalogsEnsemble/CAnEn/src/Calculator.cpp