Text.Numerals.Algorithm

A module that contains data types and functions to automatically convert a number to words. It has tooling for a NumeralsAlgorithm as well as a HighNumberAlgorithm that is used to generate a ShortScale or LongScale.

Data types for number algorithms

data NumeralsAlgorithm

A data type for algorithmic number to word conversions. Most western languages likely can work with this data type.

Instances

Default NumeralsAlgorithm

Defined in Text.Numerals.Languages.English

Methods

def :: NumeralsAlgorithm

NumToWord NumeralsAlgorithm

Defined in Text.Numerals.Algorithm

Methods

toCardinal :: Integral i => NumeralsAlgorithm -> i -> Text

toOrdinal :: Integral i => NumeralsAlgorithm -> i -> Text

toShortOrdinal :: Integral i => NumeralsAlgorithm -> i -> Text

toWords :: Integral i => NumberType -> NumeralsAlgorithm -> i -> Text

toTimeText :: NumeralsAlgorithm -> TimeOfDay -> Text

toTimeText' :: NumeralsAlgorithm -> Int -> Int -> Text

numeralsAlgorithm :: (Foldable f, Foldable g) => Text -> Text -> Text -> f Text -> g (Integer, Text) -> FreeValueSplitter -> FreeMergerFunction -> (Text -> Text) -> FreeNumberToWords -> ClockText -> NumeralsAlgorithm

A smart constructor for the NumeralsAlgorithm type. This constructor allows one to use an arbitrary Foldable type for the low words and mid words. It will also order the midwords accordingly.

Large number algorithms

data HighNumberAlgorithm

A data type used for to map larger numbers to words. This data type supports the short scale and long scale with Latin prefixes, and custom suffixes. The Default value is the short scale with illion as suffix. This is used in English for large numbers.

Constructors

ShortScale Text

LongScale Text Text

Instances

Eq HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

(==) :: HighNumberAlgorithm -> HighNumberAlgorithm -> Bool

(/=) :: HighNumberAlgorithm -> HighNumberAlgorithm -> Bool

Data HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HighNumberAlgorithm -> c HighNumberAlgorithm

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HighNumberAlgorithm

toConstr :: HighNumberAlgorithm -> Constr

dataTypeOf :: HighNumberAlgorithm -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HighNumberAlgorithm)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HighNumberAlgorithm)

gmapT :: (forall b. Data b => b -> b) -> HighNumberAlgorithm -> HighNumberAlgorithm

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HighNumberAlgorithm -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HighNumberAlgorithm -> r

gmapQ :: (forall d. Data d => d -> u) -> HighNumberAlgorithm -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> HighNumberAlgorithm -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> HighNumberAlgorithm -> m HighNumberAlgorithm

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HighNumberAlgorithm -> m HighNumberAlgorithm

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HighNumberAlgorithm -> m HighNumberAlgorithm

Ord HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

compare :: HighNumberAlgorithm -> HighNumberAlgorithm -> Ordering

(<) :: HighNumberAlgorithm -> HighNumberAlgorithm -> Bool

(<=) :: HighNumberAlgorithm -> HighNumberAlgorithm -> Bool

(>) :: HighNumberAlgorithm -> HighNumberAlgorithm -> Bool

(>=) :: HighNumberAlgorithm -> HighNumberAlgorithm -> Bool

max :: HighNumberAlgorithm -> HighNumberAlgorithm -> HighNumberAlgorithm

min :: HighNumberAlgorithm -> HighNumberAlgorithm -> HighNumberAlgorithm

Read HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

readsPrec :: Int -> ReadS HighNumberAlgorithm

readList :: ReadS [HighNumberAlgorithm]

readPrec :: ReadPrec HighNumberAlgorithm

readListPrec :: ReadPrec [HighNumberAlgorithm]

Show HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

showsPrec :: Int -> HighNumberAlgorithm -> ShowS

show :: HighNumberAlgorithm -> String

showList :: [HighNumberAlgorithm] -> ShowS

Generic HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Associated Types

type Rep HighNumberAlgorithm :: Type -> Type

Methods

from :: HighNumberAlgorithm -> Rep HighNumberAlgorithm x

to :: Rep HighNumberAlgorithm x -> HighNumberAlgorithm

Arbitrary HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

arbitrary :: Gen HighNumberAlgorithm

shrink :: HighNumberAlgorithm -> [HighNumberAlgorithm]

Default HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

def :: HighNumberAlgorithm

NFData HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

rnf :: HighNumberAlgorithm -> ()

ValueSplit HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

valueSplit :: HighNumberAlgorithm -> FreeValueSplitter

type Rep HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

type Rep HighNumberAlgorithm = D1 ('MetaData "HighNumberAlgorithm" "Text.Numerals.Algorithm" "ordinal-0.5.0.0-EO9ST13hFnV3ZkeDBMRak1" 'False) (C1 ('MetaCons "ShortScale" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "LongScale" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

shortScale :: Text -> FreeValueSplitter

Construct a FreeValueSplitter function for the given suffix for a short scale.

longScale :: Text -> Text -> FreeValueSplitter

Construct a FreeValueSplitter function for the given suffixes for a long scale.

shortScaleTitle :: Text -> FreeValueSplitter

Construct a FreeValueSplitter function for the given suffix for a short scale, the names are written in title case.

longScaleTitle :: Text -> Text -> FreeValueSplitter

Construct a FreeValueSplitter function for the given suffixes for a long scale, the names are written in title case.

valueSplit'

Arguments

:: (Text -> Text)

The post-processing function.

-> HighNumberAlgorithm

The HighNumberAlgorithm that is used.

-> FreeValueSplitter

The FreeValueSplitter result.

Generate a value splitter for a HighNumberAlgorithm but where the result is post-processed by a function.

Conversion to a NumberSegment

toSegments

Arguments

:: Integral i

=> Vector Text

A Vector of low words.

-> [(Integer, Text)]

The list of name and the names of these numbers in descending order for the mid words.

-> ValueSplitter i

The ValueSplitter used for large numbers, likely a splitter from a short scale or long scale.

-> NumberSegmenting i

The function that maps the number to the NumberSegment.

Convert the given number to a NumberSegment with the given Vector of low numbers, the sorted list of mid numbers, and a FreeValueSplitter for large numbers.

toSegmentLow

Arguments

:: Integral i

=> Vector Text

A Vector of low words.

-> NumberSegmenting i

The function that maps the number to the NumberSegment.

Convert the given number to a NumberSegment with the given Vector of low numbers. Mid words and large numbers are not taken into account. This is often the next step after the toSegmentMid.

toSegmentMid

Arguments

:: Integral i

=> Vector Text

A Vector of low words.

-> [(Integer, Text)]

The list of name and the names of these numbers in descending order for the mid words.

-> NumberSegmenting i

The function that maps the number to the NumberSegment.

Convert the given number to a NumberSegment with the given Vector of low numbers, and the sorted list of mid numbers. Large numbers are not taken into account. This is often the next step after the toSegmentHigh.

toSegmentHigh

Arguments

:: Integral i

=> Vector Text

A Vector of low words.

-> [(Integer, Text)]

The list of name and the names of these numbers in descending order for the mid words.

-> ValueSplitter i

The ValueSplitter used for large numbers, likely a splitter from a short scale or long scale.

-> NumberSegmenting i

The function that maps the number to the NumberSegment.

Convert the given number to a NumberSegment with the given Vector of low numbers, the sorted list of mid numbers, and a FreeValueSplitter for large numbers.

Segment compression

compressSegments

Arguments

:: Integral i

=> Text

The value used for one in the specific language.

-> MergerFunction i

The MergerFunction for the specific language that implements the grammar rules how to merge values.

-> NumberSegment i

The given NumberSegment value to turn into a Text object.

-> Text

The Text object that contains the name of the number stored in the NumberSegment.

Use the given MergerFunction to compress the NumberSegment to a single Text object that represents the given number.