Enum Curve

pub enum Curve {
    LinearDecreasing {
        length: Perbill,
        floor: Perbill,
        ceil: Perbill,
    },
    SteppedDecreasing {
        begin: Perbill,
        end: Perbill,
        step: Perbill,
        period: Perbill,
    },
    Reciprocal {
        factor: FixedI64,
        x_offset: FixedI64,
        y_offset: FixedI64,
    },
}

Type for describing a curve over the 2-dimensional space of axes between 0-1, as represented by (Perbill, Perbill).

Variants

LinearDecreasing

Linear curve starting at (0, ceil), proceeding linearly to (length, floor), then remaining at floor until the end of the period.

Fields

length: Perbill

floor: Perbill

ceil: Perbill

SteppedDecreasing

Stepped curve, beginning at (0, begin), then remaining constant for period, at which point it steps down to (period, begin - step). It then remains constant for another period before stepping down to (period * 2, begin - step * 2). This pattern continues but the y component has a lower limit of end.

Fields

begin: Perbill

end: Perbill

step: Perbill

period: Perbill

Reciprocal

A recipocal (K/(x+S)-T) curve: factor is K and x_offset is S, y_offset is T.

Fields

factor: FixedI64

x_offset: FixedI64

y_offset: FixedI64

Implementations

impl Curve

pub const fn make_linear( length: u128, period: u128, floor: FixedI64, ceil: FixedI64, ) -> Curve

Create a Curve::Linear instance from a high-level description.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub const fn make_reciprocal( delay: u128, period: u128, level: FixedI64, floor: FixedI64, ceil: FixedI64, ) -> Curve

Create a Curve::Reciprocal instance from a high-level description.

WARNING: This is a const function designed for convenient use at build time and will panic on overflow. Ensure that any inputs are sensible.

pub fn info(&self, days: u32, name: impl Display)

Print some info on the curve.

pub fn threshold(&self, x: Perbill) -> Perbill

Determine the y value for the given x value.

pub fn delay(&self, y: Perbill) -> Perbill

Determine the smallest x value such that passing returns true when passed along with the given y value.

If passing never returns true for any value of x when paired with y, then Perbill::one may be returned.

let c = Curve::LinearDecreasing { begin: Perbill::one(), delta: Perbill::one() };
//      ^^^ Can be any curve.
let y = Perbill::from_percent(50);
//      ^^^ Can be any value.
let x = c.delay(y);
assert!(c.passing(x, y));

pub fn passing(&self, x: Perbill, y: Perbill) -> bool

Return true iff the y value is greater than the curve at the x.

Trait Implementations

impl Clone for Curve

fn clone(&self) -> Curve

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Curve

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

Formats the value using the given formatter.

impl Decode for Curve

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

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 Encode for Curve

fn size_hint(&self) -> usize

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

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

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 Curve

fn max_encoded_len() -> usize

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

impl PartialEq for Curve

fn eq(&self, other: &Curve) -> 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 TypeInfo for Curve

type Identity = Curve

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl DecodeWithMemTracking for Curve

impl EncodeLike for Curve

impl Eq for Curve

impl StructuralPartialEq for Curve