@stdlib/blas-ext-base-cfill 0.1.0

package/docs/types/index.d.ts

@@ -0,0 +1,112 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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
+
+/// <reference types="@stdlib/types"/>
+
+import { Complex64Array } from '@stdlib/types/array';
+import { Complex64 } from '@stdlib/types/complex';
+
+/**
+* Interface describing `cfill`.
+*/
+interface Routine {
+	/**
+	* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+	*
+	* @param N - number of indexed elements
+	* @param alpha - scalar constant
+	* @param x - input array
+	* @param strideX - stride length
+	* @returns input array
+	*
+	* @example
+	* var Complex64Array = require( '@stdlib/array-complex64' );
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+	*
+	* var alpha = new Complex64( 10.0, 10.0 );
+	*
+	* cfill( x.length, alpha, x, 1 );
+	* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+	*/
+	( N: number, alpha: Complex64, x: Complex64Array, strideX: number ): Complex64Array;
+
+	/**
+	* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+	*
+	* @param N - number of indexed elements
+	* @param alpha - scalar constant
+	* @param x - input array
+	* @param strideX - stride length
+	* @param offsetX - starting index
+	* @returns input array
+	*
+	* @example
+	* var Complex64Array = require( '@stdlib/array-complex64' );
+	* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+	*
+	* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+	*
+	* var alpha = new Complex64( 10.0, 10.0 );
+	*
+	* cfill.ndarray( x.length, alpha, x, 1, 0 );
+	* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+	*/
+	ndarray( N: number, alpha: Complex64, x: Complex64Array, strideX: number, offsetX: number ): Complex64Array;
+}
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+*
+* @param N - number of indexed elements
+* @param alpha - scalar constant
+* @param x - input array
+* @param strideX - stride length
+* @returns input array
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill( x.length, alpha, x, 1 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill.ndarray( x.length, alpha, x, 1, 0 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+*/
+declare var cfill: Routine;
+
+
+// EXPORTS //
+
+export = cfill;

package/include/stdlib/blas/ext/base/cfill.h

@@ -0,0 +1,46 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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_BLAS_EXT_BASE_CFILL_H
+#define STDLIB_BLAS_EXT_BASE_CFILL_H
+
+#include "stdlib/complex/float32/ctor.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
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+*/
+void API_SUFFIX(stdlib_strided_cfill)( const CBLAS_INT N, const stdlib_complex64_t alpha, stdlib_complex64_t *X, const CBLAS_INT strideX );
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant using alternative indexing semantics.
+*/
+void API_SUFFIX(stdlib_strided_cfill_ndarray)( const CBLAS_INT N, const stdlib_complex64_t alpha, stdlib_complex64_t *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_BLAS_EXT_BASE_CFILL_H

package/lib/cfill.js

@@ -0,0 +1,56 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 //
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {ComplexLike} alpha - scalar constant
+* @param {Complex64Array} x - input array
+* @param {integer} strideX - stride length
+* @returns {Complex64Array} input array
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill( x.length, alpha, x, 1 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+*/
+function cfill( N, alpha, x, strideX ) {
+	return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) );
+}
+
+
+// EXPORTS //
+
+module.exports = cfill;

package/lib/cfill.native.js

@@ -0,0 +1,58 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
+var addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {ComplexLike} alpha - scalar constant
+* @param {Complex64Array} x - input array
+* @param {integer} strideX - stride length
+* @returns {Complex64Array} input array
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill( x.length, alpha, x, 1 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+*/
+function cfill( N, alpha, x, strideX ) {
+	var view = reinterpret( x, 0 );
+	addon( N, alpha, view, strideX );
+	return x;
+}
+
+
+// EXPORTS //
+
+module.exports = cfill;

package/lib/index.js

@@ -0,0 +1,62 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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';
+
+/**
+* Fill a single-precision complex floating-point strided array with a specified scalar constant.
+*
+* @module @stdlib/blas-ext-base-cfill
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+* var cfill = require( '@stdlib/blas-ext-base-cfill' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill( x.length, alpha, x, 1 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.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 cfill;
+var tmp = tryRequire( join( __dirname, './native.js' ) );
+if ( isError( tmp ) ) {
+	cfill = main;
+} else {
+	cfill = tmp;
+}
+
+
+// EXPORTS //
+
+module.exports = cfill;
+
+// exports: { "ndarray": "cfill.ndarray" }

package/lib/main.js

@@ -0,0 +1,35 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 cfill = require( './cfill.js' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+setReadOnly( cfill, 'ndarray', ndarray );
+
+
+// EXPORTS //
+
+module.exports = cfill;

package/lib/native.js

@@ -0,0 +1,35 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 cfill = require( './cfill.native.js' );
+var ndarray = require( './ndarray.native.js' );
+
+
+// MAIN //
+
+setReadOnly( cfill, 'ndarray', ndarray );
+
+
+// EXPORTS //
+
+module.exports = cfill;

package/lib/ndarray.js

@@ -0,0 +1,126 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
+var realf = require( '@stdlib/complex-float32-real' );
+var imagf = require( '@stdlib/complex-float32-imag' );
+
+
+// VARIABLES //
+
+var M = 8;
+
+
+// MAIN //
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {ComplexLike} alpha - scalar constant
+* @param {Complex64Array} x - input array
+* @param {integer} strideX - stride length
+* @param {NonNegativeInteger} offsetX - starting index
+* @returns {Complex64Array} input array
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill( x.length, alpha, x, 1, 0 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+*/
+function cfill( N, alpha, x, strideX, offsetX ) {
+	var view;
+	var re;
+	var im;
+	var ix;
+	var m;
+	var i;
+
+	if ( N <= 0 ) {
+		return x;
+	}
+
+	// Decompose the constant into its real and imaginary components:
+	re = realf( alpha );
+	im = imagf( alpha );
+
+	// Reinterpret the complex input array as a real-valued array:
+	view = reinterpret( x, 0 );
+
+	// Adjust the stride and offset according to real-valued array:
+	ix = offsetX * 2;
+	strideX *= 2;
+
+	// Use loop unrolling if the stride is equal to `2`...
+	if ( strideX === 2 ) {
+		m = N % M;
+
+		// If we have a remainder, run a clean-up loop...
+		if ( m > 0 ) {
+			for ( i = 0; i < m; i++ ) {
+				view[ ix ] = re;
+				view[ ix+1 ] = im;
+				ix += strideX;
+			}
+		}
+		if ( N < M ) {
+			return x;
+		}
+		for ( i = m; i < N; i += M ) {
+			view[ ix ] = re;
+			view[ ix+1 ] = im;
+			view[ ix+2 ] = re;
+			view[ ix+3 ] = im;
+			view[ ix+4 ] = re;
+			view[ ix+5 ] = im;
+			view[ ix+6 ] = re;
+			view[ ix+7 ] = im;
+			view[ ix+8 ] = re;
+			view[ ix+9 ] = im;
+			view[ ix+10 ] = re;
+			view[ ix+11 ] = im;
+			view[ ix+12 ] = re;
+			view[ ix+13 ] = im;
+			view[ ix+14 ] = re;
+			view[ ix+15 ] = im;
+			ix += M * 2;
+		}
+		return x;
+	}
+	for ( i = 0; i < N; i++ ) {
+		view[ ix ] = re;
+		view[ ix+1 ] = im;
+		ix += strideX;
+	}
+	return x;
+}
+
+
+// EXPORTS //
+
+module.exports = cfill;

package/lib/ndarray.native.js

@@ -0,0 +1,59 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
+var addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Fills a single-precision complex floating-point strided array with a specified scalar constant.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {ComplexLike} alpha - scalar constant
+* @param {Complex64Array} x - input array
+* @param {integer} strideX - stride length
+* @param {NonNegativeInteger} offsetX - starting index
+* @returns {Complex64Array} input array
+*
+* @example
+* var Complex64Array = require( '@stdlib/array-complex64' );
+* var Complex64 = require( '@stdlib/complex-float32-ctor' );
+*
+* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
+*
+* var alpha = new Complex64( 10.0, 10.0 );
+*
+* cfill( x.length, alpha, x, 1, 0 );
+* // x => <Complex64Array>[ 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0 ]
+*/
+function cfill( N, alpha, x, strideX, offsetX ) {
+	var view = reinterpret( x, 0 );
+	addon.ndarray( N, alpha, view, strideX, offsetX );
+	return x;
+}
+
+
+// EXPORTS //
+
+module.exports = cfill;

package/manifest.json

@@ -0,0 +1,82 @@
+{
+  "options": {
+    "task": "build"
+  },
+  "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",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/blas-base-shared",
+        "@stdlib/napi-export",
+        "@stdlib/napi-argv",
+        "@stdlib/napi-argv-complex64",
+        "@stdlib/napi-argv-int64",
+        "@stdlib/napi-argv-strided-complex64array",
+        "@stdlib/complex-float32-ctor",
+        "@stdlib/strided-base-stride2offset"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/blas-base-shared",
+        "@stdlib/complex-float32-ctor",
+        "@stdlib/strided-base-stride2offset"
+      ]
+    },
+    {
+      "task": "examples",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/blas-base-shared",
+        "@stdlib/complex-float32-ctor",
+        "@stdlib/strided-base-stride2offset"
+      ]
+    }
+  ]
+}