Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/math/base/complex/negate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ Negates a `complex` number comprised of a **real** component `re` and an **imagi

```javascript
var v = cnegate( -4.2, 5.5 );
// returns [ TODO, TODO ]
// returns [ 4.2, -5.5 ]

v = cnegate( 0.0, 0.0 );
// returns [ TODO, TODO ]
// returns [ -0.0, -0.0 ]

v = cnegate( NaN, NaN );
// returns [ TODO, TODO ]
// returns [ NaN, NaN ]
```

By default, the function returns real and imaginary components as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
Expand All @@ -63,7 +63,7 @@ var Float64Array = require( '@stdlib/array/float64' );
var out = new Float64Array( 2 );

var v = cnegate( out, -4.2, 5.5 );
// returns <Float64Array>[ TODO, TODO ]
// returns <Float64Array>[ 4.2, -5.5 ]

var bool = ( v === out );
// returns true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@

Examples
--------
> var out = {{alias}}( TODO, TODO )
TODO
> var out = {{alias}}( -4.2, 5.5 )
[ 4.2, -5.5 ]

// Provide an output array:
> out = new {{alias:@stdlib/array/float64}}( 2 );
> var v = {{alias}}( out, TODO, TODO )
<Float64Array>[ TODO, TODO ]
> var v = {{alias}}( out, -4.2, 5.5 )
<Float64Array>[ 4.2, -5.5 ]
> var bool = ( v === out )
true

Expand Down
12 changes: 7 additions & 5 deletions lib/node_modules/@stdlib/math/base/complex/negate/lib/cnegate.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,26 @@
* @example
* var out = new Array( 2 );
*
* var v = cnegate( out, TODO, TODO );
* // returns [ TODO, TODO ]
* var v = cnegate( out, -4.2, 5.5 );
* // returns [ 4.2, -5.5 ]
*
* var bool = ( v === out );
* // returns true
*
* @example
* var out = new Array( 2 );
* var v = cnegate( out, 0.0, 0.0 );
* // returns [ TODO, TODO ]
* // returns [ -0.0, -0.0 ]
*
* @example
* var out = new Array( 2 );
* var v = cnegate( out, NaN, NaN );
* // returns [ TODO, TODO ]
* // returns [ NaN, NaN ]
*/
function cnegate( out, re, im ) {
// TODO: implementation
out[ 0 ] = -re;
out[ 1 ] = -im;
return out;
}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,21 @@
* var cnegate = require( '@stdlib/math/base/complex/negate' );
*
* var v = cnegate( -4.2, 5.5 );
* // returns [ TODO, TODO ]
* // returns [ 4.2, -5.5 ]
*
* v = cnegate( 0.0, 0.0 );
* // returns [ TODO, TODO ]
* // returns [ -0.0, -0.0 ]
*
* v = cnegate( NaN, NaN );
* // returns [ TODO, TODO ]
* // returns [ NaN, NaN ]
*
* @example
* var cnegate = require( '@stdlib/math/base/complex/negate' );
*
* var out = new Array( 2 );
*
* var v = cnegate( out, -4.2, 5.5 );
* // returns [ TODO, TODO ]
* // returns [ 4.2, -5.5 ]
*
* var bool = ( v === out );
* // returns true
Expand Down
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/math/base/complex/negate/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,24 @@ var negate = require( './cnegate.js' );
*
* @example
* var v = cnegate( -4.2, 5.5 );
* // returns [ TODO, TODO ]
* // returns [ 4.2, -5.5 ]
*
* @example
* var out = new Array( 2 );
*
* var v = cnegate( out, -4.2, 5.5 );
* // returns [ TODO, TODO ]
* // returns [ 4.2, -5.5 ]
*
* var bool = ( v === out );
* // returns true
*
* @example
* var v = cnegate( 0.0, 0.0 );
* // returns [ TODO, TODO ]
* // returns [ -0.0, -0.0 ]
*
* @example
* var v = cnegate( NaN, NaN );
* // returns [ TODO, TODO ]
* // returns [ NaN, NaN ]
*/
function cnegate( out, re, im ) {
if ( arguments.length === 2 ) {
Expand Down
32 changes: 28 additions & 4 deletions lib/node_modules/@stdlib/math/base/complex/negate/test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,20 @@ tape( 'the function negates real and imaginary components', function test( t ) {
var expected;
var actual;

// TODO: tests
actual = cnegate( -4.2, 5.5 );
expected = [ 4.2, -5.5 ];
t.deepEqual( actual, expected, 'returns expected value' );

actual = cnegate( 9.99999, 0.1 );
expected = [ -9.99999, -0.1 ];
t.deepEqual( actual, expected, 'returns expected value' );

actual = cnegate( 4.0, 7.0 );
expected = [ -4.0, -7.0 ];
t.deepEqual( actual, expected, 'returns expected value' );

actual = cnegate( -4.0, -7.0 );
expected = [ 4.0, 7.0 ];
t.deepEqual( actual, expected, 'returns expected value' );

t.end();
Expand All @@ -54,7 +66,10 @@ tape( 'the function negates real and imaginary components (output array)', funct
var actual;
var out;

// TODO: tests
out = new Array( 2 );
actual = cnegate( out, -4.2, 5.5 );

expected = [ 4.2, -5.5 ];

t.deepEqual( actual, expected, 'returns expected value' );
t.strictEqual( actual, out, 'returns output value' );
Expand All @@ -67,7 +82,10 @@ tape( 'the function negates real and imaginary components (output typed array)',
var actual;
var out;

// TODO: tests
out = new Float64Array( 2 );
actual = cnegate( out, 9.99999, 0.1 );

expected = new Float64Array( [ -9.99999, -0.1 ] );

t.deepEqual( actual, expected, 'returns expected value' );
t.strictEqual( actual, out, 'returns output value' );
Expand All @@ -80,7 +98,13 @@ tape( 'the function negates real and imaginary components (output object)', func
var actual;
var out;

// TODO: tests
out = {};
actual = cnegate( out, 4.2, -5.5 );

expected = {
'0': -4.2,
'1': 5.5
};

t.deepEqual( actual, expected, 'returns expected value' );
t.strictEqual( actual, out, 'returns output value' );
Expand Down