Skip to content

Commit 2f0510e

Browse files
authored
docs: update examples for complex/float32/conj
PR-URL: #7294 Reviewed-by: Athan Reines <[email protected]>
1 parent e4518d4 commit 2f0510e

File tree

4 files changed

+4
-31
lines changed

4 files changed

+4
-31
lines changed

lib/node_modules/@stdlib/complex/float32/conj/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,9 @@ Returns the [complex conjugate][complex-conjugate] of a single-precision complex
4848
var Complex64 = require( '@stdlib/complex/float32/ctor' );
4949

5050
var z = new Complex64( 5.0, 3.0 );
51-
var str = z.toString();
52-
// returns '5 + 3i'
5351

5452
var v = conj( z );
55-
str = v.toString();
56-
// returns '5 - 3i'
53+
// returns <Complex64>[ 5.0, -3.0 ]
5754
```
5855

5956
</section>

lib/node_modules/@stdlib/complex/float32/conj/docs/types/index.d.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,11 @@ import Complex64 = require( '@stdlib/complex/float32/ctor' );
2828
*
2929
* @example
3030
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
31-
* var realf = require( '@stdlib/complex/float32/real' );
32-
* var imagf = require( '@stdlib/complex/float32/imag' );
3331
*
3432
* var z = new Complex64( 5.0, 3.0 );
3533
*
3634
* var v = conj( z );
37-
* // returns <Complex64>
38-
*
39-
* var re = realf( v );
40-
* // returns 5.0
41-
*
42-
* var im = imagf( v );
43-
* // returns -3.0
35+
* // returns <Complex64>[ 5.0, -3.0 ]
4436
*/
4537
declare function conj( z: Complex64 ): Complex64;
4638

lib/node_modules/@stdlib/complex/float32/conj/lib/index.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,12 @@
2525
*
2626
* @example
2727
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
28-
* var realf = require( '@stdlib/complex/float32/real' );
29-
* var imagf = require( '@stdlib/complex/float32/imag' );
3028
* var conj = require( '@stdlib/complex/float32/conj' );
3129
*
3230
* var z = new Complex64( 5.0, 3.0 );
3331
*
3432
* var v = conj( z );
35-
* // returns <Complex64>
36-
*
37-
* var re = realf( v );
38-
* // returns 5.0
39-
*
40-
* var im = imagf( v );
41-
* // returns -3.0
33+
* // returns <Complex64>[ 5.0, -3.0 ]
4234
*/
4335

4436
// MODULES //

lib/node_modules/@stdlib/complex/float32/conj/lib/main.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,11 @@
2626
*
2727
* @example
2828
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
29-
* var realf = require( '@stdlib/complex/float32/real' );
30-
* var imagf = require( '@stdlib/complex/float32/imag' );
3129
*
3230
* var z = new Complex64( 5.0, 3.0 );
3331
*
3432
* var v = conj( z );
35-
* // returns <Complex64>
36-
*
37-
* var re = realf( v );
38-
* // returns 5.0
39-
*
40-
* var im = imagf( v );
41-
* // returns -3.0
33+
* // returns <Complex64>[ 5.0, -3.0 ]
4234
*/
4335
function conj( z ) {
4436
return new z.constructor( z.re, -z.im );

0 commit comments

Comments
 (0)