Class Fraction

Number with an integer numerator and denominator.

Hierarchy

Fraction
- Percent

Implements

Index

Constructors

Properties

denominator isFraction numerator ONE ZERO

Accessors

asFraction denominatorStr numeratorStr quotient remainder

Methods

add compareTo divide equalTo greaterThan invert isNonZero isZero lessThan multiply subtract toJSON fromNumber fromObject isFraction

Constructors

constructor

new Fraction(numerator: BigintIsh, denominator?: BigintIsh): Fraction
Parameters
- numerator: BigintIsh
- denominator: BigintIsh = ONE
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:78

Properties

`Readonly` denominator

denominator: JSBI

`Readonly` isFraction

isFraction: true = true

This boolean checks to see if this is actually a Fraction.

`Readonly` numerator

numerator: JSBI

`Static` `Readonly` ONE

ONE: Fraction = ...

`Static` `Readonly` ZERO

ZERO: Fraction = ...

Accessors

asFraction

get asFraction(): Fraction
Helper method for converting any super class back to a fraction

Returns Fraction
- Defined in packages/fraction/src/fraction.ts:247

denominatorStr

get denominatorStr(): string
Fraction denominator.

Returns string
Implementation of FractionObject.denominatorStr
- Defined in packages/fraction/src/fraction.ts:68

numeratorStr

get numeratorStr(): string
Fraction numerator.

Returns string
Implementation of FractionObject.numeratorStr
- Defined in packages/fraction/src/fraction.ts:65

quotient

get quotient(): JSBI
Performs floor division.

Returns JSBI
- Defined in packages/fraction/src/fraction.ts:145

remainder

get remainder(): Fraction
Remainder after floor division.

Returns Fraction
- Defined in packages/fraction/src/fraction.ts:152

Methods

add

add(other: Fraction | BigintIsh): Fraction
Parameters
- other: Fraction | BigintIsh
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:167

compareTo

compareTo(other: Fraction): 0 | 1 | -1
Compares this Fraction to the other Fraction.
Parameters
- other: Fraction
Returns 0 | 1 | -1
- Defined in packages/fraction/src/fraction.ts:124

divide

divide(other: Fraction | BigintIsh): Fraction
Divides this Fraction by another Fraction.
Parameters
- other: Fraction | BigintIsh
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:236

equalTo

equalTo(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
- Defined in packages/fraction/src/fraction.ts:209

greaterThan

greaterThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
- Defined in packages/fraction/src/fraction.ts:217

invert

invert(): Fraction
Swaps the numerator and denominator of the Fraction.

Returns

Returns Fraction
- Defined in packages/fraction/src/fraction.ts:163

isNonZero

isNonZero(): boolean
Returns true if this number (the numerator) is not equal to zero.

Returns

Returns boolean
- Defined in packages/fraction/src/fraction.ts:263

isZero

isZero(): boolean
Returns true if this number (the numerator) is equal to zero and the denominator is non-zero.

Returns

Returns boolean
- Defined in packages/fraction/src/fraction.ts:255

lessThan

lessThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
- Defined in packages/fraction/src/fraction.ts:201

multiply

multiply(other: Fraction | BigintIsh): Fraction
Parameters
- other: Fraction | BigintIsh
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:225

subtract

subtract(other: Fraction | BigintIsh): Fraction
Parameters
- other: Fraction | BigintIsh
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:184

toJSON

toJSON(): FractionObject
JSON representation of the Fraction.

Returns FractionObject
- Defined in packages/fraction/src/fraction.ts:98

`Static` fromNumber

fromNumber(number: number, decimals?: number): Fraction
Parses a Fraction from a float.

Returns
Fraction
Parameters
- number: number
  
  Number to parse.
- decimals: number = 10
  
  Number of decimals of precision. (default 10)
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:137

`Static` fromObject

fromObject(other: FractionObject): Fraction
Ensures the other object is of this Fraction type.

Returns
Parameters
- other: FractionObject
Returns Fraction
- Defined in packages/fraction/src/fraction.ts:88

`Static` isFraction

isFraction(other: unknown): other is Fraction
Returns true if the other object is a Fraction.

Returns
Parameters
- other: unknown
Returns other is Fraction
- Defined in packages/fraction/src/fraction.ts:112

Generated using TypeDoc