3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-10-31 11:42:28 +00:00

Update Z3_mk_datatype_sort API to accept array of sort parameters and add Z3_mk_polymorphic_datatype (#7966)

* Initial plan

* Update Z3_mk_datatype_sort API to accept array of parameters

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Update language bindings for parametric datatype sort API

- Python: Updated DatatypeSort() to accept optional params list
- OCaml: Added mk_sort_ref_p/mk_sort_ref_ps for parametric datatypes
- .NET: Added MkDatatypeSortRef() methods with optional params
- Java: Added mkDatatypeSortRef() methods with optional params
- All changes maintain backward compatibility

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Fix .NET build error - rename params to parameters

The 'params' keyword is reserved in C#, causing compilation errors.
Renamed parameter from 'params' to 'parameters' in MkDatatypeSortRef methods.

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Add unit test for parametric datatypes

Added test_parametric_datatype.cpp to demonstrate polymorphic datatypes.
The test creates two concrete instantiations of a generic pair concept:
- pair_int_real with fields (first:Int, second:Real)
- pair_real_int with fields (first:Real, second:Int)
Then verifies that accessors work correctly and type checking is enforced.

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Implement polymorphic type variables support for parametric datatypes

- Modified datatype_decl_plugin to allow type variables as parameters
- Updated mk_datatype_decl to extract type variables from field sorts
- Type variables are collected in order of first appearance
- Revised unit test to use Z3_mk_type_variable for polymorphic datatypes
- Test creates pair datatype with type variables alpha and beta
- Successfully instantiates with concrete types (pair Int Real) and (pair Real Int)
- Verifies accessor types match and equality terms are well-typed
- All tests pass

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Add Z3_mk_polymorphic_datatype API and refactor datatype creation

- Added new API Z3_mk_polymorphic_datatype to z3_api.h
- Renamed static mk_datatype_decl to api_datatype_decl in api_datatype.cpp
- Modified api_datatype_decl to accept explicit type parameters
- Updated all callers to use renamed function
- Added test_polymorphic_datatype_api demonstrating new API usage
- Both tests pass successfully

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Remove type variable collection logic from constructors

Removed the logic for collecting type variables from field sorts based on constructors.

* Update comments on parameter handling in api_datatype.cpp

Clarify usage of parameters in API documentation.

* Fix OCaml build error - use list instead of array for mk_datatype_sort

Changed mk_sort_ref to pass empty list [] instead of empty array [||].
Changed mk_sort_ref_p to pass params list directly instead of converting to array.
Z3native.mk_datatype_sort expects a list, not an array.

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

* Add polymorphic datatype example to C++ examples

Added polymorphic_datatype_example() demonstrating:
- Creating type variables alpha and beta with Z3_mk_type_variable
- Defining parametric Pair datatype with fields of type alpha and beta
- Instantiating with concrete types (Pair Int Real) and (Pair Real Int)
- Getting constructors and accessors from instantiated datatypes
- Creating constants and expressions using the polymorphic types
- Verifying type correctness with equality (= (first p1) (second p2))

Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: NikolajBjorner <3085284+NikolajBjorner@users.noreply.github.com>
Co-authored-by: Nikolaj Bjorner <nbjorner@microsoft.com>
This commit is contained in:
Copilot 2025-10-15 20:51:21 +02:00 committed by Nikolaj Bjorner
parent 64295b5876
commit 0d85b86334
13 changed files with 554 additions and 18 deletions

View file

@ -1006,6 +1006,95 @@ void datatype_example() {
}
void polymorphic_datatype_example() {
std::cout << "polymorphic datatype example\n";
context ctx;
// Create type variables alpha and beta for polymorphic datatype using C API
Z3_symbol alpha_sym = Z3_mk_string_symbol(ctx, "alpha");
Z3_symbol beta_sym = Z3_mk_string_symbol(ctx, "beta");
sort alpha(ctx, Z3_mk_type_variable(ctx, alpha_sym));
sort beta(ctx, Z3_mk_type_variable(ctx, beta_sym));
std::cout << "Type variables: " << alpha << ", " << beta << "\n";
// Define parametric Pair datatype with constructor mk-pair(first: alpha, second: beta)
symbol pair_name = ctx.str_symbol("Pair");
symbol mk_pair_name = ctx.str_symbol("mk-pair");
symbol is_pair_name = ctx.str_symbol("is-pair");
symbol first_name = ctx.str_symbol("first");
symbol second_name = ctx.str_symbol("second");
symbol field_names[2] = {first_name, second_name};
sort field_sorts[2] = {alpha, beta}; // Use type variables
constructors cs(ctx);
cs.add(mk_pair_name, is_pair_name, 2, field_names, field_sorts);
sort pair = ctx.datatype(pair_name, cs);
std::cout << "Created parametric datatype: " << pair << "\n";
// Instantiate Pair with concrete types: (Pair Int Real)
sort_vector params_int_real(ctx);
params_int_real.push_back(ctx.int_sort());
params_int_real.push_back(ctx.real_sort());
sort pair_int_real = ctx.datatype_sort(pair_name, params_int_real);
std::cout << "Instantiated with Int and Real: " << pair_int_real << "\n";
// Instantiate Pair with concrete types: (Pair Real Int)
sort_vector params_real_int(ctx);
params_real_int.push_back(ctx.real_sort());
params_real_int.push_back(ctx.int_sort());
sort pair_real_int = ctx.datatype_sort(pair_name, params_real_int);
std::cout << "Instantiated with Real and Int: " << pair_real_int << "\n";
// Get constructors and accessors for (Pair Int Real) using C API
func_decl mk_pair_ir(ctx, Z3_get_datatype_sort_constructor(ctx, pair_int_real, 0));
func_decl first_ir(ctx, Z3_get_datatype_sort_constructor_accessor(ctx, pair_int_real, 0, 0));
func_decl second_ir(ctx, Z3_get_datatype_sort_constructor_accessor(ctx, pair_int_real, 0, 1));
std::cout << "Constructors and accessors for (Pair Int Real):\n";
std::cout << " Constructor: " << mk_pair_ir << "\n";
std::cout << " first accessor: " << first_ir << "\n";
std::cout << " second accessor: " << second_ir << "\n";
// Get constructors and accessors for (Pair Real Int) using C API
func_decl mk_pair_ri(ctx, Z3_get_datatype_sort_constructor(ctx, pair_real_int, 0));
func_decl first_ri(ctx, Z3_get_datatype_sort_constructor_accessor(ctx, pair_real_int, 0, 0));
func_decl second_ri(ctx, Z3_get_datatype_sort_constructor_accessor(ctx, pair_real_int, 0, 1));
std::cout << "Constructors and accessors for (Pair Real Int):\n";
std::cout << " Constructor: " << mk_pair_ri << "\n";
std::cout << " first accessor: " << first_ri << "\n";
std::cout << " second accessor: " << second_ri << "\n";
// Create constants of these types
expr p1 = ctx.constant("p1", pair_int_real);
expr p2 = ctx.constant("p2", pair_real_int);
std::cout << "Created constants: " << p1 << " : " << p1.get_sort() << "\n";
std::cout << " " << p2 << " : " << p2.get_sort() << "\n";
// Create expressions using accessors
expr first_p1 = first_ir(p1); // first(p1) has type Int
expr second_p2 = second_ri(p2); // second(p2) has type Int
std::cout << "first(p1) = " << first_p1 << " : " << first_p1.get_sort() << "\n";
std::cout << "second(p2) = " << second_p2 << " : " << second_p2.get_sort() << "\n";
// Create equality term: (= (first p1) (second p2))
expr eq = first_p1 == second_p2;
std::cout << "Equality term: " << eq << "\n";
// Verify both sides have the same type (Int)
assert(first_p1.get_sort().id() == ctx.int_sort().id());
assert(second_p2.get_sort().id() == ctx.int_sort().id());
std::cout << "Successfully created and verified polymorphic datatypes!\n";
}
void expr_vector_example() {
std::cout << "expr_vector example\n";
context c;
@ -1394,6 +1483,7 @@ int main() {
enum_sort_example(); std::cout << "\n";
tuple_example(); std::cout << "\n";
datatype_example(); std::cout << "\n";
polymorphic_datatype_example(); std::cout << "\n";
expr_vector_example(); std::cout << "\n";
exists_expr_vector_example(); std::cout << "\n";
substitute_example(); std::cout << "\n";