Blyx

Dominance

Library · 0.1.0

Compute Simpson dominance and its complement from abundance counts.

Framework using this library

Install with Conda

Create an environment containing Dominance 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-dominance=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/dominance/main.blyx

To use this package in your application, copy share/blyx/dominance/vendor/dominance from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-dominance.git vendor/dominance

You can also download Dominance as a ZIP. Extract its contents into vendor/dominance.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::dominance::dominance;

fn main() {
    let counts = [2, 2, 0];
    let result = dominance_simpson(counts);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

0.5
0.5

API and input requirements

Returns [sum of squared relative abundances, Gini–Simpson diversity]. Uses sampling with replacement. Empty surveys have no proportions. Invalid arguments and nonfinite results return an empty vector.

APIUse
dominance_simpson(counts)Returns [sum of squared relative abundances, Gini–Simpson diversity]. Uses sampling with replacement. Empty surveys have no proportions.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.