Struct VoiceLeadingPolicy 

pub struct VoiceLeadingPolicy {
    pub entrance_cost: i64,
    pub departure_cost: i64,
    pub doubling_cost: Option<i64>,
    pub voice_crossing: VoiceCrossingPolicy,
    pub metric: VoiceLeadingMetric,
}

Explicit costs and structural policy for exact voice leading.

Fields

entrance_cost: i64

Cost of a target voice entering without a source.

departure_cost: i64

Cost of a source voice leaving without a target.

doubling_cost: Option<i64>

Incremental cost for a source supplying an additional target.

voice_crossing: VoiceCrossingPolicy

Whether the pitch-sorted voices may cross.

metric: VoiceLeadingMetric

Motion norm.

Implementations

impl VoiceLeadingPolicy

pub fn new(entrance_cost: i64, departure_cost: i64) -> Self

Builds a squared-distance policy with no doubling and crossings allowed.

pub fn with_doubling(self, cost: i64) -> Self

Enables source doubling at the supplied incremental cost.

pub fn with_voice_crossing(self, policy: VoiceCrossingPolicy) -> Self

Sets the voice-crossing policy.

pub fn with_metric(self, metric: VoiceLeadingMetric) -> Self

Sets the motion norm.

Trait Implementations

impl Clone for VoiceLeadingPolicy

fn clone(&self) -> VoiceLeadingPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VoiceLeadingPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for VoiceLeadingPolicy

impl PartialEq for VoiceLeadingPolicy

fn eq(&self, other: &VoiceLeadingPolicy) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for VoiceLeadingPolicy