summaryrefslogtreecommitdiff
path: root/morphology/README.md
diff options
context:
space:
mode:
authorjacksonfu14 <jackson@fashionunited.com>2025-11-09 21:58:46 +0100
committerJackson Moore <jacksonmoore@tuta.io>2025-11-09 21:58:46 +0100
commitcccaa346384c7fed2ebf2524a2a6cca1e1bec577 (patch)
tree2d1d092d24409c5282f2205de88189b1f3d1e7f3 /morphology/README.md
parentda3aa05be9177f10ae311713a99021d76721e426 (diff)
feat: add sequence sorting
Diffstat (limited to 'morphology/README.md')
-rw-r--r--morphology/README.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/morphology/README.md b/morphology/README.md
index b933f4a..7e1865b 100644
--- a/morphology/README.md
+++ b/morphology/README.md
@@ -59,6 +59,32 @@ generate_valid_sets(max_size) -> Vec<ValidSet>
generate_valid_sets_of_size(size) -> Vec<ValidSet>
```
+**Module:** `sequence.rs`
+
+Implements sequence generation and sorting:
+
+- Sequence struct containing ordered values
+- Sequence generation from valid sets
+- Sorting with customizable precedence
+
+**API:**
+```rust
+Sequence::new(values) -> Sequence
+Sequence::length() -> usize
+Sequence::values() -> &[Value]
+Sequence::is_valid(&set) -> bool
+
+generate_sequences(&set, length) -> Vec<Sequence>
+generate_all_sequences(length) -> Vec<Sequence>
+count_sequences(&set, length) -> usize
+
+// Sorting
+PrecedenceOrder::IncreasingNegativeFirst // [0, -1, 1, -2, 2, ...]
+PrecedenceOrder::IncreasingPositiveFirst // [0, 1, -1, 2, -2, ...]
+
+sort_sequences(&mut sequences, outer_order, inner_order)
+```
+
## Building and Testing
### Compile the Library
@@ -131,6 +157,40 @@ let all_sets = generate_valid_sets(5);
// Returns 210 valid sets
```
+### Sequence Generation and Sorting
+
+```rust
+use meta_affine::{ValidSet, Value, Sequence};
+use meta_affine::sequence::generate_sequences;
+use meta_affine::{generate_all_sequences, sort_sequences, PrecedenceOrder};
+use std::collections::HashMap;
+
+// Create a valid set
+let set = ValidSet::new()
+ .add_value_with_dependencies(Value::new(1, 0));
+
+// Generate all valid sequences of length 3 from this set
+let mut sequences = generate_sequences(&set, 3);
+// Returns sequences like [(0,0), (1,0), (0,0)] and [(1,0), (0,0), (1,0)]
+
+// Sort sequences with default precedence (IncreasingPositiveFirst for both)
+sort_sequences(&mut sequences, None, None);
+
+// Sort with custom precedence orders
+sort_sequences(
+ &mut sequences,
+ Some(PrecedenceOrder::IncreasingNegativeFirst), // outer: [0, -1, 1, -2, 2, ...]
+ Some(PrecedenceOrder::IncreasingPositiveFirst), // inner: [0, 1, -1, 2, -2, ...]
+);
+
+// Generate all sequences from all valid sets with sorting options
+let mut options = HashMap::new();
+options.insert("outerPrecedenceOrder".to_string(), PrecedenceOrder::IncreasingNegativeFirst);
+options.insert("innerPrecedenceOrder".to_string(), PrecedenceOrder::IncreasingPositiveFirst);
+let all_sequences = generate_all_sequences(3, options);
+// Returns all valid sequences of length 3, sorted by the specified precedence
+```
+
## Mathematical Background
### Meta-Affine Space