Skip to content

Uupdate of the comments in source code #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2021
Merged

Uupdate of the comments in source code #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de03c1d
update of the comments in source code
jvdp1 May 31, 2021
720a0cd
fixed typo
jvdp1 May 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/specs/stdlib_sorting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ decreasing, value.

##### Syntax

`call [[stdlib_sorting(module):sort(subroutine)]]sort ( array, reverse )`
`call [[stdlib_sorting(module):sort(subroutine)]]sort ( array[, reverse] )`

##### Class

Expand Down
31 changes: 22 additions & 9 deletions src/stdlib_sorting.fypp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,10 @@ module stdlib_sorting
!! Version: experimental
!!
!! The generic subroutine implementing the `ORD_SORT` algorithm to return
!! an input array with its elements sorted in order of non-decreasing
!! an input array with its elements sorted in order of (non-)decreasing
!! value. Its use has the syntax:
!!
!! call ord_sort( array[, work] )
!! call ord_sort( array[, work, reverse] )
!!
!! with the arguments:
!!
Expand All @@ -161,6 +161,12 @@ module stdlib_sorting
!! storage, its use can significantly reduce the stack memory requirements
!! for the code. Its value on return is undefined.
!!
!! * `reverse` (optional): shall be a scalar of type default logical. It
!! is an `intent(in)` argument. If present with a value of `.true.` then
!! `array` will be sorted in order of non-increasing values in stable
!! order. Otherwise index will sort `array` in order of non-decreasing
!! values in stable order.
!!
!!#### Example
!!
!!```fortran
Expand All @@ -183,10 +189,10 @@ module stdlib_sorting
!! Version: experimental
!!
!! The generic subroutine implementing the `SORT` algorithm to return
!! an input array with its elements sorted in order of non-decreasing
!! an input array with its elements sorted in order of (non-)decreasing
!! value. Its use has the syntax:
!!
!! call sort( array )
!! call sort( array[, reverse] )
!!
!! with the arguments:
!!
Expand All @@ -197,6 +203,11 @@ module stdlib_sorting
!! real and at least one of the elements is a `NaN`, then the ordering
!! of the result is undefined. Otherwise it is defined to be the
!! original elements in non-decreasing order.
!! * `reverse` (optional): shall be a scalar of type default logical. It
!! is an `intent(in)` argument. If present with a value of `.true.` then
!! `array` will be sorted in order of non-increasing values in unstable
!! order. Otherwise index will sort `array` in order of non-decreasing
!! values in unstable order.
!!
!!#### Example
!!
Expand Down Expand Up @@ -351,7 +362,7 @@ module stdlib_sorting
module subroutine char_ord_sort( array, work, reverse )
!! Version: experimental
!!
!! `char_ord_sort( array )` sorts the input `ARRAY` of type `CHARACTER(*)`
!! `char_ord_sort( array[, work, reverse] )` sorts the input `ARRAY` of type `CHARACTER(*)`
!! using a hybrid sort based on the `'Rust" sort` algorithm found in `slice.rs`
character(len=*), intent(inout) :: array(0:)
character(len=len(array)), intent(out), optional :: work(0:)
Expand All @@ -370,7 +381,7 @@ module stdlib_sorting
pure module subroutine ${k1}$_sort( array, reverse )
!! Version: experimental
!!
!! `${k1}$_sort( array )` sorts the input `ARRAY` of type `${t1}$`
!! `${k1}$_sort( array[, reverse] )` sorts the input `ARRAY` of type `${t1}$`
!! using a hybrid sort based on the `introsort` of David Musser.
!! The algorithm is of order O(N Ln(N)) for all inputs.
!! Because it relies on `quicksort`, the coefficient of the O(N Ln(N))
Expand All @@ -384,7 +395,7 @@ module stdlib_sorting
pure module subroutine char_sort( array, reverse )
!! Version: experimental
!!
!! `char_sort( array )` sorts the input `ARRAY` of type `CHARACTER(*)`
!! `char_sort( array[, reverse] )` sorts the input `ARRAY` of type `CHARACTER(*)`
!! using a hybrid sort based on the `introsort` of David Musser.
!! The algorithm is of order O(N Ln(N)) for all inputs.
!! Because it relies on `quicksort`, the coefficient of the O(N Ln(N))
Expand All @@ -411,7 +422,8 @@ module stdlib_sorting
reverse )
!! Version: experimental
!!
!! `${k1}$_sort_index( array )` sorts an input `ARRAY` of type `${t1}$`
!! `${k1}$_sort_index( array, index[, work, iwork, reverse] )` sorts
!! an input `ARRAY` of type `${t1}$`
!! using a hybrid sort based on the `'Rust" sort` algorithm found in `slice.rs`
!! and returns the sorted `ARRAY` and an array `INDEX of indices in the
!! order that would sort the input `ARRAY` in the desired direction.
Expand All @@ -428,7 +440,8 @@ module stdlib_sorting
reverse )
!! Version: experimental
!!
!! `char_sort_index( array )` sorts an input `ARRAY` of type `CHARACTER(*)`
!! `char_sort_index( array, index[, work, iwork, reverse] )` sorts
!! an input `ARRAY` of type `CHARACTER(*)`
!! using a hybrid sort based on the `'Rust" sort` algorithm found in `slice.rs`
!! and returns the sorted `ARRAY` and an array `INDEX of indices in the
!! order that would sort the input `ARRAY` in the desired direction.
Expand Down
12 changes: 6 additions & 6 deletions src/stdlib_sorting_sort.fypp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ contains
#:for k1, t1 in IRS_KINDS_TYPES

pure subroutine ${k1}$_${sname}$_sort( array )
! `${k1}$_sort( array )` sorts the input `ARRAY` of type `${t1}$`
! `${k1}$_${sname}$_sort( array )` sorts the input `ARRAY` of type `${t1}$`
! using a hybrid sort based on the `introsort` of David Musser. As with
! `introsort`, `${k1}$_sort( array )` is an unstable hybrid comparison
! `introsort`, `${k1}$_${sname}$_sort( array )` is an unstable hybrid comparison
! algorithm using `quicksort` for the main body of the sort tree,
! supplemented by `insertion sort` for the outer brances, but if
! supplemented by `insertion sort` for the outer branches, but if
! `quicksort` is converging too slowly the algorithm resorts
! to `heapsort`. The algorithm is of order O(N Ln(N)) for all inputs.
! Because it relies on `quicksort`, the coefficient of the O(N Ln(N))
Expand Down Expand Up @@ -275,11 +275,11 @@ contains

#:for sname, signt, signoppt in SIGN_NAME_TYPE
pure subroutine char_${sname}$_sort( array )
! `char_sort( array )` sorts the input `ARRAY` of type `CHARACTER(*)`
! `char_${sname}$_sort( array )` sorts the input `ARRAY` of type `CHARACTER(*)`
! using a hybrid sort based on the `introsort` of David Musser. As with
! `introsort`, `char_sort( array )` is an unstable hybrid comparison
! `introsort`, `char_${sname}$_sort( array )` is an unstable hybrid comparison
! algorithm using `quicksort` for the main body of the sort tree,
! supplemented by `insertion sort` for the outer brances, but if
! supplemented by `insertion sort` for the outer branches, but if
! `quicksort` is converging too slowly the algorithm resorts
! to `heapsort`. The algorithm is of order O(N Ln(N)) for all inputs.
! Because it relies on `quicksort`, the coefficient of the O(N Ln(N))
Expand Down