@stdlib/array-base-broadcasted-binary3d 0.1.0 → 0.2.0

package/NOTICE

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

package/README.md

@@ -171,7 +171,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -184,8 +184,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-broadcasted-binary3d.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-base-broadcasted-binary3d
 
-[test-image]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-broadcasted-binary3d/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-base-broadcasted-binary3d?branch=main
@@ -208,8 +208,11 @@ 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-base-broadcasted-binary3d/tree/deno
+[deno-readme]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/tree/umd
+[umd-readme]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/tree/esm
+[esm-readme]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/array-base-broadcasted-binary3d/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-broadcasted-binary3d/main/LICENSE

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/docs/types/index.d.ts

@@ -26,7 +26,8 @@ import { Shape1D, Shape2D, Shape3D } from '@stdlib/types/ndarray';
 /**
 * Binary callback.
 *
-* @param value - input value
+* @param v1 - element from first input array
+* @param v2 - element from second input array
 * @returns result
 */
 type Binary<T, U, V> = ( v1: T, v2: U ) => V;
@@ -51,6 +52,24 @@ type OutputArray<T> = Array3D<T>;
 */
 type OutputArrayShape = Shape3D;
 
+/**
+* Input and output arrays.
+*/
+type InOutArrays<T, U, V> = [
+	InputArray<T>,
+	InputArray<U>,
+	OutputArray<V>
+];
+
+/**
+* Input and output array shapes.
+*/
+type InOutShapes = [
+	InputArrayShape,
+	InputArrayShape,
+	OutputArrayShape
+];
+
 /**
 * Applies a binary callback to elements in two broadcasted input arrays and assigns results to elements in a three-dimensional nested output array.
 *
@@ -63,9 +82,9 @@ type OutputArrayShape = Shape3D;
 * @param fcn - binary callback
 *
 * @example
-* var ones3d = require( `@stdlib/array/base/ones3d` );
-* var zeros3d = require( `@stdlib/array/base/zeros3d` );
-* var add = require( `@stdlib/math/base/ops/add` );
+* var ones3d = require( '@stdlib/array-base-ones3d' );
+* var zeros3d = require( '@stdlib/array-base-zeros3d' );
+* var add = require( '@stdlib/math-base-ops-add' );
 *
 * var shapes = [
 *     [ 1, 1, 2 ],
@@ -82,7 +101,7 @@ type OutputArrayShape = Shape3D;
 * console.log( z );
 * // => [ [ [ 2.0, 2.0 ], [ 2.0, 2.0 ] ],  [ [ 2.0, 2.0 ], [ 2.0, 2.0 ] ] ]
 */
-declare function bbinary3d<T = unknown, U = unknown, V = unknown>( arrays: [ InputArray<T>, InputArray<U>, OutputArray<V> ], shapes: [ InputArrayShape, InputArrayShape, OutputArrayShape ], fcn: Binary<T, U, V> ): void;
+declare function bbinary3d<T = unknown, U = unknown, V = unknown>( arrays: InOutArrays<T, U, V>, shapes: InOutShapes, fcn: Binary<T, U, V> ): void;
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-base-broadcasted-binary3d",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Apply a binary callback to elements in two broadcasted input arrays and assign results to elements in a three-dimensional nested output array.",
   "license": "Apache-2.0",
   "author": {
@@ -37,23 +37,24 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/array-base-broadcast-array": "^0.1.0",
-    "@stdlib/types": "^0.1.0"
+    "@stdlib/array-base-broadcast-array": "^0.2.0",
+    "@stdlib/types": "^0.3.1"
   },
   "devDependencies": {
-    "@stdlib/array-base-filled3d-by": "^0.1.0",
-    "@stdlib/array-base-zeros3d": "^0.1.0",
-    "@stdlib/bench": "^0.1.0",
-    "@stdlib/math-base-assert-is-nan": "^0.1.0",
-    "@stdlib/math-base-ops-add": "^0.1.0",
-    "@stdlib/math-base-special-floor": "^0.1.0",
-    "@stdlib/math-base-special-pow": "^0.1.0",
-    "@stdlib/ndarray-base-numel": "^0.1.0",
-    "@stdlib/random-base-discrete-uniform": "^0.0.6",
-    "@stdlib/random-base-uniform": "^0.0.6",
+    "@stdlib/array-base-filled3d-by": "^0.2.0",
+    "@stdlib/array-base-zeros3d": "^0.2.0",
+    "@stdlib/math-base-assert-is-nan": "^0.2.0",
+    "@stdlib/math-base-ops-add": "^0.2.0",
+    "@stdlib/math-base-special-floor": "^0.2.0",
+    "@stdlib/math-base-special-pow": "^0.2.0",
+    "@stdlib/ndarray-base-numel": "^0.2.0",
+    "@stdlib/random-base-discrete-uniform": "^0.1.0",
+    "@stdlib/random-base-uniform": "^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",

package/CITATION.cff

@@ -1,30 +0,0 @@
-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