https://github.com/stdlib-js/math-base-ops-cmulf

Multiply two single-precision complex floating-point numbers.
https://github.com/stdlib-js/math-base-ops-cmulf

arithmetic cmplx cmulf complex javascript math mathematics mul mult multiplication multiply node node-js nodejs number stdlib

Last synced: 6 months ago
JSON representation

Multiply two single-precision complex floating-point numbers.

Host: GitHub
URL: https://github.com/stdlib-js/math-base-ops-cmulf
Owner: stdlib-js
License: apache-2.0
Created: 2021-12-06T07:18:26.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-07-18T01:45:16.000Z (about 1 year ago)
Last Synced: 2025-04-12T04:16:14.197Z (6 months ago)
Topics: arithmetic, cmplx, cmulf, complex, javascript, math, mathematics, mul, mult, multiplication, multiply, node, node-js, nodejs, number, stdlib
Language: Python
Homepage: https://github.com/stdlib-js/stdlib
Size: 484 KB
Stars: 2
Watchers: 3
Forks: 1
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!


# cmulf

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> Multiply two single-precision complex floating-point numbers.

## Installation

```bash

npm install @stdlib/math-base-ops-cmulf

```

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 cmulf = require( '@stdlib/math-base-ops-cmulf' );

```

#### cmulf( z1, z2 )

Multiples two single-precision complex floating-point numbers.

```javascript

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var realf = require( '@stdlib/complex-float32-real' );

var imagf = require( '@stdlib/complex-float32-imag' );

var z1 = new Complex64( 5.0, 3.0 );

var z2 = new Complex64( -2.0, 1.0 );

var v = cmulf( z1, z2 );

// returns 

var re = realf( v );

// returns -13.0

var im = imagf( v );

// returns -1.0

```

## Examples

```javascript

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;

var cmulf = require( '@stdlib/math-base-ops-cmulf' );

var rand;

var z1;

var z2;

var z3;

var i;

rand = discreteUniform( -50, 50 );

for ( i = 0; i < 100; i++ ) {

    z1 = new Complex64( rand(), rand() );

    z2 = new Complex64( rand(), rand() );

    z3 = cmulf( z1, z2 );

    console.log( '(%s) * (%s) = %s', z1.toString(), z2.toString(), z3.toString() );

}

```

* * *

## C APIs

### Usage

```c

#include "stdlib/math/base/ops/cmulf.h"

```

#### stdlib_base_cmulf( z1, z2 )

Multiplies two single-precision complex floating-point numbers.

```c

#include "stdlib/complex/float32/ctor.h"

#include "stdlib/complex/float32/real.h"

#include "stdlib/complex/float32/imag.h"

stdlib_complex64_t z1 = stdlib_complex64( 5.0f, 3.0f );

stdlib_complex64_t z2 = stdlib_complex64( -2.0f, 1.0f );

stdlib_complex64_t out = stdlib_base_cmulf( z1, z2 );

float re = stdlib_complex64_real( out );

// returns -13.0f

float im = stdlib_complex64_imag( out );

// returns -1.0f

```

The function accepts the following arguments:

-   **z1**: `[in] stdlib_complex64_t` input value.

-   **z2**: `[in] stdlib_complex64_t` input value.

```c

stdlib_complex64_t stdlib_base_cmulf( const stdlib_complex64_t z1, const stdlib_complex64_t z2 );

```

### Examples

```c

#include "stdlib/math/base/ops/cmulf.h"

#include "stdlib/complex/float32/ctor.h"

#include "stdlib/complex/float32/reim.h"

#include 

int main( void ) {

    const stdlib_complex64_t x[] = {

        stdlib_complex64( 3.14f, 1.5f ),

        stdlib_complex64( -3.14f, 1.5f ),

        stdlib_complex64( 0.0f, -0.0f ),

        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )

    };

    stdlib_complex64_t v;

    stdlib_complex64_t y;

    float re;

    float im;

    int i;

    for ( i = 0; i < 4; i++ ) {

        v = x[ i ];

        stdlib_complex64_reim( v, &re, &im );

        printf( "z = %f + %fi\n", re, im );

        y = stdlib_base_cmulf( v, v );

        stdlib_complex64_reim( y, &re, &im );

        printf( "cmulf(z, z) = %f + %fi\n", re, im );

    }

}

```

* * *

## See Also

-   [`@stdlib/complex-float32/base/add`][@stdlib/complex/float32/base/add]: add two single-precision complex floating-point numbers.

-   [`@stdlib/math-base/ops/cmul`][@stdlib/math/base/ops/cmul]: multiply two double-precision complex floating-point numbers.

-   [`@stdlib/math-base/ops/csubf`][@stdlib/math/base/ops/csubf]: subtract two single-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-2024. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-ops-cmulf.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-base-ops-cmulf

[test-image]: https://github.com/stdlib-js/math-base-ops-cmulf/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-base-ops-cmulf/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-ops-cmulf/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-base-ops-cmulf?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/math-base-ops-cmulf/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-base-ops-cmulf/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-base-ops-cmulf/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-base-ops-cmulf/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-base-ops-cmulf/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-base-ops-cmulf/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-base-ops-cmulf/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-ops-cmulf/main/LICENSE

[@stdlib/complex/float32/base/add]: https://github.com/stdlib-js/complex-float32-base-add

[@stdlib/math/base/ops/cmul]: https://github.com/stdlib-js/math-base-ops-cmul

[@stdlib/math/base/ops/csubf]: https://github.com/stdlib-js/math-base-ops-csubf

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/stdlib-js/math-base-ops-cmulf

Awesome Lists containing this project

README