numf

Documentation

Overview

Helper functions for handling floats.

Index

• func Compare(x float64, y float64) (max float64, min float64)
• func Contains(slice []float64, s float64) bool
• func Cumsum(slice []float64) []float64
• func Delta(slice []float64) []float64
• func DropNan(slice []float64) []float64
• func FillNan(slice []float64, method string, prefill bool, validTime int) []float64
• func FindIndex(slice []float64, val float64) (int, bool)
• func Insert(slice []float64, idx int, val float64) []float64
• func IsEqualSlice(s1, s2 []float64) bool
• func IsSameSign(x float64, y float64) bool
• func IsValid(value float64) bool
• func MulSlices(s1, s2 []float64) []float64
• func NanSlice(size int) (nanslice []float64)
• func NumRange(start int, end int, step int) (numberrange []float64)
• func RemoveFrom(slice []float64, s int) []float64
• func ReplaceNan(value float64, replacewith float64) float64
• func ReplaceNans(values []float64, replacewith float64) []float64
• func RoundTo(val float64, digits int) float64
• func RoundToNearest(value float64, nearest float64) float64
• func Select(condition bool, i1, i2 float64) float64
• func SetDefault(defaultval float64, confval float64) float64
• func SliceOf(value float64, size int) []float64
• func SwitchIf(condition bool, i1, i2 float64) (float64, float64)
• type Rounded
  • func RoundWithPrefix(v float64, digits int, unit string, prefix string) Rounded

Functions

func Compare

func Compare(x float64, y float64) (max float64, min float64)

Compares and returns maximum and minimum of two floats taking NaNs into account.

func Contains

func Contains(slice []float64, s float64) bool

Checks if given float exists in the slice.

func Cumsum

func Cumsum(slice []float64) []float64

Calculates a slice of cumulative sum from given slice.

func Delta

func Delta(slice []float64) []float64

Returns the delta between all consecutive floats. Returned slice length is one item shorter.

func DropNan

func DropNan(slice []float64) []float64

Drops NaNs from a slice.

func FillNan

func FillNan(slice []float64, method string, prefill bool, validTime int) []float64

Fills NaN values with a value based on given method:

"previous" // fills the NaNs with previous value
"linear"   // fills the NaNs with linear interpolation

Filling starts from first valid value, thus leaving any preceding NaNs untouched. By setting prefill = true, first valid value is used to replace also the preceding NaNs.

One sample's lifetime can be set by setting validTime value to > 0. Filling is then performed for validTime samples. Using validTime overrides prefill = true -setting

func FindIndex

func FindIndex(slice []float64, val float64) (int, bool)

Finds the index of first occurrence of the given value.

func Insert

func Insert(slice []float64, idx int, val float64) []float64

Inserts given value to given index into a slice.

func IsEqualSlice

func IsEqualSlice(s1, s2 []float64) bool

Checks if two slices are equal, element-wise. NaN and Inf are also handled.

func IsSameSign

func IsSameSign(x float64, y float64) bool

Checks if two values have same sign. Zero sign is ambiguous and is considered to be both positive and negative.

func IsValid

func IsValid(value float64) bool

Checks whether the given float is a valid number instead of NaN or Inf.

func MulSlices

func MulSlices(s1, s2 []float64) []float64

Multiplies two slices of same length element-wise.

func NanSlice

func NanSlice(size int) (nanslice []float64)

Creates a slice of NaNs of given size.

func NumRange

func NumRange(start int, end int, step int) (numberrange []float64)

Returns an evenly spaced slice of floats, between <start> and <end> with spacing <step>.

func RemoveFrom

func RemoveFrom(slice []float64, s int) []float64

Removes an integer from given index

func ReplaceNan

func ReplaceNan(value float64, replacewith float64) float64

Replaces given value with a new one, if given value is NaN or Inf.

func ReplaceNans

func ReplaceNans(values []float64, replacewith float64) []float64

Replaces all NaNs in a slice with given value.

func RoundTo

func RoundTo(val float64, digits int) float64

Rounds the number to given significant digits.

func RoundToNearest

func RoundToNearest(value float64, nearest float64) float64

Rounds <value> to <nearest> value

func Select

func Select(condition bool, i1, i2 float64) float64

Returns i1 if condition == TRUE, else returns i2

func SetDefault

func SetDefault(defaultval float64, confval float64) float64

Replaces default value for a parameter, if the configuration value is zero (ie. initialized empty variable). Note that the function does not make any difference, if the configuration is set to zero on purpose.

func SliceOf

func SliceOf(value float64, size int) []float64

Creates a slice of given size filled with given value.

func SwitchIf

func SwitchIf(condition bool, i1, i2 float64) (float64, float64)

Returns the given values without changes, if condition == FALSE. Returns the values in switched order, if condition == TRUE.

Types

type Rounded

type Rounded struct {
	Rawvalue       float64 // raw value with given digits but no prefix
	Prefix         string  // prefix string
	Value          float64 // rounded value with given digits and prefix
	Response       string  // response string as <Value> <Prefix><unit>
	Prettyvalue    float64 // rounded value with one decimal
	Prettyresponse string  // response string as <Value> <Prefix><unit> ; if value is <0.1 , shows "less than 0.1"
}

func RoundWithPrefix

func RoundWithPrefix(v float64, digits int, unit string, prefix string) Rounded

Returns the rounded value to given digits and correct prefix (M for Megas, k for Kilos etc.) Special case is abs(value) between 1000....10000, which is not converted to kilos (because it looks nicer) set prefix to force certain prefix, otherwise the function figures it out on its' own. These units are excluded from having a prefix

noprefixUnits := []string{"%", "cycles", "years", "°c", "°lon", "°lat", "events", "", " "}