Blyx

FloorBreach

Library · 0.1.0

Locate the first reserve breach and count all deficient period ends.

Framework using this library

Install with Conda

Create an environment containing FloorBreach 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-floorbreach=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/floorbreach/main.blyx

To use this package in your application, copy share/blyx/floorbreach/vendor/floorbreach 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-floorbreach.git vendor/floorbreach

You can also download FloorBreach as a ZIP. Extract its contents into vendor/floorbreach.

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

use vendor::floorbreach::floorbreach;

fn main() {
    let opening = 20.0;
    let flows = [-15, -10, 30];
    let reserve = 10.0;
    let result = floorbreach_trace(opening, flows, reserve);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

0
2
15

API and input requirements

Returns [first deficient period, deficient periods, largest shortfall]. The opening balance initializes the trace; only period ends are counted. Invalid arguments and nonfinite results return an empty vector.

APIUse
floorbreach_trace(opening, flows, reserve)Returns [first deficient period, deficient periods, largest shortfall]. The opening balance initializes the trace; only period ends are counted.

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.