Skip to content

Commit f9fa8d7

Browse files
headlessNodeheadlessNode
committed
feat: add C ndarray API and refactor
1 parent 9818fa6 commit f9fa8d7

File tree

14 files changed

+726
-405
lines changed

14 files changed

+726
-405
lines changed

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

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

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

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

3737
```javascript
3838
var Float64Array = require( '@stdlib/array/float64' );
@@ -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 [`Float64Array`][@stdlib/array/float64].
57-
- **strideX**: `x` index increment.
57+
- **strideX**: `x` stride length.
5858
- **y**: second input [`Float64Array`][@stdlib/array/float64].
59-
- **strideY**: `y` index increment.
59+
- **strideY**: `y` stride length.
6060

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

6363
```javascript
6464
var Float64Array = require( '@stdlib/array/float64' );
@@ -104,7 +104,7 @@ console.log( y0 );
104104

105105
#### dsort2hp.ndarray( N, order, x, strideX, offsetX, y, strideY, offsetY )
106106

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

109109
```javascript
110110
var Float64Array = require( '@stdlib/array/float64' );
@@ -126,7 +126,7 @@ The function has the following additional parameters:
126126
- **offsetX**: `x` starting index.
127127
- **offsetY**: `y` starting index.
128128

129-
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`
129+
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:
130130

131131
```javascript
132132
var Float64Array = require( '@stdlib/array/float64' );
@@ -205,8 +205,139 @@ console.log( y );
205205

206206
<!-- /.examples -->
207207

208+
<!-- C interface documentation. -->
209+
208210
* * *
209211

212+
<section class="c">
213+
214+
## C APIs
215+
216+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
217+
218+
<section class="intro">
219+
220+
</section>
221+
222+
<!-- /.intro -->
223+
224+
<!-- C usage documentation. -->
225+
226+
<section class="usage">
227+
228+
### Usage
229+
230+
```c
231+
#include "stdlib/blas/ext/base/dsort2hp.h"
232+
```
233+
234+
#### stdlib_strided_dsort2hp( N, order, \*X, strideX, \*Y, strideY )
235+
236+
Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.
237+
238+
```c
239+
double x[] = { 1.0, -2.0, 3.0, -4.0 };
240+
double y[] = { 0.0, 1.0, 2.0, 3.0 };
241+
242+
stdlib_strided_dsort2hp( 4, 1, x, 1, y, 1 );
243+
```
244+
245+
The function accepts the following arguments:
246+
247+
- **N**: `[in] CBLAS_INT` number of indexed elements.
248+
- **order**: `[in] CBLAS_INT` 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.
249+
- **X**: `[inout] double*` input array.
250+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
251+
- **Y**: `[inout] double*` input array.
252+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
253+
254+
```c
255+
stdlib_strided_dsort2hp( const CBLAS_INT N, const CBLAS_INT order, double *X, const CBLAS_INT strideX, double *Y, const CBLAS_INT strideY );
256+
```
257+
258+
<!--lint disable maximum-heading-length-->
259+
260+
#### stdlib_strided_dsort2hp_ndarray( N, order, \*X, strideX, offsetX, \*Y, strideY, offsetY )
261+
262+
<!--lint enable maximum-heading-length-->
263+
264+
Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array using heapsort and alternative indexing semantics.
265+
266+
```c
267+
double x[] = { 1.0, -2.0, 3.0, -4.0 };
268+
double y[] = { 0.0, 1.0, 2.0, 3.0 };
269+
270+
stdlib_strided_dsort2hp_ndarray( 4, 1, x, 1, 0, y, 1, 0 );
271+
```
272+
273+
The function accepts the following arguments:
274+
275+
- **N**: `[in] CBLAS_INT` number of indexed elements.
276+
- **order**: `[in] CBLAS_INT` sort order.
277+
- **X**: `[inout] double*` input array. 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.
278+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
279+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
280+
- **Y**: `[inout] double*` input array.
281+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
282+
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
283+
284+
```c
285+
stdlib_strided_dsort2hp_ndarray( const CBLAS_INT N, const CBLAS_INT order, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
286+
```
287+
288+
</section>
289+
290+
<!-- /.usage -->
291+
292+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
293+
294+
<section class="notes">
295+
296+
</section>
297+
298+
<!-- /.notes -->
299+
300+
<!-- C API usage examples. -->
301+
302+
<section class="examples">
303+
304+
### Examples
305+
306+
```c
307+
#include "stdlib/blas/ext/base/dsort2hp.h"
308+
#include <stdio.h>
309+
310+
int main( void ) {
311+
// Create strided arrays:
312+
double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
313+
double y[] = { 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 };
314+
315+
// Specify the number of elements:
316+
int N = 8;
317+
318+
// Specify the strides:
319+
int strideX = 1;
320+
int strideY = 1;
321+
322+
// Sort the arrays:
323+
stdlib_strided_dsort2hp( N, 1.0, x, strideX, y, strideY );
324+
325+
// Print the result:
326+
for ( int i = 0; i < 8; i++ ) {
327+
printf( "x[ %i ] = %lf\n", i, x[ i ] );
328+
printf( "y[ %i ] = %lf\n", i, y[ i ] );
329+
}
330+
}
331+
```
332+
333+
</section>
334+
335+
<!-- /.examples -->
336+
337+
</section>
338+
339+
<!-- /.c -->
340+
210341
<section class="references">
211342
212343
## References

‎lib/node_modules/@stdlib/blas/ext/base/dsort2hp/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) 2024 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)