Numeric.Subroutine.Sort

Documentation

class BoundedDim n => SortBy n where

Methods

sortByInplace

Arguments

:: PrimBytes t

=> (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering)

must not modify state!

-> STDataFrame s t (n ': ns)

-> ST s ()

Note, Inplace here means the input frame is modified. It does not mean the algorithm does not use extra space (it does use).

Instances

KnownDim n => SortBy (n :: Nat)

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (n ': ns) -> ST s ()

SortBy 0

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (0 ': ns) -> ST s ()

SortBy 1

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (1 ': ns) -> ST s ()

SortBy 2

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (2 ': ns) -> ST s ()

SortBy 3

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (3 ': ns) -> ST s ()

SortBy 4

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (4 ': ns) -> ST s ()

BoundedDim xn => SortBy (xn :: XNat)

Defined in Numeric.Subroutine.Sort

Methods

sortByInplace :: forall t s (ns :: [k]). PrimBytes t => (STDataFrame s t ns -> STDataFrame s t ns -> ST s Ordering) -> STDataFrame s t (xn ': ns) -> ST s ()

sortBy :: forall (t :: Type) n ns. (SortableDataFrame t (n ': ns), SortBy n) => (DataFrame t ns -> DataFrame t ns -> Ordering) -> DataFrame t (n ': ns) -> DataFrame t (n ': ns)

Sort a DataFrame along the first dimension using given comparison function.

sort :: forall (t :: Type) n ns. (SortableDataFrame t (n ': ns), Ord t, SortBy n) => DataFrame t (n ': ns) -> DataFrame t (n ': ns)

Sort a DataFrame along the first dimension.

Note: the elements (which are of type DataFrame t ns) are compared lexicographically.

type family SortableDataFrame (t :: Type) (ns :: [k]) :: Constraint where ...

The required context for sorting a DataFrame is slightly different for Nat and XNat indexed arrays. This type family abstracts away the difference.

Equations

SortableDataFrame t (n ': ns :: [Nat]) = (PrimArray t (DataFrame t ns), PrimArray t (DataFrame t (n ': ns)))

SortableDataFrame t (n ': ns :: [XNat]) = PrimBytes t