Namespace: PitchIntervalClass

Interfaces

• PitchIntervalClassBrand

References

between

Renames and re-exports pic

---

fromPi

Renames and re-exports pic

---

ic

Renames and re-exports fromPic

Type Aliases

PitchIntervalClass

Ƭ PitchIntervalClass: Shape & PitchIntervalClassBrand

Ordered 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#Ordered_pitch-class_intervals_('pitch_interval_class;_PIC')

Defined in

internal/PitchIntervalClass.ts:19

---

Shape

Ƭ Shape: RangedNat<typeof min, typeof max>

Defined in

internal/PitchIntervalClass.ts:6

Variables

ALL

• Const ALL: readonly PitchIntervalClass[]

Defined in

internal/PitchIntervalClass.ts:34

---

MAX

• Const MAX: 11 & PitchIntervalClassBrand

Defined in

internal/PitchIntervalClass.ts:33

---

MIN

• Const MIN: 0 & PitchIntervalClassBrand

Defined in

internal/PitchIntervalClass.ts:32

Functions

from

▸ from(v): PitchIntervalClass

Parameters

Name	Type
v	0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Returns

PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:25

---

fromIntClamp

▸ fromIntClamp(v): PitchIntervalClass

Parameters

Name	Type
v	Int

Returns

PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:27

---

fromIntMod

▸ fromIntMod(v): PitchIntervalClass

Parameters

Name	Type
v	Int

Returns

PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:28

---

fromNum

▸ fromNum(v): PitchIntervalClass

Parameters

Name	Type
v	number

Returns

PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:26

---

fromSemitones

▸ fromSemitones(semitones): PitchIntervalClass

Parameters

Name	Type
semitones	Semitones

Returns

PitchIntervalClass

Defined in

internal/conversion.ts:57

---

fromUnknown

▸ fromUnknown(v): PitchIntervalClass

Parameters

Name	Type
v	unknown

Returns

PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:29

---

hasShape

▸ hasShape<T>(v): v is T & (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11)

Type parameters

Name
T

Parameters

Name	Type
v	T

Returns

v is T & (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11)

Defined in

internal/PitchIntervalClass.ts:7

---

invert

▸ invert(v, index?): PitchIntervalClass

Parameters

Name	Type	Default value
v	PitchIntervalClass	undefined
index	0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11	0

Returns

PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:36

---

mark

▸ mark(_v): _v is PitchIntervalClass

Parameters

Name	Type
_v	0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Returns

_v is PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:21

---

markNum

▸ markNum(v): v is PitchIntervalClass

Parameters

Name	Type
v	number

Returns

v is PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:22

---

markUnknown

▸ markUnknown(v): v is PitchIntervalClass

Parameters

Name	Type
v	unknown

Returns

v is PitchIntervalClass

Defined in

internal/PitchIntervalClass.ts:23