numbl 0.1.1 → 0.1.2

package/dist-lib/graphics/types.d.ts

@@ -0,0 +1,262 @@
+/**
+ * Shared graphics types used by both numbl-core and the rendering layer.
+ *
+ * This file is the single source of truth for plot trace interfaces and
+ * PlotInstruction.  numbl-core re-exports these types so that internal
+ * runtime code can import them without reaching into src/graphics/.
+ *
+ * The numbl-vscode extension syncs this file (and the rest of src/graphics/)
+ * via devel/sync-graphics.sh.
+ */
+export interface PlotTrace {
+    x: number[];
+    y: number[];
+    lineStyle?: string;
+    marker?: string;
+    color?: [number, number, number];
+    lineWidth?: number;
+    markerSize?: number;
+    markerEdgeColor?: [number, number, number];
+    markerFaceColor?: [number, number, number];
+    markerIndices?: number[];
+}
+export interface Plot3Trace {
+    x: number[];
+    y: number[];
+    z: number[];
+    lineStyle?: string;
+    marker?: string;
+    color?: [number, number, number];
+    lineWidth?: number;
+    markerSize?: number;
+    markerEdgeColor?: [number, number, number];
+    markerFaceColor?: [number, number, number];
+    markerIndices?: number[];
+}
+export interface SurfTrace {
+    /** X coordinates: flat array of length rows*cols (column-major) */
+    x: number[];
+    /** Y coordinates: flat array of length rows*cols (column-major) */
+    y: number[];
+    /** Z values: flat array of length rows*cols (column-major) */
+    z: number[];
+    /** Number of rows in the grid */
+    rows: number;
+    /** Number of columns in the grid */
+    cols: number;
+    /** Optional color data (same shape as Z) */
+    c?: number[];
+    edgeColor?: [number, number, number] | "none" | "flat" | "interp";
+    faceColor?: [number, number, number] | "flat" | "interp" | "none" | "texturemap";
+    faceAlpha?: number;
+}
+export interface ImagescTrace {
+    /** X limits [xmin, xmax] */
+    x: [number, number];
+    /** Y limits [ymin, ymax] */
+    y: [number, number];
+    /** Z data: flat array (column-major), rows × cols */
+    z: number[];
+    rows: number;
+    cols: number;
+}
+export interface ContourTrace {
+    /** X coordinates: flat array (column-major) */
+    x: number[];
+    /** Y coordinates: flat array (column-major) */
+    y: number[];
+    /** Z values: flat array (column-major) */
+    z: number[];
+    rows: number;
+    cols: number;
+    /** Number of contour levels */
+    nLevels: number;
+    /** Whether this is a filled contour (contourf) */
+    filled: boolean;
+}
+export interface BarTrace {
+    /** X positions for each bar */
+    x: number[];
+    /** Y values (bar heights) for each bar */
+    y: number[];
+    /** Relative bar width (0–1, default 0.8) */
+    width: number;
+    /** Bar color as RGB triple [0–1] */
+    color?: [number, number, number];
+}
+export interface Bar3Trace {
+    /** X positions for each bar (column index) */
+    x: number[];
+    /** Y positions for each bar (row index) */
+    y: number[];
+    /** Z values (bar heights) for each bar */
+    z: number[];
+    /** Number of rows in the grid */
+    rows: number;
+    /** Number of columns in the grid */
+    cols: number;
+    /** Relative bar width (0–1, default 0.8) */
+    width: number;
+    /** Bar color as RGB triple [0–1] */
+    color?: [number, number, number];
+}
+export interface ErrorBarTrace {
+    x: number[];
+    y: number[];
+    /** Error below each data point */
+    yNeg: number[];
+    /** Error above each data point */
+    yPos: number[];
+    /** Error left of each data point (horizontal error bars) */
+    xNeg?: number[];
+    /** Error right of each data point (horizontal error bars) */
+    xPos?: number[];
+    color?: [number, number, number];
+    lineStyle?: string;
+    marker?: string;
+    lineWidth?: number;
+}
+export interface BoxTrace {
+    /** X position for this box */
+    x: number;
+    /** Median value */
+    median: number;
+    /** Lower quartile (Q1, 25th percentile) */
+    q1: number;
+    /** Upper quartile (Q3, 75th percentile) */
+    q3: number;
+    /** Lower whisker end (min non-outlier) */
+    whiskerLow: number;
+    /** Upper whisker end (max non-outlier) */
+    whiskerHigh: number;
+    /** Outlier values */
+    outliers: number[];
+    /** Relative box width */
+    width: number;
+    /** Box color as RGB triple [0–1] */
+    color?: [number, number, number];
+}
+export interface PieTrace {
+    /** Slice values (absolute, not percentages) */
+    values: number[];
+    /** Optional slice names */
+    names?: string[];
+    /** Inner radius as fraction of outer radius (0 = pie, >0 = donut) */
+    innerRadius: number;
+    /** Per-slice colors as RGB triples [0–1] */
+    colors?: [number, number, number][];
+}
+export interface HeatmapTrace {
+    /** Cell values: flat array (column-major), rows × cols */
+    data: number[];
+    rows: number;
+    cols: number;
+    /** X-axis labels (one per column) */
+    xLabels?: string[];
+    /** Y-axis labels (one per row) */
+    yLabels?: string[];
+}
+export type PlotInstruction = {
+    type: "set_figure_handle";
+    handle: number;
+} | {
+    type: "plot";
+    traces: PlotTrace[];
+} | {
+    type: "plot3";
+    traces: Plot3Trace[];
+} | {
+    type: "surf";
+    trace: SurfTrace;
+} | {
+    type: "imagesc";
+    trace: ImagescTrace;
+} | {
+    type: "contour";
+    trace: ContourTrace;
+} | {
+    type: "mesh";
+    trace: SurfTrace;
+} | {
+    type: "bar";
+    traces: BarTrace[];
+} | {
+    type: "barh";
+    traces: BarTrace[];
+} | {
+    type: "bar3";
+    trace: Bar3Trace;
+} | {
+    type: "bar3h";
+    trace: Bar3Trace;
+} | {
+    type: "errorbar";
+    traces: ErrorBarTrace[];
+} | {
+    type: "area";
+    traces: PlotTrace[];
+    baseValue: number;
+} | {
+    type: "boxchart";
+    traces: BoxTrace[];
+} | {
+    type: "piechart";
+    trace: PieTrace;
+} | {
+    type: "heatmap";
+    trace: HeatmapTrace;
+} | {
+    type: "set_hold";
+    value: boolean;
+} | {
+    type: "set_title";
+    text: string;
+} | {
+    type: "set_xlabel";
+    text: string;
+} | {
+    type: "set_ylabel";
+    text: string;
+} | {
+    type: "set_zlabel";
+    text: string;
+} | {
+    type: "set_shading";
+    shading: "faceted" | "flat" | "interp";
+} | {
+    type: "close";
+} | {
+    type: "close_all";
+} | {
+    type: "clf";
+} | {
+    type: "set_subplot";
+    rows: number;
+    cols: number;
+    index: number;
+} | {
+    type: "set_legend";
+    labels: string[];
+} | {
+    type: "set_sgtitle";
+    text: string;
+} | {
+    type: "set_grid";
+    value: boolean;
+} | {
+    type: "set_colorbar";
+    value: string;
+} | {
+    type: "set_colormap";
+    name: string;
+} | {
+    type: "set_axis";
+    value: string;
+} | {
+    type: "set_axis_scale";
+    value: "linear" | "semilogx" | "semilogy" | "loglog";
+} | {
+    type: "set_view";
+    az: number;
+    el: number;
+};

package/dist-lib/lib.d.ts

@@ -0,0 +1,19 @@
+/**
+ * numbl library entry point.
+ *
+ * Usage:
+ *   import { executeCode } from "numbl";
+ *   const result = executeCode('disp("hello")');
+ *   console.log(result.output); // ["hello"]
+ */
+export { executeCode } from "./numbl-core/executeCode.js";
+export type { ExecOptions, ExecResult, ProfileData, BuiltinProfileEntry, BuiltinProfileBreakdown, } from "./numbl-core/executeCode.js";
+export type { FileIOAdapter } from "./numbl-core/fileIOAdapter.js";
+export type { SystemAdapter } from "./numbl-core/systemAdapter.js";
+export type { WorkspaceFile, NativeBridge, } from "./numbl-core/workspace/index.js";
+export type { PlotInstruction } from "./graphics/types.js";
+export type { RuntimeValue, RuntimeTensor, RuntimeString, RuntimeLogical, RuntimeCell, RuntimeStruct, RuntimeFunction, RuntimeDictionary, } from "./numbl-core/runtime/index.js";
+export { RuntimeError } from "./numbl-core/runtime/index.js";
+export { RTV } from "./numbl-core/runtime/constructors.js";
+export { displayValue } from "./numbl-core/runtime/display.js";
+export { toNumber, toBool, toString } from "./numbl-core/runtime/convert.js";