https://github.com/stdlib-js/complex-conj
Return the complex conjugate of a complex number.
https://github.com/stdlib-js/complex-conj
cmplx complex conj conjugate javascript math mathematics node node-js nodejs number stdlib
Last synced: about 1 month ago
JSON representation
Return the complex conjugate of a complex number.
- Host: GitHub
- URL: https://github.com/stdlib-js/complex-conj
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:14:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T02:53:59.000Z (almost 2 years ago)
- Last Synced: 2025-02-19T12:54:59.394Z (11 months ago)
- Topics: cmplx, complex, conj, conjugate, javascript, math, mathematics, node, node-js, nodejs, number, stdlib
- Language: Makefile
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 472 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# conj
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the [complex conjugate][complex-conjugate] of a double-precision complex floating-point number.
## Installation
```bash
npm install @stdlib/complex-conj
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var conj = require( '@stdlib/complex-conj' );
```
#### conj( z )
Returns the [complex conjugate][complex-conjugate] of a double-precision complex floating-point 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'
```
## Examples
```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() );
}
```
* * *
## C APIs
### Usage
```c
#include "stdlib/complex/conj.h"
```
#### stdlib_conj( z )
Returns the [complex conjugate][complex-conjugate] of a double-precision complex floating-point number.
```c
#include "stdlib/complex/float64.h"
#include "stdlib/complex/real.h"
#include "stdlib/complex/imag.h"
stdlib_complex128_t z = stdlib_complex128( 5.0, 2.0 );
// ...
stdlib_complex128_t v = stdlib_conj( z );
double re = stdlib_real( v );
// returns 5.0
double im = stdlib_imag( v );
// returns -2.0
```
The function accepts the following arguments:
- **z**: `[in] stdlib_complex128_t` double-precision complex floating-point number.
```c
stdlib_complex128_t stdlib_conj( const stdlib_complex128_t z );
```
### Examples
```c
#include "stdlib/complex/conj.h"
#include "stdlib/complex/real.h"
#include "stdlib/complex/imag.h"
#include "stdlib/complex/float64.h"
#include
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 )
};
stdlib_complex128_t z;
stdlib_complex128_t v;
int i;
for ( i = 0; i < 4; i++ ) {
z = x[ i ];
v = stdlib_conj( z );
printf( "conj(%lf + %lfi) = %lf + %lfi\n", stdlib_real( z ), stdlib_imag( z ), stdlib_real( v ), stdlib_imag( v ) );
}
}
```
* * *
## See Also
- [`@stdlib/complex-imag`][@stdlib/complex/imag]: return the imaginary component of a double-precision complex floating-point number.
- [`@stdlib/complex-real`][@stdlib/complex/real]: return the real component of a double-precision complex floating-point number.
- [`@stdlib/complex-reim`][@stdlib/complex/reim]: return the real and imaginary components of a double-precision complex floating-point number.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/complex-conj.svg
[npm-url]: https://npmjs.org/package/@stdlib/complex-conj
[test-image]: https://github.com/stdlib-js/complex-conj/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/complex-conj/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/complex-conj/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/complex-conj?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/complex-conj/tree/deno
[deno-readme]: https://github.com/stdlib-js/complex-conj/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/complex-conj/tree/umd
[umd-readme]: https://github.com/stdlib-js/complex-conj/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/complex-conj/tree/esm
[esm-readme]: https://github.com/stdlib-js/complex-conj/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/complex-conj/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/complex-conj/main/LICENSE
[complex-conjugate]: https://en.wikipedia.org/wiki/Complex_conjugate
[@stdlib/complex/imag]: https://github.com/stdlib-js/complex-imag
[@stdlib/complex/real]: https://github.com/stdlib-js/complex-real
[@stdlib/complex/reim]: https://github.com/stdlib-js/complex-reim