oxidd-manager-pointer 0.6.0

Pointer-based manager implementation for OxiDD
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

use std::sync::atomic;

pub mod fixed_arity;

/// Base traits to be satisfied by inner nodes for oxidd-manager. This does not
/// include the [`InnerNode`][oxidd_core::InnerNode] trait.
///
/// # Safety
///
/// - The reference counter must be initialized to 2.
/// - [`Self::load_rc()`] loads the reference count with the specified load
///   order.
pub unsafe trait NodeBase: arcslab::AtomicRefCounted + Eq + std::hash::Hash {
    /// Whether this node type contains additional data that needs to be dropped
    /// to avoid memory leaks.
    ///
    /// If the node only consists of [`Edge`][crate::manager::Edge]s and types
    /// that implement [`Copy`], an implementation may return `false`. This may
    /// speed up dropping a diagram a lot.
    #[inline(always)]
    fn needs_drop() -> bool {
        true
    }

    /// Atomically load the current reference count with the given `order`
    fn load_rc(&self, order: atomic::Ordering) -> usize;
}