feat: docs added

Author: aayush0325

lib/node_modules/@stdlib/math/base/special/ahavercosf/docs/img/equation_archavercosine.svg

@@ -0,0 +1,29 @@
+
+{{alias}}( x )
+    Computes the inverse half-value versed cosine of a
+    single-precision floating-point number.
+
+    The inverse half-value versed cosine is defined as `2*acos(sqrt(x))`.
+
+    If `x < 0`, `x > 1`, or `x` is `NaN`, the function returns `NaN`.
+
+    Parameters
+    ----------
+    x: number
+        Input value.
+
+    Returns
+    -------
+    y: number
+        Inverse half-value versed cosine.
+
+    Examples
+    --------
+    > var y = {{alias}}( 0.5 )
+    ~1.5708
+    > y = {{alias}}( 0.0 )
+    ~3.1416
+
+    See Also
+    --------
+

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

@@ -0,0 +1,48 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Computes the inverse half-value versed cosine of a single-precision floating-point number.
+*
+* @param x - input value
+* @returns inverse half-value versed cosine
+*
+* @example
+* var v = ahavercosf( 0.0 );
+* // returns ~3.1416
+*
+* @example
+* var v = ahavercosf( 1.0 );
+* // returns 0.0
+*
+* @example
+* var v = ahavercosf( 0.5 );
+* // returns ~1.5708
+*
+* @example
+* var v = ahavercosf( NaN );
+* // returns NaN
+*/
+declare function ahavercosf( x: number ): number;
+
+
+// EXPORTS //
+
+export = ahavercosf;

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

@@ -0,0 +1,44 @@
+/*
+* @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 ahavercosf = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	ahavercosf( 8 ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a value other than a number...
+{
+	ahavercosf( true ); // $ExpectError
+	ahavercosf( false ); // $ExpectError
+	ahavercosf( null ); // $ExpectError
+	ahavercosf( undefined ); // $ExpectError
+	ahavercosf( '5' ); // $ExpectError
+	ahavercosf( [] ); // $ExpectError
+	ahavercosf( {} ); // $ExpectError
+	ahavercosf( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	ahavercosf(); // $ExpectError
+}