Class VoiceLeadingSolution

Namespace

Celeritas.Core.VoiceLeading

Assembly

Celeritas.dll

Result of voice leading solver.

public sealed class VoiceLeadingSolution

Inheritance

object

VoiceLeadingSolution

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsValid

True when a finite-cost solution with at least one voicing was found.

public bool IsValid { get; }

Property Value

bool

TotalCost

Total voice leading cost of the solution path.

public float TotalCost { get; }

Property Value

float

Voicings

The chosen voicing for each chord, in progression order.

public IReadOnlyList<Voicing> Voicings { get; }

Property Value

IReadOnlyList<Voicing>

Warnings

Voice leading warnings for transitions that still violate rules.

public IReadOnlyList<string> Warnings { get; }

Property Value

IReadOnlyList<string>

Methods

ToNoteBuffer(Rational)

Export to NoteBuffer for playback. A solution with no voicings — one that found no valid path, or was asked for no chords — is an empty buffer, not an error.

public NoteBuffer ToNoteBuffer(Rational chordDuration)

Parameters

chordDuration Rational

Returns

NoteBuffer

ToScore()

Format as readable SATB score.

public string ToScore()

Returns

string