Documentation
¶
Index ¶
- Variables
- func Max[T Integer]() uint64
- func MaxInt(a, b int) int
- func MaxInt64(a, b int64) int64
- func Min[T Integer]() int64
- func MinInt(a, b int) int
- func MinInt64(a, b int64) int64
- func MustConvert[FROM Integer, TO Integer](a FROM) TO
- func MustConvertInt[T Integer](a T) int
- func MustConvertInt16[T Integer](a T) int16
- func MustConvertInt32[T Integer](a T) int32
- func MustConvertInt64[T Integer](a T) int64
- func MustConvertUint[T Integer](a T) uint
- func MustConvertUint8[T Integer](a T) uint8
- func MustConvertUint16[T Integer](a T) uint16
- func MustConvertUint32[T Integer](a T) uint32
- func MustConvertUint64[T Integer](a T) uint64
- func SafeAddClipInt64(a, b int64) int64
- func SafeAddInt32(a, b int32) (int32, error)
- func SafeAddInt64(a, b int64) (int64, error)
- func SafeConvert[F Integer, T Integer](from F) (T, error)
- func SafeConvertInt8(a int64) (int8, error)
- func SafeConvertInt16[T Integer](a T) (int16, error)
- func SafeConvertInt32[T Integer](a T) (int32, error)
- func SafeConvertInt64[T Integer](a T) (int64, error)
- func SafeConvertUint8(a int64) (uint8, error)
- func SafeConvertUint16[T Integer](a T) (uint16, error)
- func SafeConvertUint32[T Integer](a T) (uint32, error)
- func SafeConvertUint64[T Integer](a T) (uint64, error)
- func SafeMulInt64(a, b int64) (int64, bool)
- func SafeSubClipInt64(a, b int64) int64
- func SafeSubInt32(a, b int32) (int32, error)
- func SafeSubInt64(a, b int64) (int64, bool)
- type Fraction
- type Integer
Constants ¶
This section is empty.
Variables ¶
var ErrOverflow = errors.New("integer overflow")
Functions ¶
func Max ¶ added in v1.5.0
Max returns the maximum value for a type T.
The function panics if the type is not supported.
func MustConvert ¶ added in v1.5.0
MustConvert converts a value of type T to a value of type U. It panics if the conversion would cause an overflow.
See SafeConvert for non-panicking version.
func MustConvertInt ¶ added in v1.5.0
func MustConvertInt16 ¶ added in v1.5.0
func MustConvertInt32 ¶ added in v1.3.0
MustConvertInt32 takes an Integer and converts it to int32. Panics if the conversion overflows.
func MustConvertInt64 ¶ added in v1.5.0
func MustConvertUint ¶ added in v1.5.0
func MustConvertUint8 ¶ added in v1.5.0
func MustConvertUint16 ¶ added in v1.5.0
func MustConvertUint32 ¶ added in v1.3.0
MustConvertInt32 takes an Integer and converts it to int32. Panics if the conversion overflows.
func MustConvertUint64 ¶ added in v1.5.0
func SafeAddClipInt64 ¶ added in v1.3.0
SafeAddClipInt64 adds two int64 integers and clips the result to the int64 range.
func SafeAddInt32 ¶
SafeAddInt32 adds two int32 integers.
func SafeAddInt64 ¶ added in v1.3.0
SafeAddInt64 adds two int64 integers.
func SafeConvert ¶ added in v1.5.0
SafeConvert converts a value of type T to a value of type U. It returns an error if the conversion would cause an overflow.
func SafeConvertInt8 ¶
SafeConvertInt8 takes an int64 and checks if it overflows.
func SafeConvertInt16 ¶ added in v1.5.0
SafeConvertInt16 takes a int and checks if it overflows.
func SafeConvertInt32 ¶
SafeConvertInt32 takes a int and checks if it overflows.
func SafeConvertInt64 ¶ added in v1.5.0
SafeConvertInt64 takes a int and checks if it overflows.
func SafeConvertUint8 ¶
SafeConvertUint8 takes an int64 and checks if it overflows.
func SafeConvertUint16 ¶ added in v1.5.0
SafeConvertUint16 takes a int and checks if it overflows.
func SafeConvertUint32 ¶ added in v1.3.0
SafeConvertInt32 takes a int and checks if it overflows.
func SafeConvertUint64 ¶ added in v1.5.0
SafeConvertUint64 takes a int and checks if it overflows.
func SafeMulInt64 ¶ added in v1.3.0
func SafeSubClipInt64 ¶ added in v1.3.0
func SafeSubInt32 ¶
SafeSubInt32 subtracts two int32 integers.
func SafeSubInt64 ¶ added in v1.3.0
Types ¶
type Fraction ¶
type Fraction struct {
// The portion of the denominator in the faction, e.g. 2 in 2/3.
Numerator uint64 `json:"numerator"`
// The value by which the numerator is divided, e.g. 3 in 2/3.
Denominator uint64 `json:"denominator"`
}
Fraction defined in terms of a numerator divided by a denominator in uint64 format. Fraction must be positive.
func ParseFraction ¶
ParseFractions takes the string of a fraction as input i.e "2/3" and converts this to the equivalent fraction else returns an error. The format of the string must be one number followed by a slash (/) and then the other number.
Source Files