feat: tests added

Author: Neerajpathak07

lib/node_modules/@stdlib/math/base/special/atan2f/test/fixtures/julia/REQUIRE

@@ -0,0 +1,2 @@
+julia 1.5
+JSON 0.21

lib/node_modules/@stdlib/math/base/special/atan2f/test/fixtures/julia/negative_negative.json

@@ -0,0 +1,82 @@
+#!/usr/bin/env julia
+#
+# @license Apache-2.0
+#
+# Copyright (c) 2024 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.
+
+import JSON
+
+"""
+    gen( x, y, name )
+
+Generate fixture data and write to file.
+
+# Arguments
+
+* `x`: denominator domain
+* `y`: numerator domain
+* `name::AbstractString`: output filename
+
+# Examples
+
+``` julia
+julia> x = range( -1000.0, stop = 1000.0, length = 2001 );
+julia> y = range( 0.0, stop = 1000.0, length = 1001 );
+julia> gen( x, y, \"data.json\" );
+```
+"""
+function gen( x, y, name )
+	z = Array{Float64}( undef, length(x) );
+	for i in eachindex(x)
+		z[ i ] = atan2.( y[i], x[i] );
+	end
+
+	# Store data to be written to file as a collection:
+	data = Dict([
+		("x", x),
+		("y", y),
+		("expected", z)
+	]);
+
+	# Based on the script directory, create an output filepath:
+	filepath = joinpath( dir, name );
+
+	# Write the data to the output filepath as JSON:
+	outfile = open( filepath, "w" );
+	write( outfile, JSON.json(data) );
+	write( outfile, "\n" );
+	close( outfile );
+end
+
+# Get the filename:
+file = @__FILE__;
+
+# Extract the directory in which this file resides:
+dir = dirname( file );
+
+# Random (x positive, y positive):
+x = rand( 5001 ) .* 500.0;
+y = rand( 5001 ) .* 500.0;
+gen( x, y, "positive_positive.json" );
+
+# Random (x negative, y positive):
+x = -rand( 1001 ) .* 500.0;
+y = rand( 1001 ) .* 500.0;
+gen( x, y, "negative_positive.json" );
+
+# Random (x negative, y negative):
+x = -rand( 1001 ) .* 500.0;
+y = -rand( 1001 ) .* 500.0;
+gen( x, y, "negative_negative.json" );

lib/node_modules/@stdlib/math/base/special/atan2f/test/fixtures/julia/negative_positive.json

@@ -0,0 +1,227 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' );
+var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
+var abs = require( '@stdlib/math/base/special/abs' );
+var EPS = require( '@stdlib/constants/float64/eps' );
+var PINF = require( '@stdlib/constants/float64/pinf' );
+var NINF = require( '@stdlib/constants/float64/ninf' );
+var PI = require( '@stdlib/constants/float64/pi' );
+var atan2f = require( './../lib' );
+
+
+// FIXTURES //
+
+var positivePositive = require( './fixtures/julia/positive_positive.json' );
+var negativePositive = require( './fixtures/julia/negative_positive.json' );
+var negativeNegative = require( './fixtures/julia/negative_negative.json' );
+
+
+// TESTS //
+
+tape( 'main export is a function', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof atan2f, 'function', 'main export is a function' );
+	t.end();
+});
+
+tape( 'the function has two parameters: a numerator and a denominator value', function test( t ) {
+	t.equal( atan2f.length, 2.0, 'arity is 2' );
+	t.end();
+});
+
+tape( 'the function returns `NaN` if provided `NaN` as either of the arguments', function test( t ) {
+	t.equal( isnanf( atan2f( 2.0, NaN ) ), true, 'returns NaN' );
+	t.equal( isnanf( atan2f( NaN, 3.0 ) ), true, 'returns NaN' );
+	t.end();
+});
+
+tape( 'the function returns `+0` if provided `y = +0.0` and `x >= 0`', function test( t ) {
+	t.equal( isPositiveZero( atan2f( +0.0, 0.0 ) ), true, 'returns +0' );
+	t.equal( isPositiveZero( atan2f( +0.0, 2.0 ) ), true, 'returns +0' );
+	t.equal( isPositiveZero( atan2f( +0.0, 4.0 ) ), true, 'returns +0' );
+	t.equal( isPositiveZero( atan2f( +0.0, 5.0 ) ), true, 'returns +0' );
+	t.equal( isPositiveZero( atan2f( +0.0, 10.0 ) ), true, 'returns +0' );
+	t.end();
+});
+
+tape( 'the function returns `-0` if provided `y = -0.0` and `x >= 0`', function test( t ) {
+	t.equal( isNegativeZero( atan2f( -0.0, 0.0 ) ), true, 'returns -0' );
+	t.equal( isNegativeZero( atan2f( -0.0, 2.0 ) ), true, 'returns -0' );
+	t.equal( isNegativeZero( atan2f( -0.0, 4.0 ) ), true, 'returns -0' );
+	t.equal( isNegativeZero( atan2f( -0.0, 5.0 ) ), true, 'returns -0' );
+	t.equal( isNegativeZero( atan2f( -0.0, 10.0 ) ), true, 'returns -0' );
+	t.end();
+});
+
+tape( 'the function returns `PI` if provided `y = +0.0` and `x <= -0.0`', function test( t ) {
+	t.equal( atan2f( +0.0, -0.0 ), +PI, 'returns +PI' );
+	t.equal( atan2f( +0.0, -2.0 ), +PI, 'returns +PI' );
+	t.equal( atan2f( +0.0, -4.0 ), +PI, 'returns +PI' );
+	t.equal( atan2f( +0.0, -5.0 ), +PI, 'returns +PI' );
+	t.equal( atan2f( +0.0, -10.0 ), +PI, 'returns +PI' );
+	t.end();
+});
+
+tape( 'the function returns `-PI` if provided `y = -0.0` and `x <= -0.0`', function test( t ) {
+	t.equal( atan2f( -0.0, -0.0 ), -PI, 'returns -PI' );
+	t.equal( atan2f( -0.0, -2.0 ), -PI, 'returns -PI' );
+	t.equal( atan2f( -0.0, -4.0 ), -PI, 'returns -PI' );
+	t.equal( atan2f( -0.0, -5.0 ), -PI, 'returns -PI' );
+	t.equal( atan2f( -0.0, -10.0 ), -PI, 'returns -PI' );
+	t.end();
+});
+
+tape( 'the function returns `+PI/4` if provided `x = y = +infinity`', function test( t ) {
+	t.equal( atan2f( PINF, PINF ), +PI/4.0, 'returns +PI/4' );
+	t.end();
+});
+
+tape( 'the function returns `-PI/4` if provided `x = -y = +infinity`', function test( t ) {
+	t.equal( atan2f( NINF, PINF ), -PI/4.0, 'returns -PI/4' );
+	t.end();
+});
+
+tape( 'the function returns `*3*PI/4` if provided `-x = y = +infinity`', function test( t ) {
+	t.equal( atan2f( PINF, NINF ), +3.0*PI/4.0, 'returns +3*PI/4' );
+	t.end();
+});
+
+tape( 'the function returns `-3*PI/4` if provided `x = y = -infinity`', function test( t ) {
+	t.equal( atan2f( NINF, NINF ), -3.0*PI/4.0, 'returns -3*PI/4' );
+	t.end();
+});
+
+tape( 'the function returns `0.0` when `x = +infinity`', function test( t ) {
+	t.equal( atan2f( -2.0, PINF ), 0.0, 'returns 0.0' );
+	t.equal( atan2f( 0.0, PINF ), 0.0, 'returns 0.0' );
+	t.equal( atan2f( 2.0, PINF ), 0.0, 'returns 0.0' );
+	t.end();
+});
+
+tape( 'the function returns `+PI` when `y > 0` and `x = -infinity`', function test( t ) {
+	t.equal( atan2f( 1.0, NINF ), PI, 'returns PI' );
+	t.equal( atan2f( 2.0, NINF ), PI, 'returns PI' );
+	t.equal( atan2f( 3.0, NINF ), PI, 'returns PI' );
+	t.end();
+});
+
+tape( 'the function returns `-PI` when `y < 0` and `x = -infinity`', function test( t ) {
+	t.equal( atan2f( -1.0, NINF ), -PI, 'returns -PI' );
+	t.equal( atan2f( -2.0, NINF ), -PI, 'returns -PI' );
+	t.equal( atan2f( -3.0, NINF ), -PI, 'returns -PI' );
+	t.end();
+});
+
+tape( 'the function returns `+PI/2` when `y = +infinity`', function test( t ) {
+	t.equal( atan2f( PINF, -1.0 ), PI/2.0, 'returns PI/2' );
+	t.equal( atan2f( PINF, 0.0 ), PI/2.0, 'returns PI/2' );
+	t.equal( atan2f( PINF, 2.0 ), PI/2.0, 'returns PI/2' );
+	t.end();
+});
+
+tape( 'the function returns `-PI/2` when `y = -infinity`', function test( t ) {
+	t.equal( atan2f( NINF, -1.0 ), -PI/2.0, 'returns -PI/2' );
+	t.equal( atan2f( NINF, 0.0 ), -PI/2.0, 'returns -PI/2' );
+	t.equal( atan2f( NINF, 2.0 ), -PI/2.0, 'returns -PI/2' );
+	t.end();
+});
+
+tape( 'the function returns `PI/2` if provided a positive `y` and `x=0`', function test( t ) {
+	t.equal( atan2f( 2.0, 0.0 ), PI/2.0, 'returns PI/2' );
+	t.equal( atan2f( 1.0, 0.0 ), PI/2.0, 'returns PI/2' );
+	t.equal( atan2f( 0.5, 0.0 ), PI/2.0, 'returns PI/2' );
+	t.end();
+});
+
+tape( 'the function returns `-PI/2` if provided a negative `y` and `x=0`', function test( t ) {
+	t.equal( atan2f( -2.0, 0.0 ), -PI/2.0, 'returns PI/2' );
+	t.equal( atan2f( -1.0, 0.0 ), -PI/2.0, 'returns PI/2' );
+	t.equal( atan2f( -0.5, 0.0 ), -PI/2.0, 'returns PI/2' );
+	t.end();
+});
+
+tape( 'the function evaluates the `atan2` function (when x and y are positive)', function test( t ) {
+	var expected;
+	var actual;
+	var delta;
+	var tol;
+	var x;
+	var y;
+	var i;
+
+	y = positivePositive.y;
+	x = positivePositive.x;
+	expected = positivePositive.expected;
+	for ( i = 0; i < x.length; i++ ) {
+		actual = atan2f( y[i], x[i] );
+		delta = abs( actual - expected[i] );
+		tol = EPS * abs( expected[i] );
+		t.equal( delta <= tol, true, 'within tolerance. y: '+y[i]+'. x: '+x[i]+'. Actual: '+actual+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' );
+	}
+	t.end();
+});
+
+tape( 'the function evaluates the `atan2` function (when x is negative and y is positive)', function test( t ) {
+	var expected;
+	var actual;
+	var delta;
+	var tol;
+	var x;
+	var y;
+	var i;
+
+	y = negativePositive.y;
+	x = negativePositive.x;
+	expected = negativePositive.expected;
+	for ( i = 0; i < x.length; i++ ) {
+		actual = atan2f( y[i], x[i] );
+		delta = abs( actual - expected[i] );
+		tol = 2.0 * EPS * abs( expected[i] );
+		t.equal( delta <= tol, true, 'within tolerance. y: '+y[i]+'. x: '+x[i]+'. Actual: '+actual+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' );
+	}
+	t.end();
+});
+
+tape( 'the function evaluates the `atan2` function (when x and y are negative)', function test( t ) {
+	var expected;
+	var actual;
+	var delta;
+	var tol;
+	var x;
+	var y;
+	var i;
+
+	y = negativeNegative.y;
+	x = negativeNegative.x;
+	expected = negativeNegative.expected;
+	for ( i = 0; i < x.length; i++ ) {
+		actual = atan2f( y[i], x[i] );
+		delta = abs( actual - expected[i] );
+		tol = 2.0 * EPS * abs( expected[i] );
+		t.equal( delta <= tol, true, 'within tolerance. y: '+y[i]+'. x: '+x[i]+'. Actual: '+actual+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' );
+	}
+	t.end();
+});