#include "llzk-c/Support.h"
#include <mlir-c/AffineMap.h>
#include <mlir-c/IR.h>
#include <mlir-c/Support.h>
#include <stdint.h>

Include dependency graph for Struct.h:

This graph shows which files directly or indirectly include this file:

Functions
	MLIR_DECLARE_CAPI_DIALECT_REGISTRATION (Struct, llzk__component)

MLIR_CAPI_EXPORTED MlirType	llzkStructTypeGet (MlirAttribute name)
	Creates a llzk::component::StructType.

MLIR_CAPI_EXPORTED MlirType	llzkStructTypeGetWithArrayAttr (MlirAttribute name, MlirAttribute params)
	Creates a llzk::component::StructType with an ArrayAttr as parameters.

MLIR_CAPI_EXPORTED MlirType	llzkStructTypeGetWithAttrs (MlirAttribute name, intptr_t numParams, MlirAttribute const *params)
	Creates a llzk::component::StructType with an array of parameters.

	LLZK_DECLARE_TYPE_ISA (StructType)
	Returns true if the type is a StructType.

MLIR_CAPI_EXPORTED MlirAttribute	llzkStructTypeGetName (MlirType type)
	Returns the fully qualified name of a llzk::component::StructType.

MLIR_CAPI_EXPORTED MlirAttribute	llzkStructTypeGetParams (MlirType type)
	Returns the parameter of a llzk::component::StructType as an ArrayAttr.

	LLZK_DECLARE_OP_ISA (StructDefOp)
	Returns true if the op is a StructDefOp.

MLIR_CAPI_EXPORTED MlirType	llzkStructDefOpGetType (MlirOperation op)
	Returns the associated StructType to this op using the const params defined by the op.

MLIR_CAPI_EXPORTED MlirType	llzkStructDefOpGetTypeWithParams (MlirOperation op, MlirAttribute params)
	Returns the associated StructType to this op using the given const params instead of the parameters defined by the op.

MLIR_CAPI_EXPORTED MlirOperation	llzkStructDefOpGetFieldDef (MlirOperation op, MlirStringRef name)
	Returns the operation that defines the field with the given name, if present.

MLIR_CAPI_EXPORTED void	llzkStructDefOpGetFieldDefs (MlirOperation op, MlirOperation *dst)
	Fills the given array with the FieldDefOp operations inside this struct.

MLIR_CAPI_EXPORTED intptr_t	llzkStructDefOpGetNumFieldDefs (MlirOperation op)
	Returns the number of FieldDefOp operations defined in this struct.

MlirLogicalResult	llzkStructDefOpGetHasColumns (MlirOperation op)
	Returns true if the struct has fields marked as columns.

MLIR_CAPI_EXPORTED MlirOperation	llzkStructDefOpGetComputeFuncOp (MlirOperation op)
	Returns the FuncDefOp operation that defines the witness computation of the struct.

MLIR_CAPI_EXPORTED MlirOperation	llzkStructDefOpGetConstrainFuncOp (MlirOperation op)
	Returns the FuncDefOp operation that defines the constraints of the struct.

MLIR_CAPI_EXPORTED const char *	llzkStructDefOpGetHeaderString (MlirOperation op, intptr_t dstSize, char (*alloc_string)(size_t))
	Returns the header string of the struct.

	LLZK_DECLARE_NARY_OP_PREDICATE (StructDefOp, HasParamName, MlirStringRef name)
	Returns true if the struct has a parameter that with the given name.

MLIR_CAPI_EXPORTED MlirAttribute	llzkStructDefOpGetFullyQualifiedName (MlirOperation op)
	Returns a StringAttr with the fully qualified name of the struct.

	LLZK_DECLARE_OP_PREDICATE (StructDefOp, IsMainComponent)
	Returns true if the struct is the main entry point of the circuit.

	LLZK_DECLARE_OP_ISA (FieldDefOp)
	Returns true if the op is a FieldDefOp.

	LLZK_DECLARE_OP_PREDICATE (FieldDefOp, HasPublicAttr)
	Returns true if the field has been marked public with a PublicAttr.

MLIR_CAPI_EXPORTED void	llzkFieldDefOpSetPublicAttr (MlirOperation op, bool value)
	Sets the public attribute in the given field.

	LLZK_DECLARE_OP_BUILD_METHOD (FieldReadOp, MlirType type, MlirValue component, MlirStringRef fieldName)
	Creates a FieldReadOp.

	LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD (FieldReadOp, WithAffineMapDistance, MlirType type, MlirValue component, MlirStringRef fieldName, MlirAffineMap affineMap, MlirValueRange mapOperands, int32_t nDimensions)
	Creates a FieldReadOp to a column offset by the given distance affine map.

	LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD (FieldReadOp, WithConstParamDistance, MlirType type, MlirValue component, MlirStringRef fieldName, MlirStringRef paramName)
	Creates a FieldReadOp to a column offset by the given distance defined by a name to a constant parameter in the struct.

	LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD (FieldReadOp, WithLiteralDistance, MlirType type, MlirValue component, MlirStringRef fieldName, int64_t distance)
	Creates a FieldReadOp to a column offset by the given distance defined by an integer value.

Function Documentation

◆ LLZK_DECLARE_NARY_OP_PREDICATE()

LLZK_DECLARE_NARY_OP_PREDICATE	(	StructDefOp	,
		HasParamName	,
		MlirStringRef	name )

Returns true if the struct has a parameter that with the given name.

◆ LLZK_DECLARE_OP_BUILD_METHOD()

LLZK_DECLARE_OP_BUILD_METHOD	(	FieldReadOp	,
		MlirType	type,
		MlirValue	component,
		MlirStringRef	fieldName )

Creates a FieldReadOp.

◆ LLZK_DECLARE_OP_ISA() [1/2]

LLZK_DECLARE_OP_ISA ( FieldDefOp )

Returns true if the op is a FieldDefOp.

◆ LLZK_DECLARE_OP_ISA() [2/2]

LLZK_DECLARE_OP_ISA ( StructDefOp )

Returns true if the op is a StructDefOp.

◆ LLZK_DECLARE_OP_PREDICATE() [1/2]

LLZK_DECLARE_OP_PREDICATE	(	FieldDefOp	,
		HasPublicAttr	)

Returns true if the field has been marked public with a PublicAttr.

◆ LLZK_DECLARE_OP_PREDICATE() [2/2]

LLZK_DECLARE_OP_PREDICATE	(	StructDefOp	,
		IsMainComponent	)

Returns true if the struct is the main entry point of the circuit.

◆ LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD() [1/3]

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD	(	FieldReadOp	,
		WithAffineMapDistance	,
		MlirType	type,
		MlirValue	component,
		MlirStringRef	fieldName,
		MlirAffineMap	affineMap,
		MlirValueRange	mapOperands,
		int32_t	nDimensions )

Creates a FieldReadOp to a column offset by the given distance affine map.

The values in the ValueRange are operands representing the arguments to the affine map. The integer value is the number of arguments in the map that are dimensions.

◆ LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD() [2/3]

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD	(	FieldReadOp	,
		WithConstParamDistance	,
		MlirType	type,
		MlirValue	component,
		MlirStringRef	fieldName,
		MlirStringRef	paramName )

Creates a FieldReadOp to a column offset by the given distance defined by a name to a constant parameter in the struct.

◆ LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD() [3/3]

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD	(	FieldReadOp	,
		WithLiteralDistance	,
		MlirType	type,
		MlirValue	component,
		MlirStringRef	fieldName,
		int64_t	distance )

Creates a FieldReadOp to a column offset by the given distance defined by an integer value.

◆ LLZK_DECLARE_TYPE_ISA()

LLZK_DECLARE_TYPE_ISA ( StructType )

Returns true if the type is a StructType.

◆ llzkFieldDefOpSetPublicAttr()

MLIR_CAPI_EXPORTED void llzkFieldDefOpSetPublicAttr	(	MlirOperation	op,
		bool	value )

Sets the public attribute in the given field.

Definition at line 143 of file Struct.cpp.

◆ llzkStructDefOpGetComputeFuncOp()

MLIR_CAPI_EXPORTED MlirOperation llzkStructDefOpGetComputeFuncOp ( MlirOperation op )

Returns the FuncDefOp operation that defines the witness computation of the struct.

Definition at line 102 of file Struct.cpp.

◆ llzkStructDefOpGetConstrainFuncOp()

MLIR_CAPI_EXPORTED MlirOperation llzkStructDefOpGetConstrainFuncOp ( MlirOperation op )

Returns the FuncDefOp operation that defines the constraints of the struct.

Definition at line 106 of file Struct.cpp.

◆ llzkStructDefOpGetFieldDef()

MLIR_CAPI_EXPORTED MlirOperation llzkStructDefOpGetFieldDef	(	MlirOperation	op,
		MlirStringRef	name )

Returns the operation that defines the field with the given name, if present.

Definition at line 83 of file Struct.cpp.

◆ llzkStructDefOpGetFieldDefs()

MLIR_CAPI_EXPORTED void llzkStructDefOpGetFieldDefs	(	MlirOperation	op,
		MlirOperation *	dst )

Fills the given array with the FieldDefOp operations inside this struct.

The pointer to the operations must have been preallocated. See llzkStructDefOpGetNumFieldDefs for obtaining the required size of the array.

Definition at line 88 of file Struct.cpp.

◆ llzkStructDefOpGetFullyQualifiedName()

MLIR_CAPI_EXPORTED MlirAttribute llzkStructDefOpGetFullyQualifiedName ( MlirOperation op )

Returns a StringAttr with the fully qualified name of the struct.

Definition at line 125 of file Struct.cpp.

◆ llzkStructDefOpGetHasColumns()

MlirLogicalResult llzkStructDefOpGetHasColumns ( MlirOperation op )

Returns true if the struct has fields marked as columns.

Definition at line 98 of file Struct.cpp.

◆ llzkStructDefOpGetHeaderString()

MLIR_CAPI_EXPORTED const char * llzkStructDefOpGetHeaderString	(	MlirOperation	op,
		intptr_t *	dstSize,
		char (	alloc_string )(size_t) )

Returns the header string of the struct.

The size of the string is written into the given size pointer. The caller is responsible of freeing the string and of providing an allocator.

Definition at line 111 of file Struct.cpp.

◆ llzkStructDefOpGetNumFieldDefs()

MLIR_CAPI_EXPORTED intptr_t llzkStructDefOpGetNumFieldDefs ( MlirOperation op )

Returns the number of FieldDefOp operations defined in this struct.

Definition at line 94 of file Struct.cpp.

◆ llzkStructDefOpGetType()

MLIR_CAPI_EXPORTED MlirType llzkStructDefOpGetType ( MlirOperation op )

Returns the associated StructType to this op using the const params defined by the op.

Definition at line 74 of file Struct.cpp.

◆ llzkStructDefOpGetTypeWithParams()

MLIR_CAPI_EXPORTED MlirType llzkStructDefOpGetTypeWithParams	(	MlirOperation	op,
		MlirAttribute	params )

Returns the associated StructType to this op using the given const params instead of the parameters defined by the op.

The const params are defined in the given attribute which has to be of type ArrayAttr.

Definition at line 78 of file Struct.cpp.

◆ llzkStructTypeGet()

MLIR_CAPI_EXPORTED MlirType llzkStructTypeGet ( MlirAttribute name )

Creates a llzk::component::StructType.

The name attribute must be a SymbolRefAttr.

Definition at line 40 of file Struct.cpp.

◆ llzkStructTypeGetName()

MLIR_CAPI_EXPORTED MlirAttribute llzkStructTypeGetName ( MlirType type )

Returns the fully qualified name of a llzk::component::StructType.

Definition at line 60 of file Struct.cpp.

◆ llzkStructTypeGetParams()

MLIR_CAPI_EXPORTED MlirAttribute llzkStructTypeGetParams ( MlirType type )

Returns the parameter of a llzk::component::StructType as an ArrayAttr.

Definition at line 64 of file Struct.cpp.

◆ llzkStructTypeGetWithArrayAttr()

MLIR_CAPI_EXPORTED MlirType llzkStructTypeGetWithArrayAttr	(	MlirAttribute	name,
		MlirAttribute	params )

Creates a llzk::component::StructType with an ArrayAttr as parameters.

The name attribute must be a SymbolRefAttr.

Definition at line 44 of file Struct.cpp.

◆ llzkStructTypeGetWithAttrs()

MLIR_CAPI_EXPORTED MlirType llzkStructTypeGetWithAttrs	(	MlirAttribute	name,
		intptr_t	numParams,
		MlirAttribute const *	params )

Creates a llzk::component::StructType with an array of parameters.

The name attribute must be a SymbolRefAttr.

Definition at line 51 of file Struct.cpp.

◆ MLIR_DECLARE_CAPI_DIALECT_REGISTRATION()

MLIR_DECLARE_CAPI_DIALECT_REGISTRATION	(	Struct	,
		llzk__component	)

Functions

Function Documentation

◆ LLZK_DECLARE_NARY_OP_PREDICATE()

◆ LLZK_DECLARE_OP_BUILD_METHOD()

◆ LLZK_DECLARE_OP_ISA() [1/2]

◆ LLZK_DECLARE_OP_ISA() [2/2]

◆ LLZK_DECLARE_OP_PREDICATE() [1/2]

◆ LLZK_DECLARE_OP_PREDICATE() [2/2]

◆ LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD() [1/3]

◆ LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD() [2/3]

◆ LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD() [3/3]

◆ LLZK_DECLARE_TYPE_ISA()

◆ llzkFieldDefOpSetPublicAttr()

◆ llzkStructDefOpGetComputeFuncOp()

◆ llzkStructDefOpGetConstrainFuncOp()

◆ llzkStructDefOpGetFieldDef()

◆ llzkStructDefOpGetFieldDefs()

◆ llzkStructDefOpGetFullyQualifiedName()

◆ llzkStructDefOpGetHasColumns()

◆ llzkStructDefOpGetHeaderString()

◆ llzkStructDefOpGetNumFieldDefs()

◆ llzkStructDefOpGetType()

◆ llzkStructDefOpGetTypeWithParams()

◆ llzkStructTypeGet()

◆ llzkStructTypeGetName()

◆ llzkStructTypeGetParams()

◆ llzkStructTypeGetWithArrayAttr()

◆ llzkStructTypeGetWithAttrs()

◆ MLIR_DECLARE_CAPI_DIALECT_REGISTRATION()