From 75fa77572874fd04b9e494402ecb51989eccb064 Mon Sep 17 00:00:00 2001 From: inthar-raven Date: Mon, 19 Aug 2024 16:16:18 -0400 Subject: [PATCH] Update terms in documentation --- src/guide.rs | 6 +++--- src/lib.rs | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/guide.rs b/src/guide.rs index bc326df..f7a0beb 100644 --- a/src/guide.rs +++ b/src/guide.rs @@ -22,7 +22,7 @@ where .collect::>() } /* - A well-formed generator sequence (Guided GS) is a generator sequence made of stacked `k`-steps, + A guided generator sequence (Guided GS) is a generator sequence made of stacked `k`-steps, where `k` is fixed and `gcd(k, scale.len()) == 1`. The interval left over after stacking (which is a `k`-step) is different from all the others, and where the generators in the generator sequence are distinct from any non-k-step interval. @@ -96,9 +96,9 @@ fn k_step_guided_gs_list_for_subscale( #[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)] pub struct GuideFrame { /// Either Guided GS or multiple interleaved GSes that are Guided GSes when considered individually. - /// `gs` generates a well-formed generator sequence (detempered single-period MOS) subscale. + /// `gs` generates a guided generator sequence (detempered single-period MOS) subscale. pub gs: Vec>, - /// `polyoffset` is the set of intervals that each well-formed generator sequence chain is based on. Always includes `CountVector::ZERO`. + /// `polyoffset` is the set of intervals that each guided generator sequence chain is based on. Always includes `CountVector::ZERO`. pub polyoffset: Vec>, /// The base GS chains in a multiple GS structure don't form interleaved scales. Instead they form a detempered copy of m-edo. pub multiplicity: usize, diff --git a/src/lib.rs b/src/lib.rs index 22eb587..d029836 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -73,12 +73,12 @@ fn det3(v0: &[u8], v1: &[u8], v2: &[u8]) -> i16 { #[derive(Clone, Debug, Serialize)] pub struct GuideResult { /// Either Guided GS or multiple interleaved Guided GSes - /// `guided_gs` generates a well-formed generator sequence (detempered single-period MOS) subscale. + /// `guided_gs` generates a guided generator sequence (detempered single-period MOS) subscale. /// The `JsValue` is an array of 3 numbers where each entry is the count of the corresp. step size. pub gs: Vec>, /// The aggregate generator pub aggregate: Vec, - /// `polyoffset` is the set of intervals that each well-formed generator sequence chain is based on. Always includes the unison. + /// `polyoffset` is the set of intervals that each guided generator sequence chain is based on. Always includes the unison. /// The `JsValue` is an array of 3 numbers where each entry is the count of the corresp. step size. pub polyoffset: Vec>, /// complexity result