Skip to content

docs: update examples for complex/float32/base/neg #7291

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 2 commits into from
Jun 9, 2025
Merged

docs: update examples for complex/float32/base/neg #7291

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4fca34
docs: update examples for complex/float32/base/neg
ShabiShett07 Jun 9, 2025
003e8f7
docs: add missing tilde
kgryte Jun 9, 2025
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
26 changes: 3 additions & 23 deletions lib/node_modules/@stdlib/complex/float32/base/neg/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,41 +46,21 @@ Negates a single-precision complex floating-point number.

```javascript
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( -4.0, 5.0 );

var out = cnegf( z );
// returns <Complex64>

var re = realf( out );
// returns 4.0

var im = imagf( out );
// returns -5.0
// returns <Complex64>[ 4.0, -5.0 ]

z = new Complex64( 0.0, 0.0 );

out = cnegf( z );
// returns <Complex64>

re = realf( out );
// returns -0.0

im = imagf( out );
// returns -0.0
// returns <Complex64>[ -0.0, -0.0 ]

z = new Complex64( NaN, NaN );

out = cnegf( z );
// returns <Complex64>

re = realf( out );
// returns NaN

im = imagf( out );
// returns NaN
// returns <Complex64>[ NaN, NaN ]
```

</section>
Expand Down
33 changes: 3 additions & 30 deletions lib/node_modules/@stdlib/complex/float32/base/neg/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,54 +30,27 @@ import { Complex64 } from '@stdlib/types/complex';
*
* @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( -4.2, 5.5 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 4.2
*
* var im = imagf( out );
* // returns -5.5
* // returns <Complex64>[ 4.2, -5.5 ]
*
* @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( 0.0, 0.0 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns -0.0
*
* var im = imagf( out );
* // returns -0.0
* // returns <Complex64>[ -0.0, -0.0 ]
*
* @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( NaN, NaN );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns NaN
*
* var im = imagf( out );
* // returns NaN
* // returns <Complex64>[ NaN, NaN ]
*/
declare function cnegf( z: Complex64 ): Complex64;

Expand Down
33 changes: 3 additions & 30 deletions lib/node_modules/@stdlib/complex/float32/base/neg/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,57 +25,30 @@
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var cnegf = require( '@stdlib/complex/float32/base/neg' );
*
* var z = new Complex64( -4.0, 5.0 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns 4.0
*
* var im = imagf( out );
* // returns -5.0
* // returns <Complex64>[ 4.0, -5.0 ]
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var cnegf = require( '@stdlib/complex/float32/base/neg' );
*
* var z = new Complex64( 0.0, 0.0 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns -0.0
*
* var im = imagf( out );
* // returns -0.0
* // returns <Complex64>[ -0.0, -0.0 ]
*
* @example
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var realf = require( '@stdlib/complex/float32/real' );
* var imagf = require( '@stdlib/complex/float32/imag' );
* var cnegf = require( '@stdlib/complex/float32/base/neg' );
*
* var z = new Complex64( NaN, NaN );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns NaN
*
* var im = imagf( out );
* // returns NaN
* // returns <Complex64>[ NaN, NaN ]
*/

// MODULES //
Expand Down
33 changes: 3 additions & 30 deletions lib/node_modules/@stdlib/complex/float32/base/neg/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,54 +35,27 @@ var 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( -4.2, 5.5 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns ~4.2
*
* var im = imagf( out );
* // returns -5.5
* // returns <Complex64>[ ~4.2, -5.5 ]
*
* @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( 0.0, 0.0 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns -0.0
*
* var im = imagf( out );
* // returns -0.0
* // returns <Complex64>[ -0.0, -0.0 ]
*
* @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( NaN, NaN );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns NaN
*
* var im = imagf( out );
* // returns NaN
* // returns <Complex64>[ NaN, NaN ]
*/
function cnegf( z ) {
return new Complex64( -realf( z ), -imagf( z ) );
Expand Down
33 changes: 3 additions & 30 deletions lib/node_modules/@stdlib/complex/float32/base/neg/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,54 +35,27 @@ var addon = require( './../src/addon.node' );
*
* @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( -4.2, 5.5 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns ~4.2
*
* var im = imagf( out );
* // returns -5.5
* // returns <Complex64>[ ~4.2, -5.5 ]
*
* @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( 0.0, 0.0 );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns -0.0
*
* var im = imagf( out );
* // returns -0.0
* // returns <Complex64>[ -0.0, -0.0 ]
*
* @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( NaN, NaN );
* // returns <Complex64>
*
* var out = cnegf( z );
* // returns <Complex64>
*
* var re = realf( out );
* // returns NaN
*
* var im = imagf( out );
* // returns NaN
* // returns <Complex64>[ NaN, NaN ]
*/
function cnegf( z ) {
var v = addon( z );
Expand Down