@libraz/libcantus - v1.3.0
    Preparing search index...

    Type Alias CompositionPlanOptions

    Options for deriveCompositionPlan.

    type CompositionPlanOptions = {
        key?: KeyLike;
        register?: { low: number; high: number };
        preserve?: PreserveWeights;
        ctx?: GenerationContextInput;
        budget?: number;
    }
    Index
    key?: KeyLike

    The home key of the plan. Every reference key moves by the interval from the reference's home tonic to this one, keeping its own variant. Defaults to the reference's home key; a key of another variant is rejected.

    register?: { low: number; high: number }

    The melody range the plan's phrase registers are mapped onto. Defaults to the reference's melody range, moved by the nearest shift to the new key.

    preserve?: PreserveWeights

    How much of each dimension of the reference to keep; see PreserveWeights.

    The seed and algorithm version the plan records. A caller-supplied rng is rejected: a plan has to carry its source as a seed to be reproducible.

    budget?: number

    Upper bound on the motif selection.