Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
f07b52e
chore: revert other file changes
ShabiShett07 Jul 9, 2025
7cfc153
feat: add blas/base/zaxpy
ShabiShett07 Jul 9, 2025
bd41f53
fix: restore accidentally deleted test.main.js
ShabiShett07 Jul 9, 2025
774d814
docs: changes in jsdoc
ShabiShett07 Jul 9, 2025
85f32fa
bench: change len to N
Aug 12, 2025
21e06db
docs: update jsdoc
Aug 12, 2025
5e810b8
chore: update example
Aug 12, 2025
5d18f71
chore: update markdown
Aug 12, 2025
db8f8d1
chore: update example
Aug 12, 2025
02a86fd
Merge remote-tracking branch 'upstream/develop' into feature/c/zaxpy
stdlib-bot Aug 12, 2025
8a267f4
chore: update binding.gyp
Aug 12, 2025
a1546ab
chore: update include.gypi
Aug 12, 2025
d8b965b
bench: add native and fortran benchmarks
Aug 12, 2025
c992597
chore: add FORTRAN implementation
Aug 14, 2025
cd22030
chore: update package name
Aug 14, 2025
e86b6de
chore: update package name
Aug 14, 2025
4ff51c9
chore: update FORTRAN
Aug 14, 2025
e05707e
chore: update FORTRAN
Aug 14, 2025
736333c
chore: update FORTRAN
Aug 14, 2025
77a536a
chore: add include file for FORTRAN
Aug 14, 2025
8bd7a53
remove: unused packages
Aug 14, 2025
d1e7cde
chore: update package name
Aug 14, 2025
4a43dd0
chore: update package name
Aug 14, 2025
90bead4
chore: fix FORTRAN errors
Aug 14, 2025
beb3611
chore: fix FORTRAN errors
Aug 14, 2025
7252cc6
chore: fix FORTRAN errors
Aug 14, 2025
debc632
chore: fix FORTRAN errors
Aug 14, 2025
761f4ec
chore: fix FORTRAN errors
Aug 14, 2025
ab325fd
chore: fix FORTRAN errors
Aug 14, 2025
39ea5a3
remove: fortran in manifest
Aug 15, 2025
bda1604
remove: fortran benchmark
Aug 15, 2025
33396ac
chore: update c implementation
Aug 17, 2025
06ddfe9
chore: update manifest.json
Aug 17, 2025
fd5f6b1
chore: remove unused packages
Aug 17, 2025
1ce18ba
chore: update manifest.json
Aug 17, 2025
d3edb41
chore: update manifest.json
Aug 17, 2025
3be4a38
chore: update copyright years
stdlib-bot Aug 17, 2025
0c8b93b
build: add missing configurations
kgryte Aug 19, 2025
69f26df
chore: add ndarray api
Aug 23, 2025
6218e59
chore: clean-up
kgryte Aug 23, 2025
941db7d
Merge remote-tracking branch 'upstream/develop' into feature/c/zaxpy
stdlib-bot Aug 23, 2025
2dbe871
test: address test failures
kgryte Aug 23, 2025
fb725a8
Merge branch 'feature/c/zaxpy' of https://github.com/shabishett07/std…
kgryte Aug 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 158 additions & 3 deletions lib/node_modules/@stdlib/blas/base/zaxpy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ The function has the following parameters:
- **N**: number of indexed elements.
- **alpha**: scalar [`Complex128`][@stdlib/complex/float64/ctor] constant.
- **x**: first input [`Complex128Array`][@stdlib/array/complex128].
- **strideX**: index increment for `x`.
- **strideX**: stride length for `x`.
- **y**: second input [`Complex128Array`][@stdlib/array/complex128].
- **strideY**: index increment for `y`.
- **strideY**: stride length for `y`.

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`,

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

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

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

// Print the results:
logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );

yc = zcopy( y.length, y, 1, zeros( y.length, 'complex128' ), 1 );

// Scale values from `x` by `alpha` and add the result to `y` using alternative indexing semantics:
zaxpy.ndarray( x.length, alpha, x, 1, 0, y, 1, 0 );

// Print the results:
logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );
```
Expand All @@ -179,6 +188,152 @@ logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/blas/base/zaxpy.h"
```

#### c_zaxpy( N, alpha, \*X, strideX, \*Y, strideY )

Scales values from `X` by `alpha` and adds the result to `Y`.

```c
#include "stdlib/complex/float32/ctor.h"

float x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
float y[] = { -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 };
const stdlib_complex128_t alpha = stdlib_complex128( 2.0, 2.0 );

c_zaxpy( 4, alpha, (void *)x, 1, (void *)y, 1 );
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **alpha**: `[in] stdlib_complex128_t` scalar constant.
- **X**: `[in] void*` input array.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
- **Y**: `[inout] void*` output array.
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.

```c
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 );
```

#### c_zaxpy_ndarray( N, alpha, \*X, strideX, offsetX, \*Y, strideY, offsetY )

Scales values from `X` by `alpha` and adds the result to `Y` using alternative indexing semantics.

```c
#include "stdlib/complex/float32/ctor.h"

float x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
float y[] = { -1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0 };
const stdlib_complex128_t alpha = stdlib_complex128( 2.0, 2.0 );

c_zaxpy_ndarray( 4, alpha, (void *)x, 1, 0, (void *)y, 1, 0 );
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **alpha**: `[in] stdlib_complex128_t` scalar constant.
- **X**: `[in] void*` input array.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
- **Y**: `[inout] void*` output array.
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.

```c
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 );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/blas/base/zaxpy.h"
#include "stdlib/complex/float32/ctor.h"
#include <stdio.h>

int main( void ) {
// Create strided arrays:
double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
double y[] = { 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 };

// Create a complex scalar:
const stdlib_complex128_t alpha = stdlib_complex128( 2.0, 2.0 );

// Specify the number of elements:
const int N = 4;

// Specify stride lengths:
const int strideX = 1;
const int strideY = 1;

// Scale values from `x` by `alpha` and add the result to `y`:
c_zaxpy( N, alpha, (void *)x, strideX, (void *)y, strideY );

// Print the result:
for ( int i = 0; i < N; i++ ) {
printf( "zaxpy[ %i ] = %lf + %lfj\n", i, y[ i * 2 ], y[ ( i * 2 ) + 1 ] );
}

// Scale values from `x` by `alpha` and add the result to `y` using alternative indexing semantics:
c_zaxpy_ndarray( N, alpha, (void *)x, strideX, 0, (void *)y, strideY, 0 );

// Print the result:
for ( int i = 0; i < N; i++ ) {
printf( "zaxpy[ %i ] = %lf + %lfj\n", i, y[ i * 2 ], y[ ( i * 2 ) + 1 ] );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">
Expand All @@ -193,7 +348,7 @@ logEach( '(%s)*(%s) + (%s) = %s', alpha, x, yc, y );

[blas]: http://www.netlib.org/blas

[zaxpy]: https://www.netlib.org/lapack/explore-html/d5/d4b/group__axpy_ga0b7bac1f4d42514074a48f14f5f9caa0.html#ga0b7bac1f4d42514074a48f14f5f9caa0
[zaxpy]: https://www.netlib.org/lapack/explore-html/d5/d4b/group__axpy_gaf603daa00d5c723d0e409d9b2d011bf4.html

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

Expand Down
146 changes: 146 additions & 0 deletions lib/node_modules/@stdlib/blas/base/zaxpy/benchmark/c/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2025 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# VARIABLES #

ifndef VERBOSE
QUIET := @
else
QUIET :=
endif

# Determine the OS ([1][1], [2][2]).
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
else
ifneq (, $(findstring Windows_NT,$(OS)))
OS := WINNT
endif
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate position independent code ([1][1], [2][2]).
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
INCLUDE ?=

# List of source files:
SOURCE_FILES ?=

# List of libraries (e.g., `-lopenblas -lpthread`):
LIBRARIES ?=

# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
LIBPATH ?=

# List of C targets:
c_targets := benchmark.length.out


# RULES #

#/
# Compiles source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
# @param {string} [SOURCE_FILES] - list of source files
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler (e.g., `gcc`)
# @param {string} CFLAGS - C compiler options
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
# @param {string} SOURCE_FILES - list of source files
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)

#/
# Runs compiled benchmarks.
#
# @example
# make run
#/
run: $(c_targets)
$(QUIET) ./$<

.PHONY: run

#/
# Removes generated files.
#
# @example
# make clean
#/
clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading
Loading