Package detail

@stdlib/math-base-special-lcm

stdlib-js74Apache-2.00.3.0

Compute the least common multiple (lcm).

stdlib, stdmath, math, mathematics

readme

<summary> About stdlib... </summary>

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!

lcm

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

Compute the [least common multiple][lcm] (lcm).

The [least common multiple][lcm] (lcm) of two non-zero integers a and b is the smallest positive integer that is divisible by both a and b. The lcm is also known as the lowest common multiple or smallest common multiple and finds common use in calculating the lowest common denominator (lcd).
## Installation bash npm install @stdlib/math-base-special-lcm
## Usage javascript var lcm = require( '@stdlib/math-base-special-lcm' ); #### lcm( a, b ) Computes the [least common multiple][lcm] (lcm). javascript var v = lcm( 48, 18 ); // returns 144 If either a or b is 0, the function returns 0. javascript var v = lcm( 0, 0 ); // returns 0 v = lcm( 2, 0 ); // returns 0 v = lcm( 0, 3 ); // returns 0 Both a and b must have integer values; otherwise, the function returns NaN. javascript var v = lcm( 3.14, 18 ); // returns NaN v = lcm( 48, 3.14 ); // returns NaN v = lcm( NaN, 18 ); // returns NaN v = lcm( 48, NaN ); // returns NaN
## Examples javascript var randu = require( '@stdlib/random-base-randu' ); var round = require( '@stdlib/math-base-special-round' ); var lcm = require( '@stdlib/math-base-special-lcm' ); var a; var b; var v; var i; for ( i = 0; i < 100; i++ ) { a = round( randu()*50 ); b = round( randu()*50 ); v = lcm( a, b ); console.log( 'lcm(%d,%d) = %d', a, b, v ); }

## C APIs
### Usage c #include "stdlib/math/base/special/lcm.h" #### stdlib_base_lcm( a, b ) Computes the [least common multiple][lcm] (lcm). c double v = stdlib_base_lcm( 48.0, 18.0 ); // returns 144.0 The function accepts the following arguments: - a: [in] double input value. - b: [in] double input value. c double stdlib_base_lcm( const double a, const double b );
### Examples c #include "stdlib/math/base/special/lcm.h" #include <stdio.h> int main( void ) { const double a[] = { 24.0, 32.0, 48.0, 116.0, 33.0 }; const double b[] = { 12.0, 6.0, 15.0, 52.0, 22.0 }; double out; int i; for ( i = 0; i < 5; i++ ) { out = stdlib_base_lcm( a[ i ], b[ i ] ); printf( "lcm(%lf, %lf) = %lf\n", a[ i ], b[ i ], out ); } }

* ## See Also - [@stdlib/math-base/special/gcd][@stdlib/math/base/special/gcd]: compute the greatest common divisor (gcd).
* ## 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-special-lcm.svg [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-lcm [test-image]: https://github.com/stdlib-js/math-base-special-lcm/actions/workflows/test.yml/badge.svg?branch=v0.3.0 [test-url]: https://github.com/stdlib-js/math-base-special-lcm/actions/workflows/test.yml?query=branch:v0.3.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-lcm/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-lcm?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-special-lcm/tree/deno [deno-readme]: https://github.com/stdlib-js/math-base-special-lcm/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-base-special-lcm/tree/umd [umd-readme]: https://github.com/stdlib-js/math-base-special-lcm/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/math-base-special-lcm/tree/esm [esm-readme]: https://github.com/stdlib-js/math-base-special-lcm/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/math-base-special-lcm/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-lcm/main/LICENSE [lcm]: https://en.wikipedia.org/wiki/Least_common_multiple [@stdlib/math/base/special/gcd]: https://www.npmjs.com/package/@stdlib/math-base-special-gcd