time-to-botec

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

main.js (1340B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2020 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 
     20 'use strict';
     21 
     22 // MODULES //
     23 
     24 var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
     25 var cbrt = require( './../../../../base/special/cbrt' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Computes the cube root of a single-precision floating-point number.
     32 *
     33 * @param {number} x - input value
     34 * @returns {number} cube root
     35 *
     36 * @example
     37 * var v = cbrtf( 64.0 );
     38 * // returns 4.0
     39 *
     40 * @example
     41 * var v = cbrtf( 27.0 );
     42 * // returns 3.0
     43 *
     44 * @example
     45 * var v = cbrtf( 0.0 );
     46 * // returns 0.0
     47 *
     48 * @example
     49 * var v = cbrtf( -9.0 );
     50 * // returns ~-2.08
     51 *
     52 * @example
     53 * var v = cbrtf( NaN );
     54 * // returns NaN
     55 */
     56 function cbrtf( x ) {
     57 	return float64ToFloat32( cbrt( float64ToFloat32( x ) ) );
     58 }
     59 
     60 
     61 // EXPORTS //
     62 
     63 module.exports = cbrtf;