Skip to content

Commit

Permalink
Update terms in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
inthar-raven committed Aug 19, 2024
1 parent 7a7d228 commit 75fa775
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/guide.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ where
.collect::<Vec<_>>()
}
/*
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.
Expand Down Expand Up @@ -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<CountVector<usize>>,
/// `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<CountVector<usize>>,
/// 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,
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<Vec<u8>>,
/// The aggregate generator
pub aggregate: Vec<u8>,
/// `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<Vec<u8>>,
/// complexity result
Expand Down

0 comments on commit 75fa775

Please sign in to comment.