Skip to content

Commit 9248df2

Browse files
headlessNodeheadlessNode
committed
feat: add c apis
--- 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: 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: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - 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 ---
1 parent 8b0ee38 commit 9248df2

File tree

24 files changed

+1654
-56
lines changed

24 files changed

+1654
-56
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,125 @@ console.log( idx );
167167

168168
<!-- /.examples -->
169169

170+
<!-- C interface documentation. -->
171+
172+
* * *
173+
174+
<section class="c">
175+
176+
## C APIs
177+
178+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
179+
180+
<section class="intro">
181+
182+
</section>
183+
184+
<!-- /.intro -->
185+
186+
<!-- C usage documentation. -->
187+
188+
<section class="usage">
189+
190+
### Usage
191+
192+
```c
193+
#include "stdlib/blas/ext/base/sindexOf.h"
194+
```
195+
196+
#### stdlib_strided_sindexOf( N, searchElement, \*X, strideX )
197+
198+
Returns the index of a specified search element in a single-precision floating-point strided array.
199+
200+
```c
201+
float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
202+
203+
int idx = stdlib_strided_sindexOf( 4, 3.0f, x, 1 );
204+
// returns 2
205+
```
206+
207+
The function accepts the following arguments:
208+
209+
- **N**: `[in] CBLAS_INT` number of indexed elements.
210+
- **searchElement**: `[in] float` search element.
211+
- **X**: `[in] float*` input array.
212+
- **strideX**: `[in] CBLAS_INT` stride length.
213+
214+
```c
215+
CBLAS_INT N stdlib_strided_sindexOf( const CBLAS_INT N, const float searchElement, float *X, const CBLAS_INT strideX );
216+
```
217+
218+
#### stdlib_strided_sindexOf_ndarray( N, searchElement, \*X, strideX, offsetX )
219+
220+
Returns the index of a specified search element in a single-precision floating-point strided array using alternative indexing semantics.
221+
222+
```c
223+
float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
224+
225+
int idx = stdlib_strided_sindexOf( 4, 3.0f, x, 1, 0 );
226+
// returns 2
227+
```
228+
229+
The function accepts the following arguments:
230+
231+
- **N**: `[in] CBLAS_INT` number of indexed elements.
232+
- **searchElement**: `[in] float` search element.
233+
- **X**: `[in] float*` input array.
234+
- **strideX**: `[in] CBLAS_INT` stride length.
235+
- **offsetX**: `[in] CBLAS_INT` starting index.
236+
237+
```c
238+
CBLAS_INT stdlib_strided_sindexOf_ndarray( const CBLAS_INT N, const float searchElement, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
239+
```
240+
241+
</section>
242+
243+
<!-- /.usage -->
244+
245+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
246+
247+
<section class="notes">
248+
249+
</section>
250+
251+
<!-- /.notes -->
252+
253+
<!-- C API usage examples. -->
254+
255+
<section class="examples">
256+
257+
### Examples
258+
259+
```c
260+
#include "stdlib/blas/ext/base/sindexOf.h"
261+
#include <stdio.h>
262+
263+
int main( void ) {
264+
// Create a strided array:
265+
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
266+
267+
// Specify the number of indexed elements:
268+
const int N = 8;
269+
270+
// Specify a stride:
271+
const int strideX = 1;
272+
273+
// Fill the array:
274+
int idx = stdlib_strided_sindexOf( N, 5.0f, x, strideX );
275+
276+
// Print the result:
277+
printf( "index value: %d\n", idx );
278+
}
279+
```
280+
281+
</section>
282+
283+
<!-- /.examples -->
284+
285+
</section>
286+
287+
<!-- /.c -->
288+
170289
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
171290
172291
<section class="references">

‎lib/node_modules/@stdlib/blas/ext/base/sindex-of/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.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)