feat: add math/base/special/hacovercosf

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: passed
  - task: lint_c_benchmarks
    status: passed
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: anandkaranubc

lib/node_modules/@stdlib/math/base/special/hacovercosf/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # Hacovercosine
 
-> Compute the half-value [coversed cosine][coversed-cosine].
+> Compute the half-value [coversed cosine][coversed-cosine] of a single-precision floating-point number (in radians).
 
 <section class="intro">
 
@@ -32,11 +32,6 @@ The half-value [coversed cosine][coversed-cosine] is defined as
 \mathop{\mathrm{hacovercos}}(\theta) = \frac{1 + \sin \theta}{2}
 ```
 
-<!-- <div class="equation" align="center" data-raw-text="\operatorname{hacovercos}(\theta) = \frac{1 + \sin \theta}{2}" data-equation="eq:hacovercosine">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@bb29798906e119fcb2af99e94b60407a270c9b32/lib/node_modules/@stdlib/math/base/special/hacovercos/docs/img/equation_hacovercosine.svg" alt="Half-value coversed cosine.">
-    <br>
-</div> -->
-
 <!-- </equation> -->
 
 </section>
@@ -48,21 +43,21 @@ The half-value [coversed cosine][coversed-cosine] is defined as
 ## Usage
 
 ```javascript
-var hacovercos = require( '@stdlib/math/base/special/hacovercos' );
+var hacovercosf = require( '@stdlib/math/base/special/hacovercosf' );
 ```
 
-#### hacovercos( x )
+#### hacovercosf( x )
 
-Computes the half-value [coversed cosine][coversed-cosine] (in radians).
+Computes the half-value [coversed cosine][coversed-cosine] of a single-precision floating-point number (in radians).
 
 ```javascript
-var v = hacovercos( 0.0 );
+var v = hacovercosf( 0.0 );
 // returns 0.5
 
-v = hacovercos( 3.141592653589793/2.0 );
+v = hacovercosf( 3.141592653589793/2.0 );
 // returns 1.0
 
-v = hacovercos( -3.141592653589793/6.0 );
+v = hacovercosf( -3.141592653589793/6.0 );
 // returns 0.25
 ```
 
@@ -79,15 +74,15 @@ v = hacovercos( -3.141592653589793/6.0 );
 ```javascript
 var uniform = require( '@stdlib/random/array/uniform' );
 var logEachMap = require( '@stdlib/console/log-each-map' );
-var TWO_PI = require( '@stdlib/constants/float64/two-pi' );
-var hacovercos = require( '@stdlib/math/base/special/hacovercos' );
+var TWO_PI = require( '@stdlib/constants/float32/two-pi' );
+var hacovercosf = require( '@stdlib/math/base/special/hacovercosf' );
 
 var opts = {
-    'dtype': 'float64'
+    'dtype': 'float32'
 };
 var x = uniform( 100, 0.0, TWO_PI, opts );
 
-logEachMap( 'hacovercos(%0.4f) = %0.4f', x, hacovercos );
+logEachMap( 'hacovercosf(%0.4f) = %0.4f', x, hacovercosf );
 ```
 
 </section>
@@ -117,27 +112,27 @@ logEachMap( 'hacovercos(%0.4f) = %0.4f', x, hacovercos );
 ### Usage
 
 ```c
-#include "stdlib/math/base/special/hacovercos.h"
+#include "stdlib/math/base/special/hacovercosf.h"
 ```
 
-#### stdlib_base_hacovercos( x )
+#### stdlib_base_hacovercosf( x )
 
-Computes the half-value [coversed cosine][coversed-cosine] (in radians).
+Computes the half-value [coversed cosine][coversed-cosine] of a single-precision floating-point number (in radians).
 
 ```c
-double out = stdlib_base_hacovercos( 0.0 );
-// returns 0.5
+float out = stdlib_base_hacovercosf( 0.0f );
+// returns 0.5f
 
-out = stdlib_base_hacovercos( 3.141592653589793 / 2.0 );
-// returns 1.0
+out = stdlib_base_hacovercosf( 3.141592653589793f / 2.0f );
+// returns 1.0f
 ```
 
 The function accepts the following arguments:
 
--   **x**: `[in] double` input value.
+-   **x**: `[in] float` input value (in radians).
 
 ```c
-double stdlib_base_hacovercos( const double x );
+float stdlib_base_hacovercosf( const float x );
 ```
 
 </section>
@@ -159,17 +154,17 @@ double stdlib_base_hacovercos( const double x );
 ### Examples
 
 ```c
-#include "stdlib/math/base/special/hacovercos.h"
+#include "stdlib/math/base/special/hacovercosf.h"
 #include <stdio.h>
 
 int main( void ) {
-    const double x[] = { 0.0, 0.523, 0.785, 1.047, 3.14 };
+    const float x[] = { 0.0f, 0.523f, 0.785f, 1.047f, 3.14f };
 
-    double y;
+    float y;
     int i;
     for ( i = 0; i < 5; i++ ) {
-        y = stdlib_base_hacovercos( x[ i ] );
-        printf( "hacovercos(%lf) = %lf\n", x[ i ], y );
+        y = stdlib_base_hacovercosf( x[ i ] );
+        printf( "hacovercosf(%f) = %f\n", x[ i ], y );
     }
 }
 ```
@@ -186,13 +181,6 @@ int main( void ) {
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/math/base/special/hacoversin`][@stdlib/math/base/special/hacoversin]</span><span class="delimiter">: </span><span class="description">compute the half-value coversed sine.</span>
--   <span class="package-name">[`@stdlib/math/base/special/havercos`][@stdlib/math/base/special/havercos]</span><span class="delimiter">: </span><span class="description">compute the half-value versed cosine.</span>
-
 </section>
 
 <!-- /.related -->
@@ -205,10 +193,6 @@ int main( void ) {
 
 <!-- <related-links> -->
 
-[@stdlib/math/base/special/hacoversin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/hacoversin
-
-[@stdlib/math/base/special/havercos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/havercos
-
 <!-- </related-links> -->
 
 </section>

lib/node_modules/@stdlib/math/base/special/hacovercosf/benchmark/benchmark.js

@@ -22,9 +22,9 @@
 
 var bench = require( '@stdlib/bench' );
 var uniform = require( '@stdlib/random/array/uniform' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pkg = require( './../package.json' ).name;
-var hacovercos = require( './../lib' );
+var hacovercosf = require( './../lib' );
 
 
 // MAIN //
@@ -34,17 +34,19 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
-	x = uniform( 100, -10.0, 10.0 );
+	x = uniform( 100, -10.0, 10.0, {
+		'dtype': 'float32'
+	});
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = hacovercos( x[ i%x.length ] );
-		if ( isnan( y ) ) {
+		y = hacovercosf( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
 	}
 	b.toc();
-	if ( isnan( y ) ) {
+	if ( isnanf( y ) ) {
 		b.fail( 'should not return NaN' );
 	}
 	b.pass( 'benchmark finished' );

lib/node_modules/@stdlib/math/base/special/hacovercosf/benchmark/benchmark.native.js

@@ -23,16 +23,16 @@
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
 var uniform = require( '@stdlib/random/array/uniform' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
 
 // VARIABLES //
 
-var hacovercos = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var hacovercosf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
 var opts = {
-	'skip': ( hacovercos instanceof Error )
+	'skip': ( hacovercosf instanceof Error )
 };
 
 
@@ -43,17 +43,19 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 	var y;
 	var i;
 
-	x = uniform( 100, -10.0, 10.0 );
+	x = uniform( 100, -10.0, 10.0, {
+		'dtype': 'float32'
+	});
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		y = hacovercos( x[ i%x.length ] );
-		if ( isnan( y ) ) {
+		y = hacovercosf( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
 	}
 	b.toc();
-	if ( isnan( y ) ) {
+	if ( isnanf( y ) ) {
 		b.fail( 'should not return NaN' );
 	}
 	b.pass( 'benchmark finished' );

lib/node_modules/@stdlib/math/base/special/hacovercosf/benchmark/c/benchmark.c

@@ -22,7 +22,7 @@
 #include <time.h>
 #include <sys/time.h>
 
-#define NAME "hacovercos"
+#define NAME "hacovercosf"
 #define ITERATIONS 1000000
 #define REPEATS 3
 
@@ -74,13 +74,15 @@ static double tic( void ) {
 }
 
 /**
-* Generates a random number on the interval [0,1).
+* Generates a random number on the interval [min,max).
 *
-* @return random number
+* @param min    minimum value (inclusive)
+* @param max    maximum value (exclusive)
+* @return       random number
 */
-static double rand_double( void ) {
-	int r = rand();
-	return (double)r / ( (double)RAND_MAX + 1.0 );
+static float random_uniform( const float min, const float max ) {
+	float v = (float)rand() / ( (float)RAND_MAX + 1.0f );
+	return min + ( v*(max-min) );
 }
 
 /**
@@ -89,19 +91,19 @@ static double rand_double( void ) {
 * @return elapsed time in seconds
 */
 static double benchmark( void ) {
+	float x[ 100 ];
 	double elapsed;
-	double x[ 100 ];
-	double y;
 	double t;
+	float y;
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		x[ i ] = ( 20.0*rand_double() ) - 10.0;
+		x[ i ] = random_uniform( -10.0f, 10.0f );
 	}
 
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		y = ( 1.0 + sin( x[ i%100 ] ) ) / 2.0;
+		y = ( 1.0f + sinf( x[ i%100 ] ) ) / 2.0f;
 		if ( y != y ) {
 			printf( "should not return NaN\n" );
 			break;

lib/node_modules/@stdlib/math/base/special/hacovercosf/benchmark/c/native/benchmark.c

@@ -16,14 +16,14 @@
 * limitations under the License.
 */
 
-#include "stdlib/math/base/special/hacovercos.h"
+#include "stdlib/math/base/special/hacovercosf.h"
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>
 #include <time.h>
 #include <sys/time.h>
 
-#define NAME "hacovercos"
+#define NAME "hacovercosf"
 #define ITERATIONS 1000000
 #define REPEATS 3
 
@@ -75,13 +75,15 @@ static double tic( void ) {
 }
 
 /**
-* Generates a random number on the interval [0,1).
+* Generates a random number on the interval [min,max).
 *
-* @return random number
+* @param min    minimum value (inclusive)
+* @param max    maximum value (exclusive)
+* @return       random number
 */
-static double rand_double( void ) {
-	int r = rand();
-	return (double)r / ( (double)RAND_MAX + 1.0 );
+static float random_uniform( const float min, const float max ) {
+	float v = (float)rand() / ( (float)RAND_MAX + 1.0f );
+	return min + ( v*(max-min) );
 }
 
 /**
@@ -90,19 +92,19 @@ static double rand_double( void ) {
 * @return elapsed time in seconds
 */
 static double benchmark( void ) {
+	float x[ 100 ];
 	double elapsed;
-	double x[ 100 ];
-	double y;
 	double t;
+	float y;
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		x[ i ] = ( 20.0 * rand_double() ) - 10.0;
+		x[ i ] = random_uniform( -10.0f, 10.0f );
 	}
 
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		y = stdlib_base_hacovercos( x[ i%100 ] );
+		y = stdlib_base_hacovercosf( x[ i%100 ] );
 		if ( y != y ) {
 			printf( "should not return NaN\n" );
 			break;

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

@@ -1,6 +1,7 @@
 
 {{alias}}( x )
-    Computes the half-value coversed cosine of a single-precision floating-point number (in radians).
+    Computes the half-value coversed cosine of a single-precision floating-point
+    number (in radians).
 
     The half-value coversed cosine is defined as `(1 + sin(x)) / 2`.
 
@@ -12,7 +13,7 @@
     Returns
     -------
     y: number
-        Half-value coversed cosine of a single-precision floating-point number (in radians).
+        Half-value coversed cosine.
 
     Examples
     --------

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

@@ -29,24 +29,24 @@
 * @returns half-value coversed cosine
 *
 * @example
-* var v = hacovercos( 0.0 );
+* var v = hacovercosf( 0.0 );
 * // returns 0.5
 *
 * @example
-* var v = hacovercos( 3.141592653589793/2.0 );
+* var v = hacovercosf( 3.141592653589793/2.0 );
 * // returns 1.0
 *
 * @example
-* var v = hacovercos( -3.141592653589793/6.0 );
+* var v = hacovercosf( -3.141592653589793/6.0 );
 * // returns 0.25
 *
 * @example
-* var v = hacovercos( NaN );
+* var v = hacovercosf( NaN );
 * // returns NaN
 */
-declare function hacovercos( x: number ): number;
+declare function hacovercosf( x: number ): number;
 
 
 // EXPORTS //
 
-export = hacovercos;
+export = hacovercosf;