mathutil

package

v12.120.0 Latest Latest Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 1 Imported by: 18

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/essentialkaos/ek

Links

Open Source Insights

Documentation ¶

Overview ¶

Package mathutil provides some additional math methods

Index ¶

func Abs[N NumericNeg](val N) N
func Between[N Numeric](val, min, max N) N
func Max[N Numeric](val1, val2 N) N
func Min[N Numeric](val1, val2 N) N
func Perc[N Numeric](val1, val2 N) float64
func Round(v float64, p int) float64
type Numeric
type NumericNeg

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Abs ¶

func Abs[N NumericNeg](val N) N

Abs returns absolute value

Example ¶

fmt.Println(Abs(10))
fmt.Println(Abs(-10))

Output:

10
10

func Between ¶

func Between[N Numeric](val, min, max N) N

Between returns value between min and max values

Example ¶

fmt.Println(Between(10, 1, 5))
fmt.Println(Between(-3, 1, 5))
fmt.Println(Between(4, 1, 5))

Output:

5
1
4

func Max ¶

func Max[N Numeric](val1, val2 N) N

Max returns a greater value

Example ¶

fmt.Println(Max(1, 10))
fmt.Println(Max(3, -3))

Output:

10
3

func Min ¶

func Min[N Numeric](val1, val2 N) N

Min returns a smaller value

Example ¶

fmt.Println(Min(1, 10))
fmt.Println(Min(3, -3))

Output:

1
-3

func Perc ¶ added in v12.98.0

func Perc[N Numeric](val1, val2 N) float64

Perc calculates percentage

Example ¶

fmt.Printf("%g%%\n", Perc(180, 600))

Output:

30%

func Round ¶

func Round(v float64, p int) float64

Round returns rounded value

Example ¶

fmt.Println(Round(3.14159, 2))

Output:

3.14

Types ¶

type Numeric ¶ added in v12.72.0

type Numeric interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64 |
		~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr |
		~float32 | ~float64
}

type NumericNeg ¶ added in v12.72.0

type NumericNeg interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64 | ~float32 | ~float64
}

Source Files ¶

View all Source files

mathutil.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL