mo_errormeasures::bias Interface Reference

Calculates bias. More...

Public Member Functions
real(sp) function	bias_sp_1d (x, y, mask)
real(dp) function	bias_dp_1d (x, y, mask)
real(sp) function	bias_sp_2d (x, y, mask)
real(dp) function	bias_dp_2d (x, y, mask)
real(sp) function	bias_sp_3d (x, y, mask)
real(dp) function	bias_dp_3d (x, y, mask)

Detailed Description

Calculates bias.

Calculates the bias

\[BIAS = \bar y - \bar x\]

Where \( \bar y \) and \( \bar x \) are means of the data points.

If an optinal mask is given, the calculations are over those locations that correspond to true values in the mask. \( x\) and \( y\) can be single or double precision. The result will have the same numerical precision.

Example

vec1 = (/ 1., 2, 3., -999., 5., 6. /)
vec2 = (/ 1., 2, 3., -999., 5., 6. /)
m   = bias(vec1, vec2, mask=(vec >= 0.))
--> m = 0.0

See also example in test directory.

Parameters

[in]	real(sp/dp), dimension() :: x, y	1D/2D/3D-array with input numbers.
[in]	logical, optional :: mask	1D/2D/Array-array of logical values with size(x/y). If present, only those locations in vec corresponding to the true values in mask are used.

Returns

"real(sp/dp) :: BIAS" Bias.

Note

Input values must be floating points.

Authors

Matthias Zink

Date

Sept 2012

Definition at line 68 of file mo_errormeasures.f90.

Member Function/Subroutine Documentation

bias_dp_1d()

real(dp) function mo_errormeasures::bias::bias_dp_1d	(	real(dp), dimension(:), intent(in)	x,
		real(dp), dimension(:), intent(in)	y,
		logical, dimension(:), intent(in), optional	mask
	)

Definition at line 572 of file mo_errormeasures.f90.

bias_dp_2d()

real(dp) function mo_errormeasures::bias::bias_dp_2d	(	real(dp), dimension(:, :), intent(in)	x,
		real(dp), dimension(:, :), intent(in)	y,
		logical, dimension(:, :), intent(in), optional	mask
	)

Definition at line 649 of file mo_errormeasures.f90.

bias_dp_3d()

real(dp) function mo_errormeasures::bias::bias_dp_3d	(	real(dp), dimension(:, :, :), intent(in)	x,
		real(dp), dimension(:, :, :), intent(in)	y,
		logical, dimension(:, :, :), intent(in), optional	mask
	)

Definition at line 731 of file mo_errormeasures.f90.

bias_sp_1d()

real(sp) function mo_errormeasures::bias::bias_sp_1d	(	real(sp), dimension(:), intent(in)	x,
		real(sp), dimension(:), intent(in)	y,
		logical, dimension(:), intent(in), optional	mask
	)

Definition at line 535 of file mo_errormeasures.f90.

bias_sp_2d()

real(sp) function mo_errormeasures::bias::bias_sp_2d	(	real(sp), dimension(:, :), intent(in)	x,
		real(sp), dimension(:, :), intent(in)	y,
		logical, dimension(:, :), intent(in), optional	mask
	)

Definition at line 608 of file mo_errormeasures.f90.

bias_sp_3d()

real(sp) function mo_errormeasures::bias::bias_sp_3d	(	real(sp), dimension(:, :, :), intent(in)	x,
		real(sp), dimension(:, :, :), intent(in)	y,
		logical, dimension(:, :, :), intent(in), optional	mask
	)

Definition at line 689 of file mo_errormeasures.f90.

---

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

• src/mo_errormeasures.f90