bits.hpp

Go to the documentation of this file.

// Copyright (c) 2015-2022 Clearmatics Technologies Ltd
//
// SPDX-License-Identifier: LGPL-3.0+
 
#ifndef __ZETH_CORE_BITS_HPP__
#define __ZETH_CORE_BITS_HPP__
 
#include "libzeth/core/include_libsnark.hpp"
 
#include <array>
#include <iostream>
#include <stddef.h>
#include <vector>
 
namespace libzeth
{
 
// Forward declarations
template<size_t numBits> class bits;
 
template<size_t numBits>
bits<numBits> bits_xor(const bits<numBits> &a, const bits<numBits> &b);
 
template<size_t numBits>
bits<numBits> bits_add(
    const bits<numBits> &a, const bits<numBits> &b, bool with_carry = false);
 
template<size_t numBits> class bits : public std::array<bool, numBits>
{
public:
    bits();
 
    // cppcheck-suppress noExplicitConstructor
    template<typename... boolList> bits(const boolList &...bits);
 
    std::vector<bool> to_vector() const;
 
    static bits from_vector(const std::vector<bool> &bin);
 
    static bits from_hex(const std::string &hex);
 
    static bits from_size_t(size_t addr);
 
    bool is_zero() const;
 
    template<typename FieldT>
    void fill_pb_variable_array(
        libsnark::protoboard<FieldT> &pb,
        libsnark::pb_variable_array<FieldT> &var_array) const;
 
protected:
    template<typename boolIt> explicit bits(boolIt it);
    template<typename boolIt> void fill_from_iterator(boolIt it);
 
    friend bits bits_xor<numBits>(const bits &, const bits &);
    friend bits bits_add<numBits>(const bits &, const bits &, bool);
};
 
using bits32 = bits<32>;
 
using bits64 = bits<64>;
 
// 256-bit array t
using bits256 = bits<256>;
 
using bits384 = bits<384>;
 
template<size_t TreeDepth> using bits_addr = bits<TreeDepth>;
 
std::vector<bool> bit_vector_from_hex(const std::string &str);
 
std::vector<bool> bit_vector_from_size_t_le(size_t x);
 
std::vector<bool> bit_vector_from_size_t_be(size_t x);
 
void bit_vector_write_string(
    const std::vector<bool> &bits, std::ostream &out_s);
 
} // namespace libzeth
 
#include "libzeth/core/bits.tcc"
 
#endif // __ZETH_CORE_BITS_HPP__