Skip to content

Commit 7cfc153

Browse files
committed
feat: add blas/base/zaxpy
--- 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 f07b52e commit 7cfc153

File tree

21 files changed

+3577
-3
lines changed

21 files changed

+3577
-3
lines changed

lib/node_modules/@stdlib/blas/base/zaxpy/README.md

Lines changed: 158 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ The function has the following parameters:
5151
- **N**: number of indexed elements.
5252
- **alpha**: scalar [`Complex128`][@stdlib/complex/float64/ctor] constant.
5353
- **x**: first input [`Complex128Array`][@stdlib/array/complex128].
54-
- **strideX**: index increment for `x`.
54+
- **strideX**: stride length for `x`.
5555
- **y**: second input [`Complex128Array`][@stdlib/array/complex128].
56-
- **strideY**: index increment for `y`.
56+
- **strideY**: stride length for `y`.
5757

5858
The `N` and stride parameters determine how values from `x` are scaled by `alpha` and added to `y`. For example, to scale every other value in `x` by `alpha` and add the result to every other value of `y`,
5959

@@ -137,6 +137,7 @@ zaxpy.ndarray( 3, alpha, x, 1, 1, y, 1, 1 );
137137
## Notes
138138

139139
- If `N <= 0`, both functions return `y` unchanged.
140+
- If `alpha === 0`, both functions return `y` unchanged.
140141
- `zaxpy()` corresponds to the [BLAS][blas] level 1 function [`zaxpy`][zaxpy].
141142

142143
</section>
@@ -171,6 +172,14 @@ var alpha = new Complex128( 2.0, 2.0 );
171172
// Scale values from `x` by `alpha` and add the result to `y`:
172173
zaxpy( x.length, alpha, x, 1, y, 1 );
173174

175+
// Print the results:
176+
logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );
177+
178+
yc = zcopy( y.length, y, 1, zeros( y.length, 'complex128' ), 1 );
179+
180+
// Scale values from `x` by `alpha` and add the result to `y` using alternative indexing semantics:
181+
zaxpy.ndarray( x.length, alpha, x, 1, 0, y, 1, 0 );
182+
174183
// Print the results:
175184
logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );
176185
```
@@ -179,6 +188,152 @@ logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );
179188

180189
<!-- /.examples -->
181190

191+
<!-- C interface documentation. -->
192+
193+
* * *
194+
195+
<section class="c">
196+
197+
## C APIs
198+
199+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
200+
201+
<section class="intro">
202+
203+
</section>
204+
205+
<!-- /.intro -->
206+
207+
<!-- C usage documentation. -->
208+
209+
<section class="usage">
210+
211+
### Usage
212+
213+
```c
214+
#include "stdlib/blas/base/zaxpy.h"
215+
```
216+
217+
#### c_zaxpy( N, alpha, \*X, strideX, \*Y, strideY )
218+
219+
Scales values from `X` by `alpha` and adds the result to `Y`.
220+
221+
```c
222+
#include "stdlib/complex/float32/ctor.h"
223+
224+
float x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
225+
float y[] = { -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 };
226+
const stdlib_complex128_t alpha = stdlib_complex128( 2.0, 2.0 );
227+
228+
c_zaxpy( 4, alpha, (void *)x, 1, (void *)y, 1 );
229+
```
230+
231+
The function accepts the following arguments:
232+
233+
- **N**: `[in] CBLAS_INT` number of indexed elements.
234+
- **alpha**: `[in] stdlib_complex128_t` scalar constant.
235+
- **X**: `[in] void*` input array.
236+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
237+
- **Y**: `[inout] void*` output array.
238+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
239+
240+
```c
241+
void c_zaxpy( const CBLAS_INT N, const stdlib_complex128_t alpha, const void *x, const CBLAS_INT strideX, void *y, const CBLAS_INT strideY );
242+
```
243+
244+
#### c_zaxpy_ndarray( N, alpha, \*X, strideX, offsetX, \*Y, strideY, offsetY )
245+
246+
Scales values from `X` by `alpha` and adds the result to `Y` using alternative indexing semantics.
247+
248+
```c
249+
#include "stdlib/complex/float32/ctor.h"
250+
251+
float x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
252+
float y[] = { -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 };
253+
const stdlib_complex128_t alpha = stdlib_complex128( 2.0, 2.0 );
254+
255+
c_zaxpy_ndarray( 4, alpha, (void *)x, 1, 0, (void *)y, 1, 0 );
256+
```
257+
258+
The function accepts the following arguments:
259+
260+
- **N**: `[in] CBLAS_INT` number of indexed elements.
261+
- **alpha**: `[in] stdlib_complex128_t` scalar constant.
262+
- **X**: `[in] void*` input array.
263+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
264+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
265+
- **Y**: `[inout] void*` output array.
266+
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
267+
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
268+
269+
```c
270+
void c_zaxpy_ndarray( const CBLAS_INT N, const stdlib_complex128_t alpha, const void *x, const CBLAS_INT strideX, const CBLAS_INT offsetX, void *y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
271+
```
272+
273+
</section>
274+
275+
<!-- /.usage -->
276+
277+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
278+
279+
<section class="notes">
280+
281+
</section>
282+
283+
<!-- /.notes -->
284+
285+
<!-- C API usage examples. -->
286+
287+
<section class="examples">
288+
289+
### Examples
290+
291+
```c
292+
#include "stdlib/blas/base/zaxpy.h"
293+
#include "stdlib/complex/float32/ctor.h"
294+
#include <stdio.h>
295+
296+
int main( void ) {
297+
// Create strided arrays:
298+
double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
299+
double y[] = { 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 };
300+
301+
// Create a complex scalar:
302+
const stdlib_complex128_t alpha = stdlib_complex128( 2.0, 2.0 );
303+
304+
// Specify the number of elements:
305+
const int N = 4;
306+
307+
// Specify stride lengths:
308+
const int strideX = 1;
309+
const int strideY = 1;
310+
311+
// Scale values from `x` by `alpha` and add the result to `y`:
312+
c_zaxpy( N, alpha, (void *)x, strideX, (void *)y, strideY );
313+
314+
// Print the result:
315+
for ( int i = 0; i < N; i++ ) {
316+
printf( "zaxpy[ %i ] = %lf + %lfj\n", i, y[ i * 2 ], y[ ( i * 2 ) + 1 ] );
317+
}
318+
319+
// Scale values from `x` by `alpha` and add the result to `y` using alternative indexing semantics:
320+
c_zaxpy_ndarray( N, alpha, (void *)x, strideX, 0, (void *)y, strideY, 0 );
321+
322+
// Print the result:
323+
for ( int i = 0; i < N; i++ ) {
324+
printf( "zaxpy[ %i ] = %lf + %lfj\n", i, y[ i * 2 ], y[ ( i * 2 ) + 1 ] );
325+
}
326+
}
327+
```
328+
329+
</section>
330+
331+
<!-- /.examples -->
332+
333+
</section>
334+
335+
<!-- /.c -->
336+
182337
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
183338
184339
<section class="related">
@@ -193,7 +348,7 @@ logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );
193348
194349
[blas]: http://www.netlib.org/blas
195350
196-
[zaxpy]: https://www.netlib.org/lapack/explore-html/d5/d4b/group__axpy_ga0b7bac1f4d42514074a48f14f5f9caa0.html#ga0b7bac1f4d42514074a48f14f5f9caa0
351+
[zaxpy]: https://www.netlib.org/lapack/explore-html/d5/d4b/group__axpy_gaf603daa00d5c723d0e409d9b2d011bf4.html
197352
198353
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
199354
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)