README
¶
Branchless
Branchless is a Go package that provides branchless operations on integers. It assumes int is 64-bit so will not work correctly on 32-bit architecture.
Functions
Min(x, y int) int
Returns the minimum of x and y.
Max(x, y int) int
Returns the maximum of x and y.
MaxZeroAnd(x int) int
Returns 0 if x is less than 0, otherwise x.
LessThan(x, y int) int
Returns 1 if x < y, otherwise 0.
GreaterThan(x, y int) int
Returns 1 if x > y, otherwise 0.
Equal(x, y int) int
Returns 1 if x == y, otherwise 0.
NotEqual(x, y int) int
Returns 1 if x != y, otherwise 0.
LessThanEqualTo(x, y int) int
Returns 1 if x <= y, otherwise 0.
GreaterThanEqualTo(x, y int) int
Returns 1 if x >= y, otherwise 0.
Abs(x int) int
Returns the absolute value of x.
Diff(x, y int) int
Returns the absolute difference between x and y.
Sign(x int) int
Returns -1 if x < 0, 0 if x == 0, and 1 if x > 0.
IsPositive(x int) int
Returns 1 if x > 0, otherwise 0.
IsNegative(x int) int
Returns 1 if x < 0, otherwise 0.
IsZero(x int) int
Returns 1 if x == 0, otherwise 0.
IsNotZero(x int) int
Returns 1 if x != 0, otherwise 0.
Clamp(x, min, max int) int
Clamps the value x between the minimum (min) and maximum (max) values.
IsPowerOfTwo(x int) int
Returns 1 if x is a power of 2 (or is zero), otherwise 0.
IsEven(x int) int
Returns 1 if x is even, otherwise 0.
IsOdd(x int) int
Returns 1 if x is odd, otherwise 0.
Negate(x int) int
Returns the negation of x.
IsDivisibleBy(x, y int) int
Returns 1 if x is divisible by y, otherwise 0.
Documentation
¶
Overview ¶
Package branchless provides branchless operations on integers.
Index ¶
- func Abs(x int) int
- func Clamp(x, min, max int) int
- func Diff(x, y int) int
- func Equal(x, y int) int
- func GreaterThan(x, y int) int
- func GreaterThanEqualTo(x, y int) int
- func IsDivisibleBy(x, y int) int
- func IsEven(x int) int
- func IsNegative(x int) int
- func IsNotZero(x int) int
- func IsOdd(x int) int
- func IsPositive(x int) int
- func IsPowerOfTwo(x int) int
- func IsZero(x int) int
- func LessThan(x, y int) int
- func LessThanEqualTo(x, y int) int
- func Max(x, y int) int
- func MaxZeroAnd(x int) int
- func Min(x, y int) int
- func Negate(x int) int
- func NotEqual(x, y int) int
- func Sign(x int) int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GreaterThanEqualTo ¶
GreaterThanEqualTo returns 1 if x >= y, otherwise 0.
func IsDivisibleBy ¶
IsDivisibleBy returns 1 if x is divisible by y, otherwise 0.
func IsPowerOfTwo ¶
IsPowerOfTwo returns 1 if x is a power of 2 (or is zero), otherwise 0.
func LessThanEqualTo ¶
LessThanEqualTo returns 1 if x <= y, otherwise 0.
Types ¶
This section is empty.
Source Files