@stdlib/stats-strided-scuminabs 0.1.0

package/docs/types/index.d.ts

@@ -0,0 +1,103 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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
+
+/**
+* Interface describing `scuminabs`.
+*/
+interface Routine {
+	/**
+	* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+	*
+	* @param N - number of indexed elements
+	* @param x - input array
+	* @param strideX - `x` stride length
+	* @param y - output array
+	* @param strideY - `y` stride length
+	* @returns output array
+	*
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+	* var y = new Float32Array( x.length );
+	*
+	* scuminabs( x.length, x, 1, y, 1 );
+	* // y => <Float32Array>[ 1.0, 1.0, 1.0 ]
+	*/
+	( N: number, x: Float32Array, strideX: number, y: Float32Array, strideY: number ): Float32Array;
+
+	/**
+	* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements 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 - output array
+	* @param strideY - `y` stride length
+	* @param offsetY - starting index for `y`
+	* @returns output array
+	*
+	* @example
+	* var Float32Array = require( '@stdlib/array-float32' );
+	*
+	* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+	* var y = new Float32Array( x.length );
+	*
+	* scuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
+	* // y => <Float32Array>[ 1.0, 1.0, 1.0 ]
+	*/
+	ndarray( N: number, x: Float32Array, strideX: number, offsetX: number, y: Float32Array, strideY: number, offsetY: number ): Float32Array;
+}
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*
+* @param N - number of indexed elements
+* @param x - input array
+* @param strideX - `x` stride length
+* @param y - output array
+* @param strideY - `y` stride length
+* @returns output array
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+*
+* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+* var y = new Float32Array( x.length );
+*
+* scuminabs( x.length, x, 1, y, 1 );
+* // y => <Float32Array>[ 1.0, 1.0, 1.0 ]
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+*
+* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+* var y = new Float32Array( x.length );
+*
+* scuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
+* // y => <Float32Array>[ 1.0, 1.0, 1.0 ]
+*/
+declare var scuminabs: Routine;
+
+
+// EXPORTS //
+
+export = scuminabs;

package/include/stdlib/stats/strided/scuminabs.h

@@ -0,0 +1,45 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+#ifndef STDLIB_STATS_STRIDED_SCUMINABS_H
+#define STDLIB_STATS_STRIDED_SCUMINABS_H
+
+#include "stdlib/blas/base/shared.h"
+
+/*
+* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*/
+void API_SUFFIX(stdlib_strided_scuminabs)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY );
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements using alternative indexing semantics.
+*/
+void API_SUFFIX(stdlib_strided_scuminabs_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_STATS_STRIDED_SCUMINABS_H

package/lib/index.js

@@ -0,0 +1,70 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+/**
+* Compute the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*
+* @module @stdlib/stats-strided-scuminabs
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+* var scuminabs = require( '@stdlib/stats-strided-scuminabs' );
+*
+* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+* var y = new Float32Array( x.length );
+*
+* scuminabs( x.length, x, 1, y, 1 );
+* // y => <Float32Array>[ 1.0, 1.0, 1.0 ]
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+* var scuminabs = require( '@stdlib/stats-strided-scuminabs' );
+*
+* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
+* var y = new Float32Array( x.length );
+*
+* scuminabs.ndarray( 4, x, 2, 1, y, 1, 0 );
+* // y => <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]
+*/
+
+// MODULES //
+
+var join = require( 'path' ).join;
+var tryRequire = require( '@stdlib/utils-try-require' );
+var isError = require( '@stdlib/assert-is-error' );
+var main = require( './main.js' );
+
+
+// MAIN //
+
+var scuminabs;
+var tmp = tryRequire( join( __dirname, './native.js' ) );
+if ( isError( tmp ) ) {
+	scuminabs = main;
+} else {
+	scuminabs = tmp;
+}
+
+
+// EXPORTS //
+
+module.exports = scuminabs;
+
+// exports: { "ndarray": "scuminabs.ndarray" }

package/lib/main.js

@@ -0,0 +1,35 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var scuminabs = require( './scuminabs.js' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+setReadOnly( scuminabs, 'ndarray', ndarray );
+
+
+// EXPORTS //
+
+module.exports = scuminabs;

package/lib/native.js

@@ -0,0 +1,35 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var scuminabs = require( './scuminabs.native.js' );
+var ndarray = require( './ndarray.native.js' );
+
+
+// MAIN //
+
+setReadOnly( scuminabs, 'ndarray', ndarray );
+
+
+// EXPORTS //
+
+module.exports = scuminabs;

package/lib/ndarray.js

@@ -0,0 +1,95 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
+var absf = require( '@stdlib/math-base-special-absf' );
+
+
+// MAIN //
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Float32Array} x - input array
+* @param {integer} strideX - `x` stride length
+* @param {NonNegativeInteger} offsetX - starting index for `x`
+* @param {Float32Array} y - output array
+* @param {integer} strideY - `y` stride length
+* @param {NonNegativeInteger} offsetY - starting index for `y`
+* @returns {Float32Array} output array
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+*
+* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
+* var y = new Float32Array( x.length );
+*
+* var v = scuminabs( 4, x, 2, 1, y, 1, 0 );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]
+*/
+function scuminabs( N, x, strideX, offsetX, y, strideY, offsetY ) {
+	var min;
+	var ix;
+	var iy;
+	var v;
+	var i;
+
+	if ( N <= 0 ) {
+		return y;
+	}
+	ix = offsetX;
+	iy = offsetY;
+
+	min = absf( x[ ix ] );
+	y[ iy ] = min;
+
+	iy += strideY;
+	i = 1;
+	if ( isnanf( min ) === false ) {
+		for ( i; i < N; i++ ) {
+			ix += strideX;
+			v = absf( x[ ix ] );
+			if ( isnanf( v ) ) {
+				min = v;
+				break;
+			}
+			if ( v < min ) {
+				min = v;
+			}
+			y[ iy ] = min;
+			iy += strideY;
+		}
+	}
+	if ( isnanf( min ) ) {
+		for ( i; i < N; i++ ) {
+			y[ iy ] = min;
+			iy += strideY;
+		}
+	}
+	return y;
+}
+
+
+// EXPORTS //
+
+module.exports = scuminabs;

package/lib/ndarray.native.js

@@ -0,0 +1,57 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Float32Array} x - input array
+* @param {integer} strideX - `x` stride length
+* @param {NonNegativeInteger} offsetX - starting index for `x`
+* @param {Float32Array} y - output array
+* @param {integer} strideY - `y` stride length
+* @param {NonNegativeInteger} offsetY - starting index for `y`
+* @returns {Float32Array} output array
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+*
+* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
+* var y = new Float32Array( x.length );
+*
+* var v = scuminabs( 4, x, 2, 1, y, 1, 0 );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]
+*/
+function scuminabs( N, x, strideX, offsetX, y, strideY, offsetY ) {
+	addon.ndarray( N, x, strideX, offsetX, y, strideY, offsetY );
+	return y;
+}
+
+
+// EXPORTS //
+
+module.exports = scuminabs;

package/lib/scuminabs.js

@@ -0,0 +1,57 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var stride2offset = require( '@stdlib/strided-base-stride2offset' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Float32Array} x - input array
+* @param {integer} strideX - `x` stride length
+* @param {Float32Array} y - output array
+* @param {integer} strideY - `y` stride length
+* @returns {Float32Array} output array
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+*
+* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+* var y = new Float32Array( x.length );
+*
+* var v = scuminabs( x.length, x, 1, y, 1 );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0 ]
+*/
+function scuminabs( N, x, strideX, y, strideY ) {
+	var ox = stride2offset( N, strideX );
+	var oy = stride2offset( N, strideY );
+	return ndarray( N, x, strideX, ox, y, strideY, oy );
+}
+
+
+// EXPORTS //
+
+module.exports = scuminabs;

package/lib/scuminabs.native.js

@@ -0,0 +1,55 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Computes the cumulative minimum absolute value of single-precision floating-point strided array elements.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Float32Array} x - input array
+* @param {integer} strideX - `x` stride length
+* @param {Float32Array} y - output array
+* @param {integer} strideY - `y` stride length
+* @returns {Float32Array} output array
+*
+* @example
+* var Float32Array = require( '@stdlib/array-float32' );
+*
+* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
+* var y = new Float32Array( x.length );
+*
+* var v = scuminabs( x.length, x, 1, y, 1 );
+* // returns <Float32Array>[ 1.0, 1.0, 1.0 ]
+*/
+function scuminabs( N, x, strideX, y, strideY ) {
+	addon( N, x, strideX, y, strideY );
+	return y;
+}
+
+
+// EXPORTS //
+
+module.exports = scuminabs;

package/manifest.json

@@ -0,0 +1,106 @@
+{
+  "options": {
+    "task": "build",
+    "wasm": false
+  },
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "task": "build",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nanf",
+        "@stdlib/math-base-special-absf",
+        "@stdlib/blas-base-shared",
+        "@stdlib/strided-base-stride2offset",
+        "@stdlib/napi-export",
+        "@stdlib/napi-argv",
+        "@stdlib/napi-argv-int64",
+        "@stdlib/napi-argv-strided-float32array"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nanf",
+        "@stdlib/math-base-special-absf",
+        "@stdlib/blas-base-shared",
+        "@stdlib/strided-base-stride2offset"
+      ]
+    },
+    {
+      "task": "examples",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nanf",
+        "@stdlib/math-base-special-absf",
+        "@stdlib/blas-base-shared",
+        "@stdlib/strided-base-stride2offset"
+      ]
+    },
+    {
+      "task": "",
+      "wasm": true,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nanf",
+        "@stdlib/math-base-special-absf",
+        "@stdlib/blas-base-shared",
+        "@stdlib/strided-base-stride2offset"
+      ]
+    }
+  ]
+}