@stdlib/strided/base/dmskmap2/docs/types/index.d.ts

Strided.

/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Callback invoked for indexed strided input array elements.
*
* @param x - strided array element
* @param y - strided array element
* @returns result
*/
type Binary = ( x: number, y: number ) => number;

/**
* Interface describing `dmskmap2`.
*/
interface Routine {
	/**
	* Applies a binary function to double-precision floating-point strided input arrays according to a strided mask array and assigns results to a double-precision floating-point strided output array.
	*
	* @param N - number of indexed elements
	* @param x - input array
	* @param strideX - `x` stride length
	* @param y - input array
	* @param strideY - `y` stride length
	* @param mask - mask array
	* @param strideMask - `mask` stride length
	* @param z - destination array
	* @param strideZ - `z` stride length
	* @param fcn - binary function to apply
	* @returns `z`
	*
	* @example
	* var Float64Array = require( '@stdlib/array/float64' );
	* var Uint8Array = require( '@stdlib/array/uint8' );
	* var add = require( '@stdlib/math/base/ops/add' );
	*
	* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
	* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
	* var z = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
	* var m = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
	*
	* dmskmap2( x.length, x, 1, m, 1, y, 1, add );
	* // z => <Float64Array>[ 2.0, 4.0, 0.0, 8.0, 10.0 ]
	*/
	( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number, mask: Uint8Array, strideMask: number, z: Float64Array, strideZ: number, fcn: Binary ): Float64Array;

	/**
	* Applies a binary function to double-precision floating-point strided input arrays according to a strided mask array and assigns results to a double-precision floating-point strided output array using alternative indexing semantics.
	*
	* @param N - number of indexed elements
	* @param x - input array
	* @param strideX - `x` stride length
	* @param offsetX - starting index for `x`
	* @param y - input array
	* @param strideY - `y` stride length
	* @param offsetY - starting index for `y`
	* @param mask - mask array
	* @param strideMask - `mask` stride length
	* @param offsetMask - staring index for `mask`
	* @param z - destination array
	* @param strideZ - `z` stride length
	* @param offsetZ - starting index for `z`
	* @param fcn - binary function to apply
	* @returns `z`
	*
	* @example
	* var Float64Array = require( '@stdlib/array/float64' );
	* var Uint8Array = require( '@stdlib/array/uint8' );
	* var add = require( '@stdlib/math/base/ops/add' );
	*
	* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
	* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
	* var z = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
	* var m = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
	*
	* dmskmap2.ndarray( x.length, x, 1, 0, y, 1, 0, m, 1, 0, z, 1, 0, add );
	* // z => <Float64Array>[ 2.0, 4.0, 0.0, 8.0, 10.0 ]
	*/
	ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number, mask: Uint8Array, strideMask: number, offsetMask: number, z: Float64Array, strideZ: number, offsetZ: number, fcn: Binary ): Float64Array;
}

/**
* Applies a binary function to double-precision floating-point strided input arrays according to a strided mask array and assigns results to a double-precision floating-point strided output array
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param y - input array
* @param strideY - `y` stride length
* @param mask - mask array
* @param strideMask - `mask` stride length
* @param z - destination array
* @param strideZ - `z` stride length
* @param fcn - binary function to apply
* @returns `z`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var Uint8Array = require( '@stdlib/array/uint8' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var m = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
*
* dmskmap2( x.length, x, 1, m, 1, y, 1, add );
* // z => <Float64Array>[ 2.0, 4.0, 0.0, 8.0, 10.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var Uint8Array = require( '@stdlib/array/uint8' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var z = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var m = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
*
* dmskmap2.ndarray( x.length, x, 1, 0, y, 1, 0, m, 1, 0, z, 1, 0, add );
* // z => <Float64Array>[ 2.0, 4.0, 0.0, 8.0, 10.0 ]
*/
declare var dmskmap2: Routine;


// EXPORTS //

export = dmskmap2;