time-to-botec

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

index.js (1108B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Compute the arctangent of a number.
     23 *
     24 * @module @stdlib/math/base/special/atan
     25 *
     26 * @example
     27 * var PI = require( '@stdlib/constants/float64/pi' );
     28 * var atan = require( '@stdlib/math/base/special/atan' );
     29 *
     30 * var v = atan( 0.0 );
     31 * // returns ~0.0
     32 *
     33 * v = atan( -PI/4.0 );
     34 * // returns ~-0.666
     35 *
     36 * v = atan( PI/4.0 );
     37 * // returns ~0.666
     38 *
     39 * v = atan( NaN );
     40 * // returns NaN
     41 */
     42 
     43 // MODULES //
     44 
     45 var atan = require( './atan.js' );
     46 
     47 
     48 // EXPORTS //
     49 
     50 module.exports = atan;