decmath

Documentation

Index

• Variables
• func Average(ds []math.LegacyDec) (math.LegacyDec, error)
• func Max(ds []math.LegacyDec) (math.LegacyDec, error)
• func Median(ds []math.LegacyDec) (math.LegacyDec, error)
• func MedianDeviation(median math.LegacyDec, ds []math.LegacyDec) (math.LegacyDec, error)
• func Min(ds []math.LegacyDec) (math.LegacyDec, error)
• func NewDecFromFloat(f float64) (math.LegacyDec, error)

Variables

var ErrEmptyList = fmt.Errorf("empty price list passed in")

Functions

func Average

func Average(ds []math.LegacyDec) (math.LegacyDec, error)

Average returns the average value of a list of math.LegacyDec. Returns error if ds is empty list.

func Max

func Max(ds []math.LegacyDec) (math.LegacyDec, error)

Max returns the max value of a list of math.LegacyDec. Returns error if ds is empty list.

func Median

func Median(ds []math.LegacyDec) (math.LegacyDec, error)

Median returns the median of a list of math.LegacyDec. Returns error if ds is empty list.

func MedianDeviation

func MedianDeviation(median math.LegacyDec, ds []math.LegacyDec) (math.LegacyDec, error)

MedianDeviation returns the standard deviation around the median of a list of math.LegacyDec. Returns error if ds is empty list. MedianDeviation = ∑((d - median)^2 / len(ds))

func Min

func Min(ds []math.LegacyDec) (math.LegacyDec, error)

Min returns the min value of a list of math.LegacyDec. Returns error if ds is empty list.

func NewDecFromFloat

func NewDecFromFloat(f float64) (math.LegacyDec, error)

NewDecFromFloat converts a float64 into a math.LegacyDec. Returns error if float64 cannot be converted into a string, or into a subsequent math.LegacyDec.