Skip to content

Commit 59f3ca9

Browse files
kgrytekgryte
committed
feat: add C implementation
--- 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: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - 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 c18ed00 commit 59f3ca9

File tree

19 files changed

+2501
-7
lines changed

19 files changed

+2501
-7
lines changed

‎lib/node_modules/@stdlib/lapack/base/dlacpy/README.md

Lines changed: 94 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -188,21 +188,66 @@ console.log( ndarray2array( B, shape, strides, 0, order ) );
188188
### Usage
189189

190190
```c
191-
TODO
191+
#include "stdlib/lapack/base/dlacpy.h"
192192
```
193193

194-
#### TODO
194+
#### c_dlacpy( layout, uplo, M, N, \*A, LDA, \*B, LDB )
195195

196-
TODO.
196+
Copies all or part of a matrix `A` to another matrix `B`.
197197

198198
```c
199-
TODO
199+
#include "stdlib/lapack/base/shared.h"
200+
201+
const double A[] = { 1.0, 2.0, 3.0, 4.0 };
202+
double B[] = { 0.0, 0.0, 0.0, 0.0 };
203+
204+
c_dlacpy( LAPACK_ROW_MAJOR, LAPACK_UPPER_TRIANGLE, 2, 2, A, 2, B, 2 );
200205
```
201206
202-
TODO
207+
The function accepts the following arguments:
208+
209+
- **order**: `[in] LAPACK_LAYOUT` storage layout.
210+
- **uplo**: `[in] int` specifies whether to copy the upper or lower triangular/trapezoidal part of a matrix `A`.
211+
- **M**: `[in] LAPACK_INT` number of rows in `A`.
212+
- **N**: `[in] LAPACK_INT` number of columns in `A`.
213+
- **A**: `[in] double*` input matrix.
214+
- **LDA**: `[in] LAPACK_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
215+
- **B**: `[out] double*` output matrix.
216+
- **LDB**: `[in] LAPACK_INT` stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`).
217+
218+
```c
219+
LAPACK_INT c_dlacpy( const LAPACK_LAYOUT layout, const int uplo, const LAPACK_INT M, const LAPACK_INT N, const double *A, const LAPACK_INT LDA, double *B, const LAPACK_INT LDB );
220+
```
221+
222+
#### c_dlacpy_ndarray( uplo, M, N, \*A, sa1, sa2, oa, \*B, sb1, sb2, ob )
223+
224+
Copies all or part of a matrix `A` to another matrix `B` using alternative indexing semantics.
225+
226+
```c
227+
#include "stdlib/lapack/base/shared.h"
228+
229+
const double A[] = { 1.0, 2.0, 3.0, 4.0 };
230+
double B[] = { 0.0, 0.0, 0.0, 0.0 };
231+
232+
c_dlacpy_ndarray( LAPACK_UPPER_TRIANGLE, 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
233+
```
234+
235+
The function accepts the following arguments:
236+
237+
- **uplo**: `[in] int` specifies whether to copy the upper or lower triangular/trapezoidal part of a matrix `A`.
238+
- **M**: `[in] LAPACK_INT` number of rows in `A`.
239+
- **N**: `[in] LAPACK_INT` number of columns in `A`.
240+
- **A**: `[in] double*` input matrix.
241+
- **sa1**: `[in] LAPACK_INT` stride of the first dimension of `A`.
242+
- **sa2**: `[in] LAPACK_INT` stride of the second dimension of `A`.
243+
- **oa**: `[in] LAPACK_INT` starting index for `A`.
244+
- **B**: `[out] double*` output matrix.
245+
- **sb1**: `[in] LAPACK_INT` stride of the first dimension of `B`.
246+
- **sb2**: `[in] LAPACK_INT` stride of the second dimension of `B`.
247+
- **ob**: `[in] LAPACK_INT` starting index for `B`.
203248
204249
```c
205-
TODO
250+
LAPACK_INT c_dlacpy_ndarray( const int uplo, const LAPACK_INT M, const LAPACK_INT N, const double *A, const LAPACK_INT strideA1, const LAPACK_INT strideA2, const LAPACK_INT offsetA, double *B, const LAPACK_INT strideB1, const LAPACK_INT strideB2, const LAPACK_INT offsetB );
206251
```
207252

208253
</section>
@@ -224,7 +269,49 @@ TODO
224269
### Examples
225270

226271
```c
227-
TODO
272+
#include "stdlib/lapack/base/dlacpy.h"
273+
#include "stdlib/lapack/base/shared.h"
274+
#include <stdio.h>
275+
276+
int main( void ) {
277+
// Define a 3x3 input matrix stored in row-major order:
278+
const double A[ 3*3 ] = {
279+
1.0, 2.0, 3.0,
280+
4.0, 5.0, 6.0,
281+
7.0, 8.0, 9.0
282+
};
283+
284+
// Define a 3x3 output matrix:
285+
double B[ 3*3 ] = {
286+
0.0, 0.0, 0.0,
287+
0.0, 0.0, 0.0,
288+
0.0, 0.0, 0.0
289+
};
290+
291+
// Specify the number of elements along each dimension of `A`:
292+
const int M = 3;
293+
const int N = 3;
294+
295+
// Copy elements from the upper triangle of `A` to `B`:
296+
c_dlacpy( LAPACK_ROW_MAJOR, LAPACK_UPPER_TRIANGLE, M, N, A, N, B, N );
297+
298+
// Print the result:
299+
for ( int i = 0; i < M; i++ ) {
300+
for ( int j = 0; j < N; j++ ) {
301+
printf( "B[ %i, %i ] = %lf\n", i, j, B[ (i*N)+j ] );
302+
}
303+
}
304+
305+
// Copy elements from the lower triangle of `A` to `B` using alternative indexing semantics:
306+
c_dlacpy_ndarray( LAPACK_LOWER_TRIANGLE, M, N, A, N, 1, 0, B, N, 1, 0 );
307+
308+
// Print the result:
309+
for ( int i = 0; i < M; i++ ) {
310+
for ( int j = 0; j < N; j++ ) {
311+
printf( "B[ %i, %i ] = %lf\n", i, j, B[ (i*N)+j ] );
312+
}
313+
}
314+
}
228315
```
229316
230317
</section>

‎lib/node_modules/@stdlib/lapack/base/dlacpy/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.size.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)