#include <uint256.hpp>

Public Member Functions
constexpr	uint256_t () noexcept

template<std::integral T> requires (!std::same_as<std::remove_cv_t<T>, bool> && sizeof(T) <= sizeof(uint64_t))
constexpr	uint256_t (T value) noexcept

constexpr	uint256_t (const uint64_t a, const uint64_t b, const uint64_t c, const uint64_t d) noexcept

constexpr	uint256_t (const uint128_t &a) noexcept

constexpr	uint256_t (const uint256_t &other) noexcept

constexpr	uint256_t (uint256_t &&other) noexcept=default

constexpr	uint256_t (const std::string &input) noexcept

constexpr uint256_t &	operator= (const uint256_t &other) noexcept=default

constexpr uint256_t &	operator= (uint256_t &&other) noexcept=default

constexpr	~uint256_t () noexcept=default

constexpr	operator bool () const

constexpr	operator uint128_t ()

template<std::integral T>
constexpr	operator T () const

constexpr bool	get_bit (uint64_t bit_index) const

constexpr uint64_t	get_msb () const

constexpr uint256_t	slice (uint64_t start, uint64_t end) const

constexpr uint256_t	pow (const uint256_t &exponent) const

constexpr uint256_t	operator+ (const uint256_t &other) const

constexpr uint256_t	operator- (const uint256_t &other) const

constexpr uint256_t	operator- () const

constexpr uint256_t	operator* (const uint256_t &other) const

constexpr uint256_t	operator/ (const uint256_t &other) const

constexpr uint256_t	operator% (const uint256_t &other) const

constexpr uint256_t	operator>> (const uint256_t &other) const

constexpr uint256_t	operator<< (const uint256_t &other) const

constexpr uint256_t	operator& (const uint256_t &other) const

constexpr uint256_t	operator^ (const uint256_t &other) const

constexpr uint256_t	operator\| (const uint256_t &other) const

constexpr uint256_t	operator~ () const

constexpr bool	operator== (const uint256_t &other) const

constexpr bool	operator!= (const uint256_t &other) const

constexpr bool	operator! () const

constexpr bool	operator> (const uint256_t &other) const

constexpr bool	operator< (const uint256_t &other) const

constexpr bool	operator>= (const uint256_t &other) const

constexpr bool	operator<= (const uint256_t &other) const

constexpr uint256_t &	operator+= (const uint256_t &other)

constexpr uint256_t &	operator-= (const uint256_t &other)

constexpr uint256_t &	operator*= (const uint256_t &other)

constexpr uint256_t &	operator/= (const uint256_t &other)

constexpr uint256_t &	operator%= (const uint256_t &other)

constexpr uint256_t &	operator++ ()

constexpr uint256_t &	operator-- ()

constexpr uint256_t &	operator&= (const uint256_t &other)

constexpr uint256_t &	operator^= (const uint256_t &other)

constexpr uint256_t &	operator\|= (const uint256_t &other)

constexpr uint256_t &	operator>>= (const uint256_t &other)

constexpr uint256_t &	operator<<= (const uint256_t &other)

constexpr std::pair< uint256_t, uint256_t >	mul_extended (const uint256_t &other) const
	Compute the result of multiplication modulu 2**512.

constexpr std::pair< uint256_t, uint256_t >	divmod (const uint256_t &b) const

constexpr std::pair< uint256_t, uint64_t >	divmod (uint64_t b) const
	Optimized divmod for a single-limb divisor using schoolbook long division in base 2^64. For smaller divisors this is significantly faster than the general divmod. Each iteration divides a 128-bit intermediate (remainder << 64 \| limb) by b, which is safe because the invariant remainder < b guarantees the quotient limb fits in 64 bits. Falls back to the uint256_t overload for wasm.

size_t	hash () const noexcept

void	msgpack_pack (auto &packer) const

void	msgpack_unpack (auto o)

void	msgpack_schema (auto &packer) const

Static Public Member Functions
static constexpr size_t	length ()

Public Attributes
uint64_t	data [4]

Static Private Member Functions
static constexpr std::pair< uint64_t, uint64_t >	mul_wide (uint64_t a, uint64_t b)

static constexpr std::pair< uint64_t, uint64_t >	addc (uint64_t a, uint64_t b, uint64_t carry_in)

static constexpr uint64_t	addc_discard_hi (uint64_t a, uint64_t b, uint64_t carry_in)

static constexpr uint64_t	sbb_discard_hi (uint64_t a, uint64_t b, uint64_t borrow_in)

static constexpr std::pair< uint64_t, uint64_t >	sbb (uint64_t a, uint64_t b, uint64_t borrow_in)

static constexpr uint64_t	mac_discard_hi (uint64_t a, uint64_t b, uint64_t c, uint64_t carry_in)

static constexpr std::pair< uint64_t, uint64_t >	mac (uint64_t a, uint64_t b, uint64_t c, uint64_t carry_in)

static constexpr void	wasm_madd (const uint64_t &left_limb, const uint64_t *right_limbs, uint64_t &result_0, uint64_t &result_1, uint64_t &result_2, uint64_t &result_3, uint64_t &result_4, uint64_t &result_5, uint64_t &result_6, uint64_t &result_7, uint64_t &result_8)
	Multiply one limb by 9 limbs and add to resulting limbs.

static constexpr std::array< uint64_t, WASM_NUM_LIMBS >	wasm_convert (const uint64_t *data)
	Convert from 4 64-bit limbs to 9 29-bit limbs.

Detailed Description

Definition at line 32 of file uint256.hpp.

Constructor & Destructor Documentation

◆ uint256_t() [1/7]

constexpr bb::numeric::uint256_t::uint256_t ( )

inlineconstexprnoexcept

Definition at line 39 of file uint256.hpp.

◆ uint256_t() [2/7]

template<std::integral T>
requires (!std::same_as<std::remove_cv_t<T>, bool> && sizeof(T) <= sizeof(uint64_t))

constexpr bb::numeric::uint256_t::uint256_t ( T value )

inlineconstexprnoexcept

Definition at line 49 of file uint256.hpp.

◆ uint256_t() [3/7]

constexpr bb::numeric::uint256_t::uint256_t	(	const uint64_t	a,
		const uint64_t	b,
		const uint64_t	c,
		const uint64_t	d
	)

inlineconstexprnoexcept

Definition at line 53 of file uint256.hpp.

◆ uint256_t() [4/7]

constexpr bb::numeric::uint256_t::uint256_t ( const uint128_t & a )

inlineconstexprnoexcept

Definition at line 57 of file uint256.hpp.

◆ uint256_t() [5/7]

constexpr bb::numeric::uint256_t::uint256_t ( const uint256_t & other )

inlineconstexprnoexcept

Definition at line 61 of file uint256.hpp.

◆ uint256_t() [6/7]

constexpr bb::numeric::uint256_t::uint256_t ( uint256_t && other )

constexprdefaultnoexcept

◆ uint256_t() [7/7]

constexpr bb::numeric::uint256_t::uint256_t ( const std::string & input )

inlineexplicitconstexprnoexcept

Definition at line 66 of file uint256.hpp.

◆ ~uint256_t()

constexpr bb::numeric::uint256_t::~uint256_t ( )

constexprdefaultnoexcept

Member Function Documentation

◆ addc()

constexpr std::pair< uint64_t, uint64_t > bb::numeric::uint256_t::addc	(	uint64_t	a,
		uint64_t	b,
		uint64_t	carry_in
	)

staticconstexprprivate

Definition at line 32 of file uint256_impl.hpp.

◆ addc_discard_hi()

constexpr uint64_t bb::numeric::uint256_t::addc_discard_hi	(	uint64_t	a,
		uint64_t	b,
		uint64_t	carry_in
	)

staticconstexprprivate

Definition at line 41 of file uint256_impl.hpp.

◆ divmod() [1/2]

constexpr std::pair< uint256_t, uint256_t > bb::numeric::uint256_t::divmod ( const uint256_t & b ) const

constexpr

Definition at line 129 of file uint256_impl.hpp.

◆ divmod() [2/2]

constexpr std::pair< uint256_t, uint64_t > bb::numeric::uint256_t::divmod ( uint64_t b ) const

constexpr

Optimized divmod for a single-limb divisor using schoolbook long division in base 2^64. For smaller divisors this is significantly faster than the general divmod. Each iteration divides a 128-bit intermediate (remainder << 64 | limb) by b, which is safe because the invariant remainder < b guarantees the quotient limb fits in 64 bits. Falls back to the uint256_t overload for wasm.

Definition at line 184 of file uint256_impl.hpp.

◆ get_bit()

constexpr bool bb::numeric::uint256_t::get_bit ( uint64_t bit_index ) const

constexpr

Definition at line 352 of file uint256_impl.hpp.

◆ get_msb()

constexpr uint64_t bb::numeric::uint256_t::get_msb ( ) const

constexpr

Definition at line 362 of file uint256_impl.hpp.

◆ hash()

size_t bb::numeric::uint256_t::hash ( ) const

inlinenoexcept

Definition at line 221 of file uint256.hpp.

◆ length()

static constexpr size_t bb::numeric::uint256_t::length ( )

inlinestaticconstexpr

Definition at line 148 of file uint256.hpp.

◆ mac()

constexpr std::pair< uint64_t, uint64_t > bb::numeric::uint256_t::mac	(	uint64_t	a,
		uint64_t	b,
		uint64_t	c,
		uint64_t	carry_in
	)

staticconstexprprivate

Definition at line 62 of file uint256_impl.hpp.

◆ mac_discard_hi()

constexpr uint64_t bb::numeric::uint256_t::mac_discard_hi	(	uint64_t	a,
		uint64_t	b,
		uint64_t	c,
		uint64_t	carry_in
	)

staticconstexprprivate

Definition at line 76 of file uint256_impl.hpp.

◆ msgpack_pack()

void bb::numeric::uint256_t::msgpack_pack ( auto & packer ) const

Definition at line 662 of file uint256_impl.hpp.

◆ msgpack_schema()

void bb::numeric::uint256_t::msgpack_schema ( auto & packer ) const

inline

Definition at line 226 of file uint256.hpp.

◆ msgpack_unpack()

void bb::numeric::uint256_t::msgpack_unpack ( auto o )

Definition at line 675 of file uint256_impl.hpp.

◆ mul_extended()

constexpr std::pair< uint256_t, uint256_t > bb::numeric::uint256_t::mul_extended ( const uint256_t & other ) const

constexpr

Compute the result of multiplication modulu 2**512.

Definition at line 213 of file uint256_impl.hpp.

◆ mul_wide()

constexpr std::pair< uint64_t, uint64_t > bb::numeric::uint256_t::mul_wide	(	uint64_t	a,
		uint64_t	b
	)

staticconstexprprivate

Definition at line 14 of file uint256_impl.hpp.

◆ operator bool()

constexpr bb::numeric::uint256_t::operator bool ( ) const

inlineexplicitconstexpr

Definition at line 112 of file uint256.hpp.

◆ operator T()

template<std::integral T>

constexpr bb::numeric::uint256_t::operator T ( ) const

inlineexplicitconstexpr

Definition at line 115 of file uint256.hpp.

◆ operator uint128_t()

constexpr bb::numeric::uint256_t::operator uint128_t ( )

inlineexplicitconstexpr

Definition at line 114 of file uint256.hpp.

◆ operator!()

constexpr bool bb::numeric::uint256_t::operator! ( ) const

constexpr

Definition at line 536 of file uint256_impl.hpp.

◆ operator!=()

constexpr bool bb::numeric::uint256_t::operator!= ( const uint256_t & other ) const

constexpr

Definition at line 531 of file uint256_impl.hpp.

◆ operator%()

constexpr uint256_t bb::numeric::uint256_t::operator% ( const uint256_t & other ) const

constexpr

Definition at line 501 of file uint256_impl.hpp.

◆ operator%=()

constexpr uint256_t & bb::numeric::uint256_t::operator%= ( const uint256_t & other )

inlineconstexpr

Definition at line 170 of file uint256.hpp.

◆ operator&()

constexpr uint256_t bb::numeric::uint256_t::operator& ( const uint256_t & other ) const

constexpr

Definition at line 506 of file uint256_impl.hpp.

◆ operator&=()

constexpr uint256_t & bb::numeric::uint256_t::operator&= ( const uint256_t & other )

inlineconstexpr

Definition at line 187 of file uint256.hpp.

◆ operator*()

constexpr uint256_t bb::numeric::uint256_t::operator* ( const uint256_t & other ) const

constexpr

Definition at line 395 of file uint256_impl.hpp.

◆ operator*=()

constexpr uint256_t & bb::numeric::uint256_t::operator*= ( const uint256_t & other )

inlineconstexpr

Definition at line 160 of file uint256.hpp.

◆ operator+()

constexpr uint256_t bb::numeric::uint256_t::operator+ ( const uint256_t & other ) const

constexpr

Definition at line 371 of file uint256_impl.hpp.

◆ operator++()

constexpr uint256_t & bb::numeric::uint256_t::operator++ ( )

inlineconstexpr

Definition at line 176 of file uint256.hpp.

◆ operator+=()

constexpr uint256_t & bb::numeric::uint256_t::operator+= ( const uint256_t & other )

inlineconstexpr

Definition at line 150 of file uint256.hpp.

◆ operator-() [1/2]

constexpr uint256_t bb::numeric::uint256_t::operator- ( ) const

constexpr

Definition at line 390 of file uint256_impl.hpp.

◆ operator-() [2/2]

constexpr uint256_t bb::numeric::uint256_t::operator- ( const uint256_t & other ) const

constexpr

Definition at line 380 of file uint256_impl.hpp.

◆ operator--()

constexpr uint256_t & bb::numeric::uint256_t::operator-- ( )

inlineconstexpr

Definition at line 181 of file uint256.hpp.

◆ operator-=()

constexpr uint256_t & bb::numeric::uint256_t::operator-= ( const uint256_t & other )

inlineconstexpr

Definition at line 155 of file uint256.hpp.

◆ operator/()

constexpr uint256_t bb::numeric::uint256_t::operator/ ( const uint256_t & other ) const

constexpr

Definition at line 496 of file uint256_impl.hpp.

◆ operator/=()

constexpr uint256_t & bb::numeric::uint256_t::operator/= ( const uint256_t & other )

inlineconstexpr

Definition at line 165 of file uint256.hpp.

◆ operator<()

constexpr bool bb::numeric::uint256_t::operator< ( const uint256_t & other ) const

constexpr

Definition at line 556 of file uint256_impl.hpp.

◆ operator<<()

constexpr uint256_t bb::numeric::uint256_t::operator<< ( const uint256_t & other ) const

constexpr

Definition at line 614 of file uint256_impl.hpp.

◆ operator<<=()

constexpr uint256_t & bb::numeric::uint256_t::operator<<= ( const uint256_t & other )

inlineconstexpr

Definition at line 208 of file uint256.hpp.

◆ operator<=()

constexpr bool bb::numeric::uint256_t::operator<= ( const uint256_t & other ) const

constexpr

Definition at line 561 of file uint256_impl.hpp.

◆ operator=() [1/2]

constexpr uint256_t & bb::numeric::uint256_t::operator= ( const uint256_t & other )

constexprdefaultnoexcept

◆ operator=() [2/2]

constexpr uint256_t & bb::numeric::uint256_t::operator= ( uint256_t && other )

constexprdefaultnoexcept

◆ operator==()

constexpr bool bb::numeric::uint256_t::operator== ( const uint256_t & other ) const

constexpr

Definition at line 526 of file uint256_impl.hpp.

◆ operator>()

constexpr bool bb::numeric::uint256_t::operator> ( const uint256_t & other ) const

constexpr

Definition at line 541 of file uint256_impl.hpp.

◆ operator>=()

constexpr bool bb::numeric::uint256_t::operator>= ( const uint256_t & other ) const

constexpr

Definition at line 551 of file uint256_impl.hpp.

◆ operator>>()

constexpr uint256_t bb::numeric::uint256_t::operator>> ( const uint256_t & other ) const

constexpr

Definition at line 566 of file uint256_impl.hpp.

◆ operator>>=()

constexpr uint256_t & bb::numeric::uint256_t::operator>>= ( const uint256_t & other )

inlineconstexpr

Definition at line 203 of file uint256.hpp.

◆ operator^()

constexpr uint256_t bb::numeric::uint256_t::operator^ ( const uint256_t & other ) const

constexpr

Definition at line 511 of file uint256_impl.hpp.

◆ operator^=()

constexpr uint256_t & bb::numeric::uint256_t::operator^= ( const uint256_t & other )

inlineconstexpr

Definition at line 192 of file uint256.hpp.

◆ operator|()

constexpr uint256_t bb::numeric::uint256_t::operator| ( const uint256_t & other ) const

constexpr

Definition at line 516 of file uint256_impl.hpp.

◆ operator|=()

constexpr uint256_t & bb::numeric::uint256_t::operator|= ( const uint256_t & other )

inlineconstexpr

Definition at line 197 of file uint256.hpp.

◆ operator~()

constexpr uint256_t bb::numeric::uint256_t::operator~ ( ) const

constexpr

Definition at line 521 of file uint256_impl.hpp.

◆ pow()

constexpr uint256_t bb::numeric::uint256_t::pow ( const uint256_t & exponent ) const

constexpr

Definition at line 332 of file uint256_impl.hpp.

◆ sbb()

constexpr std::pair< uint64_t, uint64_t > bb::numeric::uint256_t::sbb	(	uint64_t	a,
		uint64_t	b,
		uint64_t	borrow_in
	)

staticconstexprprivate

Definition at line 46 of file uint256_impl.hpp.

◆ sbb_discard_hi()

constexpr uint64_t bb::numeric::uint256_t::sbb_discard_hi	(	uint64_t	a,
		uint64_t	b,
		uint64_t	borrow_in
	)

staticconstexprprivate

Definition at line 56 of file uint256_impl.hpp.

◆ slice()

constexpr uint256_t bb::numeric::uint256_t::slice	(	uint64_t	start,
		uint64_t	end
	)		const

constexpr

Viewing this uint256_t as a bit string, and counting bits from 0, slices a substring.

Returns: the uint256_t equal to the substring of bits from (and including) the start-th bit, to (but excluding) the end-th bit of this.

Definition at line 324 of file uint256_impl.hpp.

◆ wasm_convert()

constexpr std::array< uint64_t, WASM_NUM_LIMBS > bb::numeric::uint256_t::wasm_convert ( const uint64_t * data )

staticconstexprprivate

Convert from 4 64-bit limbs to 9 29-bit limbs.

Definition at line 116 of file uint256_impl.hpp.

◆ wasm_madd()

constexpr void bb::numeric::uint256_t::wasm_madd	(	const uint64_t &	left_limb,
		const uint64_t *	right_limbs,
		uint64_t &	result_0,
		uint64_t &	result_1,
		uint64_t &	result_2,
		uint64_t &	result_3,
		uint64_t &	result_4,
		uint64_t &	result_5,
		uint64_t &	result_6,
		uint64_t &	result_7,
		uint64_t &	result_8
	)

staticconstexprprivate

Multiply one limb by 9 limbs and add to resulting limbs.

Definition at line 89 of file uint256_impl.hpp.

Member Data Documentation

◆ data

uint64_t bb::numeric::uint256_t::data[4]

Definition at line 216 of file uint256.hpp.

The documentation for this class was generated from the following files:

src/barretenberg/numeric/uint256/uint256.hpp
src/barretenberg/numeric/uint256/uint256_impl.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ uint256_t() [1/7]

◆ uint256_t() [2/7]

◆ uint256_t() [3/7]

◆ uint256_t() [4/7]

◆ uint256_t() [5/7]

◆ uint256_t() [6/7]

◆ uint256_t() [7/7]

◆ ~uint256_t()

Member Function Documentation

◆ addc()

◆ addc_discard_hi()

◆ divmod() [1/2]

◆ divmod() [2/2]

◆ get_bit()

◆ get_msb()

◆ hash()

◆ length()

◆ mac()

◆ mac_discard_hi()

◆ msgpack_pack()

◆ msgpack_schema()

◆ msgpack_unpack()

◆ mul_extended()

◆ mul_wide()

◆ operator bool()

◆ operator T()

◆ operator uint128_t()

◆ operator!()

◆ operator!=()

◆ operator%()

◆ operator%=()

◆ operator&()

◆ operator&=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator++()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator--()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator<<()

◆ operator<<=()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator>>()

◆ operator>>=()

◆ operator^()

◆ operator^=()

◆ operator|()

◆ operator|=()

◆ operator~()

◆ pow()

◆ sbb()

◆ sbb_discard_hi()

◆ slice()

◆ wasm_convert()

◆ wasm_madd()

Member Data Documentation

◆ data