Skip to content

Commit 758dc37

Browse files
DhruvArvindSinghDhruvArvindSingh
committed
feat: add C implementation for blas/base/srotg
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent dfb4d35 commit 758dc37

File tree

15 files changed

+1310
-0
lines changed

15 files changed

+1310
-0
lines changed

‎lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.native.js‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var tryRequire = require( '@stdlib/utils/try-require' );
26+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
27+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
28+
var Float32Array = require( '@stdlib/array/float32' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var srotg = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( srotg instanceof Error )
37+
};
38+
39+
40+
// VARIABLES //
41+
42+
var OPTS = {
43+
'dtype': 'float32'
44+
};
45+
46+
47+
// MAIN //
48+
49+
bench( pkg, opts, function benchmark( b ) {
50+
var out;
51+
var x;
52+
var y;
53+
var i;
54+
55+
x = discreteUniform( 100, -5, 5, OPTS );
56+
y = discreteUniform( 100, -5, 5, OPTS );
57+
out = new Float32Array( 4 );
58+
59+
b.tic();
60+
for ( i = 0; i < b.iterations; i++ ) {
61+
srotg( x[ i%x.length ], y[ i%y.length ], out, 1, 0 );
62+
if ( typeof out !=='object' ) {
63+
b.fail( 'should return an array' );
64+
}
65+
}
66+
b.toc();
67+
if ( isnanf( out[ i%4 ] ) ) {
68+
b.fail( 'should return the output array' );
69+
}
70+
b.pass( 'benchmark finished' );
71+
b.end();
72+
});

‎lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/Makefile‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2025 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean

‎lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/benchmark.c‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include "stdlib/blas/base/srotg.h"
20+
#include "stdlib/math/base/assert/is_nan.h"
21+
#include "stdlib/constants/float64/eps.h"
22+
#include <stdlib.h>
23+
#include <stdio.h>
24+
#include <math.h>
25+
#include <time.h>
26+
#include <sys/time.h>
27+
28+
#define NAME "srotg"
29+
#define ITERATIONS 1000000
30+
#define REPEATS 3
31+
32+
/**
33+
* Prints the TAP version.
34+
*/
35+
static void print_version( void ) {
36+
printf( "TAP version 13\n" );
37+
}
38+
39+
/**
40+
* Prints the TAP summary.
41+
*
42+
* @param total total number of tests
43+
* @param passing total number of passing tests
44+
*/
45+
static void print_summary( int total, int passing ) {
46+
printf( "#\n" );
47+
printf( "1..%d\n", total ); // TAP plan
48+
printf( "# total %d\n", total );
49+
printf( "# pass %d\n", passing );
50+
printf( "#\n" );
51+
printf( "# ok\n" );
52+
}
53+
54+
/**
55+
* Prints benchmarks results.
56+
*
57+
* @param elapsed elapsed time in seconds
58+
*/
59+
static void print_results( double elapsed ) {
60+
double rate = (double)ITERATIONS / elapsed;
61+
printf( " ---\n" );
62+
printf( " iterations: %d\n", ITERATIONS );
63+
printf( " elapsed: %0.9f\n", elapsed );
64+
printf( " rate: %0.9f\n", rate );
65+
printf( " ...\n" );
66+
}
67+
68+
/**
69+
* Returns a clock time.
70+
*
71+
* @return clock time
72+
*/
73+
static double tic( void ) {
74+
struct timeval now;
75+
gettimeofday( &now, NULL );
76+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
77+
}
78+
79+
/**
80+
* Generates a random number on the interval [min,max).
81+
*
82+
* @param min minimum value (inclusive)
83+
* @param max maximum value (exclusive)
84+
* @return random number
85+
*/
86+
static double random_uniform( const double min, const double max ) {
87+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
88+
return min + ( v*(max-min) );
89+
}
90+
91+
/**
92+
* Runs a benchmark.
93+
*
94+
* @return elapsed time in seconds
95+
*/
96+
static double benchmark( void ) {
97+
double elapsed;
98+
float a[ 100 ];
99+
float b[ 100 ];
100+
float Out[ 4 ];
101+
double t;
102+
int i;
103+
104+
for ( i = 0; i < 100; i++ ) {
105+
a[ i ] = random_uniform( 0.0, 100.0 );
106+
b[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;
107+
}
108+
109+
t = tic();
110+
for ( i = 0; i < ITERATIONS; i++ ) {
111+
srotg( a[ i % 100 ], b[ i % 100 ], Out, 1, 0 );
112+
if ( stdlib_base_is_nan( Out[0] ) || stdlib_base_is_nan( Out[1] ) || stdlib_base_is_nan( Out[2] ) || stdlib_base_is_nan( Out[3] ) ) {
113+
printf( "should not return NaN\n" );
114+
break;
115+
}
116+
}
117+
elapsed = tic() - t;
118+
if ( stdlib_base_is_nan( Out[0] ) || stdlib_base_is_nan( Out[1] ) || stdlib_base_is_nan( Out[2] ) || stdlib_base_is_nan( Out[3] ) ) {
119+
printf( "should not return NaN\n" );
120+
}
121+
return elapsed;
122+
}
123+
124+
/**
125+
* Main execution sequence.
126+
*/
127+
int main( void ) {
128+
double elapsed;
129+
int i;
130+
131+
// Use the current time to seed the random number generator:
132+
srand( time( NULL ) );
133+
134+
print_version();
135+
for ( i = 0; i < REPEATS; i++ ) {
136+
printf( "# c::%s\n", NAME );
137+
elapsed = benchmark();
138+
print_results( elapsed );
139+
printf( "ok %d benchmark finished\n", i+1 );
140+
}
141+
print_summary( REPEATS, REPEATS );
142+
}

0 commit comments

Comments
 (0)