complex-float64-base-mul-add

Perform a multiply-add operation involving three double-precision complex floating-point numbers.

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

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
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

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

Repository

Perform a multiply-add operation involving three double-precision complex floating-point numbers.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
add addition arithmetic cmplx complex javascript math mathematics mul mult multiplication multiply node node-js nodejs number stdlib
Created 12 months ago · Last pushed 5 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!

muladd

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

Perform a multiply-add operation involving three double-precision complex floating-point numbers.

## Installation ```bash npm install @stdlib/complex-float64-base-mul-add ``` 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 muladd = require( '@stdlib/complex-float64-base-mul-add' ); ``` #### muladd( alpha, x, y ) Performs a multiply-add operation involving three double-precision complex floating-point numbers. ```javascript var Complex128 = require( '@stdlib/complex-float64-ctor' ); var real = require( '@stdlib/complex-float64-real' ); var imag = require( '@stdlib/complex-float64-imag' ); var z1 = new Complex128( 5.0, 3.0 ); var z2 = new Complex128( -2.0, 1.0 ); var z3 = new Complex128( 7.0, -8.0 ); // Compute `alpha*x + y`: var v = muladd( z1, z2, z3 ); // returns [ -6.0, -9.0 ] ``` The function supports the following parameters: - **alpha**: first [complex number][@stdlib/complex/float64/ctor]. - **x**: second [complex number][@stdlib/complex/float64/ctor]. - **y**: third [complex number][@stdlib/complex/float64/ctor]. #### muladd.assign( ar, ai, xr, xi, yr, yi, out, strideOut, offsetOut ) Performs a multiply-add operation involving three double-precision complex floating-point numbers and assigns the results to an output strided array. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var out = new Float64Array( 2 ); var v = muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, out, 1, 0 ); // returns [ -6.0, -9.0 ] var bool = ( out === v ); // returns true ``` The function supports the following parameters: - **ar**: real component of the first complex number. - **ai**: imaginary component of the first complex number. - **xr**: real component of the second complex number. - **xi**: imaginary component of the second complex number. - **yr**: real component of the third complex number. - **yi**: imaginary component of the third complex number. - **out**: output array. - **strideOut**: stride length for `out`. - **offsetOut**: starting index for `out`. #### muladd.strided( alpha, sa, oa, x, sx, ox, y, sy, oy, out, so, oo ) Performs a multiply-add operation involving three 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 z3 = new Float64Array( [ 7.0, -8.0 ] ); var out = new Float64Array( 2 ); var v = muladd.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // returns [ -6.0, -9.0 ] var bool = ( out === v ); // returns true ``` The function supports the following parameters: - **alpha**: first complex number strided array view. - **sa**: stride length for `alpha`. - **oa**: starting index for `alpha`. - **x**: second complex number strided array view. - **sx**: stride length for `x`. - **ox**: starting index for `x`. - **y**: third complex number strided array view. - **sy**: stride length for `y`. - **oy**: starting index for `y`. - **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 muladd = require( '@stdlib/complex-float64-base-mul-add' ); // Generate arrays of random values: var z1 = new Complex128Array( discreteUniform( 200, -50, 50 ) ); var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) ); var z3 = new Complex128Array( discreteUniform( 200, -50, 50 ) ); // Perform element-wise computation: logEachMap( '( (%s) * (%s) ) + (%s) = %s', z1, z2, z3, muladd ); ```

## C APIs
### Usage ```c #include "stdlib/complex/float64/base/mul_add.h" ``` #### stdlib_base_complex128_muladd( alpha, x, y ) Performs a multiply-add operation involving three 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 z3 = stdlib_complex128( 7.0, -8.0 ); stdlib_complex128_t out = stdlib_base_complex128_muladd( z1, z2, z3 ); double re = stdlib_complex128_real( out ); // returns -6.0 double im = stdlib_complex128_imag( out ); // returns -9.0 ``` The function accepts the following arguments: - **alpha**: `[in] stdlib_complex128_t` input value. - **x**: `[in] stdlib_complex128_t` input value. - **y**: `[in] stdlib_complex128_t` input value. ```c stdlib_complex128_t stdlib_base_complex128_muladd( const stdlib_complex128_t alpha, const stdlib_complex128_t x, const stdlib_complex128_t y ); ```
### Examples ```c #include "stdlib/complex/float64/base/mul_add.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_muladd( v, v, v ); stdlib_complex128_reim( y, &re, &im ); printf( "z*z + z = %lf + %lfi\n", re, im ); } } ```

* * * ## 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
  • Watch event: 1
  • Push event: 28
  • Create event: 6
Last Year
  • Watch event: 1
  • Push event: 28
  • Create event: 6

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 3
  • Total Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite
.github/workflows/examples.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/productionize.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/test.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_bundles.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite
.github/workflows/test_coverage.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_published_package.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
benchmark/julia/REQUIRE julia
  • BenchmarkTools 0.5.0
  • julia 1.5
package.json npm
  • @stdlib/array-float64 ^0.2.2 development
  • @stdlib/assert-is-method ^0.2.2 development
  • @stdlib/assert-is-same-float64array ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/math-base-assert-is-nan ^0.2.2 development
  • @stdlib/random-array-uniform ^0.2.1 development
  • @stdlib/random-base-discrete-uniform ^0.2.1 development
  • @stdlib/random-base-uniform ^0.2.1 development
  • @stdlib/utils-try-require ^0.2.2 development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/complex-float64-ctor ^0.0.3
  • @stdlib/complex-float64-imag ^0.1.1
  • @stdlib/complex-float64-real ^0.1.1
  • @stdlib/complex-float64-reim ^0.1.2
  • @stdlib/math-base-napi-ternary ^0.3.0
  • @stdlib/types ^0.4.3
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2
  • @stdlib/utils-library-manifest ^0.2.2