Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Data.Quantity

Contents

Polymorphic Quantity
Percentage

Description

Representation of values with an associated (free) unit of measure. Useful to disambiguate primitive types like Int or String which can be in different bases depending on the context.

Synopsis

newtype Quantity (unit :: Symbol ) a = Quantity {
- getQuantity :: a
}
data Percentage
data MkPercentageError = PercentageOutOfBoundsError
mkPercentage :: Rational -> Either MkPercentageError Percentage
getPercentage :: Percentage -> Rational
clipToPercentage :: Rational -> Percentage
complementPercentage :: Percentage -> Percentage
percentageToDouble :: Percentage -> Double

Polymorphic Quantity

newtype Quantity (unit :: Symbol ) a Source #

Quantity (unit :: Symbol) a is a primitive a multiplied by an unit .

Example:

Instead of providing the unit implicitly as a comment, or a part of a name

>>> a :: Word32 -- in lovelace

we can write

>>> a :: Quantity "lovelace" Word32

which now has a different type from

>>> b :: Quantity "lovelace/byte" Word32

so mixing them up is more difficult.

The unit is mostly a phantom type, but it is also included in the ToJSON / FromJSON instances.

>>> Aeson.encode $ Quantity @"lovelace" 14
{"unit":"lovelace","quantity":14}

Constructors

Quantity
Fields getQuantity :: a

Instances

Instances details

Functor ( Quantity any) Source #
Instance details Defined in Data.Quantity Methods fmap :: (a -> b) -> Quantity any a -> Quantity any b Source # (<$) :: a -> Quantity any b -> Quantity any a Source #
Bounded a => Bounded ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods minBound :: Quantity unit a Source # maxBound :: Quantity unit a Source #
Enum a => Enum ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods succ :: Quantity unit a -> Quantity unit a Source # pred :: Quantity unit a -> Quantity unit a Source # toEnum :: Int -> Quantity unit a Source # fromEnum :: Quantity unit a -> Int Source # enumFrom :: Quantity unit a -> [ Quantity unit a] Source # enumFromThen :: Quantity unit a -> Quantity unit a -> [ Quantity unit a] Source # enumFromTo :: Quantity unit a -> Quantity unit a -> [ Quantity unit a] Source # enumFromThenTo :: Quantity unit a -> Quantity unit a -> Quantity unit a -> [ Quantity unit a] Source #
Eq a => Eq ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods (==) :: Quantity unit a -> Quantity unit a -> Bool Source # (/=) :: Quantity unit a -> Quantity unit a -> Bool Source #
Ord a => Ord ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods compare :: Quantity unit a -> Quantity unit a -> Ordering Source # (<) :: Quantity unit a -> Quantity unit a -> Bool Source # (<=) :: Quantity unit a -> Quantity unit a -> Bool Source # (>) :: Quantity unit a -> Quantity unit a -> Bool Source # (>=) :: Quantity unit a -> Quantity unit a -> Bool Source # max :: Quantity unit a -> Quantity unit a -> Quantity unit a Source # min :: Quantity unit a -> Quantity unit a -> Quantity unit a Source #
Show a => Show ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods showsPrec :: Int -> Quantity unit a -> ShowS Source # show :: Quantity unit a -> String Source # showList :: [ Quantity unit a] -> ShowS Source #
Generic ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Associated Types type Rep ( Quantity unit a) :: Type -> Type Source # Methods from :: Quantity unit a -> Rep ( Quantity unit a) x Source # to :: Rep ( Quantity unit a) x -> Quantity unit a Source #
NFData a => NFData ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods rnf :: Quantity unit a -> () Source #
Hashable a => Hashable ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods hashWithSalt :: Int -> Quantity unit a -> Int Source # hash :: Quantity unit a -> Int Source #
( KnownSymbol unit, ToJSON a) => ToJSON ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods toJSON :: Quantity unit a -> Value Source # toEncoding :: Quantity unit a -> Encoding Source # toJSONList :: [ Quantity unit a] -> Value Source # toEncodingList :: [ Quantity unit a] -> Encoding Source #
( KnownSymbol unit, FromJSON a) => FromJSON ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods parseJSON :: Value -> Parser ( Quantity unit a) Source # parseJSONList :: Value -> Parser [ Quantity unit a] Source #
( KnownSymbol unit, Buildable a) => Buildable ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods build :: Quantity unit a -> Builder Source #
NoThunks a => NoThunks ( Quantity unit a) Source #
Instance details Defined in Data.Quantity Methods noThunks :: Context -> Quantity unit a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Quantity unit a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( Quantity unit a) -> String Source #
ToText b => ToText ( Quantity sym b) Source #
Instance details Defined in Data.Quantity Methods toText :: Quantity sym b -> Text Source #
FromText b => FromText ( Quantity sym b) Source #
Instance details Defined in Data.Quantity Methods fromText :: Text -> Either TextDecodingError ( Quantity sym b) Source #
type Rep ( Quantity unit a) Source #
Instance details Defined in Data.Quantity type Rep ( Quantity unit a) = D1 (' MetaData "Quantity" "Data.Quantity" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "Quantity" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getQuantity") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 a)))

Percentage

data Percentage Source #

Opaque Haskell type to represent values between 0 and 100 (incl).

Instances

Instances details

Bounded Percentage Source #
Instance details Defined in Data.Quantity Methods minBound :: Percentage Source # maxBound :: Percentage Source #
Eq Percentage Source #
Instance details Defined in Data.Quantity Methods (==) :: Percentage -> Percentage -> Bool Source # (/=) :: Percentage -> Percentage -> Bool Source #
Ord Percentage Source #
Instance details Defined in Data.Quantity Methods compare :: Percentage -> Percentage -> Ordering Source # (<) :: Percentage -> Percentage -> Bool Source # (<=) :: Percentage -> Percentage -> Bool Source # (>) :: Percentage -> Percentage -> Bool Source # (>=) :: Percentage -> Percentage -> Bool Source # max :: Percentage -> Percentage -> Percentage Source # min :: Percentage -> Percentage -> Percentage Source #
Show Percentage Source #
Instance details Defined in Data.Quantity Methods showsPrec :: Int -> Percentage -> ShowS Source # show :: Percentage -> String Source # showList :: [ Percentage ] -> ShowS Source #
Generic Percentage Source #
Instance details Defined in Data.Quantity Associated Types type Rep Percentage :: Type -> Type Source # Methods from :: Percentage -> Rep Percentage x Source # to :: Rep Percentage x -> Percentage Source #
NFData Percentage Source #
Instance details Defined in Data.Quantity Methods rnf :: Percentage -> () Source #
ToJSON Percentage Source #
Instance details Defined in Data.Quantity Methods toJSON :: Percentage -> Value Source # toEncoding :: Percentage -> Encoding Source # toJSONList :: [ Percentage ] -> Value Source # toEncodingList :: [ Percentage ] -> Encoding Source #
FromJSON Percentage Source #
Instance details Defined in Data.Quantity Methods parseJSON :: Value -> Parser Percentage Source # parseJSONList :: Value -> Parser [ Percentage ] Source #
Buildable Percentage Source #
Instance details Defined in Data.Quantity Methods build :: Percentage -> Builder Source #
NoThunks Percentage Source #
Instance details Defined in Data.Quantity Methods noThunks :: Context -> Percentage -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Percentage -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Percentage -> String Source #
PersistFieldSql Percentage Source #
Instance details Defined in Cardano.Wallet.DB.Sqlite.Types Methods sqlType :: Proxy Percentage -> SqlType Source #
PersistField Percentage Source #
Instance details Defined in Cardano.Wallet.DB.Sqlite.Types Methods toPersistValue :: Percentage -> PersistValue Source # fromPersistValue :: PersistValue -> Either Text Percentage Source #
ToText Percentage Source #
Instance details Defined in Data.Quantity Methods toText :: Percentage -> Text Source #
FromText Percentage Source #
Instance details Defined in Data.Quantity Methods fromText :: Text -> Either TextDecodingError Percentage Source #
SymbolToField "protocolParametersDecentralizationLevel" ProtocolParameters Percentage Source #
Instance details Defined in Cardano.Wallet.DB.Sqlite.Schema Methods symbolToField :: EntityField ProtocolParameters Percentage Source #
type Rep Percentage Source #
Instance details Defined in Data.Quantity type Rep Percentage = D1 (' MetaData "Percentage" "Data.Quantity" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "Percentage" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getPercentage") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Rational )))

data MkPercentageError Source #

Constructors

PercentageOutOfBoundsError

Instances

Instances details

Eq MkPercentageError Source #
Instance details Defined in Data.Quantity Methods (==) :: MkPercentageError -> MkPercentageError -> Bool Source # (/=) :: MkPercentageError -> MkPercentageError -> Bool Source #
Show MkPercentageError Source #
Instance details Defined in Data.Quantity Methods showsPrec :: Int -> MkPercentageError -> ShowS Source # show :: MkPercentageError -> String Source # showList :: [ MkPercentageError ] -> ShowS Source #

mkPercentage :: Rational -> Either MkPercentageError Percentage Source #

Safe constructor for Percentage

Takes an input in the range [0, 1].

getPercentage :: Percentage -> Rational Source #

clipToPercentage :: Rational -> Percentage Source #

Safe way to make a Percentage by clipping values that are out of bounds.

complementPercentage :: Percentage -> Percentage Source #

The complement is the amount that is missing to make it 100%.

Example: The complementPercentage of 0.7 is 0.3.

percentageToDouble :: Percentage -> Double Source #

Turn a Percentage to a Double (without any extra rounding.)