From f17745535dbd89c328de4b57f6d52b54f582574a Mon Sep 17 00:00:00 2001 From: Jeremie Vandenplas Date: Thu, 2 Dec 2021 07:45:42 +0100 Subject: [PATCH] add the intent status to all arguments in stdlib_stats.md --- doc/specs/stdlib_stats.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/specs/stdlib_stats.md b/doc/specs/stdlib_stats.md index b8a4f7f78..d13746c01 100644 --- a/doc/specs/stdlib_stats.md +++ b/doc/specs/stdlib_stats.md @@ -32,11 +32,11 @@ Generic subroutine ### Arguments -`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. +`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument. -`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. +`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument. -`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. +`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument. ### Return value @@ -93,13 +93,13 @@ Generic subroutine ### Arguments -`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. +`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument. -`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. +`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument. -`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. +`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument. -`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`. +`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`. It is an `intent(in)` argument. ### Return value @@ -148,11 +148,11 @@ Generic subroutine ### Arguments -`array`: Shall be an array of type `integer`, `real`, or `complex`. +`array`: Shall be an array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument. -`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. +`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument. -`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. +`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument. ### Return value @@ -220,11 +220,11 @@ Generic subroutine ### Arguments -`array`: Shall be an array of type `integer` or `real`. +`array`: Shall be an array of type `integer` or `real`. It is an `intent(in)` argument. -`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. +`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument. -`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. +`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument. ### Return value @@ -360,13 +360,13 @@ Generic subroutine ### Arguments -`array`: Shall be an array of type `integer`, `real`, or `complex`. +`array`: Shall be an array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument. -`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. +`dim`: Shall be a scalar of type `integer` with a value in the range from 1 to `n`, where `n` is the rank of `array`. It is an `intent(in)` argument. -`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. +`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`. It is an `intent(in)` argument. -`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`. +`corrected` (optional): Shall be a scalar of type `logical`. If `corrected` is `.true.` (default value), the sum is scaled with `n-1`. If `corrected` is `.false.`, then the sum is scaled with `n`. It is an `intent(in)` argument. ### Return value