Skip to content

Commit 381863c

Browse files
iampratik13iampratik13
committed
feat: add C implementation for lapack/base/dlassq
--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent ed8d4b1 commit 381863c

19 files changed

Lines changed: 2129 additions & 7 deletions

File tree

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

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -185,23 +185,54 @@ console.log( out );
185185
### Usage
186186

187187
```c
188-
TODO
188+
#include "stdlib/lapack/base/dlassq.h"
189189
```
190190

191-
#### TODO
191+
#### c\_dlassq( N, \*X, incX, \*scale, \*sumsq )
192192

193-
TODO.
193+
Returns an updated sum of squares represented in scaled form.
194194

195195
```c
196-
TODO
196+
double X[] = { 1.0, 2.0, 3.0, 4.0 };
197+
double scale = 1.0;
198+
double sumsq = 0.0;
199+
200+
c_dlassq( 4, X, 1, &scale, &sumsq );
201+
// scale => 1.0
202+
// sumsq => 30.0
197203
```
198204
199-
TODO
205+
The function has the following parameters:
206+
207+
- **N**: `[in] LAPACK_INT` number of indexed elements.
208+
- **X**: `[in] double*` input array.
209+
- **incX**: `[in] LAPACK_INT` stride length for `X`.
210+
- **scale**: `[in,out] double*` pointer to scaling factor.
211+
- **sumsq**: `[in,out] double*` pointer to sum of squares.
212+
213+
#### c\_dlassq\_ndarray( N, \*X, strideX, offsetX, \*scale, \*sumsq )
214+
215+
Returns an updated sum of squares represented in scaled form using alternative indexing semantics.
200216
201217
```c
202-
TODO
218+
double X[] = { 0.0, 1.0, 2.0, 3.0, 4.0 };
219+
double scale = 1.0;
220+
double sumsq = 0.0;
221+
222+
c_dlassq_ndarray( 4, X, 1, 1, &scale, &sumsq );
223+
// scale => 1.0
224+
// sumsq => 30.0
203225
```
204226

227+
The function has the following parameters:
228+
229+
- **N**: `[in] LAPACK_INT` number of indexed elements.
230+
- **X**: `[in] double*` input array.
231+
- **strideX**: `[in] LAPACK_INT` stride length for `X`.
232+
- **offsetX**: `[in] LAPACK_INT` starting index for `X`.
233+
- **scale**: `[in,out] double*` pointer to scaling factor.
234+
- **sumsq**: `[in,out] double*` pointer to sum of squares.
235+
205236
</section>
206237

207238
<!-- /.usage -->
@@ -221,7 +252,32 @@ TODO
221252
### Examples
222253

223254
```c
224-
TODO
255+
#include "stdlib/lapack/base/dlassq.h"
256+
#include <stdio.h>
257+
258+
int main( void ) {
259+
// Create a strided array:
260+
double X[] = { 1.0, 2.0, 3.0, 4.0 };
261+
262+
// Specify the number of elements:
263+
const int N = 4;
264+
265+
// Specify the stride length:
266+
const int strideX = 1;
267+
268+
// Initialize scaling factor and sum of squares:
269+
double scale = 1.0;
270+
double sumsq = 0.0;
271+
272+
// Compute the updated sum of squares in scaled form:
273+
c_dlassq( N, X, strideX, &scale, &sumsq );
274+
275+
// Print the results:
276+
printf( "scale: %f\n", scale );
277+
printf( "sumsq: %f\n", sumsq );
278+
279+
return 0;
280+
}
225281
```
226282
227283
</section>

‎lib/node_modules/@stdlib/lapack/base/dlassq/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) 2026 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)