Text.Numerals.Class

A module that defines the typeclasses that are used in the rest of the module. The NumToWord class is the typeclass that is used by all algorithmic conversion tools.

Typeclasses

class NumToWord a where

A type class used for num to word algorithms. It maps an Integral type i to Text.

Minimal complete definition

toCardinal, toOrdinal, toShortOrdinal | toWords

Methods

toCardinal

Arguments

:: Integral i

=> a

The conversion algorithm that transforms the number into words.

-> i

The number to transform into a cardinal form.

-> Text

The number in words in a cardinal form.

Convert the given number to a Text object that is the given number in words in cardinal form.

toOrdinal

Arguments

:: Integral i

=> a

The conversion algorithm that transforms the number into words.

-> i

The number to transform into a ordinal form.

-> Text

The number in words in a ordinal form.

Convert the given number to a Text object that is the given number in words in cardinal form.

toShortOrdinal

Arguments

:: Integral i

=> a

The conversion algorithm that transforms the number into words.

-> i

The number to transform into a ordinal form.

-> Text

The number in words in a ordinal form.

Convert the given number to a Text object that is the given number in words in short cardinal form.

toWords

Arguments

:: Integral i

=> NumberType

The given format to convert the number to.

-> a

The conversion algorithm that transforms the number into words.

-> i

The number to transform into the given form.

-> Text

The number in words in the given form.

Convert the given number to a Text object that is the given number in words in the given NumberType.

Instances

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

class ValueSplit a where

A type class used to split a value, based on the name of a number in a specific language. The value that is used to split, is often, depending on the language, the largest value smaller than the given number.

Methods

valueSplit :: a -> FreeValueSplitter

A function that takes an Integral value, and based on the object splits it with a value and the name of the number in a specific language.

Instances

ValueSplit HighNumberAlgorithm

Defined in Text.Numerals.Algorithm

Methods

valueSplit :: HighNumberAlgorithm -> FreeValueSplitter

Types of numbers

data NumberType

A data type that specifies the different types of numbers. These can be used to specify the "target format". The Default number type is Cardinal.

Constructors

Cardinal

Cardinal numbers like one, two, three, etc.

Ordinal

Ordinal numbers like first, second, third, etc.

ShortOrdinal

Short ordinal numbers like 1st, 2nd, 3rd, etc.

Instances

Bounded NumberType

Defined in Text.Numerals.Class

Methods

minBound :: NumberType

maxBound :: NumberType

Enum NumberType

Defined in Text.Numerals.Class

Methods

succ :: NumberType -> NumberType

pred :: NumberType -> NumberType

toEnum :: Int -> NumberType

fromEnum :: NumberType -> Int

enumFrom :: NumberType -> [NumberType]

enumFromThen :: NumberType -> NumberType -> [NumberType]

enumFromTo :: NumberType -> NumberType -> [NumberType]

enumFromThenTo :: NumberType -> NumberType -> NumberType -> [NumberType]

Eq NumberType

Defined in Text.Numerals.Class

Methods

(==) :: NumberType -> NumberType -> Bool

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

Ord NumberType

Defined in Text.Numerals.Class

Methods

compare :: NumberType -> NumberType -> Ordering

(<) :: NumberType -> NumberType -> Bool

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

(>) :: NumberType -> NumberType -> Bool

(>=) :: NumberType -> NumberType -> Bool

max :: NumberType -> NumberType -> NumberType

min :: NumberType -> NumberType -> NumberType

Read NumberType

Defined in Text.Numerals.Class

Methods

readsPrec :: Int -> ReadS NumberType

readList :: ReadS [NumberType]

readPrec :: ReadPrec NumberType

readListPrec :: ReadPrec [NumberType]

Show NumberType

Defined in Text.Numerals.Class

Methods

showsPrec :: Int -> NumberType -> ShowS

show :: NumberType -> String

showList :: [NumberType] -> ShowS

Default NumberType

Defined in Text.Numerals.Class

Methods

def :: NumberType

Segmenting a number

data NumberSegment i

A data type used to convert a number into segments. Each segment has an optional division and remainder part, together with a value and the name of that value in a language.

Constructors

NumberSegment

Fields

• segmentDivision :: MNumberSegment i

  The optional division part. Nothing if the division is equal to one.

• segmentValue :: i

  The value of the given segment.

• segmentText :: Text

  The name of the value of the given segment, in a specific language.

• segmentRemainder :: MNumberSegment i

  The optional remainder part. Nothing if the remainder is equal to zero.

Instances

Functor NumberSegment

Defined in Text.Numerals.Class

Methods

fmap :: (a -> b) -> NumberSegment a -> NumberSegment b

(<$) :: a -> NumberSegment b -> NumberSegment a

Foldable NumberSegment

Defined in Text.Numerals.Class

Methods

fold :: Monoid m => NumberSegment m -> m

foldMap :: Monoid m => (a -> m) -> NumberSegment a -> m

foldr :: (a -> b -> b) -> b -> NumberSegment a -> b

foldr' :: (a -> b -> b) -> b -> NumberSegment a -> b

foldl :: (b -> a -> b) -> b -> NumberSegment a -> b

foldl' :: (b -> a -> b) -> b -> NumberSegment a -> b

foldr1 :: (a -> a -> a) -> NumberSegment a -> a

foldl1 :: (a -> a -> a) -> NumberSegment a -> a

toList :: NumberSegment a -> [a]

null :: NumberSegment a -> Bool

length :: NumberSegment a -> Int

elem :: Eq a => a -> NumberSegment a -> Bool

maximum :: Ord a => NumberSegment a -> a

minimum :: Ord a => NumberSegment a -> a

sum :: Num a => NumberSegment a -> a

product :: Num a => NumberSegment a -> a

Eq i => Eq (NumberSegment i)

Defined in Text.Numerals.Class

Methods

(==) :: NumberSegment i -> NumberSegment i -> Bool

(/=) :: NumberSegment i -> NumberSegment i -> Bool

Ord i => Ord (NumberSegment i)

Defined in Text.Numerals.Class

Methods

compare :: NumberSegment i -> NumberSegment i -> Ordering

(<) :: NumberSegment i -> NumberSegment i -> Bool

(<=) :: NumberSegment i -> NumberSegment i -> Bool

(>) :: NumberSegment i -> NumberSegment i -> Bool

(>=) :: NumberSegment i -> NumberSegment i -> Bool

max :: NumberSegment i -> NumberSegment i -> NumberSegment i

min :: NumberSegment i -> NumberSegment i -> NumberSegment i

Read i => Read (NumberSegment i)

Defined in Text.Numerals.Class

Methods

readsPrec :: Int -> ReadS (NumberSegment i)

readList :: ReadS [NumberSegment i]

readPrec :: ReadPrec (NumberSegment i)

readListPrec :: ReadPrec [NumberSegment i]

Show i => Show (NumberSegment i)

Defined in Text.Numerals.Class

Methods

showsPrec :: Int -> NumberSegment i -> ShowS

show :: NumberSegment i -> String

showList :: [NumberSegment i] -> ShowS

type MNumberSegment i = Maybe (NumberSegment i)

A Maybe variant of the NumberSegment data type. This is used since the division part can be one, or the remainder part can be zero.

Utility type synonyms

type NumberToWords i = i -> Text

A type alias for a function that maps a number to a Text object.

type FreeNumberToWords = forall i. Integral i => NumberToWords i

A type alias for a NumberToWords function, with a free Integral variable.

type MergerFunction i = i -> i -> Text -> Text -> Text

A type alias of a function that is used to merge the names of two numbers according to gramatical rules. The type parameter is the type of the numbers to merge.

type FreeMergerFunction = forall i. Integral i => MergerFunction i

A type alias of a MergerFunction function with a free Integral variable.

type ValueSplitter i = i -> Maybe (i, Text)

A type alias of a function that maps a number to a 2-tuple that contains a number and the word for that number. This number is normally the largest number smaller than the given number. In case no name exists for a number smaller than the given one Nothing is returned.

type FreeValueSplitter = forall i. Integral i => ValueSplitter i

A type alias of a ValueSplitter function, with a free Integral variable.

type NumberSegmenting i = i -> NumberSegment i

A type alias of a function that converts a number to a NumberSegment for that number.