Skip to content

Commit 6d39660

Browse files
committed
docs: improve doctests for complex number instances in array/complex64
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - 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: passed - task: lint_license_headers status: passed ---
1 parent f2f0088 commit 6d39660

File tree

2 files changed

+49
-51
lines changed

2 files changed

+49
-51
lines changed

lib/node_modules/@stdlib/array/complex64/docs/repl.txt

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -164,12 +164,12 @@
164164

165165
thisArg: Any (optional)
166166
Callback execution context.
167-
167+
168168
Returns
169169
-------
170170
out: Complex64Array
171171
A typed array.
172-
172+
173173
Examples
174174
--------
175175
> function clbkFcn( v ) { return v * 2.0 };
@@ -341,18 +341,18 @@
341341
----------
342342
target: integer
343343
Target start index position.
344-
344+
345345
start: integer
346346
Source start index position.
347-
347+
348348
end: integer (optional)
349349
Source end index position. Default: out.length.
350350

351351
Returns
352352
-------
353353
out: Complex64Array
354354
Modified array.
355-
355+
356356
Examples
357357
--------
358358
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )
@@ -455,7 +455,7 @@
455455
-------
456456
out: Complex64Array
457457
Modified array.
458-
458+
459459
Examples
460460
--------
461461
> var arr = new {{alias}}( 3 )
@@ -507,7 +507,7 @@
507507
-------
508508
out: Complex64Array
509509
A new typed array.
510-
510+
511511
Examples
512512
--------
513513
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
@@ -545,12 +545,12 @@
545545

546546
thisArg: Any (optional)
547547
Execution context.
548-
548+
549549
Returns
550550
-------
551551
out: Complex64|void
552552
Array element or `undefined`.
553-
553+
554554
Examples
555555
--------
556556
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
@@ -584,12 +584,12 @@
584584

585585
thisArg: Any (optional)
586586
Execution context.
587-
587+
588588
Returns
589589
-------
590590
out: integer
591591
Array index or `-1`.
592-
592+
593593
Examples
594594
--------
595595
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
@@ -618,13 +618,13 @@
618618
Predicate function which tests array elements.
619619

620620
thisArg: Any (optional)
621-
Execution context.
622-
621+
Execution context.
622+
623623
Returns
624624
-------
625625
out: Complex64|void
626626
Array element or `undefined`.
627-
627+
628628
Examples
629629
--------
630630
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
@@ -663,7 +663,7 @@
663663
-------
664664
out: integer
665665
Array index or `-1`.
666-
666+
667667
Examples
668668
--------
669669
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
@@ -689,7 +689,7 @@
689689

690690
thisArg: Any (optional)
691691
Execution context.
692-
692+
693693
Examples
694694
--------
695695
> var str = '%';
@@ -711,12 +711,12 @@
711711
----------
712712
i: integer
713713
Element index.
714-
714+
715715
Returns
716716
-------
717717
out: Complex64|void
718718
Array element or `undefined`.
719-
719+
720720
Examples
721721
--------
722722
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
@@ -741,12 +741,12 @@
741741
Array index at which to start the search. If provided a negative value,
742742
the method resolves the start index relative to the last array element.
743743
Default: 0.
744-
744+
745745
Returns
746746
-------
747747
bool: boolean
748748
Boolean indicating whether an array includes a search element.
749-
749+
750750
Examples
751751
--------
752752
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )
@@ -776,7 +776,7 @@
776776
-------
777777
out: integer
778778
Array index or `-1`.
779-
779+
780780
Examples
781781
--------
782782
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )
@@ -795,12 +795,12 @@
795795
----------
796796
separator: string (optional)
797797
Separator string. Default: ','.
798-
798+
799799
Returns
800800
-------
801801
out: string
802802
Array serialized as a string.
803-
803+
804804
Examples
805805
--------
806806
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
@@ -818,7 +818,7 @@
818818
-------
819819
iterator: Iterator
820820
Iterator for iterating over array index keys.
821-
821+
822822
Examples
823823
--------
824824
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
@@ -846,12 +846,12 @@
846846
Array index at which to start the search. If provided a negative value,
847847
the method resolves the start index relative to the last array element.
848848
Default: out.length-1.
849-
849+
850850
Returns
851851
-------
852852
out: integer
853853
Array index or `-1`.
854-
854+
855855
Examples
856856
--------
857857
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] )
@@ -886,7 +886,7 @@
886886
-------
887887
out: Complex64Array
888888
A new typed array.
889-
889+
890890
Examples
891891
--------
892892
> function clbk( v ) { return v; };
@@ -931,16 +931,16 @@
931931
Parameters
932932
----------
933933
reducerFn: Function
934-
Function to apply to each array element.
934+
Function to apply to each array element.
935935

936936
initialValue: any (optional)
937937
Initial accumulation value.
938-
938+
939939
Returns
940940
-------
941941
out: any
942942
Accumulated result.
943-
943+
944944
Examples
945945
--------
946946
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
@@ -980,12 +980,12 @@
980980

981981
initialValue: any (optional)
982982
Initial accumulation value.
983-
983+
984984
Returns
985985
-------
986986
out: any
987987
Accumulated result.
988-
988+
989989
Examples
990990
--------
991991
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
@@ -1083,12 +1083,12 @@
10831083
end: integer (optional)
10841084
End index (non-inclusive). If less than zero, the end index is resolved
10851085
relative to the last array element. Default: out.length.
1086-
1086+
10871087
Returns
10881088
-------
10891089
out: Complex64Array
10901090
New typed array.
1091-
1091+
10921092
Examples
10931093
--------
10941094
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )
@@ -1126,15 +1126,15 @@
11261126
Predicate function which tests array elements. If a predicate function
11271127
returns a truthy value, an array element passes; otherwise, an array
11281128
element fails.
1129-
1129+
11301130
thisArg: Any (optional)
11311131
Execution context.
1132-
1132+
11331133
Returns
11341134
-------
11351135
bool: boolean
11361136
Boolean indicating whether at least one element passes the test.
1137-
1137+
11381138
Examples
11391139
--------
11401140
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
@@ -1161,12 +1161,12 @@
11611161
----------
11621162
compareFunction: Function
11631163
Comparison function.
1164-
1164+
11651165
Returns
11661166
-------
11671167
out: Complex64Array
11681168
Modified array.
1169-
1169+
11701170
Examples
11711171
--------
11721172
> function compare( a, b ) { return ( {{alias:@stdlib/complex/float32/real}}( a ) - {{alias:@stdlib/complex/float32/real}}( b ) ); };
@@ -1241,10 +1241,10 @@
12411241
----------
12421242
locales: string|Array (optional)
12431243
Locale identifier(s).
1244-
1244+
12451245
options: Object (optional)
12461246
An object containing serialization options.
1247-
1247+
12481248
Returns
12491249
-------
12501250
str: string
@@ -1265,7 +1265,7 @@
12651265
-------
12661266
out: Complex64Array
12671267
New typed array.
1268-
1268+
12691269
Examples
12701270
--------
12711271
> var arr = new {{alias}}( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] )
@@ -1309,12 +1309,12 @@
13091309
----------
13101310
compareFcn: Function
13111311
Comparison function.
1312-
1312+
13131313
Returns
13141314
-------
13151315
out: Complex64Array
13161316
New typed array.
1317-
1317+
13181318
Examples
13191319
--------
13201320
> function compare( a, b ) { return ( {{alias:@stdlib/complex/float32/real}}( a ) - {{alias:@stdlib/complex/float32/real}}( b ) ); };
@@ -1348,7 +1348,7 @@
13481348
-------
13491349
str: string
13501350
String serialization of the array.
1351-
1351+
13521352
Examples
13531353
--------
13541354
> var arr = new {{alias}}( [ 1.0, 1.0, 2.0, -2.0, 3.0, 3.0 ] )
@@ -1364,7 +1364,7 @@
13641364
-------
13651365
iterator: Iterator
13661366
Iterator for iterating over array values.
1367-
1367+
13681368
Examples
13691369
--------
13701370
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
@@ -1394,15 +1394,15 @@
13941394
----------
13951395
index: integer
13961396
Element index.
1397-
1397+
13981398
value: Complex64
1399-
Element value.
1399+
Element value.
14001400

14011401
Returns
14021402
-------
14031403
out: Complex64Array
14041404
New typed array.
1405-
1405+
14061406
Examples
14071407
--------
14081408
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )

lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,6 @@ declare class Complex64Array implements Complex64ArrayInterface {
624624
* @returns array element or undefined
625625
*
626626
* @example
627-
* var realf = require( '@stdlib/complex/float32/real' );
628-
* var imagf = require( '@stdlib/complex/float32/imag' );
629627
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
630628
*
631629
* function predicate( v ) {

0 commit comments

Comments
 (0)