Skip to content

Commit 7b69d84

Browse files
committed
docs: update examples to reflect the returned workspace array
--- 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: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: skipped - task: lint_license_headers status: passed ---
1 parent 40a0606 commit 7b69d84

5 files changed

Lines changed: 24 additions & 5 deletions

File tree

lib/node_modules/@stdlib/fft/base/fftpack/rffti/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ var Float64Array = require( '@stdlib/array/float64' );
5050
var N = 8;
5151
var workspace = new Float64Array( ( 2*N ) + 34 );
5252

53-
rffti( N, workspace, 1, 0 );
53+
var out = rffti( N, workspace, 1, 0 );
54+
// returns <Float64Array>
55+
56+
var bool = ( out === workspace );
57+
// returns true
5458

5559
var twiddleFactors = workspace.slice( N, 2*N );
5660
// returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]

lib/node_modules/@stdlib/fft/base/fftpack/rffti/docs/repl.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@
4242
> var {{alias:@stdlib/array/float64}} = require( '@stdlib/array/float64' );
4343
> var N = 8;
4444
> var workspace = new {{alias:@stdlib/array/float64}}( ( 2*N ) + 34 );
45-
> {{alias}}( N, workspace, 1, 0 );
45+
> var out = {{alias}}( N, workspace, 1, 0 )
46+
<Float64Array>
47+
> var bool = ( out === workspace )
48+
true
4649
> var twiddleFactors = workspace.slice( N, 2*N )
4750
<Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]
4851
> var factors = workspace.slice( 2*N, ( 2*N ) + 4 )

lib/node_modules/@stdlib/fft/base/fftpack/rffti/docs/types/index.d.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,11 @@ import { Collection } from '@stdlib/types/array';
3737
* var N = 8;
3838
* var workspace = new Float64Array( ( 2*N ) + 34 );
3939
*
40-
* rffti( N, workspace, 1, 0 );
40+
* var out = rffti( N, workspace, 1, 0 );
41+
* // returns <Float64Array>
42+
*
43+
* var bool = ( out === workspace );
44+
* // returns true
4145
*
4246
* var twiddleFactors = workspace.slice( N, 2*N );
4347
* // returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]

lib/node_modules/@stdlib/fft/base/fftpack/rffti/lib/index.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@
3030
* var N = 8;
3131
* var workspace = new Float64Array( ( 2*N ) + 34 );
3232
*
33-
* rffti( N, workspace, 1, 0 );
33+
* var out = rffti( N, workspace, 1, 0 );
34+
* // returns <Float64Array>
35+
*
36+
* var bool = ( out === workspace );
37+
* // returns true
3438
*
3539
* var twiddleFactors = workspace.slice( N, 2*N );
3640
* // returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]

lib/node_modules/@stdlib/fft/base/fftpack/rffti/lib/main.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,11 @@ var rffti1 = require( './rffti1.js' );
140140
* var N = 8;
141141
* var workspace = new Float64Array( ( 2*N ) + 34 );
142142
*
143-
* rffti( N, workspace, 1, 0 );
143+
* var out = rffti( N, workspace, 1, 0 );
144+
* // returns <Float64Array>
145+
*
146+
* var bool = ( out === workspace );
147+
* // returns true
144148
*
145149
* var twiddleFactors = workspace.slice( N, 2*N );
146150
* // returns <Float64Array>[ 0, ~0.707, ~0.707, 0, 0, 0, 0, 0 ]

0 commit comments

Comments
 (0)