Calculate an average of an array excluding missing code values. More...

Collaboration diagram for commondata::average:

Public Member Functions
pure real(srp) function	average_r (array_in, missing_code, undef_ret_null)
	Calculate an average value of a real array, excluding MISSING values. More...

pure real(srp) function	average_i (array_in, missing_code, undef_ret_null)
	Calculate an average value of an integer array, excluding MISSING values. More...

Detailed Description

Calculate an average of an array excluding missing code values.

Definition at line 5491 of file m_common.f90.

Member Function/Subroutine Documentation

pure real(srp) function commondata::average::average_r	(	real(srp), dimension(:), intent(in)	array_in,
		real(srp), intent(in), optional	missing_code,
		logical, intent(in), optional	undef_ret_null
	)

Calculate an average value of a real array, excluding MISSING values.

Parameters

vector_in	The input data vector
missing_code	Optional parameter setting the missing data code, to be excluded from the calculation of the mean.
undef_ret_null	Optional parameter, if TRUE, the function returns zero rather than undefined if the sample size is zero.

Definition at line 5952 of file m_common.f90.

pure real(srp) function commondata::average::average_i	(	integer, dimension(:), intent(in)	array_in,
		integer, intent(in), optional	missing_code,
		logical, intent(in), optional	undef_ret_null
	)

Calculate an average value of an integer array, excluding MISSING values.

Parameters

vector_in	The input data vector
missing_code	Optional parameter setting the missing data code, to be excluded from the calculation of the mean.
undef_ret_null	Optional parameter, if TRUE, the function returns zero rather than undefined if the sample size is zero.

Definition at line 6022 of file m_common.f90.

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