Skip to content

Feat: stdlib: adds std/algorithm.sortedBy #25241

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

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Feat: stdlib: adds std/algorithm.sortedBy #25241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 50 additions & 0 deletions lib/pure/algorithm.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,7 @@ func sort*[T](a: var openArray[T],
## * `sort proc<#sort,openArray[T]>`_
## * `sorted proc<#sorted,openArray[T],proc(T,T)>`_ sorted by `cmp` in the specified order
## * `sorted proc<#sorted,openArray[T]>`_
## * `sortedBy proc<#sortedBy,openArray[T],proc(T)>`_
## * `sortedByIt template<#sortedByIt.t,untyped,untyped>`_
runnableExamples:
var d = ["boo", "fo", "barr", "qux"]
Expand All @@ -427,6 +428,7 @@ proc sort*[T](a: var openArray[T], order = SortOrder.Ascending) = sort[T](a,
## * `sort func<#sort,openArray[T],proc(T,T)>`_
## * `sorted proc<#sorted,openArray[T],proc(T,T)>`_ sorted by `cmp` in the specified order
## * `sorted proc<#sorted,openArray[T]>`_
## * `sortedBy proc<#sortedBy,openArray[T],proc(T)>`_
## * `sortedByIt template<#sortedByIt.t,untyped,untyped>`_

proc sorted*[T](a: openArray[T], cmp: proc(x, y: T): int {.closure.},
Expand All @@ -436,6 +438,7 @@ proc sorted*[T](a: openArray[T], cmp: proc(x, y: T): int {.closure.},
## **See also:**
## * `sort func<#sort,openArray[T],proc(T,T)>`_
## * `sort proc<#sort,openArray[T]>`_
## * `sortedBy proc<#sortedBy,openArray[T],proc(T)>`_
## * `sortedByIt template<#sortedByIt.t,untyped,untyped>`_
runnableExamples:
let
Expand All @@ -457,6 +460,7 @@ proc sorted*[T](a: openArray[T], order = SortOrder.Ascending): seq[T] =
## **See also:**
## * `sort func<#sort,openArray[T],proc(T,T)>`_
## * `sort proc<#sort,openArray[T]>`_
## * `sortedBy proc<#sortedBy,openArray[T],proc(T)>`_
## * `sortedByIt template<#sortedByIt.t,untyped,untyped>`_
runnableExamples:
let
Expand All @@ -469,6 +473,51 @@ proc sorted*[T](a: openArray[T], order = SortOrder.Ascending): seq[T] =
assert d == @["adam", "brian", "cat", "dande"]
sorted[T](a, system.cmp[T], order)

proc sortedBy*[T, C](
a: openArray[T],
comparable: proc(x: T): C {.closure.},
order = SortOrder.Ascending
): seq[T] {.effectsOf: comparable.} =
## Convenience proc around `sorted`. The closure `comparable`
## should produce a single comparable value for each element,
## which will then be used to sort with `system.cmp` by `order`.
##
## **See also:**
## * `sort func<#sort,openArray[T],proc(T,T)>`_
## * `sorted proc<#sorted,openArray[T],proc(T,T)>`_ sorted by `cmp` in the specified order
## * `sorted proc<#sorted,openArray[T]>`_
## * `sortedByIt template<#sortedByIt.t,untyped,untyped>`_
runnableExamples:
import std/math
import std/sugar
import std/sequtils

type Country = tuple[name: string, gdp: float, area: float]

let countries: seq[Country] = @[
(name: "USA", gdp: 30.617, area: 9.148),
(name: "China", gdp: 19.399, area: 9.326),
(name: "Germany", gdp: 5.015, area: 0.349),
(name: "Japan", gdp: 4.281, area: 0.364),
(name: "India", gdp: 4.028, area: 2.973)
]

assert countries.sortedBy(c => c.gdp, Descending).map(c => c.name) == @["USA",
"China", "Germany", "Japan", "India"]
assert countries.sortedBy(c => c.area, Descending).map(c => c.name) == @["China",
"USA", "India", "Japan", "Germany"]
assert countries.sortedBy(c => c.area.pow(2.0), Descending).map(c => c.name) == @["China",
"USA", "India", "Japan", "Germany"]
assert countries.sortedBy(c => c.name).map(c => c.name) == @["China",
"Germany", "India", "Japan", "USA"]
assert countries.sortedBy(c => c.name[^1]).map(c => c.name) == @["USA",
"China", "India", "Japan", "Germany"]
sorted[T](
a,
proc(x, y: T): int = system.cmp[C](comparable(x), comparable(y)),
order
)

template sortedByIt*(seq1, op: untyped): untyped =
## Convenience template around the `sorted` proc to reduce typing.
##
Expand All @@ -483,6 +532,7 @@ template sortedByIt*(seq1, op: untyped): untyped =
## * `sort proc<#sort,openArray[T]>`_
## * `sorted proc<#sorted,openArray[T],proc(T,T)>`_ sorted by `cmp` in the specified order
## * `sorted proc<#sorted,openArray[T]>`_
## * `sortedBy proc<#sortedBy,openArray[T],proc(T)>`_
runnableExamples:
type Person = tuple[name: string, age: int]
var
Expand Down