Debian Codegraph @

upstream/debian-unstable/man3/sort.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "sort 3perl"
58 .TH sort 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 sort \- perl pragma to control sort() behaviour
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 The sort pragma is now a no-op, and its use is discouraged. These three
68 operations are valid, but have no effect:
69 .PP
70 .Vb 3
71 \& use sort \*(Aqstable\*(Aq; # guarantee stability
72 \& use sort \*(Aqdefaults\*(Aq; # revert to default behavior
73 \& no sort \*(Aqstable\*(Aq; # stability not important
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 Historically the \f(CW\*(C`sort\*(C'\fR pragma you can control the behaviour of the builtin
78 \&\f(CWsort()\fR function.
79 .PP
80 Prior to v5.28.0 there were two other options:
81 .PP
82 .Vb 2
83 \& use sort \*(Aq_mergesort\*(Aq;
84 \& use sort \*(Aq_qsort\*(Aq; # or \*(Aq_quicksort\*(Aq
85 .Ve
86 .PP
87 If you try and specify either of these in v5.28+ it will croak.
88 .PP
89 The default sort has been stable since v5.8.0, and given this consistent
90 behaviour for almost two decades, everyone has come to assume stability.
91 .PP
92 Stability will remain the default \- hence there is no need for a pragma for
93 code to opt into stability "just in case" this changes \- it won't.
94 .PP
95 We do not foresee going back to offering multiple implementations of general
96 purpose sorting \- hence there is no future need to offer a pragma to choose
97 between them.
98 .PP
99 If you know that you care that much about performance of your sorting, and
100 that for your use case and your data, it was worth investigating
101 alternatives, possible to identify an alternative from our default that was
102 better, and the cost of switching was worth it, then you know more than we
103 do. Likely whatever choices we can give are not as good as implementing your
104 own. (For example, a Radix sort can be faster than O(n log n), but can't be
105 used for all keys and has larger overheads.)
106 .PP
107 We are not averse to \fBchanging\fR the sort algorithm, but we don't see the
108 benefit in offering the choice of two general purpose implementations.
109 .SH CAVEATS
110 .IX Header "CAVEATS"
111 The function \f(CWsort::current()\fR was provided to report the current state of
112 the sort pragmata. This function was not exported, and there is no code to
113 call it on CPAN. It is now deprecated, and will warn by default.
114 .PP
115 As we no longer store any sort "state", it can no longer return the correct
116 value, so it will always return the string \f(CW\*(C`stable\*(C'\fR, as this is consistent
117 with what we actually have implemented.