|
3 | 3 |
|
4 | 4 | !! Licensing:
|
5 | 5 | !!
|
6 |
| -!! This file is subjec† both to the Fortran Standard Library license, and |
| 6 | +!! This file is subject both to the Fortran Standard Library license, and |
7 | 7 | !! to additional licensing requirements as it contains translations of
|
8 | 8 | !! other software.
|
9 | 9 | !!
|
|
65 | 65 | module stdlib_sorting
|
66 | 66 | !! This module implements overloaded sorting subroutines named `ORD_SORT`,
|
67 | 67 | !! `SORT_INDEX`, and `SORT`, that each can be used to sort four kinds
|
68 |
| -!! of `INTEGER` arrays and three kinds of `REAL` arrays. By default, sorting |
69 |
| -!! is in order of increasing value, though `SORT_INDEX` has the option of |
| 68 | +!! of `INTEGER` arrays and three kinds of `REAL` arrays. |
| 69 | +!! ([Specification](../page/specs/stdlib_sorting.html)) |
| 70 | +!! |
| 71 | +!!By default, sorting |
| 72 | +!! is in order of increasing value, though all subroutines have the option of |
70 | 73 | !! sorting in order of decresasing value. All the subroutines have worst
|
71 | 74 | !! case run time performance of `O(N Ln(N))`, but on largely sorted data
|
72 | 75 | !! `ORD_SORT` and `SORT_INDEX` can have a run time performance of `O(N)`.
|
@@ -140,7 +143,10 @@ module stdlib_sorting
|
140 | 143 | !!
|
141 | 144 | !! The generic subroutine implementing the `ORD_SORT` algorithm to return
|
142 | 145 | !! an input array with its elements sorted in order of (non-)decreasing
|
143 |
| -!! value. Its use has the syntax: |
| 146 | +!! value. |
| 147 | +!! ([Specification](../page/specs/stdlib_sorting.html#ord_sort-sorts-an-input-array)) |
| 148 | +!! |
| 149 | +!! Its use has the syntax: |
144 | 150 | !!
|
145 | 151 | !! call ord_sort( array[, work, reverse] )
|
146 | 152 | !!
|
@@ -190,7 +196,10 @@ module stdlib_sorting
|
190 | 196 | !!
|
191 | 197 | !! The generic subroutine implementing the `SORT` algorithm to return
|
192 | 198 | !! an input array with its elements sorted in order of (non-)decreasing
|
193 |
| -!! value. Its use has the syntax: |
| 199 | +!! value. |
| 200 | +!! ([Specification](../page/specs/stdlib_sorting.html#sort-sorts-an-input-array)) |
| 201 | +!! |
| 202 | +!!Its use has the syntax: |
194 | 203 | !!
|
195 | 204 | !! call sort( array[, reverse] )
|
196 | 205 | !!
|
@@ -229,6 +238,8 @@ module stdlib_sorting
|
229 | 238 | !! return an index array whose elements would sort the input array in the
|
230 | 239 | !! desired direction. It is primarily intended to be used to sort a
|
231 | 240 | !! derived type array based on the values of a component of the array.
|
| 241 | +!! ([Specification](../page/specs/stdlib_sorting.html#sort_index-creates-an-array-of-sorting-indices-for-an-input-array-while-also-sorting-the-array) |
| 242 | +!! |
232 | 243 | !! Its use has the syntax:
|
233 | 244 | !!
|
234 | 245 | !! call sort_index( array, index[, work, iwork, reverse ] )
|
|
0 commit comments