214 lines
7.9 KiB
Markdown
214 lines
7.9 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# ndarray
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
|
||
|
|
|
||
|
|
> Multidimensional arrays.
|
||
|
|
|
||
|
|
<section class="installation">
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install @stdlib/ndarray
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var ns = require( '@stdlib/ndarray' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### ns
|
||
|
|
|
||
|
|
ndarray namespace.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var o = ns;
|
||
|
|
// returns {...}
|
||
|
|
```
|
||
|
|
|
||
|
|
The namespace exports the following functions to create multidimensional arrays:
|
||
|
|
|
||
|
|
<!-- <toc pattern="+(array|ctor)"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`array( [buffer,] [options] )`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">create a multidimensional array.</span>
|
||
|
|
- <span class="signature">[`ndarray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
The namespace contains the following sub-namespaces:
|
||
|
|
|
||
|
|
<!-- <toc pattern="base"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`base`][@stdlib/ndarray/base]</span><span class="delimiter">: </span><span class="description">base ndarray.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
In addition, the namespace contaians the following multidimensional array utility functions:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*" > -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
|
||
|
|
- <span class="signature">[`ndarrayDataTypes()`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
|
||
|
|
- <span class="signature">[`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]</span><span class="delimiter">: </span><span class="description">convert a linear index to an array of subscripts.</span>
|
||
|
|
- <span class="signature">[`ndarrayIndexModes()`][@stdlib/ndarray/index-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray index modes.</span>
|
||
|
|
- <span class="signature">[`ndarrayMinDataType( value )`][@stdlib/ndarray/min-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value.</span>
|
||
|
|
- <span class="signature">[`ndarrayNextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]</span><span class="delimiter">: </span><span class="description">return the next larger ndarray data type of the same kind.</span>
|
||
|
|
- <span class="signature">[`ndarrayOrders()`][@stdlib/ndarray/orders]</span><span class="delimiter">: </span><span class="description">list of ndarray orders.</span>
|
||
|
|
- <span class="signature">[`ndarrayPromotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast.</span>
|
||
|
|
- <span class="signature">[`ndarraySafeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast.</span>
|
||
|
|
- <span class="signature">[`ndarraySameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".</span>
|
||
|
|
- <span class="signature">[`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]</span><span class="delimiter">: </span><span class="description">convert subscripts to a linear index.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: better examples -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var objectKeys = require( '@stdlib/utils/keys' );
|
||
|
|
var ns = require( '@stdlib/ndarray' );
|
||
|
|
|
||
|
|
console.log( objectKeys( ns ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
|
||
|
|
<section class="main-repo" >
|
||
|
|
|
||
|
|
* * *
|
||
|
|
|
||
|
|
## Notice
|
||
|
|
|
||
|
|
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
|
||
|
|
|
||
|
|
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
|
||
|
|
|
||
|
|
#### Community
|
||
|
|
|
||
|
|
[![Chat][chat-image]][chat-url]
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
See [LICENSE][stdlib-license].
|
||
|
|
|
||
|
|
|
||
|
|
## Copyright
|
||
|
|
|
||
|
|
Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.stdlib -->
|
||
|
|
|
||
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray.svg
|
||
|
|
[npm-url]: https://npmjs.org/package/@stdlib/ndarray
|
||
|
|
|
||
|
|
[test-image]: https://github.com/stdlib-js/ndarray/actions/workflows/test.yml/badge.svg
|
||
|
|
[test-url]: https://github.com/stdlib-js/ndarray/actions/workflows/test.yml
|
||
|
|
|
||
|
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray/main.svg
|
||
|
|
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray?branch=main
|
||
|
|
|
||
|
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray.svg
|
||
|
|
[dependencies-url]: https://david-dm.org/stdlib-js/ndarray/main
|
||
|
|
|
||
|
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
||
|
|
[chat-url]: https://gitter.im/stdlib-js/stdlib/
|
||
|
|
|
||
|
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
||
|
|
|
||
|
|
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
||
|
|
|
||
|
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray/main/LICENSE
|
||
|
|
|
||
|
|
<!-- <toc-links> -->
|
||
|
|
|
||
|
|
[@stdlib/ndarray/casting-modes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/casting-modes
|
||
|
|
|
||
|
|
[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/dtypes
|
||
|
|
|
||
|
|
[@stdlib/ndarray/ind2sub]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/ind2sub
|
||
|
|
|
||
|
|
[@stdlib/ndarray/index-modes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/index-modes
|
||
|
|
|
||
|
|
[@stdlib/ndarray/min-dtype]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/min-dtype
|
||
|
|
|
||
|
|
[@stdlib/ndarray/next-dtype]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/next-dtype
|
||
|
|
|
||
|
|
[@stdlib/ndarray/orders]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/orders
|
||
|
|
|
||
|
|
[@stdlib/ndarray/promotion-rules]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/promotion-rules
|
||
|
|
|
||
|
|
[@stdlib/ndarray/safe-casts]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/safe-casts
|
||
|
|
|
||
|
|
[@stdlib/ndarray/same-kind-casts]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/same-kind-casts
|
||
|
|
|
||
|
|
[@stdlib/ndarray/sub2ind]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/sub2ind
|
||
|
|
|
||
|
|
[@stdlib/ndarray/base]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/base
|
||
|
|
|
||
|
|
[@stdlib/ndarray/array]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/array
|
||
|
|
|
||
|
|
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/ctor
|
||
|
|
|
||
|
|
<!-- </toc-links> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|