Module arrays

Structs

• ClaimedLengthArray
  ClaimedLengthArray - An array interpreted by Kernel circuits. Its length is merely a claim that must eventually be validated. Validation must include:

  • Asserting all items to the LHS of the length are nonempty (dense).
  • Asserting all items to the RHS of the length are empty.
• SortedTuple

Functions

• array_length
  Helper function to count the number of non-empty elements in a validated array. Danger: This is only safe to call if the input arrays have been "validated" (dense lhs, empty rhs).

  1. All elements before the first empty element are non-empty
  2. All elements after and including the first empty element are empty
  3. The array forms a contiguous sequence of non-empty elements followed by empty elements
• array_length_until
• array_merge
  This function assumes that array1 and array2 contain no more than N non-empty elements between them, if this is not the case then elements from the end of array2 will be dropped. Danger: This is only safe to call if the input arrays have been "validated" (dense lhs, empty rhs).
• array_padded_with
• assert_trailing_zeros
  Asserts that all fields in input after the first in_len fields are zero.
• check_permutation
• copy_items_into_array
  Copies up to num_items_to_copy items from array2 into array1, starting at start_index, and returns a new array with the modifications.
• find_first_index
  Helper function to find the index of the first element in an array that satisfies a given predicate. If the element is not found, the function returns the length of the array N
• find_last_index
  Helper function to find the index of the last element in an array that satisfies a given predicate. If the element is not found, the function returns the length of the array N
• get_sorted_tuples
  Sorts the input array, but also outputs an original_index field for each sorted item, so that you know where it came from.
• subarray
  Helper fn to create a subarray from a given array.
• trimmed_array_length_hint