math#

Fully qualified name: carb::math

namespace math#: Namespace for various math helper functions.

Functions#

int bitScanForward(const T &val): Searches an integer value from least significant bit to most significant bit for the first set (1) bit.
int bitScanReverse(const T &val): Searches an integer value from most significant bit to least significant bit for the first set (1) bit.
int64_t cast_to_int64_t(const int128_t &val) noexcept: Truncates the signed 128-bit value, returning only the lowest 64-bits.
uint64_t cast_to_uint64_t(const uint128_t &val) noexcept: Truncates the unsigned 128-bit value, returning only the lowest 64-bits.
int128_t divide_and_modulus(const int128_t &dividend, const int128_t &divisor, int128_t &modulus) noexcept: Performs a division operation with two signed 128-bit integers and provides both the quotient and remainder.
uint128_t divide_and_modulus(const uint128_t &dividend, const uint128_t &divisor, uint128_t &modulus) noexcept: Performs a division operation on two unsigned 128-bit integers and provides both the quotient and remainder.
constexpr bool isPowerOf2(const T &val): Returns whether the given integer value is a power of two.
int128_t make_int128_t(uint64_t high, uint64_t low) noexcept: Creates a signed 128-bit integer from two unsigned 64-bit integers.
constexpr uint128_t make_uint128_t(uint64_t high, uint64_t low) noexcept: Creates an unsigned 128-bit integer from two unsigned 64-bit integers.
cpp::optional< uint64_t > mulDiv(uint64_t num, uint64_t multiplier, uint64_t divisor) noexcept: Multiplies two 64-bit unsigned integers and then divides the 128-bit result by a third 64-bit unsigned integer.
cpp::optional< int64_t > mulDiv(RoundPolicy round, int64_t num, int64_t multiplier, int64_t divisor) noexcept: Multiplies two 64-bit signed integers and then divides the 128-bit result by a third 64-bit signed integer.
cpp::optional< double > mulDiv(double num, double multiplier, double divisor) noexcept: Multiplies two 64-bit floating-point values and then divides the result by a third 64-bit floating-point value.
cpp::optional< uint64_t > mulDiv(RoundPolicy round, uint64_t num, uint64_t multiplier, uint64_t divisor) noexcept: Multiplies two 64-bit unsigned integers and then divides the 128-bit result by a third 64-bit unsigned integer.
cpp::optional< double > mulDiv(RoundPolicy, double num, double multiplier, double divisor) noexcept: Multiplies two 64-bit floating-point values and then divides the result by a third 64-bit floating-point value.
cpp::optional< int64_t > mulDiv(int64_t num, int64_t multiplier, int64_t divisor) noexcept: Multiplies two 64-bit signed integers and then divides the 128-bit result by a third 64-bit signed integer.
int numLeadingZeroBits(const T &val): Returns the number of leading zero bits for an integer value.
inline ::std::ostream & operator<<(::std::ostream &os, const ::carb::math::uint128_t &val): Stream insertion operator for unsigned 128-bit integers.
inline ::std::ostream & operator<<(::std::ostream &os, const ::carb::math::int128_t &val): Stream insertion operator for signed 128-bit integers.
int popCount(const T &val): Returns the number of set (1) bits in an integer value.
std::string to_string(const int128_t &val): Formats a signed 128-bit integer as a string.
std::string to_string(const uint128_t &val): Formats an unsigned 128-bit integer as a string.

Structs#

round_away_from_zero_t: A rounding policy for mulDiv that rounds the result away from zero.
round_nearest_neighbor_t: A rounding policy for mulDiv that rounds the result to the nearest neighbor.
round_toward_zero_t: A rounding policy for mulDiv that rounds the result toward zero, the default behavior for integer division.

Typedefs#

int128_t: The 128-bit signed integer type.
uint128_t: The 128-bit unsigned integer type.

Variables#

round_away_from_zero_t round_away_from_zero: An instantiation of the round_away_from_zero_t policy type that can be passed to mulDiv() .
round_away_from_zero_t round_ceil: An alias of round_away_from_zero .
round_toward_zero_t round_floor: An alias of round_toward_zero .
round_nearest_neighbor_t round_nearest_neighbor: An instantiation of the round_nearest_neighbor_t policy type that can be passed to mulDiv() .
round_toward_zero_t round_toward_zero: An instantiation of the round_toward_zero_t policy type that can be passed to mulDiv() .