BigFraction - Documentation

new BigFraction()

Description:

A class for arbitrary-precision rational number arithmetic.

Source:

frac.js, line 152

Classes

BigFraction

Methods

abs() → {BigFraction}

Description:

Returns the absolute value.

Source:

frac.js, line 406

Returns:

Type: BigFraction

acos() → {BigFraction|undefined}

Description:

Returns acos(this). Placeholder, not implemented.

Source:

frac.js, line 469

Returns:

Type: BigFraction | undefined

acosh() → {BigFraction|undefined}

Description:

Returns acosh(this). Placeholder, not implemented.

Source:

frac.js, line 523

Returns:

Type: BigFraction | undefined

add(b) → {BigFraction}

Description:

Adds another fraction.

Source:

frac.js, line 274

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

New Fraction instance

Type: BigFraction

asin() → {BigFraction|undefined}

Description:

Returns asin(this). Placeholder, not implemented.

Source:

frac.js, line 460

Returns:

Type: BigFraction | undefined

asinh() → {BigFraction|undefined}

Description:

Returns asinh(this). Placeholder, not implemented.

Source:

frac.js, line 514

Returns:

Type: BigFraction | undefined

atan() → {BigFraction|undefined}

Description:

Returns atan(this). Placeholder, not implemented.

Source:

frac.js, line 478

Returns:

Type: BigFraction | undefined

atanh() → {BigFraction|undefined}

Description:

Returns atanh(this). Placeholder, not implemented.

Source:

frac.js, line 532

Returns:

Type: BigFraction | undefined

cmp(b) → {number}

Description:

Compares with another value.

Source:

frac.js, line 618

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

-1 if less, 0 if equal, 1 if greater.

Type: number

cos() → {BigFraction|undefined}

Description:

Returns cos(this). Placeholder, not implemented.

Source:

frac.js, line 442

Returns:

Type: BigFraction | undefined

cosh() → {BigFraction|undefined}

Description:

Returns cosh(this). Placeholder, not implemented.

Source:

frac.js, line 496

Returns:

Type: BigFraction | undefined

div(b) → {BigFraction}

Description:

Divides by another fraction.

Source:

frac.js, line 315

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

equals(b) → {boolean}

Source:

frac.js, line 633

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

exp() → {BigFraction|undefined}

Description:

Returns e^this. Placeholder, not implemented.

Source:

frac.js, line 415

Returns:

Type: BigFraction | undefined

floor() → {BigFraction}

Description:

Returns the floor of the fraction (largest integer <= value).

Source:

frac.js, line 383

Returns:

Type: BigFraction

isAlmostZero() → {boolean}

Description:

Checks if the value is zero.

Source:

frac.js, line 561

Returns:

Type: boolean

isNaN() → {boolean}

Description:

Checks if the fraction is technically invalid (denominator was 0).

Source:

frac.js, line 545

Returns:

Type: boolean

isZero() → {boolean}

Description:

Checks if the value is zero.

Source:

frac.js, line 553

Returns:

Type: boolean

log() → {BigFraction|undefined}

Description:

Returns log(this). Placeholder, not implemented.

Source:

frac.js, line 424

Returns:

Type: BigFraction | undefined

mul(b) → {BigFraction}

Description:

Multiplies by another fraction.

Source:

frac.js, line 302

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

neg() → {BigFraction}

Description:

Negates the value.

Source:

frac.js, line 398

Returns:

Type: BigFraction

operatorAdd(b) → {BigFraction}

Source:

frac.js, line 689

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

operatorDiv(b) → {BigFraction}

Source:

frac.js, line 704

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

operatorEqual(b) → {boolean}

Source:

frac.js, line 673

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

operatorGreater(b) → {boolean}

Source:

frac.js, line 649

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

operatorGreaterEqual(b) → {boolean}

Source:

frac.js, line 665

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

operatorLess(b) → {boolean}

Source:

frac.js, line 641

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

operatorLessEqual(b) → {boolean}

Source:

frac.js, line 657

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

operatorMul(b) → {BigFraction}

Source:

frac.js, line 699

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

operatorNeg() → {BigFraction}

Source:

frac.js, line 713

Returns:

Type: BigFraction

operatorNotEqual(b) → {boolean}

Source:

frac.js, line 681

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: boolean

operatorPow(b) → {BigFraction|undefined}

Source:

frac.js, line 709

Parameters:

Name	Type	Description
`b`	number \| bigint \| BigFraction

Returns:

Type: BigFraction | undefined

operatorSub(b) → {BigFraction}

Source:

frac.js, line 694

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

pow(exponent) → {BigFraction|undefined}

Description:

Raises fraction to an integer power.

Source:

frac.js, line 344

Parameters:

Name	Type	Description
`exponent`	number \| bigint \| BigFraction

Returns:

Type: BigFraction | undefined

sin() → {BigFraction|undefined}

Description:

Returns sin(this). Placeholder, not implemented.

Source:

frac.js, line 433

Returns:

Type: BigFraction | undefined

sinh() → {BigFraction|undefined}

Description:

Returns sinh(this). Placeholder, not implemented.

Source:

frac.js, line 487

Returns:

Type: BigFraction | undefined

sqrt() → {BigFraction|undefined}

Description:

Returns the integer square root of the fraction (floor(sqrt(value))). Since BigInt arithmetic is integer based, exact rational roots are rare. This returns a Fraction representing the integer root.

Source:

frac.js, line 331

Returns:

Type: BigFraction | undefined

sub(b) → {BigFraction}

Description:

Subtracts another fraction.

Source:

frac.js, line 288

Parameters:

Name	Type	Description
`b`	BigFraction \| bigint \| number \| string

Returns:

Type: BigFraction

tan() → {BigFraction|undefined}

Description:

Returns tan(this). Placeholder, not implemented.

Source:

frac.js, line 451

Returns:

Type: BigFraction | undefined

tanh() → {BigFraction|undefined}

Description:

Returns tanh(this). Placeholder, not implemented.

Source:

frac.js, line 505

Returns:

Type: BigFraction | undefined

toBigFloat() → {BigFloat}

Source:

frac.js, line 568

Returns:

Type: BigFloat

toNumber() → {number}

Description:

Converts to a standard JavaScript number (may lose precision).

Source:

frac.js, line 576

Returns:

Type: number

toString(radixopt, precopt, prettyopt) → {string}

Description:

Converts to string.

Source:

frac.js, line 602

Parameters:

Name	Type	Attributes	Default	Description
`radix`	number	<optional>	`10`
`prec`	number	<optional>	`-1`	precision digits in radix
`pretty`	boolean	<optional>	`false`	pretty print

Returns:

Type: string

(static) fromString(str) → {BigFraction}

Description:

Parses a string to create a fraction. Supports integers "123", fractions "1/2", and decimals "1.5".

Source:

frac.js, line 588

Parameters:

Name	Type	Description
`str`	string

Returns:

Type: BigFraction