1
0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-01-29 11:58:39 +01:00
dotSCAD/docs/lib2x-sort.md

32 lines
1.1 KiB
Markdown
Raw Normal View History

2019-06-29 10:29:43 +08:00
# sort
Sorts the elements of a list in ascending order. The list is a list-of-list construct, such as `[[a0, a1, a2...], [b0, b1, b2,...], [c0, c1, c2,...],...]`. When sorting, the function looks only at one index position of each sublist.
2020-03-19 16:59:41 +08:00
From dotSCAD 2.3, when `by` is `"vt"`, it will sort points by zyx (from the last index to the first one).
2019-06-29 10:40:03 +08:00
**Since:** 2.0
2019-06-29 10:29:43 +08:00
## Parameters
- `lt` : The original list.
2020-03-19 16:59:41 +08:00
- `by` : Can be `"x"``"y"``"z"`, `"idx"` (Default) or `"vt"`.
2019-06-29 10:29:43 +08:00
- `idx` : When `by` is `"idx"`, the value of `idx` is used. The Default value is 0.
## Examples
2020-01-28 17:51:20 +08:00
use <util/sort.scad>;
2019-06-29 10:29:43 +08:00
assert(
[[2, 0, 0], [5, 0, 0], [7, 0, 0], [9, 0, 0], [10, 0, 0]] ==
sort([[10, 0, 0], [5, 0, 0], [7, 0, 0], [2, 0, 0], [9, 0, 0]])
);
assert(
[[2, 0, 0], [5, 0, 0], [7, 0, 0], [9, 0, 0], [10, 0, 0]] ==
sort([[10, 0, 0], [5, 0, 0], [7, 0, 0], [2, 0, 0], [9, 0, 0]], by = "x")
);
assert(
[[0, 2, 0], [0, 5, 0], [0, 7, 0], [0, 9, 0], [0, 10, 0]] ==
sort([[0, 10, 0], [0, 5, 0], [0, 7, 0], [0, 2, 0], [0, 9, 0]], by = "idx", idx = 1)
2020-03-19 16:59:41 +08:00
);