Copyright	(c) 2010 John Millikin
License	BSD3
Maintainer	[email protected]
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell98

Algorithms.NaturalSort

Description

Human-friendly text collation

Synopsis

data SortKey
class NaturalSort a where
- sortKey :: a -> SortKey
- sortKeyCollated :: (Text -> ByteString) -> a -> SortKey
compare :: NaturalSort a => a -> a -> Ordering

Documentation

data SortKey Source #

Instances

Instances details

Show SortKey Source #
Instance details Defined in Algorithms.NaturalSort Methods showsPrec :: Int -> SortKey -> ShowS # show :: SortKey -> String # showList :: [SortKey] -> ShowS #
Eq SortKey Source #
Instance details Defined in Algorithms.NaturalSort Methods (==) :: SortKey -> SortKey -> Bool # (/=) :: SortKey -> SortKey -> Bool #
Ord SortKey Source #
Instance details Defined in Algorithms.NaturalSort 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 #

class NaturalSort a where Source #

Methods

sortKey :: a -> SortKey Source #

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 Source #

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

Instances details

NaturalSort Text Source #
Instance details Defined in Algorithms.NaturalSort Methods sortKey :: Text -> SortKey Source # sortKeyCollated :: (Text -> ByteString) -> Text -> SortKey Source #
NaturalSort Text Source #
Instance details Defined in Algorithms.NaturalSort Methods sortKey :: Text -> SortKey Source # sortKeyCollated :: (Text -> ByteString) -> Text -> SortKey Source #
NaturalSort String Source #
Instance details Defined in Algorithms.NaturalSort Methods sortKey :: String -> SortKey Source # sortKeyCollated :: (Text -> ByteString) -> String -> SortKey Source #

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

Compare two values, using their natural ordering.