feat: add math/base/special/sech

Author: gunjjoshi

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

@@ -18,13 +18,9 @@ limitations under the License.
 
 -->
 
-# Hyperbolic Secant
+# sech
 
-> Evaluate the [hyperbolic secant][trigonometric-functions] of a number.
-
-<section class="intro">
-
-</section>
+> Compute the [hyperbolic cosecant][hyperbolic-functions] of a double-precision floating-point number.
 
 <section class="usage">
 
@@ -34,9 +30,9 @@ limitations under the License.
 var sech = require( '@stdlib/math/base/special/sech' );
 ```
 
-## csc( x )
+#### sech( x )
 
-Evaluates the [hyperbolic secant][trigonometric-functions] of `x` (in radians).
+Computes the [hyperbolic cosecant][hyperbolic-functions] of a double-precision floating-point number.
 
 ```javascript
 var v = sech( 0.0 );
@@ -66,7 +62,7 @@ v = sech( NaN );
 var linspace = require( '@stdlib/array/base/linspace' );
 var sech = require( '@stdlib/math/base/special/sech' );
 
-var x = linspace( -10, 10, 100 );
+var x = linspace( -5.0, 5.0, 100 );
 
 var i;
 for ( i = 0; i < x.length; i++ ) {
@@ -78,30 +74,108 @@ for ( i = 0; i < x.length; i++ ) {
 
 <!-- /.examples -->
 
-<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
-
-<section class="related">
+<!-- C interface documentation. -->
 
 * * *
 
-## See Also
+<section class="c">
 
-<span class="package-name">[`@stdlib/math/base/special/cosh`][@stdlib/math/base/special/cosh]</span><span class="delimiter">: </span><span class="description">evaluate the hyperbolic cosine of a number.</span>
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
 
 </section>
 
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/math/base/special/sech.h"
+```
+
+#### stdlib_base_sech( x )
+
+Computes the [hyperbolic cosecant][hyperbolic-functions] of double-precision floating-point number.
+
+```c
+double out = stdlib_base_sech( 2.0 );
+// returns ~0.2658
+
+out = stdlib_base_sech( -2.0 );
+// returns ~0.2658
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+
+```c
+double stdlib_base_sech( const double x );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/math/base/special/sech.h"
+#include <stdio.h>
+
+int main( void ) {
+    const double x[] = { -4.0, -3.11, -2.22, -1.33, -0.44, 0.44, 1.33, 2.22, 3.11, 4.0 };
+    
+    double v;
+    int i;
+    for ( i = 0; i < 10; i++ ) {
+        v = stdlib_base_sech( x[ i ] );
+        printf( "sech(%lf) = %lf\n", x[ i ], v );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
 <!-- /.related -->
 
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 <section class="links">
 
-[trigonometric-functions]: https://en.wikipedia.org/wiki/Trigonometric_functions
+[hyperbolic-functions]: https://en.wikipedia.org/wiki/Hyperbolic_functions
 
 <!-- <related-links> -->
 
-[@stdlib/math/base/special/cosh]: https://github.com/stdlib-js/math/tree/main/base/special/cosh
-
 <!-- </related-links> -->
 
 </section>

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

@@ -21,11 +21,10 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var randu = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var cosh = require( '@stdlib/math/base/special/cosh' );
-var sech = require( './../lib' );
 var pkg = require( './../package.json' ).name;
+var sech = require( './../lib' );
 
 
 // MAIN //
@@ -35,33 +34,13 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
-	b.tic();
-	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu() * 20.0 ) - 10.0;
-		y = sech(x);
-		if ( isnan( y ) ) {
-			b.fail( 'should not return NaN' );
-		}
-	}
-	b.toc();
-	if ( isnan( y ) ) {
-		b.fail( 'should not return NaN' );
-	}
-	b.pass( 'benchmark finished' );
-	b.end();
-});
-
-bench(pkg + '::built-in', function benchmark( b ) {
-	var x;
-	var y;
-	var i;
+	x = randu( 100, -5.0, 5.0 );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu() * 20.0 ) - 10.0;
-		y = 1.0 / cosh( x );
+		y = sech( x[ i % x.length ] );
 		if ( isnan( y ) ) {
-			b.fail('should not return NaN');
+			b.fail( 'should not return NaN' );
 		}
 	}
 	b.toc();

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

@@ -20,31 +20,34 @@
 
 // MODULES //
 
+var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var randu = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
 
 // VARIABLES //
 
-var sech = require( './../lib/native.js' );
+var sech = tryRequire( resolve( __dirname, './../lib/native.js' ) );
 var opts = {
-	'skip': (sech instanceof Error)
+	'skip': ( sech instanceof Error )
 };
 
 
 // MAIN //
 
-bench( pkg + '::native', opts, function benchmark( b ) {
+bench( pkg+'::native', opts, function benchmark( b ) {
 	var x;
 	var y;
 	var i;
 
+	x = randu( 100, -5.0, 5.0 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu() * 10.0 ) - 5.0;
-		y = sech(x);
+		y = sech( x[ i % x.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}