Z.Data.Builder.Numeric

Textual numeric builders.

Integral type formatting

data IFormat

Integral formatting options.

Constructors

IFormat

Fields

• width :: Int

  total width, only effective with padding options

• padding :: Padding

  padding options

• posSign :: Bool

  show + when the number is positive

Instances

Eq IFormat

Defined in Z.Data.Builder.Numeric

Methods

(==) :: IFormat -> IFormat -> Bool

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

Ord IFormat

Defined in Z.Data.Builder.Numeric

Methods

compare :: IFormat -> IFormat -> Ordering

(<) :: IFormat -> IFormat -> Bool

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

(>) :: IFormat -> IFormat -> Bool

(>=) :: IFormat -> IFormat -> Bool

max :: IFormat -> IFormat -> IFormat

min :: IFormat -> IFormat -> IFormat

Show IFormat

Defined in Z.Data.Builder.Numeric

Methods

showsPrec :: Int -> IFormat -> ShowS

show :: IFormat -> String

showList :: [IFormat] -> ShowS

Arbitrary IFormat

Defined in Z.Data.Builder.Numeric

Methods

arbitrary :: Gen IFormat

shrink :: IFormat -> [IFormat]

CoArbitrary IFormat

Defined in Z.Data.Builder.Numeric

Methods

coarbitrary :: IFormat -> Gen b -> Gen b

defaultIFormat :: IFormat

defaultIFormat = IFormat 0 NoPadding False

data Padding

Constructors

NoPadding

RightSpacePadding

LeftSpacePadding

ZeroPadding

Instances

Enum Padding

Defined in Z.Data.Builder.Numeric

Methods

succ :: Padding -> Padding

pred :: Padding -> Padding

toEnum :: Int -> Padding

fromEnum :: Padding -> Int

enumFrom :: Padding -> [Padding]

enumFromThen :: Padding -> Padding -> [Padding]

enumFromTo :: Padding -> Padding -> [Padding]

enumFromThenTo :: Padding -> Padding -> Padding -> [Padding]

Eq Padding

Defined in Z.Data.Builder.Numeric

Methods

(==) :: Padding -> Padding -> Bool

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

Ord Padding

Defined in Z.Data.Builder.Numeric

Methods

compare :: Padding -> Padding -> Ordering

(<) :: Padding -> Padding -> Bool

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

(>) :: Padding -> Padding -> Bool

(>=) :: Padding -> Padding -> Bool

max :: Padding -> Padding -> Padding

min :: Padding -> Padding -> Padding

Show Padding

Defined in Z.Data.Builder.Numeric

Methods

showsPrec :: Int -> Padding -> ShowS

show :: Padding -> String

showList :: [Padding] -> ShowS

Arbitrary Padding

Defined in Z.Data.Builder.Numeric

Methods

arbitrary :: Gen Padding

shrink :: Padding -> [Padding]

CoArbitrary Padding

Defined in Z.Data.Builder.Numeric

Methods

coarbitrary :: Padding -> Gen b -> Gen b

int :: (Integral a, Bounded a) => a -> Builder ()

int = intWith defaultIFormat

intWith :: (Integral a, Bounded a) => IFormat -> a -> Builder ()

Format a Bounded Integral type like Int or Word16 into decimal ASCII digits.

import Z.Data.Builder as B

> B.buildText $ B.intWith defaultIFormat  (12345 :: Int)
"12345"
> B.buildText $ B.intWith defaultIFormat{width=10, padding=RightSpacePadding} (12345 :: Int)
"12345     "
> B.buildText $ B.intWith defaultIFormat{width=10, padding=ZeroPadding} (12345 :: Int)
"0000012345"

integer :: Integer -> Builder ()

Format a Integer into decimal ASCII digits.

Fixded size hexidecimal formatting

hex :: forall a. (FiniteBits a, Integral a) => a -> Builder ()

Format a FiniteBits Integral type into hex nibbles.

import Z.Data.Builder as B
import Z.Data.Text    as T
import Data.Word
import Data.Int

> T.validate . B.build $ B.hex (125 :: Int8)
"7d"
> T.validate . B.build $ B.hex (-1 :: Int8)
"ff"
> T.validate . B.build $ B.hex (125 :: Word16)
"007d"

hexUpper :: forall a. (FiniteBits a, Integral a) => a -> Builder ()

The UPPERCASED version of hex.

IEEE float formating

data FFormat

Control the rendering of floating point numbers.

Constructors

Exponent

Scientific notation (e.g. 2.3e123).

Fixed

Standard decimal notation.

Generic

Use decimal notation for values between 0.1 and 9,999,999, and scientific notation otherwise.

Instances

Enum FFormat

Defined in Z.Data.Builder.Numeric

Methods

succ :: FFormat -> FFormat

pred :: FFormat -> FFormat

toEnum :: Int -> FFormat

fromEnum :: FFormat -> Int

enumFrom :: FFormat -> [FFormat]

enumFromThen :: FFormat -> FFormat -> [FFormat]

enumFromTo :: FFormat -> FFormat -> [FFormat]

enumFromThenTo :: FFormat -> FFormat -> FFormat -> [FFormat]

Read FFormat

Defined in Z.Data.Builder.Numeric

Methods

readsPrec :: Int -> ReadS FFormat

readList :: ReadS [FFormat]

readPrec :: ReadPrec FFormat

readListPrec :: ReadPrec [FFormat]

Show FFormat

Defined in Z.Data.Builder.Numeric

Methods

showsPrec :: Int -> FFormat -> ShowS

show :: FFormat -> String

showList :: [FFormat] -> ShowS

double :: Double -> Builder ()

Decimal encoding of an IEEE Double.

Using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

doubleWith

Arguments

:: FFormat

-> Maybe Int

Number of decimal places to render.

-> Double

-> Builder ()

Format double-precision float using drisu3 with dragon4 fallback.

float :: Float -> Builder ()

Decimal encoding of an IEEE Float.

Using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

floatWith

Arguments

:: FFormat

-> Maybe Int

Number of decimal places to render.

-> Float

-> Builder ()

Format single-precision float using drisu3 with dragon4 fallback.

scientific :: Scientific -> Builder ()

A Builder which renders a scientific number to full precision, using standard decimal notation for arguments whose absolute value lies between 0.1 and 9,999,999, and scientific notation otherwise.

scientific' :: Scientific -> Builder ()

This builder try to avoid scientific notation when 0 <= exponent < 16.

scientificWith

Arguments

:: FFormat

-> Maybe Int

Number of decimal places to render.

-> Scientific

-> Builder ()

Like scientific but provides rendering options.

Misc

grisu3 :: Double -> ([Int], Int)

Decimal encoding of a Double, note grisu only handles strictly positive finite numbers.

grisu3_sp :: Float -> ([Int], Int)

Decimal encoding of a Float, note grisu3_sp only handles strictly positive finite numbers.

i2wDec :: Integral a => a -> Word8

Decimal digit to ASCII digit.

i2wHex :: Integral a => a -> Word8

Hexadecimal digit to ASCII char.

i2wHexUpper :: Integral a => a -> Word8

Hexadecimal digit to UPPERCASED ASCII char.

countDigits :: Integral a => a -> Int

Count how many decimal digits an integer has.

c_intWith :: (Integral a, Bits a) => IFormat -> a -> Builder ()

Internal formatting backed by C FFI, it must be used with type smaller than Word64.

We use rewrite rules to rewrite most of the integral types formatting to this function.

hs_intWith :: (Integral a, Bounded a) => IFormat -> a -> Builder ()

Internal formatting in haskell, it can be used with any bounded integral type.

Other than provide fallback for the c version, this function is also used to check the c version's formatting result.