Addition of corrected in API of var (following #149) #151
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is following the discussion in #149 .
New syntax
result = var(array [, mask[, corrected]])
result = var(array, dim [,mask[, corrected]])
corrected
is as last argument becausemask
is not alwaysoptional
in the implementation (whilecorrected
is alwaysoptional
).corrected
is used as follows, e.g.:When
mask
is an array, the additional condition.and. n > 0._dp
is needed to ensure that the result isNaN
when all elements are.false.
andcorrected == .true.
, as specified in the spec.If
corrected == .true.
andn==0
, then we got something likeres = res / -1
, which may lead to a result equal to0
, e.g., in the following case if the additional condition is not added:Tests have been adapted to consider this scenario.
I also added some tests for
corrected==.false.
. However, it is now only forreal(sp)
. I can add more tests later in this PR when we will agree on its implementation.