Data.FormatN

Formatting of Doubles.

Documentation

data FormatN

Wrapper for the various formatting options.

>>> defaultFormatN
FormatComma 2

Constructors

FormatFixed Int

FormatDecimal Int

FormatComma Int

FormatExpt Int

FormatPrec Int

FormatDollar Int

FormatPercent Int

FormatNone

Instances

Eq FormatN

Defined in Data.FormatN

Methods

(==) :: FormatN -> FormatN -> Bool

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

Show FormatN

Defined in Data.FormatN

Methods

showsPrec :: Int -> FormatN -> ShowS

show :: FormatN -> String

showList :: [FormatN] -> ShowS

Generic FormatN

Defined in Data.FormatN

Associated Types

type Rep FormatN :: Type -> Type

Methods

from :: FormatN -> Rep FormatN x

to :: Rep FormatN x -> FormatN

type Rep FormatN

Defined in Data.FormatN

type Rep FormatN = D1 ('MetaData "FormatN" "Data.FormatN" "formatn-0.0.1-Eak7ymvexS2z3MaCWle8A" 'False) (((C1 ('MetaCons "FormatFixed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "FormatDecimal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "FormatComma" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "FormatExpt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))) :+: ((C1 ('MetaCons "FormatPrec" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "FormatDollar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "FormatPercent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "FormatNone" 'PrefixI 'False) (U1 :: Type -> Type))))

defaultFormatN :: FormatN

The official format

fromFormatN :: IsString s => FormatN -> s

type textifier

toFormatN :: (Eq s, IsString s) => s -> Int -> FormatN

type readifier

fixed :: Int -> Double -> Text

to x decimal places

>>> fixed 2 1
"1.00"

>>> fixed 2 0.001
"0.00"

decimal :: Int -> Double -> Text

round to n significant figures and always use decimal notation

>>> decimal 2 0.000001234
"0.00000123"

>>> decimal 2 1234567
"1230000"

prec :: Int -> Double -> Text

format numbers between 0.001 and 1,000,000 using digit and comma notation and exponential outside this range, with x significant figures.

>>> prec 1 0.00234
"0.0023"

>>> prec 1 0.000023
"2.3e-5"

>>> prec 1 123
"120"

>>> prec 1 123456
"120000"

>>> prec 1 1234567
"1.2e6"

comma :: Int -> Double -> Text

add commas format for numbers above 1,000 but below 1 million, otherwise use prec.

>>> comma 2 1234
"1,230"

expt :: Int -> Double -> Text

scientific exponential

>>> expt 2 1234
"1.23e3"

dollar :: Int -> Double -> Text

dollars and cents, always decimal notation

>>> dollar 2 1234
"$1,230"

>>> dollar 2 0.01234
"$0.0123"

formatN :: FormatN -> Double -> Text

make text

precision :: (Int -> Double -> Text) -> Int -> [Double] -> [Text]

Provide formatted text for a list of numbers so that they are just distinguished. 'precision commas 2 ticks' means use as much precision as is needed for them to be distinguished, but with at least 2 significant figures.

formatNs :: FormatN -> [Double] -> [Text]

Consistently format a list of doubles.