Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Multiply two double-precision floating-point numbers.
https://github.com/stdlib-js/math-base-ops-mul

double double-precision javascript math mathematics multiplication multiply node node-js nodejs number prod product stdlib times

Last synced: about 17 hours ago
JSON representation

Multiply two double-precision floating-point numbers.

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!

# mul

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

> Multiply two double-precision floating-point numbers.

## Installation

```bash
npm install @stdlib/math-base-ops-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/math-base-ops-mul' );
```

#### mul( x, y )

Multiplies two double-precision floating-point numbers.

```javascript
var v = mul( -1.0, 5.0 );
// returns -5.0

v = mul( 2.0, 5.0 );
// returns 10.0

v = mul( 0.0, 5.0 );
// returns 0.0

v = mul( -0.0, 0.0 );
// returns -0.0

v = mul( NaN, NaN );
// returns NaN
```

## Examples

```javascript
var rand = require( '@stdlib/random-base-discrete-uniform' );
var mul = require( '@stdlib/math-base-ops-mul' );

var x;
var y;
var i;

for ( i = 0; i < 100; i++ ) {
x = rand( -50, 50 );
y = rand( -50, 50 );
console.log( '%d x %d = %d', x, y, mul( x, y ) );
}
```

* * *

## C APIs

### Usage

```c
#include "stdlib/math/base/ops/mul.h"
```

#### stdlib_base_mul( x, y )

Multiplies two double-precision floating-point numbers.

```c
double v = stdlib_base_mul( -5.0, 2.0 );
// returns -10.0
```

The function accepts the following arguments:

- **x**: `[in] double` first input value.
- **y**: `[in] double` second input value.

```c
double stdlib_base_mul( const double x, const double y );
```

### Examples

```c
#include "stdlib/math/base/ops/mul.h"
#include

int main( void ) {
const double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 };
const double y[] = { 3.14, -3.14, -0.0, 0.0/0.0 };

double z;
int i;
for ( i = 0; i < 4; i++ ) {
z = stdlib_base_mul( x[ i ], y[ i ] );
printf( "%lf x %lf = %lf\n", x[ i ], y[ i ], z );
}
}
```

* * *

## See Also

- [`@stdlib/math-base/ops/add`][@stdlib/math/base/ops/add]: compute the sum of two double-precision floating-point numbers.
- [`@stdlib/math-base/ops/div`][@stdlib/math/base/ops/div]: divide two double-precision floating-point numbers.
- [`@stdlib/math-base/ops/sub`][@stdlib/math/base/ops/sub]: subtract two double-precision 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-mul.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-ops-mul

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

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-ops-mul/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-ops-mul?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-mul/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-ops-mul/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-ops-mul/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-ops-mul/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-ops-mul/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-ops-mul/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-ops-mul/blob/main/branches.md

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

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

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

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