icentral-sigmas 0.1.0

A Rust library providing efficient management of sigma values for nodes in graph-based data structures. Includes traits for accessing and modifying sigma values, with a focus on performance and precision.
Documentation
  • Coverage
  • 0%
    0 out of 9 items documented0 out of 2 items with examples
  • Size
  • Source code size: 56.28 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 682.58 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 1m 28s Average build duration of successful builds.
  • all releases: 1m 28s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • klebs6

iCentral Sigmas

icentral-sigmas is a Rust library designed to efficiently manage and manipulate sigma values associated with graph nodes. It provides a robust infrastructure for setting, getting, updating, and computing ratios of sigma values, with a focus on performance and precision.

This crate is particularly useful in scenarios involving graph-based data structures where sigma calculations are necessary - such as simulations, optimizations, scientific computations, and other applications requiring node-centric analyses.

Features

  • Trait-based Interfaces: Define standardized functionality for setting and getting sigma values.

    pub trait GetSigmaValueForNode {
    fn sigma_value_for_node(&self, node: NodeId) -> f64;
}

pub trait SetSigmaValueForNode {
    fn set_sigma_value_for_node(&mut self, node: NodeId, val: f64);
}

  • SigmaMap Structure: A comprehensive structure that implements these traits and provides a plethora of methods to manipulate sigma values.

  • Macro Support: Use the delegate_to_sigmas! macro for delegating functionalities to sigma value operations conveniently.

Usage

To include icentral-sigmas in your project, add it to your Cargo.toml dependencies section:

[dependencies]
icentral-sigmas = "0.1.0"

Examples

Create a new SigmaMap and manipulate sigma values:

let mut sigma_map = SigmaMap::new(10, "ExampleMap");
sigma_map.set_sigma_value_for_node(1, 2.5);
println!("Sigma value for node 1: {}", sigma_map.sigma_value_for_node(1));

Updating Sigma Values

Use the update method for complex updates based on the sigma values of two nodes and a multiplier:

sigma_map.update(2, 3, 1.2);

Ratio Calculations

Compute the ratio of sigma values between two nodes:

let ratio = sigma_map.ratio(4, 5);
println!("Sigma ratio: {}", ratio);

License

This project is licensed under the terms of the MIT license.

Disclaimer: This README file was generated by an AI model and may not be 100% accurate. However, it should provide a good overview of the crate functionalities.

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.