Skip to content

Commit 33bda21

Browse files
kgrytekgryte
committed
feat: add C API
1 parent 2ca8d8f commit 33bda21

File tree

9 files changed

+687
-0
lines changed

9 files changed

+687
-0
lines changed

‎lib/node_modules/@stdlib/strided/base/max-view-buffer-index/README.md

+96
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,102 @@ console.log( 'N: %d, stride: %d, offset: %d => %d', N, stride, offset, idx );
9696

9797
<!-- /.examples -->
9898

99+
* * *
100+
101+
<section class="c">
102+
103+
## C APIs
104+
105+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
106+
107+
<section class="intro">
108+
109+
</section>
110+
111+
<!-- /.intro -->
112+
113+
<!-- C usage documentation. -->
114+
115+
<section class="usage">
116+
117+
### Usage
118+
119+
```c
120+
#include "stdlib/strided/base/max_view_buffer_index.h"
121+
```
122+
123+
#### stdlib_strided_max_view_buffer_index( N, stride, offset )
124+
125+
Returns the maximum accessible index based on a set of provided strided array parameters.
126+
127+
```c
128+
#include "stdlib/strided/base/max_view_buffer_index.h"
129+
#include <stdint.h>
130+
131+
int64_t offset = stdlib_strided_max_view_buffer_index( 3, 2, 10 );
132+
// returns 14
133+
```
134+
135+
The function accepts the following arguments:
136+
137+
- **N**: `[in] int64_t` number of indexed elements.
138+
- **stride**: `[in] int64_t` index increment.
139+
- **offset**: `[in] int64_t` starting index.
140+
141+
```c
142+
int64_t stdlib_strided_max_view_buffer_index( const int64_t N, const int64_t stride, const int64_t offset );
143+
```
144+
145+
</section>
146+
147+
<!-- /.usage -->
148+
149+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
150+
151+
<section class="notes">
152+
153+
</section>
154+
155+
<!-- /.notes -->
156+
157+
<!-- C API usage examples. -->
158+
159+
<section class="examples">
160+
161+
### Examples
162+
163+
```c
164+
#include "stdlib/strided/base/max_view_buffer_index.h"
165+
#include <stdint.h>
166+
#include <stdio.h>
167+
#include <inttypes.h>
168+
169+
int main( void ) {
170+
// Specify the number of indexed elements:
171+
int64_t N = 6;
172+
173+
// Define a stride:
174+
int64_t stride = 2;
175+
176+
// Define an offset:
177+
int64_t offset = 100;
178+
179+
// Compute the maximum accessible index:
180+
int64_t idx = stdlib_strided_max_view_buffer_index( N, stride, offset );
181+
182+
// Print the results:
183+
printf( "N: %"PRId64", stride: %"PRId64", offset: %"PRId64" => idx: %"PRId64"\n", N, stride, offset, idx );
184+
}
185+
```
186+
187+
</section>
188+
189+
<!-- /.examples -->
190+
191+
</section>
192+
193+
<!-- /.c -->
194+
99195
<!-- 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. -->
100196

101197
<section class="references">

‎lib/node_modules/@stdlib/strided/base/max-view-buffer-index/benchmark/c/Makefile

+146
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.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles C source files.
92+
#
93+
# @param {string} SOURCE_FILES - list of C source files
94+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop`)
95+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lpthread -lblas`)
96+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
97+
# @param {string} [C_COMPILER] - C compiler
98+
# @param {string} [CFLAGS] - C compiler flags
99+
# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code
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} SOURCE_FILES - list of C source files
116+
# @param {(string|void)} INCLUDE - list of includes (e.g., `-I /foo/bar -I /beep/boop`)
117+
# @param {(string|void)} LIBRARIES - list of libraries (e.g., `-lpthread -lblas`)
118+
# @param {(string|void)} LIBPATH - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
119+
# @param {string} CC - C compiler
120+
# @param {string} CFLAGS - C compiler flags
121+
# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code
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/strided/base/max-view-buffer-index/benchmark/c/benchmark.c

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
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+
#include "stdlib/strided/base/max_view_buffer_index.h"
20+
#include <stdlib.h>
21+
#include <stdio.h>
22+
#include <stdint.h>
23+
#include <math.h>
24+
#include <time.h>
25+
#include <sys/time.h>
26+
27+
#define NAME "max-view-buffer-index"
28+
#define ITERATIONS 1000000
29+
#define REPEATS 3
30+
31+
/**
32+
* Prints the TAP version.
33+
*/
34+
static void print_version( void ) {
35+
printf( "TAP version 13\n" );
36+
}
37+
38+
/**
39+
* Prints the TAP summary.
40+
*
41+
* @param total total number of tests
42+
* @param passing total number of passing tests
43+
*/
44+
static void print_summary( int total, int passing ) {
45+
printf( "#\n" );
46+
printf( "1..%d\n", total ); // TAP plan
47+
printf( "# total %d\n", total );
48+
printf( "# pass %d\n", passing );
49+
printf( "#\n" );
50+
printf( "# ok\n" );
51+
}
52+
53+
/**
54+
* Prints benchmarks results.
55+
*
56+
* @param elapsed elapsed time in seconds
57+
*/
58+
static void print_results( double elapsed ) {
59+
double rate = (double)ITERATIONS / elapsed;
60+
printf( " ---\n" );
61+
printf( " iterations: %d\n", ITERATIONS );
62+
printf( " elapsed: %0.9f\n", elapsed );
63+
printf( " rate: %0.9f\n", rate );
64+
printf( " ...\n" );
65+
}
66+
67+
/**
68+
* Returns a clock time.
69+
*
70+
* @return clock time
71+
*/
72+
static double tic( void ) {
73+
struct timeval now;
74+
gettimeofday( &now, NULL );
75+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
76+
}
77+
78+
/**
79+
* Generates a random number on the interval [0,1).
80+
*
81+
* @return random number
82+
*/
83+
static double rand_double( void ) {
84+
int r = rand();
85+
return (double)r / ( (double)RAND_MAX + 1.0 );
86+
}
87+
88+
/**
89+
* Runs a benchmark.
90+
*
91+
* @return elapsed time in seconds
92+
*/
93+
static double benchmark( void ) {
94+
double elapsed;
95+
int64_t stride;
96+
int64_t N;
97+
int64_t o;
98+
double t;
99+
int i;
100+
101+
N = 10;
102+
stride = -1;
103+
104+
t = tic();
105+
for ( i = 0; i < ITERATIONS; i++ ) {
106+
stride *= ( rand_double() < 0.5 ) ? -1 : 1;
107+
o = stdlib_strided_max_view_buffer_index( N, stride, ( stride < 0 ) ? N+i-1 : 0 );
108+
if ( o > 1e20 ) {
109+
printf( "unexpected result\n" );
110+
break;
111+
}
112+
}
113+
elapsed = tic() - t;
114+
if ( o > 1e20 ) {
115+
printf( "unexpected result\n" );
116+
}
117+
return elapsed;
118+
}
119+
120+
/**
121+
* Main execution sequence.
122+
*/
123+
int main( void ) {
124+
double elapsed;
125+
int i;
126+
127+
// Use the current time to seed the random number generator:
128+
srand( time( NULL ) );
129+
130+
print_version();
131+
for ( i = 0; i < REPEATS; i++ ) {
132+
printf( "# c::native::%s\n", NAME );
133+
elapsed = benchmark();
134+
print_results( elapsed );
135+
printf( "ok %d benchmark finished\n", i+1 );
136+
}
137+
print_summary( REPEATS, REPEATS );
138+
}

0 commit comments

Comments
 (0)