mathutil

Documentation

Index

• func Abs[T constraints.SignedReal](x T) T
• func Add[T constraints.Number](x, y T) T
• func CeilPowerOfTwo[T constraints.Integer](value T) T
• func Clamp[T constraints.Ordered](x, min, max T) T
• func Damp[T constraints.Float](x, y, lambda, dt T) T
• func Deg2Rad[T constraints.Float](deg T) T
• func Div[T constraints.Number](x, y T) T
• func EuclideanModulo[T constraints.Float](x, y T) T
• func FloorPowerOfTwo[T constraints.Integer](value T) T
• func Identity[T constraints.Number](x T) T
• func InverseLerp[T constraints.Field](x, y, value T) T
• func IsPowerOfTwo[T constraints.Integer](value T) bool
• func IsZero[T constraints.SignedReal](x T) T
• func Lerp[T constraints.Field](x, y, t T) T
• func MapLinear[T constraints.Field](x, a1, a2, b1, b2 T) T
• func Max[T constraints.Ordered](x, y T) T
• func Min[T constraints.Ordered](x, y T) T
• func Minmax[T constraints.Ordered](x, y T) (min, max T)
• func Mul[T constraints.Number](x, y T) T
• func One[T constraints.Number](x T) T
• func PingPong[T constraints.Float](x, length T) T
• func Pow[T constraints.Real](x, y T) T
• func Predict[T constraints.Number](ok bool) T
• func Rad2Deg[T constraints.Float](rad T) T
• func Sigmoid[T constraints.Real](x T) T
• func SigmoidPrime[T constraints.Real](x T) T
• func Sign[T constraints.SignedReal](x T) T
• func SmoothStep[T constraints.Float](x, min, max T) T
• func SmoothStepFunc[T constraints.Float](x, min, max T, fn func(T) T) T
• func Square[T constraints.Number](x T) T
• func Sub[T constraints.Number](x, y T) T
• func Zero[T constraints.Number](x T) T
• type BinaryFn
  • func (f BinaryFn[T]) Add(f2 BinaryFn[T]) BinaryFn[T]
  • func (f BinaryFn[T]) Div(f2 BinaryFn[T]) BinaryFn[T]
  • func (f BinaryFn[T]) Mul(f2 BinaryFn[T]) BinaryFn[T]
  • func (f BinaryFn[T]) Sub(f2 BinaryFn[T]) BinaryFn[T]
• type UnaryFn
  • func Affine[T constraints.Number](k, b T) UnaryFn[T]
  • func Constant[T constraints.Number](c T) UnaryFn[T]
  • func KSigmoid[T constraints.Real](k T) UnaryFn[T]
  • func KSigmoidPrime[T constraints.Real](k T) UnaryFn[T]
  • func Offset[T constraints.Number](b T) UnaryFn[T]
  • func Power[T constraints.Real](p T) UnaryFn[T]
  • func Scale[T constraints.Number](k T) UnaryFn[T]
  • func (f UnaryFn[T]) Add(f2 UnaryFn[T]) UnaryFn[T]
  • func (f UnaryFn[T]) Div(f2 UnaryFn[T]) UnaryFn[T]
  • func (f UnaryFn[T]) Mul(f2 UnaryFn[T]) UnaryFn[T]
  • func (f UnaryFn[T]) Sub(f2 UnaryFn[T]) UnaryFn[T]

Functions

func Abs

func Abs[T constraints.SignedReal](x T) T

Abs returns abs of x

func Add

func Add[T constraints.Number](x, y T) T

func CeilPowerOfTwo

func CeilPowerOfTwo[T constraints.Integer](value T) T

func Clamp

func Clamp[T constraints.Ordered](x, min, max T) T

Clamp clamps x into range [min, max]

func Damp

func Damp[T constraints.Float](x, y, lambda, dt T) T

http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/

func Deg2Rad

func Deg2Rad[T constraints.Float](deg T) T

func Div

func Div[T constraints.Number](x, y T) T

func EuclideanModulo

func EuclideanModulo[T constraints.Float](x, y T) T

EuclideanModulo computes euclidean modulo: x % y

func FloorPowerOfTwo

func FloorPowerOfTwo[T constraints.Integer](value T) T

func Identity

func Identity[T constraints.Number](x T) T

func InverseLerp

func InverseLerp[T constraints.Field](x, y, value T) T

https://www.gamedev.net/tutorials/programming/general-and-gameplay-programming/inverse-lerp-a-super-useful-yet-often-overlooked-function-r5230/

func IsPowerOfTwo

func IsPowerOfTwo[T constraints.Integer](value T) bool

func IsZero

func IsZero[T constraints.SignedReal](x T) T

func Lerp

func Lerp[T constraints.Field](x, y, t T) T

https://en.wikipedia.org/wiki/Linear_interpolation

func MapLinear

func MapLinear[T constraints.Field](x, a1, a2, b1, b2 T) T

MapLinear mapping from range <a1, a2> to range <b1, b2>

func Max

func Max[T constraints.Ordered](x, y T) T

Max returns maxinum value

func Min

func Min[T constraints.Ordered](x, y T) T

Min returns mininum value

func Minmax

func Minmax[T constraints.Ordered](x, y T) (min, max T)

Minmax returns ordered values

func Mul

func Mul[T constraints.Number](x, y T) T

func One

func One[T constraints.Number](x T) T

func PingPong

func PingPong[T constraints.Float](x, length T) T

https://www.desmos.com/calculator/vcsjnyz7x4

func Pow

func Pow[T constraints.Real](x, y T) T

func Predict

func Predict[T constraints.Number](ok bool) T

Predict returns 1 if ok, otherwise 0

func Rad2Deg

func Rad2Deg[T constraints.Float](rad T) T

func Sigmoid

func Sigmoid[T constraints.Real](x T) T

func SigmoidPrime

func SigmoidPrime[T constraints.Real](x T) T

func Sign

func Sign[T constraints.SignedReal](x T) T

func SmoothStep

func SmoothStep[T constraints.Float](x, min, max T) T

http://en.wikipedia.org/wiki/Smoothstep

func SmoothStepFunc

func SmoothStepFunc[T constraints.Float](x, min, max T, fn func(T) T) T

func Square

func Square[T constraints.Number](x T) T

func Sub

func Sub[T constraints.Number](x, y T) T

func Zero

func Zero[T constraints.Number](x T) T

Types

type BinaryFn

type BinaryFn[T constraints.Number] func(x, y T) T

func (BinaryFn[T]) Add

func (f BinaryFn[T]) Add(f2 BinaryFn[T]) BinaryFn[T]

func (BinaryFn[T]) Div

func (f BinaryFn[T]) Div(f2 BinaryFn[T]) BinaryFn[T]

func (BinaryFn[T]) Mul

func (f BinaryFn[T]) Mul(f2 BinaryFn[T]) BinaryFn[T]

func (BinaryFn[T]) Sub

func (f BinaryFn[T]) Sub(f2 BinaryFn[T]) BinaryFn[T]

type UnaryFn

type UnaryFn[T constraints.Number] func(T) T

func Affine

func Affine[T constraints.Number](k, b T) UnaryFn[T]

func Constant

func Constant[T constraints.Number](c T) UnaryFn[T]

func KSigmoid

func KSigmoid[T constraints.Real](k T) UnaryFn[T]

func KSigmoidPrime

func KSigmoidPrime[T constraints.Real](k T) UnaryFn[T]

func Offset

func Offset[T constraints.Number](b T) UnaryFn[T]

func Power

func Power[T constraints.Real](p T) UnaryFn[T]

func Scale

func Scale[T constraints.Number](k T) UnaryFn[T]

func (UnaryFn[T]) Add

func (f UnaryFn[T]) Add(f2 UnaryFn[T]) UnaryFn[T]

func (UnaryFn[T]) Div

func (f UnaryFn[T]) Div(f2 UnaryFn[T]) UnaryFn[T]

func (UnaryFn[T]) Mul

func (f UnaryFn[T]) Mul(f2 UnaryFn[T]) UnaryFn[T]

func (UnaryFn[T]) Sub

func (f UnaryFn[T]) Sub(f2 UnaryFn[T]) UnaryFn[T]