LLZK 2.0.0
An open-source IR for Zero Knowledge (ZK) circuits
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT > Class Template Reference
Inheritance diagram for llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >:
[legend]
Collaboration diagram for llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >:
[legend]

Public Types

using Base = IntervalAnalysisPrinterPassBase

Public Member Functions

 IntervalAnalysisPrinterPassBase ()
 IntervalAnalysisPrinterPassBase (const IntervalAnalysisPrinterPassBase &other)
IntervalAnalysisPrinterPassBase & operator= (const IntervalAnalysisPrinterPassBase &)=delete
 IntervalAnalysisPrinterPassBase (IntervalAnalysisPrinterPassBase &&)=delete
IntervalAnalysisPrinterPassBase & operator= (IntervalAnalysisPrinterPassBase &&)=delete
 ~IntervalAnalysisPrinterPassBase ()=default
::llvm::StringRef getArgument () const override
::llvm::StringRef getDescription () const override
::llvm::StringRef getName () const override
std::unique_ptr<::mlir::Pass > clonePass () const override
 A clone method to create a copy of this pass.
void getDependentDialects (::mlir::DialectRegistry &registry) const override
 Return the dialect that must be loaded in the context before this pass.
 IntervalAnalysisPrinterPassBase (IntervalAnalysisPrinterPassOptions options)
 Explicitly declare the TypeID for this class.

Static Public Member Functions

static constexpr ::llvm::StringLiteral getArgumentName ()
 Returns the command-line argument attached to this pass.
static constexpr ::llvm::StringLiteral getPassName ()
 Returns the derived pass name.
static bool classof (const ::mlir::Pass *pass)
 Support isa/dyn_cast functionality for the derived pass class.

Protected Attributes

::mlir::Pass::Option< std::string > fieldName {*this, "field", ::llvm::cl::desc("The field to use for interval analysis. If supplied, this always overrides the module's detected field. If omitted, the pass first tries to detect a single field from the enclosing module's felt usage and otherwise falls back to bn128. Supported fields: bn128/bn254, babybear, goldilocks, koalabear, mersenne31"), ::llvm::cl::init("")}
::mlir::Pass::Option< bool > propagateInputConstraints {*this, "propagate-input-constraints", ::llvm::cl::desc("Whether to propagate constraints on inputs from @constrain to @compute functions. This allows for tighter intervals to possibly be found for computed values, assuming that the witness generator would include constraints as assertions during the computation."), ::llvm::cl::init(false)}
::mlir::Pass::Option< bool > printSolverConstraints {*this, "print-solver-constraints", ::llvm::cl::desc("Whether to output SMT solver constraints along with intervals."), ::llvm::cl::init(false)}
::mlir::Pass::Option< bool > printComputeIntervals {*this, "print-compute-intervals", ::llvm::cl::desc("Whether to print compute function intervals (default only prints constrain function intervals)."), ::llvm::cl::init(false)}

Detailed Description

template<typename DerivedT>
class llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >

Definition at line 261 of file IntervalAnalysisPass.cpp.

Member Typedef Documentation

◆ Base

template<typename DerivedT>
using llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::Base = IntervalAnalysisPrinterPassBase

Definition at line 263 of file IntervalAnalysisPass.cpp.

Constructor & Destructor Documentation

◆ IntervalAnalysisPrinterPassBase() [1/4]

template<typename DerivedT>
llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::IntervalAnalysisPrinterPassBase ( )
inline

Definition at line 265 of file IntervalAnalysisPass.cpp.

◆ IntervalAnalysisPrinterPassBase() [2/4]

template<typename DerivedT>
llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::IntervalAnalysisPrinterPassBase ( const IntervalAnalysisPrinterPassBase< DerivedT > & other)
inline

Definition at line 266 of file IntervalAnalysisPass.cpp.

◆ IntervalAnalysisPrinterPassBase() [3/4]

template<typename DerivedT>
llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::IntervalAnalysisPrinterPassBase ( IntervalAnalysisPrinterPassBase< DerivedT > && )
delete

◆ ~IntervalAnalysisPrinterPassBase()

template<typename DerivedT>
llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::~IntervalAnalysisPrinterPassBase ( )
default

◆ IntervalAnalysisPrinterPassBase() [4/4]

template<typename DerivedT>
llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::IntervalAnalysisPrinterPassBase ( IntervalAnalysisPrinterPassOptions options)
inline

Explicitly declare the TypeID for this class.

We declare an explicit private instantiation because Pass classes should only be visible by the current library.

Definition at line 318 of file IntervalAnalysisPass.cpp.

Member Function Documentation

◆ classof()

template<typename DerivedT>
bool llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::classof ( const ::mlir::Pass * pass)
inlinestatic

Support isa/dyn_cast functionality for the derived pass class.

Definition at line 287 of file IntervalAnalysisPass.cpp.

◆ clonePass()

template<typename DerivedT>
std::unique_ptr<::mlir::Pass > llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::clonePass ( ) const
inlineoverride

A clone method to create a copy of this pass.

Definition at line 292 of file IntervalAnalysisPass.cpp.

◆ getArgument()

template<typename DerivedT>
::llvm::StringRef llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::getArgument ( ) const
inlineoverride

Definition at line 276 of file IntervalAnalysisPass.cpp.

◆ getArgumentName()

template<typename DerivedT>
constexpr ::llvm::StringLiteral llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::getArgumentName ( )
inlinestatic

Returns the command-line argument attached to this pass.

Definition at line 273 of file IntervalAnalysisPass.cpp.

◆ getDependentDialects()

template<typename DerivedT>
void llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::getDependentDialects ( ::mlir::DialectRegistry & registry) const
inlineoverride

Return the dialect that must be loaded in the context before this pass.

Definition at line 297 of file IntervalAnalysisPass.cpp.

◆ getDescription()

template<typename DerivedT>
::llvm::StringRef llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::getDescription ( ) const
inlineoverride

Definition at line 278 of file IntervalAnalysisPass.cpp.

◆ getName()

template<typename DerivedT>
::llvm::StringRef llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::getName ( ) const
inlineoverride

Definition at line 284 of file IntervalAnalysisPass.cpp.

◆ getPassName()

template<typename DerivedT>
constexpr ::llvm::StringLiteral llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::getPassName ( )
inlinestatic

Returns the derived pass name.

Definition at line 281 of file IntervalAnalysisPass.cpp.

◆ operator=() [1/2]

template<typename DerivedT>
IntervalAnalysisPrinterPassBase & llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::operator= ( const IntervalAnalysisPrinterPassBase< DerivedT > & )
delete

◆ operator=() [2/2]

template<typename DerivedT>
IntervalAnalysisPrinterPassBase & llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::operator= ( IntervalAnalysisPrinterPassBase< DerivedT > && )
delete

Member Data Documentation

◆ fieldName

template<typename DerivedT>
::mlir::Pass::Option<std::string> llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::fieldName {*this, "field", ::llvm::cl::desc("The field to use for interval analysis. If supplied, this always overrides the module's detected field. If omitted, the pass first tries to detect a single field from the enclosing module's felt usage and otherwise falls back to bn128. Supported fields: bn128/bn254, babybear, goldilocks, koalabear, mersenne31"), ::llvm::cl::init("")}
protected

Definition at line 325 of file IntervalAnalysisPass.cpp.

◆ printComputeIntervals

template<typename DerivedT>
::mlir::Pass::Option<bool> llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::printComputeIntervals {*this, "print-compute-intervals", ::llvm::cl::desc("Whether to print compute function intervals (default only prints constrain function intervals)."), ::llvm::cl::init(false)}
protected

Definition at line 328 of file IntervalAnalysisPass.cpp.

◆ printSolverConstraints

template<typename DerivedT>
::mlir::Pass::Option<bool> llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::printSolverConstraints {*this, "print-solver-constraints", ::llvm::cl::desc("Whether to output SMT solver constraints along with intervals."), ::llvm::cl::init(false)}
protected

Definition at line 327 of file IntervalAnalysisPass.cpp.

◆ propagateInputConstraints

template<typename DerivedT>
::mlir::Pass::Option<bool> llzk::impl::IntervalAnalysisPrinterPassBase< DerivedT >::propagateInputConstraints {*this, "propagate-input-constraints", ::llvm::cl::desc("Whether to propagate constraints on inputs from @constrain to @compute functions. This allows for tighter intervals to possibly be found for computed values, assuming that the witness generator would include constraints as assertions during the computation."), ::llvm::cl::init(false)}
protected

Definition at line 326 of file IntervalAnalysisPass.cpp.

The documentation for this class was generated from the following file: