Skip to content

Commit 711c4fc

Browse files
committed
docs: add repl.txt
--- 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 859b69a commit 711c4fc

File tree

1 file changed

+90
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/dladiv/docs

1 file changed

+90
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
{{alias}}( a, b, c, d, P, Q )
2+
Divides two double-precision complex floating-point numbers in real
3+
arithmetic.
4+
5+
Indexing is relative to the first index. To introduce an offset, use typed
6+
array views.
7+
8+
Parameters
9+
----------
10+
a: number
11+
Real component of numerator.
12+
13+
b: number
14+
Imaginary component of numerator.
15+
16+
c: number
17+
Real component of denominator.
18+
19+
d: number
20+
Imaginary component of denominator.
21+
22+
P: Float64Array
23+
Array containing a single element which is overwritten by the real part
24+
of the quotient.
25+
26+
Q: Float64Array
27+
Array containing a single element which is overwritten by the imaginary
28+
part of the quotient.
29+
30+
Examples
31+
--------
32+
> var {{alias:@stdlib/array/float64}} = require( '@stdlib/array/float64' );
33+
> var P = new {{alias:@stdlib/array/float64}}( 1 );
34+
> var Q = new {{alias:@stdlib/array/float64}}( 1 );
35+
> {{alias}}( -13.0, -1.0, -2.0, 1.0, P, Q );
36+
> P
37+
<Float64Array>[ 5.0 ]
38+
> Q
39+
<Float64Array>[ 3.0 ]
40+
41+
42+
{{alias}}.ndarray( a, b, c, d, P, offsetP, Q, offsetQ )
43+
Divides two double-precision complex floating-point numbers in real
44+
arithmetic using alternative indexing semantics.
45+
46+
While typed array views mandate a view offset based on the underlying
47+
buffer, the offset parameters support indexing semantics based on starting
48+
indices.
49+
50+
Parameters
51+
----------
52+
a: number
53+
Real component of numerator.
54+
55+
b: number
56+
Imaginary component of numerator.
57+
58+
c: number
59+
Real component of denominator.
60+
61+
d: number
62+
Imaginary component of denominator.
63+
64+
P: Float64Array
65+
Array containing a single element which is overwritten by the real part
66+
of the quotient.
67+
68+
offsetP: integer
69+
Index of the element in `P`.
70+
71+
Q: Float64Array
72+
Array containing a single element which is overwritten by the imaginary
73+
part of the quotient.
74+
75+
offsetQ: integer
76+
Index of the element in `Q`.
77+
78+
Examples
79+
--------
80+
> var {{alias:@stdlib/array/float64}} = require( '@stdlib/array/float64' );
81+
> var P = new {{alias:@stdlib/array/float64}}( [ 0.0, 0.0, 0.0 ] );
82+
> var Q = new {{alias:@stdlib/array/float64}}( [ 0.0, 0.0, 0.0 ] );
83+
> {{alias}}.ndarray( -13.0, -1.0, -2.0, 1.0, P, 1, Q, 2 );
84+
> P
85+
<Float64Array>[ 0.0, 5.0, 0.0 ]
86+
> Q
87+
<Float64Array>[ 0.0, 0.0, 3.0 ]
88+
89+
See Also
90+
--------

0 commit comments

Comments
 (0)