Perl Programming Documentation
Download Perl
Explore

Manual

- Overview
- Tutorials
- FAQs
- History / Changes
- License

Reference

- Language
- Functions
- Operators
- Special Variables
- Pragmas
- Utilities
- Internals
- Platform Specific

Modules

- A • B • C • D • E
- F • G • H • I • L
- M • N • O • P • S
- T • U • X

Tools

- Preferences

# sort

Perl 5 version 26.0 documentation
Go to top
Show recent pages
Recently read

# sort

Perl functions A-Z | Perl functions by category | The 'perlfunc' manpage

- sort SUBNAME LIST

- sort BLOCK LIST
- sort LIST

  In list context, this sorts the LIST and returns the sorted list value. In scalar context, the behaviour of sort is undefined.

  If SUBNAME or BLOCK is omitted, sorts in standard string comparison order. If SUBNAME is specified, it gives the name of a subroutine that returns an integer less than, equal to, or greater than `0` , depending on how the elements of the list are to be ordered. (The `<=>` and `cmp` operators are extremely useful in such routines.) SUBNAME may be a scalar variable name (unsubscripted), in which case the value provides the name of (or a reference to) the actual subroutine to use. In place of a SUBNAME, you can provide a BLOCK as an anonymous, in-line sort subroutine.

  If the subroutine's prototype is `($$)` , the elements to be compared are passed by reference in @_ , as for a normal subroutine. This is slower than unprototyped subroutines, where the elements to be compared are passed into the subroutine as the package global variables `$a` and `$b` (see example below).

  If the subroutine is an XSUB, the elements to be compared are pushed on to the stack, the way arguments are usually passed to XSUBs. `$a` and `$b` are not set.

  The values to be compared are always passed by reference and should not be modified.

  You also cannot exit out of the sort block or subroutine using any of the loop control operators described in perlsyn or with goto.

  When use locale (but not `use locale ':not_characters'` ) is in effect, `sort LIST` sorts LIST according to the current collation locale. See perllocale.

  sort returns aliases into the original list, much as a for loop's index variable aliases the list elements. That is, modifying an element of a list returned by sort (for example, in a `foreach` , map or grep) actually modifies the element in the original list. This is usually something to be avoided when writing clear code.

  Perl 5.6 and earlier used a quicksort algorithm to implement sort. That algorithm was not stable and could go quadratic. (A stable sort preserves the input order of elements that compare equal. Although quicksort's run time is O(NlogN) when averaged over all arrays of length N, the time can be O(N**2), quadratic behavior, for some inputs.) In 5.7, the quicksort implementation was replaced with a stable mergesort algorithm whose worst-case behavior is O(NlogN). But benchmarks indicated that for some inputs, on some platforms, the original quicksort was faster. 5.8 has a sort pragma for limited control of the sort. Its rather blunt control of the underlying algorithm may not persist into future Perls, but the ability to characterize the input or output in implementation independent ways quite probably will.

  Examples:

          # sort lexically    my @articles = sort @files;    # same thing, but with explicit sort routine    my @articles = sort {$a cmp $b} @files;    # now case-insensitively    my @articles = sort {fc($a) cmp fc($b)} @files;    # same thing in reversed order    my @articles = sort {$b cmp $a} @files;    # sort numerically ascending    my @articles = sort {$a <=> $b} @files;    # sort numerically descending    my @articles = sort {$b <=> $a} @files;    # this sorts the %age hash by value instead of key    # using an in-line function    my @eldest = sort { $age{$b} <=> $age{$a} } keys %age;    # sort using explicit subroutine name    sub byage {        $age{$a} <=> $age{$b};  # presuming numeric    }    my @sortedclass = sort byage @class;    sub backwards { $b cmp $a }    my @harry  = qw(dog cat x Cain Abel);    my @george = qw(gone chased yz Punished Axed);    print sort @harry;        # prints AbelCaincatdogx    print sort backwards @harry;        # prints xdogcatCainAbel    print sort @george, 'to', @harry;        # prints AbelAxedCainPunishedcatchaseddoggonetoxyz    # inefficiently sort by descending numeric compare using    # the first integer after the first = sign, or the    # whole record case-insensitively otherwise    my @new = sort {        ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0]                            ||                    fc($a)  cmp  fc($b)    } @old;    # same thing, but much more efficiently;    # we'll build auxiliary indices instead    # for speed    my (@nums, @caps);    for (@old) {        push @nums, ( /=(\d+)/ ? $1 : undef );        push @caps, fc($_);    }    my @new = @old[ sort {                           $nums[$b] <=> $nums[$a]                                    ||                           $caps[$a] cmp $caps[$b]                         } 0..$#old                  ];    # same thing, but without any temps    my @new = map { $_->[0] }           sort { $b->[1] <=> $a->[1]                           ||                  $a->[2] cmp $b->[2]           } map { [$_, /=(\d+)/, fc($_)] } @old;    # using a prototype allows you to use any comparison subroutine    # as a sort subroutine (including other package's subroutines)    package Other;    sub backwards ($$) { $_[1] cmp $_[0]; }  # $a and $b are                                             # not set here    package main;    my @new = sort Other::backwards @old;    # guarantee stability, regardless of algorithm    use sort 'stable';    my @new = sort { substr($a, 3, 5) cmp substr($b, 3, 5) } @old;    # force use of mergesort (not portable outside Perl 5.8)    use sort '_mergesort';  # note discouraging _    my @new = sort { substr($a, 3, 5) cmp substr($b, 3, 5) } @old;

  Warning: syntactical care is required when sorting the list returned from a function. If you want to sort the list returned by the function call `find_records(@key)` , you can use:

          my @contact = sort { $a cmp $b } find_records @key;    my @contact = sort +find_records(@key);    my @contact = sort &find_records(@key);    my @contact = sort(find_records(@key));

  If instead you want to sort the array `@key` with the comparison routine `find_records()` then you can use:

          my @contact = sort { find_records() } @key;    my @contact = sort find_records(@key);    my @contact = sort(find_records @key);    my @contact = sort(find_records (@key));

  `$a` and `$b` are set as package globals in the package the sort() is called from. That means `$main::a` and `$main::b` (or `$::a` and `$::b` ) in the `main` package, `$FooPack::a` and `$FooPack::b` in the `FooPack` package, etc. If the sort block is in scope of a `my` or `state` declaration of `$a` and/or `$b` , you must spell out the full name of the variables in the sort block :

         package main;   my $a = "C"; # DANGER, Will Robinson, DANGER !!!   print sort { $a cmp $b }               qw(A C E G B D F H);                                          # WRONG   sub badlexi { $a cmp $b }   print sort badlexi                     qw(A C E G B D F H);                                          # WRONG   # the above prints BACFEDGH or some other incorrect ordering   print sort { $::a cmp $::b }           qw(A C E G B D F H);                                          # OK   print sort { our $a cmp our $b }       qw(A C E G B D F H);                                          # also OK   print sort { our ($a, $b); $a cmp $b } qw(A C E G B D F H);                                          # also OK   sub lexi { our $a cmp our $b }   print sort lexi                        qw(A C E G B D F H);                                          # also OK   # the above print ABCDEFGH

  With proper care you may mix package and my (or state) `$a` and/or `$b` :

         my $a = {      tiny   => -2,      small  => -1,      normal => 0,      big    => 1,      huge   => 2   };   say sort { $a->{our $a} <=> $a->{our $b} }       qw{ huge normal tiny small big};   # prints tinysmallnormalbighuge

  `$a` and `$b` are implicitely local to the sort() execution and regain their former values upon completing the sort.

  Sort subroutines written using `$a` and `$b` are bound to their calling package. It is possible, but of limited interest, to define them in a different package, since the subroutine must still refer to the calling package's `$a` and `$b` :

         package Foo;   sub lexi { $Bar::a cmp $Bar::b }   package Bar;   ... sort Foo::lexi ...

  Use the prototyped versions (see above) for a more generic alternative.

  The comparison function is required to behave. If it returns inconsistent results (sometimes saying `$x[1]` is less than `$x[2]` and sometimes saying the opposite, for example) the results are not well-defined.

  Because `<=>` returns undef when either operand is `NaN` (not-a-number), be careful when sorting with a comparison function like `$a <=> $b` any lists that might contain a `NaN` . The following example takes advantage that `NaN != NaN` to eliminate any `NaN` s from the input list.

          my @result = sort { $a <=> $b } grep { $_ == $_ } @input;