@stdlib/array-nans 0.0.1 → 0.1.0

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>
+
 # nans
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -175,8 +186,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.1.0
+[test-url]: https://github.com/stdlib-js/array-nans/actions/workflows/test.yml?query=branch:v0.1.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 +200,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
 

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 l=function(a,e){return function(){return e||a((e={exports:{}}).exports,e),e.exports}};var t=l(function(x,o){
+var i=require('@stdlib/complex-float64/dist'),u=require('@stdlib/complex-float32/dist'),s=require('@stdlib/array-full/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),m=new i(NaN,NaN),v=new u(NaN,NaN),n=["float64","float32","complex128","complex64","generic"];function p(a){var e,r;if(arguments.length>1){if(e=arguments[1],n.indexOf(e)===-1)throw new TypeError(f('1ZnDQ',n.join('", "'),e))}else e="float64";return e==="complex128"?r=m:e==="complex64"?r=v:r=NaN,s(a,r,e)}o.exports=p
+});var N=t();module.exports=N;
+/** @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 Complex128 = require( '@stdlib/complex-float64' );\nvar Complex64 = require( '@stdlib/complex-float32' );\nvar full = require( '@stdlib/array-full' );\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 = [ 'float64', 'float32', 'complex128', 'complex64', 'generic' ];\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 ( DTYPES.indexOf( dtype ) === -1 ) {\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 = 'float64';\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,EAAa,QAAS,yBAA0B,EAChDC,EAAY,QAAS,yBAA0B,EAC/CC,EAAO,QAAS,oBAAqB,EACrCC,EAAS,QAAS,uBAAwB,EAK1CC,EAAO,IAAIJ,EAAY,IAAK,GAAI,EAChCK,EAAM,IAAIJ,EAAW,IAAK,GAAI,EAC9BK,EAAS,CAAE,UAAW,UAAW,aAAc,YAAa,SAAU,EAsB1E,SAASC,EAAMC,EAAS,CACvB,IAAIC,EACAC,EAEJ,GAAK,UAAU,OAAS,GAEvB,GADAD,EAAQ,UAAW,CAAE,EAChBH,EAAO,QAASG,CAAM,IAAM,GAChC,MAAM,IAAI,UAAWN,EAAQ,qFAAsFG,EAAO,KAAM,MAAO,EAAGG,CAAM,CAAE,OAGnJA,EAAQ,UAET,OAAKA,IAAU,aACdC,EAAQN,EACGK,IAAU,YACrBC,EAAQL,EAERK,EAAQ,IAEFR,EAAMM,EAAQE,EAAOD,CAAM,CACnC,CAKAV,EAAO,QAAUQ,ICvCjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "Complex128", "Complex64", "full", "format", "Z128", "Z64", "DTYPES", "nans", "length", "dtype", "value", "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"/>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-nans",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Create an array filled with NaNs and having a specified length.",
   "license": "Apache-2.0",
   "author": {
@@ -37,28 +37,29 @@
     "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-full": "^0.1.0",
+    "@stdlib/complex-float32": "^0.1.0",
+    "@stdlib/complex-float64": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.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.1.0",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/array-typed-float-dtypes": "^0.1.0",
+    "@stdlib/assert-instance-of": "^0.1.0",
+    "@stdlib/assert-is-array": "^0.1.0",
+    "@stdlib/assert-is-typed-array": "^0.1.0",
+    "@stdlib/assert-is-typed-array-like": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-nanf": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.1.0",
+    "@stdlib/strided-base-reinterpret-complex128": "^0.1.0",
+    "@stdlib/strided-base-reinterpret-complex64": "^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"

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
-}