Neverending Pile of Messages

    @fav/math.gcd

    0.1.0 • Public • Published

    @fav/math.gcd NPM MIT License Build Status Build Status Coverage status

    Calculates the greatest common divisor of two integers.

    "fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

    Install

    To install from npm:

    $ npm install --save @fav/math.gcd

    NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/math.gcd/ directory manually.

    Usage

    For Node.js:

    var gcd = require('@fav/math.gcd');
    gcd(12, 34) // => 2
    gcd(12, -34) // => 2
    gcd(1, 12) // => 1
    
    gcd(0, 12) // => 1
    gcd(0, 0) // => 1

    For Web browsers:

    <script src="fav.math.gcd.min.js"></script>
    <script>
    var gcd = fav.math.gcd;
    gcd(12, 34) // => 2
    </script>

    API

    gcd(x, y) : number

    Calculates the greatest common divisor of two integers.

    This function assumes that both x and y are integers within Number.MIN_SAFE_INTEGERNumber.MAX_SAFE_INTEGER.

    If x or y is 0, this function returns 1.

    NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

    Parameters:

    Parameter Type Description
    x number An integer to be calculated.
    y number An integer to be calculated.

    Returns:

    The greatest common divisor of two integer parameters.

    Type: number

    Checked

    Node.js (4〜)

    Platform 4 5 6 7 8 9 10
    macOS
    Windows10
    Linux

    io.js (1〜3)

    Platform 1 2 3
    macOS
    Windows10
    Linux

    Node.js (〜0.12)

    Platform 0.8 0.9 0.10 0.11 0.12
    macOS
    Windows10
    Linux

    Web browsers

    Platform Chrome Firefox Vivaldi Safari Edge IE11
    macOS -- --
    Windows10 --
    Linux -- -- --

    License

    Copyright (C) 2018 Takayuki Sato

    This program is free software under MIT License. See the file LICENSE in this distribution for more details.

    Install

    npm i @fav/math.gcd

    DownloadsWeekly Downloads

    0

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    10.7 kB

    Total Files

    7

    Last publish

    Collaborators

    • sttk