Skip to content

Commit 8ffcb27

Browse files
0PrashantYadav00PrashantYadav0
committed
feat: add C ndarray interface and refactor implementation
--- 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: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: passed - 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 84b7614 commit 8ffcb27

File tree

14 files changed

+492
-241
lines changed

14 files changed

+492
-241
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/ssort2ins/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.unsorted_random.length.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/ext/base/ssort2ins/benchmark/c/benchmark.unsorted_random.length.c‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
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/ext/base/ssort2ins.h"
20+
#include <stdlib.h>
21+
#include <stdio.h>
22+
#include <math.h>
23+
#include <time.h>
24+
#include <sys/time.h>
25+
26+
#define NAME "ssort2ins"
27+
#define ITERATIONS 10000000
28+
#define REPEATS 3
29+
#define MIN 1
30+
#define MAX 6
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 iterations number of iterations
58+
* @param elapsed elapsed time in seconds
59+
*/
60+
static void print_results( int iterations, double elapsed ) {
61+
double rate = (double)iterations / elapsed;
62+
printf( " ---\n" );
63+
printf( " iterations: %d\n", iterations );
64+
printf( " elapsed: %0.9f\n", elapsed );
65+
printf( " rate: %0.9f\n", rate );
66+
printf( " ...\n" );
67+
}
68+
69+
/**
70+
* Returns a clock time.
71+
*
72+
* @return clock time
73+
*/
74+
static double tic( void ) {
75+
struct timeval now;
76+
gettimeofday( &now, NULL );
77+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
78+
}
79+
80+
/**
81+
* Generates a random number on the interval [0,1).
82+
*
83+
* @return random number
84+
*/
85+
static double rand_float( void ) {
86+
int r = rand();
87+
return (float)r / ( (float)RAND_MAX + 1.0f );
88+
}
89+
90+
/**
91+
* Runs a benchmark.
92+
*
93+
* @param iterations number of iterations
94+
* @param len array length
95+
* @return elapsed time in seconds
96+
*/
97+
static double benchmark1( int iterations, int len ) {
98+
double elapsed;
99+
double t;
100+
float *x;
101+
float *y;
102+
int i;
103+
104+
x = ( float * )malloc( len * sizeof(float) );
105+
y = ( float * )malloc( len * sizeof(float) );
106+
for ( i = 0; i < len; i++ ) {
107+
x[ i ] = ( rand_float()*20.0f ) - 10.0f;
108+
y[ i ] = ( rand_float()*20.0f ) - 10.0f;
109+
}
110+
t = tic();
111+
for ( i = 0; i < iterations; i++ ) {
112+
stdlib_strided_ssort2ins( len, 1.0f, x, 1, y, 1 );
113+
if ( y[ 0 ] != y[ 0 ] ) {
114+
printf( "should not return NaN\n" );
115+
break;
116+
}
117+
}
118+
elapsed = tic() - t;
119+
if ( y[ 0 ] != y[ 0 ] ) {
120+
printf( "should not return NaN\n" );
121+
}
122+
free( x );
123+
free( y );
124+
return elapsed;
125+
}
126+
127+
/**
128+
* Runs a benchmark.
129+
*
130+
* @param iterations number of iterations
131+
* @param len array length
132+
* @return elapsed time in seconds
133+
*/
134+
static double benchmark2( int iterations, int len ) {
135+
double elapsed;
136+
double t;
137+
float *x;
138+
float *y;
139+
int i;
140+
141+
x = (float *)malloc( len * sizeof(float) );
142+
y = (float *)malloc( len * sizeof(float) );
143+
for ( i = 0; i < len; i++ ) {
144+
x[ i ] = ( rand_float()*20.0f ) - 10.0f;
145+
y[ i ] = ( rand_float()*20.0f ) - 10.0f;
146+
}
147+
t = tic();
148+
for ( i = 0; i < iterations; i++ ) {
149+
stdlib_strided_ssort2ins_ndarray( len, 1.0f, x, 1, 0, y, 1, 0 );
150+
if ( y[ 0 ] != y[ 0 ] ) {
151+
printf( "should not return NaN\n" );
152+
break;
153+
}
154+
}
155+
elapsed = tic() - t;
156+
if ( y[ 0 ] != y[ 0 ] ) {
157+
printf( "should not return NaN\n" );
158+
}
159+
free( x );
160+
free( y );
161+
return elapsed;
162+
}
163+
164+
/**
165+
* Main execution sequence.
166+
*/
167+
int main( void ) {
168+
double elapsed;
169+
int count;
170+
int iter;
171+
int len;
172+
int i;
173+
int j;
174+
175+
// Use the current time to seed the random number generator:
176+
srand( time( NULL ) );
177+
178+
print_version();
179+
count = 0;
180+
for ( i = MIN; i <= MAX; i++ ) {
181+
len = pow( 10, i );
182+
iter = ITERATIONS / pow( 10, i-1 );
183+
for ( j = 0; j < REPEATS; j++ ) {
184+
count += 1;
185+
printf( "# c::%s:unsorted,random:len=%d\n", NAME, len );
186+
elapsed = benchmark1( iter, len );
187+
print_results( iter, elapsed );
188+
printf( "ok %d benchmark finished\n", count );
189+
}
190+
}
191+
for ( i = MIN; i <= MAX; i++ ) {
192+
len = pow( 10, i );
193+
iter = ITERATIONS / pow( 10, i-1 );
194+
for ( j = 0; j < REPEATS; j++ ) {
195+
count += 1;
196+
printf( "# c::%s:ndarray:unsorted,random:len=%d\n", NAME, len );
197+
elapsed = benchmark2( iter, len );
198+
print_results( iter, elapsed );
199+
printf( "ok %d benchmark finished\n", count );
200+
}
201+
}
202+
print_summary( count, count );
203+
}

‎lib/node_modules/@stdlib/blas/ext/base/ssort2ins/docs/repl.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Simultaneously sorts two single-precision floating-point strided arrays
44
based on the sort order of the first array using insertion sort.
55

6-
The `N` and stride parameters determine which elements in the strided
7-
arrays are accessed at runtime.
6+
The `N` and stride parameters determine which elements in the strided arrays
7+
are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use typed
1010
array views.
@@ -47,13 +47,13 @@
4747
First input array.
4848

4949
strideX: integer
50-
Index increment for `x`.
50+
Stride length for `x`.
5151

5252
y: Float32Array
5353
Second input array.
5454

5555
strideY: integer
56-
Index increment for `y`.
56+
Stride length for `y`.
5757

5858
Returns
5959
-------
@@ -113,7 +113,7 @@
113113
First input array.
114114

115115
strideX: integer
116-
Index increment for `x`.
116+
Stride length for `x`.
117117

118118
offsetX: integer
119119
Starting index of `x`.
@@ -122,7 +122,7 @@
122122
Second input array.
123123

124124
strideY: integer
125-
Index increment for `y`.
125+
Stride length for `y`.
126126

127127
offsetY: integer
128128
Starting index of `y`.

0 commit comments

Comments
 (0)