Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/math-base-special-gcdf
Compute the greatest common divisor (gcd).
https://github.com/stdlib-js/math-base-special-gcdf
binary-gcd euclid euclidean gcd gcf gcm greatest-common-divisor greatest-common-factor greatest-common-measure hcf highest-common-divisor highest-common-factor javascript math mathematics node node-js nodejs stdlib stein
Last synced: about 2 months ago
JSON representation
Compute the greatest common divisor (gcd).
- Host: GitHub
- URL: https://github.com/stdlib-js/math-base-special-gcdf
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-11-11T15:21:14.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T01:56:16.000Z (about 2 months ago)
- Last Synced: 2024-12-09T02:39:50.930Z (about 2 months ago)
- Topics: binary-gcd, euclid, euclidean, gcd, gcf, gcm, greatest-common-divisor, greatest-common-factor, greatest-common-measure, hcf, highest-common-divisor, highest-common-factor, javascript, math, mathematics, node, node-js, nodejs, stdlib, stein
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 248 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- 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!
# gcdf
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [greatest common divisor][gcd] (gcd) of two single-precision floating-point numbers.
The [greatest common divisor][gcd] (gcd) of two non-zero integers `a` and `b` is the largest positive integer which divides both `a` and `b` without a remainder. The gcd is also known as the **greatest common factor** (gcf), **highest common factor** (hcf), **highest common divisor**, and **greatest common measure** (gcm).
## Installation
```bash
npm install @stdlib/math-base-special-gcdf
```
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 gcdf = require( '@stdlib/math-base-special-gcdf' );
```
#### gcdf( a, b )
Computes the [greatest common divisor][gcd] (gcd) of two single-precision floating-point numbers.
```javascript
var v = gcdf( 48, 18 );
// returns 6
```
If both `a` and `b` are `0`, the function returns `0`.
```javascript
var v = gcdf( 0, 0 );
// returns 0
```
Both `a` and `b` must have integer values; otherwise, the function returns `NaN`.
```javascript
var v = gcdf( 3.14, 18 );
// returns NaN
v = gcdf( 48, 3.14 );
// returns NaN
v = gcdf( NaN, 18 );
// returns NaN
v = gcdf( 48, NaN );
// returns NaN
```
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var gcdf = require( '@stdlib/math-base-special-gcdf' );
var a = discreteUniform( 100, 0, 50 );
var b = discreteUniform( a.length, 0, 50 );
var i;
for ( i = 0; i < a.length; i++ ) {
console.log( 'gcdf(%d,%d) = %d', a[ i ], b[ i ], gcdf( a[ i ], b[ i ] ) );
}
```
* * *
## C APIs
### Usage
```c
#include "stdlib/math/base/special/gcdf.h"
```
#### stdlib_base_gcdf( a, b )
Computes the greatest common divisor (gcd) of two single-precision floating-point numbers.
```c
float v = stdlib_base_gcdf( 48.0f, 18.0f );
// returns 6.0f
```
The function accepts the following arguments:
- **a**: `[in] float` input value.
- **b**: `[in] float` input value.
```c
float stdlib_base_gcdf( const float a, const float b );
```
### Examples
```c
#include "stdlib/math/base/special/gcdf.h"
#include
int main( void ) {
const float a[] = { 24.0f, 32.0f, 48.0f, 116.0f, 33.0f };
const float b[] = { 12.0f, 6.0f, 15.0f, 52.0f, 22.0f };
float out;
int i;
for ( i = 0; i < 5; i++ ) {
out = stdlib_base_gcdf( a[ i ], b[ i ] );
printf( "gcdf(%f, %f) = %f\n", a[ i ], b[ i ], out );
}
}
```
## References
- Stein, Josef. 1967. "Computational problems associated with Racah algebra." _Journal of Computational Physics_ 1 (3): 397–405. doi:[10.1016/0021-9991(67)90047-2][@stein:1967].
* * *
## 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-gcdf.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-gcdf
[test-image]: https://github.com/stdlib-js/math-base-special-gcdf/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-base-special-gcdf/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-gcdf/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-gcdf?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-gcdf/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-gcdf/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-gcdf/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-gcdf/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-gcdf/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-gcdf/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-gcdf/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-gcdf/main/LICENSE
[gcd]: https://en.wikipedia.org/wiki/Greatest_common_divisor
[@stein:1967]: https://doi.org/10.1016/0021-9991(67)90047-2