[API Coherence] Report for March 2, 2026 - Solver/Optimize/BitVector APIs #8832

2026-03-02T23:22:45Z

github-actions[bot]
bot Mar 2, 2026

Summary

This run analyzed Solver APIs, Optimize APIs, and BitVector operations across all 8 language bindings (Java, .NET, C++, Python, TypeScript, OCaml, Go, Rust).

Key Statistics:

APIs Analyzed: Solver APIs (15+ functions), Optimize APIs (10+ functions), BitVector operations (50+ functions)
Languages Covered: 8 (Java, .NET, C++, Python, TypeScript, OCaml, Go, Rust)
Previously Cached Issues Resolved: 11 🎉
Still Open Issues: 3
New Issues Found: 3

🎉 Resolution Updates

The following 11 cached issues have been RESOLVED since the last run (Feb 24):

TypeScript Enhancements

✅ solver_to_dimacs_string - Now implemented as dimacs() method
✅ solver_translate - Now implemented as translate() method
✅ Optimize.getLower()/getUpper() - Both methods now exist in OptimizeImpl
✅ Optimize.fromFile()/unsatCore()/objectives()/reasonUnknown() - All 4 methods now implemented

Java Enhancements

✅ solver_to_dimacs_string - Now implemented as toDimacs() method
✅ solver_add_simplifier - Now implemented as addSimplifier() method

.NET Enhancements

✅ solver_to_dimacs_string - Now bound in Solver.cs

Go Enhancements

✅ solver_get_proof - Now implemented as GetProof() method
✅ solver_register_on_clause - Now implemented via propagator.go

OCaml Enhancements

✅ solver_register_on_clause - Now implemented in z3.mli

Rust Enhancements

✅ Solver.translate() - Now implemented in solver.rs

Excellent progress! The maintainers have been actively improving API coverage.

Progress Tracking

APIs analyzed so far: ~5/20 API families (25%)
This run: Solver APIs, Optimize APIs, BitVector operations (detailed)
Previous run: Solver APIs, Optimize APIs (initial survey)
Next run: Floating-point APIs, Quantifier APIs, Tactic/Probe APIs

High Priority Issues

1. Go Missing BitVector Reduction Operations

What: BitVector reduction operations Z3_mk_bvredand and Z3_mk_bvredor are not exposed in Go API
Available in: C, C++, Python, Java, .NET, TypeScript, OCaml
Missing in: Go, Rust (high-level)
Use case: Reduce a bitvector to a single bit by AND/OR-ing all bits together
Suggested fix: Add to src/api/go/bitvec.go:

func (c *Context) MkBVRedAnd(t1 *Expr) *Expr {
    return &Expr{c, C.Z3_mk_bvredand(c.ptr, t1.ptr)}
}

func (c *Context) MkBVRedOr(t1 *Expr) *Expr {
    return &Expr{c, C.Z3_mk_bvredor(c.ptr, t1.ptr)}
}

Verified: Checked src/api/go/bitvec.go on 2026-03-02 - still missing

2. Go Missing Specialized Bitwise Operations

What: BitVector bitwise operations Z3_mk_bvnand, Z3_mk_bvnor, Z3_mk_bvxnor are not exposed in Go API
Available in: C, C++, Python, Java, .NET, TypeScript, OCaml
Missing in: Go, Rust (high-level)
Use case: Specialized bitwise operations (NAND, NOR, XNOR gates)
Suggested fix: Add to src/api/go/bitvec.go:

func (c *Context) MkBVNand(t1, t2 *Expr) *Expr {
    return &Expr{c, C.Z3_mk_bvnand(c.ptr, t1.ptr, t2.ptr)}
}

func (c *Context) MkBVNor(t1, t2 *Expr) *Expr {
    return &Expr{c, C.Z3_mk_bvnor(c.ptr, t1.ptr, t2.ptr)}
}

func (c *Context) MkBVXnor(t1, t2 *Expr) *Expr {
    return &Expr{c, C.Z3_mk_bvxnor(c.ptr, t1.ptr, t2.ptr)}
}

Verified: Checked src/api/go/bitvec.go on 2026-03-02 - still missing

Note: Go API has excellent coverage of overflow checking operations (8/8 implemented), but is missing these 5 bitwise operations.

3. Rust High-Level BitVector API Severely Limited

What: Rust z3 crate's BV type has only 15 public methods, while the C API exposes 39+ BitVector operations
Available in C API: All 39 operations (arithmetic, bitwise, shifts, rotates, extensions, comparisons, overflow checking, etc.)
Available in Rust: Only 15 methods: basic construction, extract, sign_ext, zero_ext, from_int, to_int, as_i64, as_u64, get_size
Missing in Rust: 24+ operations including:

Reduction operations (bvredand, bvredor)
Specialized bitwise (bvnand, bvnor, bvxnor)
Overflow/underflow checking (8 functions)
Shifts and rotates (bvshl, bvlshr, bvashr, rotate_left, rotate_right)
Arithmetic (add/sub/mul/div/rem - only available via operator overloading)
Comparisons (ult, ule, ugt, uge, slt, sle, sgt, sge)

Impact: High - Rust users must either use operator overloading (limited to basic arithmetic) or drop to low-level FFI

Suggested fix: Expand /tmp/z3.rs/z3/src/ast/bv.rs with wrapper methods for missing operations. For example:

impl BV {
    pub fn bvredand(&self) -> Bool {
        Bool::wrap(unsafe { 
            Z3_mk_bvredand(self.ctx.z3_ctx, self.z3_ast) 
        })
    }
    
    pub fn bvnand(&self, other: &BV) -> BV {
        BV::wrap(unsafe { 
            Z3_mk_bvnand(self.ctx.z3_ctx, self.z3_ast, other.z3_ast) 
        })
    }
    
    // ... add remaining 22+ operations
}

Note: The Rust z3-sys crate has the FFI bindings for most operations, so this is primarily about adding high-level wrappers.

Verified: Checked /tmp/z3.rs/z3/src/ast/bv.rs on 2026-03-02 - confirmed only 15 methods

Medium Priority Issues

4. Optimize Translate Missing in Multiple Languages

What: Z3_optimize_translate function is not exposed in TypeScript, OCaml, Go, or Rust
Available in: C, C++, Python, Java, .NET
Missing in: TypeScript, OCaml, Go, Rust
Use case: Translate an optimizer from one context to another
Suggested fix:

TypeScript: Add translate(target: Context): Optimize method to OptimizeImpl in src/api/js/src/high-level/high-level.ts
Go: Add func (o *Optimize) Translate(target *Context) *Optimize to src/api/go/optimize.go
OCaml: Add val translate : context -> optimize -> optimize to src/api/ml/z3.mli
Rust: Add FFI binding to z3-sys and high-level wrapper to z3/src/optimize.rs

Verified: Re-checked on 2026-03-02 - still missing in all 4 languages

5. Rust Missing Several Solver APIs (External Repository)

What: Rust z3 crate (external repo at github.com/prove-rs/z3.rs) is missing high-level wrappers for several Solver C API functions
Available in C API but missing Rust wrappers:

Z3_solver_interrupt - Interrupt a solver
Z3_solver_cube - Get cube for satisfiable formulas
Z3_solver_get_trail - Get trail of literals
Z3_solver_congruence_* - Congruence class queries
Z3_solver_solve_for - Solve with specific assumptions
Z3_solver_set_initial_value - Set initial values for variables
Z3_solver_from_file - Load solver from file
Z3_solver_to_dimacs_string - Export to DIMACS format

Impact: Medium - These are specialized features not needed for basic usage
Note: This is an external repository not maintained by the Z3 team

Verified: Checked /tmp/z3.rs/z3/src/solver.rs on 2026-03-02 - confirmed missing

Low Priority Issues

6. Rust z3-sys Missing FFI Bindings for Newer C APIs (External Repository)

What: Rust z3-sys crate is missing FFI bindings for some newer C API functions added to Z3
Missing FFI bindings in z3-sys:

Z3_solver_interrupt
Z3_solver_to_dimacs_string
Z3_solver_add_simplifier
Z3_solver_get_trail
Z3_solver_register_on_clause
Z3_solver_congruence_*
Z3_solver_solve_for
Z3_solver_set_initial_value

Note: The z3-sys crate DOES have Z3_goal_to_dimacs_string but not the solver variant

Impact: Low - These can be added incrementally as users request them
Note: This is an external repository not maintained by the Z3 team

Verified: Checked /tmp/z3.rs/z3-sys/src/lib.rs on 2026-03-02 - confirmed missing

API Coverage by Language (BitVector Operations)

Language	Basic Ops	Arithmetic	Bitwise	Shifts/Rotate	Extension	Overflow Check	Reduction	Coverage
C API	✅	✅	✅	✅	✅	✅	✅	100% (39/39)
C++	✅	✅	✅	✅	✅	✅	✅	~100%
Python	✅	✅	✅	✅	✅	✅	✅	~100%
Java	✅	✅	✅	✅	✅	✅	✅	~100%
.NET	✅	✅	✅	✅	✅	✅	✅	~100%
TypeScript	✅	✅	✅	✅	✅	✅	✅	~100%
OCaml	✅	✅	✅	✅	✅	✅	⚠️	~95%
Go	✅	✅	⚠️ (5 missing)	✅	✅	✅	❌	~87% (34/39)
Rust	✅	⚠️ (operators only)	❌	❌	✅	❌	❌	~38% (15/39)

Legend: ✅ Complete, ⚠️ Partial, ❌ Missing

Methodology Notes

Verification date: March 2, 2026
Code verified: All findings re-checked against current codebase before reporting
Resolved issues: 11 previously cached issues were verified as resolved and removed from open issue list
Tools used: Serena (for Java/Python/TypeScript/.NET), grep/glob (for C++/OCaml/Go), external repo clone (for Rust)
External repos: Rust z3 crate is maintained at github.com/prove-rs/z3.rs (not by Z3 team)

Next Analysis Run

The next run will focus on:

Floating-point APIs (Z3_mk_fpa_*, Z3_fpa_*) - 56 functions
Quantifier APIs (Z3_mk_forall, Z3_mk_exists, Z3_mk_lambda, pattern support)
Tactic and Probe APIs (composable solving strategies)

Expected to uncover: API gaps in newer language bindings (TypeScript, Go) for specialized features like FP rounding modes, quantifier patterns, and tactic combinators.

Recommendations for Maintainers

Prioritize Go BitVector completion - Only 5 operations missing, easy to add
Consider Rust high-level API expansion - Currently very limited (38% coverage), though this is an external repository
Document optimize_translate - If it's rarely used, document why; if useful, add to remaining languages
Continue excellent work - 11 issues resolved since last month shows great progress! 🎉

Generated by: API Coherence Checker
Run ID: 2026-03-02
Cache updated: Yes

AI generated by API Coherence Checker

expires on Mar 9, 2026, 11:22 PM UTC

2026-03-10T00:59:27Z

github-actions[bot]
bot Mar 10, 2026
Author

This discussion was automatically closed because it expired on 2026-03-09T23:22:44.966Z.

Closed by Workflow

0 replies

saratge · 2026-03-10T03:45:38Z

saratge
Mar 10, 2026

[surprised] Varanasi, Sarat Chandra (GE Ae... reacted to your message:

…

________________________________ From: github-actions[bot] ***@***.***> Sent: Tuesday, March 10, 2026 12:59:49 AM To: Z3Prover/z3 ***@***.***> Cc: Subscribed ***@***.***> Subject: Re: [Z3Prover/z3] [API Coherence] Report for March 2, 2026 - Solver/Optimize/BitVector APIs (Discussion #8832) Closed #8832<#8832> as outdated. — Reply to this email directly, view it on GitHub<#8832>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AXTHRELAQJQSKPNGMUBCAO34P5SILAVCNFSM6AAAAACWEZJELGVHI2DSMVQWIX3LMV45UABFIRUXGY3VONZWS33OIV3GK3TUHI5E433UNFTGSY3BORUW63R3GI2DKMBSG4ZQ>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

0 replies

saratge · 2026-03-10T03:45:39Z

saratge
Mar 10, 2026

[0] Varanasi, Sarat Chandra (GE Ae... reacted to your message:

…

________________________________ From: github-actions[bot] ***@***.***> Sent: Tuesday, March 10, 2026 12:59:49 AM To: Z3Prover/z3 ***@***.***> Cc: Subscribed ***@***.***> Subject: Re: [Z3Prover/z3] [API Coherence] Report for March 2, 2026 - Solver/Optimize/BitVector APIs (Discussion #8832) Closed #8832<#8832> as outdated. — Reply to this email directly, view it on GitHub<#8832>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AXTHRELAQJQSKPNGMUBCAO34P5SILAVCNFSM6AAAAACWEZJELGVHI2DSMVQWIX3LMV45UABFIRUXGY3VONZWS33OIV3GK3TUHI5E433UNFTGSY3BORUW63R3GI2DKMBSG4ZQ>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[API Coherence] Report for March 2, 2026 - Solver/Optimize/BitVector APIs #8832

Uh oh!

{{title}}

Uh oh!

Replies: 3 comments

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

[API Coherence] Report for March 2, 2026 - Solver/Optimize/BitVector APIs #8832

Uh oh!

github-actions[bot] bot Mar 2, 2026

Summary

🎉 Resolution Updates

TypeScript Enhancements

Java Enhancements

.NET Enhancements

Go Enhancements

OCaml Enhancements

Rust Enhancements

Progress Tracking

High Priority Issues

1. Go Missing BitVector Reduction Operations

2. Go Missing Specialized Bitwise Operations

3. Rust High-Level BitVector API Severely Limited

Medium Priority Issues

4. Optimize Translate Missing in Multiple Languages

5. Rust Missing Several Solver APIs (External Repository)

Low Priority Issues

6. Rust z3-sys Missing FFI Bindings for Newer C APIs (External Repository)

API Coverage by Language (BitVector Operations)

Methodology Notes

Next Analysis Run

Recommendations for Maintainers

Replies: 3 comments

Uh oh!

github-actions[bot] bot Mar 10, 2026 Author

Uh oh!

saratge Mar 10, 2026

Uh oh!

saratge Mar 10, 2026

github-actions[bot]
bot Mar 2, 2026

github-actions[bot]
bot Mar 10, 2026
Author

saratge
Mar 10, 2026

saratge
Mar 10, 2026