bb::numeric::sparse_int< base, num_bits > Class Template Reference

Integer type that stores each bit as a separate digit in the given base. Supports addition with single-pass carry propagation. Used to build plookup tables for bitwise operations (XOR, AND) where two sparse_ints are added and the resulting per-digit values encode the operation's truth table. More...

#include <sparse_form.hpp>

Public Member Functions
	sparse_int (const uint64_t input=0)
	sparse_int (const sparse_int &other) noexcept=default
	sparse_int (sparse_int &&other) noexcept=default
sparse_int &	operator= (const sparse_int &other) noexcept=default
sparse_int &	operator= (sparse_int &&other) noexcept=default
	~sparse_int () noexcept=default
sparse_int	operator+ (const sparse_int &other) const
sparse_int	operator+= (const sparse_int &other)
uint64_t	get_value () const
uint64_t	get_sparse_value () const
const std::array< uint64_t, num_bits > &	get_limbs () const

Private Attributes
std::array< uint64_t, num_bits >	limbs
uint64_t	value

Detailed Description

template<uint64_t base, size_t num_bits>
class bb::numeric::sparse_int< base, num_bits >

Integer type that stores each bit as a separate digit in the given base. Supports addition with single-pass carry propagation. Used to build plookup tables for bitwise operations (XOR, AND) where two sparse_ints are added and the resulting per-digit values encode the operation's truth table.

Definition at line 135 of file sparse_form.hpp.

Constructor & Destructor Documentation

sparse_int() [1/3]

template<uint64_t base, size_t num_bits>

bb::numeric::sparse_int< base, num_bits >::sparse_int ( const uint64_t  input = 0 )

inline

Definition at line 137 of file sparse_form.hpp.

sparse_int() [2/3]

template<uint64_t base, size_t num_bits>

bb::numeric::sparse_int< base, num_bits >::sparse_int ( const sparse_int< base, num_bits > &  other )

defaultnoexcept

sparse_int() [3/3]

template<uint64_t base, size_t num_bits>

bb::numeric::sparse_int< base, num_bits >::sparse_int ( sparse_int< base, num_bits > &&  other )

defaultnoexcept

~sparse_int()

template<uint64_t base, size_t num_bits>

bb::numeric::sparse_int< base, num_bits >::~sparse_int ( )

defaultnoexcept

Member Function Documentation

get_limbs()

template<uint64_t base, size_t num_bits>

const std::array< uint64_t, num_bits > & bb::numeric::sparse_int< base, num_bits >::get_limbs ( ) const

inline

Definition at line 190 of file sparse_form.hpp.

get_sparse_value()

template<uint64_t base, size_t num_bits>

uint64_t bb::numeric::sparse_int< base, num_bits >::get_sparse_value ( ) const

inline

Definition at line 180 of file sparse_form.hpp.

get_value()

template<uint64_t base, size_t num_bits>

uint64_t bb::numeric::sparse_int< base, num_bits >::get_value ( ) const

inline

Definition at line 178 of file sparse_form.hpp.

operator+()

template<uint64_t base, size_t num_bits>

sparse_int bb::numeric::sparse_int< base, num_bits >::operator+ ( const sparse_int< base, num_bits > &  other ) const

inline

Definition at line 153 of file sparse_form.hpp.

operator+=()

template<uint64_t base, size_t num_bits>

sparse_int bb::numeric::sparse_int< base, num_bits >::operator+= ( const sparse_int< base, num_bits > &  other )

inline

Definition at line 172 of file sparse_form.hpp.

operator=() [1/2]

template<uint64_t base, size_t num_bits>

sparse_int & bb::numeric::sparse_int< base, num_bits >::operator= ( const sparse_int< base, num_bits > &  other )

defaultnoexcept

operator=() [2/2]

template<uint64_t base, size_t num_bits>

sparse_int & bb::numeric::sparse_int< base, num_bits >::operator= ( sparse_int< base, num_bits > &&  other )

defaultnoexcept

Member Data Documentation

limbs

template<uint64_t base, size_t num_bits>

std::array<uint64_t, num_bits> bb::numeric::sparse_int< base, num_bits >::limbs

private

Definition at line 193 of file sparse_form.hpp.

value

template<uint64_t base, size_t num_bits>

uint64_t bb::numeric::sparse_int< base, num_bits >::value

private

Definition at line 194 of file sparse_form.hpp.

---

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

• src/barretenberg/numeric/bitop/sparse_form.hpp