package mathutil

Import Path
	github.com/gookit/goutil/mathutil (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	    calc.go
	    check.go
	    compare.go
	    conv2int.go
	    convert.go
	    format.go
	  d mathutil.go
		Package mathutil provide math(int, number) util functions. eg: convert, math calc, random

	    random.go
	    types.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type ConvOption[T] (struct)

		Type Parameters:
			T: any

		ConvOption convert options

		Fields (total 4)
			HandlePtr bool
				HandlePtr auto convert ptr type(int,float,string) value. eg: *int to int
					- if true: will use real type try convert. default is false
					- NOTE: current T type's ptr is default support.

			NilAsFail bool
				if ture: value is nil, will return convert error;
				if false(default): value is nil, will convert to zero value

			StrictMode bool
				StrictMode for convert value. default is false
				
				TRUE:
				 - to int: string, float will return error

			UserConvFn ToTypeFunc[T]
				set custom fallback convert func for not supported type.

		Methods (only one)
			(*ConvOption[T]) WithOption(optFns ...ConvOptionFn[T])
				WithOption set convert option

		As Outputs Of (at least one exported)
			func NewConvOption[T](optFns ...ConvOptionFn[T]) *ConvOption[T]
		As Inputs Of (at least 3)
			func WithHandlePtr[T](opt *ConvOption[T])
			func WithNilAsFail[T](opt *ConvOption[T])
			func WithStrictMode[T](opt *ConvOption[T])

	 type ConvOptionFn[T] (func)

		Type Parameters:
			T: any

		ConvOptionFn convert option func

		As Outputs Of (at least one exported)
			func WithUserConvFn[T](fn ToTypeFunc[T]) ConvOptionFn[T]
		As Inputs Of (at least 7)
			func NewConvOption[T](optFns ...ConvOptionFn[T]) *ConvOption[T]
			func ToFloatWith(in any, optFns ...ConvOptionFn[float64]) (f64 float64, err error)
			func ToInt64With(in any, optFns ...ConvOptionFn[int64]) (i64 int64, err error)
			func ToIntWith(in any, optFns ...ConvOptionFn[int]) (iVal int, err error)
			func ToUint64With(in any, optFns ...ConvOptionFn[uint64]) (u64 uint64, err error)
			func ToUintWith(in any, optFns ...ConvOptionFn[uint]) (uVal uint, err error)
			func (*ConvOption)[T].WithOption(optFns ...ConvOptionFn[T])

	 type ToFloatFunc (func)
		ToFloatFunc convert value to float

	 type ToInt64Func (func)
		ToInt64Func convert value to int64

	 type ToIntFunc (func)
		ToIntFunc convert value to int

	 type ToTypeFunc[T] (func)

		Type Parameters:
			T: any

		ToTypeFunc convert value to defined type

		As Inputs Of (at least one exported)
			func WithUserConvFn[T](fn ToTypeFunc[T]) ConvOptionFn[T]

	 type ToUint64Func (func)
		ToUint64Func convert value to uint

	 type ToUintFunc (func)
		ToUintFunc convert value to uint


Package-Level Functions (total 114)

	 func Abs[T](val T) T

		Type Parameters:
			T: comdef.Int

		Abs get absolute value of given value

	 func Compare(first, second any, op string) bool
		Compare any intX,floatX value by given op. returns `first op(=,!=,<,<=,>,>=) second`
		
		Usage:
		
			mathutil.Compare(2, 3, ">") // false
			mathutil.Compare(2, 1.3, ">") // true
			mathutil.Compare(2.2, 1.3, ">") // true
			mathutil.Compare(2.1, 2, ">") // true

	 func CompFloat[T](first, second T, op string) (ok bool)

		Type Parameters:
			T: comdef.Float

		CompFloat compare float64,float32 value. returns `first op(=,!=,<,<=,>,>=) second`

	 func CompInt[T](first, second T, op string) (ok bool)

		Type Parameters:
			T: comdef.Xint

		CompInt compare all intX,uintX type value. returns `first op(=,!=,<,<=,>,>=) second`

	 func CompInt64(first, second int64, op string) bool
		CompInt64 compare int64 value. returns `first op(=,!=,<,<=,>,>=) second`

	 func CompValue[T](first, second T, op string) (ok bool)

		Type Parameters:
			T: comdef.Number

		CompValue compare intX,uintX,floatX value. returns `first op(=,!=,<,<=,>,>=) second`

	 func DataSize(size uint64) string
		DataSize format bytes number friendly. eg: 1024 => 1KB, 1024*1024 => 1MB
		
		Usage:
		
			file, err := os.Open(path)
			fl, err := file.Stat()
			fmtSize := DataSize(fl.Size())

	 func Div[T1, T2](a T1, b T2) float64

		Type Parameters:
			T1: comdef.Number
			T2: comdef.Number

		Div computes the `a/b` value, result uses a round handle.

	 func DivF2i(a, b float64) int
		DivF2i computes the float64 type a / b value, rounding the result to an integer.

	 func DivInt[T](a, b T) int

		Type Parameters:
			T: comdef.Integer

		DivInt computes the int type a / b value, rounding the result to an integer.

	 func Expand(expr string) ([]int, error)
		Expand a number range expression to int[]. eg: "1-100,123,124"

	 func Float(in any) (float64, error)
		Float convert value to float64, return error on failed

	 func FloatOr(in any, defVal float64) float64
		FloatOr convert value to float64, will return default value on error

	 func FloatOrDefault(in any, defVal float64) float64
		FloatOrDefault convert value to float64, will return default value on error

	 func FloatOrErr(in any) (float64, error)
		FloatOrErr convert value to float64, return error on failed

	 func FloatOrPanic(in any) float64
		FloatOrPanic convert value to float64, will panic on error

	 func FormatBytes(bytes int) string
		FormatBytes Format the byte size to be a readable string. eg: 1024 => 1 KB

	 func GreaterOr[T](val, min, defVal T) T

		Type Parameters:
			T: comdef.Number

		GreaterOr return val on val > max, else return default value.
		
		Example:
		
			GreaterOr(23, 0, 2) // 23
			GreaterOr(0, 0, 2) // 2

	 func GteOr[T](val, min, defVal T) T

		Type Parameters:
			T: comdef.Number

		GteOr return val on val >= max, else return default value.
		
		Example:
		
			GteOr(23, 0, 2) // 23
			GteOr(0, 0, 2) // 0

	 func HowLongAgo(sec int64) string
		HowLongAgo format a seconds, get how lang ago. eg: 1 day, 1 week

	 func InDelta[T](want, give T, delta float64) bool

		Type Parameters:
			T: comdef.Float

		InDelta Check whether two floating-point numbers are equal within a specified margin of error
		
		Params:
		  want - 期望的浮点数值
		  give - 实际给定的浮点数值
		  delta - 允许的误差范围

	 func InDeltaAny(want, give any, delta float64) bool
		InDeltaAny Check whether two floating-point numbers are equal within a specified margin of error

	 func InRange[T](val, min, max T) bool

		Type Parameters:
			T: comdef.Number

		InRange check if val in int/float range [min, max]

	 func Int(in any) (int, error)
		Int convert value to int

	 func Int64(in any) (int64, error)
		Int64 convert value to int64, return error on failed

	 func Int64Or(in any, defVal int64) int64
		Int64Or convert value to int64, return default val on failed

	 func Int64OrDefault(in any, defVal int64) int64
		Int64OrDefault convert value to int64, return default val on failed

	 func Int64OrErr(in any) (int64, error)
		Int64OrErr convert value to int64, return error on failed

	 func IntOr(in any, defVal int) int
		IntOr convert value to int, return defaultVal on failed

	 func IntOrDefault(in any, defVal int) int
		IntOrDefault convert value to int, return defaultVal on failed

	 func IntOrErr(in any) (int, error)
		IntOrErr convert value to int, return error on failed

	 func IntOrPanic(in any) int
		IntOrPanic convert value to int, will panic on error

	 func InUintRange[T](val, min, max T) bool

		Type Parameters:
			T: comdef.Uint

		InUintRange check if val in unit range [min, max]

	 func IsFloat(val any) bool
		IsFloat returns true if the given character is a float(32/64), otherwise false.

	 func IsInteger(val any) bool
		IsInteger strict check the given value is an integer(intX,uintX), otherwise false.

	 func IsNumeric(c byte) bool
		IsNumeric returns true if the given character is a numeric, otherwise false.

	 func LessOr[T](val, max, devVal T) T

		Type Parameters:
			T: comdef.Number

		LessOr return val on val < max, else return default value.
		
		Example:
		
			LessOr(11, 10, 1) // 1
			LessOr(2, 10, 1) // 2
			LessOr(10, 10, 1) // 1

	 func LteOr[T](val, max, devVal T) T

		Type Parameters:
			T: comdef.Number

		LteOr return val on val <= max, else return default value.
		
		Example:
		
			LteOr(11, 10, 1) // 11
			LteOr(2, 10, 1) // 2
			LteOr(10, 10, 1) // 10

	 func Max[T](x, y T) T

		Type Parameters:
			T: comdef.Number

		Max compare two value and return max value

	 func MaxFloat(x, y float64) float64
		MaxFloat compare and return max value

	 func MaxI64(x, y int64) int64
		MaxI64 compare and return max value

	 func MaxInt(x, y int) int
		MaxInt compare and return max value

	 func Min[T](x, y T) T

		Type Parameters:
			T: comdef.Number

		Min compare two value and return max value

	 func Mul[T1, T2](a T1, b T2) float64

		Type Parameters:
			T1: comdef.Number
			T2: comdef.Number

		Mul computes the `a*b` value, rounding the result.

	 func MulF2i(a, b float64) int
		MulF2i computes the float64 type a * b value, rounding the result to an integer.

	 func MustFloat(in any) float64
		MustFloat convert value to float64, will panic on error

	 func MustInt(in any) int
		MustInt convert value to int, will panic on error

	 func MustInt64(in any) int64
		MustInt64 convert value to int64, will panic on error

	 func MustString(val any) string
		MustString convert intX/floatX value to string, will panic on error

	 func MustUint(in any) uint
		MustUint convert any to uint, will panic on error

	 func MustUint64(in any) uint64
		MustUint64 convert any to uint64, will panic on error

	 func NewConvOption[T](optFns ...ConvOptionFn[T]) *ConvOption[T]

		Type Parameters:
			T: any

		NewConvOption create a new ConvOption

	 func OrElse[T](val, defVal T) T

		Type Parameters:
			T: comdef.Number

		OrElse return default value on val is zero, else return val

	 func OutRange[T](val, min, max T) bool

		Type Parameters:
			T: comdef.Number

		OutRange check if val not in int/float range [min, max]

	 func Percent(val, total int) float64
		Percent returns a value percentage of the total. eg: 1/100 = 1.0%

	 func QuietFloat(in any) float64
		QuietFloat convert value to float64, will ignore error. alias of SafeFloat

	 func QuietInt(in any) int
		QuietInt convert value to int, will ignore error

	 func QuietInt64(in any) int64
		QuietInt64 convert value to int64, will ignore error

	 func QuietString(val any) string
		QuietString convert intX/floatX value to string, other type convert by fmt.Sprint

	 func QuietUint(in any) uint
		QuietUint convert any to uint, will ignore error

	 func QuietUint64(in any) uint64
		QuietUint64 convert any to uint64, will ignore error

	 func RandInt(min, max int) int
		RandInt alias of RandomInt()

	 func RandIntWithSeed(min, max int, seed int64) int
		RandIntWithSeed alias of RandomIntWithSeed()

	 func RandomInt(min, max int) int
		RandomInt return a random int at the [min, max)
		
		Usage:
		
			RandomInt(10, 99)
			RandomInt(100, 999)
			RandomInt(1000, 9999)

	 func RandomIntWithSeed(min, max int, seed int64) int
		RandomIntWithSeed return a random int at the [min, max)
		
		Usage:
		
			seed := time.Now().UnixNano()
			RandomIntWithSeed(1000, 9999, seed)

	 func Range(expr string, handle func(val int)) error
		Range a number range expression, and handle each value. eg: "1-100,123,124"

	 func SafeFloat(in any) float64
		SafeFloat convert value to float64, will ignore error

	 func SafeInt(in any) int
		SafeInt convert value to int, will ignore error

	 func SafeInt64(in any) int64
		SafeInt64 convert value to int64, will ignore error

	 func SafeString(val any) string
		SafeString convert intX/floatX value to string, other type convert by fmt.Sprint

	 func SafeUint(in any) uint
		SafeUint convert any to uint, will ignore error

	 func SafeUint64(in any) uint64
		SafeUint64 convert any to uint64, will ignore error

	 func StrictInt(val any) (int64, bool)
		StrictInt check the given value is an integer(intX,uintX), return the int64 value and true if success

	 func StrictUint(val any) (uint64, bool)
		StrictUint strict check value is integer(intX,uintX) and convert to uint64.

	 func String(val any) string
		String convert intX/floatX value to string, other type convert by fmt.Sprint

	 func StringOr(val any, defVal string) string
		StringOr convert intX/floatX value to string, will return default value on error

	 func StringOrDefault(val any, defVal string) string
		StringOrDefault convert intX/floatX value to string, will return default value on error

	 func StringOrErr(val any) (string, error)
		StringOrErr convert intX/floatX value to string, return error on failed

	 func StringOrPanic(val any) string
		StringOrPanic convert intX/floatX value to string, will panic on error

	 func StrInt(s string) int
		StrInt convert string to int, ignore error

	 func StrIntOr(s string, defVal int) int
		StrIntOr convert string to int, return default val on failed

	 func SwapMax[T](x, y T) (T, T)

		Type Parameters:
			T: comdef.Number

		SwapMax compare and always return [max, min] value

	 func SwapMaxI64(x, y int64) (int64, int64)
		SwapMaxI64 compare and return max, min value

	 func SwapMaxInt(x, y int) (int, int)
		SwapMaxInt compare and return max, min value

	 func SwapMin[T](x, y T) (T, T)

		Type Parameters:
			T: comdef.Number

		SwapMin compare and always return [min, max] value

	 func ToFloat(in any) (float64, error)
		ToFloat convert value to float64, return error on failed

	 func ToFloatWith(in any, optFns ...ConvOptionFn[float64]) (f64 float64, err error)
		ToFloatWith try to convert value to float64. can with some option func, more see ConvOption.

	 func ToInt(in any) (int, error)
		ToInt convert value to int, return error on failed

	 func ToInt64(in any) (int64, error)
		ToInt64 convert value to int64, return error on failed

	 func ToInt64With(in any, optFns ...ConvOptionFn[int64]) (i64 int64, err error)
		ToInt64With try to convert value to int64. can with some option func, more see ConvOption.

	 func ToIntWith(in any, optFns ...ConvOptionFn[int]) (iVal int, err error)
		ToIntWith convert value to int, can with some option func.
		
		Example:
		
			ToIntWithFunc(val, mathutil.WithNilAsFail, mathutil.WithUserConvFn(func(in any) (int, error) {
			})

	 func ToString(val any) (string, error)
		ToString convert intX/floatX value to string, return error on failed

	 func ToStringWith(in any, optFns ...comfunc.ConvOptionFn) (string, error)
		ToStringWith try to convert value to string. can with some option func, more see comfunc.ConvOption.

	 func ToUint(in any) (u64 uint, err error)
		ToUint convert value to uint, return error on failed

	 func ToUint64(in any) (uint64, error)
		ToUint64 convert value to uint64, return error on failed

	 func ToUint64With(in any, optFns ...ConvOptionFn[uint64]) (u64 uint64, err error)
		ToUint64With try to convert value to uint64. can with some option func, more see ConvOption.

	 func ToUintWith(in any, optFns ...ConvOptionFn[uint]) (uVal uint, err error)
		ToUintWith try to convert value to uint. can with some option func, more see ConvOption.

	 func TryStrInt(s string) (int, error)
		TryStrInt convert string to int, return error on failed.
		
		 - empty string will return 0.
		 - allow float string.

	 func TryStrInt64(s string) (int64, error)
		TryStrInt64 convert string to int64, return error on failed.
		
		 - empty string will return 0.
		 - allow float string.

	 func TryStrUint64(s string) (uint64, error)
		TryStrUint64 try to convert string to uint64, return error on failed
		
		 - empty string will return 0.
		 - allow float string.

	 func TryToString(val any, defaultAsErr bool) (string, error)
		TryToString try convert intX/floatX value to string
		
		if defaultAsErr is False, will use fmt.Sprint convert other type

	 func Uint(in any) (uint, error)
		Uint convert any to uint, return error on failed

	 func Uint64(in any) (uint64, error)
		Uint64 convert any to uint64, return error on failed

	 func Uint64Or(in any, defVal uint64) uint64
		Uint64Or convert any to uint64, return default val on failed

	 func Uint64OrDefault(in any, defVal uint64) uint64
		Uint64OrDefault convert any to uint64, return default val on failed

	 func Uint64OrErr(in any) (uint64, error)
		Uint64OrErr convert value to uint64, return error on failed

	 func UintOr(in any, defVal uint) uint
		UintOr convert any to uint, return default val on failed

	 func UintOrDefault(in any, defVal uint) uint
		UintOrDefault convert any to uint, return default val on failed

	 func UintOrErr(in any) (uint, error)
		UintOrErr convert value to uint, return error on failed

	 func WithHandlePtr[T](opt *ConvOption[T])

		Type Parameters:
			T: any

		WithHandlePtr set ConvOption.HandlePtr option

	 func WithNilAsFail[T](opt *ConvOption[T])

		Type Parameters:
			T: any

		WithNilAsFail set ConvOption.NilAsFail option
		
		Example:
		
			ToIntWithFunc(val, mathutil.WithNilAsFail[int])

	 func WithStrictMode[T](opt *ConvOption[T])

		Type Parameters:
			T: any

		WithStrictMode set ConvOption.StrictMode option

	 func WithUserConvFn[T](fn ToTypeFunc[T]) ConvOptionFn[T]

		Type Parameters:
			T: any

		WithUserConvFn set ConvOption.UserConvFn option

	 func ZeroOr[T](val, defVal T) T

		Type Parameters:
			T: comdef.Number

		ZeroOr return default value on val is zero, else return val

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.