@stdlib/ndarray-zeros-like 0.0.1

package/README.md

@@ -0,0 +1,239 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2022 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.
+
+-->
+
+# zerosLike
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Create a zero-filled [ndarray][@stdlib/ndarray/ctor] having the same shape and [data type][@stdlib/ndarray/dtypes] as a provided ndarray.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/ndarray-zeros-like
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zerosLike = require( '@stdlib/ndarray-zeros-like' );
+```
+
+#### zerosLike( x\[, options] )
+
+Creates a zero-filled [ndarray][@stdlib/ndarray/ctor] having the same shape and [data type][@stdlib/ndarray/dtypes] as a provided ndarray.
+
+```javascript
+var zeros = require( '@stdlib/ndarray-zeros' );
+
+var x = zeros( [ 2, 2 ] );
+// returns <ndarray>
+
+var y = zerosLike( x );
+// returns <ndarray>
+
+var sh = y.shape;
+// returns [ 2, 2 ]
+
+var dt = y.dtype;
+// returns 'float64'
+```
+
+The function supports the following `options`:
+
+-   **dtype**: output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes]. Overrides the input ndarray's inferred [data type][@stdlib/ndarray/dtypes].
+-   **shape**: output [ndarray][@stdlib/ndarray/ctor] shape. Overrides the input ndarray's inferred shape.
+-   **order**: specifies whether the output [ndarray][@stdlib/ndarray/ctor] should be `'row-major'` (C-style) or `'column-major'` (Fortran-style). Overrides the input ndarray's inferred order.
+
+To override either the `dtype`, `shape`, or `order`, specify the corresponding option. For example, to override the inferred [data type][@stdlib/ndarray/dtypes], 
+
+```javascript
+var zeros = require( '@stdlib/ndarray-zeros' );
+
+var x = zeros( [ 2, 2 ] );
+// returns <ndarray>
+
+var dt = x.dtype;
+// returns 'float64'
+
+var y = zerosLike( x, {
+    'dtype': 'int32'
+});
+// returns <ndarray>
+
+var sh = y.shape;
+// returns [ 2, 2 ]
+
+dt = y.dtype;
+// returns 'int32'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var dtypes = require( '@stdlib/ndarray-dtypes' );
+var zeros = require( '@stdlib/ndarray-zeros' );
+var zerosLike = require( '@stdlib/ndarray-zeros-like' );
+
+// Get a list of data types:
+var dt = dtypes();
+
+// Generate zero-filled arrays...
+var x;
+var y;
+var i;
+for ( i = 0; i < dt.length; i++ ) {
+    x = zeros( [ 2, 2 ], {
+        'dtype': dt[ i ]
+    });
+    y = zerosLike( x );
+    console.log( y.data );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+
+<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 &copy; 2016-2022. 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-zeros-like.svg
+[npm-url]: https://npmjs.org/package/@stdlib/ndarray-zeros-like
+
+[test-image]: https://github.com/stdlib-js/ndarray-zeros-like/actions/workflows/test.yml/badge.svg
+[test-url]: https://github.com/stdlib-js/ndarray-zeros-like/actions/workflows/test.yml
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-zeros-like/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-zeros-like?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-zeros-like.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-zeros-like/main
+
+-->
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/ndarray-zeros-like/tree/deno
+[umd-url]: https://github.com/stdlib-js/ndarray-zeros-like/tree/umd
+[esm-url]: https://github.com/stdlib-js/ndarray-zeros-like/tree/esm
+
+[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-zeros-like/main/LICENSE
+
+[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/stdlib
+
+[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/stdlib
+
+</section>
+
+<!-- /.links -->

package/docs/repl.txt

@@ -0,0 +1,53 @@
+
+{{alias}}( x[, options] )
+    Returns a zero-filled ndarray having the same shape and data type as a
+    provided input ndarray.
+
+    The function infers the following attributes from the input array:
+
+    - shape: array shape.
+    - dtype: underlying array data type.
+    - order: whether the array order is row-major (C-style) or column-major
+      (Fortran-style).
+
+    Parameters
+    ----------
+    x: ndarray
+        Input array.
+
+    options: Object (optional)
+        Options.
+
+    options.shape: ArrayLikeObject<integer>|integer (optional)
+        Array shape. Overrides the input array's inferred shape.
+
+    options.dtype: string (optional)
+        Array data type. Overrides the input array's inferred data type.
+
+    options.order: string (optional)
+        Array order (either 'row-major' (C-style) or 'column-major' (Fortran-
+        style)). Overrides the input array's inferred order.
+
+    Returns
+    -------
+    out: ndarray
+        Output array.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/base/zeros}}( 'float64', [ 2, 2 ], 'row-major' )
+    <ndarray>
+    > var sh = x.shape
+    [ 2, 2 ]
+    > var dt = x.dtype
+    'float64'
+    > var y = {{alias}}( x )
+    <ndarray>
+    > sh = y.shape
+    [ 2, 2 ]
+    > dt = y.dtype
+    'float64'
+
+    See Also
+    --------
+