Find a funding gap inside an otherwise positive cash schedule
The closing balance is 25, but two period ends fall below the reserve and the worst gap is 15.
Run the native CLI
Extract the workflow collection for your platform. Run .\bin\siskin.exe --help in PowerShell or ./bin/siskin --help on Linux and macOS. Running the command with no arguments prints the worked example.
Build from source
With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.
git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-siskin.git cd blyx-siskin blyxc native-run project.blyx -- 20 "-15,-10,30" 10
Why this framework exists
A positive closing balance can conceal a mid-period reserve breach. Replay the signed flows in order. GnuCash, cash flow reporting
Install Siskin in your editor
Extension RahulChaube.blyx-siskin · 0.1.0
The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.
Create an empty .blyx file, type blyx-siskin-demo and accept the completion. Choose Blyx: Run File to run the example.
For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Siskin.
Download the companion Blyx Language VSIXLibraries in this framework
Install with Conda
Create an environment containing Siskin 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-siskin=0.1.0=0 blyxc native-run ./blyx-env/share/blyx/siskin/main.blyx
To use this package in your application, copy share/blyx/siskin/vendor/siskin from the environment into your project's vendor directory.
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-siskin.git vendor/siskin
You can also download Siskin as a ZIP. Extract its contents into vendor/siskin.
Save this as main.blyx beside vendor and run blyxc native-run main.blyx.
use vendor::siskin::siskin;
fn main() {
let opening = 20.0;
let flows = [-15, -10, 30];
let reserve = 10.0;
let result = siskin_project(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
25 -5 0 2 15
API and input requirements
Returns [closing balance, low-water balance, first deficient period, deficient periods, period-end funding gap]. Flows must be in date order. Invalid arguments and nonfinite results return an empty vector.
| API | Use |
|---|---|
siskin_project(opening, flows, reserve) | Returns [closing balance, low-water balance, first deficient period, deficient periods, period-end funding gap]. Flows must be in date order. |
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.
