mathutil

package

v0.0.0-...-957a8c4 Latest Latest Go to latest Published: Sep 17, 2023 License: Unlicense Imports: 1 Imported by: 0

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/nhakims/golibs

Documentation ¶

Overview ¶

Package mathutil contains generic helpers for common algorithms and mathematic operations.

Index ¶

func BoolToNumber[T Number](cond bool) (res T)
func Max[T constraints.Integer | ~string](x, y T) (res T)
func Min[T constraints.Integer | ~string](x, y T) (res T)
type Number

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BoolToNumber ¶

func BoolToNumber[T Number](cond bool) (res T)

BoolToNumber returns 1 if cond is true and 0 otherwise.

Example ¶

package main

import (
	"fmt"

	"github.com/AdguardTeam/golibs/mathutil"
)

func main() {
	fmt.Println(mathutil.BoolToNumber[int](true))
	fmt.Println(mathutil.BoolToNumber[int](false))

	type flag float64
	fmt.Println(mathutil.BoolToNumber[flag](true))
	fmt.Println(mathutil.BoolToNumber[flag](false))

}

Output:

1
0
1
0

func Max ¶

func Max[T constraints.Integer | ~string](x, y T) (res T)

Max returns the larger of x or y.

Example ¶

package main

import (
	"fmt"

	"github.com/AdguardTeam/golibs/mathutil"
)

func main() {
	fmt.Println(mathutil.Max(1, 2))
	fmt.Println(mathutil.Max(2, 1))

}

Output:

2
2

func Min ¶

func Min[T constraints.Integer | ~string](x, y T) (res T)

Min returns the smaller of x or y.

Example ¶

package main

import (
	"fmt"

	"github.com/AdguardTeam/golibs/mathutil"
)

func main() {
	fmt.Println(mathutil.Min(1, 2))
	fmt.Println(mathutil.Min(2, 1))

}

Output:

1
1

Types ¶

type Number ¶

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

Number is a type constraint for all numbers.

Source Files ¶

View all Source files

mathutil.go

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