feat: add C implementation for blas/ext/base/ndarray/ztril

lib/node_modules/@stdlib/blas/ext/base/ndarray/ztril/README.md

@@ -50,7 +50,7 @@ var A = new Complex128Matrix( [ [ 1.0, 2.0, 3.0, 4.0 ], [ 5.0, 6.0, 7.0, 8.0 ] ]
 var B = new Complex128Matrix( [ [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] );
 
 var k = scalar2ndarray( 0, {
-    'dtype': 'generic'
+    'dtype': 'int32'
 });
 
 var out = ztril( [ A, B, k ] );
@@ -108,7 +108,7 @@ var B = new Complex128Matrix( discreteUniform( 5*5*2, -50, 50, opts ).buffer, 0,
 console.log( ndarray2array( B ) );
 
 var k = scalar2ndarray( 0, {
-    'dtype': 'generic'
+    'dtype': 'int32'
 });
 
 var out = ztril( [ A, B, k ] );
@@ -119,6 +119,200 @@ console.log( ndarray2array( out ) );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/ndarray/ztril.h"
+```
+
+#### stdlib_blas_ext_ztril( arrays )
+
+Copies the lower triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`.
+
+```c
+#include "stdlib/ndarray/ctor.h"
+#include "stdlib/ndarray/dtypes.h"
+#include "stdlib/ndarray/index_modes.h"
+#include "stdlib/ndarray/orders.h"
+#include "stdlib/ndarray/base/bytes_per_element.h"
+#include "stdlib/complex/float64/ctor.h"
+#include <stdint.h>
+
+// Create ndarrays:
+const stdlib_complex128_t dataA[] = {
+    stdlib_complex128( 1.0, 1.0 ),
+    stdlib_complex128( 2.0, 2.0 ),
+    stdlib_complex128( 3.0, 3.0 ),
+    stdlib_complex128( 4.0, 4.0 )
+};
+stdlib_complex128_t dataB[] = {
+    stdlib_complex128( 0.0, 0.0 ),
+    stdlib_complex128( 0.0, 0.0 ),
+    stdlib_complex128( 0.0, 0.0 ),
+    stdlib_complex128( 0.0, 0.0 )
+};
+int32_t dataK[] = { 0 };
+int64_t shape[] = { 2, 2 };
+int64_t strides[] = { 2 * STDLIB_NDARRAY_COMPLEX128_BYTES_PER_ELEMENT, STDLIB_NDARRAY_COMPLEX128_BYTES_PER_ELEMENT };
+int64_t kstrides[] = { 0 };
+int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };
+
+struct ndarray *A = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX128, (uint8_t *)dataA, 2, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );
+struct ndarray *B = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX128, (uint8_t *)dataB, 2, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );
+struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)dataK, 0, NULL, kstrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );
+
+// Perform computation:
+const struct ndarray *arrays[] = { A, B, k };
+stdlib_blas_ext_ztril( arrays );
+
+// Free allocated memory:
+stdlib_ndarray_free( A );
+stdlib_ndarray_free( B );
+stdlib_ndarray_free( k );
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: `[in] struct ndarray**` list containing the following ndarrays:
+
+    -   `[in] struct ndarray*` a two-dimensional input ndarray corresponding to `A`.
+    -   `[inout] struct ndarray*` a two-dimensional output ndarray corresponding to `B`.
+    -   `[in] struct ndarray*` a zero-dimensional ndarray specifying the diagonal above which to ignore.
+
+```c
+void stdlib_blas_ext_ztril( const struct ndarray *arrays[] );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+### Notes
+
+-   Elements outside of the copied region are left unchanged.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/ndarray/ztril.h"
+#include "stdlib/ndarray/ctor.h"
+#include "stdlib/ndarray/dtypes.h"
+#include "stdlib/ndarray/index_modes.h"
+#include "stdlib/ndarray/orders.h"
+#include "stdlib/ndarray/base/bytes_per_element.h"
+#include "stdlib/complex/float64/ctor.h"
+#include "stdlib/complex/float64/real.h"
+#include "stdlib/complex/float64/imag.h"
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+int main( void ) {
+    // Create data buffers:
+    const stdlib_complex128_t dataA[] = {
+        stdlib_complex128( 1.0, 1.0 ),
+        stdlib_complex128( 2.0, 2.0 ),
+        stdlib_complex128( 3.0, 3.0 ),
+        stdlib_complex128( 4.0, 4.0 )
+    };
+    stdlib_complex128_t dataB[] = {
+        stdlib_complex128( 0.0, 0.0 ),
+        stdlib_complex128( 0.0, 0.0 ),
+        stdlib_complex128( 0.0, 0.0 ),
+        stdlib_complex128( 0.0, 0.0 )
+    };
+    int32_t dataK[] = { 0 };
+
+    // Specify the number of matrix dimensions:
+    const int64_t ndims = 2;
+
+    // Specify the matrix shape:
+    int64_t shape[] = { 2, 2 };
+
+    // Specify the array strides (in bytes):
+    int64_t strides[] = { 2 * STDLIB_NDARRAY_COMPLEX128_BYTES_PER_ELEMENT, STDLIB_NDARRAY_COMPLEX128_BYTES_PER_ELEMENT };
+    int64_t kstrides[] = { 0 };
+
+    // Specify the byte offset:
+    const int64_t offset = 0;
+
+    // Specify the array order:
+    const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR;
+
+    // Specify the index mode:
+    const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR;
+
+    // Specify the subscript index modes:
+    int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };
+    const int64_t nsubmodes = 1;
+
+    // Create ndarrays:
+    struct ndarray *A = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX128, (uint8_t *)dataA, ndims, shape, strides, offset, order, imode, nsubmodes, submodes );
+    struct ndarray *B = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX128, (uint8_t *)dataB, ndims, shape, strides, offset, order, imode, nsubmodes, submodes );
+    struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)dataK, 0, NULL, kstrides, offset, order, imode, nsubmodes, submodes );
+    if ( A == NULL || B == NULL || k == NULL ) {
+        fprintf( stderr, "Error allocating memory.\n" );
+        exit( 1 );
+    }
+
+    // Define a list of ndarrays:
+    const struct ndarray *arrays[] = { A, B, k };
+
+    // Copy the lower triangular part of A into B:
+    stdlib_blas_ext_ztril( arrays );
+
+    // Print the output buffer:
+    for ( int i = 0; i < 4; i++ ) {
+        printf( "dataB[ %i ] = (%lf, %lf)\n", i, stdlib_complex128_real( dataB[ i ] ), stdlib_complex128_imag( dataB[ i ] ) );
+    }
+
+    // Free allocated memory:
+    stdlib_ndarray_free( A );
+    stdlib_ndarray_free( B );
+    stdlib_ndarray_free( k );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

lib/node_modules/@stdlib/blas/ext/base/ndarray/ztril/benchmark/benchmark.js

@@ -29,7 +29,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
 var format = require( '@stdlib/string/format' );
 var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 var pkg = require( './../package.json' ).name;
-var ztril = require( './../lib' );
+var ztril = require( './../lib/main.js' );
 
 
 // VARIABLES //
@@ -61,7 +61,7 @@ function createBenchmark( N ) {
 	B = new Complex128Matrix( bbuf.buffer, 0, N, N );
 
 	k = scalar2ndarray( 0, {
-		'dtype': 'generic'
+		'dtype': 'int32'
 	});
 
 	return benchmark;

lib/node_modules/@stdlib/blas/ext/base/ndarray/ztril/benchmark/benchmark.native.js

@@ -0,0 +1,124 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var Complex128Matrix = require( '@stdlib/ndarray/matrix/complex128' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var real = require( '@stdlib/complex/float64/real' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var ztril = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( ztril instanceof Error )
+};
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} N - number of elements along each dimension
+* @returns {Function} benchmark function
+*/
+function createBenchmark( N ) {
+	var abuf;
+	var bbuf;
+	var A;
+	var B;
+	var k;
+
+	abuf = uniform( N*N*2, -100.0, 100.0, options );
+	bbuf = uniform( N*N*2, -100.0, 100.0, options );
+	A = new Complex128Matrix( abuf.buffer, 0, N, N );
+	B = new Complex128Matrix( bbuf.buffer, 0, N, N );
+	k = scalar2ndarray( 0, {
+		'dtype': 'int32'
+	});
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = ztril( [ A, B, k ] );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( isnan( real( out.get( i%N, i%N ) ) ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var min;
+	var max;
+	var N;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 3; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		N = pow( 10, i );
+		f = createBenchmark( N );
+		bench( format( '%s::native:size=%d', pkg, N*N ), opts, f );
+	}
+}
+
+main();