gsl::movstat Namespace Reference

This namespace handles the GSL moving-window statistics. More...

Namespaces
namespace	accum
	namespace for the accumulators.

Classes
class	function
	Class that extends gsl_movstat_function so that it can be constructed from arbitrary function objects. More...
class	workspace
	Workspace for moving window statistics. More...

Typedefs
typedef gsl_movstat_end_t	end_t
	Convenient typedef. More...

Enumerations
enum	{ PADZERO = GSL_MOVSTAT_END_PADZERO , PADVALUE = GSL_MOVSTAT_END_PADVALUE , TRUNCATE = GSL_MOVSTAT_END_TRUNCATE }

Functions
int	apply (movstat::end_t const endtype, movstat::function const &F, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_apply(). More...
size_t	fill (movstat::end_t const endtype, vector const &x, size_t const idx, size_t const H, size_t const J, gsl::vector &window)
	C++ version of gsl_movstat_fill(). More...
int	mean (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_mean(). More...
int	variance (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_variance(). More...
int	sd (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_sd(). More...
int	median (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_median(). More...
int	min (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_min(). More...
int	max (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_max(). More...
int	minmax (movstat::end_t const endtype, vector const &x, vector &y_min, vector &y_max, workspace &w)
	C++ version of gsl_movstat_minmax(). More...
int	mad0 (movstat::end_t const endtype, vector const &x, vector &xmedian, vector &xmad, workspace &w)
	C++ version of gsl_movstat_mad0(). More...
int	mad (movstat::end_t const endtype, vector const &x, vector &xmedian, vector &xmad, workspace &w)
	C++ version of gsl_movstat_mad(). More...
int	qqr (movstat::end_t const endtype, vector const &x, double const q, vector &xqqr, workspace &w)
	C++ version of gsl_movstat_qqr(). More...
int	Sn (movstat::end_t const endtype, vector const &x, vector &xscale, workspace &w)
	C++ version of gsl_movstat_Sn(). More...
int	Qn (movstat::end_t const endtype, vector const &x, vector &xscale, workspace &w)
	C++ version of gsl_movstat_Qn(). More...
int	sum (movstat::end_t const endtype, vector const &x, vector &y, workspace &w)
	C++ version of gsl_movstat_sum(). More...
template<typename T >
function	make_function (T &c, double(T::*f)(gsl::vector const &))
	Make a gsl::movstat::function from a function object and a suitable member function. More...

Detailed Description

This namespace handles the GSL moving-window statistics.

Typedef Documentation

end_t

typedef gsl_movstat_end_t gsl::movstat::end_t

Convenient typedef.

Definition at line 36 of file movstat.hpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
PADZERO	Defined for handling end points.
PADVALUE	Defined for handling end points.
TRUNCATE	Defined for handling end points.

Definition at line 440 of file movstat.hpp.

Function Documentation

apply()

int gsl::movstat::apply ( movstat::end_t const  endtype, movstat::function const &  F, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_apply().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
F	A function
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 493 of file movstat.hpp.

References gsl::sf::ellint::F(), gsl::vector::get(), and gsl::movstat::workspace::get().

fill()

size_t gsl::movstat::fill ( movstat::end_t const  endtype, vector const &  x, size_t const  idx, size_t const  H, size_t const  J, gsl::vector &  window  )

inline

C++ version of gsl_movstat_fill().

This could be used to create a user-defined statistic.

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
idx	index of centre
H	Samples before current
J	Samples after current
window	The window [return]

Returns

size of window

Definition at line 524 of file movstat.hpp.

References gsl::vector::get(), gsl::exception::GSL_EBADLEN, and gsl::vector::size().

mad()

int gsl::movstat::mad ( movstat::end_t const  endtype, vector const &  x, vector &  xmedian, vector &  xmad, workspace &  w  )

inline

C++ version of gsl_movstat_mad().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
xmedian	input vector
xmad	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 628 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

mad0()

int gsl::movstat::mad0 ( movstat::end_t const  endtype, vector const &  x, vector &  xmedian, vector &  xmad, workspace &  w  )

inline

C++ version of gsl_movstat_mad0().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
xmedian	input vector
xmad	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 616 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

make_function()

template<typename T >

function gsl::movstat::make_function ( T &  c, double(T::*)(gsl::vector const &)  f  )

inline

Make a gsl::movstat::function from a function object and a suitable member function.

Parameters

c	The function object.
f	The member function.

Definition at line 4268 of file movstat_function.hpp.

max()

int gsl::movstat::max ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_max().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 592 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

Referenced by gsl::fft::halfcomplex::unpack(), gsl::fft::halfcomplex_float::unpack(), gsl::fft::real::unpack(), and gsl::fft::real_float::unpack().

mean()

int gsl::movstat::mean ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_mean().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 537 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

median()

int gsl::movstat::median ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_median().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 570 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

min()

int gsl::movstat::min ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_min().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 581 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

Referenced by gsl::block::operator<(), gsl::block_char::operator<(), gsl::block_complex::operator<(), gsl::block_complex_float::operator<(), gsl::block_complex_long_double::operator<(), gsl::block_float::operator<(), gsl::block_int::operator<(), gsl::block_long::operator<(), gsl::block_long_double::operator<(), gsl::block_short::operator<(), gsl::block_uchar::operator<(), gsl::block_uint::operator<(), gsl::block_ulong::operator<(), gsl::block_ushort::operator<(), gsl::vector_char::operator<(), gsl::vector_complex::operator<(), gsl::vector_complex_float::operator<(), gsl::vector_complex_long_double::operator<(), gsl::vector_int::operator<(), gsl::vector_long::operator<(), gsl::vector_long_double::operator<(), gsl::vector_short::operator<(), gsl::vector_uchar::operator<(), gsl::vector_uint::operator<(), gsl::vector_ulong::operator<(), gsl::vector_ushort::operator<(), gsl::block::operator>(), gsl::block_char::operator>(), gsl::block_complex::operator>(), gsl::block_complex_float::operator>(), gsl::block_complex_long_double::operator>(), gsl::block_float::operator>(), gsl::block_int::operator>(), gsl::block_long::operator>(), gsl::block_long_double::operator>(), gsl::block_short::operator>(), gsl::block_uchar::operator>(), gsl::block_uint::operator>(), gsl::block_ulong::operator>(), gsl::block_ushort::operator>(), gsl::vector_char::operator>(), gsl::vector_complex::operator>(), gsl::vector_complex_float::operator>(), gsl::vector_complex_long_double::operator>(), gsl::vector_int::operator>(), gsl::vector_long::operator>(), gsl::vector_long_double::operator>(), gsl::vector_short::operator>(), gsl::vector_uchar::operator>(), gsl::vector_uint::operator>(), gsl::vector_ulong::operator>(), and gsl::vector_ushort::operator>().

minmax()

int gsl::movstat::minmax ( movstat::end_t const  endtype, vector const &  x, vector &  y_min, vector &  y_max, workspace &  w  )

inline

C++ version of gsl_movstat_minmax().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y_min	output vector for minimum
y_max	output vector for maximum
w	A movstat::workspace

Returns

Error code on failures

Definition at line 604 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

Qn()

int gsl::movstat::Qn ( movstat::end_t const  endtype, vector const &  x, vector &  xscale, workspace &  w  )

inline

C++ version of gsl_movstat_Qn().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
xscale	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 662 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

qqr()

int gsl::movstat::qqr ( movstat::end_t const  endtype, vector const &  x, double const  q, vector &  xqqr, workspace &  w  )

inline

C++ version of gsl_movstat_qqr().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
q	quantile parameter in (0,0.5]
xqqr	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 640 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

sd()

int gsl::movstat::sd ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_sd().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 559 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

Sn()

int gsl::movstat::Sn ( movstat::end_t const  endtype, vector const &  x, vector &  xscale, workspace &  w  )

inline

C++ version of gsl_movstat_Sn().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
xscale	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 651 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

sum()

int gsl::movstat::sum ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_sum().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 673 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().

variance()

int gsl::movstat::variance ( movstat::end_t const  endtype, vector const &  x, vector &  y, workspace &  w  )

inline

C++ version of gsl_movstat_variance().

Parameters

endtype	PADZERO, PADVALUE or TRUNCATE
x	input vector
y	output vector
w	A movstat::workspace

Returns

Error code on failures

Definition at line 548 of file movstat.hpp.

References gsl::vector::get(), and gsl::movstat::workspace::get().