Module `std::uq32_32`

Defines an unsigned, fixed-point numeric type with a 32-bit integer part and a 32-bit fractional part. The notation <code><a href="../std/uq32_32.md#std_uq32_32">uq32_32</a></code> and <code><a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a></code> is based on Q notation. <code>q</code> indicates it a fixed-point number. The <code>u</code> prefix indicates it is unsigned. The <code>32_32</code> suffix indicates the number of bits, where the first number indicates the number of bits in the integer part, and the second the number of bits in the fractional part--in this case 32 bits for each.

Struct UQ32_32
Constants
Function from_quotient
Function from_int
Function add
Function sub
Function mul
Function div
Function to_int
Function int_mul
Function int_div
Function le
Function lt
Function ge
Function gt
Function to_raw
Function from_raw

Struct `UQ32_32`

A fixed-point numeric type with 32 integer bits and 32 fractional bits, represented by an underlying 64 bit value. This is a binary representation, so decimal values may not be exactly representable, but it provides more than 9 decimal digits of precision both before and after the decimal point (18 digits total).

<pre><code>public struct <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>0: <a href="../std/u64.md#std_u64">u64</a></code> </dt> <dd> </dd> </dl> </details>

Constants

<pre><code>#[error] const <a href="../std/uq32_32.md#std_uq32_32_EDenominator">EDenominator</a>: <a href="../std/vector.md#std_vector">vector</a><<a href="../std/u8.md#std_u8">u8</a>> = b"Quotient specified with a zero denominator"; </code></pre>

<pre><code>#[error] const <a href="../std/uq32_32.md#std_uq32_32_EQuotientTooSmall">EQuotientTooSmall</a>: <a href="../std/vector.md#std_vector">vector</a><<a href="../std/u8.md#std_u8">u8</a>> = b"Quotient specified is too small, and is outside of the supported range"; </code></pre>

<pre><code>#[error] const <a href="../std/uq32_32.md#std_uq32_32_EQuotientTooLarge">EQuotientTooLarge</a>: <a href="../std/vector.md#std_vector">vector</a><<a href="../std/u8.md#std_u8">u8</a>> = b"Quotient specified is too large, and is outside of the supported range"; </code></pre>

<pre><code>#[error] const <a href="../std/uq32_32.md#std_uq32_32_EOverflow">EOverflow</a>: <a href="../std/vector.md#std_vector">vector</a><<a href="../std/u8.md#std_u8">u8</a>> = b"Overflow from an arithmetic operation"; </code></pre>

<pre><code>#[error] const <a href="../std/uq32_32.md#std_uq32_32_EDivisionByZero">EDivisionByZero</a>: <a href="../std/vector.md#std_vector">vector</a><<a href="../std/u8.md#std_u8">u8</a>> = b"Division by zero"; </code></pre>

The total number of bits in the fixed-point number. Used in <code>macro</code> invocations.

<pre><code>const <a href="../std/uq32_32.md#std_uq32_32_TOTAL_BITS">TOTAL_BITS</a>: <a href="../std/u8.md#std_u8">u8</a> = 64; </code></pre>

The number of fractional bits in the fixed-point number. Used in <code>macro</code> invocations.

<pre><code>const <a href="../std/uq32_32.md#std_uq32_32_FRACTIONAL_BITS">FRACTIONAL_BITS</a>: <a href="../std/u8.md#std_u8">u8</a> = 32; </code></pre>

Function `from_quotient`

Create a fixed-point value from a quotient specified by its numerator and denominator. <code><a href="../std/uq32_32.md#std_uq32_32_from_quotient">from_quotient</a></code> and <code><a href="../std/uq32_32.md#std_uq32_32_from_int">from_int</a></code> should be preferred over using <code><a href="../std/uq32_32.md#std_uq32_32_from_raw">from_raw</a></code>. Unless the denominator is a power of two, fractions can not be represented accurately, so be careful about rounding errors. Aborts if the denominator is zero. Aborts if the input is non-zero but so small that it will be represented as zero, e.g. smaller than 2^{-32}. Aborts if the input is too large, e.g. larger than or equal to 2^32.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_from_quotient">from_quotient</a>(numerator: <a href="../std/u64.md#std_u64">u64</a>, denominator: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_from_quotient">from_quotient</a>(numerator: <a href="../std/u64.md#std_u64">u64</a>, denominator: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>( <a href="../std/macros.md#std_macros_uq_from_quotient">std::macros::uq_from_quotient</a>!<<a href="../std/u64.md#std_u64">u64</a>, <a href="../std/u128.md#std_u128">u128</a>>( numerator, denominator, <a href="../std/u64.md#std_u64_max_value">std::u64::max_value</a>!(), <a href="../std/uq32_32.md#std_uq32_32_TOTAL_BITS">TOTAL_BITS</a>, <a href="../std/uq32_32.md#std_uq32_32_FRACTIONAL_BITS">FRACTIONAL_BITS</a>, abort <a href="../std/uq32_32.md#std_uq32_32_EDenominator">EDenominator</a>, abort <a href="../std/uq32_32.md#std_uq32_32_EQuotientTooSmall">EQuotientTooSmall</a>, abort <a href="../std/uq32_32.md#std_uq32_32_EQuotientTooLarge">EQuotientTooLarge</a>, ), ) } </code></pre> </details>

Function `from_int`

Create a fixed-point value from an integer. <code><a href="../std/uq32_32.md#std_uq32_32_from_int">from_int</a></code> and <code><a href="../std/uq32_32.md#std_uq32_32_from_quotient">from_quotient</a></code> should be preferred over using <code><a href="../std/uq32_32.md#std_uq32_32_from_raw">from_raw</a></code>.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_from_int">from_int</a>(integer: <a href="../std/u32.md#std_u32">u32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_from_int">from_int</a>(integer: <a href="../std/u32.md#std_u32">u32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>(<a href="../std/macros.md#std_macros_uq_from_int">std::macros::uq_from_int</a>!(integer, <a href="../std/uq32_32.md#std_uq32_32_FRACTIONAL_BITS">FRACTIONAL_BITS</a>)) } </code></pre> </details>

Function `add`

Add two fixed-point numbers, <code>a + b</code>. Aborts if the sum overflows.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_add">add</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_add">add</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>(<a href="../std/macros.md#std_macros_uq_add">std::macros::uq_add</a>!<<a href="../std/u64.md#std_u64">u64</a>, <a href="../std/u128.md#std_u128">u128</a>>(a.0, b.0, <a href="../std/u64.md#std_u64_max_value">std::u64::max_value</a>!(), abort <a href="../std/uq32_32.md#std_uq32_32_EOverflow">EOverflow</a>)) } </code></pre> </details>

Function `sub`

Subtract two fixed-point numbers, <code>a - b</code>. Aborts if <code>a < b</code>.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_sub">sub</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_sub">sub</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>(<a href="../std/macros.md#std_macros_uq_sub">std::macros::uq_sub</a>!(a.0, b.0, abort <a href="../std/uq32_32.md#std_uq32_32_EOverflow">EOverflow</a>)) } </code></pre> </details>

Function `mul`

Multiply two fixed-point numbers, truncating any fractional part of the product. Aborts if the product overflows.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_mul">mul</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_mul">mul</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>(<a href="../std/uq32_32.md#std_uq32_32_int_mul">int_mul</a>(a.0, b)) } </code></pre> </details>

Function `div`

Divide two fixed-point numbers, truncating any fractional part of the quotient. Aborts if the divisor is zero. Aborts if the quotient overflows.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_div">div</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_div">div</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>(<a href="../std/uq32_32.md#std_uq32_32_int_div">int_div</a>(a.0, b)) } </code></pre> </details>

Function `to_int`

Convert a fixed-point number to an integer, truncating any fractional part.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_to_int">to_int</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/u32.md#std_u32">u32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_to_int">to_int</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/u32.md#std_u32">u32</a> { <a href="../std/macros.md#std_macros_uq_to_int">std::macros::uq_to_int</a>!(a.0, <a href="../std/uq32_32.md#std_uq32_32_FRACTIONAL_BITS">FRACTIONAL_BITS</a>) } </code></pre> </details>

Function `int_mul`

Multiply a <code><a href="../std/u64.md#std_u64">u64</a></code> integer by a fixed-point number, truncating any fractional part of the product. Aborts if the product overflows.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_int_mul">int_mul</a>(val: <a href="../std/u64.md#std_u64">u64</a>, multiplier: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/u64.md#std_u64">u64</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_int_mul">int_mul</a>(val: <a href="../std/u64.md#std_u64">u64</a>, multiplier: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/u64.md#std_u64">u64</a> { <a href="../std/macros.md#std_macros_uq_int_mul">std::macros::uq_int_mul</a>!<<a href="../std/u64.md#std_u64">u64</a>, <a href="../std/u128.md#std_u128">u128</a>>( val, multiplier.0, <a href="../std/u64.md#std_u64_max_value">std::u64::max_value</a>!(), <a href="../std/uq32_32.md#std_uq32_32_FRACTIONAL_BITS">FRACTIONAL_BITS</a>, abort <a href="../std/uq32_32.md#std_uq32_32_EOverflow">EOverflow</a>, ) } </code></pre> </details>

Function `int_div`

Divide a <code><a href="../std/u64.md#std_u64">u64</a></code> integer by a fixed-point number, truncating any fractional part of the quotient. Aborts if the divisor is zero. Aborts if the quotient overflows.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_int_div">int_div</a>(val: <a href="../std/u64.md#std_u64">u64</a>, divisor: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/u64.md#std_u64">u64</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_int_div">int_div</a>(val: <a href="../std/u64.md#std_u64">u64</a>, divisor: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/u64.md#std_u64">u64</a> { <a href="../std/macros.md#std_macros_uq_int_div">std::macros::uq_int_div</a>!<<a href="../std/u64.md#std_u64">u64</a>, <a href="../std/u128.md#std_u128">u128</a>>( val, divisor.0, <a href="../std/u64.md#std_u64_max_value">std::u64::max_value</a>!(), <a href="../std/uq32_32.md#std_uq32_32_FRACTIONAL_BITS">FRACTIONAL_BITS</a>, abort <a href="../std/uq32_32.md#std_uq32_32_EDivisionByZero">EDivisionByZero</a>, abort <a href="../std/uq32_32.md#std_uq32_32_EOverflow">EOverflow</a>, ) } </code></pre> </details>

Function `le`

Less than or equal to. Returns <code>true</code> if and only if <code>a <= b</code>.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_le">le</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_le">le</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> { a.0 <= b.0 } </code></pre> </details>

Function `lt`

Less than. Returns <code>true</code> if and only if <code>a < b</code>.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_lt">lt</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_lt">lt</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> { a.0 < b.0 } </code></pre> </details>

Function `ge`

Greater than or equal to. Returns <code>true</code> if and only if <code>a >= b</code>.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_ge">ge</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_ge">ge</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> { a.0 >= b.0 } </code></pre> </details>

Function `gt`

Greater than. Returns <code>true</code> if and only if <code>a > b</code>.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_gt">gt</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_gt">gt</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>, b: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/bool.md#std_bool">bool</a> { a.0 > b.0 } </code></pre> </details>

Function `to_raw`

Accessor for the raw u64 value. Can be paired with <code><a href="../std/uq32_32.md#std_uq32_32_from_raw">from_raw</a></code> to perform less common operations on the raw values directly.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_to_raw">to_raw</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a>): <a href="../std/u64.md#std_u64">u64</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_to_raw">to_raw</a>(a: <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>): <a href="../std/u64.md#std_u64">u64</a> { a.0 } </code></pre> </details>

Function `from_raw`

Accessor for the raw u64 value. Can be paired with <code><a href="../std/uq32_32.md#std_uq32_32_to_raw">to_raw</a></code> to perform less common operations on the raw values directly.

<pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_from_raw">from_raw</a>(raw_value: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">std::uq32_32::UQ32_32</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/uq32_32.md#std_uq32_32_from_raw">from_raw</a>(raw_value: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a> { <a href="../std/uq32_32.md#std_uq32_32_UQ32_32">UQ32_32</a>(raw_value) } </code></pre> </details>

Struct UQ32_32

Constants

Function from_quotient

Function from_int

Function add

Function sub

Function mul

Function div

Function to_int

Function int_mul

Function int_div

Function le

Function lt

Function ge

Function gt

Function to_raw

Function from_raw