numutil

Documentation

Overview

Package numutil implements number helpers

Index

• func ChangeByPercent[T Number](value T, percent float64) float64
• func Drawdown[T Number](high T, regular T) float64
• func Percent[T Number](percent T, total T) float64
• func PercentDiff[T Number](before T, after T) float64
• func PercentOf[T Number](part T, total T) float64
• func Round[T float32 | float64](value T, precision uint) float64
• type Number

Functions

func ChangeByPercent

func ChangeByPercent[T Number](value T, percent float64) float64

ChangeByPercent calculates change of given number by given percent

func Drawdown

func Drawdown[T Number](high T, regular T) float64

Drawdown calculates percentage of the peak value

func Percent

func Percent[T Number](percent T, total T) float64

Percent calculates value of given <percent> from given <total>

func PercentDiff

func PercentDiff[T Number](before T, after T) float64

PercentDiff calculates percentage difference between two numbers

func PercentOf

func PercentOf[T Number](part T, total T) float64

PercentOf calculates what percent <part> of <total>

func Round

func Round[T float32 | float64](value T, precision uint) float64

Round rounds given float number to given precision (decimal digits)

Types

type Number

type Number interface {
	constraints.Integer | constraints.Float
}

Number is a constraint that covers any integer or float type