Struct ElectionScore

pub struct ElectionScore {
    pub minimal_stake: u128,
    pub sum_stake: u128,
    pub sum_stake_squared: u128,
}

The score of an election. This is the main measure of an election’s quality.

By definition, the order of significance in ElectionScore is:

1. minimal_stake.
2. sum_stake.
3. sum_stake_squared.

Fields

minimal_stake: u128

The minimal winner, in terms of total backing stake.

This parameter should be maximized.

sum_stake: u128

The sum of the total backing of all winners.

This parameter should maximized

sum_stake_squared: u128

The sum squared of the total backing of all winners, aka. the variance.

This parameter should be minimized.

Implementations

impl ElectionScore

pub fn pretty(&self, token: &str, decimals: u32) -> String

format the election score in a pretty way with the given token symbol and decimals.

impl ElectionScore

pub fn strict_threshold_better( self, other: ElectionScore, threshold: impl PerThing, ) -> bool

Compares two sets of election scores based on desirability, returning true if self is strictly threshold better than other. In other words, each element of self must be better than other relative to the given threshold.

Evaluation is done based on the order of significance of the fields of ElectionScore.

pub fn strict_better(self, other: ElectionScore) -> bool

Compares two sets of election scores based on desirability, returning true if self is strictly better than other.

Trait Implementations

impl Clone for ElectionScore

fn clone(&self) -> ElectionScore

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ElectionScore

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Decode for ElectionScore

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<ElectionScore, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for ElectionScore

fn default() -> ElectionScore

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ElectionScore

fn deserialize<__D>( __deserializer: __D, ) -> Result<ElectionScore, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for ElectionScore

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl MaxEncodedLen for ElectionScore

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl Ord for ElectionScore

fn cmp(&self, other: &ElectionScore) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ElectionScore

fn eq(&self, other: &ElectionScore) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ElectionScore

fn partial_cmp(&self, other: &ElectionScore) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ElectionScore

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeInfo for ElectionScore

type Identity = ElectionScore

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for ElectionScore

impl DecodeWithMemTracking for ElectionScore

impl EncodeLike for ElectionScore

impl Eq for ElectionScore

impl StructuralPartialEq for ElectionScore