mo_moment::central_moment_var Interface Reference

R-central moment variance. More...

Public Member Functions
real(sp) function	central_moment_var_sp (x, r, mask)
real(dp) function	central_moment_var_dp (x, r, mask)

Detailed Description

R-central moment variance.

Calculates the sampling variance of the central moment of a vector. central_moment_var is something like the "error variance" of the r-th order central moment sampling statistic.
If an optinal mask is given, the average is only over those locations that correspond to true values in the mask. \(x\) can be single or double precision. The result will have the same numerical precision.
Example

vec = (/ 1., 2, 3., -999., 5., 6. /)
m   = central_moment(vec, 2, mask=(vec >= 0.))
em  = central_moment_var(vec, 2, mask=(vec >= 0.))

See also example in pf_tests directory.

Literature

1. LH Benedict & RD Gould, Towards better uncertainty estimates for turbulence statistics, Experiments in Fluids 22, 129-136, 1996

Parameters

[in]	real(sp/dp) :: dat(:)	1D-array with input numbers.
[in]	integer(i4) :: r	Order of the central moment, i.e. r=2 is variance.
[in]	logical, optional :: mask(:)	1D-array of logical values with size(dat). If present, only those locations in dat corresponding to the true values in mask are used.

Return values

real(sp/dp) :: central_moment_var

Sampling variance of r-th central moment of elements in dat

Note

Input values must be floating points.

Author

Matthias Cuntz

Date

Nov 2011

Definition at line 200 of file mo_moment.f90.

Member Function/Subroutine Documentation

central_moment_var_dp()

real(dp) function mo_moment::central_moment_var::central_moment_var_dp	(	real(dp), dimension(:), intent(in)	x,
		integer(i4), intent(in)	r,
		logical, dimension(:), intent(in), optional	mask
	)

Definition at line 813 of file mo_moment.f90.

central_moment_var_sp()

real(sp) function mo_moment::central_moment_var::central_moment_var_sp	(	real(sp), dimension(:), intent(in)	x,
		integer(i4), intent(in)	r,
		logical, dimension(:), intent(in), optional	mask
	)

Definition at line 851 of file mo_moment.f90.

---

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

• src/mo_moment.f90