Skip to content

Commit 0ee5fb1

Browse files
committed
updated api-docs
1 parent 423a8b4 commit 0ee5fb1

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

doc/specs/stdlib_sorting.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,9 @@ Generic subroutine.
235235

236236
`array` : shall be a rank one array of any of the types:
237237
`integer(int8)`, `integer(int16)`, `integer(int32)`, `integer(int64)`,
238-
`real(sp)`, `real(dp)`, `real(qp)`, `character(*)`, or
239-
`type(string_type)`. It is an `intent(inout)` argument. On input it is
238+
`real(sp)`, `real(dp)`, `real(qp)`, `character(*)`, `type(string_type)`,
239+
`type(bitset_64)`, or `type(bitset_large)`.
240+
It is an `intent(inout)` argument. On input it is
240241
the array to be sorted. If both the type of `array` is real and at
241242
least one of the elements is a `NaN`, then the ordering of the result
242243
is undefined. Otherwise on return its elements will be sorted in order
@@ -301,8 +302,9 @@ Pure generic subroutine.
301302

302303
`array` : shall be a rank one array of any of the types:
303304
`integer(int8)`, `integer(int16)`, `integer(int32)`, `integer(int64)`,
304-
`real(sp)`, `real(dp)`, `real(qp)`. `character(*)`, or
305-
`type(string_type)`. It is an `intent(inout)` argument. On return its
305+
`real(sp)`, `real(dp)`, `real(qp)`. `character(*)`, `type(string_type)`,
306+
`type(bitset_64)`, or `type(bitset_large)`.
307+
It is an `intent(inout)` argument. On return its
306308
input elements will be sorted in order of non-decreasing value.
307309

308310

@@ -405,8 +407,9 @@ Generic subroutine.
405407

406408
`array`: shall be a rank one array of any of the types:
407409
`integer(int8)`, `integer(int16)`, `integer(int32)`, `integer(int64)`,
408-
`real(sp)`, `real(dp)`, `real(qp)`, `character(*)`, or
409-
`type(string_type)`. It is an `intent(inout)` argument. On input it
410+
`real(sp)`, `real(dp)`, `real(qp)`, `character(*)`, `type(string_type)`,
411+
`type(bitset_64)`, or `type(bitset_large)`.
412+
It is an `intent(inout)` argument. On input it
410413
will be an array whose sorting indices are to be determined. On return
411414
it will be the sorted array.
412415

src/stdlib_sorting.fypp

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ module stdlib_sorting
170170
!! * array: the rank 1 array to be sorted. It is an `intent(inout)`
171171
!! argument of any of the types `integer(int8)`, `integer(int16)`,
172172
!! `integer(int32)`, `integer(int64)`, `real(real32)`, `real(real64)`,
173-
!! `real(real128)`, `character(*)`, `type(string_type)`. If both the
173+
!! `real(real128)`, `character(*)`, `type(string_type)`,
174+
!! `type(bitset_64)`, `type(bitset_large)`. If both the
174175
!! type of `array` is real and at least one of the elements is a
175176
!! `NaN`, then the ordering of the result is undefined. Otherwise it
176177
!! is defined to be the original elements in non-decreasing order.
@@ -220,7 +221,8 @@ module stdlib_sorting
220221
!! * array: the rank 1 array to be sorted. It is an `intent(inout)`
221222
!! argument of any of the types `integer(int8)`, `integer(int16)`,
222223
!! `integer(int32)`, `integer(int64)`, `real(real32)`, `real(real64)`,
223-
!! `real(real128)`, `character(*)`, `type(string_type)`. If both the type
224+
!! `real(real128)`, `character(*)`, `type(string_type)`,
225+
!! `type(bitset_64)`, `type(bitset_large)`. If both the type
224226
!! of `array` is real and at least one of the elements is a `NaN`, then
225227
!! the ordering of the result is undefined. Otherwise it is defined to be the
226228
!! original elements in non-decreasing order.
@@ -304,7 +306,8 @@ module stdlib_sorting
304306
!! * array: the rank 1 array to be sorted. It is an `intent(inout)`
305307
!! argument of any of the types `integer(int8)`, `integer(int16)`,
306308
!! `integer(int32)`, `integer(int64)`, `real(real32)`, `real(real64)`,
307-
!! `real(real128)`, `character(*)`, `type(string_type)`. If both the
309+
!! `real(real128)`, `character(*)`, `type(string_type)`,
310+
!! `type(bitset_64)`, `type(bitset_large)`. If both the
308311
!! type of `array` is real and at least one of the elements is a `NaN`,
309312
!! then the ordering of the `array` and `index` results is undefined.
310313
!! Otherwise it is defined to be as specified by reverse.

0 commit comments

Comments
 (0)