Numeric Functions and Types
(ply-system.h)

Integer Types

Primitive Functions

template <typename Type> Type abs(Type value)

Returns the absolute value of any integer or floating-point value.

template <typename Type> Type min(Type value1, Type value2)

Returns the minimum of two integer or floating-point values.

template <typename Type> Type max(Type value1, Type value2)

Returns the maximum of two integer or floating-point values.

template <typename Type> Type clamp(Type value, Type lowerBound, Type upperBound)

Clamps an integer or floating-point value to lie within a lower and upper bound.

clamp(1, 2, 4);  // Returns 2.

Alignment

u32 isPowerOf2(u32 value)
u64 isPowerOf2(u64 value)

Returns true if a value is a power of 2, false otherwise.

u32 alignToPowerOf2(u32 value, u32 alignment)
u64 alignToPowerOf2(u64 value, u64 alignment)

Rounds value up to the nearest multiple of alignment, which must be a power of 2.

bool isAlignedToPowerOf2(u32 value, u32 alignment)
bool isAlignedToPowerOf2(u64 value, u64 alignment)

Returns true if value is a multiple of alignment, which must be a power of 2.

u32 roundUpToPowerOf2(u32 value)
u64 roundUpToPowerOf2(u64 value)

Rounds value up to the nearest power of 2.

Byte Ordering

u16 reverseBytes(u16 value)
u32 reverseBytes(u32 value)
u64 reverseBytes(u64 value)

Reverses the byte order of a value. Used internally by convertLittleEndian() or convertBigEndian().

u16 value = reverseBytes((u16) 0x1234);  // Returns 0x3412.

template <typename Type> Type convertLittleEndian(Type value)
template <typename Type> Type convertBigEndian(Type value)

Converts a native integer to little-endian or big-endian byte order. Also converts it back again. Type must be one of u16, u32, or u64.

Numeric Casts and Limits

template <typename DstType, typename SrcType> bool isRepresentable(SrcType value)

Returns true if value can be represented by the destination type DstType; false otherwise.

isRepresentable<u16>(1234);   // Returns true.
isRepresentable<u32>(-1234);  // Returns false.

template <typename Type> Type minRepresentableValue()
template <typename Type> Type maxRepresentableValue()

Returns the minimum or maximum representable value for a given type Type. Works with all integer and floating-point types.

s32 value = maxRepresentableValue<s32>();      // Returns 0x7fffffff.
float value = minRepresentableValue<float>();  // Returns -3.402823466e+38f.

template <typename DstType, typename SrcType> DstType numericCast(SrcType value)

Casts value from one numeric type to another under the assumption that the value can be represented by the destination type. Will assert at runtime if the value can't be represented.

s32 value = foo();
if (value >= 0) {
    u32 value2 = numericCast<u32>(value);  // OK
}
u32 value3 = numericCast<u32>(-1234);      // Error: triggers runtime assertion.