From 36941bce04a3102ebe38a9338309b994dae4859e Mon Sep 17 00:00:00 2001 From: headlessNode Date: Fri, 7 Aug 2026 18:51:02 +0500 Subject: [PATCH] feat: add blas/ext/base/ndarray/dfirst-index-greater-than --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../dfirst-index-greater-than/README.md | 128 ++++++++++++ .../benchmark/benchmark.js | 105 ++++++++++ .../dfirst-index-greater-than/docs/repl.txt | 34 +++ .../docs/types/index.d.ts | 54 +++++ .../docs/types/test.ts | 63 ++++++ .../examples/index.js | 35 ++++ .../dfirst-index-greater-than/lib/index.js | 44 ++++ .../dfirst-index-greater-than/lib/main.js | 65 ++++++ .../dfirst-index-greater-than/package.json | 71 +++++++ .../dfirst-index-greater-than/test/test.js | 194 ++++++++++++++++++ 10 files changed, 793 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/README.md new file mode 100644 index 000000000000..ef391116b70e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/README.md @@ -0,0 +1,128 @@ + + +# dfirstIndexGreaterThan + +> Return the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dfirstIndexGreaterThan = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than' ); +``` + +#### dfirstIndexGreaterThan( arrays ) + +Returns the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray. + +```javascript +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + +var x = new Float64Vector( [ 0.0, 0.0, 1.0, 0.0 ] ); +var y = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] ); + +var idx = dfirstIndexGreaterThan( [ x, y ] ); +// returns 2 +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - first one-dimensional input ndarray. + - second one-dimensional input ndarray. + +If the function is unable to find an element in the first one-dimensional input ndarray which is greater than a corresponding element in the second one-dimensional input ndarray, the function returns `-1`. + +```javascript +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + +var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); +var y = new Float64Vector( [ 5.0, 6.0, 7.0, 8.0 ] ); + +var idx = dfirstIndexGreaterThan( [ x, y ] ); +// returns -1 +``` + +
+ + + +
+ +## Notes + +- When comparing elements, the function checks whether an element in the first one-dimensional input ndarray is greater than a corresponding element in the second one-dimensional input ndarray using the greater-than operator `>`. As a consequence, comparisons involving `NaN` always evaluate to `false`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dfirstIndexGreaterThan = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( [ 10 ], 0, 10, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], 0, 10, opts ); +console.log( ndarray2array( y ) ); + +var idx = dfirstIndexGreaterThan( [ x, y ] ); +console.log( idx ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/benchmark/benchmark.js new file mode 100644 index 000000000000..f237ced4ed17 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/benchmark/benchmark.js @@ -0,0 +1,105 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive; +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +var ones = require( '@stdlib/array/ones' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dfirstIndexGreaterThan = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = new Float64Vector( ones( len, options.dtype ) ); + var y = new Float64Vector( ones( len, options.dtype ) ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = dfirstIndexGreaterThan( [ x, y ] ); + if ( out !== out ) { + b.fail( 'should return an integer' ); + } + } + b.toc(); + if ( !isInteger( out ) ) { + b.fail( 'should return an integer' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/repl.txt new file mode 100644 index 000000000000..c459126939ba --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/repl.txt @@ -0,0 +1,34 @@ + +{{alias}}( arrays ) + Returns the index of the first element in a one-dimensional double- + precision floating-point ndarray which is greater than a corresponding + element in another one-dimensional double-precision floating-point ndarray. + + When comparing elements, the function checks whether an element in the + first one-dimensional input ndarray is greater than a corresponding element + in the second one-dimensional input ndarray using the greater-than operator + `>`. As a consequence, comparisons involving `NaN` always evaluate to + `false`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - first one-dimensional input ndarray. + - second one-dimensional input ndarray. + + Returns + ------- + out: integer + Index. + + Examples + -------- + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 0.0, 0.0, 1.0, 0.0 ] ); + > var y = new {{alias:@stdlib/ndarray/vector/float64}}( [ 0.0, 0.0, 0.0, 0.0 ] ); + > {{alias}}( [ x, y ] ) + 2 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/index.d.ts new file mode 100644 index 000000000000..a37ca647a95b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/index.d.ts @@ -0,0 +1,54 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Returns the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - first one-dimensional input ndarray. +* - second one-dimensional input ndarray. +* +* - When comparing elements, the function checks whether an element in the first one-dimensional input ndarray is greater than a corresponding element in the second one-dimensional input ndarray using the greater-than operator `>`. As a consequence, comparisons involving `NaN` always evaluate to `false`. +* +* @param arrays - array-like object containing ndarrays +* @returns index +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* +* var x = new Float64Vector( [ 0.0, 0.0, 1.0, 0.0 ] ); +* var y = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] ); +* +* var idx = dfirstIndexGreaterThan( [ x, y ] ); +* // returns 2 +*/ +declare function dfirstIndexGreaterThan( arrays: [ float64ndarray, float64ndarray ] ): number; + + +// EXPORTS // + +export = dfirstIndexGreaterThan; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/test.ts new file mode 100644 index 000000000000..a6eddf68defc --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import dfirstIndexGreaterThan = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const y = zeros( [ 10 ], { + 'dtype': 'float64' + }); + + dfirstIndexGreaterThan( [ x, y ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dfirstIndexGreaterThan( '10' ); // $ExpectError + dfirstIndexGreaterThan( 10 ); // $ExpectError + dfirstIndexGreaterThan( true ); // $ExpectError + dfirstIndexGreaterThan( false ); // $ExpectError + dfirstIndexGreaterThan( null ); // $ExpectError + dfirstIndexGreaterThan( undefined ); // $ExpectError + dfirstIndexGreaterThan( [] ); // $ExpectError + dfirstIndexGreaterThan( {} ); // $ExpectError + dfirstIndexGreaterThan( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const y = zeros( [ 10 ], { + 'dtype': 'float64' + }); + + dfirstIndexGreaterThan(); // $ExpectError + dfirstIndexGreaterThan( [ x, y ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/examples/index.js new file mode 100644 index 000000000000..da51da1754a7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/examples/index.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dfirstIndexGreaterThan = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( [ 10 ], 0, 10, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], 0, 10, opts ); +console.log( ndarray2array( y ) ); + +var idx = dfirstIndexGreaterThan( [ x, y ] ); +console.log( idx ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/index.js new file mode 100644 index 000000000000..cfec6358c417 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/index.js @@ -0,0 +1,44 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +'use strict'; + +/** +* Return the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray. +* +* @module @stdlib/blas/ext/base/ndarray/dfirst-index-greater-than +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var dfirstIndexGreaterThan = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than' ); +* +* var x = new Float64Vector( [ 0.0, 0.0, 1.0, 0.0 ] ); +* var y = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] ); +* +* var idx = dfirstIndexGreaterThan( [ x, y ] ); +* // returns 2 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/main.js new file mode 100644 index 000000000000..bebe9fd9efa8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/lib/main.js @@ -0,0 +1,65 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +'use strict'; + +// MODULES // + +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/ext/base/dfirst-index-greater-than' ).ndarray; + + +// MAIN // + +/** +* Returns the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - first one-dimensional input ndarray. +* - second one-dimensional input ndarray. +* +* - When comparing elements, the function checks whether an element in the first one-dimensional input ndarray is greater than a corresponding element in the second one-dimensional input ndarray using the greater-than operator `>`. As a consequence, comparisons involving `NaN` always evaluate to `false`. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {integer} index +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* +* var x = new Float64Vector( [ 0.0, 0.0, 1.0, 0.0 ] ); +* var y = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] ); +* +* var idx = dfirstIndexGreaterThan( [ x, y ] ); +* // returns 2 +*/ +function dfirstIndexGreaterThan( arrays ) { + var x = arrays[ 0 ]; + var y = arrays[ 1 ]; + return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = dfirstIndexGreaterThan; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/package.json new file mode 100644 index 000000000000..9b6c4f1fab17 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/package.json @@ -0,0 +1,71 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than", + "version": "0.0.0", + "description": "Return the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "extended", + "array", + "index", + "search", + "find", + "greater", + "compare", + "ndarray", + "double", + "float", + "float64", + "float64array" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/test/test.js new file mode 100644 index 000000000000..e6157acef06a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than/test/test.js @@ -0,0 +1,194 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dfirstIndexGreaterThan = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Float64Array} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'float64', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dfirstIndexGreaterThan, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the index of the first element in a one-dimensional ndarray which is greater than a corresponding element in another one-dimensional ndarray', function test( t ) { + var actual; + var x; + var y; + + x = vector( new Float64Array( [ 2.0, 2.0, 2.0, 3.0, 4.0, 5.0 ] ), 6, 1, 0 ); + y = vector( new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), 6, 1, 0 ); + + actual = dfirstIndexGreaterThan( [ x, y ] ); + t.strictEqual( actual, 0, 'returns expected value' ); + + x = vector( new Float64Array( [ 1.0, 2.0, 2.0, 3.0, 4.0, 5.0 ] ), 6, 1, 0 ); + y = vector( new Float64Array( [ 2.0, 1.0, 3.0, 4.0, 5.0, 6.0 ] ), 6, 1, 0 ); + + actual = dfirstIndexGreaterThan( [ x, y ] ); + t.strictEqual( actual, 1, 'returns expected value' ); + + x = vector( new Float64Array( [ 1.0, 2.0, 3.0, 5.0, 4.0, 5.0 ] ), 6, 1, 0 ); + y = vector( new Float64Array( [ 2.0, 2.0, 2.0, 4.0, 5.0, 6.0 ] ), 6, 1, 0 ); + + actual = dfirstIndexGreaterThan( [ x, y ] ); + t.strictEqual( actual, 2, 'returns expected value' ); + + x = vector( new Float64Array( [ 1.0, 2.0, 2.0, 3.0, 4.0, 5.0 ] ), 6, 1, 0 ); + y = vector( new Float64Array( [ 2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), 6, 1, 0 ); + + actual = dfirstIndexGreaterThan( [ x, y ] ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if unable to find an element in the first one-dimensional input ndarray which is greater than a corresponding element in the second one-dimensional input ndarray', function test( t ) { + var actual; + var x; + var y; + + x = vector( new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), 6, 1, 0 ); + y = vector( new Float64Array( [ 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ), 6, 1, 0 ); + + actual = dfirstIndexGreaterThan( [ x, y ] ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var actual; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 1.0, // 1 + -4.0, + 4.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + y = new Float64Array([ + 2.0, // 0 + 2.0, + 2.0, // 1 + -4.0, + 3.0, // 2 + 3.0, + 5.0, // 3 + 2.0 + ]); + + actual = dfirstIndexGreaterThan( [ vector( x, 4, 2, 0 ), vector( y, 4, 2, 0 ) ] ); + + t.strictEqual( actual, 2, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var actual; + var x; + var y; + + x = new Float64Array([ + 4.0, // 3 + 2.0, + 3.0, // 2 + -2.0, + 4.0, // 1 + 4.0, + 4.0, // 0 + 2.0 + ]); + y = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -2.0, + 3.0, // 1 + 4.0, + 5.0, // 0 + 2.0 + ]); + + actual = dfirstIndexGreaterThan( [ vector( x, 4, -2, 6 ), vector( y, 4, -2, 6 ) ] ); + + t.strictEqual( actual, 1, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var actual; + var x; + var y; + + x = new Float64Array([ + 2.0, + 2.0, // 0 + 2.0, + 3.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 5.0 // 3 + ]); + y = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + 2.0, // 1 + -2.0, + 3.0, // 2 + 3.0, + 4.0 // 3 + ]); + + actual = dfirstIndexGreaterThan( [ vector( x, 4, 2, 1 ), vector( y, 4, 2, 1 ) ] ); + t.strictEqual( actual, 0, 'returns expected value' ); + + t.end(); +});