numpy-ts 1.0.0 → 1.2.0

package/dist/types/io/file-ops.d.ts

@@ -0,0 +1,269 @@
+/**
+ * File IO operations for numpy-ts.
+ *
+ * These functions read/write files using the runtime fs abstraction from filesystem.ts.
+ * They work in Node.js, Bun, and Deno, and throw clear errors in the browser.
+ */
+import { NDArray } from '../full/ndarray';
+import type { NpzParseOptions } from './npz/parser';
+import { type NpzSerializeOptions, type NpzArraysInput } from './npz/serializer';
+import { type ParseTxtOptions, type SerializeTxtOptions } from './txt';
+import type { DType } from '../common/dtype';
+interface NpzParseResultNDArray {
+    arrays: Map<string, NDArray>;
+    skipped: string[];
+    errors: Map<string, string>;
+}
+/**
+ * Options for loading NPY/NPZ files
+ */
+export interface LoadOptions extends NpzParseOptions {
+    /**
+     * If true, allow loading .npy files.
+     * Default: true
+     */
+    allowNpy?: boolean;
+}
+/**
+ * Options for saving NPZ files
+ */
+export type SaveNpzOptions = NpzSerializeOptions;
+/**
+ * Options for loadtxt
+ */
+export type LoadTxtOptions = ParseTxtOptions;
+/**
+ * Options for savetxt
+ */
+export type SaveTxtOptions = SerializeTxtOptions;
+/**
+ * Load an NDArray from a .npy file
+ *
+ * @param path - Path to the .npy file
+ * @returns The loaded NDArray
+ */
+export declare function loadNpy(path: string): Promise<NDArray>;
+/**
+ * Synchronously load an NDArray from a .npy file
+ *
+ * @param path - Path to the .npy file
+ * @returns The loaded NDArray
+ */
+export declare function loadNpySync(path: string): NDArray;
+/**
+ * Save an NDArray to a .npy file
+ *
+ * @param path - Path to save the .npy file
+ * @param arr - The NDArray to save
+ */
+export declare function saveNpy(path: string, arr: NDArray): Promise<void>;
+/**
+ * Synchronously save an NDArray to a .npy file
+ *
+ * @param path - Path to save the .npy file
+ * @param arr - The NDArray to save
+ */
+export declare function saveNpySync(path: string, arr: NDArray): void;
+/**
+ * Load arrays from a .npz file
+ *
+ * @param path - Path to the .npz file
+ * @param options - Load options
+ * @returns Object with array names as keys
+ */
+export declare function loadNpzFile(path: string, options?: NpzParseOptions): Promise<NpzParseResultNDArray>;
+/**
+ * Synchronously load arrays from a .npz file
+ *
+ * Note: Only works if the NPZ file is not DEFLATE compressed.
+ *
+ * @param path - Path to the .npz file
+ * @param options - Load options
+ * @returns Object with array names as keys
+ */
+export declare function loadNpzFileSync(path: string, options?: NpzParseOptions): NpzParseResultNDArray;
+/**
+ * Save arrays to a .npz file
+ *
+ * @param path - Path to save the .npz file
+ * @param arrays - Arrays to save:
+ *   - Array of NDArrays (positional, named arr_0, arr_1, etc.)
+ *   - Map of names to NDArrays
+ *   - Object with names as keys
+ * @param options - Save options
+ */
+export declare function saveNpz(path: string, arrays: NpzArraysInput, options?: SaveNpzOptions): Promise<void>;
+/**
+ * Synchronously save arrays to a .npz file (no compression)
+ *
+ * @param path - Path to save the .npz file
+ * @param arrays - Arrays to save (same types as saveNpz)
+ */
+export declare function saveNpzSync(path: string, arrays: NpzArraysInput): void;
+/**
+ * Load an array or arrays from a .npy or .npz file
+ *
+ * This is a convenience function that auto-detects the file format based on extension.
+ *
+ * @param path - Path to the file
+ * @param options - Load options
+ * @returns NDArray for .npy files, or NpzParseResult for .npz files
+ */
+export declare function load(path: string, options?: LoadOptions): Promise<NDArray | NpzParseResultNDArray>;
+/**
+ * Synchronously load an array or arrays from a .npy or .npz file
+ *
+ * @param path - Path to the file
+ * @param options - Load options
+ * @returns NDArray for .npy files, or NpzParseResult for .npz files
+ */
+export declare function loadSync(path: string, options?: LoadOptions): NDArray | NpzParseResultNDArray;
+/**
+ * Save an array to a .npy file
+ *
+ * @param path - Path to save the file (should end with .npy)
+ * @param arr - The NDArray to save
+ */
+export declare function save(path: string, arr: NDArray): Promise<void>;
+/**
+ * Synchronously save an array to a .npy file
+ *
+ * @param path - Path to save the file (should end with .npy)
+ * @param arr - The NDArray to save
+ */
+export declare function saveSync(path: string, arr: NDArray): void;
+/**
+ * Save multiple arrays to a .npz file (like np.savez)
+ *
+ * @param path - Path to save the .npz file
+ * @param arrays - Arrays to save:
+ *   - Array of NDArrays: named arr_0, arr_1, etc. (like np.savez positional args)
+ *   - Object/Map with names as keys (like np.savez keyword args)
+ *
+ * @example
+ * // Positional arrays
+ * await savez('data.npz', [arr1, arr2])  // saved as arr_0, arr_1
+ *
+ * // Named arrays
+ * await savez('data.npz', { x: arr1, y: arr2 })
+ */
+export declare function savez(path: string, arrays: NpzArraysInput): Promise<void>;
+/**
+ * Save multiple arrays to a compressed .npz file (like np.savez_compressed)
+ *
+ * @param path - Path to save the .npz file
+ * @param arrays - Arrays to save (same input types as savez)
+ */
+export declare function savez_compressed(path: string, arrays: NpzArraysInput): Promise<void>;
+/**
+ * Load data from a text file.
+ *
+ * Each row in the text file must have the same number of values.
+ *
+ * @param path - Path to the text file
+ * @param options - Load options
+ * @returns NDArray with the loaded data
+ *
+ * @example
+ * ```typescript
+ * // Load a CSV file
+ * const arr = await loadtxt('data.csv', { delimiter: ',' });
+ *
+ * // Load with specific columns
+ * const arr = await loadtxt('data.txt', { usecols: [0, 2] });
+ *
+ * // Skip header rows
+ * const arr = await loadtxt('data.txt', { skiprows: 1 });
+ * ```
+ */
+export declare function loadtxt(path: string, options?: LoadTxtOptions): Promise<NDArray>;
+/**
+ * Synchronously load data from a text file.
+ *
+ * @param path - Path to the text file
+ * @param options - Load options
+ * @returns NDArray with the loaded data
+ */
+export declare function loadtxtSync(path: string, options?: LoadTxtOptions): NDArray;
+/**
+ * Save an array to a text file.
+ *
+ * @param path - Path to save the text file
+ * @param arr - The array to save (must be 1D or 2D)
+ * @param options - Save options
+ *
+ * @example
+ * ```typescript
+ * // Save as CSV
+ * await savetxt('data.csv', arr, { delimiter: ',' });
+ *
+ * // Save with custom format
+ * await savetxt('data.txt', arr, { fmt: '%.2f', delimiter: '\t' });
+ *
+ * // Save with header
+ * await savetxt('data.txt', arr, { header: 'x y z' });
+ * ```
+ */
+export declare function savetxt(path: string, arr: NDArray, options?: SaveTxtOptions): Promise<void>;
+/**
+ * Synchronously save an array to a text file.
+ *
+ * @param path - Path to save the text file
+ * @param arr - The array to save (must be 1D or 2D)
+ * @param options - Save options
+ */
+export declare function savetxtSync(path: string, arr: NDArray, options?: SaveTxtOptions): void;
+/**
+ * Load data from a text file with more flexible handling.
+ *
+ * Similar to loadtxt but handles missing values more gracefully.
+ *
+ * @param path - Path to the text file
+ * @param options - Load options
+ * @returns NDArray with the loaded data
+ *
+ * @example
+ * ```typescript
+ * // Load file with missing values
+ * const arr = await genfromtxt('data.csv', {
+ *   delimiter: ',',
+ *   missing_values: ['NA', ''],
+ *   filling_values: 0
+ * });
+ * ```
+ */
+export declare function genfromtxt(path: string, options?: LoadTxtOptions): Promise<NDArray>;
+/**
+ * Synchronously load data from a text file with more flexible handling.
+ *
+ * @param path - Path to the text file
+ * @param options - Load options
+ * @returns NDArray with the loaded data
+ */
+export declare function genfromtxtSync(path: string, options?: LoadTxtOptions): NDArray;
+/**
+ * Load data from a text file using regular expressions.
+ *
+ * @param path - Path to the text file
+ * @param regexp - Regular expression with capture groups for extracting values
+ * @param dtype - Data type of the resulting array (default: 'float64')
+ * @returns NDArray with the extracted data
+ *
+ * @example
+ * ```typescript
+ * // Extract x,y pairs from "Point: x=1.0, y=2.0" format
+ * const arr = await fromregex('points.txt', /x=([\d.]+), y=([\d.]+)/);
+ * ```
+ */
+export declare function fromregex(path: string, regexp: RegExp | string, dtype?: DType): Promise<NDArray>;
+/**
+ * Synchronously load data from a text file using regular expressions.
+ *
+ * @param path - Path to the text file
+ * @param regexp - Regular expression with capture groups for extracting values
+ * @param dtype - Data type of the resulting array (default: 'float64')
+ * @returns NDArray with the extracted data
+ */
+export declare function fromregexSync(path: string, regexp: RegExp | string, dtype?: DType): NDArray;
+export {};
+//# sourceMappingURL=file-ops.d.ts.map

package/dist/types/io/filesystem.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Runtime filesystem abstraction for cross-platform file IO.
+ *
+ * Pre-loads `node:fs` and `node:fs/promises` asynchronously at module load
+ * in Node-like environments. Both getFs() and getFsSync() read from this cache.
+ * In browsers, all IO functions throw a helpful error.
+ */
+type FsPromises = typeof import('node:fs/promises');
+type FsSync = typeof import('node:fs');
+/**
+ * Get the async fs module (`node:fs/promises`).
+ * Caches the result after the first successful resolution.
+ */
+export declare function getFs(): Promise<FsPromises>;
+/**
+ * Get the sync fs module (`node:fs`).
+ * Reads from the cache populated at module load time or by a prior getFs() call.
+ */
+export declare function getFsSync(): FsSync;
+export {};
+//# sourceMappingURL=filesystem.d.ts.map

package/dist/types/io/zip/types.d.ts

@@ -53,7 +53,8 @@ export interface RawZipEntry {
     uncompressedSize: number;
 }
 /**
- * Calculate CRC-32 checksum
+ * Calculate CRC-32 checksum using slice-by-8.
+ * Processes 8 bytes per iteration, then finishes byte-at-a-time.
  */
 export declare function crc32(data: Uint8Array): number;
 //# sourceMappingURL=types.d.ts.map

package/dist/types/node.d.ts

@@ -1,280 +1,8 @@
 /**
- * Node.js-specific entry point for numpy-ts
+ * Deprecated: use `import from 'numpy-ts'` instead.
  *
- * This module provides file system operations for saving and loading NPY/NPZ files,
- * plus all core numpy-ts functionality in a single import.
- *
- * Usage:
- *   import * as np from 'numpy-ts/node';
- *   // Has everything from numpy-ts + file I/O
- *   const arr = await np.loadNpy('data.npy');
- *   await np.saveNpz('output.npz', { x: arr });
- *
- * For browser usage, use the main entry point (no file I/O).
+ * This module re-exports everything from the main entry point.
+ * File IO functions (loadNpy, saveNpy, etc.) are now available directly from 'numpy-ts'.
  */
-import { NDArray } from './full/ndarray';
-import type { NpzParseOptions } from './io/npz/parser';
-import { type NpzSerializeOptions, type NpzArraysInput } from './io/npz/serializer';
-import { type ParseTxtOptions, type SerializeTxtOptions } from './io/txt';
-import type { DType } from './common/dtype';
-interface NpzParseResultNDArray {
-    arrays: Map<string, NDArray>;
-    skipped: string[];
-    errors: Map<string, string>;
-}
 export * from './index';
-/**
- * Options for loading NPY/NPZ files
- */
-export interface LoadOptions extends NpzParseOptions {
-    /**
-     * If true, allow loading .npy files.
-     * Default: true
-     */
-    allowNpy?: boolean;
-}
-/**
- * Options for saving NPZ files
- */
-export interface SaveNpzOptions extends NpzSerializeOptions {
-}
-/**
- * Load an NDArray from a .npy file
- *
- * @param path - Path to the .npy file
- * @returns The loaded NDArray
- */
-export declare function loadNpy(path: string): Promise<NDArray>;
-/**
- * Synchronously load an NDArray from a .npy file
- *
- * @param path - Path to the .npy file
- * @returns The loaded NDArray
- */
-export declare function loadNpySync(path: string): NDArray;
-/**
- * Save an NDArray to a .npy file
- *
- * @param path - Path to save the .npy file
- * @param arr - The NDArray to save
- */
-export declare function saveNpy(path: string, arr: NDArray): Promise<void>;
-/**
- * Synchronously save an NDArray to a .npy file
- *
- * @param path - Path to save the .npy file
- * @param arr - The NDArray to save
- */
-export declare function saveNpySync(path: string, arr: NDArray): void;
-/**
- * Load arrays from a .npz file
- *
- * @param path - Path to the .npz file
- * @param options - Load options
- * @returns Object with array names as keys
- */
-export declare function loadNpzFile(path: string, options?: NpzParseOptions): Promise<NpzParseResultNDArray>;
-/**
- * Synchronously load arrays from a .npz file
- *
- * Note: Only works if the NPZ file is not DEFLATE compressed.
- *
- * @param path - Path to the .npz file
- * @param options - Load options
- * @returns Object with array names as keys
- */
-export declare function loadNpzFileSync(path: string, options?: NpzParseOptions): NpzParseResultNDArray;
-/**
- * Save arrays to a .npz file
- *
- * @param path - Path to save the .npz file
- * @param arrays - Arrays to save:
- *   - Array of NDArrays (positional, named arr_0, arr_1, etc.)
- *   - Map of names to NDArrays
- *   - Object with names as keys
- * @param options - Save options
- */
-export declare function saveNpz(path: string, arrays: NpzArraysInput, options?: SaveNpzOptions): Promise<void>;
-/**
- * Synchronously save arrays to a .npz file (no compression)
- *
- * @param path - Path to save the .npz file
- * @param arrays - Arrays to save (same types as saveNpz)
- */
-export declare function saveNpzSync(path: string, arrays: NpzArraysInput): void;
-/**
- * Load an array or arrays from a .npy or .npz file
- *
- * This is a convenience function that auto-detects the file format based on extension.
- *
- * @param path - Path to the file
- * @param options - Load options
- * @returns NDArray for .npy files, or NpzParseResult for .npz files
- */
-export declare function load(path: string, options?: LoadOptions): Promise<NDArray | NpzParseResultNDArray>;
-/**
- * Synchronously load an array or arrays from a .npy or .npz file
- *
- * @param path - Path to the file
- * @param options - Load options
- * @returns NDArray for .npy files, or NpzParseResult for .npz files
- */
-export declare function loadSync(path: string, options?: LoadOptions): NDArray | NpzParseResultNDArray;
-/**
- * Save an array to a .npy file
- *
- * @param path - Path to save the file (should end with .npy)
- * @param arr - The NDArray to save
- */
-export declare function save(path: string, arr: NDArray): Promise<void>;
-/**
- * Synchronously save an array to a .npy file
- *
- * @param path - Path to save the file (should end with .npy)
- * @param arr - The NDArray to save
- */
-export declare function saveSync(path: string, arr: NDArray): void;
-/**
- * Save multiple arrays to a .npz file (like np.savez)
- *
- * @param path - Path to save the .npz file
- * @param arrays - Arrays to save:
- *   - Array of NDArrays: named arr_0, arr_1, etc. (like np.savez positional args)
- *   - Object/Map with names as keys (like np.savez keyword args)
- *
- * @example
- * // Positional arrays
- * await savez('data.npz', [arr1, arr2])  // saved as arr_0, arr_1
- *
- * // Named arrays
- * await savez('data.npz', { x: arr1, y: arr2 })
- */
-export declare function savez(path: string, arrays: NpzArraysInput): Promise<void>;
-/**
- * Save multiple arrays to a compressed .npz file (like np.savez_compressed)
- *
- * @param path - Path to save the .npz file
- * @param arrays - Arrays to save (same input types as savez)
- */
-export declare function savez_compressed(path: string, arrays: NpzArraysInput): Promise<void>;
-/**
- * Options for loadtxt
- */
-export interface LoadTxtOptions extends ParseTxtOptions {
-}
-/**
- * Options for savetxt
- */
-export interface SaveTxtOptions extends SerializeTxtOptions {
-}
-/**
- * Load data from a text file.
- *
- * Each row in the text file must have the same number of values.
- *
- * @param path - Path to the text file
- * @param options - Load options
- * @returns NDArray with the loaded data
- *
- * @example
- * ```typescript
- * // Load a CSV file
- * const arr = await loadtxt('data.csv', { delimiter: ',' });
- *
- * // Load with specific columns
- * const arr = await loadtxt('data.txt', { usecols: [0, 2] });
- *
- * // Skip header rows
- * const arr = await loadtxt('data.txt', { skiprows: 1 });
- * ```
- */
-export declare function loadtxt(path: string, options?: LoadTxtOptions): Promise<NDArray>;
-/**
- * Synchronously load data from a text file.
- *
- * @param path - Path to the text file
- * @param options - Load options
- * @returns NDArray with the loaded data
- */
-export declare function loadtxtSync(path: string, options?: LoadTxtOptions): NDArray;
-/**
- * Save an array to a text file.
- *
- * @param path - Path to save the text file
- * @param arr - The array to save (must be 1D or 2D)
- * @param options - Save options
- *
- * @example
- * ```typescript
- * // Save as CSV
- * await savetxt('data.csv', arr, { delimiter: ',' });
- *
- * // Save with custom format
- * await savetxt('data.txt', arr, { fmt: '%.2f', delimiter: '\t' });
- *
- * // Save with header
- * await savetxt('data.txt', arr, { header: 'x y z' });
- * ```
- */
-export declare function savetxt(path: string, arr: NDArray, options?: SaveTxtOptions): Promise<void>;
-/**
- * Synchronously save an array to a text file.
- *
- * @param path - Path to save the text file
- * @param arr - The array to save (must be 1D or 2D)
- * @param options - Save options
- */
-export declare function savetxtSync(path: string, arr: NDArray, options?: SaveTxtOptions): void;
-/**
- * Load data from a text file with more flexible handling.
- *
- * Similar to loadtxt but handles missing values more gracefully.
- *
- * @param path - Path to the text file
- * @param options - Load options
- * @returns NDArray with the loaded data
- *
- * @example
- * ```typescript
- * // Load file with missing values
- * const arr = await genfromtxt('data.csv', {
- *   delimiter: ',',
- *   missing_values: ['NA', ''],
- *   filling_values: 0
- * });
- * ```
- */
-export declare function genfromtxt(path: string, options?: LoadTxtOptions): Promise<NDArray>;
-/**
- * Synchronously load data from a text file with more flexible handling.
- *
- * @param path - Path to the text file
- * @param options - Load options
- * @returns NDArray with the loaded data
- */
-export declare function genfromtxtSync(path: string, options?: LoadTxtOptions): NDArray;
-/**
- * Load data from a text file using regular expressions.
- *
- * @param path - Path to the text file
- * @param regexp - Regular expression with capture groups for extracting values
- * @param dtype - Data type of the resulting array (default: 'float64')
- * @returns NDArray with the extracted data
- *
- * @example
- * ```typescript
- * // Extract x,y pairs from "Point: x=1.0, y=2.0" format
- * const arr = await fromregex('points.txt', /x=([\d.]+), y=([\d.]+)/);
- * ```
- */
-export declare function fromregex(path: string, regexp: RegExp | string, dtype?: DType): Promise<NDArray>;
-/**
- * Synchronously load data from a text file using regular expressions.
- *
- * @param path - Path to the text file
- * @param regexp - Regular expression with capture groups for extracting values
- * @param dtype - Data type of the resulting array (default: 'float64')
- * @returns NDArray with the extracted data
- */
-export declare function fromregexSync(path: string, regexp: RegExp | string, dtype?: DType): NDArray;
 //# sourceMappingURL=node.d.ts.map