Skip to content

docs: update examples for complex/float32/conj #7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 9, 2025
Merged

docs: update examples for complex/float32/conj #7294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/complex/float32/conj/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,9 @@ Returns the [complex conjugate][complex-conjugate] of a single-precision complex
var Complex64 = require( '@stdlib/complex/float32/ctor' );

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

var v = conj( z );
str = v.toString();
// returns '5 - 3i'
// returns <Complex64>[ 5.0, -3.0 ]
```

</section>
Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/complex/float32/conj/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,11 @@ import Complex64 = require( '@stdlib/complex/float32/ctor' );
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var z = new Complex64( 5.0, 3.0 );
*
* var v = conj( z );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 5.0
*
* var im = imagf( v );
* // returns -3.0
* // returns <Complex64>[ 5.0, -3.0 ]
*/
declare function conj( z: Complex64 ): Complex64;

Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/complex/float32/conj/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,12 @@
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var conj = require( '@stdlib/complex/float32/conj' );
*
* var z = new Complex64( 5.0, 3.0 );
*
* var v = conj( z );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 5.0
*
* var im = imagf( v );
* // returns -3.0
* // returns <Complex64>[ 5.0, -3.0 ]
*/

// MODULES //
Expand Down
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/complex/float32/conj/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,11 @@
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
*
* var z = new Complex64( 5.0, 3.0 );
*
* var v = conj( z );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 5.0
*
* var im = imagf( v );
* // returns -3.0
* // returns <Complex64>[ 5.0, -3.0 ]
*/
function conj( z ) {
return new z.constructor( z.re, -z.im );
Expand Down