Difference between revisions of "Array sort"
From Lazarus wiki
Jump to navigationJump to searchm (→AnySort.pas) |
(Faster and safer version.) |
||
Line 80: | Line 80: | ||
interface | interface | ||
− | uses AnySort | + | uses AnySort; |
procedure SortArrayInteger(var arr: array of Integer; count: Integer); | procedure SortArrayInteger(var arr: array of Integer; count: Integer); | ||
Line 102: | Line 102: | ||
</source> | </source> | ||
+ | =Advanced version= | ||
+ | =Features= | ||
+ | * FPC-only | ||
+ | * Uses '''generic''' with static comparer | ||
+ | * Essentially an Introsort, a QuickSort that falls back to a simple algorithm for small enough subarrays. | ||
+ | * Bypasses managed types handling to greatly speed up sorting arrays of reference-counted types; won't work with custom Copy/AddRef operators | ||
+ | * Protected against | ||
+ | ** O(N²) time (falls back to heap sort) | ||
+ | ** O(N) recursion depth; maximum recursion depth is ⌈bitsizeof(SizeUint) - log₂ SelectionThreshold⌉. | ||
+ | =AnySort2.pas= | ||
+ | <source lang='delphi'>{$mode objfpc} {$coperators on} | ||
+ | unit AnySort2; | ||
+ | |||
+ | interface | ||
+ | |||
+ | type | ||
+ | // Comparer should provide the function Less(const a, b: Elem): boolean. | ||
+ | generic Sorter<Elem, Comparer> = class | ||
+ | type | ||
+ | pElem = ^Elem; | ||
+ | |||
+ | class procedure Sort(p: pElem; count: SizeUint); static; | ||
+ | class procedure Sort(var a: array of Elem); static; | ||
+ | |||
+ | private const | ||
+ | SelectionThreshold = 12; | ||
+ | HeapArity = 4; | ||
+ | type | ||
+ | SwapTemp = array[0 .. sizeof(Elem) - 1] of byte; | ||
+ | var | ||
+ | class procedure SelectionSort(p: pElem; count: SizeUint); static; | ||
+ | |||
+ | class function Median(p: pElem; count: SizeUint): pElem; static; | ||
+ | class procedure QSort(p: pElem; count, reasonable: SizeUint); static; | ||
+ | |||
+ | class procedure HeapReplacePessimistic(p: pElem; count, id: SizeUint; const x: SwapTemp); static; | ||
+ | class procedure HeapSort(p: pElem; count: SizeUint); static; | ||
+ | end; | ||
+ | |||
+ | generic ComparerLessOp<Elem> = class | ||
+ | class function Less(const a, b: Elem): boolean; static; inline; | ||
+ | end; | ||
+ | |||
+ | generic SorterLessOp<Elem> = class(specialize Sorter<Elem, specialize ComparerLessOp<Elem>>) end; | ||
+ | |||
+ | implementation | ||
+ | |||
+ | class procedure Sorter.Sort(p: pElem; count: SizeUint); | ||
+ | begin | ||
+ | QSort(p, count, count); | ||
+ | end; | ||
+ | |||
+ | class procedure Sorter.Sort(var a: array of Elem); | ||
+ | begin | ||
+ | Sort(pElem(a), length(a)); | ||
+ | end; | ||
+ | |||
+ | class procedure Sorter.SelectionSort(p: pElem; count: SizeUint); | ||
+ | var | ||
+ | i, j, imin: SizeInt; | ||
+ | t: SwapTemp; | ||
+ | begin | ||
+ | for i := 0 to SizeInt(count) - 2 do | ||
+ | begin | ||
+ | imin := i; | ||
+ | for j := i + 1 to SizeInt(count) - 1 do | ||
+ | if Comparer.Less(p[j], p[imin]) then imin := j; | ||
+ | t := SwapTemp(p[i]); SwapTemp(p[i]) := SwapTemp(p[imin]); SwapTemp(p[imin]) := t; | ||
+ | end; | ||
+ | end; | ||
+ | |||
+ | class function Sorter.Median(p: pElem; count: SizeUint): pElem; | ||
+ | var | ||
+ | mid, last: pElem; | ||
+ | begin | ||
+ | mid := p + count div 2; | ||
+ | last := p + SizeUint(count - 1); | ||
+ | if Comparer.Less(p[0], mid^) then // first < mid | ||
+ | if Comparer.Less(mid^, last^) then // first < mid < last | ||
+ | result := mid | ||
+ | else // mid >= first, mid >= last | ||
+ | if Comparer.Less(p[0], last^) then // first < last <= mid | ||
+ | result := last | ||
+ | else // last <= first <= mid | ||
+ | result := p | ||
+ | else // mid <= first | ||
+ | if Comparer.less(last^, mid^) then // last < mid <= first | ||
+ | result := mid | ||
+ | else // mid <= first, mid <= last | ||
+ | if Comparer.Less(p[0], last^) then // mid <= first < last | ||
+ | result := p | ||
+ | else // mid <= last <= first | ||
+ | result := last; | ||
+ | end; | ||
+ | |||
+ | // see MSVC std::sort | ||
+ | class procedure Sorter.QSort(p: pElem; count, reasonable: SizeUint); | ||
+ | var | ||
+ | L, R: SizeUint; | ||
+ | t, avg: SwapTemp; | ||
+ | begin | ||
+ | while (count > SelectionThreshold) and (reasonable > 0) do | ||
+ | begin | ||
+ | reasonable := reasonable div 2 + reasonable div 4; | ||
+ | |||
+ | avg := SwapTemp(Median(p, count)^); | ||
+ | R := 0; | ||
+ | L := count - 1; | ||
+ | |||
+ | repeat | ||
+ | while Comparer.Less(p[R], Elem(avg)) do inc(R); | ||
+ | while Comparer.Less(Elem(avg), p[L]) do dec(L); | ||
+ | if R <= L then | ||
+ | begin | ||
+ | t := SwapTemp(p[R]); SwapTemp(p[R]) := SwapTemp(p[L]); SwapTemp(p[L]) := t; | ||
+ | inc(R); | ||
+ | dec(L); | ||
+ | end; | ||
+ | until R > L; | ||
+ | |||
+ | // [0 .. L], [R .. count - 1] | ||
+ | if count - R <= L then | ||
+ | begin | ||
+ | if R + 1 < count then QSort(p + R, count - R, reasonable); | ||
+ | count := L + 1; | ||
+ | end else | ||
+ | begin | ||
+ | if L > 0 then QSort(p, L + 1, reasonable); | ||
+ | p += R; | ||
+ | count -= R; | ||
+ | end; | ||
+ | end; | ||
+ | if count > SelectionThreshold then | ||
+ | HeapSort(p, count) | ||
+ | else if count >= 2 then | ||
+ | SelectionSort(p, count); | ||
+ | end; | ||
+ | |||
+ | // HeapReplacePessimistic(p, count, id, x) | ||
+ | // | ||
+ | // is equivalent to | ||
+ | // | ||
+ | // p[id] := x; | ||
+ | // id := HeapDownThoroughly(..., id); | ||
+ | // HeapUp(..., id) | ||
+ | // | ||
+ | // where HeapDownThoroughly doesn't stop at correct position, instead shifting the element all the way down, saving one compare, and HeapUp fixes it. | ||
+ | // See Python's 'heapq' for justification over simple HeapDown. | ||
+ | |||
+ | class procedure Sorter.HeapReplacePessimistic(p: pElem; count, id: SizeUint; const x: SwapTemp); | ||
+ | var | ||
+ | child, bestChild, endChild, parent, start: SizeUint; | ||
+ | begin | ||
+ | start := id; | ||
+ | repeat | ||
+ | child := HeapArity * id; // childs of 'id' are p[child + 1] ... p[child + HeapArity]. | ||
+ | bestChild := child + 1; | ||
+ | if bestChild >= count then break; | ||
+ | |||
+ | endChild := child + (HeapArity + 1); | ||
+ | if endChild > count then endChild := count; | ||
+ | |||
+ | child += 2; | ||
+ | while child < endChild do | ||
+ | begin | ||
+ | if Comparer.Less(p[bestChild], p[child]) then bestChild := child; | ||
+ | inc(child); | ||
+ | end; | ||
+ | SwapTemp(p[id]) := SwapTemp(p[bestChild]); | ||
+ | id := bestChild; | ||
+ | until false; | ||
+ | |||
+ | while id > start do | ||
+ | begin | ||
+ | parent := (id - 1) div HeapArity; | ||
+ | if not Comparer.Less(p[parent], Elem(x)) then break; | ||
+ | SwapTemp(p[id]) := SwapTemp(p[parent]); | ||
+ | id := parent; | ||
+ | end; | ||
+ | SwapTemp(p[id]) := x; | ||
+ | end; | ||
+ | |||
+ | class procedure Sorter.HeapSort(p: pElem; count: SizeUint); | ||
+ | var | ||
+ | i: SizeInt; | ||
+ | t: SwapTemp; | ||
+ | begin | ||
+ | for i := SizeInt((count + (HeapArity - 2)) div HeapArity) - 1 downto 0 do | ||
+ | begin | ||
+ | t := SwapTemp(p[i]); | ||
+ | HeapReplacePessimistic(p, count, i, t); | ||
+ | end; | ||
+ | for i := SizeInt(count) - 1 downto 1 do | ||
+ | begin | ||
+ | t := SwapTemp(p[i]); | ||
+ | SwapTemp(p[i]) := SwapTemp(p[0]); | ||
+ | HeapReplacePessimistic(p, i, 0, t); | ||
+ | end; | ||
+ | end; | ||
+ | |||
+ | class function ComparerLessOp.Less(const a, b: Elem): boolean; | ||
+ | begin | ||
+ | result := a < b; | ||
+ | end; | ||
+ | |||
+ | end.</source> | ||
+ | |||
+ | Usage:<source lang='delphi'>{$mode objfpc} | ||
+ | uses AnySort2; | ||
+ | |||
+ | var | ||
+ | a: array of integer; | ||
+ | |||
+ | begin | ||
+ | a := specialize TArray<integer>.Create(111, 555, 888, 777, 333, 444, 666); | ||
+ | specialize SorterLessOp<integer>.Sort(a); | ||
+ | end.</source> | ||
[[Category:Sort]] | [[Category:Sort]] |
Revision as of 11:51, 2 November 2020
A typical task is to sort an array. One of the problems is that an array could be of any type. Not a simple type, but more complicated types.
Prior to introducing Generics into Freepascal, sorting an array of arbitrary type could be achieve via untyped variables (implicit Pointers).
Features
- Fast
- any array data type
AnySort.pas
unit anysort;
{$ifdef fpc}{$mode delphi}{$H+}{$endif}
interface
type
TCompareFunc = function (const elem1, elem2): Integer;
procedure AnySort(var Arr; Count: Integer; Stride: Integer; CompareFunc: TCompareFunc);
implementation
type
TByteArray = array [Word] of byte;
PByteArray = ^TByteArray;
procedure AnyQuickSort(var Arr; idxL, idxH: Integer;
Stride: Integer; CompareFunc: TCompareFunc; var SwapBuf, MedBuf);
var
ls,hs : Integer;
li,hi : Integer;
mi : Integer;
ms : Integer;
pb : PByteArray;
begin
pb:=@Arr;
li:=idxL;
hi:=idxH;
mi:=(li+hi) div 2;
ls:=li*Stride;
hs:=hi*Stride;
ms:=mi*Stride;
Move(pb[ms], medBuf, Stride);
repeat
while CompareFunc( pb[ls], medBuf) < 0 do begin
inc(ls, Stride);
inc(li);
end;
while CompareFunc( medBuf, pb[hs] ) < 0 do begin
dec(hs, Stride);
dec(hi);
end;
if ls <= hs then begin
Move(pb[ls], SwapBuf, Stride);
Move(pb[hs], pb[ls], Stride);
Move(SwapBuf, pb[hs], Stride);
inc(ls, Stride); inc(li);
dec(hs, Stride); dec(hi);
end;
until ls>hs;
if hi>idxL then AnyQuickSort(Arr, idxL, hi, Stride, CompareFunc, SwapBuf);
if li<idxH then AnyQuickSort(Arr, li, idxH, Stride, CompareFunc, SwapBuf);
end;
procedure AnySort(var Arr; Count: Integer; Stride: Integer; CompareFunc: TCompareFunc);
var
buf: array of byte;
buf2: array of byte;
begin
SetLength(buf, Stride);
SetLength(buf2, Stride);
AnyQuickSort(Arr, 0, Count-1, Stride, compareFunc, buf[0], buf2[0]);
end;
end.
Here's an example on how to use AnySort() function to sort an array of Integer
interface
uses AnySort;
procedure SortArrayInteger(var arr: array of Integer; count: Integer);
implementation
function CompareInt(const d1,d2): integer;
var
i1 : integer absolute d1;
i2 : integer absolute d2;
begin
if i1=i2 then Result:=0
else if i1<i2 then Result:=-1
else Result:=1;
end;
procedure SortArrayInteger(var arr: array of Integer; count: Integer);
begin
AnySort(arr, Count, sizeof(Integer), @CompareInt);
end;
Advanced version
Features
- FPC-only
- Uses generic with static comparer
- Essentially an Introsort, a QuickSort that falls back to a simple algorithm for small enough subarrays.
- Bypasses managed types handling to greatly speed up sorting arrays of reference-counted types; won't work with custom Copy/AddRef operators
- Protected against
- O(N²) time (falls back to heap sort)
- O(N) recursion depth; maximum recursion depth is ⌈bitsizeof(SizeUint) - log₂ SelectionThreshold⌉.
AnySort2.pas
{$mode objfpc} {$coperators on}
unit AnySort2;
interface
type
// Comparer should provide the function Less(const a, b: Elem): boolean.
generic Sorter<Elem, Comparer> = class
type
pElem = ^Elem;
class procedure Sort(p: pElem; count: SizeUint); static;
class procedure Sort(var a: array of Elem); static;
private const
SelectionThreshold = 12;
HeapArity = 4;
type
SwapTemp = array[0 .. sizeof(Elem) - 1] of byte;
var
class procedure SelectionSort(p: pElem; count: SizeUint); static;
class function Median(p: pElem; count: SizeUint): pElem; static;
class procedure QSort(p: pElem; count, reasonable: SizeUint); static;
class procedure HeapReplacePessimistic(p: pElem; count, id: SizeUint; const x: SwapTemp); static;
class procedure HeapSort(p: pElem; count: SizeUint); static;
end;
generic ComparerLessOp<Elem> = class
class function Less(const a, b: Elem): boolean; static; inline;
end;
generic SorterLessOp<Elem> = class(specialize Sorter<Elem, specialize ComparerLessOp<Elem>>) end;
implementation
class procedure Sorter.Sort(p: pElem; count: SizeUint);
begin
QSort(p, count, count);
end;
class procedure Sorter.Sort(var a: array of Elem);
begin
Sort(pElem(a), length(a));
end;
class procedure Sorter.SelectionSort(p: pElem; count: SizeUint);
var
i, j, imin: SizeInt;
t: SwapTemp;
begin
for i := 0 to SizeInt(count) - 2 do
begin
imin := i;
for j := i + 1 to SizeInt(count) - 1 do
if Comparer.Less(p[j], p[imin]) then imin := j;
t := SwapTemp(p[i]); SwapTemp(p[i]) := SwapTemp(p[imin]); SwapTemp(p[imin]) := t;
end;
end;
class function Sorter.Median(p: pElem; count: SizeUint): pElem;
var
mid, last: pElem;
begin
mid := p + count div 2;
last := p + SizeUint(count - 1);
if Comparer.Less(p[0], mid^) then // first < mid
if Comparer.Less(mid^, last^) then // first < mid < last
result := mid
else // mid >= first, mid >= last
if Comparer.Less(p[0], last^) then // first < last <= mid
result := last
else // last <= first <= mid
result := p
else // mid <= first
if Comparer.less(last^, mid^) then // last < mid <= first
result := mid
else // mid <= first, mid <= last
if Comparer.Less(p[0], last^) then // mid <= first < last
result := p
else // mid <= last <= first
result := last;
end;
// see MSVC std::sort
class procedure Sorter.QSort(p: pElem; count, reasonable: SizeUint);
var
L, R: SizeUint;
t, avg: SwapTemp;
begin
while (count > SelectionThreshold) and (reasonable > 0) do
begin
reasonable := reasonable div 2 + reasonable div 4;
avg := SwapTemp(Median(p, count)^);
R := 0;
L := count - 1;
repeat
while Comparer.Less(p[R], Elem(avg)) do inc(R);
while Comparer.Less(Elem(avg), p[L]) do dec(L);
if R <= L then
begin
t := SwapTemp(p[R]); SwapTemp(p[R]) := SwapTemp(p[L]); SwapTemp(p[L]) := t;
inc(R);
dec(L);
end;
until R > L;
// [0 .. L], [R .. count - 1]
if count - R <= L then
begin
if R + 1 < count then QSort(p + R, count - R, reasonable);
count := L + 1;
end else
begin
if L > 0 then QSort(p, L + 1, reasonable);
p += R;
count -= R;
end;
end;
if count > SelectionThreshold then
HeapSort(p, count)
else if count >= 2 then
SelectionSort(p, count);
end;
// HeapReplacePessimistic(p, count, id, x)
//
// is equivalent to
//
// p[id] := x;
// id := HeapDownThoroughly(..., id);
// HeapUp(..., id)
//
// where HeapDownThoroughly doesn't stop at correct position, instead shifting the element all the way down, saving one compare, and HeapUp fixes it.
// See Python's 'heapq' for justification over simple HeapDown.
class procedure Sorter.HeapReplacePessimistic(p: pElem; count, id: SizeUint; const x: SwapTemp);
var
child, bestChild, endChild, parent, start: SizeUint;
begin
start := id;
repeat
child := HeapArity * id; // childs of 'id' are p[child + 1] ... p[child + HeapArity].
bestChild := child + 1;
if bestChild >= count then break;
endChild := child + (HeapArity + 1);
if endChild > count then endChild := count;
child += 2;
while child < endChild do
begin
if Comparer.Less(p[bestChild], p[child]) then bestChild := child;
inc(child);
end;
SwapTemp(p[id]) := SwapTemp(p[bestChild]);
id := bestChild;
until false;
while id > start do
begin
parent := (id - 1) div HeapArity;
if not Comparer.Less(p[parent], Elem(x)) then break;
SwapTemp(p[id]) := SwapTemp(p[parent]);
id := parent;
end;
SwapTemp(p[id]) := x;
end;
class procedure Sorter.HeapSort(p: pElem; count: SizeUint);
var
i: SizeInt;
t: SwapTemp;
begin
for i := SizeInt((count + (HeapArity - 2)) div HeapArity) - 1 downto 0 do
begin
t := SwapTemp(p[i]);
HeapReplacePessimistic(p, count, i, t);
end;
for i := SizeInt(count) - 1 downto 1 do
begin
t := SwapTemp(p[i]);
SwapTemp(p[i]) := SwapTemp(p[0]);
HeapReplacePessimistic(p, i, 0, t);
end;
end;
class function ComparerLessOp.Less(const a, b: Elem): boolean;
begin
result := a < b;
end;
end.
Usage:
{$mode objfpc}
uses AnySort2;
var
a: array of integer;
begin
a := specialize TArray<integer>.Create(111, 555, 888, 777, 333, 444, 666);
specialize SorterLessOp<integer>.Sort(a);
end.