@stdlib/complex-base 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>
+
 # Base Complex
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -57,6 +68,7 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`assert`][@stdlib/complex/base/assert]</span><span class="delimiter">: </span><span class="description">base complex number assert functions.</span>
 -   <span class="signature">[`cast( fcn, nargs, ctor )`][@stdlib/complex/base/cast-return]</span><span class="delimiter">: </span><span class="description">wrap a function and cast a function's return value to a complex number.</span>
 -   <span class="signature">[`wrap( fcn, nargs, ctor )`][@stdlib/complex/base/wrap-function]</span><span class="delimiter">: </span><span class="description">wrap a function accepting complex number arguments to support providing both real and complex numbers.</span>
 
@@ -129,7 +141,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>
 
@@ -142,8 +154,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/complex-base.svg
 [npm-url]: https://npmjs.org/package/@stdlib/complex-base
 
-[test-image]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml/badge.svg?branch=v0.0.1
-[test-url]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml?query=branch:v0.0.1
+[test-image]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/complex-base/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-base/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/complex-base?branch=main
@@ -156,7 +168,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
 
@@ -166,14 +178,19 @@ 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/complex-base/tree/deno
+[deno-readme]: https://github.com/stdlib-js/complex-base/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/complex-base/tree/umd
+[umd-readme]: https://github.com/stdlib-js/complex-base/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/complex-base/tree/esm
+[esm-readme]: https://github.com/stdlib-js/complex-base/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/complex-base/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/complex-base/main/LICENSE
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/base/assert]: https://www.npmjs.com/package/@stdlib/complex-base-assert
+
 [@stdlib/complex/base/cast-return]: https://www.npmjs.com/package/@stdlib/complex-base-cast-return
 
 [@stdlib/complex/base/wrap-function]: https://www.npmjs.com/package/@stdlib/complex-base-wrap-function

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 ns from '../docs/types/index';
+export = ns;

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";var e=require('@stdlib/utils-define-read-only-property/dist'),r={};e(r,"assert",require('@stdlib/complex-base-assert/dist'));e(r,"cast",require('@stdlib/complex-base-cast-return/dist'));e(r,"wrap",require('@stdlib/complex-base-wrap-function/dist'));module.exports=r;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-read-only-property' );\n\n\n// MAIN //\n\n/**\n* Top-level namespace.\n*\n* @namespace ns\n*/\nvar ns = {};\n\n/**\n* @name assert\n* @memberof ns\n* @readonly\n* @type {Namespace}\n* @see {@link module:@stdlib/complex/base/assert}\n*/\nsetReadOnly( ns, 'assert', require( '@stdlib/complex-base-assert' ) );\n\n/**\n* @name cast\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/cast-return}\n*/\nsetReadOnly( ns, 'cast', require( '@stdlib/complex-base-cast-return' ) );\n\n/**\n* @name wrap\n* @memberof ns\n* @readonly\n* @type {Function}\n* @see {@link module:@stdlib/complex/base/wrap-function}\n*/\nsetReadOnly( ns, 'wrap', require( '@stdlib/complex-base-wrap-function' ) );\n\n\n// EXPORTS //\n\nmodule.exports = ns;\n"],
+  "mappings": "aA0BA,IAAIA,EAAc,QAAS,yCAA0C,EAUjEC,EAAK,CAAC,EASVD,EAAaC,EAAI,SAAU,QAAS,6BAA8B,CAAE,EASpED,EAAaC,EAAI,OAAQ,QAAS,kCAAmC,CAAE,EASvED,EAAaC,EAAI,OAAQ,QAAS,oCAAqC,CAAE,EAKzE,OAAO,QAAUA",
+  "names": ["setReadOnly", "ns"]
+}

package/docs/types/index.d.ts

@@ -16,11 +16,11 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
-/* tslint:disable:max-line-length */
-/* tslint:disable:max-file-line-count */
+/* eslint-disable max-lines */
 
+import assert = require( '@stdlib/complex-base-assert' );
 import cast = require( '@stdlib/complex-base-cast-return' );
 import wrap = require( '@stdlib/complex-base-wrap-function' );
 
@@ -28,6 +28,11 @@ import wrap = require( '@stdlib/complex-base-wrap-function' );
 * Interface describing the `base` namespace.
 */
 interface Namespace {
+	/**
+	* Base complex number assert functions.
+	*/
+	assert: typeof assert;
+
 	/**
 	* Wraps an n-ary function and casts a function's return value to a complex number.
 	*
@@ -43,9 +48,9 @@ interface Namespace {
 	* @returns wrapped function
 	*
 	* @example
-	* var Complex64 = require( `@stdlib/complex/float32` );
-	* var realf = require( `@stdlib/complex/realf` );
-	* var imagf = require( `@stdlib/complex/imagf` );
+	* var Complex64 = require( '@stdlib/complex-float32' );
+	* var realf = require( '@stdlib/complex-realf' );
+	* var imagf = require( '@stdlib/complex-imagf' );
 	*
 	* function add( x, y, z, w, v, t ) {
 	*     return x + y + z + w + v + t;
@@ -81,9 +86,9 @@ interface Namespace {
 	* @returns wrapped function
 	*
 	* @example
-	* var Complex64 = require( `@stdlib/complex/float32` );
-	* var realf = require( `@stdlib/complex/realf` );
-	* var imagf = require( `@stdlib/complex/imagf` );
+	* var Complex64 = require( '@stdlib/complex-float32' );
+	* var realf = require( '@stdlib/complex-realf' );
+	* var imagf = require( '@stdlib/complex-imagf' );
 	*
 	* function add( x, y, z, w, v, t ) {
 	*     var re = realf( x ) + realf( y ) + realf( z ) + realf( w ) + realf( v ) + realf( t );
@@ -108,7 +113,7 @@ interface Namespace {
 }
 
 /**
-* Base (i.e., lower-level) complex number functions
+* Base (i.e., lower-level) complex number functions.
 */
 declare var ns: Namespace;
 

package/lib/index.js

@@ -36,6 +36,15 @@ var setReadOnly = require( '@stdlib/utils-define-read-only-property' );
 */
 var ns = {};
 
+/**
+* @name assert
+* @memberof ns
+* @readonly
+* @type {Namespace}
+* @see {@link module:@stdlib/complex/base/assert}
+*/
+setReadOnly( ns, 'assert', require( '@stdlib/complex-base-assert' ) );
+
 /**
 * @name cast
 * @memberof ns

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/complex-base",
-  "version": "0.0.1",
-  "description": "Base (i.e., lower-level) complex number functions",
+  "version": "0.2.0",
+  "description": "Base (i.e., lower-level) complex number functions.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
@@ -36,25 +36,48 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/complex-base-cast-return": "^0.0.x",
-    "@stdlib/complex-base-wrap-function": "^0.0.x",
-    "@stdlib/utils-define-read-only-property": "^0.0.x"
+    "@stdlib/complex-base-assert": "^0.2.0",
+    "@stdlib/complex-base-cast-return": "^0.2.0",
+    "@stdlib/complex-base-wrap-function": "^0.2.0",
+    "@stdlib/utils-define-read-only-property": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/complex-float32": "^0.0.x",
-    "@stdlib/complex-imagf": "^0.0.x",
-    "@stdlib/complex-realf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nanf": "^0.0.x",
-    "@stdlib/math-base-ops-addf": "^0.0.x",
-    "@stdlib/math-base-ops-caddf": "^0.0.x",
-    "@stdlib/string-format": "^0.0.x",
-    "@stdlib/utils-keys": "^0.0.x",
+    "@stdlib/assert-is-boolean": "^0.1.1",
+    "@stdlib/assert-is-function": "^0.1.1",
+    "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
+    "@stdlib/complex-base-assert-is-equal": "^0.2.0",
+    "@stdlib/complex-base-assert-is-equalf": "^0.2.0",
+    "@stdlib/complex-base-assert-is-not-equal": "^0.2.0",
+    "@stdlib/complex-base-assert-is-not-equalf": "^0.2.0",
+    "@stdlib/complex-base-assert-is-same-value": "^0.2.0",
+    "@stdlib/complex-base-assert-is-same-value-zero": "^0.3.0",
+    "@stdlib/complex-base-assert-is-same-value-zerof": "^0.2.0",
+    "@stdlib/complex-base-assert-is-same-valuef": "^0.1.0",
+    "@stdlib/complex-float32": "^0.1.1",
+    "@stdlib/complex-float64": "^0.1.1",
+    "@stdlib/complex-imagf": "^0.1.1",
+    "@stdlib/complex-realf": "^0.1.1",
+    "@stdlib/complex-reim": "^0.2.0",
+    "@stdlib/complex-reimf": "^0.2.0",
+    "@stdlib/constants-float32-ninf": "^0.1.1",
+    "@stdlib/constants-float32-pinf": "^0.1.1",
+    "@stdlib/constants-float64-ninf": "^0.1.1",
+    "@stdlib/constants-float64-pinf": "^0.1.1",
+    "@stdlib/math-base-assert-is-nanf": "^0.1.1",
+    "@stdlib/math-base-ops-addf": "^0.1.0",
+    "@stdlib/math-base-ops-caddf": "^0.1.0",
+    "@stdlib/number-float32-base-assert-is-same-value": "^0.2.0",
+    "@stdlib/number-float32-base-assert-is-same-value-zero": "^0.2.0",
+    "@stdlib/number-float64-base-assert-is-same-value": "^0.2.0",
+    "@stdlib/number-float64-base-assert-is-same-value-zero": "^0.2.0",
+    "@stdlib/random-base-randu": "^0.1.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/utils-keys": "^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"
+    "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",
@@ -83,7 +106,7 @@
     "base"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/types/test.ts

@@ -1,29 +0,0 @@
-/*
-* @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.
-*/
-
-/* tslint:disable:no-unused-expression */
-
-import ns = require( './index' );
-
-
-// TESTS //
-
-// The exported value is the expected interface...
-{
-	ns; // $ExpectType Namespace
-}