@stdlib/array-nans 0.0.1 → 0.2.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

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>
+
 # nans
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -132,6 +143,15 @@ for ( i = 0; i < dt.length; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array-full`][@stdlib/array/full]</span><span class="delimiter">: </span><span class="description">create a filled array having a specified length.</span>
+-   <span class="package-name">[`@stdlib/array-nans-like`][@stdlib/array/nans-like]</span><span class="delimiter">: </span><span class="description">create an array filled with NaNs and having the same length and data type as a provided array.</span>
+-   <span class="package-name">[`@stdlib/array-ones`][@stdlib/array/ones]</span><span class="delimiter">: </span><span class="description">create an array filled with ones and having a specified length.</span>
+-   <span class="package-name">[`@stdlib/array-zeros`][@stdlib/array/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled array having a specified length.</span>
+
 </section>
 
 <!-- /.related -->
@@ -162,7 +182,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -175,8 +195,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-nans.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-nans
 
-[test-image]: https://github.com/stdlib-js/array-nans/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/array-nans/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/array-nans/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/array-nans/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-nans/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-nans?branch=main
@@ -189,7 +209,7 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -199,14 +219,29 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/array-nans/tree/deno
+[deno-readme]: https://github.com/stdlib-js/array-nans/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/array-nans/tree/umd
+[umd-readme]: https://github.com/stdlib-js/array-nans/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/array-nans/tree/esm
+[esm-readme]: https://github.com/stdlib-js/array-nans/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/array-nans/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-nans/main/LICENSE
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
+<!-- <related-links> -->
+
+[@stdlib/array/full]: https://www.npmjs.com/package/@stdlib/array-full
+
+[@stdlib/array/nans-like]: https://www.npmjs.com/package/@stdlib/array-nans-like
+
+[@stdlib/array/ones]: https://www.npmjs.com/package/@stdlib/array-ones
+
+[@stdlib/array/zeros]: https://www.npmjs.com/package/@stdlib/array-zeros
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var o=function(a,e){return function(){return e||a((e={exports:{}}).exports,e),e.exports}};var n=o(function(_,t){
+var u=require('@stdlib/array-base-assert-contains/dist').factory,l=require('@stdlib/complex-float64/dist'),s=require('@stdlib/complex-float32/dist'),v=require('@stdlib/array-full/dist'),f=require('@stdlib/array-defaults/dist'),p=require('@stdlib/array-dtypes/dist'),m=require('@stdlib/error-tools-fmtprodmsg/dist'),g=new l(NaN,NaN),N=new s(NaN,NaN),i=p("floating_point_and_generic"),c=u(i),d=f.get("dtypes.real_floating_point");function q(a){var e,r;if(arguments.length>1){if(e=arguments[1],!c(e))throw new TypeError(m('1ZnDQ',i.join('", "'),e))}else e=d;return e==="complex128"?r=g:e==="complex64"?r=N:r=NaN,v(a,r,e)}t.exports=q
+});var x=n();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 contains = require( '@stdlib/array-base-assert-contains' ).factory;\nvar Complex128 = require( '@stdlib/complex-float64' );\nvar Complex64 = require( '@stdlib/complex-float32' );\nvar full = require( '@stdlib/array-full' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar Z128 = new Complex128( NaN, NaN );\nvar Z64 = new Complex64( NaN, NaN );\nvar DTYPES = dtypes( 'floating_point_and_generic' );\nvar isValidDType = contains( DTYPES );\nvar DEFAULT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Creates an array filled with NaNs and having a specified length.\n*\n* @param {NonNegativeInteger} length - array length\n* @param {string} [dtype=\"float64\"] - data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} second argument must be a supported data type\n* @returns {(TypedArray|Array|ComplexArray)} array or typed array\n*\n* @example\n* var arr = nans( 2 );\n* // returns <Float64Array>[ NaN, NaN ]\n*\n* @example\n* var arr = nans( 2, 'float32' );\n* // returns <Float32Array>[ NaN, NaN ]\n*/\nfunction nans( length ) {\n\tvar dtype;\n\tvar value;\n\n\tif ( arguments.length > 1 ) {\n\t\tdtype = arguments[ 1 ];\n\t\tif ( !isValidDType( dtype ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be one of the following: \"%s\". Value: `%s`.', DTYPES.join( '\", \"' ), dtype ) );\n\t\t}\n\t} else {\n\t\tdtype = DEFAULT_DTYPE;\n\t}\n\tif ( dtype === 'complex128' ) {\n\t\tvalue = Z128;\n\t} else if ( dtype === 'complex64' ) {\n\t\tvalue = Z64;\n\t} else {\n\t\tvalue = NaN;\n\t}\n\treturn full( length, value, dtype );\n}\n\n\n// EXPORTS //\n\nmodule.exports = nans;\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 array filled with NaNs and having a specified length.\n*\n* @module @stdlib/array-nans\n*\n* @example\n* var nans = require( '@stdlib/array-nans' );\n*\n* var arr = nans( 2 );\n* // returns <Float64Array>[ NaN, NaN ]\n*\n* @example\n* var nans = require( '@stdlib/array-nans' );\n*\n* var arr = nans( 2, 'float32' );\n* // returns <Float32Array>[ NaN, NaN ]\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,EAAW,QAAS,oCAAqC,EAAE,QAC3DC,EAAa,QAAS,yBAA0B,EAChDC,EAAY,QAAS,yBAA0B,EAC/CC,EAAO,QAAS,oBAAqB,EACrCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAS,QAAS,sBAAuB,EACzCC,EAAS,QAAS,uBAAwB,EAK1CC,EAAO,IAAIN,EAAY,IAAK,GAAI,EAChCO,EAAM,IAAIN,EAAW,IAAK,GAAI,EAC9BO,EAASJ,EAAQ,4BAA6B,EAC9CK,EAAeV,EAAUS,CAAO,EAChCE,EAAgBP,EAAS,IAAK,4BAA6B,EAsB/D,SAASQ,EAAMC,EAAS,CACvB,IAAIC,EACAC,EAEJ,GAAK,UAAU,OAAS,GAEvB,GADAD,EAAQ,UAAW,CAAE,EAChB,CAACJ,EAAcI,CAAM,EACzB,MAAM,IAAI,UAAWR,EAAQ,qFAAsFG,EAAO,KAAM,MAAO,EAAGK,CAAM,CAAE,OAGnJA,EAAQH,EAET,OAAKG,IAAU,aACdC,EAAQR,EACGO,IAAU,YACrBC,EAAQP,EAERO,EAAQ,IAEFZ,EAAMU,EAAQE,EAAOD,CAAM,CACnC,CAKAf,EAAO,QAAUa,IC5CjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "contains", "Complex128", "Complex64", "full", "defaults", "dtypes", "format", "Z128", "Z64", "DTYPES", "isValidDType", "DEFAULT_DTYPE", "nans", "length", "dtype", "value", "main"]
+}

package/docs/types/index.d.ts

@@ -16,16 +16,16 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Complex128Array, Complex64Array, FloatOrComplexDataType } from '@stdlib/types/array';
+import { Complex128Array, Complex64Array, FloatingPointDataType } from '@stdlib/types/array';
 
 /**
 * Data type.
 */
-type DataType = FloatOrComplexDataType | 'generic';
+type DataType = FloatingPointDataType | 'generic';
 
 /**
 * Creates an array filled with NaNs and having a specified length.

package/lib/main.js

@@ -20,9 +20,12 @@
 
 // MODULES //
 
+var contains = require( '@stdlib/array-base-assert-contains' ).factory;
 var Complex128 = require( '@stdlib/complex-float64' );
 var Complex64 = require( '@stdlib/complex-float32' );
 var full = require( '@stdlib/array-full' );
+var defaults = require( '@stdlib/array-defaults' );
+var dtypes = require( '@stdlib/array-dtypes' );
 var format = require( '@stdlib/string-format' );
 
 
@@ -30,7 +33,9 @@ var format = require( '@stdlib/string-format' );
 
 var Z128 = new Complex128( NaN, NaN );
 var Z64 = new Complex64( NaN, NaN );
-var DTYPES = [ 'float64', 'float32', 'complex128', 'complex64', 'generic' ];
+var DTYPES = dtypes( 'floating_point_and_generic' );
+var isValidDType = contains( DTYPES );
+var DEFAULT_DTYPE = defaults.get( 'dtypes.real_floating_point' );
 
 
 // MAIN //
@@ -58,11 +63,11 @@ function nans( length ) {
 
 	if ( arguments.length > 1 ) {
 		dtype = arguments[ 1 ];
-		if ( DTYPES.indexOf( dtype ) === -1 ) {
+		if ( !isValidDType( dtype ) ) {
 			throw new TypeError( format( 'invalid argument. Second argument must be one of the following: "%s". Value: `%s`.', DTYPES.join( '", "' ), dtype ) );
 		}
 	} else {
-		dtype = 'float64';
+		dtype = DEFAULT_DTYPE;
 	}
 	if ( dtype === 'complex128' ) {
 		value = Z128;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-nans",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Create an array filled with NaNs and having a specified length.",
   "license": "Apache-2.0",
   "author": {
@@ -37,31 +37,36 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/array-full": "^0.0.1",
-    "@stdlib/complex-float32": "^0.0.7",
-    "@stdlib/complex-float64": "^0.0.8",
-    "@stdlib/string-format": "^0.0.3",
-    "@stdlib/types": "^0.0.14"
+    "@stdlib/array-base-assert-contains": "^0.2.0",
+    "@stdlib/array-defaults": "^0.2.0",
+    "@stdlib/array-dtypes": "^0.2.0",
+    "@stdlib/array-full": "^0.2.0",
+    "@stdlib/complex-float32": "^0.2.0",
+    "@stdlib/complex-float64": "^0.2.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/types": "^0.3.1",
+    "@stdlib/error-tools-fmtprodmsg": "^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-typed-float-dtypes": "^0.0.1",
-    "@stdlib/assert-instance-of": "^0.0.8",
-    "@stdlib/assert-is-array": "^0.0.7",
-    "@stdlib/assert-is-typed-array": "^0.0.6",
-    "@stdlib/assert-is-typed-array-like": "^0.0.8",
-    "@stdlib/bench": "^0.0.12",
-    "@stdlib/math-base-assert-is-nan": "^0.0.8",
-    "@stdlib/math-base-assert-is-nanf": "^0.0.8",
-    "@stdlib/math-base-special-pow": "^0.0.7",
-    "@stdlib/strided-base-reinterpret-complex128": "^0.0.2",
-    "@stdlib/strided-base-reinterpret-complex64": "^0.0.2",
+    "@stdlib/array-complex128": "^0.1.0",
+    "@stdlib/array-complex64": "^0.1.0",
+    "@stdlib/array-float32": "^0.2.0",
+    "@stdlib/array-float64": "^0.2.0",
+    "@stdlib/array-typed-float-dtypes": "^0.2.0",
+    "@stdlib/assert-instance-of": "^0.2.0",
+    "@stdlib/assert-is-array": "^0.2.0",
+    "@stdlib/assert-is-typed-array": "^0.2.0",
+    "@stdlib/assert-is-typed-array-like": "^0.2.0",
+    "@stdlib/math-base-assert-is-nan": "^0.2.0",
+    "@stdlib/math-base-assert-is-nanf": "^0.2.0",
+    "@stdlib/math-base-special-pow": "^0.2.0",
+    "@stdlib/strided-base-reinterpret-complex128": "^0.2.0",
+    "@stdlib/strided-base-reinterpret-complex64": "^0.2.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"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
+    "@stdlib/bench-harness": "^0.2.0",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",

package/docs/repl.txt

@@ -1,37 +0,0 @@
-
-{{alias}}( length[, dtype] )
-    Returns an array filled with NaNs and having a specified length.
-
-    The function supports the following data types:
-
-    - float64: double-precision floating-point numbers (IEEE 754)
-    - float32: single-precision floating-point numbers (IEEE 754)
-    - complex128: double-precision complex floating-point numbers
-    - complex64: single-precision complex floating-point numbers
-    - generic: generic JavaScript values
-
-    The default array data type is `float64`.
-
-    Parameters
-    ----------
-    length: integer
-        Array length.
-
-    dtype: string (optional)
-        Data type. Default: 'float64'.
-
-    Returns
-    -------
-    out: TypedArray|Array
-        Output array.
-
-    Examples
-    --------
-    > var arr = {{alias}}( 2 )
-    <Float64Array>[ NaN, NaN ]
-    > arr = {{alias}}( 2, 'float32' )
-    <Float32Array>[ NaN, NaN ]
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,70 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2023 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.
-*/
-
-import nans = require( './index' );
-
-
-// TESTS //
-
-// The function returns an array or typed array...
-{
-	nans( 10 ); // $ExpectType Float64Array
-	nans( 10, 'float64' ); // $ExpectType Float64Array
-	nans( 10, 'float32' ); // $ExpectType Float32Array
-	nans( 10, 'complex128' ); // $ExpectType Complex128Array
-	nans( 10, 'complex64' ); // $ExpectType Complex64Array
-	nans( 10, 'generic' ); // $ExpectType number[]
-}
-
-// The compiler throws an error if the function is not provided a number for the first argument...
-{
-	nans( '5' ); // $ExpectError
-	nans( false ); // $ExpectError
-	nans( true ); // $ExpectError
-	nans( null ); // $ExpectError
-	nans( undefined ); // $ExpectError
-	nans( [] ); // $ExpectError
-	nans( {} ); // $ExpectError
-	nans( ( x: number ): number => x ); // $ExpectError
-
-	nans( '5', 'float32' ); // $ExpectError
-	nans( false, 'float32' ); // $ExpectError
-	nans( true, 'float32' ); // $ExpectError
-	nans( null, 'float32' ); // $ExpectError
-	nans( undefined, 'float32' ); // $ExpectError
-	nans( [], 'float32' ); // $ExpectError
-	nans( {}, 'float32' ); // $ExpectError
-	nans( ( x: number ): number => x, 'float32' ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is an unrecognized/unsupported data type...
-{
-	nans( 10, '10' ); // $ExpectError
-	nans( 10, 10 ); // $ExpectError
-	nans( 10, false ); // $ExpectError
-	nans( 10, true ); // $ExpectError
-	nans( 10, null ); // $ExpectError
-	nans( 10, [] ); // $ExpectError
-	nans( 10, {} ); // $ExpectError
-	nans( 10, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	nans( 10, 'float64', 1 ); // $ExpectError
-}