time-to-botec

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

snanmskmax.native.js (1571B)


      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 'use strict';
     20 
     21 // MODULES //
     22 
     23 var addon = require( './../src/addon.node' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Computes the maximum value of a single-precision floating-point strided array according to a mask, ignoring `NaN` values.
     30 *
     31 * @param {PositiveInteger} N - number of indexed elements
     32 * @param {Float32Array} x - input array
     33 * @param {integer} strideX - `x` stride length
     34 * @param {Uint8Array} mask - mask array
     35 * @param {integer} strideMask - `mask` stride length
     36 * @returns {number} maximum value
     37 *
     38 * @example
     39 * var Float32Array = require( '@stdlib/array/float32' );
     40 * var Uint8Array = require( '@stdlib/array/uint8' );
     41 *
     42 * var x = new Float32Array( [ 1.0, -2.0, 4.0, 2.0, NaN ] );
     43 * var mask = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
     44 *
     45 * var v = snanmskmax( x.length, x, 1, mask, 1 );
     46 * // returns 2.0
     47 */
     48 function snanmskmax( N, x, strideX, mask, strideMask ) {
     49 	return addon( N, x, strideX, mask, strideMask );
     50 }
     51 
     52 
     53 // EXPORTS //
     54 
     55 module.exports = snanmskmax;