oxidd 0.11.0

A safe, concurrent, modular, and performant decision diagram framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Default instantiation of `oxidd-rules-*` using `oxidd-manager-index/pointer`
//! and an apply cache implementation from `oxidd-cache`
//!
//! ## Feature flags
#![doc = document_features::document_features!()]
#![deny(unsafe_op_in_unsafe_fn)]
#![allow(clippy::upper_case_acronyms)]
#![warn(missing_docs)]

#[cfg(not(any(feature = "manager-index", feature = "manager-pointer")))]
std::compile_error!(
    "Either feature `manager-index` or `manager-pointer` must be enabled for this crate"
);

pub use oxidd_core::error;
pub use oxidd_core::function::{
    BooleanFunction, BooleanFunctionQuant, BooleanOperator, BooleanVecSet, Function, FunctionSubst,
    NumberBase, PseudoBooleanFunction, TVLFunction,
};
pub use oxidd_core::util::{Subst, Substitution};
pub use oxidd_core::{
    Edge, HasLevel, HasWorkers, InnerNode, LevelNo, Manager, ManagerRef, Node, NodeID, VarNo,
    WorkerPool,
};

pub mod util;

#[cfg(feature = "bcdd")]
pub mod bcdd;
#[cfg(feature = "bdd")]
pub mod bdd;
#[cfg(feature = "mtbdd")]
pub mod mtbdd;
#[cfg(feature = "tdd")]
pub mod tdd;
#[cfg(feature = "zbdd")]
pub mod zbdd;

/// [`Function`] that can be converted into raw values. For use via the FFI
/// only.
#[doc(hidden)]
pub trait RawFunction {
    /// Convert `self` into a raw pointer and index, e.g. for usage in a
    /// foreign function interface.
    ///
    /// This method does not change any reference counters. To avoid a
    /// memory leak, use [`Self::from_raw()`] to convert pointer and index
    /// back into a `Self`.
    fn into_raw(self) -> (*const std::ffi::c_void, usize);

    /// Convert `raw` into `Self`
    ///
    /// # Safety
    ///
    /// `raw` and `index` must have been obtained via [`Self::into_raw()`]. This
    /// function does not change any reference counters, so calling this
    /// function multiple times for the same pointer may lead to use after free
    /// bugs depending on the usage of the returned `Self`.
    unsafe fn from_raw(ptr: *const std::ffi::c_void, index: usize) -> Self;
}

/// [`ManagerRef`] that can be converted into a raw value. For use via the FFI
/// only.
#[doc(hidden)]
pub trait RawManagerRef {
    /// Convert `self` into a raw pointer, e.g. for usage in a foreign
    /// function interface.
    ///
    /// This method does not change any reference counters. To avoid a
    /// memory leak, use [`Self::from_raw()`] to convert the pointer back
    /// into manager reference.
    fn into_raw(self) -> *const std::ffi::c_void;

    /// Convert `raw` into a `Self`
    ///
    /// # Safety
    ///
    /// `raw` must have been obtained via [`Self::into_raw()`]. This function
    /// does not change any reference counters, so calling this function
    /// multiple times for the same pointer may lead to use after free bugs
    /// depending on the usage of the returned manager reference.
    unsafe fn from_raw(raw: *const std::ffi::c_void) -> Self;
}

#[cfg(all(feature = "manager-pointer", not(miri)))]
const PAGE_SIZE: usize = 2 * 1024 * 1024;
#[cfg(all(feature = "manager-pointer", miri))]
const PAGE_SIZE: usize = 4 * 1024;