Skip to content

Commit c21403c

Browse files
ShabiShett07ShabiShett07
committed
docs: change variable naming for blas/base/scnrm2
--- 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: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - 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: passed - task: lint_license_headers status: passed ---
1 parent ceac1d7 commit c21403c

30 files changed

+345
-345
lines changed

‎lib/node_modules/@stdlib/blas/base/scnrm2/README.md‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,33 @@ limitations under the License.
3030
var scnrm2 = require( '@stdlib/blas/base/scnrm2' );
3131
```
3232

33-
#### scnrm2( N, cx, strideX )
33+
#### scnrm2( N, x, strideX )
3434

3535
Computes the L2-norm of a complex single-precision floating-point vector.
3636

3737
```javascript
3838
var Complex64Array = require( '@stdlib/array/complex64' );
3939

40-
var cx = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2 ] );
40+
var x = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2 ] );
4141

42-
var norm = scnrm2( 4, cx, 1 );
42+
var norm = scnrm2( 4, x, 1 );
4343
// returns ~0.8
4444
```
4545

4646
The function has the following parameters:
4747

4848
- **N**: number of indexed elements.
49-
- **cx**: input [`Complex64Array`][@stdlib/array/complex64].
50-
- **strideX**: index increment for `cx`.
49+
- **x**: input [`Complex64Array`][@stdlib/array/complex64].
50+
- **strideX**: index increment for `x`.
5151

5252
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to traverse every other value,
5353

5454
```javascript
5555
var Complex64Array = require( '@stdlib/array/complex64' );
5656

57-
var cx = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
57+
var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
5858

59-
var norm = scnrm2( 2, cx, 2 );
59+
var norm = scnrm2( 2, x, 2 );
6060
// returns ~4.6
6161
```
6262

@@ -66,26 +66,26 @@ Note that indexing is relative to the first index. To introduce an offset, use [
6666
var Complex64Array = require( '@stdlib/array/complex64' );
6767

6868
// Initial array:
69-
var cx0 = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
69+
var x0 = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
7070

7171
// Create an offset view:
72-
var cx1 = new Complex64Array( cx0.buffer, cx0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
72+
var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
7373

7474
// Compute the L2-norm:
75-
var norm = scnrm2( 2, cx1, 1 );
75+
var norm = scnrm2( 2, x1, 1 );
7676
// returns ~9.3
7777
```
7878

79-
#### scnrm2.ndarray( N, cx, strideX, offset )
79+
#### scnrm2.ndarray( N, x, strideX, offset )
8080

8181
Computes the L2-norm of a complex single-precision floating-point vector using alternative indexing semantics.
8282

8383
```javascript
8484
var Complex64Array = require( '@stdlib/array/complex64' );
8585

86-
var cx = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2 ] );
86+
var x = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2 ] );
8787

88-
var norm = scnrm2.ndarray( 4, cx, 1, 0 );
88+
var norm = scnrm2.ndarray( 4, x, 1, 0 );
8989
// returns ~0.8
9090
```
9191

@@ -98,9 +98,9 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
9898
```javascript
9999
var Complex64Array = require( '@stdlib/array/complex64' );
100100

101-
var cx = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
101+
var x = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
102102

103-
var norm = scnrm2.ndarray( 2, cx, 1, 1 );
103+
var norm = scnrm2.ndarray( 2, x, 1, 1 );
104104
// returns ~9.3
105105
```
106106

@@ -135,11 +135,11 @@ function rand() {
135135
return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );
136136
}
137137

138-
var cx = filledarrayBy( 10, 'complex64', rand );
139-
console.log( cx.toString() );
138+
var x = filledarrayBy( 10, 'complex64', rand );
139+
console.log( x.toString() );
140140

141141
// Compute the L2-norm:
142-
var norm = scnrm2( cx.length, cx, 1 );
142+
var norm = scnrm2( x.length, x, 1 );
143143
console.log( norm );
144144
```
145145

@@ -173,46 +173,46 @@ console.log( norm );
173173
#include "stdlib/blas/base/scnrm2.h"
174174
```
175175

176-
#### c_scnrm2( N, \*CX, strideX )
176+
#### c_scnrm2( N, \*X, strideX )
177177

178178
Computes the L2-norm of a complex single-precision floating-point vector.
179179

180180
```c
181-
const float cx[] = { 0.3f, 0.1f, 0.5f, 0.0f, 0.0f, 0.5f, 0.0f, 0.2f };
181+
const float X[] = { 0.3f, 0.1f, 0.5f, 0.0f, 0.0f, 0.5f, 0.0f, 0.2f };
182182

183-
float norm = c_scnrm2( 4, (void *)cx, 1 );
183+
float norm = c_scnrm2( 4, (void *)X, 1 );
184184
// returns 0.8f
185185
```
186186
187187
The function accepts the following arguments:
188188
189189
- **N**: `[in] CBLAS_INT` number of indexed elements.
190-
- **CX**: `[in] void*` input array.
191-
- **strideX**: `[in] CBLAS_INT` index increment for `CX`.
190+
- **X**: `[in] void*` input array.
191+
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
192192
193193
```c
194-
float c_scnrm2( const CBLAS_INT N, const void *CX, const CBLAS_INT strideX );
194+
float c_scnrm2( const CBLAS_INT N, const void *X, const CBLAS_INT strideX );
195195
```
196196

197-
#### c_scnrm2_ndarray( N, \*CX, strideX, offsetX )
197+
#### c_scnrm2_ndarray( N, \*X, strideX, offsetX )
198198

199199
Computes the L2-norm of a complex single-precision floating-point vector using alternative indexing semantics.
200200

201201
```c
202-
const float cx[] = { 0.3f, 0.1f, 0.5f, 0.0f, 0.0f, 0.5f, 0.0f, 0.2f };
202+
const float X[] = { 0.3f, 0.1f, 0.5f, 0.0f, 0.0f, 0.5f, 0.0f, 0.2f };
203203

204-
float norm = c_scnrm2_ndarray( 4, (void *)cx, 1, 0 );
204+
float norm = c_scnrm2_ndarray( 4, (void *)X, 1, 0 );
205205
// returns 0.8f
206206
```
207207
208208
The function accepts the following arguments:
209209
210210
- **N**: `[in] CBLAS_INT` number of indexed elements.
211-
- **CX**: `[in] void*` input array.
212-
- **strideX**: `[in] CBLAS_INT` index increment for `CX`.
211+
- **X**: `[in] void*` input array.
212+
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
213213
214214
```c
215-
float c_scnrm2_ndarray( const CBLAS_INT N, const void *CX, const CBLAS_INT strideX, const CBLAS_INT offsetX );
215+
float c_scnrm2_ndarray( const CBLAS_INT N, const void *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
216216
```
217217

218218
</section>
@@ -239,7 +239,7 @@ float c_scnrm2_ndarray( const CBLAS_INT N, const void *CX, const CBLAS_INT strid
239239

240240
int main( void ) {
241241
// Create a strided array of interleaved real and imaginary components:
242-
const float cx[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
242+
const float X[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
243243

244244
// Specify the number of elements:
245245
const int N = 4;
@@ -248,13 +248,13 @@ int main( void ) {
248248
const int strideX = 1;
249249

250250
// Compute the L2-norm:
251-
float norm = c_scnrm2( N, (void *)cx, strideX );
251+
float norm = c_scnrm2( N, (void *)X, strideX );
252252

253253
// Print the result:
254254
printf( "L2-norm: %f\n", norm );
255255

256256
// Compute the L2-norm using alternative indexing semantics:
257-
norm = c_scnrm2_ndarray( N, (void *)cx, -strideX, N-1 );
257+
norm = c_scnrm2_ndarray( N, (void *)X, -strideX, N-1 );
258258

259259
// Print the result:
260260
printf( "L2-norm: %f\n", norm );

‎lib/node_modules/@stdlib/blas/base/scnrm2/benchmark/benchmark.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ var options = {
4646
* @returns {Function} benchmark function
4747
*/
4848
function createBenchmark( len ) {
49-
var cx = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
49+
var x = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
5050
return benchmark;
5151

5252
function benchmark( b ) {
@@ -55,7 +55,7 @@ function createBenchmark( len ) {
5555

5656
b.tic();
5757
for ( i = 0; i < b.iterations; i++ ) {
58-
norm = scnrm2( cx.length, cx, 1 );
58+
norm = scnrm2( x.length, x, 1 );
5959
if ( isnanf( norm ) ) {
6060
b.fail( 'should not return NaN' );
6161
}

‎lib/node_modules/@stdlib/blas/base/scnrm2/benchmark/benchmark.native.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ var options = {
5151
* @returns {Function} benchmark function
5252
*/
5353
function createBenchmark( len ) {
54-
var cx = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
54+
var x = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
5555
return benchmark;
5656

5757
function benchmark( b ) {
@@ -60,7 +60,7 @@ function createBenchmark( len ) {
6060

6161
b.tic();
6262
for ( i = 0; i < b.iterations; i++ ) {
63-
norm = scnrm2( cx.length, cx, 1 );
63+
norm = scnrm2( x.length, x, 1 );
6464
if ( isnanf( norm ) ) {
6565
b.fail( 'should not return NaN' );
6666
}

‎lib/node_modules/@stdlib/blas/base/scnrm2/benchmark/benchmark.ndarray.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ var options = {
4646
* @returns {Function} benchmark function
4747
*/
4848
function createBenchmark( len ) {
49-
var cx = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
49+
var x = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
5050
return benchmark;
5151

5252
function benchmark( b ) {
@@ -55,7 +55,7 @@ function createBenchmark( len ) {
5555

5656
b.tic();
5757
for ( i = 0; i < b.iterations; i++ ) {
58-
norm = scnrm2( cx.length, cx, 1, 0 );
58+
norm = scnrm2( x.length, x, 1, 0 );
5959
if ( isnanf( norm ) ) {
6060
b.fail( 'should not return NaN' );
6161
}

‎lib/node_modules/@stdlib/blas/base/scnrm2/benchmark/benchmark.ndarray.native.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ var options = {
5151
* @returns {Function} benchmark function
5252
*/
5353
function createBenchmark( len ) {
54-
var cx = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
54+
var x = new Complex64Array( uniform( len*2, -10.0, 10.0, options ) );
5555
return benchmark;
5656

5757
function benchmark( b ) {
@@ -60,7 +60,7 @@ function createBenchmark( len ) {
6060

6161
b.tic();
6262
for ( i = 0; i < b.iterations; i++ ) {
63-
norm = scnrm2( cx.length, cx, 1, 0 );
63+
norm = scnrm2( x.length, x, 1, 0 );
6464
if ( isnanf( norm ) ) {
6565
b.fail( 'should not return NaN' );
6666
}

‎lib/node_modules/@stdlib/blas/base/scnrm2/benchmark/c/benchmark.length.c‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,20 @@ static float rand_float( void ) {
9595
* @return elapsed time in seconds
9696
*/
9797
static double benchmark1( int iterations, int len ) {
98-
float cx[ len*2 ];
98+
float X[ len*2 ];
9999
double elapsed;
100100
float norm;
101101
double t;
102102
int i;
103103

104104
for ( i = 0; i < len*2; i += 2 ) {
105-
cx[ i ] = ( rand_float()*10000.0f ) - 5000.0f;
106-
cx[ i+1 ] = ( rand_float()*10000.0f ) - 5000.0f;
105+
X[ i ] = ( rand_float()*10000.0f ) - 5000.0f;
106+
X[ i+1 ] = ( rand_float()*10000.0f ) - 5000.0f;
107107
}
108108
norm = 0.0f;
109109
t = tic();
110110
for ( i = 0; i < iterations; i++ ) {
111-
norm = c_scnrm2( len, (void *)cx, 1 );
111+
norm = c_scnrm2( len, (void *)X, 1 );
112112
if ( norm != norm ) {
113113
printf( "should not return NaN\n" );
114114
break;
@@ -129,20 +129,20 @@ static double benchmark1( int iterations, int len ) {
129129
* @return elapsed time in seconds
130130
*/
131131
static double benchmark2( int iterations, int len ) {
132-
float cx[ len*2 ];
132+
float X[ len*2 ];
133133
double elapsed;
134134
float norm;
135135
double t;
136136
int i;
137137

138138
for ( i = 0; i < len*2; i += 2 ) {
139-
cx[ i ] = ( rand_float()*10000.0f ) - 5000.0f;
140-
cx[ i+1 ] = ( rand_float()*10000.0f ) - 5000.0f;
139+
X[ i ] = ( rand_float()*10000.0f ) - 5000.0f;
140+
X[ i+1 ] = ( rand_float()*10000.0f ) - 5000.0f;
141141
}
142142
norm = 0.0f;
143143
t = tic();
144144
for ( i = 0; i < iterations; i++ ) {
145-
norm = c_scnrm2_ndarray( len, (void *)cx, 1, 0 );
145+
norm = c_scnrm2_ndarray( len, (void *)X, 1, 0 );
146146
if ( norm != norm ) {
147147
printf( "should not return NaN\n" );
148148
break;

‎lib/node_modules/@stdlib/blas/base/scnrm2/benchmark/fortran/benchmark.length.f‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ double precision function benchmark( iterations, len )
124124
! ..
125125
! External functions:
126126
interface
127-
real function scnrm2( N, cx, strideX )
128-
complex :: cx(*)
127+
real function scnrm2( N, x, strideX )
128+
complex :: x(*)
129129
integer :: strideX, N
130130
end function scnrm2
131131
end interface
@@ -217,4 +217,4 @@ subroutine main()
217217
end do
218218
call print_summary( count, count )
219219
end subroutine main
220-
end program bench
220+
end program bench

0 commit comments

Comments
 (0)