summaryrefslogtreecommitdiff
path: root/morphology/src
diff options
context:
space:
mode:
Diffstat (limited to 'morphology/src')
-rw-r--r--morphology/src/lib.rs5
-rw-r--r--morphology/src/sequence.rs30
-rw-r--r--morphology/src/set.rs18
-rw-r--r--morphology/src/value.rs14
4 files changed, 34 insertions, 33 deletions
diff --git a/morphology/src/lib.rs b/morphology/src/lib.rs
index de33f70..bfc40f1 100644
--- a/morphology/src/lib.rs
+++ b/morphology/src/lib.rs
@@ -1,6 +1,7 @@
-//! Meta-Affine Sequence Generator
+//! Morphology: Meta-Affine Sequence Generator
//!
-//! A library for generating and validating meta-affine sequences.
+//! A library for generating and validating meta-affine sequences and other
+//! mathematically defined structures.
//!
//! A meta-affine space consists of 2-tuple values (outer, inner) derived from (0,0)
//! using five derivation rules. Valid sets are downward-closed subsets, and valid
diff --git a/morphology/src/sequence.rs b/morphology/src/sequence.rs
index 8f15c7c..88c5942 100644
--- a/morphology/src/sequence.rs
+++ b/morphology/src/sequence.rs
@@ -28,7 +28,7 @@ impl Sequence {
/// # Examples
///
/// ```
- /// use meta_affine::{Sequence, Value};
+ /// use morphology::{Sequence, Value};
///
/// let seq = Sequence::new(vec![Value::new(0,0), Value::new(1,0), Value::new(0,0)]);
/// assert_eq!(seq.length(), 3);
@@ -52,7 +52,7 @@ impl Sequence {
/// # Examples
///
/// ```
- /// use meta_affine::{Sequence, ValidSet, Value};
+ /// use morphology::{Sequence, ValidSet, Value};
///
/// let set = ValidSet::origin_set();
/// let seq = Sequence::new(vec![Value::origin()]);
@@ -76,8 +76,8 @@ impl Sequence {
/// # Examples
///
/// ```
-/// use meta_affine::{Sequence, ValidSet, Value};
-/// use meta_affine::sequence::check_coverage;
+/// use morphology::{Sequence, ValidSet, Value};
+/// use morphology::sequence::check_coverage;
///
/// let set = ValidSet::origin_set();
/// let seq = Sequence::new(vec![Value::origin()]);
@@ -100,8 +100,8 @@ pub fn check_coverage(sequence: &Sequence, set: &ValidSet) -> bool {
/// # Examples
///
/// ```
-/// use meta_affine::{Sequence, Value};
-/// use meta_affine::sequence::check_no_consecutive_duplicates;
+/// use morphology::{Sequence, Value};
+/// use morphology::sequence::check_no_consecutive_duplicates;
///
/// let seq1 = Sequence::new(vec![Value::new(0,0), Value::new(1,0), Value::new(0,0)]);
/// assert!(check_no_consecutive_duplicates(&seq1));
@@ -124,8 +124,8 @@ pub fn check_no_consecutive_duplicates(sequence: &Sequence) -> bool {
/// # Examples
///
/// ```
-/// use meta_affine::{Sequence, Value};
-/// use meta_affine::sequence::check_terminal;
+/// use morphology::{Sequence, Value};
+/// use morphology::sequence::check_terminal;
///
/// let seq1 = Sequence::new(vec![Value::new(1,0), Value::origin()]);
/// assert!(check_terminal(&seq1));
@@ -147,8 +147,8 @@ pub fn check_terminal(sequence: &Sequence) -> bool {
/// # Examples
///
/// ```
-/// use meta_affine::{Sequence, Value};
-/// use meta_affine::sequence::check_outer_value_constraint;
+/// use morphology::{Sequence, Value};
+/// use morphology::sequence::check_outer_value_constraint;
///
/// // Last occurrence of outer=1 is (1,0) ✓
/// let seq1 = Sequence::new(vec![Value::new(1,1), Value::new(1,0), Value::new(0,0)]);
@@ -193,8 +193,8 @@ pub fn check_outer_value_constraint(sequence: &Sequence) -> bool {
/// # Examples
///
/// ```
-/// use meta_affine::{ValidSet, Value};
-/// use meta_affine::sequence::generate_sequences;
+/// use morphology::{ValidSet, Value};
+/// use morphology::sequence::generate_sequences;
///
/// let set = ValidSet::origin_set();
/// let sequences = generate_sequences(&set, 1);
@@ -385,7 +385,7 @@ fn is_outer_constraint_satisfiable(current: &[Value]) -> bool {
/// # Examples
///
/// ```
-/// use meta_affine::sequence::{generate_all_sequences, SequenceOptions, PrecedenceOrder};
+/// use morphology::sequence::{generate_all_sequences, SequenceOptions, PrecedenceOrder};
///
/// // Use defaults
/// let sequences = generate_all_sequences(1, None);
@@ -481,7 +481,7 @@ pub enum LengthSorting {
/// # Examples
///
/// ```
-/// use meta_affine::sequence::{SequenceOptions, PrecedenceOrder};
+/// use morphology::sequence::{SequenceOptions, PrecedenceOrder};
///
/// // All defaults
/// let opts = SequenceOptions::new();
@@ -579,7 +579,7 @@ impl SequenceOptions {
/// # Examples
///
/// ```
-/// use meta_affine::{Sequence, Value, sequence::{sort_sequences, SequenceOptions, PrecedenceOrder}};
+/// use morphology::{Sequence, Value, sequence::{sort_sequences, SequenceOptions, PrecedenceOrder}};
///
/// let mut sequences = vec![
/// Sequence::new(vec![Value::new(1, 0), Value::new(0, 0)]),
diff --git a/morphology/src/set.rs b/morphology/src/set.rs
index cb0d015..06e73b3 100644
--- a/morphology/src/set.rs
+++ b/morphology/src/set.rs
@@ -47,7 +47,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::ValidSet;
+ /// use morphology::ValidSet;
/// let set = ValidSet::new();
/// assert_eq!(set.size(), 0);
/// ```
@@ -64,7 +64,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::{ValidSet, Value};
+ /// use morphology::{ValidSet, Value};
/// let set = ValidSet::origin_set();
/// assert_eq!(set.size(), 1);
/// assert!(set.contains(&Value::origin()));
@@ -83,7 +83,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::{ValidSet, Value};
+ /// use morphology::{ValidSet, Value};
/// use std::collections::HashSet;
///
/// let mut values = HashSet::new();
@@ -115,7 +115,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::{ValidSet, Value};
+ /// use morphology::{ValidSet, Value};
///
/// let set = ValidSet::origin_set();
/// let set2 = set.add_value(Value::new(1, 0)).unwrap();
@@ -135,7 +135,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::{ValidSet, Value};
+ /// use morphology::{ValidSet, Value};
///
/// let set = ValidSet::new();
/// let set2 = set.add_value_with_dependencies(Value::new(2, 3));
@@ -159,7 +159,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::{ValidSet, Value};
+ /// use morphology::{ValidSet, Value};
/// use std::collections::HashSet;
///
/// let mut values = HashSet::new();
@@ -192,7 +192,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::{ValidSet, Value};
+ /// use morphology::{ValidSet, Value};
///
/// let set = ValidSet::origin_set();
/// assert!(set.contains(&Value::origin()));
@@ -207,7 +207,7 @@ impl ValidSet {
/// # Examples
///
/// ```
- /// use meta_affine::ValidSet;
+ /// use morphology::ValidSet;
///
/// let set = ValidSet::origin_set();
/// assert_eq!(set.size(), 1);
@@ -255,7 +255,7 @@ impl Default for ValidSet {
/// # Examples
///
/// ```
-/// use meta_affine::set::generate_valid_sets;
+/// use morphology::set::generate_valid_sets;
///
/// let sets = generate_valid_sets(3);
/// // Will include sets like {(0,0)}, {(0,0), (1,0)}, {(0,0), (0,1)}, etc.
diff --git a/morphology/src/value.rs b/morphology/src/value.rs
index 51e9e40..e3348fb 100644
--- a/morphology/src/value.rs
+++ b/morphology/src/value.rs
@@ -29,7 +29,7 @@ impl Value {
/// # Examples
///
/// ```
- /// use meta_affine::Value;
+ /// use morphology::Value;
/// let v = Value::new(2, 3);
/// assert_eq!(v.outer, 2);
/// assert_eq!(v.inner, 3);
@@ -43,7 +43,7 @@ impl Value {
/// # Examples
///
/// ```
- /// use meta_affine::Value;
+ /// use morphology::Value;
/// let origin = Value::origin();
/// assert_eq!(origin, Value::new(0, 0));
/// ```
@@ -56,7 +56,7 @@ impl Value {
/// # Examples
///
/// ```
- /// use meta_affine::Value;
+ /// use morphology::Value;
/// assert!(Value::new(0, 0).is_origin());
/// assert!(!Value::new(1, 0).is_origin());
/// ```
@@ -79,7 +79,7 @@ impl Value {
/// # Examples
///
/// ```
- /// use meta_affine::Value;
+ /// use morphology::Value;
/// assert_eq!(Value::new(0, 0).pretty_print(), "0");
/// assert_eq!(Value::new(0, 1).pretty_print(), "1");
/// assert_eq!(Value::new(1, 0).pretty_print(), "(0)");
@@ -113,7 +113,7 @@ impl fmt::Display for Value {
/// # Examples
///
/// ```
- /// use meta_affine::Value;
+ /// use morphology::Value;
/// let v = Value::new(2, -3);
/// assert_eq!(format!("{}", v), "(2,-3)");
/// ```
@@ -132,7 +132,7 @@ impl fmt::Display for Value {
/// # Examples
///
/// ```
-/// use meta_affine::{Value, get_minimum_derivation_path};
+/// use morphology::{Value, get_minimum_derivation_path};
/// let path = get_minimum_derivation_path(Value::new(2, 3));
/// assert_eq!(path.len(), 6);
/// assert_eq!(path[0], Value::new(0, 0));
@@ -198,7 +198,7 @@ fn generate_inner_path(m: i32, n: i32) -> Vec<Value> {
/// # Examples
///
/// ```
-/// use meta_affine::{Value, path_length};
+/// use morphology::{Value, path_length};
/// assert_eq!(path_length(Value::new(2, 3)), 6);
/// assert_eq!(path_length(Value::new(-2, -3)), 6);
/// ```