feat: add docs

Author: aayush0325

lib/node_modules/@stdlib/math/base/special/cabsf/docs/img/equation_absolute_value_complex.svg

@@ -0,0 +1,25 @@
+
+{{alias}}( z )
+    Computes the absolute value of a single-precision complex floating-point
+    number.
+
+    The absolute value of a complex number is its distance from zero.
+
+    Parameters
+    ----------
+    z: Complex64
+        Complex number.
+
+    Returns
+    -------
+    y: number
+        Absolute value.
+
+    Examples
+    --------
+    > var y = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 ) )
+    ~5.831
+
+    See Also
+    --------
+

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

@@ -0,0 +1,46 @@
+/*
+* @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
+
+/// <reference types="@stdlib/types"/>
+
+import { Complex64 } from '@stdlib/types/complex';
+
+/**
+* Computes the absolute value of a single-precision complex floating-point number.
+*
+* ## Notes
+*
+* -   The absolute value of a complex number is its distance from zero.
+*
+* @param z - complex number
+* @returns absolute value
+*
+* @example
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+*
+* var v = cabsf( new Complex64( 5.0, 3.0 ) );
+* // returns ~5.83
+*/
+declare function cabsf( z: Complex64 ): number;
+
+
+// EXPORTS //
+
+export = cabsf;

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

@@ -0,0 +1,45 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 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 Complex64 = require( '@stdlib/complex/float32/ctor' );
+import cabsf = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	cabsf( new Complex64( 5, 3 ) ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is not provided a complex number...
+{
+	cabsf( true ); // $ExpectError
+	cabsf( false ); // $ExpectError
+	cabsf( null ); // $ExpectError
+	cabsf( undefined ); // $ExpectError
+	cabsf( '5' ); // $ExpectError
+	cabsf( [] ); // $ExpectError
+	cabsf( {} ); // $ExpectError
+	cabsf( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	cabsf(); // $ExpectError
+}