-
-
Notifications
You must be signed in to change notification settings - Fork 446
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ref: #2260
- Loading branch information
Showing
19 changed files
with
1,408 additions
and
0 deletions.
There are no files selected for viewing
245 changes: 245 additions & 0 deletions
245
lib/node_modules/@stdlib/complex/float64/reim/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,245 @@ | ||
<!-- | ||
@license Apache-2.0 | ||
Copyright (c) 2018 The Stdlib Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
|
||
# reim | ||
|
||
> Return the real and imaginary components of a double-precision complex floating-point number. | ||
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<!-- Package usage documentation. --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var reim = require( '@stdlib/complex/float64/reim' ); | ||
``` | ||
|
||
#### reim( z ) | ||
|
||
Returns the **real** and **imaginary** components of a double-precision complex floating-point number. | ||
|
||
```javascript | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
|
||
var z = new Complex128( 5.0, 3.0 ); | ||
var out = reim( z ); | ||
// returns <Float64Array>[ 5.0, 3.0 ] | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="notes"> | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<!-- Package usage examples. --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint-disable max-len --> | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); | ||
var filledarrayBy = require( '@stdlib/array/filled-by' ); | ||
var reim = require( '@stdlib/complex/float64/reim' ); | ||
|
||
function random() { | ||
return new Complex128( discreteUniform( -10, 10 ), discreteUniform( -10, 10 ) ); | ||
} | ||
|
||
// Generate an array of random complex numbers: | ||
var x = filledarrayBy( 100, 'complex128', random ); | ||
// returns <Complex128Array> | ||
|
||
// Return the real and imaginary components of each complex number... | ||
var out; | ||
var z; | ||
var i; | ||
for ( i = 0; i < x.length; i++ ) { | ||
z = x.get( i ); | ||
out = reim( z ); | ||
console.log( '%s => %d, %d', z.toString(), out[ 0 ], out[ 1 ] ); | ||
} | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
<!-- C interface documentation. --> | ||
|
||
* * * | ||
|
||
<section class="c"> | ||
|
||
## C APIs | ||
|
||
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<!-- C usage documentation. --> | ||
|
||
<section class="usage"> | ||
|
||
### Usage | ||
|
||
```c | ||
#include "stdlib/complex/float64/reim.h" | ||
``` | ||
|
||
#### stdlib_complex128_reim( z, \*re, \*im ) | ||
|
||
Returns the real and imaginary components of a double-precision complex floating-point number. | ||
|
||
```c | ||
#include "stdlib/complex/float64/ctor.h" | ||
|
||
stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 ); | ||
|
||
// ... | ||
|
||
double re; | ||
double im; | ||
|
||
stdlib_complex128_reim( z, &re, &im ); | ||
``` | ||
The function accepts the following arguments: | ||
- **z**: `[in] stdlib_complex128_t` double-precision complex floating-point number. | ||
- **re**: `[out] double*` destination for real component. | ||
- **im**: `[out] double*` destination for imaginary component. | ||
```c | ||
void stdlib_complex128_reim( const stdlib_complex128_t z, double *re, double *im ); | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="notes"> | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<!-- C API usage examples. --> | ||
|
||
<section class="examples"> | ||
|
||
### Examples | ||
|
||
```c | ||
#include "stdlib/complex/float64/reim.h" | ||
#include "stdlib/complex/float64/ctor.h" | ||
#include <stdio.h> | ||
|
||
int main( void ) { | ||
const stdlib_complex128_t x[] = { | ||
stdlib_complex128( 5.0, 2.0 ), | ||
stdlib_complex128( -2.0, 1.0 ), | ||
stdlib_complex128( 0.0, -0.0 ), | ||
stdlib_complex128( 0.0/0.0, 0.0/0.0 ) | ||
}; | ||
|
||
double re; | ||
double im; | ||
int i; | ||
for ( i = 0; i < 4; i++ ) { | ||
stdlib_complex128_reim( x[ i ], &re, &im ); | ||
printf( "reim(v) = %lf, %lf\n", re, im ); | ||
} | ||
} | ||
``` | ||
</section> | ||
<!-- /.examples --> | ||
</section> | ||
<!-- /.c --> | ||
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
<section class="references"> | ||
</section> | ||
<!-- /.references --> | ||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
<section class="related"> | ||
* * * | ||
## See Also | ||
- <span class="package-name">[`@stdlib/complex/imag`][@stdlib/complex/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a double-precision complex floating-point number.</span> | ||
- <span class="package-name">[`@stdlib/complex/real`][@stdlib/complex/real]</span><span class="delimiter">: </span><span class="description">return the real component of a double-precision complex floating-point number.</span> | ||
</section> | ||
<!-- /.related --> | ||
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
<section class="links"> | ||
<!-- <related-links> --> | ||
[@stdlib/complex/imag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/imag | ||
[@stdlib/complex/real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/real | ||
<!-- </related-links> --> | ||
</section> | ||
<!-- /.links --> |
57 changes: 57 additions & 0 deletions
57
lib/node_modules/@stdlib/complex/float64/reim/benchmark/benchmark.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2018 The Stdlib Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
// MODULES // | ||
|
||
var bench = require( '@stdlib/bench' ); | ||
var Complex128 = require( '@stdlib/complex/float64/ctor' ); | ||
var randu = require( '@stdlib/random/base/randu' ); | ||
var isArrayLike = require( '@stdlib/assert/is-array-like' ); | ||
var pkg = require( './../package.json' ).name; | ||
var reim = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg, function benchmark( b ) { | ||
var values; | ||
var arr; | ||
var i; | ||
|
||
values = [ | ||
new Complex128( randu(), randu() ), | ||
new Complex128( randu(), randu() ), | ||
new Complex128( randu(), randu() ) | ||
]; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
arr = reim( values[ i%values.length ] ); | ||
if ( arr.length === 0 ) { | ||
b.fail( 'should not be empty' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( !isArrayLike( arr ) ) { | ||
b.fail( 'should return an array' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
Oops, something went wrong.