Copyright	(c) 2010 John Millikin
License	BSD3
Maintainer	jmillikin@gmail.com
Portability	portable
Safe Haskell	Safe
Language	Haskell98

Algorithms.NaturalSort

Description

Human-friendly text collation

Synopsis

Documentation

data SortKey #

Instances

Eq SortKey #
Methods (==) :: SortKey -> SortKey -> Bool # (/=) :: SortKey -> SortKey -> Bool #
Ord SortKey #
Methods compare :: SortKey -> SortKey -> Ordering # (<) :: SortKey -> SortKey -> Bool # (<=) :: SortKey -> SortKey -> Bool # (>) :: SortKey -> SortKey -> Bool # (>=) :: SortKey -> SortKey -> Bool # max :: SortKey -> SortKey -> SortKey # min :: SortKey -> SortKey -> SortKey #
Show SortKey #
Methods showsPrec :: Int -> SortKey -> ShowS # show :: SortKey -> String # showList :: [SortKey] -> ShowS #

class NaturalSort a where #

Minimal complete definition

sortKey, sortKeyCollated

Methods

sortKey :: a -> SortKey #

Split a sortable type into textual and numeric sections, with no collation transformation.

If advanced collation is required, either pre-transform the input (using eg toLower) or use sortKeyCollated.

sortKeyCollated :: (Text -> ByteString) -> a -> SortKey #

Split a sortable type into textual and numeric sections, using a custom collation transformation. This is useful for providing language- or use-specific ordering.

Instances

NaturalSort String #
Methods sortKey :: String -> SortKey # sortKeyCollated :: (Text -> ByteString) -> String -> SortKey #
NaturalSort Text #
Methods sortKey :: Text -> SortKey # sortKeyCollated :: (Text -> ByteString) -> Text -> SortKey #
NaturalSort Text #
Methods sortKey :: Text -> SortKey # sortKeyCollated :: (Text -> ByteString) -> Text -> SortKey #

compare :: NaturalSort a => a -> a -> Ordering #

Compare two values, using their natural ordering.