Skip to content

Commit 6c1f9aa

Browse files
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: passed - 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 6c1f9aa

File tree

15 files changed

+767
-225
lines changed

15 files changed

+767
-225
lines changed

lib/node_modules/@stdlib/blas/ext/base/ssort2hp/README.md

Lines changed: 146 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var ssort2hp = require( '@stdlib/blas/ext/base/ssort2hp' );
3232

3333
#### ssort2hp( N, order, x, strideX, y, strideY )
3434

35-
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array `x` using heapsort.
35+
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using heapsort.
3636

3737
```javascript
3838
var Float32Array = require( '@stdlib/array/float32' );
@@ -54,11 +54,11 @@ The function has the following parameters:
5454
- **N**: number of indexed elements.
5555
- **order**: sort order. If `order < 0.0`, the input strided array `x` is sorted in **decreasing** order. If `order > 0.0`, the input strided array `x` is sorted in **increasing** order. If `order == 0.0`, the input strided arrays are left unchanged.
5656
- **x**: first input [`Float32Array`][@stdlib/array/float32].
57-
- **strideX**: `x` index increment.
57+
- **strideX**: stride length for `x`.
5858
- **y**: second input [`Float32Array`][@stdlib/array/float32].
59-
- **strideY**: `y` index increment.
59+
- **strideY**: stride length for `y`.
6060

61-
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to sort every other element
61+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to sort every other element:
6262

6363
```javascript
6464
var Float32Array = require( '@stdlib/array/float32' );
@@ -100,7 +100,7 @@ console.log( y0 );
100100

101101
#### ssort2hp.ndarray( N, order, x, strideX, offsetX, y, strideY, offsetY )
102102

103-
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array `x` using heapsort and alternative indexing semantics.
103+
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using heapsort and alternative indexing semantics.
104104

105105
```javascript
106106
var Float32Array = require( '@stdlib/array/float32' );
@@ -119,10 +119,10 @@ console.log( y );
119119

120120
The function has the following additional parameters:
121121

122-
- **offsetX**: `x` starting index.
123-
- **offsetY**: `y` starting index.
122+
- **offsetX**: starting index for `x`.
123+
- **offsetY**: starting index for `y`.
124124

125-
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
125+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last three elements:
126126

127127
```javascript
128128
var Float32Array = require( '@stdlib/array/float32' );
@@ -165,28 +165,15 @@ console.log( y );
165165
<!-- eslint no-undef: "error" -->
166166

167167
```javascript
168-
var round = require( '@stdlib/math/base/special/round' );
169-
var randu = require( '@stdlib/random/base/randu' );
170-
var Float32Array = require( '@stdlib/array/float32' );
168+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
171169
var ssort2hp = require( '@stdlib/blas/ext/base/ssort2hp' );
172170

173-
var rand;
174-
var sign;
175-
var i;
176-
177-
var x = new Float32Array( 10 );
178-
var y = new Float32Array( 10 ); // index array
179-
for ( i = 0; i < x.length; i++ ) {
180-
rand = round( randu()*100.0 );
181-
sign = randu();
182-
if ( sign < 0.5 ) {
183-
sign = -1.0;
184-
} else {
185-
sign = 1.0;
186-
}
187-
x[ i ] = sign * rand;
188-
y[ i ] = i;
189-
}
171+
var x = discreteUniform( 10, -100, 100, {
172+
'dtype': 'float64'
173+
});
174+
var y = discreteUniform( 10, -100, 100, {
175+
'dtype': 'float64'
176+
});
190177
console.log( x );
191178
console.log( y );
192179

@@ -201,6 +188,137 @@ console.log( y );
201188

202189
* * *
203190

191+
<!-- C interface documentation. -->
192+
193+
<section class="c">
194+
195+
## C APIs
196+
197+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
198+
199+
<section class="intro">
200+
201+
</section>
202+
203+
<!-- /.intro -->
204+
205+
<!-- C usage documentation. -->
206+
207+
<section class="usage">
208+
209+
### Usage
210+
211+
```c
212+
#include "stdlib/blas/ext/base/ssort2hp.h"
213+
```
214+
215+
#### stdlib_strided_ssort2hp( N, order, \*X, strideX, \*Y, strideY )
216+
217+
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using heapsort.
218+
219+
```c
220+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
221+
float y[] = { 0.0f, 1.0f, 2.0f, 3.0f };
222+
223+
stdlib_strided_ssort2hp( 4, 1.0f, x, 1, y, 1 );
224+
```
225+
226+
The function accepts the following arguments:
227+
228+
- **N**: `[in] CBLAS_INT` number of indexed elements.
229+
- **order**: `[in] float` sort order. If `order < 0.0`, the input strided array `x` is sorted in **decreasing** order. If `order > 0.0`, the input strided array `x` is sorted in **increasing** order. If `order == 0.0`, the input strided arrays are left unchanged.
230+
- **X**: `[inout] float*` input array.
231+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
232+
- **Y**: `[inout] float*` input array.
233+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
234+
235+
```c
236+
stdlib_strided_ssort2hp( const CBLAS_INT N, const float order, float *X, CBLAS_INT strideX, float *Y, CBLAS_INT strideY );
237+
```
238+
239+
<!--lint disable maximum-heading-length-->
240+
241+
#### stdlib_strided_ssort2hp_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY )
242+
243+
<!--lint enable maximum-heading-length-->
244+
245+
Simultaneously sorts two single-precision floating-point strided arrays based on the sort order of the first array using heapsort and alternative indexing semantics.
246+
247+
```c
248+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
249+
float y[] = { 0.0f, 1.0f, 2.0f, 3.0f };
250+
251+
stdlib_strided_ssort2hp_ndarray( 4, 1.0f, x, 1, 0, y, 1, 0 );
252+
```
253+
254+
The function accepts the following arguments:
255+
256+
- **N**: `[in] CBLAS_INT` number of indexed elements.
257+
- **order**: `[in] float` sort order.
258+
- **X**: `[inout] float*` input array.
259+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
260+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
261+
- **Y**: `[inout] float*` input array.
262+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
263+
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
264+
265+
```c
266+
stdlib_strided_ssort2hp_ndarray( const CBLAS_INT N, const float order, float *X, CBLAS_INT strideX, CBLAS_INT offsetX, float *Y, CBLAS_INT strideY, CBLAS_INT offsetY );
267+
```
268+
269+
</section>
270+
271+
<!-- /.usage -->
272+
273+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
274+
275+
<section class="notes">
276+
277+
</section>
278+
279+
<!-- /.notes -->
280+
281+
<!-- C API usage examples. -->
282+
283+
<section class="examples">
284+
285+
### Examples
286+
287+
```c
288+
#include "stdlib/blas/ext/base/ssort2hp.h"
289+
#include <stdio.h>
290+
291+
int main( void ) {
292+
// Create strided arrays:
293+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
294+
float y[] = { 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f };
295+
296+
// Specify the number of elements:
297+
int N = 8;
298+
299+
// Specify the strides:
300+
int strideX = 1;
301+
int strideY = 1;
302+
303+
// Sort the arrays:
304+
stdlib_strided_ssort2hp( N, 1.0f, x, strideX, y, strideY );
305+
306+
// Print the result:
307+
for ( int i = 0; i < 8; i++ ) {
308+
printf( "x[ %i ] = %f\n", i, x[ i ] );
309+
printf( "y[ %i ] = %lf\n", i, y[ i ] );
310+
}
311+
}
312+
```
313+
314+
</section>
315+
316+
<!-- /.examples -->
317+
318+
</section>
319+
320+
<!-- /.c -->
321+
204322
<section class="references">
205323
206324
## References
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

0 commit comments

Comments
 (0)