119 lines
2.7 KiB
Markdown
119 lines
2.7 KiB
Markdown
<!--
|
|
|
|
@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.
|
|
|
|
-->
|
|
|
|
# conj
|
|
|
|
> Return the [complex conjugate][complex-conjugate] of a complex 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 conj = require( '@stdlib/complex/conj' );
|
|
```
|
|
|
|
#### conj( z )
|
|
|
|
Returns the [complex conjugate][complex-conjugate] of a `complex` number.
|
|
|
|
```javascript
|
|
var Complex128 = require( '@stdlib/complex/float64' );
|
|
|
|
var z = new Complex128( 5.0, 3.0 );
|
|
var str = z.toString();
|
|
// returns '5 + 3i'
|
|
|
|
var v = conj( z );
|
|
str = v.toString();
|
|
// returns '5 - 3i'
|
|
```
|
|
|
|
</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 no-undef: "error" -->
|
|
|
|
```javascript
|
|
var Complex128 = require( '@stdlib/complex/float64' );
|
|
var randu = require( '@stdlib/random/base/randu' );
|
|
var round = require( '@stdlib/math/base/special/round' );
|
|
var conj = require( '@stdlib/complex/conj' );
|
|
|
|
var re;
|
|
var im;
|
|
var z;
|
|
var i;
|
|
|
|
for ( i = 0; i < 100; i++ ) {
|
|
re = round( (randu()*100.0) - 50.0 );
|
|
im = round( (randu()*50.0) - 25.0 );
|
|
z = new Complex128( re, im );
|
|
console.log( 'conj(%s) = %s', z.toString(), conj( z ).toString() );
|
|
}
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<!-- 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 all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[complex-conjugate]: https://en.wikipedia.org/wiki/Complex_conjugate
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|