/** * @module ndarray-js * @description * * # Welcome to the documentation of `ndarray-js` * ndarray-js is a reimplementation of numpy for javascript that aims to make the coding experience as similar to numpy as possible. * ## Interactive demo: * [[include: docs-index.md]] * * ## API Index * - Global namespace: {@link np} * - NDArray class: np.{@link NDArray}. * * ## Browser usage * In html: * ```html * * * ``` * Or press F12 and play with the browser console directly. * * ## Node usage * Installation: * ```bash * npm install ndarray-js * ``` * Use in nodejs with require: * ```javascript * const { np } = require('ndarray-js'); * a = np.arange(18).reshape(3, 2, 3); * console.log(a.tolist()); * ``` * * Use in nodejs with typescript (run with ts-node or compile with tsc): * ```typescript * import { np } from 'ndarray-js'; * const a = np.arange(18).reshape(3, 2, 3); * console.log(a.tolist()); * ``` * * ## Use in Jupyter notebooks: * You need to install the ipykernel (the setup is a bit more complex). * * Example notebook: https://github.com/caph1993/numpy-js/blob/main/notebooks/normal-scatter.ipynb * * [[include: clean-index.md]] */ import { np } from './index'; import NDArray from './NDArray'; export { np, NDArray }; /** @namespace */ export declare const modules: { constructors: typeof import("./modules/constructors"); grammar: typeof import("./modules/grammar"); random: typeof import("./modules/random"); indexing: typeof import("./modules/indexing"); statistics: typeof import("./modules/statistics"); }; //# sourceMappingURL=docs-index.d.ts.map