Struct PitchClassSetAnalysisResult

Namespace

Celeritas.Core.Analysis

Assembly

Celeritas.dll

Result of pitch-class set analysis: normal order, prime form, and interval vector (Forte set theory).

public readonly record struct PitchClassSetAnalysisResult : IEquatable<PitchClassSetAnalysisResult>

Implements

IEquatable<PitchClassSetAnalysisResult>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PitchClassSetAnalysisResult(ushort, int, int[], int[], int[], int[])

Result of pitch-class set analysis: normal order, prime form, and interval vector (Forte set theory).

public PitchClassSetAnalysisResult(ushort Mask, int Cardinality, int[] PitchClasses, int[] NormalOrder, int[] PrimeForm, int[] IntervalVector)

Parameters

Mask ushort

12-bit pitch-class membership mask (bit pc set = that pitch class is present).

Cardinality int

Number of distinct pitch classes in the set.

PitchClasses int[]

Distinct pitch classes (0-11), ascending.

NormalOrder int[]

The set's normal order.

PrimeForm int[]

Prime form, transposed to begin on 0.

IntervalVector int[]

Interval-class vector <ic1..ic6>.

Properties

Cardinality

Number of distinct pitch classes in the set.

public int Cardinality { get; init; }

Property Value

int

IntervalVector

Interval-class vector <ic1..ic6>.

public int[] IntervalVector { get; init; }

Property Value

int[]

IntervalVectorText

Interval vector formatted as <a,b,c,d,e,f>.

public string IntervalVectorText { get; }

Property Value

string

Mask

12-bit pitch-class membership mask (bit pc set = that pitch class is present).

public ushort Mask { get; init; }

Property Value

ushort

NormalOrder

The set's normal order.

public int[] NormalOrder { get; init; }

Property Value

int[]

NormalOrderText

Normal order formatted as {a,b,c}.

public string NormalOrderText { get; }

Property Value

string

PitchClasses

Distinct pitch classes (0-11), ascending.

public int[] PitchClasses { get; init; }

Property Value

int[]

PitchClassesText

Pitch classes formatted as {a,b,c}.

public string PitchClassesText { get; }

Property Value

string

PrimeForm

Prime form, transposed to begin on 0.

public int[] PrimeForm { get; init; }

Property Value

int[]

PrimeFormText

Prime form formatted as {a,b,c}.

public string PrimeFormText { get; }

Property Value

string