Skip to content

Commit 90824dc

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add C ndarray API and refactor blas/ext/base/ssorthp
PR-URL: #9698 Closes: stdlib-js/metr-issue-tracker#154 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent e0aa4bb commit 90824dc

File tree

15 files changed

+649
-209
lines changed

15 files changed

+649
-209
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/ssorthp/README.md‎

Lines changed: 129 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ limitations under the License.
3030
var ssorthp = require( '@stdlib/blas/ext/base/ssorthp' );
3131
```
3232

33-
#### ssorthp( N, order, x, stride )
33+
#### ssorthp( N, order, x, strideX )
3434

3535
Sorts a single-precision floating-point strided array using heapsort.
3636

@@ -48,9 +48,9 @@ The function has the following parameters:
4848
- **N**: number of indexed elements.
4949
- **order**: sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
5050
- **x**: input [`Float32Array`][@stdlib/array/float32].
51-
- **stride**: index increment.
51+
- **strideX**: stride length.
5252

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

5555
```javascript
5656
var Float32Array = require( '@stdlib/array/float32' );
@@ -77,7 +77,7 @@ ssorthp( 2, -1.0, x1, 2 );
7777
// x0 => <Float32Array>[ 1.0, 4.0, 3.0, 2.0 ]
7878
```
7979

80-
#### ssorthp.ndarray( N, order, x, stride, offset )
80+
#### ssorthp.ndarray( N, order, x, strideX, offsetX )
8181

8282
Sorts a single-precision floating-point strided array using heapsort and alternative indexing semantics.
8383

@@ -92,9 +92,9 @@ ssorthp.ndarray( x.length, 1.0, x, 1, 0 );
9292

9393
The function has the following additional parameters:
9494

95-
- **offset**: starting index.
95+
- **offsetX**: starting index.
9696

97-
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 the strided array
97+
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:
9898

9999
```javascript
100100
var Float32Array = require( '@stdlib/array/float32' );
@@ -131,13 +131,12 @@ ssorthp.ndarray( 3, 1.0, x, 1, x.length-3 );
131131
<!-- eslint no-undef: "error" -->
132132

133133
```javascript
134-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
135-
var filledarrayBy = require( '@stdlib/array/filled-by' );
134+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
136135
var ssorthp = require( '@stdlib/blas/ext/base/ssorthp' );
137136

138-
var rand = discreteUniform( -100, 100 );
139-
var x = filledarrayBy( 10, 'float32', rand );
140-
137+
var x = discreteUniform( 10, -100, 100, {
138+
'dtype': 'float32'
139+
});
141140
console.log( x );
142141

143142
ssorthp( x.length, -1.0, x, -1 );
@@ -150,6 +149,125 @@ console.log( x );
150149

151150
* * *
152151

152+
<section class="c">
153+
154+
## C APIs
155+
156+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
157+
158+
<section class="intro">
159+
160+
</section>
161+
162+
<!-- /.intro -->
163+
164+
<!-- C usage documentation. -->
165+
166+
<section class="usage">
167+
168+
### Usage
169+
170+
```c
171+
#include "stdlib/blas/ext/base/ssorthp.h"
172+
```
173+
174+
#### stdlib_strided_ssorthp( N, order, \*X, strideX )
175+
176+
Sorts a single-precision floating-point strided array using heapsort.
177+
178+
```c
179+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
180+
181+
stdlib_strided_ssorthp( 2, -1.0f, x, 1 );
182+
```
183+
184+
The function accepts the following arguments:
185+
186+
- **N**: `[in] CBLAS_INT` number of indexed elements.
187+
- **order**: `[in] float` sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
188+
- **X**: `[inout] float*` input array.
189+
- **strideX**: `[in] CBLAS_INT` stride length.
190+
191+
```c
192+
stdlib_strided_ssorthp( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX );
193+
```
194+
195+
<!--lint disable maximum-heading-length-->
196+
197+
#### stdlib_strided_ssorthp_ndarray( N, order, \*X, strideX, offsetX )
198+
199+
<!--lint enable maximum-heading-length-->
200+
201+
Sorts a single-precision floating-point strided array using heapsort and alternative indexing semantics.
202+
203+
```c
204+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f };
205+
206+
stdlib_strided_ssorthp_ndarray( 4, 1.0f, x, 1, 0 );
207+
```
208+
209+
The function accepts the following arguments:
210+
211+
- **N**: `[in] CBLAS_INT` number of indexed elements.
212+
- **order**: `[in] float` sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
213+
- **X**: `[inout] float*` input array.
214+
- **strideX**: `[in] CBLAS_INT` stride length.
215+
- **offsetX**: `[in] CBLAS_INT` starting index.
216+
217+
```c
218+
stdlib_strided_ssorthp_ndarray( const CBLAS_INT N, const float order, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
219+
```
220+
221+
</section>
222+
223+
<!-- /.usage -->
224+
225+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
226+
227+
<section class="notes">
228+
229+
</section>
230+
231+
<!-- /.notes -->
232+
233+
<!-- C API usage examples. -->
234+
235+
<section class="examples">
236+
237+
### Examples
238+
239+
```c
240+
#include "stdlib/blas/ext/base/ssorthp.h"
241+
#include <stdio.h>
242+
243+
int main( void ) {
244+
// Create a strided array:
245+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
246+
247+
// Specify the number of elements:
248+
int N = 8;
249+
250+
// Specify a stride:
251+
int strideX = 1;
252+
253+
// Sort the array:
254+
stdlib_strided_ssorthp( N, 1.0f, x, strideX );
255+
256+
// Print the result:
257+
for ( int i = 0; i < 8; i++ ) {
258+
printf( "x[ %i ] = %f\n", i, x[ i ] );
259+
}
260+
}
261+
```
262+
263+
</section>
264+
265+
<!-- /.examples -->
266+
267+
</section>
268+
269+
<!-- /.c -->
270+
153271
<section class="references">
154272
155273
## References

‎lib/node_modules/@stdlib/blas/ext/base/ssorthp/benchmark/c/unsorted-random/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) 2026 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.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)