Skip to content

docs: improve doctests for complex number instances in array/complex64 #8926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aryan7071 wants to merge 3 commits into
base: develop
Choose a base branch
from
+117 −539
Open

docs: improve doctests for complex number instances in array/complex64 #8926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7023a68
docs: improve doctests for complex number instances in array/complex64
aryan7071 Dec 9, 2025
f2f0088
docs: improve doctests for complex number instances in array/complex64
aryan7071 Dec 11, 2025
6d39660
docs: improve doctests for complex number instances in array/complex64
aryan7071 Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 49 additions & 49 deletions lib/node_modules/@stdlib/array/complex64/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,12 +164,12 @@

thisArg: Any (optional)
Callback execution context.

Returns
-------
out: Complex64Array
A typed array.

Examples
--------
> function clbkFcn( v ) { return v * 2.0 };
Expand Down Expand Up @@ -341,18 +341,18 @@
----------
target: integer
Target start index position.

start: integer
Source start index position.

end: integer (optional)
Source end index position. Default: out.length.

Returns
-------
out: Complex64Array
Modified array.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )
Expand Down Expand Up @@ -455,7 +455,7 @@
-------
out: Complex64Array
Modified array.

Examples
--------
> var arr = new {{alias}}( 3 )
Expand Down Expand Up @@ -507,7 +507,7 @@
-------
out: Complex64Array
A new typed array.

Examples
--------
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
Expand Down Expand Up @@ -545,12 +545,12 @@

thisArg: Any (optional)
Execution context.

Returns
-------
out: Complex64|void
Array element or `undefined`.

Examples
--------
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
Expand Down Expand Up @@ -584,12 +584,12 @@

thisArg: Any (optional)
Execution context.

Returns
-------
out: integer
Array index or `-1`.

Examples
--------
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
Expand Down Expand Up @@ -618,13 +618,13 @@
Predicate function which tests array elements.

thisArg: Any (optional)
Execution context.
Execution context.

Returns
-------
out: Complex64|void
Array element or `undefined`.

Examples
--------
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
Expand Down Expand Up @@ -663,7 +663,7 @@
-------
out: integer
Array index or `-1`.

Examples
--------
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
Expand All @@ -689,7 +689,7 @@

thisArg: Any (optional)
Execution context.

Examples
--------
> var str = '%';
Expand All @@ -711,12 +711,12 @@
----------
i: integer
Element index.

Returns
-------
out: Complex64|void
Array element or `undefined`.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand All @@ -741,12 +741,12 @@
Array index at which to start the search. If provided a negative value,
the method resolves the start index relative to the last array element.
Default: 0.

Returns
-------
bool: boolean
Boolean indicating whether an array includes a search element.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )
Expand Down Expand Up @@ -776,7 +776,7 @@
-------
out: integer
Array index or `-1`.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 4.0, -4.0 ] )
Expand All @@ -795,12 +795,12 @@
----------
separator: string (optional)
Separator string. Default: ','.

Returns
-------
out: string
Array serialized as a string.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand All @@ -818,7 +818,7 @@
-------
iterator: Iterator
Iterator for iterating over array index keys.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand Down Expand Up @@ -846,12 +846,12 @@
Array index at which to start the search. If provided a negative value,
the method resolves the start index relative to the last array element.
Default: out.length-1.

Returns
-------
out: integer
Array index or `-1`.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0, 1.0, -1.0 ] )
Expand Down Expand Up @@ -886,7 +886,7 @@
-------
out: Complex64Array
A new typed array.

Examples
--------
> function clbk( v ) { return v; };
Expand Down Expand Up @@ -931,16 +931,16 @@
Parameters
----------
reducerFn: Function
Function to apply to each array element.
Function to apply to each array element.

initialValue: any (optional)
Initial accumulation value.

Returns
-------
out: any
Accumulated result.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand Down Expand Up @@ -980,12 +980,12 @@

initialValue: any (optional)
Initial accumulation value.

Returns
-------
out: any
Accumulated result.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand Down Expand Up @@ -1083,12 +1083,12 @@
end: integer (optional)
End index (non-inclusive). If less than zero, the end index is resolved
relative to the last array element. Default: out.length.

Returns
-------
out: Complex64Array
New typed array.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0, 3.0, -3.0 ] )
Expand Down Expand Up @@ -1126,15 +1126,15 @@
Predicate function which tests array elements. If a predicate function
returns a truthy value, an array element passes; otherwise, an array
element fails.

thisArg: Any (optional)
Execution context.

Returns
-------
bool: boolean
Boolean indicating whether at least one element passes the test.

Examples
--------
> function predicate( v ) { return ( {{alias:@stdlib/complex/float32/real}}( v ) === {{alias:@stdlib/complex/float32/imag}}( v ) ); };
Expand All @@ -1161,12 +1161,12 @@
----------
compareFunction: Function
Comparison function.

Returns
-------
out: Complex64Array
Modified array.

Examples
--------
> function compare( a, b ) { return ( {{alias:@stdlib/complex/float32/real}}( a ) - {{alias:@stdlib/complex/float32/real}}( b ) ); };
Expand Down Expand Up @@ -1241,10 +1241,10 @@
----------
locales: string|Array (optional)
Locale identifier(s).

options: Object (optional)
An object containing serialization options.

Returns
-------
str: string
Expand All @@ -1265,7 +1265,7 @@
-------
out: Complex64Array
New typed array.

Examples
--------
> var arr = new {{alias}}( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] )
Expand Down Expand Up @@ -1309,12 +1309,12 @@
----------
compareFcn: Function
Comparison function.

Returns
-------
out: Complex64Array
New typed array.

Examples
--------
> function compare( a, b ) { return ( {{alias:@stdlib/complex/float32/real}}( a ) - {{alias:@stdlib/complex/float32/real}}( b ) ); };
Expand Down Expand Up @@ -1348,7 +1348,7 @@
-------
str: string
String serialization of the array.

Examples
--------
> var arr = new {{alias}}( [ 1.0, 1.0, 2.0, -2.0, 3.0, 3.0 ] )
Expand All @@ -1364,7 +1364,7 @@
-------
iterator: Iterator
Iterator for iterating over array values.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand Down Expand Up @@ -1394,15 +1394,15 @@
----------
index: integer
Element index.

value: Complex64
Element value.
Element value.

Returns
-------
out: Complex64Array
New typed array.

Examples
--------
> var arr = new {{alias}}( [ 1.0, -1.0, 2.0, -2.0 ] )
Expand Down
Loading