HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Namespaces | Concepts | Functions
assert.hpp File Reference

Utilities to assert and bound check. More...

#include "type_traits.hpp"
#include "terminate.hpp"
#include "../macros.hpp"
#include "exception.hpp"
#include <exception>
#include <ranges>

Go to the source code of this file.

Namespaces

namespace  hi
 The HikoGUI namespace.
 
namespace  hi::v1
 The HikoGUI API version 1.
 

Concepts

concept  hi::v1::bound_check_range_helper
 

Functions

 hi_export_module (hikogui.utility.assert)
 
 hi_warning_push ()
 
 hi_warning_ignore_msvc (26472)
 
hi_export constexpr bool hi::v1::bound_check (std::integral auto index, std::integral auto upper) noexcept
 Check if an index is less than the bound.
 
hi_export constexpr bool hi::v1::bound_check (std::integral auto index, std::integral auto lower, std::integral auto upper) noexcept
 Check if an index is between the lower (inclusive) and upper (exclusive).
 
hi_export constexpr bool hi::v1::bound_check (std::floating_point auto index, std::floating_point auto lower, std::floating_point auto upper) noexcept
 Check if an floating point value is between the lower (inclusive) and upper (inclusive).
 
hi_export constexpr bool hi::v1::bound_check (std::integral auto index, bound_check_range_helper auto &&range) noexcept
 Check if an index is within a range.
 
 hi_warning_pop ()
 

Detailed Description

Utilities to assert and bound check.

Function Documentation

◆ hi_warning_ignore_msvc()

hi_warning_ignore_msvc ( 26472 )

Get a bit from an array of unsigned integers. The integers are arranged in little-endian order.

Parameters
lhsThe array of integers from which to take the bit.
indexThe index of the bit
Returns
The value of the bit, either 0 or 1, with the same type as the integers of the array.

Set a bit from an array of unsigned integers. The integers are arranged in little-endian order.

Parameters
rThe array of integers on which to set the bit.
indexThe index of the bit
valueThe value of the bit, either 0 or 1.

Shift logical left with carry chain.

Parameters
lhsThe original value
rhsThe count by how much to shift lhs left.
carryThe carry data to or with the lower bits.
Returns
(result, carry); the carry which can be used to pass into the next iteration.

Shift logical right with carry chain.

Parameters
lhsThe original value
rhsThe count by how much to shift lhs right.
carryThe carry data to or with the lower bits.
Returns
(result, carry); the carry which can be used to pass into the next iteration.

Shift arithmetic right with carry chain.

Parameters
lhsThe original value
rhsThe count by how much to shift lhs right.
Returns
(result, carry); the carry which can be used to pass into the next iteration.

Add two numbers with carry chain.

Parameters
lhsThe left hand side
rhsThe right hand side
carryFrom the previous add in the chain
Returns
(result, carry) pair

Multiply with carry. The carry is a high-word of the multiplication result and has the same size as the inputs. The accumulator is used when doing long-multiplication from the previous row. This function does not overflow even if all the arguments are at max.

Parameters
lhsThe left hand side.
rhsThe right hand side.
carryThe carry-input; carry-output from the previous mul_carry().
accumulatorThe column value during a long multiply.
Returns
low, high of the result.

Wide divide. Can be used to divide a wide unsigned integer by a unsigned integer, as long as the result fits in an unsigned integer.

Parameters
lhs_loThe low side of a wide left-hand-side
lhs_hiThe high side of a wide left-hand-side
rhsThe right hand side
Returns
The result.

Bit scan reverse.

Parameters
lhsThe array of unsigned integers to find the highest set bit off.
nThe number of unsigned integers in the array.
Returns
index of leading one, or -1 when rhs is zero.

Invert unsigned integers using a carry-chain Technically this is not an carry chain.

Parameters
rThe result of the inversion.
rhsThe right hand side operand.
nThe number of digits of r and rhs.

shift logical right using a carry-chain

Parameters
rThe result of the logical-shift-right.
lhsThe left hand side operand of the lsr.
rhsThe right hand side operand of the lsr, the number of bits to shift.
nThe number of digits of r, lhs and rhs.

shift logical right using a carry-chain

Parameters
rThe result of the logical-shift-right.
lhsThe left hand side operand of the lsr.
rhsThe right hand side operand of the lsr, the number of bits to shift.
nThe number of digits of r, lhs and rhs.

shift arithmetic right using a carry-chain This sign-extends the left most bit.

Parameters
rThe result of the logical-shift-right.
lhsThe left hand side operand of the lsr.
rhsThe right hand side operand of the lsr, the number of bits to shift.
nThe number of digits of r, lhs and rhs.

and-operation unsigned integers using a carry-chain

Parameters
rThe result of the and-operation.
lhsThe left hand side operand of the and-operation.
rhsThe right hand side operand of the and-operation.
nThe number of digits of r, lhs and rhs.

or-operation unsigned integers using a carry-chain

Parameters
rThe result of the and-operation.
lhsThe left hand side operand of the or-operation.
rhsThe right hand side operand of the or-operation.
nThe number of digits of r, lhs and rhs.

xor-operation unsigned integers using a carry-chain

Parameters
rThe result of the and-operation.
lhsThe left hand side operand of the xor-operation.
rhsThe right hand side operand of the xor-operation.
nThe number of digits of r, lhs and rhs.

Negate unsigned integers using a carry-chain This is a two's compliment negate.

Parameters
rThe result of the addition.
rhsThe left hand side operand of the addition.
nThe number of digits of r, lhs and rhs.

Add unsigned integers using a carry-chain

Parameters
rThe result of the addition.
lhsThe left hand side operand of the addition.
rhsThe right hand side operand of the addition.
nThe number of digits of r, lhs and rhs.

Subtract unsigned integers using a carry-chain

Parameters
rThe result of the addition.
lhsThe left hand side operand of the addition.
rhsThe right hand side operand of the addition.
nThe number of digits of r, lhs and rhs.

Multiply unsigned integers using a carry-chain

Note
r May not alias with lhs or rhs.
Parameters
rThe result of the multiplication.
lhsThe left hand side operand.
rhsThe right hand side operand.
nThe number of digits of r, lhs and rhs.

Divide unsigned integers using a carry-chain This function does a bit-wise division.

Note
quotient and remainder may not alias with lhs or rhs or with each other.
Parameters
quotientThe result of the division.
remainderThe remainder of the division.
lhsThe left hand side operand.
rhsThe right hand side operand.
nThe number of digits of quotient, remainder, lhs and rhs.

signed divide unsigned integers using a carry-chain This function does a bit-wise division. This function will allocate memory when one or both operands are negative.

Note
quotient and remainder may not alias with lhs or rhs or with each other.
Parameters
quotientThe result of the division.
remainderThe remainder of the division. The remainder has same sign as lhs.
lhsThe left hand side operand.
rhsThe right hand side operand.
nThe number of digits of quotient, remainder, lhs and rhs.