Blyx

UnderWater

Library · 0.1.0

Measure how long an equity series stayed below its running peak.

Framework using this library

Install with Conda

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

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

You can also download UnderWater as a ZIP. Extract its contents into vendor/underwater.

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

use vendor::underwater::underwater;

fn main() {
    let equity = [100, 90, 85, 100, 99];
    let result = underwater_duration(equity);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

2
1
3

API and input requirements

Returns [longest consecutive underwater observations, current run, last recovered index]. A return exactly to the prior peak ends a run. Invalid arguments and nonfinite results return an empty vector.

APIUse
underwater_duration(equity)Returns [longest consecutive underwater observations, current run, last recovered index]. A return exactly to the prior peak ends a run.

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.