@stdlib/ndarray-base-empty 0.0.1 → 0.1.1

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # empty
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -173,8 +184,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-empty.svg
 [npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-empty
 
-[test-image]: https://github.com/stdlib-js/ndarray-base-empty/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/ndarray-base-empty/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/ndarray-base-empty/actions/workflows/test.yml/badge.svg?branch=v0.1.1
+[test-url]: https://github.com/stdlib-js/ndarray-base-empty/actions/workflows/test.yml?query=branch:v0.1.1
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-empty/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-empty?branch=main
@@ -203,9 +214,9 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-empty/main/LICENSE
 
-[@stdlib/ndarray/base/ctor]: https://www.npmjs.com/package/@stdlib/stdlib
+[@stdlib/ndarray/base/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-base-ctor
 
-[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/stdlib
+[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
 
 </section>
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import empty from '../docs/types/index';
+export = empty;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var f=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=f(function(g,n){
+var l=require('@stdlib/ndarray-base-shape2strides/dist'),q=require('@stdlib/ndarray-base-strides2offset/dist'),m=require('@stdlib/ndarray-base-ctor/dist'),c=require('@stdlib/ndarray-base-numel/dist'),o=require('@stdlib/array-empty/dist'),y=require('@stdlib/buffer-alloc-unsafe/dist');function b(e,r,t){var u,s,i,a;return u=r.length,u>0?(i=c(r),a=l(r,t)):(i=1,a=[0]),e==="binary"?s=y(i):s=o(i,e),new m(e,s,r,a,q(r,a),t)}n.exports=b
+});var x=v();module.exports=x;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar strides2offset = require( '@stdlib/ndarray-base-strides2offset' );\nvar ndarray = require( '@stdlib/ndarray-base-ctor' );\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar emptyArray = require( '@stdlib/array-empty' );\nvar allocUnsafe = require( '@stdlib/buffer-alloc-unsafe' );\n\n\n// MAIN //\n\n/**\n* Creates an uninitialized ndarray having a specified shape and data type.\n*\n* @param {string} dtype - data type\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {string} order - array order\n* @throws {TypeError} first argument must be a recognized data type\n* @returns {ndarray} ndarray\n*\n* @example\n* var arr = empty( 'float32', [ 2, 2 ], 'row-major' );\n* // returns <ndarray>\n*\n* var sh = arr.shape;\n* // returns [ 2, 2 ]\n*\n* var dt = arr.dtype;\n* // returns 'float32'\n*/\nfunction empty( dtype, shape, order ) {\n\tvar ndims;\n\tvar buf;\n\tvar len;\n\tvar st;\n\n\tndims = shape.length;\n\tif ( ndims > 0 ) {\n\t\tlen = numel( shape );\n\t\tst = shape2strides( shape, order );\n\t} else {\n\t\t// For 0-dimensional arrays, the buffer should contain a single element...\n\t\tlen = 1;\n\t\tst = [ 0 ];\n\t}\n\tif ( dtype === 'binary' ) {\n\t\tbuf = allocUnsafe( len );\n\t} else {\n\t\tbuf = emptyArray( len, dtype );\n\t}\n\treturn new ndarray( dtype, buf, shape, st, strides2offset( shape, st ), order ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = empty;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Create an uninitialized ndarray having a specified shape and data type.\n*\n* @module @stdlib/ndarray-base-empty\n*\n* @example\n* var empty = require( '@stdlib/ndarray-base-empty' );\n*\n* var arr = empty( 'float32', [ 2, 2 ], 'row-major' );\n* // returns <ndarray>\n*\n* var sh = arr.shape;\n* // returns [ 2, 2 ]\n*\n* var dt = arr.dtype;\n* // returns 'float32'\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAiB,QAAS,qCAAsC,EAChEC,EAAU,QAAS,2BAA4B,EAC/CC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAa,QAAS,qBAAsB,EAC5CC,EAAc,QAAS,6BAA8B,EAwBzD,SAASC,EAAOC,EAAOC,EAAOC,EAAQ,CACrC,IAAIC,EACAC,EACAC,EACAC,EAEJ,OAAAH,EAAQF,EAAM,OACTE,EAAQ,GACZE,EAAMT,EAAOK,CAAM,EACnBK,EAAKb,EAAeQ,EAAOC,CAAM,IAGjCG,EAAM,EACNC,EAAK,CAAE,CAAE,GAELN,IAAU,SACdI,EAAMN,EAAaO,CAAI,EAEvBD,EAAMP,EAAYQ,EAAKL,CAAM,EAEvB,IAAIL,EAASK,EAAOI,EAAKH,EAAOK,EAAIZ,EAAgBO,EAAOK,CAAG,EAAGJ,CAAM,CAC/E,CAKAV,EAAO,QAAUO,ICrCjB,IAAIQ,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "shape2strides", "strides2offset", "ndarray", "numel", "emptyArray", "allocUnsafe", "empty", "dtype", "shape", "order", "ndims", "buf", "len", "st", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
@@ -40,7 +40,7 @@ import { Shape, Order, typedndarray, float64ndarray, float32ndarray, int32ndarra
 * var dt = arr.dtype;
 * // returns 'float64'
 */
-declare function empty( dtype: 'float64', shape: Shape, order: Order ): float64ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'float64', shape: Shape, order: Order ): float64ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -60,7 +60,7 @@ declare function empty( dtype: 'float64', shape: Shape, order: Order ): float64n
 * var dt = arr.dtype;
 * // returns 'float32'
 */
-declare function empty( dtype: 'float32', shape: Shape, order: Order ): float32ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'float32', shape: Shape, order: Order ): float32ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -80,7 +80,7 @@ declare function empty( dtype: 'float32', shape: Shape, order: Order ): float32n
 * var dt = arr.dtype;
 * // returns 'complex128'
 */
-declare function empty( dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -100,7 +100,7 @@ declare function empty( dtype: 'complex128', shape: Shape, order: Order ): compl
 * var dt = arr.dtype;
 * // returns 'complex64'
 */
-declare function empty( dtype: 'complex64', shape: Shape, order: Order ): complex64ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'complex64', shape: Shape, order: Order ): complex64ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -120,7 +120,7 @@ declare function empty( dtype: 'complex64', shape: Shape, order: Order ): comple
 * var dt = arr.dtype;
 * // returns 'int32'
 */
-declare function empty( dtype: 'int32', shape: Shape, order: Order ): int32ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'int32', shape: Shape, order: Order ): int32ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -140,7 +140,7 @@ declare function empty( dtype: 'int32', shape: Shape, order: Order ): int32ndarr
 * var dt = arr.dtype;
 * // returns 'int16'
 */
-declare function empty( dtype: 'int16', shape: Shape, order: Order ): int16ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'int16', shape: Shape, order: Order ): int16ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -160,7 +160,7 @@ declare function empty( dtype: 'int16', shape: Shape, order: Order ): int16ndarr
 * var dt = arr.dtype;
 * // returns 'int8'
 */
-declare function empty( dtype: 'int8', shape: Shape, order: Order ): int8ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'int8', shape: Shape, order: Order ): int8ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -180,7 +180,7 @@ declare function empty( dtype: 'int8', shape: Shape, order: Order ): int8ndarray
 * var dt = arr.dtype;
 * // returns 'uint32'
 */
-declare function empty( dtype: 'uint32', shape: Shape, order: Order ): uint32ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'uint32', shape: Shape, order: Order ): uint32ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -200,7 +200,7 @@ declare function empty( dtype: 'uint32', shape: Shape, order: Order ): uint32nda
 * var dt = arr.dtype;
 * // returns 'uint16'
 */
-declare function empty( dtype: 'uint16', shape: Shape, order: Order ): uint16ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'uint16', shape: Shape, order: Order ): uint16ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -220,7 +220,7 @@ declare function empty( dtype: 'uint16', shape: Shape, order: Order ): uint16nda
 * var dt = arr.dtype;
 * // returns 'uint8'
 */
-declare function empty( dtype: 'uint8', shape: Shape, order: Order ): uint8ndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'uint8', shape: Shape, order: Order ): uint8ndarray;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -240,7 +240,7 @@ declare function empty( dtype: 'uint8', shape: Shape, order: Order ): uint8ndarr
 * var dt = arr.dtype;
 * // returns 'uint8c'
 */
-declare function empty( dtype: 'uint8c', shape: Shape, order: Order ): uint8cndarray; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'uint8c', shape: Shape, order: Order ): uint8cndarray;
 
 /**
 * Creates a zero-filled array having a specified shape and data type.
@@ -260,7 +260,7 @@ declare function empty( dtype: 'uint8c', shape: Shape, order: Order ): uint8cnda
 * var dt = arr.dtype;
 * // returns 'generic'
 */
-declare function empty( dtype: 'generic', shape: Shape, order: Order ): typedndarray<number>; // tslint:disable-line:max-line-length
+declare function empty( dtype: 'generic', shape: Shape, order: Order ): typedndarray<number>;
 
 /**
 * Creates an uninitialized array having a specified shape and data type.
@@ -280,7 +280,7 @@ declare function empty( dtype: 'generic', shape: Shape, order: Order ): typednda
 * var dt = arr.dtype;
 * // returns 'float32'
 */
-declare function empty( dtype: DataType, shape: Shape, order: Order ): typedndarray<number>; // tslint:disable-line:max-line-length unified-signatures
+declare function empty( dtype: DataType, shape: Shape, order: Order ): typedndarray<number>;
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/ndarray-base-empty",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "description": "Create an uninitialized ndarray having a specified shape and data type.",
   "license": "Apache-2.0",
   "author": {
@@ -37,32 +37,32 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/array-empty": "^0.0.1",
-    "@stdlib/buffer-alloc-unsafe": "^0.0.7",
-    "@stdlib/ndarray-base-ctor": "^0.0.6",
-    "@stdlib/ndarray-base-numel": "^0.0.8",
-    "@stdlib/ndarray-base-shape2strides": "^0.0.8",
-    "@stdlib/ndarray-base-strides2offset": "^0.0.8",
-    "@stdlib/types": "^0.0.14"
+    "@stdlib/array-empty": "^0.1.0",
+    "@stdlib/buffer-alloc-unsafe": "^0.1.0",
+    "@stdlib/ndarray-base-ctor": "^0.1.0",
+    "@stdlib/ndarray-base-numel": "^0.1.1",
+    "@stdlib/ndarray-base-shape2strides": "^0.1.1",
+    "@stdlib/ndarray-base-strides2offset": "^0.1.1",
+    "@stdlib/types": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/array-complex128": "^0.0.6",
-    "@stdlib/array-complex64": "^0.0.6",
-    "@stdlib/array-float32": "^0.0.6",
-    "@stdlib/array-float64": "^0.0.6",
-    "@stdlib/array-int16": "^0.0.6",
-    "@stdlib/array-int32": "^0.0.6",
-    "@stdlib/array-int8": "^0.0.6",
-    "@stdlib/array-uint16": "^0.0.6",
-    "@stdlib/array-uint32": "^0.0.6",
-    "@stdlib/array-uint8": "^0.0.7",
-    "@stdlib/array-uint8c": "^0.0.8",
-    "@stdlib/assert-instance-of": "^0.0.8",
-    "@stdlib/assert-is-ndarray-like": "^0.0.6",
-    "@stdlib/bench": "^0.0.12",
-    "@stdlib/buffer-ctor": "^0.0.7",
-    "@stdlib/math-base-special-pow": "^0.0.7",
-    "@stdlib/ndarray-dtypes": "^0.0.9",
+    "@stdlib/array-complex128": "^0.1.0",
+    "@stdlib/array-complex64": "^0.1.0",
+    "@stdlib/array-float32": "^0.1.1",
+    "@stdlib/array-float64": "^0.1.1",
+    "@stdlib/array-int16": "^0.1.1",
+    "@stdlib/array-int32": "^0.1.1",
+    "@stdlib/array-int8": "^0.1.1",
+    "@stdlib/array-uint16": "^0.1.1",
+    "@stdlib/array-uint32": "^0.1.1",
+    "@stdlib/array-uint8": "^0.1.1",
+    "@stdlib/array-uint8c": "^0.1.1",
+    "@stdlib/assert-instance-of": "^0.1.1",
+    "@stdlib/assert-is-ndarray-like": "^0.1.0",
+    "@stdlib/bench": "^0.2.1",
+    "@stdlib/buffer-ctor": "^0.1.1",
+    "@stdlib/math-base-special-pow": "^0.1.0",
+    "@stdlib/ndarray-dtypes": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
     "tap-min": "git+https://github.com/Planeshifter/tap-min.git"