Skip to content

Commit aa57c03

Browse files
committed
docs: update readme
--- 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: na - 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 aed6efe commit aa57c03

File tree

1 file changed

+57
-2
lines changed
  • lib/node_modules/@stdlib/complex/float64/base/div

1 file changed

+57
-2
lines changed

lib/node_modules/@stdlib/complex/float64/base/div/README.md

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,61 @@ var v = cdiv( z1, z2 );
5050
// returns <Complex128>[ 5.0, 3.0 ]
5151
```
5252

53+
#### cdiv.assign( re1, im1, re2, im2, out, strideOut, offsetOut )
54+
55+
Divides two double-precision complex floating-point numbers and assigns results to a provided output array.
56+
57+
```javascript
58+
var Float64Array = require( '@stdlib/array/float64' );
59+
60+
var out = new Float64Array( 2 );
61+
var v = cdiv.assign( -13.0, -1.0, -2.0, 1.0, out, 1, 0 );
62+
// returns <Float64Array>[ 5.0, 3.0 ]
63+
64+
var bool = ( out === v );
65+
// returns true
66+
```
67+
68+
The function supports the following parameters:
69+
70+
- **re1**: real component of the first complex number.
71+
- **im1**: imaginary component of the first complex number.
72+
- **re2**: real component of the second complex number.
73+
- **im2**: imaginary component of the second complex number.
74+
- **out**: output array.
75+
- **strideOut**: stride length for `out`.
76+
- **offsetOut**: starting index for `out`.
77+
78+
#### cdiv.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )
79+
80+
Divides two double-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.
81+
82+
```javascript
83+
var Float64Array = require( '@stdlib/array/float64' );
84+
85+
var z1 = new Float64Array( [ -13.0, -1.0 ] );
86+
var z2 = new Float64Array( [ -2.0, 1.0 ] );
87+
var out = new Float64Array( 2 );
88+
89+
var v = cdiv.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 );
90+
// returns <Float64Array>[ 5.0, 3.0 ]
91+
92+
var bool = ( out === v );
93+
// returns true
94+
```
95+
96+
The function supports the following parameters:
97+
98+
- **z1**: first complex number strided array view.
99+
- **sz1**: stride length for `z1`.
100+
- **oz1**: starting index for `z1`.
101+
- **z2**: second complex number strided array view.
102+
- **sz2**: stride length for `z2`.
103+
- **oz2**: starting index for `z2`.
104+
- **out**: output array.
105+
- **so**: stride length for `out`.
106+
- **oo**: starting index for `out`.
107+
53108
</section>
54109

55110
<!-- /.usage -->
@@ -214,7 +269,7 @@ int main( void ) {
214269

215270
## See Also
216271

217-
- <span class="package-name">[`@stdlib/complex/float64/base/add`][@stdlib/complex/float64/base/add]</span><span class="delimiter">: </span><span class="description">add two double-precision complex floating-point numbers.</span>
272+
- <span class="package-name">[`@stdlib/complex/float64/base/cdiv`][@stdlib/complex/float64/base/cdiv]</span><span class="delimiter">: </span><span class="description">cdiv two double-precision complex floating-point numbers.</span>
218273
- <span class="package-name">[`@stdlib/complex/float64/base/mul`][@stdlib/complex/float64/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision complex floating-point numbers.</span>
219274
- <span class="package-name">[`@stdlib/complex/float64/base/sub`][@stdlib/complex/float64/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two double-precision complex floating-point numbers.</span>
220275

@@ -236,7 +291,7 @@ int main( void ) {
236291

237292
<!-- <related-links> -->
238293

239-
[@stdlib/complex/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add
294+
[@stdlib/complex/float64/base/cdiv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/cdiv
240295

241296
[@stdlib/complex/float64/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/mul
242297

0 commit comments

Comments
 (0)