time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (1481B)


      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2020 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # acot
     22 
     23 > Compute the [inverse cotangent][arccotangent] of a number.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var acot = require( '@stdlib/math/base/special/acot' );
     31 ```
     32 
     33 #### acot( x )
     34 
     35 Computes the [inverse cotangent][arccotangent] of a `number` (in radians).
     36 
     37 ```javascript
     38 var v = acot( 2.0 );
     39 // returns ~0.4636
     40 
     41 v = acot( Infinity );
     42 // returns 0.0
     43 ```
     44 
     45 </section>
     46 
     47 <!-- /.usage -->
     48 
     49 <section class="examples">
     50 
     51 ## Examples
     52 
     53 <!-- eslint no-undef: "error" -->
     54 
     55 ```javascript
     56 var linspace = require( '@stdlib/array/linspace' );
     57 var acot = require( '@stdlib/math/base/special/acot' );
     58 
     59 var x = linspace( -5.0, 5.0, 100 );
     60 var i;
     61 
     62 for ( i = 0; i < x.length; i++ ) {
     63     console.log( acot( x[ i ] ) );
     64 }
     65 ```
     66 
     67 </section>
     68 
     69 <!-- /.examples -->
     70 
     71 <section class="links">
     72 
     73 [arccotangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
     74 
     75 </section>
     76 
     77 <!-- /.links -->