diff --git a/lib/node_modules/@stdlib/math/base/special/cround/README.md b/lib/node_modules/@stdlib/math/base/special/cround/README.md index 5c4dd96e77b9..4593bea24db9 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cround/README.md @@ -69,6 +69,55 @@ v = cround( new Complex128( NaN, NaN ) ); // returns [ NaN, NaN ] ``` +#### cround.assign( re, im, out, strideOut, offsetOut ) + +Rounds each component of a double-precision complex floating-point number to the nearest integer and assigns results to a provided output array. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var out = new Float64Array( 2 ); +var v = cround.assign( -1.5, 2.5, out, 1, 0 ); +// returns [ -1.0, 3.0 ] + +var bool = ( out === v ); +// returns true +``` + +The function supports the following parameters: + +- **re**: real component. +- **im**: imaginary component. +- **out**: output array. +- **strideOut**: stride length for `out`. +- **offsetOut**: starting index for `out`. + +#### cround.strided( z, sz, oz, out, so, oo ) + +Rounds each component of a double-precision complex floating-point number stored in a real-valued strided array view to the nearest integer and assigns results to a provided strided output array. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var z = new Float64Array( [ -1.5, 2.5 ] ); +var out = new Float64Array( 2 ); + +var v = cround.strided( z, 1, 0, out, 1, 0 ); +// returns [ -1.0, 3.0 ] + +var bool = ( out === v ); +// returns true +``` + +The function supports the following parameters: + +- **z**: complex number strided array view. +- **sz**: stride length for `z`. +- **oz**: starting index for `z`. +- **out**: output array. +- **so**: stride length for `out`. +- **oo**: starting index for `out`. + @@ -80,18 +129,16 @@ v = cround( new Complex128( NaN, NaN ) ); ```javascript -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var cround = require( '@stdlib/math/base/special/cround' ); -var rand = uniform( -50.0, 50.0 ); +// Create an array of random numbers: +var arr = new Complex128Array( uniform( 200, -50.0, 50.0 ) ); -var z; -var i; -for ( i = 0; i < 100; i++ ) { - z = new Complex128( rand(), rand() ); - console.log( 'cround(%s) = %s', z, cround( z ) ); -} +// Round each component of each complex number to the nearest integer: +logEachMap( 'cround(%s) = %s', arr, cround ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.assign.js b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.assign.js new file mode 100644 index 000000000000..0319c98c8dfb --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.assign.js @@ -0,0 +1,69 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var assign = require( './../lib' ).assign; + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// MAIN // + +bench( format( '%s:assign', pkg ), function benchmark( b ) { + var out; + var re; + var im; + var N; + var i; + var j; + + N = 100; + re = uniform( N, -500.0, 500.0, options ); + im = uniform( N, -500.0, 500.0, options ); + + out = new Float64Array( 2 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + j = i % N; + out = assign( re[ j ], im[ j ], out, 1, 0 ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.js index 25ac68d06f06..99e1d09cce0b 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.js @@ -21,37 +21,43 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var Complex128Array = require( '@stdlib/array/complex128' ); var real = require( '@stdlib/complex/float64/real' ); var imag = require( '@stdlib/complex/float64/imag' ); var pkg = require( './../package.json' ).name; var cround = require( './../lib' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // MAIN // bench( pkg, function benchmark( b ) { - var values; + var zbuf; + var z; var y; var i; - values = [ - new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), - new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) - ]; + zbuf = uniform( 200, -500.0, 500.0, options ); + z = new Complex128Array( zbuf.buffer ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = cround( values[ i%values.length ] ); + y = cround( z.get( i%100 ) ); if ( isnan( real( y ) ) ) { b.fail( 'should not return NaN' ); } } b.toc(); if ( isnan( imag( y ) ) ) { - b.fail( 'should not return not NaN' ); + b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); b.end(); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.native.js index 58088329ee6d..3c4158d2cc72 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.native.js @@ -22,10 +22,11 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var Complex128Array = require( '@stdlib/array/complex128' ); var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); var tryRequire = require( '@stdlib/utils/try-require' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; @@ -37,29 +38,31 @@ var cround = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { 'skip': ( cround instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // MAIN // bench( format( '%s::native', pkg ), opts, function benchmark( b ) { - var values; + var zbuf; + var z; var y; var i; - values = [ - new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), - new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) - ]; + zbuf = uniform( 200, -500.0, 500.0, options ); + z = new Complex128Array( zbuf.buffer ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = cround( values[ i%values.length ] ); + y = cround( z.get( i%100 ) ); if ( isnan( real( y ) ) ) { b.fail( 'should not return NaN' ); } } b.toc(); - if ( isnan( real( y ) ) ) { + if ( isnan( imag( y ) ) ) { b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.strided.js b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.strided.js new file mode 100644 index 000000000000..d04b1022d627 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/benchmark.strided.js @@ -0,0 +1,67 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var strided = require( './../lib' ).strided; + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// MAIN // + +bench( format( '%s:strided', pkg ), function benchmark( b ) { + var out; + var z; + var N; + var i; + var j; + + N = 50; + z = uniform( N*2, -500.0, 500.0, options ); + + out = new Float64Array( 2 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + j = ( i % N ) * 2; + out = strided( z, 1, j, out, 1, 0 ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( isnan( out[ 0 ] ) || isnan( out[ 1 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/c/benchmark.c index 2626de420205..d5bd6cf60d77 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/c/benchmark.c @@ -20,9 +20,10 @@ #include #include #include +#include #include -#define NAME "round" +#define NAME "cround" #define ITERATIONS 1000000 #define REPEATS 3 diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt index ed31621f112a..29858a2ab3f9 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt @@ -18,6 +18,77 @@ > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.5, 3.3 ) ) [ 6.0, 3.0 ] + +{{alias}}.assign( re, im, out, strideOut, offsetOut ) + Rounds each component of a double-precision complex floating-point number + to the nearest integer and assigns results to a provided output array. + + Parameters + ---------- + re: number + Real component. + + im: number + Imaginary component. + + out: ArrayLikeObject + Output array. + + strideOut: integer + Stride length. + + offsetOut: integer + Starting index. + + Returns + ------- + out: ArrayLikeObject + Output array. + + Examples + -------- + > var out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}.assign( -1.5, 2.5, out, 1, 0 ) + [ -1.0, 3.0 ] + + +{{alias}}.strided( z, sz, oz, out, so, oo ) + Rounds each component of a double-precision complex floating-point number + stored in a real-valued strided array view to the nearest integer and + assigns results to a provided strided output array. + + Parameters + ---------- + z: ArrayLikeObject + Complex number view. + + sz: integer + Stride length for `z`. + + oz: integer + Starting index for `z`. + + out: ArrayLikeObject + Output array. + + so: integer + Stride length for `out`. + + oo: integer + Starting index for `out`. + + Returns + ------- + out: ArrayLikeObject + Output array. + + Examples + -------- + > var z = new {{alias:@stdlib/array/float64}}( [ -1.5, 2.5 ] ); + > var out = new {{alias:@stdlib/array/float64}}( 2 ); + > {{alias}}.strided( z, 1, 0, out, 1, 0 ) + [ -1.0, 3.0 ] + See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts index 5aa41d145a06..20be33776f63 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts @@ -21,22 +21,101 @@ /// import { Complex128 } from '@stdlib/types/complex'; +import { Collection, NumericArray } from '@stdlib/types/array'; + +/** +* Interface for rounding each component of a double-precision complex floating-point number to the nearest integer. +*/ +interface Cround { + /** + * Rounds each component of a double-precision complex floating-point number to the nearest integer. + * + * @param z - complex number + * @returns result + * + * @example + * var Complex128 = require( '@stdlib/complex/float64/ctor' ); + * + * var v = cround( new Complex128( -1.5, 2.5 ) ); + * // returns [ -1.0, 3.0 ] + */ + ( z: Complex128 ): Complex128; + + /** + * Rounds each component of a double-precision complex floating-point number to the nearest integer and assigns results to a provided output array. + * + * @param re - real component + * @param im - imaginary component + * @param out - output array + * @param strideOut - stride length + * @param offsetOut - starting index + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var out = new Float64Array( 2 ); + * var v = cround.assign( -1.5, 2.5, out, 1, 0 ); + * // returns [ -1.0, 3.0 ] + * + * var bool = ( out === v ); + * // returns true + */ + assign>( re: number, im: number, out: T, strideOut: number, offsetOut: number ): T; + + /** + * Rounds each component of a double-precision complex floating-point number stored in a real-valued strided array view to the nearest integer and assigns results to a provided strided output array. + * + * @param z - complex number view + * @param strideZ - stride length for `z` + * @param offsetZ - starting index for `z` + * @param out - output array + * @param strideOut - stride length for `out` + * @param offsetOut - starting index for `out` + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var z = new Float64Array( [ -1.5, 2.5 ] ); + * + * var out = cround.strided( z, 1, 0, new Float64Array( 2 ), 1, 0 ); + * // returns [ -1.0, 3.0 ] + */ + strided, U extends NumericArray | Collection>( z: T, strideZ: number, offsetZ: number, out: U, strideOut: number, offsetOut: number ): U; +} /** * Rounds each component of a double-precision complex floating-point number to the nearest integer. * -* @param z - input value +* @param z - complex number * @returns result * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * -* var v = cround( new Complex128( -4.2, 5.5 ) ); -* // returns [ -4.0, 6.0 ] +* var v = cround( new Complex128( -1.5, 2.5 ) ); +* // returns [ -1.0, 3.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var out = new Float64Array( 2 ); +* var v = cround.assign( -1.5, 2.5, out, 1, 0 ); +* // returns [ -1.0, 3.0 ] +* +* var bool = ( out === v ); +* // returns true +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var z = new Float64Array( [ -1.5, 2.5 ] ); +* +* var out = cround.strided( z, 1, 0, new Float64Array( 2 ), 1, 0 ); +* // returns [ -1.0, 3.0 ] */ -declare function cround( z: Complex128 ): Complex128; +declare var cround: Cround; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/test.ts index a70d728d9a08..18d029ae6b2e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/test.ts @@ -22,13 +22,14 @@ import cround = require( './index' ); // TESTS // -// The function returns a double-precision complex floating-point number... +// The function returns a complex number... { cround( new Complex128( 1.0, 2.0 ) ); // $ExpectType Complex128 } -// The compiler throws an error if the function is provided a real component which is not a number... +// The compiler throws an error if the function is provided a value other than a complex number... { + cround( 2 ); // $ExpectError cround( true ); // $ExpectError cround( false ); // $ExpectError cround( null ); // $ExpectError @@ -43,3 +44,203 @@ import cround = require( './index' ); { cround(); // $ExpectError } + +// Attached to the main export is an `assign` method which returns a collection... +{ + cround.assign( 1.0, 1.0, new Float64Array( 2 ), 1, 0 ); // $ExpectType Float64Array + cround.assign( 1.0, 1.0, new Float32Array( 2 ), 1, 0 ); // $ExpectType Float32Array + cround.assign( 1.0, 1.0, [ 0.0, 0.0 ], 1, 0 ); // $ExpectType number[] +} + +// The compiler throws an error if the `assign` method is provided a first argument which is not a number... +{ + const out = new Float64Array( 2 ); + + cround.assign( true, 2.0, out, 1, 0 ); // $ExpectError + cround.assign( false, 2.0, out, 1, 0 ); // $ExpectError + cround.assign( null, 2.0, out, 1, 0 ); // $ExpectError + cround.assign( undefined, 2.0, out, 1, 0 ); // $ExpectError + cround.assign( '5', 2.0, out, 1, 0 ); // $ExpectError + cround.assign( [], 2.0, out, 1, 0 ); // $ExpectError + cround.assign( {}, 2.0, out, 1, 0 ); // $ExpectError + cround.assign( ( x: number ): number => x, 2.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a second argument which is not a number... +{ + const out = new Float64Array( 2 ); + + cround.assign( 1.0, true, out, 1, 0 ); // $ExpectError + cround.assign( 1.0, false, out, 1, 0 ); // $ExpectError + cround.assign( 1.0, null, out, 1, 0 ); // $ExpectError + cround.assign( 1.0, undefined, out, 1, 0 ); // $ExpectError + cround.assign( 1.0, '5', out, 1, 0 ); // $ExpectError + cround.assign( 1.0, [], out, 1, 0 ); // $ExpectError + cround.assign( 1.0, {}, out, 1, 0 ); // $ExpectError + cround.assign( 1.0, ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a third argument which is not a collection... +{ + cround.assign( 1.0, 2.0, 1, 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, true, 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, false, 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, null, 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, undefined, 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, '5', 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, [ '5' ], 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, {}, 1, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a fourth argument which is not a number... +{ + const out = new Float64Array( 2 ); + + cround.assign( 1.0, 2.0, out, true, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, false, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, null, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, undefined, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, '5', 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, [], 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, {}, 0 ); // $ExpectError + cround.assign( 1.0, 2.0, out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... +{ + const out = new Float64Array( 2 ); + + cround.assign( 1.0, 2.0, out, 1, true ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, false ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, null ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, undefined ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, '5' ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, [] ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, {} ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... +{ + const out = new Float64Array( 2 ); + + cround.assign(); // $ExpectError + cround.assign( 1.0 ); // $ExpectError + cround.assign( 1.0, 2.0 ); // $ExpectError + cround.assign( 1.0, 2.0, out ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1 ); // $ExpectError + cround.assign( 1.0, 2.0, out, 1, 0, {} ); // $ExpectError +} + +// Attached to the main export is a `strided` method which returns a collection... +{ + const z = new Float64Array( 2 ); + + cround.strided( z, 1, 0, new Float64Array( 2 ), 1, 0 ); // $ExpectType Float64Array + cround.strided( z, 1, 0, new Float32Array( 2 ), 1, 0 ); // $ExpectType Float32Array + cround.strided( z, 1, 0, [ 0.0, 0.0 ], 1, 0 ); // $ExpectType number[] +} + +// The compiler throws an error if the `strided` method is provided a first argument which is not a collection... +{ + const out = new Float64Array( 2 ); + + cround.strided( true, 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( false, 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( null, 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( undefined, 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( '5', 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( [ '5' ], 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( {}, 1, 0, out, 1, 0 ); // $ExpectError + cround.strided( ( x: number ): number => x, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a second argument which is not a number... +{ + const z = new Float64Array( 2 ); + const out = new Float64Array( 2 ); + + cround.strided( z, true, 0, out, 1, 0 ); // $ExpectError + cround.strided( z, false, 0, out, 1, 0 ); // $ExpectError + cround.strided( z, null, 0, out, 1, 0 ); // $ExpectError + cround.strided( z, undefined, 0, out, 1, 0 ); // $ExpectError + cround.strided( z, '5', 0, out, 1, 0 ); // $ExpectError + cround.strided( z, [], 0, out, 1, 0 ); // $ExpectError + cround.strided( z, {}, 0, out, 1, 0 ); // $ExpectError + cround.strided( z, ( x: number ): number => x, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a third argument which is not a number... +{ + const z = new Float64Array( 2 ); + const out = new Float64Array( 2 ); + + cround.strided( z, 1, true, out, 1, 0 ); // $ExpectError + cround.strided( z, 1, false, out, 1, 0 ); // $ExpectError + cround.strided( z, 1, null, out, 1, 0 ); // $ExpectError + cround.strided( z, 1, undefined, out, 1, 0 ); // $ExpectError + cround.strided( z, 1, '5', out, 1, 0 ); // $ExpectError + cround.strided( z, 1, [], out, 1, 0 ); // $ExpectError + cround.strided( z, 1, {}, out, 1, 0 ); // $ExpectError + cround.strided( z, 1, ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a fourth argument which is not a collection... +{ + const z = new Float64Array( 2 ); + + cround.strided( z, 1, 0, 1, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, true, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, false, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, null, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, undefined, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, '5', 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, [ '5' ], 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, {}, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a fifth argument which is not a number... +{ + const z = new Float64Array( 2 ); + const out = new Float64Array( 2 ); + + cround.strided( z, 1, 0, out, true, 0 ); // $ExpectError + cround.strided( z, 1, 0, out, false, 0 ); // $ExpectError + cround.strided( z, 1, 0, out, null, 0 ); // $ExpectError + cround.strided( z, 1, 0, out, undefined, 0 ); // $ExpectError + cround.strided( z, 1, 0, out, '5', 0 ); // $ExpectError + cround.strided( z, 1, 0, out, [], 0 ); // $ExpectError + cround.strided( z, 1, 0, out, {}, 0 ); // $ExpectError + cround.strided( z, 1, 0, out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a sixth argument which is not a number... +{ + const z = new Float64Array( 2 ); + const out = new Float64Array( 2 ); + + cround.strided( z, 1, 0, out, 1, true ); // $ExpectError + cround.strided( z, 1, 0, out, 1, false ); // $ExpectError + cround.strided( z, 1, 0, out, 1, null ); // $ExpectError + cround.strided( z, 1, 0, out, 1, undefined ); // $ExpectError + cround.strided( z, 1, 0, out, 1, '5' ); // $ExpectError + cround.strided( z, 1, 0, out, 1, [] ); // $ExpectError + cround.strided( z, 1, 0, out, 1, {} ); // $ExpectError + cround.strided( z, 1, 0, out, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided an unsupported number of arguments... +{ + const z = new Float64Array( 2 ); + const out = new Float64Array( 2 ); + + cround.strided(); // $ExpectError + cround.strided( z ); // $ExpectError + cround.strided( z, 1 ); // $ExpectError + cround.strided( z, 1, 0 ); // $ExpectError + cround.strided( z, 1, 0, out ); // $ExpectError + cround.strided( z, 1, 0, out, 1 ); // $ExpectError + cround.strided( z, 1, 0, out, 1, 0, {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/cround/examples/index.js b/lib/node_modules/@stdlib/math/base/special/cround/examples/index.js index 2685e7bec99d..6e1edb21d92f 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/examples/index.js @@ -18,15 +18,13 @@ 'use strict'; -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var cround = require( './../lib' ); -var rand = uniform( -50.0, 50.0 ); +// Create an array of random numbers: +var arr = new Complex128Array( uniform( 200, -50.0, 50.0 ) ); -var z; -var i; -for ( i = 0; i < 100; i++ ) { - z = new Complex128( rand(), rand() ); - console.log( 'cround(%s) = %s', z, cround( z ) ); -} +// Round each component of each complex number to the nearest integer: +logEachMap( 'cround(%s) = %s', arr, cround ); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/assign.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/assign.js new file mode 100644 index 000000000000..a1fc43c8d6e8 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/assign.js @@ -0,0 +1,53 @@ +/** +* @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 round = require( '@stdlib/math/base/special/round' ); + + +// MAIN // + +/** +* Rounds each component of a double-precision complex floating-point number to the nearest integer and assigns results to a provided output array. +* +* @param {number} re - real component +* @param {number} im - imaginary component +* @param {Collection} out - output array +* @param {integer} strideOut - stride length +* @param {NonNegativeInteger} offsetOut - starting index +* @returns {Collection} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var out = assign( -1.5, 2.5, new Float64Array( 2 ), 1, 0 ); +* // returns [ -1.0, 3.0 ] +*/ +function assign( re, im, out, strideOut, offsetOut ) { + out[ offsetOut ] = round( re ); + out[ offsetOut+strideOut ] = round( im ); + return out; +} + + +// EXPORTS // + +module.exports = assign; diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js index 76009cce59ab..8b0b7bab7c7e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js @@ -42,9 +42,20 @@ // MODULES // +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); var main = require( './main.js' ); +var assign = require( './assign.js' ); +var strided = require( './strided.js' ); + + +// MAIN // + +setReadOnly( main, 'assign', assign ); +setReadOnly( main, 'strided', strided ); // EXPORTS // module.exports = main; + +// exports: { "assign": "main.assign", "strided": "main.strided" } diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js index bc76f77dca6c..81627e2a3080 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js @@ -21,9 +21,15 @@ // MODULES // var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var round = require( '@stdlib/math/base/special/round' ); +var Float64Array = require( '@stdlib/array/float64' ); var real = require( '@stdlib/complex/float64/real' ); var imag = require( '@stdlib/complex/float64/imag' ); +var assign = require( './assign.js' ); + + +// VARIABLES // + +var out = new Float64Array( 2 ); // MAIN // @@ -50,7 +56,8 @@ var imag = require( '@stdlib/complex/float64/imag' ); * // returns [ NaN, NaN ] */ function cround( z ) { - return new Complex128( round( real( z ) ), round( imag( z ) ) ); + assign( real( z ), imag( z ), out, 1, 0 ); + return new Complex128( out[ 0 ], out[ 1 ] ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/strided.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/strided.js new file mode 100644 index 000000000000..dfe3077f5125 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/strided.js @@ -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. +*/ + +'use strict'; + +// MODULES // + +var assign = require( './assign.js' ); + + +// MAIN // + +/** +* Rounds each component of a double-precision complex floating-point number stored in a real-valued strided array view to the nearest integer and assigns results to a provided strided output array. +* +* @param {Float64Array} z - complex number view +* @param {integer} strideZ - stride length for `z` +* @param {NonNegativeInteger} offsetZ - starting index for `z` +* @param {Collection} out - output array +* @param {integer} strideOut - stride length for `out` +* @param {NonNegativeInteger} offsetOut - starting index for `out` +* @returns {Collection} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var z = new Float64Array( [ -1.5, 2.5 ] ); +* +* var out = strided( z, 1, 0, new Float64Array( 2 ), 1, 0 ); +* // returns [ -1.0, 3.0 ] +*/ +function strided( z, strideZ, offsetZ, out, strideOut, offsetOut ) { + return assign( z[ offsetZ ], z[ offsetZ+strideZ ], out, strideOut, offsetOut ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = strided; diff --git a/lib/node_modules/@stdlib/math/base/special/cround/test/test.assign.js b/lib/node_modules/@stdlib/math/base/special/cround/test/test.assign.js new file mode 100644 index 000000000000..00f3f25cc498 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/test/test.assign.js @@ -0,0 +1,167 @@ +/** +* @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 isSameFloat64Array = require( '@stdlib/assert/is-same-float64array' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var Float64Array = require( '@stdlib/array/float64' ); +var cround = require( './../lib/assign.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cround, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds each component of a double-precision complex floating-point number to the nearest integer', function test( t ) { + var expected; + var out; + var v; + + out = new Float64Array( 2 ); + v = cround( -1.5, 2.5, out, 1, 0 ); + + expected = new Float64Array( [ -1.0, 3.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + out = new Float64Array( 4 ); + v = cround( -1.5, 2.5, out, 2, 0 ); + + expected = new Float64Array( [ -1.0, 0.0, 3.0, 0.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + out = new Float64Array( 4 ); + v = cround( -1.5, 2.5, out, 2, 1 ); + + expected = new Float64Array( [ 0.0, -1.0, 0.0, 3.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + out = new Float64Array( 4 ); + v = cround( -1.5, 2.5, out, -2, 3 ); + + expected = new Float64Array( [ 0.0, 3.0, 0.0, -1.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function rounds real and imaginary components to the nearest integer', function test( t ) { + var expected; + var out; + + out = new Float64Array( 2 ); + cround( -4.2, 5.5, out, 1, 0 ); + + expected = new Float64Array( [ -4.0, 6.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + cround( 9.99999, 0.1, out, 1, 0 ); + + expected = new Float64Array( [ 10.0, 0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + out = new Float64Array( 2 ); + cround( 0.0, 0.0, out, 1, 0 ); + + expected = new Float64Array( [ 0.0, 0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a `NaN` if provided a `NaN`', function test( t ) { + var out = new Float64Array( 2 ); + + cround( NaN, NaN, out, 1, 0 ); + t.strictEqual( isnan( out[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( out[ 1 ] ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', function test( t ) { + var expected; + var out; + + out = new Float64Array( 2 ); + cround( -0.0, -0.0, out, 1, 0 ); + + expected = new Float64Array( [ -0.0, -0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', function test( t ) { + var expected; + var out; + + out = new Float64Array( 2 ); + cround( +0.0, +0.0, out, 1, 0 ); + + expected = new Float64Array( [ +0.0, +0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { + var expected; + var out; + + out = new Float64Array( 2 ); + cround( PINF, PINF, out, 1, 0 ); + + expected = new Float64Array( [ PINF, PINF ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided `-infinity`', function test( t ) { + var expected; + var out; + + out = new Float64Array( 2 ); + cround( NINF, NINF, out, 1, 0 ); + + expected = new Float64Array( [ NINF, NINF ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/test/test.js b/lib/node_modules/@stdlib/math/base/special/cround/test/test.js index 7ab5a72cc2fb..976602aa52f9 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/test/test.js @@ -21,14 +21,7 @@ // MODULES // var tape = require( 'tape' ); -var PINF = require( '@stdlib/constants/float64/pinf' ); -var NINF = require( '@stdlib/constants/float64/ninf' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); -var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); -var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); +var isMethod = require( '@stdlib/assert/is-method' ); var cround = require( './../lib' ); @@ -40,65 +33,12 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function rounds real and imaginary components to the nearest integer', function test( t ) { - var v; - - v = cround( new Complex128( -4.2, 5.5 ) ); - t.strictEqual( real( v ), -4.0, 'returns expected value' ); - t.strictEqual( imag( v ), 6.0, 'returns expected value' ); - - v = cround( new Complex128( 9.99999, 0.1 ) ); - t.strictEqual( real( v ), 10.0, 'returns expected value' ); - t.strictEqual( imag( v ), 0.0, 'returns expected value' ); - - v = cround( new Complex128( 0.0, 0.0 ) ); - t.strictEqual( real( v ), 0.0, 'returns expected value' ); - t.strictEqual( imag( v ), 0.0, 'returns expected value' ); - +tape( 'attached to the main export is an `assign` method', function test( t ) { + t.strictEqual( isMethod( cround, 'assign' ), true, 'returns expected value' ); t.end(); }); -tape( 'the function returns a `NaN` if provided a `NaN`', function test( t ) { - var v; - - v = cround( new Complex128( NaN, NaN ) ); - t.strictEqual( isnan( real( v ) ), true, 'returns expected value' ); - t.strictEqual( isnan( imag( v ) ), true, 'returns expected value' ); - t.end(); -}); - -tape( 'the function returns `-0` if provided `-0`', function test( t ) { - var v; - - v = cround( new Complex128( -0.0, -0.0 ) ); - t.strictEqual( isNegativeZero( real( v ) ), true, 'returns expected value' ); - t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns expected value' ); - t.end(); -}); - -tape( 'the function returns `+0` if provided `+0`', function test( t ) { - var v; - - v = cround( new Complex128( +0.0, +0.0 ) ); - t.strictEqual( isPositiveZero( real( v ) ), true, 'returns expected value' ); - t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns expected value' ); - t.end(); -}); - -tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { - var v; - - v = cround( new Complex128( PINF, PINF ) ); - t.strictEqual( real( v ), PINF, 'returns expected value' ); - t.strictEqual( imag( v ), PINF, 'returns expected value' ); - t.end(); -}); - -tape( 'the function returns `-infinity` if provided `-infinity`', function test( t ) { - var v; - - v = cround( new Complex128( NINF, NINF ) ); - t.strictEqual( real( v ), NINF, 'returns expected value' ); - t.strictEqual( imag( v ), NINF, 'returns expected value' ); +tape( 'attached to the main export is a `strided` method', function test( t ) { + t.strictEqual( isMethod( cround, 'strided' ), true, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/test/test.main.js b/lib/node_modules/@stdlib/math/base/special/cround/test/test.main.js new file mode 100644 index 000000000000..779dad5a4653 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/test/test.main.js @@ -0,0 +1,104 @@ +/** +* @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 PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); +var cround = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cround, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds real and imaginary components to the nearest integer', function test( t ) { + var v; + + v = cround( new Complex128( -4.2, 5.5 ) ); + t.strictEqual( real( v ), -4.0, 'returns expected value' ); + t.strictEqual( imag( v ), 6.0, 'returns expected value' ); + + v = cround( new Complex128( 9.99999, 0.1 ) ); + t.strictEqual( real( v ), 10.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); + + v = cround( new Complex128( 0.0, 0.0 ) ); + t.strictEqual( real( v ), 0.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a `NaN` if provided a `NaN`', function test( t ) { + var v; + + v = cround( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', function test( t ) { + var v; + + v = cround( new Complex128( -0.0, -0.0 ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', function test( t ) { + var v; + + v = cround( new Complex128( +0.0, +0.0 ) ); + t.strictEqual( isPositiveZero( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { + var v; + + v = cround( new Complex128( PINF, PINF ) ); + t.strictEqual( real( v ), PINF, 'returns expected value' ); + t.strictEqual( imag( v ), PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided `-infinity`', function test( t ) { + var v; + + v = cround( new Complex128( NINF, NINF ) ); + t.strictEqual( real( v ), NINF, 'returns expected value' ); + t.strictEqual( imag( v ), NINF, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/test/test.strided.js b/lib/node_modules/@stdlib/math/base/special/cround/test/test.strided.js new file mode 100644 index 000000000000..6fd688ebda96 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cround/test/test.strided.js @@ -0,0 +1,185 @@ +/** +* @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 isSameFloat64Array = require( '@stdlib/assert/is-same-float64array' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var Float64Array = require( '@stdlib/array/float64' ); +var cround = require( './../lib/strided.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cround, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds each component of a double-precision complex floating-point number to the nearest integer', function test( t ) { + var expected; + var out; + var z; + var v; + + z = new Float64Array( [ -1.5, 2.5 ] ); + out = new Float64Array( 2 ); + v = cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -1.0, 3.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + z = new Float64Array( [ -1.5, 0.0, 2.5, 0.0 ] ); + out = new Float64Array( 4 ); + v = cround( z, 2, 0, out, 2, 0 ); + + expected = new Float64Array( [ -1.0, 0.0, 3.0, 0.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + z = new Float64Array( [ 0.0, -1.5, 0.0, 2.5 ] ); + out = new Float64Array( 4 ); + v = cround( z, 2, 1, out, 2, 1 ); + + expected = new Float64Array( [ 0.0, -1.0, 0.0, 3.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + z = new Float64Array( [ 2.5, -1.5 ] ); + out = new Float64Array( 4 ); + v = cround( z, -1, 1, out, -2, 3 ); + + expected = new Float64Array( [ 0.0, 3.0, 0.0, -1.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function rounds real and imaginary components to the nearest integer', function test( t ) { + var expected; + var out; + var z; + + z = new Float64Array( [ -4.2, 5.5 ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -4.0, 6.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + z = new Float64Array( [ 9.99999, 0.1 ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 10.0, 0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + z = new Float64Array( [ 0.0, 0.0 ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ 0.0, 0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a `NaN` if provided a `NaN`', function test( t ) { + var out = new Float64Array( 2 ); + var z = new Float64Array( [ NaN, NaN ] ); + + cround( z, 1, 0, out, 1, 0 ); + t.strictEqual( isnan( out[ 0 ] ), true, 'returns expected value' ); + t.strictEqual( isnan( out[ 1 ] ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', function test( t ) { + var expected; + var out; + var z; + + z = new Float64Array( [ -0.0, -0.0 ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ -0.0, -0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', function test( t ) { + var expected; + var out; + var z; + + z = new Float64Array( [ +0.0, +0.0 ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ +0.0, +0.0 ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { + var expected; + var out; + var z; + + z = new Float64Array( [ PINF, PINF ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ PINF, PINF ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided `-infinity`', function test( t ) { + var expected; + var out; + var z; + + z = new Float64Array( [ NINF, NINF ] ); + out = new Float64Array( 2 ); + cround( z, 1, 0, out, 1, 0 ); + + expected = new Float64Array( [ NINF, NINF ] ); + + t.strictEqual( isSameFloat64Array( out, expected ), true, 'returns expected value' ); + t.end(); +});