array.hpp

Go to the documentation of this file.

// === AUDIT STATUS ===
// internal:    { status: not started, auditors: [], date: YYYY-MM-DD }
// external_1:  { status: not started, auditors: [], date: YYYY-MM-DD }
// external_2:  { status: not started, auditors: [], date: YYYY-MM-DD }
// =====================
 
#pragma once
#include "../bool/bool.hpp"
#include "../safe_uint/safe_uint.hpp"
#include "field.hpp"
 
namespace bb::stdlib {
 
template <typename Builder, size_t SIZE> field_t<Builder> array_length(std::array<field_t<Builder>, SIZE> const& arr)
{
    field_t<Builder> length = 0;
    bool_t<Builder> hit_zero = false;
    for (const auto& e : arr) {
        bool_t<Builder> is_zero = e.is_zero();
        hit_zero.must_imply(is_zero, "Once we've hit the first zero, there must only be zeros thereafter!");
        hit_zero |= is_zero;
        const field_t<Builder> increment = !hit_zero;
        length += increment;
    }
    return length;
};
 
template <typename Builder, size_t SIZE> field_t<Builder> array_pop(std::array<field_t<Builder>, SIZE> const& arr)
{
    field_t<Builder> popped_value = 0;
    bool_t<Builder> already_popped = { arr[0].context, false };
 
    for (size_t i = arr.size() - 1; i != (size_t)-1; i--) {
        bool_t<Builder> is_non_zero = arr[i] != 0;
        popped_value = field_t<Builder>::conditional_assign(!already_popped && is_non_zero, arr[i], popped_value);
 
        already_popped |= is_non_zero;
    }
    already_popped.assert_equal(true, "array_pop cannot pop from an empty array");
 
    return popped_value;
};
 
template <typename Builder, size_t SIZE>
void array_push(std::array<field_t<Builder>, SIZE>& arr, field_t<Builder> const& value)
{
    bool_t<Builder> already_pushed = false;
    for (size_t i = 0; i < arr.size(); ++i) {
        bool_t<Builder> is_zero = arr[i] == 0;
        arr[i] = field_t<Builder>::conditional_assign(!already_pushed && is_zero, value, arr[i]);
 
        already_pushed |= is_zero;
    }
    already_pushed.assert_equal(true, "array_push cannot push to a full array");
};
 
template <typename Builder, size_t SIZE>
inline size_t array_push(std::array<std::optional<field_t<Builder>>, SIZE>& arr, field_t<Builder> const& value)
{
    for (size_t i = 0; i < arr.size(); ++i) {
        if (arr[i] == std::nullopt) {
            arr[i] = value;
            return i;
        }
    }
    throw_or_abort("array_push cannot push to a full array");
};
 
template <typename T, size_t SIZE>
inline size_t array_push(std::array<std::shared_ptr<T>, SIZE>& arr, std::shared_ptr<T> const& value)
{
    for (size_t i = 0; i < arr.size(); ++i) {
        if (arr[i] == nullptr) {
            arr[i] = value;
            return i;
        }
    }
    throw_or_abort("array_push cannot push to a full array");
};
 
template <typename Builder, typename T, size_t SIZE> inline void array_push(std::array<T, SIZE>& arr, T const& value)
{
    bool_t<Builder> already_pushed = false;
    for (size_t i = 0; i < arr.size(); ++i) {
        bool_t<Builder> is_zero = arr[i].is_empty();
        arr[i].conditional_select(!already_pushed && is_zero, value);
 
        already_pushed |= is_zero;
    }
    already_pushed.assert_equal(true, "array_push cannot push to a full array");
};
 
template <typename Builder, size_t SIZE>
typename stdlib::bool_t<Builder> is_array_empty(std::array<field_t<Builder>, SIZE> const& arr)
{
    bool_t<Builder> nonzero_found = false;
    for (size_t i = arr.size() - 1; i != (size_t)-1; i--) {
        bool_t<Builder> is_non_zero = arr[i] != 0;
        nonzero_found |= is_non_zero;
    }
    return !nonzero_found;
};
 
template <typename Builder, size_t size_1, size_t size_2>
void push_array_to_array(std::array<field_t<Builder>, size_1> const& source,
                         std::array<field_t<Builder>, size_2>& target)
{
    field_t<Builder> target_length = array_length<Builder>(target);
    const field_t<Builder> overflow_capacity = target.max_size() + 1;
 
    field_t<Builder> j_ct = 0; // circuit-type index for the inner loop
    // Find the first empty slot in the target:
    field_t<Builder> next_target_index = target_length;
 
    bool_t<Builder> hit_s_zero = false;
    bool_t<Builder> not_hit_s_zero = true;
 
    for (size_t i = 0; i < source.max_size(); ++i) {
        // Loop over each source value we want to push:
        auto& s = source[i];
        {
            auto is_s_zero = s.is_zero();
            hit_s_zero.must_imply(is_s_zero,
                                  "Once we've hit the first source zero, there must only be zeros thereafter!");
            hit_s_zero |= is_s_zero;
            not_hit_s_zero = !hit_s_zero;
        }
 
        // Triangular loop:
        for (size_t j = i; j < target.max_size(); ++j) {
            auto& t = target[j];
 
            // Check whether we've reached the next target index at which we can push `s`:
            bool_t<Builder> at_next_target_index = j_ct == next_target_index;
 
            t = field_t<Builder>::conditional_assign(at_next_target_index && not_hit_s_zero, s, t);
 
            j_ct++;
        }
 
        next_target_index += not_hit_s_zero;
 
        next_target_index.assert_not_equal(overflow_capacity, "push_array_to_array target array capacity exceeded");
 
        j_ct = i + 1;
    }
}
 
} // namespace bb::stdlib