Namespace: PitchInterval

Interfaces

• PitchIntervalBrand

References

between

Renames and re-exports pi

Type Aliases

PitchInterval

Ƭ PitchInterval: Shape & PitchIntervalBrand

Ordered pitch interval

Number of semitones that separates one pitch from another, upward or downward.

See

https://en.wikipedia.org/wiki/Pitch_interval#Ordered_Pitch_Interval

Defined in

internal/PitchInterval.ts:20

Functions

add

▸ add(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	PitchInterval

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:41

---

addChecked

▸ addChecked(a, b): Int

Parameters

Name	Type
a	PitchInterval
b	PitchInterval

Returns

Int

Defined in

internal/PitchInterval.ts:42

---

direction

▸ direction(pi): -1 | 0 | 1

Parameters

Name	Type
pi	PitchInterval

Returns

-1 | 0 | 1

Defined in

internal/PitchInterval.ts:64

---

divChecked

▸ divChecked(a, b): Int

Parameters

Name	Type
a	PitchInterval
b	PitchInterval

Returns

Int

Defined in

internal/PitchInterval.ts:55

---

divRound

▸ divRound(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:57

---

divTrunc

▸ divTrunc(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:58

---

from

▸ from(v): PitchInterval

Parameters

Name	Type
v	Int | PartialPitchInterval

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:32

---

fromNum

▸ fromNum(v): PitchInterval

Parameters

Name	Type
v	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:33

---

fromNumRound

▸ fromNumRound(v): PitchInterval

Parameters

Name	Type
v	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:34

---

fromNumTrunc

▸ fromNumTrunc(v): PitchInterval

Parameters

Name	Type
v	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:35

---

fromUnknown

▸ fromUnknown(v): PitchInterval

Parameters

Name	Type
v	unknown

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:36

---

hasShape

▸ hasShape<T>(v): v is T & number & IntBrand

Type parameters

Name
T

Parameters

Name	Type
v	T

Returns

v is T & number & IntBrand

Defined in

internal/PitchInterval.ts:8

---

mark

▸ mark(_v): _v is PitchInterval

Parameters

Name	Type
_v	Int

Returns

_v is PitchInterval

Defined in

internal/PitchInterval.ts:22

---

markNum

▸ markNum(v): v is PitchInterval

Parameters

Name	Type
v	number

Returns

v is PitchInterval

Defined in

internal/PitchInterval.ts:23

---

markUnknown

▸ markUnknown(v): v is PitchInterval

Parameters

Name	Type
v	unknown

Returns

v is PitchInterval

Defined in

internal/PitchInterval.ts:24

---

mul

▸ mul(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	Int

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:49

---

mulChecked

▸ mulChecked(a, b): Int

Parameters

Name	Type
a	PitchInterval
b	PitchInterval

Returns

Int

Defined in

internal/PitchInterval.ts:50

---

mulRound

▸ mulRound(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:52

---

mulTrunc

▸ mulTrunc(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	number

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:53

---

octaves

▸ octaves(pi): NonNegativeInt

Parameters

Name	Type
pi	PitchInterval

Returns

NonNegativeInt

Defined in

internal/PitchInterval.ts:60

---

pic

▸ pic(pi): PitchIntervalClass

Gets the pitch interval class of the pitch interval.

Parameters

Name	Type
pi	PitchInterval

Returns

PitchIntervalClass

Example

import * as PI from "brand-music/PitchInterval";
import * as PIC from "brand-music/PitchIntervalClass";

const picOfPi = PIC.fromPi(PI.from(-2)); // 10
const picOfSemitones = PIC.fromSemitones(PI.semitones(PI.from(-2))); // 2

Defined in

internal/conversion.ts:56

---

semitones

▸ semitones(pi): Semitones

Parameters

Name	Type
pi	PitchInterval

Returns

Semitones

Defined in

internal/conversion.ts:60

---

sub

▸ sub(a, b): PitchInterval

Parameters

Name	Type
a	PitchInterval
b	PitchInterval

Returns

PitchInterval

Defined in

internal/PitchInterval.ts:45

---

subChecked

▸ subChecked(a, b): Int

Parameters

Name	Type
a	PitchInterval
b	PitchInterval

Returns

Int

Defined in

internal/PitchInterval.ts:46