WitgenUtils.h

Go to the documentation of this file.

//===-- WitgenUtils.h - llzk-witgen shared helpers --------------*- C++ -*-===//
//
// Part of the LLZK Project, under the Apache License v2.0.
// See LICENSE.txt for license information.
// Copyright 2026 Project LLZK
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include "Errors.h"
#include "WitgenDriver.h"
 
#include <mlir/IR/BuiltinTypes.h>
 
#include <llvm/ADT/ArrayRef.h>
#include <llvm/ADT/DynamicAPInt.h>
#include <llvm/ADT/StringRef.h>
#include <llvm/Support/Error.h>
 
#include <cstddef>
#include <random>
#include <utility>
 
namespace llzk::witgen {
 
template <typename T, typename U> inline llvm::Expected<T> checkedCast(U u) {
  if (std::in_range<T>(u)) {
    return static_cast<T>(u);
  }
  return makeError("lossy integer conversion");
}

std::mt19937_64 makeDefaultValueRng(const WitgenOptions &options);

llvm::DynamicAPInt randomFieldElement(std::mt19937_64 &rng, const Field &field);

int64_t randomIndexValue(std::mt19937_64 &rng);

bool randomBoolValue(std::mt19937_64 &rng);

llvm::Expected<size_t> checkedShapeDimToSize(int64_t dim, llvm::StringRef context);

llvm::Expected<size_t>
checkedDynamicAPIntToSize(const llvm::DynamicAPInt &value, llvm::StringRef context);

llvm::Expected<size_t>
getStaticShapeElementCount(llvm::ArrayRef<int64_t> shape, llvm::StringRef context);

llvm::Expected<size_t> getStaticElementCount(mlir::ShapedType type, llvm::StringRef context);
 
} // namespace llzk::witgen