feat: docs added

Author: Neerajpathak07

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

@@ -0,0 +1,40 @@
+
+{{alias}}( y, x )
+    Computes the angle in the plane (in radians) between the positive x-axis and
+    the ray from (0,0) to the point (x,y).
+
+    Parameters
+    ----------
+    y: number
+        Coordinate along y-axis.
+
+    x: number
+        Coordinate along x-axis.
+
+    Returns
+    -------
+    out: number
+        Angle (in radians).
+
+    Examples
+    --------
+    > var v = {{alias}}( 2.0f, 2.0f )
+    ~0.785f
+    > v = {{alias}}( 6.0f, 2.0f )
+    ~1.249f
+    > v = {{alias}}( -1.0f, -1.0f )
+    ~-2.356f
+    > v = {{alias}}( 3.0f, 0.0f )
+    ~1.571f
+    > v = {{alias}}( -2.0f, 0.0f )
+    ~-1.571f
+    > v = {{alias}}( 0.0f, 0.0f )
+    0.0f
+    > v = {{alias}}( 3.0f, NaN )
+    NaN
+    > v = {{alias}}( NaN, 2.0f )
+    NaN
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/math/base/special/atan2f/docs/repl.txt

@@ -0,0 +1,65 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Computes the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`.
+*
+* @param y - `y` coordinate
+* @param x - `x` coordinate
+* @returns angle (in radians)
+*
+* @example
+* var v = atan2f( 2.0f, 2.0f ); // => atanf(1.0f)
+* // returns ~0.785f
+*
+* @example
+* var v = atan2f( 6.0f, 2.0f ); // => atanf(3.0f)
+* // returns ~1.249f
+*
+* @example
+* var v = atan2f( -1.0f, -1.0f ); // => atanf(1.0f) - π
+* // returns ~-2.356f
+*
+* @example
+* var v = atan2f( 3.0f, 0.0f ); // => π/2
+* // returns ~1.571f
+*
+* @example
+* var v = atan2f( -2.0f, 0.0f ); // => -π/2
+* // returns ~-1.571f
+*
+* @example
+* var v = atan2f( 0.0f, 0.0f );
+* // returns 0.0f
+*
+* @example
+* var v = atan2f( 3.0f, NaN );
+* // returns NaN
+*
+* @example
+* var v = atan2( NaN, 2.0f );
+* // returns NaN
+*/
+declare function atan2f( y: number, x: number ): number;
+
+
+// EXPORTS //
+
+export = atan2f;

lib/node_modules/@stdlib/math/base/special/atan2f/docs/types/index.d.ts

@@ -0,0 +1,56 @@
+/*
+* @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 atan2f = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	atan2f( 8, 2 ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided values other than two numbers...
+{
+	atan2f( true, 3 ); // $ExpectError
+	atan2f( false, 2 ); // $ExpectError
+	atan2f( '5', 1 ); // $ExpectError
+	atan2f( [], 1 ); // $ExpectError
+	atan2f( {}, 2 ); // $ExpectError
+	atan2f( ( x: number ): number => x, 2 ); // $ExpectError
+
+	atan2f( 9, true ); // $ExpectError
+	atan2f( 9, false ); // $ExpectError
+	atan2f( 5, '5' ); // $ExpectError
+	atan2f( 8, [] ); // $ExpectError
+	atan2f( 9, {} ); // $ExpectError
+	atan2f( 8, ( x: number ): number => x ); // $ExpectError
+
+	atan2f( [], true ); // $ExpectError
+	atan2f( {}, false ); // $ExpectError
+	atan2f( false, '5' ); // $ExpectError
+	atan2f( {}, [] ); // $ExpectError
+	atan2f( '5', ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	atan2(); // $ExpectError
+	atan2( 3 ); // $ExpectError
+}

lib/node_modules/@stdlib/math/base/special/atan2f/docs/types/test.ts

@@ -221,4 +221,4 @@ tape( 'the function evaluates the `atan2` function (when x and y are negative)',
 		t.equal( delta <= tol, true, 'within tolerance. y: '+y[i]+'. x: '+x[i]+'. Actual: '+actual+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' );
 	}
 	t.end();
-});
+});