DynamicAPIntHelper.h

Go to the documentation of this file.

//===-- DynamicAPIntHelper.h ------------------------------------*- C++ -*-===//
//
// Part of the LLZK Project, under the Apache License v2.0.
// See LICENSE.txt for license information.
// Copyright 2025 Veridise Inc.
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include "llzk/Util/Compare.h"
 
#include <llvm/ADT/APInt.h>
#include <llvm/ADT/APSInt.h>
#include <llvm/ADT/ArrayRef.h>
#include <llvm/ADT/DynamicAPInt.h>
#include <llvm/ADT/Hashing.h>
#include <llvm/ADT/StringRef.h>
#include <llvm/ADT/Twine.h>
#include <llvm/Support/Error.h>
 
#include <climits>
#include <concepts>
#include <cstddef>
#include <cstdint>
#include <limits>
 
namespace llzk {

llvm::Expected<llvm::DynamicAPInt> parseDynamicAPInt(llvm::StringRef str);

llvm::hash_code hashDynamicAPInt(const llvm::DynamicAPInt &value);

llvm::Expected<llvm::APInt>
checkedToAPInt(const llvm::DynamicAPInt &value, unsigned bitWidth, bool isSigned);

llvm::Expected<int64_t> checkedToInt64(const llvm::DynamicAPInt &value);

llvm::Expected<uint64_t> checkedToUInt64(const llvm::DynamicAPInt &value);

llvm::Expected<size_t> checkedToSize(const llvm::DynamicAPInt &value, const llvm::Twine &context);

llvm::DynamicAPInt operator&(const llvm::DynamicAPInt &lhs, const llvm::DynamicAPInt &rhs);
llvm::DynamicAPInt operator|(const llvm::DynamicAPInt &lhs, const llvm::DynamicAPInt &rhs);
llvm::DynamicAPInt operator^(const llvm::DynamicAPInt &lhs, const llvm::DynamicAPInt &rhs);

llvm::DynamicAPInt operator<<(const llvm::DynamicAPInt &lhs, const llvm::DynamicAPInt &rhs);
llvm::DynamicAPInt operator<<(const llvm::DynamicAPInt &lhs, int64_t rhs);
llvm::DynamicAPInt operator>>(const llvm::DynamicAPInt &lhs, const llvm::DynamicAPInt &rhs);
llvm::DynamicAPInt operator>>(const llvm::DynamicAPInt &lhs, int64_t rhs);

template <std::unsigned_integral T>
llvm::DynamicAPInt operator>>(const llvm::DynamicAPInt &lhs, T rhs) {
  if (rhs > static_cast<uint64_t>(std::numeric_limits<int64_t>::max())) {
    return llvm::DynamicAPInt(lhs < 0 ? -1 : 0);
  }
  return lhs >> static_cast<int64_t>(rhs);
}

llvm::DynamicAPInt toDynamicAPInt(llvm::StringRef str);
 
llvm::DynamicAPInt toDynamicAPInt(const llvm::APSInt &i);

llvm::DynamicAPInt toDynamicAPInt(const llvm::APInt &i);

llvm::DynamicAPInt toSignedDynamicAPInt(llvm::ArrayRef<uint64_t> parts);
 
inline llvm::DynamicAPInt toDynamicAPInt(size_t i) {
  return toDynamicAPInt(llvm::APInt(sizeof(size_t) * CHAR_BIT, llzk::checkedCast<uint64_t>(i)));
}

llvm::APSInt toAPSInt(const llvm::DynamicAPInt &i);

llvm::DynamicAPInt modExp(
    const llvm::DynamicAPInt &base, const llvm::DynamicAPInt &exp, const llvm::DynamicAPInt &mod
);
 
llvm::DynamicAPInt modInversePrime(const llvm::DynamicAPInt &f, const llvm::DynamicAPInt &p);
 
} // namespace llzk