Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -86,7 +86,6 @@ indent_style = tab
 [*.{f,f.txt}]
 indent_style = space
 indent_size = 2
-insert_final_newline = false
 
 # Set properties for shell files:
 [*.{sh,sh.txt}]
@@ -121,7 +120,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]

.github/.keepalive

@@ -50,8 +50,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the sequence of job steps...
     steps:

.github/workflows/test_install.yml

@@ -47,8 +47,8 @@ jobs:
     env:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
-    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
 
     # Define the job's steps:
     steps:

.github/workflows/test_published_package.yml

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-09)
+## Unreleased (2025-02-08)
 
 <section class="features">
 
 ### Features
 
+-   [`924f85a`](https://github.com/stdlib-js/stdlib/commit/924f85ad57aec54ede64c9db9ee96459befa2c00) - add C implementation for `blas/base/ssyr` [(#2877)](https://github.com/stdlib-js/stdlib/pull/2877)
 -   [`4300111`](https://github.com/stdlib-js/stdlib/commit/4300111c80e0bd4941dcdd30a6b6dd36f2250dce) - add `blas/base/ssyr` [(#2658)](https://github.com/stdlib-js/stdlib/pull/2658)
 
 </section>
@@ -22,6 +23,7 @@
 
 <details>
 
+-   [`924f85a`](https://github.com/stdlib-js/stdlib/commit/924f85ad57aec54ede64c9db9ee96459befa2c00) - **feat:** add C implementation for `blas/base/ssyr` [(#2877)](https://github.com/stdlib-js/stdlib/pull/2877) _(by Aman Bhansali, Athan Reines, stdlib-bot)_
 -   [`4ca068f`](https://github.com/stdlib-js/stdlib/commit/4ca068f174225d1eaec123656682589febf1b547) - **test:** update to test for exact equality [(#2864)](https://github.com/stdlib-js/stdlib/pull/2864) _(by Aman Bhansali)_
 -   [`e0cef99`](https://github.com/stdlib-js/stdlib/commit/e0cef995e884021db3001dc1a3cfef0ca7b368c2) - **style:** remove extra spaces for regular expressions in publish script _(by Philipp Burckhardt)_
 -   [`b3a0bd1`](https://github.com/stdlib-js/stdlib/commit/b3a0bd1a3e9bcdde3af048c7d6b6cfcd3765138f) - **docs:** fix example order _(by Athan Reines)_

CHANGELOG.md

@@ -2,12 +2,14 @@
 #
 # Contributors listed in alphabetical order.
 
+Aadish Jain <[email protected]>
 Aayush Khanna <[email protected]>
 Abhijit Raut <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 Ahmed Atwa <[email protected]>
 Ahmed Kashkoush <[email protected]>
+Ahmed Khaled <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
 Aman Bhansali <[email protected]>
@@ -24,6 +26,10 @@ Dan Rose <[email protected]>
 Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
+Desh Deepak Kant <[email protected]>
+Dev Goel <[email protected]>
+Dhruv Arvind Singh <[email protected]>
+Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
@@ -45,22 +51,24 @@ Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
+Karan Anand <[email protected]>
 Karthik Prakash <[email protected]>
-Khaldon <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
-Lovelin <[email protected]>
+Lovelin Dhoni J B <[email protected]>
 Manik Sharma <[email protected]>
 Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
 Matt Cochrane <[email protected]>
 Mihir Pandit <[email protected]>
 Milan Raj <[email protected]>
+Mohammad Bin Aftab <[email protected]>
 Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
 Naresh Jagadeesan <[email protected]>
+Naveen Kumar <[email protected]>
 Neeraj Pathak <[email protected]>
 Nishant Shinde <[email protected]>
 Nithin Katta <[email protected]>
@@ -71,10 +79,11 @@ Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
-Praneki <[email protected]>
-Pratik <[email protected]>
+Pranjal Jha <[email protected]>
+Prashant Kumar Yadav <[email protected]>
+Pratik Singh <[email protected]>
 Pratyush Kumar Chouhan <[email protected]>
-Priyansh <[email protected]>
+Priyansh Prajapati <[email protected]>
 Priyanshu Agarwal <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
 Raunak Kumar Gupta <[email protected]>
@@ -93,7 +102,7 @@ Sarthak Paandey <[email protected]>
 Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shashank Shekhar Singh <[email protected]>
-Shivam <[email protected]>
+Shivam Ahir <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
@@ -112,10 +121,11 @@ UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
 Vinit Pandit <[email protected]>
+Vivek Maurya <[email protected]>
 Xiaochuan Ye <[email protected]>
 Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
-naveen <[email protected]>
 olenkabilonizhka <[email protected]>
+pranav-1720 <[email protected]>
 rainn <[email protected]>
 rei2hu <[email protected]>

CONTRIBUTORS

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2025 The Stdlib Authors.

NOTICE

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2024 The Stdlib Authors.
+Copyright (c) 2025 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.
@@ -216,21 +216,65 @@ console.log( A );
 ### Usage
 
 ```c
-TODO
+#include "stdlib/blas/base/ssyr.h"
 ```
 
-#### TODO
+#### c_ssyr( order, uplo, N, alpha, \*X, strideX, \*A, LDA )
 
-TODO.
+Performs the symmetric rank 1 operation `A = α*x*x^T + A`.
 
 ```c
-TODO
+#include "stdlib/blas/base/shared.h"
+
+float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f };
+const float x[] = { 1.0f, 2.0f, 3.0f };
+
+c_ssyr( CblasColMajor, CblasUpper, 3, 1.0f, x, 1, A, 3 );
+```
+
+The function accepts the following arguments:
+
+-   **order**: `[in] CBLAS_LAYOUT` storage layout.
+-   **uplo**: `[in] CBLAS_UPLO` specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced.
+-   **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`.
+-   **alpha**: `[in] float` scalar.
+-   **X**: `[in] float*` input array.
+-   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **A**: `[inout] float*` input matrix.
+-   **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
+
+```c
+void c_ssyr( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *A, const CBLAS_INT LDA )
 ```
 
-TODO
+#### c_ssyr_ndarray( uplo, N, alpha, \*X, strideX, offsetX, \*A, sa1, sa2, oa )
+
+Performs the symmetric rank 1 operation `A = α*x*x^T + A` using alternative indexing semantics.
+
+```c
+#include "stdlib/blas/base/shared.h"
+
+float A[] = { 1.0f, 2.0f, 3.0f, 0.0f, 1.0f, 2.0f, 0.0f, 0.0f, 1.0f };
+const float x[] = { 1.0f, 2.0f, 3.0f };
+
+c_ssyr_ndarray( CblasUpper, 3, 1.0f, x, 1, 0, A, 3, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **uplo**: `[in] CBLAS_UPLO` specifies whether the upper or lower triangular part of the symmetric matrix `A` should be referenced.
+-   **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`.
+-   **alpha**: `[in] float` scalar.
+-   **X**: `[in] float*` input array.
+-   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+-   **A**: `[inout] float*` input matrix.
+-   **sa1**: `[in] CBLAS_INT` stride of the first dimension of `A`.
+-   **sa2**: `[in] CBLAS_INT` stride of the second dimension of `A`.
+-   **oa**: `[in] CBLAS_INT` starting index for `A`.
 
 ```c
-TODO
+void c_ssyr_ndarray( const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *A, const CBLAS_INT sa1, const CBLAS_INT sa2, const CBLAS_INT oa )
 ```
 
 </section>
@@ -252,7 +296,34 @@ TODO
 ### Examples
 
 ```c
-TODO
+#include "stdlib/blas/base/ssyr.h"
+#include "stdlib/blas/base/shared.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create strided arrays:
+    float A[] = { 1.0f, 0.0f, 0.0f, 2.0f, 1.0f, 0.0f, 3.0f, 2.0f, 1.0f };
+    const float x[] = { 1.0f, 2.0f, 3.0f };
+
+    // Specify the number of elements along each dimension of `A`:
+    const int N = 3;
+
+    // Perform the symmetric rank 1 operation `A = α*x*x^T + A`:
+    c_ssyr( CblasColMajor, CblasUpper, N, 1.0f, x, 1, A, N );
+
+    // Print the result:
+    for ( int i = 0; i < N*N; i++ ) {
+        printf( "A[ %i ] = %f\n", i, A[ i ] );
+    }
+
+    // Perform the symmetric rank 1 operation `A = α*x*x^T + A`:
+    c_ssyr_ndarray( CblasUpper, N, 1.0f, x, 1, 0, A, N, 1, 0 );
+
+    // Print the result:
+    for ( int i = 0; i < N*N; i++ ) {
+        printf( "A[ %i ] = %f\n", i, A[ i ] );
+    }
+}
 ```
 
 </section>
@@ -297,7 +368,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 

README.md

@@ -0,0 +1,109 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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-harness' );
+var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
+var ones = require( '@stdlib/array-ones' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var floor = require( '@stdlib/math-base-special-floor' );
+var tryRequire = require( '@stdlib/utils-try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var ssyr = tryRequire( resolve( __dirname, './../lib/ssyr.native.js' ) );
+var opts = {
+	'skip': ( ssyr instanceof Error )
+};
+var options = {
+	'dtype': 'float32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} N - number of elements along each dimension
+* @returns {Function} benchmark function
+*/
+function createBenchmark( N ) {
+	var x = ones( N, options.dtype );
+	var A = ones( N*N, options.dtype );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var z;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			z = ssyr( 'row-major', 'upper', N, 1.0, x, 1, A, N );
+			if ( isnanf( z[ i%z.length ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnanf( z[ i%z.length ] ) ) {
+			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 = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
+		f = createBenchmark( N );
+		bench( pkg+'::native:size='+(N*N), opts, f );
+	}
+}
+
+main();