icentral-mucid

icentral-mucid is a Rust crate designed for managing identifiers associated with minimum union cycles within graph nodes, offering a straightforward API to access and manipulate these identifiers effectively.

Features

• MucIdForNode Trait: Provides an interface to retrieve MinimumUnionCycleId for a given node using mucid_for_node.
• SetMucIdForNode Trait: Enables setting a MinimumUnionCycleId for a node via set_mucid_for_node.
• Macro Expansion: Utilize the mucid! macro for simplifying repetitive code tasks, enhancing expressiveness and maintaining robustness in your codebase.
• MinimumUnionCycleId Struct: Efficient representation of a union cycle identifier, with utilities to manipulate and interact with node identifiers, including implementations for Display, and deriving traits such as Clone, Copy, PartialEq, and more.

Mathematical Foundation

This crate leverages fundamental concepts from discrete mathematics and graph theory, concentrating on minimal cycles, which are pivotal in algorithms that analyze or manipulate graph structures by aiming at optimal intersection points or paths.

Usage

To utilize the functionalities provided by icentral-mucid, import the relevant traits and structures into your Rust project's scope.

use icentral_mucid::{MucIdForNode, SetMucIdForNode, MinimumUnionCycleId, mucid};

// Example implementation
struct NodeIdExample;
impl MucIdForNode for NodeIdExample {
    fn mucid_for_node(&self, node: NodeId) -> MinimumUnionCycleId {
        // Implementation details here
    }
}

Installation

Add icentral-mucid to your Cargo.toml dependencies:

[dependencies]
icentral-mucid = "0.1.0"

Contribution

We welcome contributions and improvements. Fork the repository, make your changes, and submit a pull request. Please ensure your contributions are well-documented and tested.

This README.md file was generated by an AI model and may not be 100% accurate however it should be pretty good.

This crate is in the process of being translated from c++ to rust. Currently, it still needs exhaustive testing. It is likely there currently exist many glitches which need to be fixed before proper usage. This crate is based on the original icentral program developed by Fuad Jamor. Please see the following repository for details: https://github.com/fjamour/icentral.

For progress updates, see the workspacer rust project.