Namespace: IntervalClass

Interfaces

• IntervalClassBrand

Type Aliases

IntervalClass

Ƭ IntervalClass: Shape & IntervalClassBrand

Unordered pitch-class interval

Number of ascending semitones from one pitch-class to the next, ordered from lowest to highest

See

https://en.wikipedia.org/wiki/Pitch_interval#Unordered_pitch-class_intervals_('interval_class;_IC')

Defined in

internal/IntervalClass.ts:19

---

Shape

Ƭ Shape: RangedNat<typeof min, typeof max>

Defined in

internal/IntervalClass.ts:6

Variables

ALL

• Const ALL: readonly IntervalClass[]

Defined in

internal/IntervalClass.ts:34

---

MAX

• Const MAX: 6 & IntervalClassBrand

Defined in

internal/IntervalClass.ts:33

---

MIN

• Const MIN: 0 & IntervalClassBrand

Defined in

internal/IntervalClass.ts:32

Functions

between

▸ between(a, b): IntervalClass

Parameters

Name	Type
a	PitchClass
b	PitchClass

Returns

IntervalClass

Defined in

internal/conversion.ts:12

---

from

▸ from(v): IntervalClass

Parameters

Name	Type
v	0 | 1 | 2 | 3 | 4 | 5 | 6

Returns

IntervalClass

Defined in

internal/IntervalClass.ts:25

---

fromIntClamp

▸ fromIntClamp(v): IntervalClass

Parameters

Name	Type
v	Int

Returns

IntervalClass

Defined in

internal/IntervalClass.ts:27

---

fromIntMod

▸ fromIntMod(v): IntervalClass

Parameters

Name	Type
v	Int

Returns

IntervalClass

Defined in

internal/IntervalClass.ts:28

---

fromNum

▸ fromNum(v): IntervalClass

Parameters

Name	Type
v	number

Returns

IntervalClass

Defined in

internal/IntervalClass.ts:26

---

fromPic

▸ fromPic(pic): IntervalClass

Parameters

Name	Type
pic	PitchIntervalClass

Returns

IntervalClass

Defined in

internal/conversion.ts:10

---

fromUnknown

▸ fromUnknown(v): IntervalClass

Parameters

Name	Type
v	unknown

Returns

IntervalClass

Defined in

internal/IntervalClass.ts:29

---

hasShape

▸ hasShape<T>(v): v is T & (0 | 1 | 2 | 3 | 4 | 5 | 6)

Type parameters

Name
T

Parameters

Name	Type
v	T

Returns

v is T & (0 | 1 | 2 | 3 | 4 | 5 | 6)

Defined in

internal/IntervalClass.ts:7

---

mark

▸ mark(_v): _v is IntervalClass

Parameters

Name	Type
_v	0 | 1 | 2 | 3 | 4 | 5 | 6

Returns

_v is IntervalClass

Defined in

internal/IntervalClass.ts:21

---

markNum

▸ markNum(v): v is IntervalClass

Parameters

Name	Type
v	number

Returns

v is IntervalClass

Defined in

internal/IntervalClass.ts:22

---

markUnknown

▸ markUnknown(v): v is IntervalClass

Parameters

Name	Type
v	unknown

Returns

v is IntervalClass

Defined in

internal/IntervalClass.ts:23