Auto-generated commit

base/special/cotd/README.md

@@ -0,0 +1,101 @@
+<!--
+
+@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.
+
+-->
+
+# cotd
+
+> Compute the [cotangent][trigonometric-functions] of an angle measured in degrees.
+
+<section class="intro">
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cotd = require( '@stdlib/math/base/special/cotd' );
+```
+
+#### cotd( x )
+
+Evaluates the [cotangent][trigonometric-functions] of `x` (in degrees).
+
+```javascript
+var v = cotd( 0.0 );
+// returns Infinity
+
+v = cotd( 60.0 );
+// returns ~0.58
+
+v = cotd( 90.0 );
+// returns 0.0
+
+v = cotd( NaN );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var linspace = require( '@stdlib/array/base/linspace' );
+var cotd = require( '@stdlib/math/base/special/cotd' );
+
+var x = linspace( -180, 180, 100 );
+
+var i;
+for ( i = 0; i < x.length; i++ ) {
+    console.log( cotd( x[ i ] ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.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
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

base/special/cotd/benchmark/benchmark.js

@@ -0,0 +1,51 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( './../../../../base/assert/is-nan' );
+var pkg = require( './../package.json' ).name;
+var cotd = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = ( randu()*10.0 ) - 5.0;
+		y = cotd( 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();
+});

base/special/cotd/docs/repl.txt

@@ -0,0 +1,28 @@
+
+{{alias}}( x )
+    Computes the cotangent of an angle measured in degrees.
+
+    Parameters
+    ----------
+    x: number
+        Input value (in degrees).
+
+    Returns
+    -------
+    y: number
+        Cotangent.
+
+    Examples
+    --------
+    > var y = {{alias}}( 0.0 )
+    Infinity
+    > y = {{alias}}( 90.0 )
+    0.0
+    > y = {{alias}}( 60.0 )
+    ~0.58
+    > y = {{alias}}( NaN )
+    NaN
+
+    See Also
+    --------
+

base/special/cotd/docs/types/index.d.ts

@@ -0,0 +1,48 @@
+/*
+* @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 cotangent of an angle measured in degrees
+*
+* @param x - input value (in degrees)
+* @returns cotangent
+ *
+ * @example
+ * var v = cotd( 0.0 );
+ * // returns Infinity
+ *
+ * @example
+ * var v = cotd( 60.0 );
+ * // returns ~0.58
+ *
+ * @example
+ * var v = cotd( 90.0 );
+ * // returns 0.0
+ *
+ * @example
+ * var v = cotd( NaN );
+ * // returns NaN
+*/
+declare function cotd( x: number ): number;
+
+
+// EXPORTS //
+
+export = cotd;

base/special/cotd/docs/types/test.ts

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

base/special/cotd/examples/index.js

@@ -0,0 +1,29 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+var linspace = require( '@stdlib/array/base/linspace' );
+var cotd = require( './../lib' );
+
+var x = linspace( -180, 180, 100 );
+
+var i;
+for ( i = 0; i < x.length; i++ ) {
+	console.log( 'cotd(%d) = %d', x[ i ], cotd( x[ i ] ) );
+}

base/special/cotd/lib/index.js

@@ -0,0 +1,52 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+/**
+* Compute the cotangent of an angle measured in degrees.
+*
+* @module @stdlib/math/base/special/cotd
+*
+* @example
+* var cotd = require( '@stdlib/math/base/special/cotd' );
+*
+* var v = cotd( 0.0 );
+* // returns Infinity
+*
+* v = cotd( 45.0 );
+* // returns 1.0
+*
+* v = cotd( 90.0 );
+* // returns 0.0
+*
+* v = cotd( 60.0 );
+* // returns ~0.58
+*
+* v = cotd( NaN );
+* // returns NaN
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;