#cnf #logic #sat


Generate DIMACS CNF formula from operations

7 releases

new 0.4.0 Jun 14, 2024
0.3.3 May 4, 2024
0.3.2 Apr 12, 2024
0.3.1 Jan 29, 2024
0.2.1 Oct 15, 2022

#147 in Math

Download history 3/week @ 2024-02-25 12/week @ 2024-03-31 134/week @ 2024-04-07 11/week @ 2024-04-14 127/week @ 2024-04-28 34/week @ 2024-05-05 128/week @ 2024-06-09

128 downloads per month
Used in 2 crates


22K SLoC


The library to generate CNF (Conjunctive Normal Form) formula.

This library provides simple CNF writer, structures to create boolean formula from boolean expressions and integer expressions. The module writer provides basic types, traits to handle clauses and literals, simple the CNF writer to write same CNF formulas. The boolexpr module provides structure to construct boolean expressions. The intexpr and dynintexpr modules provides structure and traits to construct integer expressions.

Same construction of expressions can be done in natural way by using operators or methods. The object called ExprCreator holds all expressions. The main structures that allow construct expressions are expression nodes: BoolExprNode, IntExprNode and DynIntExprNode. BoolExprNode allow to construct boolean expressions. IntExprNode and DynIntExprNode allow to construct integer expressions or multiple bit expressions.

Version 0.4.0 (current) offers new interface to operate on expressions. This interface in boolvar, intvar and dynintvar modules. New interface offers few simplifications that facility writing complex expressions.

Typical usage of this library is: construction boolean expression and write it by using method write from an expression object. The writer module can be used to write 'raw' CNF formulas that can be generated by other software.

Sample usage:

use cnfgen::boolexpr::*;
use cnfgen::intexpr::*;
use cnfgen::writer::{CNFError, CNFWriter};
use std::io;

fn write_diophantine_equation() -> Result<(), CNFError> {
    // define ExprCreator.
    let creator = ExprCreator32::new();
    // define variables - signed 32-bit wide.
    let x = I32ExprNode::variable(creator.clone());
    let y = I32ExprNode::variable(creator.clone());
    let z = I32ExprNode::variable(creator.clone());
    // define equation: x^2 + y^2 - 77*z^2 = 0
    let powx = x.clone().fullmul(x);  // x^2
    let powy = y.clone().fullmul(y);  // y^2
    let powz = z.clone().fullmul(z);  // z^2
    // We use cond_mul to get product and required condition to avoid overflow.
    let (prod, cond0) = powz.cond_mul(77i64);
    // Similary, we use conditional addition and conditional subtraction.
    let (sum1, cond1) = powx.cond_add(powy);
    let (diff2, cond2) = sum1.cond_sub(prod);
    // define final formula with required conditions.
    let formula: BoolExprNode<_> = diff2.equal(0) & cond0 & cond1 & cond2;
    // write CNF to stdout.
    formula.write(&mut CNFWriter::new(io::stdout()))


~24K SLoC