Debian Codegraph @

upstream/opensuse-tumbleweed/man3/sort.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "sort 3pm"
61 .TH sort 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 sort \- perl pragma to control sort() behaviour
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 The sort pragma is now a no\-op, and its use is discouraged. These three
71 operations are valid, but have no effect:
72 .PP
73 .Vb 3
74 \& use sort \*(Aqstable\*(Aq; # guarantee stability
75 \& use sort \*(Aqdefaults\*(Aq; # revert to default behavior
76 \& no sort \*(Aqstable\*(Aq; # stability not important
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 Historically the \f(CW\*(C`sort\*(C'\fR pragma you can control the behaviour of the builtin
81 \&\f(CWsort()\fR function.
82 .PP
83 Prior to v5.28.0 there were two other options:
84 .PP
85 .Vb 2
86 \& use sort \*(Aq_mergesort\*(Aq;
87 \& use sort \*(Aq_qsort\*(Aq; # or \*(Aq_quicksort\*(Aq
88 .Ve
89 .PP
90 If you try and specify either of these in v5.28+ it will croak.
91 .PP
92 The default sort has been stable since v5.8.0, and given this consistent
93 behaviour for almost two decades, everyone has come to assume stability.
94 .PP
95 Stability will remain the default \- hence there is no need for a pragma for
96 code to opt into stability "just in case" this changes \- it won\*(Aqt.
97 .PP
98 We do not foresee going back to offering multiple implementations of general
99 purpose sorting \- hence there is no future need to offer a pragma to choose
100 between them.
101 .PP
102 If you know that you care that much about performance of your sorting, and
103 that for your use case and your data, it was worth investigating
104 alternatives, possible to identify an alternative from our default that was
105 better, and the cost of switching was worth it, then you know more than we
106 do. Likely whatever choices we can give are not as good as implementing your
107 own. (For example, a Radix sort can be faster than O(n log n), but can\*(Aqt be
108 used for all keys and has larger overheads.)
109 .PP
110 We are not averse to \fBchanging\fR the sort algorithm, but we don\*(Aqt see the
111 benefit in offering the choice of two general purpose implementations.
112 .SH CAVEATS
113 .IX Header "CAVEATS"
114 The function \f(CWsort::current()\fR was provided to report the current state of
115 the sort pragmata. This function was not exported, and there is no code to
116 call it on CPAN. It is now deprecated, and will warn by default.
117 .PP
118 As we no longer store any sort "state", it can no longer return the correct
119 value, so it will always return the string \f(CW\*(C`stable\*(C'\fR, as this is consistent
120 with what we actually have implemented.