@stdlib/array-base-ternary3d 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

@@ -64,12 +64,9 @@ var ternary3d = require( '@stdlib/array-base-ternary3d' );
 Applies a ternary callback to elements in three three-dimensional nested input arrays and assigns results to elements in a three-dimensional nested output array.
 
 ```javascript
+var add = require( '@stdlib/math-base-ops-add3' );
 var zeros3d = require( '@stdlib/array-base-zeros3d' );
 
-function add( x, y, z ) {
-    return x + y + z;
-}
-
 var x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ];
 var out = zeros3d( [ 1, 2, 2 ] );
 
@@ -108,13 +105,10 @@ The function accepts the following arguments:
 ```javascript
 var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
 var filled3dBy = require( '@stdlib/array-base-filled3d-by' );
+var add = require( '@stdlib/math-base-ops-add3' );
 var zeros3d = require( '@stdlib/array-base-zeros3d' );
 var ternary3d = require( '@stdlib/array-base-ternary3d' );
 
-function add( x, y, z ) {
-    return x + y + z;
-}
-
 var shape = [ 3, 3, 3 ];
 
 var x = filled3dBy( shape, discreteUniform( -100, 100 ) );
@@ -171,7 +165,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 +178,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-ternary3d.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-base-ternary3d
 
-[test-image]: https://github.com/stdlib-js/array-base-ternary3d/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/array-base-ternary3d/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/array-base-ternary3d/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/array-base-ternary3d/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-ternary3d/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-base-ternary3d?branch=main
@@ -208,8 +202,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-ternary3d/tree/deno
+[deno-readme]: https://github.com/stdlib-js/array-base-ternary3d/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/array-base-ternary3d/tree/umd
+[umd-readme]: https://github.com/stdlib-js/array-base-ternary3d/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/array-base-ternary3d/tree/esm
+[esm-readme]: https://github.com/stdlib-js/array-base-ternary3d/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/array-base-ternary3d/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-ternary3d/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/dist/index.js.map

@@ -1,7 +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// MAIN //\n\n/**\n* Applies a ternary callback to elements in three three-dimensional nested input arrays and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* -   The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing three input nested arrays and one output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Callback} fcn - ternary callback\n* @returns {void}\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function add( x, y, z ) {\n*     return x + y + z;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = ones3d( shape );\n* var z = ones3d( shape );\n* var out = zeros3d( shape );\n*\n* ternary3d( [ x, y, z, out ], shape, add );\n*\n* console.log( out );\n* // => [ [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ] ]\n*/\nfunction ternary3d( arrays, shape, fcn ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar z0;\n\tvar w0;\n\tvar x1;\n\tvar y1;\n\tvar z1;\n\tvar w1;\n\tvar x;\n\tvar y;\n\tvar z;\n\tvar w;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn;\n\t}\n\tx = arrays[ 0 ];\n\ty = arrays[ 1 ];\n\tz = arrays[ 2 ];\n\tw = arrays[ 3 ];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tz1 = z[ i2 ];\n\t\tw1 = w[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tz0 = z1[ i1 ];\n\t\t\tw0 = w1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\tw0[ i0 ] = fcn( x0[ i0 ], y0[ i0 ], z0[ i0 ] );\n\t\t\t}\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = ternary3d;\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* Apply a ternary callback to elements in three three-dimensional nested input arrays and assign results to elements in a three-dimensional nested output array.\n*\n* @module @stdlib/array-base-ternary3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var ternary3d = require( '@stdlib/array-base-ternary3d' );\n*\n* function add( x, y, z ) {\n*     return x + y + z;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = ones3d( shape );\n* var z = ones3d( shape );\n* var out = zeros3d( shape );\n*\n* ternary3d( [ x, y, z, out ], shape, add );\n*\n* console.log( out );\n* // => [ [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ] ]\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,cAsDA,SAASC,EAAWC,EAAQC,EAAOC,EAAM,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAjB,EAAKF,EAAO,CAAE,EACdG,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACT,EAAAE,GAAM,GAAKC,GAAM,GAAKC,GAAM,GAOjC,IAJAY,EAAIjB,EAAQ,CAAE,EACdkB,EAAIlB,EAAQ,CAAE,EACdmB,EAAInB,EAAQ,CAAE,EACdoB,EAAIpB,EAAQ,CAAE,EACRQ,EAAK,EAAGA,EAAKH,EAAIG,IAKtB,IAJAK,EAAKI,EAAGT,CAAG,EACXM,EAAKI,EAAGV,CAAG,EACXO,EAAKI,EAAGX,CAAG,EACXQ,EAAKI,EAAGZ,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAKtB,IAJAE,EAAKI,EAAIN,CAAG,EACZG,EAAKI,EAAIP,CAAG,EACZI,EAAKI,EAAIR,CAAG,EACZK,EAAKI,EAAIT,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBM,EAAIN,CAAG,EAAIJ,EAAKO,EAAIH,CAAG,EAAGI,EAAIJ,CAAG,EAAGK,EAAIL,CAAG,CAAE,CAIjD,CAKAR,EAAO,QAAUC,ICvDjB,IAAIsB,EAAO,IAKX,OAAO,QAAUA",
+  "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// MAIN //\n\n/**\n* Applies a ternary callback to elements in three three-dimensional nested input arrays and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* -   The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject<Array<Array<Collection>>>} arrays - array-like object containing three input nested arrays and one output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Callback} fcn - ternary callback\n* @returns {void}\n*\n* @example\n* var add = require( '@stdlib/math-base-ops-add3' );\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = ones3d( shape );\n* var z = ones3d( shape );\n* var out = zeros3d( shape );\n*\n* ternary3d( [ x, y, z, out ], shape, add );\n*\n* console.log( out );\n* // => [ [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ] ]\n*/\nfunction ternary3d( arrays, shape, fcn ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar z0;\n\tvar w0;\n\tvar x1;\n\tvar y1;\n\tvar z1;\n\tvar w1;\n\tvar x;\n\tvar y;\n\tvar z;\n\tvar w;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn;\n\t}\n\tx = arrays[ 0 ];\n\ty = arrays[ 1 ];\n\tz = arrays[ 2 ];\n\tw = arrays[ 3 ];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tz1 = z[ i2 ];\n\t\tw1 = w[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tz0 = z1[ i1 ];\n\t\t\tw0 = w1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\tw0[ i0 ] = fcn( x0[ i0 ], y0[ i0 ], z0[ i0 ] );\n\t\t\t}\n\t\t}\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = ternary3d;\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* Apply a ternary callback to elements in three three-dimensional nested input arrays and assign results to elements in a three-dimensional nested output array.\n*\n* @module @stdlib/array-base-ternary3d\n*\n* @example\n* var add = require( '@stdlib/math-base-ops-add3' );\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var ternary3d = require( '@stdlib/array-base-ternary3d' );\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = ones3d( shape );\n* var z = ones3d( shape );\n* var out = zeros3d( shape );\n*\n* ternary3d( [ x, y, z, out ], shape, add );\n*\n* console.log( out );\n* // => [ [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ] ]\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,cAmDA,SAASC,EAAWC,EAAQC,EAAOC,EAAM,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAjB,EAAKF,EAAO,CAAE,EACdG,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACT,EAAAE,GAAM,GAAKC,GAAM,GAAKC,GAAM,GAOjC,IAJAY,EAAIjB,EAAQ,CAAE,EACdkB,EAAIlB,EAAQ,CAAE,EACdmB,EAAInB,EAAQ,CAAE,EACdoB,EAAIpB,EAAQ,CAAE,EACRQ,EAAK,EAAGA,EAAKH,EAAIG,IAKtB,IAJAK,EAAKI,EAAGT,CAAG,EACXM,EAAKI,EAAGV,CAAG,EACXO,EAAKI,EAAGX,CAAG,EACXQ,EAAKI,EAAGZ,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAKtB,IAJAE,EAAKI,EAAIN,CAAG,EACZG,EAAKI,EAAIP,CAAG,EACZI,EAAKI,EAAIR,CAAG,EACZK,EAAKI,EAAIT,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBM,EAAIN,CAAG,EAAIJ,EAAKO,EAAIH,CAAG,EAAGI,EAAIJ,CAAG,EAAGK,EAAIL,CAAG,CAAE,CAIjD,CAKAR,EAAO,QAAUC,ICvDjB,IAAIsB,EAAO,IAKX,OAAO,QAAUA",
   "names": ["require_main", "__commonJSMin", "exports", "module", "ternary3d", "arrays", "shape", "fcn", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "z0", "w0", "x1", "y1", "z1", "w1", "x", "y", "z", "w", "main"]
 }

package/docs/types/index.d.ts

@@ -26,7 +26,9 @@ import { Shape3D } from '@stdlib/types/ndarray';
 /**
 * Ternary callback.
 *
-* @param value - input value
+* @param v1 - element from first input array
+* @param v2 - element from second input array
+* @param v3 - element from third input array
 * @returns result
 */
 type Ternary<T, U, V, W> = ( v1: T, v2: U, v3: V ) => W;
@@ -43,12 +45,9 @@ type Ternary<T, U, V, W> = ( v1: T, v2: U, v3: V ) => W;
 * @param fcn - ternary callback
 *
 * @example
-* var ones3d = require( `@stdlib/array/base/ones3d` );
-* var zeros3d = require( `@stdlib/array/base/zeros3d` );
-*
-* function add( x, y, z ) {
-*     return x + y + z;
-* }
+* var add = require( '@stdlib/math-base-ops-add3' );
+* var ones3d = require( '@stdlib/array-base-ones3d' );
+* var zeros3d = require( '@stdlib/array-base-zeros3d' );
 *
 * var shape = [ 1, 2, 2 ];
 *

package/lib/index.js

@@ -24,14 +24,11 @@
 * @module @stdlib/array-base-ternary3d
 *
 * @example
+* var add = require( '@stdlib/math-base-ops-add3' );
 * var ones3d = require( '@stdlib/array-base-ones3d' );
 * var zeros3d = require( '@stdlib/array-base-zeros3d' );
 * var ternary3d = require( '@stdlib/array-base-ternary3d' );
 *
-* function add( x, y, z ) {
-*     return x + y + z;
-* }
-*
 * var shape = [ 1, 2, 2 ];
 *
 * var x = ones3d( shape );

package/lib/main.js

@@ -27,19 +27,16 @@
 *
 * -   The function assumes that the input and output arrays have the same shape.
 *
-* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing three input nested arrays and one output nested array
+* @param {ArrayLikeObject<Array<Array<Collection>>>} arrays - array-like object containing three input nested arrays and one output nested array
 * @param {NonNegativeIntegerArray} shape - array shape
 * @param {Callback} fcn - ternary callback
 * @returns {void}
 *
 * @example
+* var add = require( '@stdlib/math-base-ops-add3' );
 * var ones3d = require( '@stdlib/array-base-ones3d' );
 * var zeros3d = require( '@stdlib/array-base-zeros3d' );
 *
-* function add( x, y, z ) {
-*     return x + y + z;
-* }
-*
 * var shape = [ 1, 2, 2 ];
 *
 * var x = ones3d( shape );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-base-ternary3d",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Apply a ternary callback to elements in three three-dimensional nested input arrays and assign results to elements in a three-dimensional nested output array.",
   "license": "Apache-2.0",
   "author": {
@@ -37,13 +37,13 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/types": "^0.1.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.1",
+    "@stdlib/math-base-ops-add3": "^0.1.0",
     "@stdlib/math-base-special-floor": "^0.1.1",
     "@stdlib/math-base-special-pow": "^0.1.0",
     "@stdlib/ndarray-base-numel": "^0.1.1",
@@ -51,7 +51,9 @@
     "@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