undertone

Appearance

@liminal-hq/undertone / Fraction

Class: Fraction ​

Defined in: fraction.ts:18

An immutable rational number (numerator/denominator, always in lowest terms, denominator always positive). Pattern time is measured in cycles as Fractions so that subdivisions like triplets stay exact across arbitrarily many cycles.

Constructors ​

Constructor ​

new Fraction(numerator, denominator?): Fraction

Defined in: fraction.ts:22

Parameters ​

numerator ​

number

denominator? ​

number = 1

Returns ​

Fraction

Properties ​

d ​

readonly d: number

Defined in: fraction.ts:20

n ​

readonly n: number

Defined in: fraction.ts:19

Methods ​

add() ​

add(other): Fraction

Defined in: fraction.ts:63

Parameters ​

other ​

Fraction

Returns ​

Fraction

cmp() ​

cmp(other): number

Defined in: fraction.ts:83

Negative, zero, or positive as this is less than, equal to, or greater than other.

Parameters ​

other ​

Fraction

Returns ​

number

cyclePos() ​

cyclePos(): Fraction

Defined in: fraction.ts:131

Position within the current cycle, in [0, 1).

Returns ​

Fraction

div() ​

div(other): Fraction

Defined in: fraction.ts:75

Parameters ​

other ​

Fraction

Returns ​

Fraction

eq() ​

eq(other): boolean

Defined in: fraction.ts:87

Parameters ​

other ​

Fraction

Returns ​

boolean

floor() ​

floor(): number

Defined in: fraction.ts:116

The largest integer <= this value (rounds towards negative infinity).

Returns ​

number

gt() ​

gt(other): boolean

Defined in: fraction.ts:99

Parameters ​

other ​

Fraction

Returns ​

boolean

gte() ​

gte(other): boolean

Defined in: fraction.ts:103

Parameters ​

other ​

Fraction

Returns ​

boolean

lt() ​

lt(other): boolean

Defined in: fraction.ts:91

Parameters ​

other ​

Fraction

Returns ​

boolean

lte() ​

lte(other): boolean

Defined in: fraction.ts:95

Parameters ​

other ​

Fraction

Returns ​

boolean

max() ​

max(other): Fraction

Defined in: fraction.ts:111

Parameters ​

other ​

Fraction

Returns ​

Fraction

min() ​

min(other): Fraction

Defined in: fraction.ts:107

Parameters ​

other ​

Fraction

Returns ​

Fraction

mul() ​

mul(other): Fraction

Defined in: fraction.ts:71

Parameters ​

other ​

Fraction

Returns ​

Fraction

nextSam() ​

nextSam(): Fraction

Defined in: fraction.ts:126

The start of the next cycle.

Returns ​

Fraction

sam() ​

sam(): Fraction

Defined in: fraction.ts:121

The start of the cycle this time falls in ("sam" in Tidal terminology).

Returns ​

Fraction

sub() ​

sub(other): Fraction

Defined in: fraction.ts:67

Parameters ​

other ​

Fraction

Returns ​

Fraction

toNumber() ​

toNumber(): number

Defined in: fraction.ts:135

Returns ​

number

toString() ​

toString(): string

Defined in: fraction.ts:139

Returns ​

string

from() ​

static from(value): Fraction

Defined in: fraction.ts:39

Converts a number (integer or decimal like 1.5) or existing Fraction to a Fraction.

Parameters ​

value ​

number | Fraction

Returns ​

Fraction