Skip to content

Commit 2f70ccc

Browse files
committed
Auto-generated commit
1 parent c4b99cb commit 2f70ccc

File tree

9 files changed

+305
-6
lines changed

9 files changed

+305
-6
lines changed

.github/.keepalive

Lines changed: 0 additions & 1 deletion
This file was deleted.

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2024-09-01)
7+
## Unreleased (2024-09-12)
88

99
<section class="commits">
1010

1111
### Commits
1212

1313
<details>
1414

15+
- [`00651e7`](https://github.com/stdlib-js/stdlib/commit/00651e7847283dadfb29ef6c90addd78380a3c5b) - **refactor:** use `const` qualifier and update examples _(by Athan Reines)_
1516
- [`2777e4b`](https://github.com/stdlib-js/stdlib/commit/2777e4be161869d09406e3b17947d24c64b47af2) - **bench:** resolve lint errors in benchmarks _(by Athan Reines)_
1617

1718
</details>

CONTRIBUTORS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com>
2626
Frank Kovacs <fran70kk@gmail.com>
2727
Golden Kumar <103646877+AuenKr@users.noreply.github.com>
2828
Gunj Joshi <gunjjoshi8372@gmail.com>
29+
HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
2930
Harshita Kalani <harshitakalani02@gmail.com>
3031
Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
3132
Jaimin Godhani <112328542+Jai0401@users.noreply.github.com>
3233
James Gelok <jdgelok@gmail.com>
3334
Jaysukh Makvana <jaysukhmakvana2004@gmail.com>
35+
Jenish Thapa <141203631+jenish-thapa@users.noreply.github.com>
3436
Jithin KS <jithinks112@gmail.com>
3537
Joel Mathew Koshy <joelmathewkoshy@gmail.com>
3638
Joey Reed <joeyrreed@gmail.com>
@@ -86,8 +88,10 @@ Stephannie Jiménez Gacha <steff456@hotmail.com>
8688
Suraj kumar <125961509+kumarsuraj212003@users.noreply.github.com>
8789
Tirtadwipa Manunggal <tirtadwipa.manunggal@gmail.com>
8890
Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com>
91+
Tufailahmed Bargir <142114244+Tufailahmed-Bargir@users.noreply.github.com>
8992
Utkarsh <http://utkarsh11105@gmail.com>
9093
Utkarsh Raj <rajutkarsh2505@gmail.com>
94+
Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
9195
Varad Gupta <varadgupta21@gmail.com>
9296
Xiaochuan Ye <tap91624@gmail.com>
9397
Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
@@ -96,3 +100,4 @@ nishant-s7 <97207366+nishant-s7@users.noreply.github.com>
96100
orimiles5 <97595296+orimiles5@users.noreply.github.com>
97101
rainn <88160429+AmCodesLame@users.noreply.github.com>
98102
rei2hu <reimu@reimu.ws>
103+
yaswanth <116426380+yaswanthkosuru@users.noreply.github.com>

README.md

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ limitations under the License.
2929
<p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
3030
</details>
3131

32-
# Min View Buffer Index
32+
# minViewBufferIndex
3333

3434
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
3535

@@ -155,6 +155,112 @@ for ( i = 0; i < 100; i++ ) {
155155

156156
<!-- /.examples -->
157157

158+
<!-- C interface documentation. -->
159+
160+
* * *
161+
162+
<section class="c">
163+
164+
## C APIs
165+
166+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
167+
168+
<section class="intro">
169+
170+
</section>
171+
172+
<!-- /.intro -->
173+
174+
<!-- C usage documentation. -->
175+
176+
<section class="usage">
177+
178+
### Usage
179+
180+
```c
181+
#include "stdlib/ndarray/base/min_view_buffer_index.h"
182+
```
183+
184+
#### stdlib_ndarray_min_view_buffer_index( ndims, \*shape, \*strides, offset )
185+
186+
Computes the minimum linear index (in bytes) in an underlying data buffer accessible to an array view.
187+
188+
```c
189+
#include <stdint.h>
190+
191+
int64_t ndims = 2;
192+
int64_t shape[] = { 10, 10 };
193+
int64_t strides[] = { 10, 1 };
194+
int64_t offset = 10;
195+
196+
int64_t idx = stdlib_ndarray_min_view_buffer_index( ndims, shape, strides, offset );
197+
// returns 10
198+
```
199+
200+
The function accepts the following arguments:
201+
202+
- **ndims**: `[in] int64_t` number of dimensions.
203+
- **shape**: `[in] int64_t*` array shape (dimensions).
204+
- **strides**: `[in] int64_t*` array strides (in bytes).
205+
- **offset**: `[in] int64_t` index offset.
206+
207+
```c
208+
int64_t stdlib_ndarray_min_view_buffer_index( const int64_t ndims, const int64_t *shape, const int64_t *strides, const int64_t offset );
209+
```
210+
211+
</section>
212+
213+
<!-- /.usage -->
214+
215+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
216+
217+
<section class="notes">
218+
219+
</section>
220+
221+
<!-- /.notes -->
222+
223+
<!-- C API usage examples. -->
224+
225+
<section class="examples">
226+
227+
### Examples
228+
229+
```c
230+
#include "stdlib/ndarray/base/min_view_buffer_index.h"
231+
#include <stdint.h>
232+
#include <stdio.h>
233+
#include <inttypes.h>
234+
235+
int main( void ) {
236+
// Specify the number of dimensions:
237+
const int64_t ndims = 2;
238+
239+
// Define an array shape:
240+
const int64_t shape[] = { 10, 10 };
241+
242+
// Define array strides:
243+
const int64_t strides[] = { -2, 5 };
244+
245+
// Define an offset:
246+
const int64_t offset = 100;
247+
248+
// Compute the minimum accessible index:
249+
int64_t idx = stdlib_ndarray_min_view_buffer_index( ndims, shape, strides, offset );
250+
251+
// Print the results:
252+
printf( "idx: %"PRId64"\n", idx );
253+
}
254+
```
255+
256+
</section>
257+
258+
<!-- /.examples -->
259+
260+
</section>
261+
262+
<!-- /.c -->
263+
158264
<!-- 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. -->
159265
160266
<section class="references">

benchmark/c/benchmark.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@
1616
* limitations under the License.
1717
*/
1818

19+
#include "stdlib/ndarray/base/min_view_buffer_index.h"
1920
#include <stdlib.h>
2021
#include <stdio.h>
2122
#include <stdint.h>
2223
#include <math.h>
2324
#include <time.h>
2425
#include <sys/time.h>
25-
#include "stdlib/ndarray/base/min_view_buffer_index.h"
2626

2727
#define NAME "min-view-buffer-index"
2828
#define ITERATIONS 1000000

examples/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 := example.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 examples.
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

examples/c/example.c

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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/ndarray/base/min_view_buffer_index.h"
20+
#include <stdint.h>
21+
#include <stdio.h>
22+
#include <inttypes.h>
23+
24+
int main( void ) {
25+
// Specify the number of dimensions:
26+
const int64_t ndims = 2;
27+
28+
// Define an array shape:
29+
const int64_t shape[] = { 10, 10 };
30+
31+
// Define array strides:
32+
const int64_t strides[] = { -2, 5 };
33+
34+
// Define an offset:
35+
const int64_t offset = 100;
36+
37+
// Compute the minimum accessible index:
38+
int64_t idx = stdlib_ndarray_min_view_buffer_index( ndims, shape, strides, offset );
39+
40+
// Print the results:
41+
printf( "idx: %"PRId64"\n", idx );
42+
}

include/stdlib/ndarray/base/min_view_buffer_index.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ extern "C" {
3131
/**
3232
* Computes the minimum linear index (in bytes) in an underlying data buffer accessible to an array view.
3333
*/
34-
int64_t stdlib_ndarray_min_view_buffer_index( int64_t ndims, int64_t *shape, int64_t *strides, int64_t offset );
34+
int64_t stdlib_ndarray_min_view_buffer_index( const int64_t ndims, const int64_t *shape, const int64_t *strides, const int64_t offset );
3535

3636
#ifdef __cplusplus
3737
}

src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
* int64_t idx = stdlib_ndarray_min_view_buffer_index( ndims, shape, strides, offset );
4141
* // returns 10
4242
*/
43-
int64_t stdlib_ndarray_min_view_buffer_index( int64_t ndims, int64_t *shape, int64_t *strides, int64_t offset ) {
43+
int64_t stdlib_ndarray_min_view_buffer_index( const int64_t ndims, const int64_t *shape, const int64_t *strides, const int64_t offset ) {
4444
int64_t idx;
4545
int64_t i;
4646

0 commit comments

Comments
 (0)