Skip to content

Commit 3e49820

Browse files
authored
Merge pull request #586 from jvdp1/intent_stdlib_stats_specs
Update of stdlib_stats.md with intents.
2 parents 22c1be0 + f177455 commit 3e49820

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

doc/specs/stdlib_stats.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Generic subroutine
3232

3333
### Arguments
3434

35-
`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`.
35+
`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
3636

37-
`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`.
37+
`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.
3838

39-
`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
39+
`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.
4040

4141
### Return value
4242

@@ -93,13 +93,13 @@ Generic subroutine
9393

9494
### Arguments
9595

96-
`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`.
96+
`array`: Shall be a rank-1 or a rank-2 array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
9797

98-
`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`.
98+
`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.
9999

100-
`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
100+
`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.
101101

102-
`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`.
102+
`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.
103103

104104
### Return value
105105

@@ -148,11 +148,11 @@ Generic subroutine
148148

149149
### Arguments
150150

151-
`array`: Shall be an array of type `integer`, `real`, or `complex`.
151+
`array`: Shall be an array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
152152

153-
`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`.
153+
`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.
154154

155-
`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
155+
`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.
156156

157157
### Return value
158158

@@ -220,11 +220,11 @@ Generic subroutine
220220

221221
### Arguments
222222

223-
`array`: Shall be an array of type `integer` or `real`.
223+
`array`: Shall be an array of type `integer` or `real`. It is an `intent(in)` argument.
224224

225-
`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`.
225+
`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.
226226

227-
`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
227+
`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.
228228

229229
### Return value
230230

@@ -360,13 +360,13 @@ Generic subroutine
360360

361361
### Arguments
362362

363-
`array`: Shall be an array of type `integer`, `real`, or `complex`.
363+
`array`: Shall be an array of type `integer`, `real`, or `complex`. It is an `intent(in)` argument.
364364

365-
`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`.
365+
`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.
366366

367-
`mask` (optional): Shall be of type `logical` and either a scalar or an array of the same shape as `array`.
367+
`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.
368368

369-
`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`.
369+
`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.
370370

371371
### Return value
372372

0 commit comments

Comments
 (0)