/fraction-js

Fraction library written in JavaScript.

Primary LanguageJavaScriptMIT LicenseMIT

fraction-js

Build Status npm GitHub license GitHub issues

Maintained Known Vulnerabilities PRs Welcome

Fraction library written in JavaScript.

Description

The library provides the following API:

Installation

 npm install @mathematics/fraction

API ✍

constructor

 const Fraction = require('@mathematics/fraction')

// default constructor 
const fraction = new Fraction()  // -> 0/1

// single arg constructor
const fraction = new Fraction(2)  // -> 2/1

// single arg constructor (decimal)
const fraction = new Fraction(0.2)  // -> 1/5

// two args constructor
const fraction = new Fraction(2, 5) // -> 2/5

// two args constructor (decimal)
const fraction = new Fraction(2, 0.5) // -> 4/1

// two args constructor
const fraction = new Fraction(3, 0) // -> throws error

// copy constructor
const fraction = new Fraction(that)

add

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(1, 3)
const that = new Fraction(1, 3)

fraction.add(that)  

subtract

 const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(2, 3)
const that = new Fraction(1, 3)

fraction.subtract(that)

multiply

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(3, 4)
const that = new Fraction(1, 6)

fraction.multiply(that)  

divide

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(1, 3)
const that = new Fraction(1, 6)

fraction.divide(that)

inverse

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(2, 7)

const inverse = fraction.inverse()

clone

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(4, 9)

const clone = fraction.clone()

copy

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(4, 9)
const that = new Fraction(1, 4)

fraction.copy(that)

equals

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(4, 5)
const that = new Fraction(3, 5)

const isEqual = fraction.equals(that)

value

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(4, 9)

const value = fraction.value()

toString

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(4, 9)

const string = fraction.toString()

gcd

const Fraction = require('@mathematics/fraction')

const fraction = new Fraction(4, 12)

const gcd = fraction.gcd()

Fraction.isFraction

const Fraction = require('@mathematics/fraction')

const that = new Fraction(7, 9)

const isFraction = Fraction.isFraction(that)