time-to-botec

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

index.js (1236B)


      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 * Return a boolean indicating if the sign bit is on (true) or off (false).
     23 *
     24 * @module @stdlib/number/float32/base/signbit
     25 *
     26 * @example
     27 * var signbitf = require( '@stdlib/number/float32/base/signbit' );
     28 * var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
     29 *
     30 * var bool = signbitf( toFloat32( 4.0 ) );
     31 * // returns false
     32 *
     33 * bool = signbitf( toFloat32( -9.14e-34 ) );
     34 * // returns true
     35 *
     36 * bool = signbitf( 0.0 );
     37 * // returns false
     38 *
     39 * bool = signbitf( -0.0 );
     40 * // returns true
     41 */
     42 
     43 // MODULES //
     44 
     45 var signbitf = require( './main.js' );
     46 
     47 
     48 // EXPORTS //
     49 
     50 module.exports = signbitf;