mathutil

Documentation

Overview

Package mathutil offers some useful utility functions which are missing from the standard packages.

Index

• func AlmostEqual(a, b, epsilon float64) bool
• func MaxOf(vals ...float64) float64
• func MaxOfInt(vals ...int) int
• func MinOf(vals ...float64) float64
• func MinOfInt(vals ...int) int
• func WithinNPercent(a, b, epsilon float64) bool

Functions

func AlmostEqual

func AlmostEqual(a, b, epsilon float64) bool

AlmostEqual returns true if a and b are within epsilon of one another.

func MaxOf

func MaxOf(vals ...float64) float64

MaxOf returns the greater of the slice of values; it will panic if the slice is empty

func MaxOfInt

func MaxOfInt(vals ...int) int

MaxOfInt returns the greater of the slice of values; it will panic if the slice is empty

func MinOf

func MinOf(vals ...float64) float64

MinOf returns the lesser of the slice of values; it will panic if the slice is empty

func MinOfInt

func MinOfInt(vals ...int) int

MinOfInt returns the lesser of the slice of values; it will panic if the slice is empty

func WithinNPercent

func WithinNPercent(a, b, epsilon float64) bool

WithinNPercent returns true if a and b are within epsilon percent of one another. Strictly speaking the test is for whether the difference between a and b as a proportion of the larger value is less than epsilon. So an epsilon of 10 will test for numbers within 10% of each other Numbers with differing sign are always considered different regardless of proximity