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

Cardano.Pool.Rank.Likelihood

Contents

Pool performance estimate from historical block production
Likelihood computations

Description

This module provides a maximum likelhood estimator for pool performance.

Copy & paste of the original implementation in

cardano-ledgererasshelleyimplsrcCardanoLedgerShelleyPoolRank.hs

The copy was made in order to reduce (transitive) dependencies.

Synopsis

data BlockProduction = BlockProduction {
- blocksProduced :: ! Natural
- stakeRelative :: ! Rational
}
newtype PerformanceEstimate = PerformanceEstimate {
- unPerformanceEstimate :: Double
}
estimatePoolPerformance :: SlottingParameters -> DecentralizationLevel -> Seq BlockProduction -> PerformanceEstimate
newtype LogWeight = LogWeight {
- unLogWeight :: Float
}
newtype Likelihood = Likelihood {
- unLikelihood :: StrictSeq LogWeight
}
likelihood :: Natural -> Double -> EpochSize -> Likelihood
applyDecay :: Float -> Likelihood -> Likelihood
newtype Histogram = Histogram {
- unHistogram :: StrictSeq LogWeight
}
percentile' :: Likelihood -> PerformanceEstimate

Pool performance estimate from historical block production

data BlockProduction Source #

Information about block production of a pool in one epoch.

Constructors

BlockProduction
Fields blocksProduced :: ! Natural Blocks produced in the given epoch. stakeRelative :: ! Rational Relative stake of the pool that was relevant for block production. (i.e. from the "set" snapshot).

newtype PerformanceEstimate Source #

This is a estimate of the proportion of allowed blocks a pool will make in the future. It is used for ranking pools in delegation.

Constructors

PerformanceEstimate
Fields unPerformanceEstimate :: Double

Instances

Instances details

Eq PerformanceEstimate Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods (==) :: PerformanceEstimate -> PerformanceEstimate -> Bool Source # (/=) :: PerformanceEstimate -> PerformanceEstimate -> Bool Source #
Show PerformanceEstimate Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods showsPrec :: Int -> PerformanceEstimate -> ShowS Source # show :: PerformanceEstimate -> String Source # showList :: [ PerformanceEstimate ] -> ShowS Source #
Generic PerformanceEstimate Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Associated Types type Rep PerformanceEstimate :: Type -> Type Source # Methods from :: PerformanceEstimate -> Rep PerformanceEstimate x Source # to :: Rep PerformanceEstimate x -> PerformanceEstimate Source #
NoThunks PerformanceEstimate Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods noThunks :: Context -> PerformanceEstimate -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PerformanceEstimate -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy PerformanceEstimate -> String Source #
type Rep PerformanceEstimate Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood type Rep PerformanceEstimate = D1 (' MetaData "PerformanceEstimate" "Cardano.Pool.Rank.Likelihood" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "PerformanceEstimate" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unPerformanceEstimate") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Double )))

estimatePoolPerformance Source #

Arguments

:: SlottingParameters
-> DecentralizationLevel
-> Seq BlockProduction	Historical block production data. Most recent data comes first . Recent performance weighs more than past performance: Block production from > 25 epochs ago has less than 10% influence on the likelihoods. Block production from > 50 epochs ago has less than 1% influence on the likelihoods and can be ignored.
-> PerformanceEstimate

Estimate the performance of a pool from historical block production data.

Assumes that the SlottingParameters are constant through the given history.

Likelihood computations

newtype LogWeight Source #

Constructors

LogWeight
Fields unLogWeight :: Float

Instances

Instances details

Eq LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods (==) :: LogWeight -> LogWeight -> Bool Source # (/=) :: LogWeight -> LogWeight -> Bool Source #
Num LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods (+) :: LogWeight -> LogWeight -> LogWeight Source # (-) :: LogWeight -> LogWeight -> LogWeight Source # (*) :: LogWeight -> LogWeight -> LogWeight Source # negate :: LogWeight -> LogWeight Source # abs :: LogWeight -> LogWeight Source # signum :: LogWeight -> LogWeight Source # fromInteger :: Integer -> LogWeight Source #
Ord LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods compare :: LogWeight -> LogWeight -> Ordering Source # (<) :: LogWeight -> LogWeight -> Bool Source # (<=) :: LogWeight -> LogWeight -> Bool Source # (>) :: LogWeight -> LogWeight -> Bool Source # (>=) :: LogWeight -> LogWeight -> Bool Source # max :: LogWeight -> LogWeight -> LogWeight Source # min :: LogWeight -> LogWeight -> LogWeight Source #
Show LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods showsPrec :: Int -> LogWeight -> ShowS Source # show :: LogWeight -> String Source # showList :: [ LogWeight ] -> ShowS Source #
Generic LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Associated Types type Rep LogWeight :: Type -> Type Source # Methods from :: LogWeight -> Rep LogWeight x Source # to :: Rep LogWeight x -> LogWeight Source #
NFData LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods rnf :: LogWeight -> () Source #
NoThunks LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods noThunks :: Context -> LogWeight -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> LogWeight -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy LogWeight -> String Source #
type Rep LogWeight Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood type Rep LogWeight = D1 (' MetaData "LogWeight" "Cardano.Pool.Rank.Likelihood" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "LogWeight" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unLogWeight") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Float )))

newtype Likelihood Source #

Constructors

Likelihood
Fields unLikelihood :: StrictSeq LogWeight

Instances

Instances details

Eq Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods (==) :: Likelihood -> Likelihood -> Bool Source # (/=) :: Likelihood -> Likelihood -> Bool Source #
Ord Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods compare :: Likelihood -> Likelihood -> Ordering Source # (<) :: Likelihood -> Likelihood -> Bool Source # (<=) :: Likelihood -> Likelihood -> Bool Source # (>) :: Likelihood -> Likelihood -> Bool Source # (>=) :: Likelihood -> Likelihood -> Bool Source # max :: Likelihood -> Likelihood -> Likelihood Source # min :: Likelihood -> Likelihood -> Likelihood Source #
Show Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods showsPrec :: Int -> Likelihood -> ShowS Source # show :: Likelihood -> String Source # showList :: [ Likelihood ] -> ShowS Source #
Generic Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Associated Types type Rep Likelihood :: Type -> Type Source # Methods from :: Likelihood -> Rep Likelihood x Source # to :: Rep Likelihood x -> Likelihood Source #
Semigroup Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods (<>) :: Likelihood -> Likelihood -> Likelihood Source # sconcat :: NonEmpty Likelihood -> Likelihood Source # stimes :: Integral b => b -> Likelihood -> Likelihood Source #
Monoid Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods mempty :: Likelihood Source # mappend :: Likelihood -> Likelihood -> Likelihood Source # mconcat :: [ Likelihood ] -> Likelihood Source #
NFData Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods rnf :: Likelihood -> () Source #
NoThunks Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods noThunks :: Context -> Likelihood -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Likelihood -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Likelihood -> String Source #
type Rep Likelihood Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood type Rep Likelihood = D1 (' MetaData "Likelihood" "Cardano.Pool.Rank.Likelihood" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "Likelihood" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unLikelihood") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( StrictSeq LogWeight ))))

likelihood :: Natural -> Double -> EpochSize -> Likelihood Source #

applyDecay :: Float -> Likelihood -> Likelihood Source #

Decay previous likelihood

newtype Histogram Source #

Constructors

Histogram
Fields unHistogram :: StrictSeq LogWeight

Instances

Instances details

Eq Histogram Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods (==) :: Histogram -> Histogram -> Bool Source # (/=) :: Histogram -> Histogram -> Bool Source #
Show Histogram Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Methods showsPrec :: Int -> Histogram -> ShowS Source # show :: Histogram -> String Source # showList :: [ Histogram ] -> ShowS Source #
Generic Histogram Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood Associated Types type Rep Histogram :: Type -> Type Source # Methods from :: Histogram -> Rep Histogram x Source # to :: Rep Histogram x -> Histogram Source #
type Rep Histogram Source #
Instance details Defined in Cardano.Pool.Rank.Likelihood type Rep Histogram = D1 (' MetaData "Histogram" "Cardano.Pool.Rank.Likelihood" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' True ) ( C1 (' MetaCons "Histogram" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unHistogram") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( StrictSeq LogWeight ))))

percentile' :: Likelihood -> PerformanceEstimate Source #