dstdevtk.native.js (1415B)
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 standard deviation of a double-precision floating-point strided array using a one-pass textbook algorithm. 30 * 31 * @param {PositiveInteger} N - number of indexed elements 32 * @param {number} correction - degrees of freedom adjustment 33 * @param {Float64Array} x - input array 34 * @param {integer} stride - stride length 35 * @returns {number} standard deviation 36 * 37 * @example 38 * var Float64Array = require( '@stdlib/array/float64' ); 39 * 40 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); 41 * var N = x.length; 42 * 43 * var v = dstdevtk( N, 1, x, 1 ); 44 * // returns ~2.0817 45 */ 46 function dstdevtk( N, correction, x, stride ) { 47 return addon( N, correction, x, stride ); 48 } 49 50 51 // EXPORTS // 52 53 module.exports = dstdevtk;