time-to-botec

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

abs.js (1118B)


      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 * Computes the absolute value of `x`.
     23 *
     24 * @param {number} x - input value
     25 * @returns {number} absolute value
     26 *
     27 * @example
     28 * var v = abs( -1.0 );
     29 * // returns 1.0
     30 *
     31 * @example
     32 * var v = abs( 2.0 );
     33 * // returns 2.0
     34 *
     35 * @example
     36 * var v = abs( 0.0 );
     37 * // returns 0.0
     38 *
     39 * @example
     40 * var v = abs( -0.0 );
     41 * // returns -0.0
     42 *
     43 * @example
     44 * var v = abs( NaN );
     45 * // returns NaN
     46 */
     47 function abs( x ) {
     48 	if ( x < 0.0 ) {
     49 		return -x;
     50 	}
     51 	return x;
     52 }
     53 
     54 
     55 // EXPORTS //
     56 
     57 module.exports = abs;