Skip to content

Commit d74a322

Browse files
gunjjoshigunjjoshi
committed
docs: update parameter descriptions, disable eslint max len at top level
1 parent 825ca7f commit d74a322

File tree

9 files changed

+111
-102
lines changed

9 files changed

+111
-102
lines changed

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/c1_ref.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@
6464
* Performs a pass of the FFT algorithm.
6565
*
6666
* @private
67-
* @param {number} a1 - Index of first dimension.
68-
* @param {number} a2 - Index of second dimension.
69-
* @param {number} a3 - Index of third dimension.
70-
* @param {number} l1 - Length parameter related to the FFT stage.
71-
* @param {number} ido - Dimension order.
72-
* @returns {number} - Calculated index.
67+
* @param {number} a1 - index of first dimension
68+
* @param {number} a2 - index of second dimension
69+
* @param {number} a3 - index of third dimension
70+
* @param {number} l1 - length parameter related to the FFT stage
71+
* @param {number} ido - dimension order
72+
* @returns {number} - calculated index
7373
*/
7474
function c1Ref( a1, a2, a3, l1, ido ) {
7575
return ( ( ( a3 * l1 ) + a2 ) * ido ) + a1;

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/c2_ref.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@
6464
* Performs a pass of the FFT algorithm.
6565
*
6666
* @private
67-
* @param {number} a1 - Index of first dimension.
68-
* @param {number} a2 - Index of second dimension.
69-
* @param {Float64Array} c2 - Secondary intermediate array for FFT computations.
70-
* @param {number} idl1 - Stride related to the `l1` parameter.
71-
* @returns {number} - Calculated index.
67+
* @param {number} a1 - index of first dimension
68+
* @param {number} a2 - index of second dimension
69+
* @param {Float64Array} c2 - secondary intermediate array for FFT computations
70+
* @param {number} idl1 - stride related to the `l1` parameter
71+
* @returns {number} - calculated index
7272
*/
7373
function c2Ref( a1, a2, idl1 ) {
7474
return ( a2 * idl1 ) + a1;

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/cc_ref.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@
6464
* Performs a pass of the FFT algorithm.
6565
*
6666
* @private
67-
* @param {number} a1 - Index of first dimension.
68-
* @param {number} a2 - Index of second dimension.
69-
* @param {number} a3 - Index of third dimension.
70-
* @param {number} ip - Number of sub-steps or prime factors in the FFT.
71-
* @param {number} ido - Dimension order.
72-
* @returns {number} - Calculated index.
67+
* @param {number} a1 - index of first dimension
68+
* @param {number} a2 - index of second dimension
69+
* @param {number} a3 - index of third dimension
70+
* @param {number} ip - number of sub-steps or prime factors in the FFT
71+
* @param {number} ido - dimension order
72+
* @returns {number} - calculated index
7373
*/
7474
function ccRef ( a1, a2, a3, ip, ido ) {
7575
return ( ( ( a3 * ip ) + a2 ) * ido ) + a1;

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/ch2_ref.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@
6464
* Performs a pass of the FFT algorithm.
6565
*
6666
* @private
67-
* @param {number} a1 - Index of first dimension.
68-
* @param {number} a2 - Index of second dimension.
69-
* @param {number} idl1 - Stride related to the `l1` parameter.
70-
* @returns {number} - Calculated index.
67+
* @param {number} a1 - index of first dimension
68+
* @param {number} a2 - index of second dimension
69+
* @param {number} idl1 - stride related to the `l1` parameter
70+
* @returns {number} - calculated index
7171
*/
7272
function ch2Ref ( a1, a2, idl1 ) {
7373
return ( a2 * idl1 ) + a1;

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/ch_ref.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@
6464
* Performs a pass of the FFT algorithm.
6565
*
6666
* @private
67-
* @param {number} a1 - Index of first dimension.
68-
* @param {number} a2 - Index of second dimension.
69-
* @param {number} a3 - Index of third dimension.
70-
* @param {number} l1 - Length parameter related to the FFT stage.
71-
* @param {number} ido - Dimension order.
72-
* @returns {number} - Calculated index.
67+
* @param {number} a1 - index of first dimension
68+
* @param {number} a2 - index of second dimension
69+
* @param {number} a3 - index of third dimension
70+
* @param {number} l1 - length parameter related to the FFT stage
71+
* @param {number} ido - dimension order
72+
* @returns {number} - calculated index
7373
*/
7474
function chRef ( a1, a2, a3, l1, ido ) {
7575
return ( ( ( a3 * l1 ) + a2 ) * ido ) + a1;

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/passb2.js‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@
5656
* ```
5757
*/
5858

59+
/* eslint-disable max-len */
60+
5961
'use strict';
6062

6163
// MODULES //
@@ -70,11 +72,11 @@ var ccRef = require( './cc_ref.js' );
7072
* Performs a pass of length 2 of the FFT algorithm.
7173
*
7274
* @private
73-
* @param {number} ido - Number of real values for each transform
74-
* @param {number} l1 - Length of the input sequences
75-
* @param {Float64Array} cc - Input array containing sequences to be transformed
76-
* @param {Float64Array} ch - Output array containing transformed sequences
77-
* @param {Float64Array} wa1 - Array of twiddle factors
75+
* @param {number} ido - number of real values for each transform
76+
* @param {number} l1 - length of the input sequences
77+
* @param {Float64Array} cc - input array containing sequences to be transformed
78+
* @param {Float64Array} ch - output array containing transformed sequences
79+
* @param {Float64Array} wa1 - array of twiddle factors
7880
* @returns {void}
7981
*/
8082
function passb2( ido, l1, cc, ch, wa1 ) {

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/passb3.js‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@
5656
* ```
5757
*/
5858

59+
/* eslint-disable max-len */
60+
5961
'use strict';
6062

6163
// MODULES //
@@ -76,12 +78,12 @@ var taui = 0.866025403784439;
7678
* Performs a pass of length 3 of the FFT algorithm.
7779
*
7880
* @private
79-
* @param {number} ido - Number of real values for each transform
80-
* @param {number} l1 - Length of the input sequences
81-
* @param {Float64Array} cc - Input array containing sequences to be transformed
82-
* @param {Float64Array} ch - Output array containing transformed sequences
83-
* @param {Float64Array} wa1 - First array of twiddle factors
84-
* @param {Float64Array} wa2 - Second array of twiddle factors
81+
* @param {number} ido - number of real values for each transform
82+
* @param {number} l1 - length of the input sequences
83+
* @param {Float64Array} cc - input array containing sequences to be transformed
84+
* @param {Float64Array} ch - output array containing transformed sequences
85+
* @param {Float64Array} wa1 - first array of twiddle factors
86+
* @param {Float64Array} wa2 - second array of twiddle factors
8587
* @returns {void}
8688
*/
8789
function passb3( ido, l1, cc, ch, wa1, wa2 ) {
@@ -107,14 +109,14 @@ function passb3( ido, l1, cc, ch, wa1, wa2 ) {
107109
// Function body:
108110
if ( ido === 2 ) {
109111
for ( k = 1; k <= l1; ++k ) {
110-
tr2 = cc[ ccRef( 1, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( 1, 3, k, 3, ido ) - cc_offset ]; // eslint-disable-line max-len
112+
tr2 = cc[ ccRef( 1, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( 1, 3, k, 3, ido ) - cc_offset ];
111113
cr2 = cc[ ccRef( 1, 1, k, 3, ido ) - cc_offset ] + ( taur * tr2 );
112-
ch[ chRef( 1, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( 1, 1, k, 3, ido ) - cc_offset ] + tr2; // eslint-disable-line max-len
113-
ti2 = cc[ ccRef( 2, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( 2, 3, k, 3, ido ) - cc_offset ]; // eslint-disable-line max-len
114+
ch[ chRef( 1, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( 1, 1, k, 3, ido ) - cc_offset ] + tr2;
115+
ti2 = cc[ ccRef( 2, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( 2, 3, k, 3, ido ) - cc_offset ];
114116
ci2 = cc[ ccRef( 2, 1, k, 3, ido ) - cc_offset ] + ( taur * ti2 );
115-
ch[ chRef( 2, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( 2, 1, k, 3, ido ) - cc_offset ] + ti2; // eslint-disable-line max-len
116-
cr3 = taui * ( cc[ ccRef( 1, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( 1, 3, k, 3, ido ) - cc_offset ] ); // eslint-disable-line max-len
117-
ci3 = taui * ( cc[ ccRef( 2, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( 2, 3, k, 3, ido ) - cc_offset ] ); // eslint-disable-line max-len
117+
ch[ chRef( 2, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( 2, 1, k, 3, ido ) - cc_offset ] + ti2;
118+
cr3 = taui * ( cc[ ccRef( 1, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( 1, 3, k, 3, ido ) - cc_offset ] );
119+
ci3 = taui * ( cc[ ccRef( 2, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( 2, 3, k, 3, ido ) - cc_offset ] );
118120
ch[ chRef( 1, k, 2, l1, ido ) - ch_offset ] = cr2 - ci3;
119121
ch[ chRef( 1, k, 3, l1, ido ) - ch_offset ] = cr2 + ci3;
120122
ch[ chRef( 2, k, 2, l1, ido ) - ch_offset ] = ci2 + ci3;
@@ -123,14 +125,14 @@ function passb3( ido, l1, cc, ch, wa1, wa2 ) {
123125
} else {
124126
for ( k = 1; k <= l1; ++k ) {
125127
for ( i = 2; i <= ido; i += 2 ) {
126-
tr2 = cc[ ccRef( i - 1, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( i - 1, 3, k, 3, ido ) - cc_offset ]; // eslint-disable-line max-len
128+
tr2 = cc[ ccRef( i - 1, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( i - 1, 3, k, 3, ido ) - cc_offset ];
127129
cr2 = cc[ ccRef( i - 1, 1, k, 3, ido ) - cc_offset ] + ( taur * tr2 );
128-
ch[ chRef( i - 1, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( i - 1, 1, k, 3, ido ) - cc_offset ] + tr2; // eslint-disable-line max-len
129-
ti2 = cc[ ccRef( i, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( i, 3, k, 3, ido ) - cc_offset ]; // eslint-disable-line max-len
130+
ch[ chRef( i - 1, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( i - 1, 1, k, 3, ido ) - cc_offset ] + tr2;
131+
ti2 = cc[ ccRef( i, 2, k, 3, ido ) - cc_offset ] + cc[ ccRef( i, 3, k, 3, ido ) - cc_offset ];
130132
ci2 = cc[ ccRef( i, 1, k, 3, ido ) - cc_offset ] + ( taur * ti2 );
131-
ch[ chRef( i, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( i, 1, k, 3, ido ) - cc_offset ] + ti2; // eslint-disable-line max-len
132-
cr3 = taui * ( cc[ ccRef( i - 1, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( i - 1, 3, k, 3, ido ) - cc_offset ] ); // eslint-disable-line max-len
133-
ci3 = taui * ( cc[ ccRef( i, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( i, 3, k, 3, ido ) - cc_offset ] ); // eslint-disable-line max-len
133+
ch[ chRef( i, k, 1, l1, ido ) - ch_offset ] = cc[ ccRef( i, 1, k, 3, ido ) - cc_offset ] + ti2;
134+
cr3 = taui * ( cc[ ccRef( i - 1, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( i - 1, 3, k, 3, ido ) - cc_offset ] );
135+
ci3 = taui * ( cc[ ccRef( i, 2, k, 3, ido ) - cc_offset ] - cc[ ccRef( i, 3, k, 3, ido ) - cc_offset ] );
134136
dr2 = cr2 - ci3;
135137
dr3 = cr2 + ci3;
136138
di2 = ci2 + ci3;

‎lib/node_modules/@stdlib/fft/base/fftpack/lib/passb4.js‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@
5656
* ```
5757
*/
5858

59+
/* eslint-disable max-len */
60+
5961
'use strict';
6062

6163
// MODULES //
@@ -70,13 +72,13 @@ var ccRef = require( './cc_ref.js' );
7072
* Performs a pass of length 4 of the FFT algorithm.
7173
*
7274
* @private
73-
* @param {integer} ido - Number of real values for each transform
74-
* @param {integer} l1 - Length of the input sequences
75-
* @param {Float64Array} cc - Input array containing sequences to be transformed
76-
* @param {Float64Array} ch - Output array containing transformed sequences
77-
* @param {Float64Array} wa1 - First array of twiddle factors
78-
* @param {Float64Array} wa2 - Second array of twiddle factors
79-
* @param {Float64Array} wa3 - Third array of twiddle factors
75+
* @param {integer} ido - number of real values for each transform
76+
* @param {integer} l1 - length of the input sequences
77+
* @param {Float64Array} cc - input array containing sequences to be transformed
78+
* @param {Float64Array} ch - output array containing transformed sequences
79+
* @param {Float64Array} wa1 - first array of twiddle factors
80+
* @param {Float64Array} wa2 - second array of twiddle factors
81+
* @param {Float64Array} wa3 - third array of twiddle factors
8082
* @returns {void}
8183
*/
8284
function passb4( ido, l1, cc, ch, wa1, wa2, wa3 ) {
@@ -106,14 +108,14 @@ function passb4( ido, l1, cc, ch, wa1, wa2, wa3 ) {
106108
// Function body:
107109
if ( ido === 2 ) {
108110
for ( k = 1; k <= l1; ++k ) {
109-
ti1 = cc[ ccRef( 2, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( 2, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
110-
ti2 = cc[ ccRef( 2, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( 2, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
111-
tr4 = cc[ ccRef( 2, 4, k, 4, ido ) - cc_offset ] - cc[ ccRef( 2, 2, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
112-
ti3 = cc[ ccRef( 2, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( 2, 4, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
113-
tr1 = cc[ ccRef( 1, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( 1, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
114-
tr2 = cc[ ccRef( 1, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( 1, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
115-
ti4 = cc[ ccRef( 1, 2, k, 4, ido ) - cc_offset ] - cc[ ccRef( 1, 4, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
116-
tr3 = cc[ ccRef( 1, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( 1, 4, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
111+
ti1 = cc[ ccRef( 2, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( 2, 3, k, 4, ido ) - cc_offset ];
112+
ti2 = cc[ ccRef( 2, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( 2, 3, k, 4, ido ) - cc_offset ];
113+
tr4 = cc[ ccRef( 2, 4, k, 4, ido ) - cc_offset ] - cc[ ccRef( 2, 2, k, 4, ido ) - cc_offset ];
114+
ti3 = cc[ ccRef( 2, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( 2, 4, k, 4, ido ) - cc_offset ];
115+
tr1 = cc[ ccRef( 1, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( 1, 3, k, 4, ido ) - cc_offset ];
116+
tr2 = cc[ ccRef( 1, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( 1, 3, k, 4, ido ) - cc_offset ];
117+
ti4 = cc[ ccRef( 1, 2, k, 4, ido ) - cc_offset ] - cc[ ccRef( 1, 4, k, 4, ido ) - cc_offset ];
118+
tr3 = cc[ ccRef( 1, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( 1, 4, k, 4, ido ) - cc_offset ];
117119
ch[ chRef( 1, k, 1, l1, ido ) - ch_offset ] = tr2 + tr3;
118120
ch[ chRef( 1, k, 3, l1, ido ) - ch_offset ] = tr2 - tr3;
119121
ch[ chRef( 2, k, 1, l1, ido ) - ch_offset ] = ti2 + ti3;
@@ -126,14 +128,14 @@ function passb4( ido, l1, cc, ch, wa1, wa2, wa3 ) {
126128
} else {
127129
for ( k = 1; k <= l1; ++k ) {
128130
for ( i = 2; i <= ido; i += 2 ) {
129-
ti1 = cc[ ccRef( i, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( i, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
130-
ti2 = cc[ ccRef( i, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( i, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
131-
ti3 = cc[ ccRef( i, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( i, 4, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
132-
tr4 = cc[ ccRef( i, 4, k, 4, ido ) - cc_offset ] - cc[ ccRef( i, 2, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
133-
tr1 = cc[ ccRef( i - 1, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( i - 1, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
134-
tr2 = cc[ ccRef( i - 1, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( i - 1, 3, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
135-
ti4 = cc[ ccRef( i - 1, 2, k, 4, ido ) - cc_offset ] - cc[ ccRef( i - 1, 4, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
136-
tr3 = cc[ ccRef( i - 1, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( i - 1, 4, k, 4, ido ) - cc_offset ]; // eslint-disable-line max-len
131+
ti1 = cc[ ccRef( i, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( i, 3, k, 4, ido ) - cc_offset ];
132+
ti2 = cc[ ccRef( i, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( i, 3, k, 4, ido ) - cc_offset ];
133+
ti3 = cc[ ccRef( i, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( i, 4, k, 4, ido ) - cc_offset ];
134+
tr4 = cc[ ccRef( i, 4, k, 4, ido ) - cc_offset ] - cc[ ccRef( i, 2, k, 4, ido ) - cc_offset ];
135+
tr1 = cc[ ccRef( i - 1, 1, k, 4, ido ) - cc_offset ] - cc[ ccRef( i - 1, 3, k, 4, ido ) - cc_offset ];
136+
tr2 = cc[ ccRef( i - 1, 1, k, 4, ido ) - cc_offset ] + cc[ ccRef( i - 1, 3, k, 4, ido ) - cc_offset ];
137+
ti4 = cc[ ccRef( i - 1, 2, k, 4, ido ) - cc_offset ] - cc[ ccRef( i - 1, 4, k, 4, ido ) - cc_offset ];
138+
tr3 = cc[ ccRef( i - 1, 2, k, 4, ido ) - cc_offset ] + cc[ ccRef( i - 1, 4, k, 4, ido ) - cc_offset ];
137139
ch[ chRef( i - 1, k, 1, l1, ido ) - ch_offset ] = tr2 + tr3;
138140
cr3 = tr2 - tr3;
139141
ch[ chRef( i, k, 1, l1, ido ) - ch_offset ] = ti2 + ti3;

0 commit comments

Comments
 (0)