Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/complex-float64-base-mul

Multiply two double-precision complex floating-point numbers.

https://github.com/stdlib-js/complex-float64-base-mul

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary

Keywords

arithmetic cmplx cmul complex javascript math mathematics mul mult multiplication multiply node node-js nodejs number stdlib
Last synced: 6 months ago · JSON representation ·

Repository

Multiply two double-precision complex floating-point numbers.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
arithmetic cmplx cmul complex javascript math mathematics mul mult multiplication multiply node node-js nodejs number stdlib
Created over 1 year ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

mul

NPM version Build Status Coverage Status <!-- dependencies -->

Multiply two double-precision complex floating-point numbers.

## Installation ```bash npm install @stdlib/complex-float64-base-mul ``` 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 mul = require( '@stdlib/complex-float64-base-mul' ); ``` #### mul( z1, z2 ) Multiplies two double-precision complex floating-point numbers. ```javascript var Complex128 = require( '@stdlib/complex-float64-ctor' ); var z1 = new Complex128( 5.0, 3.0 ); var z2 = new Complex128( -2.0, 1.0 ); var v = mul( z1, z2 ); // returns [ -13.0, -1.0 ] ``` The function supports the following parameters: - **z1**: first [complex number][@stdlib/complex/float64/ctor]. - **z2**: second [complex number][@stdlib/complex/float64/ctor]. #### mul.assign( re1, im1, re2, im2, out, strideOut, offsetOut ) Multiplies two double-precision complex floating-point numbers and assigns results to a provided output array. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var out = new Float64Array( 2 ); var v = mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 ); // returns [ -13.0, -1.0 ] var bool = ( out === v ); // returns true ``` The function supports the following parameters: - **re1**: real component of the first complex number. - **im1**: imaginary component of the first complex number. - **re2**: real component of the second complex number. - **im2**: imaginary component of the second complex number. - **out**: output array. - **strideOut**: stride length for `out`. - **offsetOut**: starting index for `out`. #### mul.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo ) Multiplies two double-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var z1 = new Float64Array( [ 5.0, 3.0 ] ); var z2 = new Float64Array( [ -2.0, 1.0 ] ); var out = new Float64Array( 2 ); var v = mul.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 ); // returns [ -13.0, -1.0 ] var bool = ( out === v ); // returns true ``` The function supports the following parameters: - **z1**: first complex number strided array view. - **sz1**: stride length for `z1`. - **oz1**: starting index for `z1`. - **z2**: second complex number strided array view. - **sz2**: stride length for `z2`. - **oz2**: starting index for `z2`. - **out**: output array. - **so**: stride length for `out`. - **oo**: starting index for `out`.
## Examples ```javascript var Complex128Array = require( '@stdlib/array-complex128' ); var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var mul = require( '@stdlib/complex-float64-base-mul' ); // Generate arrays of random values: var z1 = new Complex128Array( discreteUniform( 200, -50, 50 ) ); var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) ); // Perform element-wise multiplication: logEachMap( '(%s) * (%s) = %s', z1, z2, mul ); ```
## C APIs
### Usage ```c #include "stdlib/complex/float64/base/mul.h" ``` #### stdlib_base_complex128_mul( z1, z2 ) Multiplies two double-precision complex floating-point numbers. ```c #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/real.h" #include "stdlib/complex/float64/imag.h" stdlib_complex128_t z1 = stdlib_complex128( 5.0, 3.0 ); stdlib_complex128_t z2 = stdlib_complex128( -2.0, 1.0 ); stdlib_complex128_t out = stdlib_base_complex128_mul( z1, z2 ); double re = stdlib_complex128_real( out ); // returns -13.0 double im = stdlib_complex128_imag( out ); // returns -1.0 ``` The function accepts the following arguments: - **z1**: `[in] stdlib_complex128_t` input value. - **z2**: `[in] stdlib_complex128_t` input value. ```c stdlib_complex128_t stdlib_base_complex128_mul( const stdlib_complex128_t z1, const stdlib_complex128_t z2 ); ```
### Examples ```c #include "stdlib/complex/float64/base/mul.h" #include "stdlib/complex/float64/ctor.h" #include "stdlib/complex/float64/reim.h" #include int main( void ) { const stdlib_complex128_t x[] = { stdlib_complex128( 3.14, 1.5 ), stdlib_complex128( -3.14, 1.5 ), stdlib_complex128( 0.0, -0.0 ), stdlib_complex128( 0.0/0.0, 0.0/0.0 ) }; stdlib_complex128_t v; stdlib_complex128_t y; double re; double im; int i; for ( i = 0; i < 4; i++ ) { v = x[ i ]; stdlib_complex128_reim( v, &re, &im ); printf( "z = %lf + %lfi\n", re, im ); y = stdlib_base_complex128_mul( v, v ); stdlib_complex128_reim( y, &re, &im ); printf( "mul(z, z) = %lf + %lfi\n", re, im ); } } ```

* * * ## See Also - [`@stdlib/complex-float64/base/add`][@stdlib/complex/float64/base/add]: add two double-precision complex floating-point numbers. - [`@stdlib/complex-float64/base/div`][@stdlib/complex/float64/base/div]: divide two complex numbers. - [`@stdlib/complex-float64/base/sub`][@stdlib/complex/float64/base/sub]: subtract two double-precision complex floating-point numbers.
* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 50
Last Year
  • Push event: 50

Packages

  • Total packages: 1
  • Total downloads:
    • npm 97 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 4
npmjs.org: @stdlib/complex-float64-base-mul

Multiply two double-precision complex floating-point numbers.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.1.0
    published over 1 year ago
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 97 Last month
Rankings
Dependent repos count: 26.1%
Average: 32.1%
Dependent packages count: 38.0%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago