Skip to content

Commit f06e5e0

Browse files
committed
docs: update repl for csignum assign and strided
--- 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 10a506a commit f06e5e0

File tree

1 file changed

+83
-6
lines changed
  • lib/node_modules/@stdlib/math/base/special/csignumf/docs

1 file changed

+83
-6
lines changed
Lines changed: 83 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
21
{{alias}}( z )
3-
Evaluates the signum function of a single-precision complex floating-point
4-
number.
2+
Evaluates the signum function of a single-precision
3+
complex floating-point number.
54

65
Parameters
76
----------
@@ -15,13 +14,91 @@
1514

1615
Examples
1716
--------
18-
> var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -4.2, 5.5 ) )
17+
> var Complex64 = {{alias:@stdlib/complex/float32/ctor}}
18+
<Function>
19+
> var realf = {{alias:@stdlib/complex/float32/real}}
20+
<Function>
21+
> var imagf = {{alias:@stdlib/complex/float32/imag}}
22+
<Function>
23+
> var v = {{alias}}( new Complex64( -4.2, 5.5 ) )
1924
<Complex64>
20-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
25+
> var re = realf( v )
2126
~-0.607
22-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
27+
> var im = imagf( v )
2328
~0.795
2429

30+
31+
{{alias}}.assign( re, im, out, stride, offset )
32+
Evaluates the signum function and assigns the result to a
33+
provided output array.
34+
35+
Parameters
36+
----------
37+
re: number
38+
Real component.
39+
40+
im: number
41+
Imaginary component.
42+
43+
out: Float32Array
44+
Output array.
45+
46+
stride: integer
47+
Output stride length.
48+
49+
offset: integer
50+
Starting index for output.
51+
52+
Returns
53+
-------
54+
out: Float32Array
55+
Output array.
56+
57+
Examples
58+
--------
59+
> var out = new Float32Array( 2 );
60+
> {{alias}}.assign( -4.2, 5.5, out, 1, 0 )
61+
<Float32Array>[ ~-0.607, ~0.795 ]
62+
63+
64+
{{alias}}.strided( z, sz, oz, out, so, oo )
65+
Evaluates the signum function for single-precision complex numbers
66+
stored in a real-valued strided input array and assigns
67+
the results to a strided output array.
68+
69+
Parameters
70+
----------
71+
z: Float32Array
72+
Input array containing interleaved real and imaginary components.
73+
74+
sz: integer
75+
Input stride length.
76+
77+
oz: integer
78+
Starting index for input.
79+
80+
out: Float32Array
81+
Output array.
82+
83+
so: integer
84+
Output stride length.
85+
86+
oo: integer
87+
Starting index for output.
88+
89+
Returns
90+
-------
91+
out: Float32Array
92+
Output array.
93+
94+
Examples
95+
--------
96+
> var z = new Float32Array( [ -4.2, 5.5 ] );
97+
> var out = new Float32Array( 2 );
98+
> {{alias}}.strided( z, 1, 0, out, 1, 0 )
99+
<Float32Array>[ ~-0.607, ~0.795 ]
100+
101+
25102
See Also
26103
--------
27104

0 commit comments

Comments
 (0)