Skip to content

Commit 10a506a

Browse files
committed
docs: update README.md for csignumf usage and examples
--- 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 0b1a520 commit 10a506a

File tree

1 file changed

+28
-14
lines changed
  • lib/node_modules/@stdlib/math/base/special/csignumf

1 file changed

+28
-14
lines changed

lib/node_modules/@stdlib/math/base/special/csignumf/README.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
@license Apache-2.0
44
5-
Copyright (c) 2025 The Stdlib Authors.
5+
Copyright (c) 2018 The Stdlib Authors.
66
77
Licensed under the Apache License, Version 2.0 (the "License");
88
you may not use this file except in compliance with the License.
@@ -22,16 +22,12 @@ limitations under the License.
2222

2323
> Evaluate the [signum][signum] function of a single-precision complex floating-point number.
2424
25-
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26-
2725
<section class="intro">
2826

2927
</section>
3028

3129
<!-- /.intro -->
3230

33-
<!-- Package usage documentation. -->
34-
3531
<section class="usage">
3632

3733
## Usage
@@ -77,26 +73,44 @@ im = imag( v );
7773
// returns NaN
7874
```
7975

80-
</section>
76+
#### csignumf.assign( re, im, out, strideOut, offsetOut )
8177

82-
<!-- /.usage -->
78+
Evaluates the signum function and assigns the result to a provided output array.
8379

84-
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
80+
```javascript
81+
var Float32Array = require( '@stdlib/array/float32' );
8582

86-
<section class="notes">
83+
var out = new Float32Array( 2 );
84+
var v = csignumf.assign( -4.2, 5.5, out, 1, 0 );
85+
// returns <Float32Array>[ ~-0.607, ~0.795 ]
8786

88-
</section>
87+
var bool = ( out === v );
88+
// returns true
89+
```
8990

90-
<!-- /.notes -->
91+
#### csignumf.strided( z, sz, oz, out, so, oo )
9192

92-
<!-- Package usage examples. -->
93+
Evaluates the signum function for single-precision complex numbers stored in a real-valued strided array and assigns results to a strided output array.
94+
95+
```javascript
96+
var Float32Array = require( '@stdlib/array/float32' );
97+
98+
var z = new Float32Array( [ -4.2, 5.5 ] );
99+
var out = new Float32Array( 2 );
100+
101+
var v = csignumf.strided( z, 1, 0, out, 1, 0 );
102+
// returns <Float32Array>[ ~-0.607, ~0.795 ]
103+
104+
var bool = ( out === v );
105+
// returns true
106+
```
107+
108+
</section>
93109

94110
<section class="examples">
95111

96112
## Examples
97113

98-
<!-- eslint no-undef: "error" -->
99-
100114
```javascript
101115
var uniform = require( '@stdlib/random/base/uniform' ).factory;
102116
var Complex64 = require( '@stdlib/complex/float32/ctor' );

0 commit comments

Comments
 (0)