|
| 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 | +// TypeScript Version: 4.1 |
| 20 | + |
| 21 | +/** |
| 22 | +* Interface describing `dnancusumkbn2`. |
| 23 | +*/ |
| 24 | +interface Routine { |
| 25 | + /** |
| 26 | + * Computes the cumulative sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm. |
| 27 | + * |
| 28 | + * @param N - number of indexed elements |
| 29 | + * @param sum - initial sum |
| 30 | + * @param x - input array |
| 31 | + * @param strideX - stride length for `x` |
| 32 | + * @param y - output array |
| 33 | + * @param strideY - stride length for `y` |
| 34 | + * @returns output array |
| 35 | + * |
| 36 | + * @example |
| 37 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 38 | + * |
| 39 | + * var x = new Float64Array( [ 1.0, -2.0, NaN ] ); |
| 40 | + * var y = new Float64Array( x.length ); |
| 41 | + * |
| 42 | + * dnancusumkbn2( x.length, 0.0, x, 1, y, 1 ); |
| 43 | + * // y => <Float64Array>[ 1.0, -1.0, -1.0 ] |
| 44 | + */ |
| 45 | + ( N: number, sum: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): Float64Array; |
| 46 | + |
| 47 | + /** |
| 48 | + * Computes the cumulative sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics. |
| 49 | + * |
| 50 | + * @param N - number of indexed elements |
| 51 | + * @param sum - initial sum |
| 52 | + * @param x - input array |
| 53 | + * @param strideX - stride length for `x` |
| 54 | + * @param offsetX - starting index for `x` |
| 55 | + * @param y - output array |
| 56 | + * @param strideY - stride length for `y` |
| 57 | + * @param offsetY - starting index for `y` |
| 58 | + * @returns output array |
| 59 | + * |
| 60 | + * @example |
| 61 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 62 | + * |
| 63 | + * var x = new Float64Array( [ 1.0, -2.0, NaN ] ); |
| 64 | + * var y = new Float64Array( x.length ); |
| 65 | + * |
| 66 | + * dnancusumkbn2.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); |
| 67 | + * // y => <Float64Array>[ 1.0, -1.0, -1.0 ] |
| 68 | + */ |
| 69 | + ndarray( N: number, sum: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): Float64Array; |
| 70 | +} |
| 71 | + |
| 72 | +/** |
| 73 | +* Computes the cumulative sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm. |
| 74 | +* |
| 75 | +* @param N - number of indexed elements |
| 76 | +* @param sum - initial sum |
| 77 | +* @param x - input array |
| 78 | +* @param strideX - stride length for `x` |
| 79 | +* @param y - output array |
| 80 | +* @param strideY - stride length for `y` |
| 81 | +* @returns output array |
| 82 | +* |
| 83 | +* @example |
| 84 | +* var Float64Array = require( '@stdlib/array/float64' ); |
| 85 | +* |
| 86 | +* var x = new Float64Array( [ 1.0, -2.0, NaN ] ); |
| 87 | +* var y = new Float64Array( x.length ); |
| 88 | +* |
| 89 | +* dnancusumkbn2( x.length, 0.0, x, 1, y, 1 ); |
| 90 | +* // y => <Float64Array>[ 1.0, -1.0, -1.0 ] |
| 91 | +* |
| 92 | +* @example |
| 93 | +* var Float64Array = require( '@stdlib/array/float64' ); |
| 94 | +* |
| 95 | +* var x = new Float64Array( [ 1.0, -2.0, NaN ] ); |
| 96 | +* var y = new Float64Array( x.length ); |
| 97 | +* |
| 98 | +* dnancusumkbn2.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); |
| 99 | +* // y => <Float64Array>[ 1.0, -1.0, -1.0 ] |
| 100 | +*/ |
| 101 | +declare var dnancusumkbn2: Routine; |
| 102 | + |
| 103 | + |
| 104 | +// EXPORTS // |
| 105 | + |
| 106 | +export = dnancusumkbn2; |
0 commit comments