xmath

Documentation

Overview

Package xmath extends the Go standard library package math by providing additional mathematical functions.

Index

• func DimInt(x, y int) int
• func DimInt64(x, y int64) int64
• func DimUint(x, y uint) uint
• func DimUint64(x, y uint64) uint64
• func MaxInt(x, y int) int
• func MaxInt64(x, y int64) int64
• func MaxUint(x, y uint) uint
• func MaxUint64(x, y uint64) uint64
• func MinInt(x, y int) int
• func MinInt64(x, y int64) int64
• func MinUint(x, y uint) uint
• func MinUint64(x, y uint64) uint64

Examples

• DimInt
• DimInt64
• DimUint
• DimUint64
• MaxInt
• MaxInt64
• MaxUint
• MaxUint64
• MinInt
• MinInt64
• MinUint
• MinUint64

Functions

func DimInt

func DimInt(x, y int) int

DimInt returns the maximum of x-y or 0 with x, y and the return value of type int.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.DimInt(4, -2))
	fmt.Printf("%d\n", xmath.DimInt(-4, 2))
}

Output:

6
0

func DimInt64

func DimInt64(x, y int64) int64

DimInt64 returns the maximum of x-y or 0 with x, y and the return value of type int64.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.DimInt64(4, -2))
	fmt.Printf("%d\n", xmath.DimInt64(-4, 2))
}

Output:

6
0

func DimUint

func DimUint(x, y uint) uint

DimUint returns the maximum of x-y or 0 with x, y and the return value of type uint.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.DimUint(4, 2))
	fmt.Printf("%d\n", xmath.DimUint(4, 6))
}

Output:

2
0

func DimUint64

func DimUint64(x, y uint64) uint64

DimUint64 returns the maximum of x-y or 0 with x, y and the return value of type uint64.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.DimUint64(4, 2))
	fmt.Printf("%d\n", xmath.DimUint64(4, 6))
}

Output:

2
0

func MaxInt

func MaxInt(x, y int) int

MaxInt returns the larger of x or y with x, y and the return value of type int.

Deprecated: From Go 1.21, use the built-in max function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MaxInt(4, 2))
	fmt.Printf("%d\n", xmath.MaxInt(4, -2))
	fmt.Printf("%d\n", xmath.MaxInt(-4, -2))
}

Output:

4
4
-2

func MaxInt64

func MaxInt64(x, y int64) int64

MaxInt64 returns the larger of x or y with x, y and the return value of type int64.

Deprecated: From Go 1.21, use the built-in max function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MaxInt64(4, 2))
	fmt.Printf("%d\n", xmath.MaxInt64(4, -2))
	fmt.Printf("%d\n", xmath.MaxInt64(-4, -2))
}

Output:

4
4
-2

func MaxUint

func MaxUint(x, y uint) uint

MaxUint returns the larger of x or y with x, y and the return value of type uint.

Deprecated: From Go 1.21, use the built-in max function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MaxUint(4, 2))
}

Output:

4

func MaxUint64

func MaxUint64(x, y uint64) uint64

MaxUint64 returns the larger of x or y with x, y and the return value of type uint64.

Deprecated: From Go 1.21, use the built-in max function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MaxUint64(4, 2))
}

Output:

4

func MinInt

func MinInt(x, y int) int

MinInt returns the smaller of x or y with x, y and the return value of type int.

Deprecated: From Go 1.21, use the built-in min function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MinInt(4, 2))
	fmt.Printf("%d\n", xmath.MinInt(4, -2))
	fmt.Printf("%d\n", xmath.MinInt(-4, -2))
}

Output:

2
-2
-4

func MinInt64

func MinInt64(x, y int64) int64

MinInt64 returns the smaller of x or y with x, y and the return value of type int64.

Deprecated: From Go 1.21, use the built-in min function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MinInt64(4, 2))
	fmt.Printf("%d\n", xmath.MinInt64(4, -2))
	fmt.Printf("%d\n", xmath.MinInt64(-4, -2))
}

Output:

2
-2
-4

func MinUint

func MinUint(x, y uint) uint

MinUint returns the smaller of x or y with x, y and the return value of type uint.

Deprecated: From Go 1.21, use the built-in min function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MinUint(4, 2))
}

Output:

2

func MinUint64

func MinUint64(x, y uint64) uint64

MinUint64 returns the smaller of x or y with x, y and the return value of type uint64.

Deprecated: From Go 1.21, use the built-in min function instead.

Example

package main

import (
	"fmt"

	"github.com/jlourenc/xgo/xmath"
)

func main() {
	fmt.Printf("%d\n", xmath.MinUint64(4, 2))
}

Output:

2