UNumflow 0.8.1

UNumflow

.NET bindings for the u-numflow numerical library.

Features

• Distributions: Uniform, Triangular, PERT, Normal, LogNormal, Weibull, Exponential, Gamma, Beta and χ² — Cdf, Quantile, Mean, Variance, and Sample(n, seed): the same seed always gives the same values, and the uniforms behind them come from the open interval (0, 1), so no variate is infinite
• Sample statistics: Stats.Median, Stats.Quantile and Stats.Quantiles (several at once, one sort) — R-7 linear interpolation, the default of R, NumPy and Excel
• Interval sets: unions of half-open intervals [start, end) with Union, Intersection, Difference, Clip, Contains and a Measure that counts every point once, however much the input overlapped
• Units of measure: conversion between units of the same dimension — UCUM expressions (kW.h, m/s2, Gcal_IT) over the SI and the units you define (UnitDefinition), readings (Convert — 20 °C is 293.15 K) and differences (ConvertDifference — a rise of 20 °C is 20 K), and Info for a unit's dimension
• Parameters are checked when you create a distribution — a Distribution that exists is a valid one

Installation

dotnet add package UNumflow

Usage

using UNumflow;

// Critical values and probabilities
var chi = Distribution.ChiSquared(4);
double critical = chi.Quantile(0.95);       // 9.4877…
double p = chi.Cdf(critical);               // 0.95

// Reproducible samples
double[] lives = Distribution.Weibull(shape: 2, scale: 100).Sample(1000, seed: 42);

// Sample statistics: a time distribution's median is not pulled by one long case
double[] minutes = [12, 7, 95, 9, 14, 11];
double median = Stats.Median(minutes);                         // 11.5
double[] q = Stats.Quantiles(minutes, [0.25, 0.5, 0.9]);       // [9.5, 11.5, 54.5]

// Coverage arithmetic: overlapping stops are down-time once
var planned = IntervalSet.From([(0, 24)]);
var unplanned = IntervalSet.From([(10, 30)]);
var week = IntervalSet.From([(0, 168)]);
double upHours = week.Difference(planned.Union(unplanned)).Measure; // 138

// Units: the SI is built in; a unit whose size varies by convention is yours to define
var units = new Units([
    new UnitDefinition("cal_IT", "J", 4.1868),
    new UnitDefinition("toe", "kcal_IT", 1e7),
]);
double gj = units.Convert(1, "Gcal_IT", "GJ");            // 4.1868
double kelvin = Units.Si.Convert(20, "Cel", "K");          // 293.15 — a reading
double rise = Units.Si.ConvertDifference(20, "Cel", "K");  // 20 — a change
string dimension = units.Info("toe").Dimension;            // "kg.m2.s-2"

Errors

A refused request raises NumflowException. Message is readable text; ErrorCode is a stable code to branch on (the error body's code), Parameter and Index say which value it is about, Details is the error body with the values behind it, and Status is the native status:

try
{
    Distribution.Normal(0, sigma: -1);
}
catch (NumflowException e)
{
    // e.ErrorCode == "parameter_out_of_range"
    // e.Details: { "parameter": "distribution.sigma", "min": null, "exclusive_min": 0, "max": null, "got": -1, ... }
}

Numflow.Codes returns the engine's codes as data — Codes(Refusals, Violations), each refusal with the fields beside it — from the table the engine refuses from (it is the engine's whole list, so it also names reasons only the WebAssembly package's functions raise).

In parameter_out_of_range, min and max are inclusive bounds and are always present — null when that end is unbounded or open. An open (exclusive) end is exclusive_min / exclusive_max, present only when the bound is open.

Platforms

The package carries the native library for win-x64, linux-x64 and linux-arm64 (glibc 2.39 or later), osx-x64 and osx-arm64; no separate install is needed.

License

MIT