Merge pull request #53 from FL03/v0.1.5

V0.1.5
FL03 · Jul 16, 2023 · 9a7b4ea · 9a7b4ea
2 parents 188ede1 + 398429e
commit 9a7b4ea
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 19 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,7 @@ keywords = []
 license = "Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/FL03/contained"
-version = "0.1.4"
+version = "0.1.5"
 
 [workspace.dependencies]
 # Custom crates

diff --git a/contained/Cargo.toml b/contained/Cargo.toml
@@ -33,10 +33,10 @@ test = true
 [build-dependencies]
 
 [dependencies]
-contained-core = { features = [], optional = true, path = "../core", version = "0.1.4" }
-contained-music = { features = [], optional = true, path = "../music", version = "0.1.4" }
-contained-net = { features = [], optional = true, path = "../net", version = "0.1.4" }
-contained-turing = { features = [], optional = true, path = "../turing", version = "0.1.4" }
+contained-core = { features = [], optional = true, path = "../core", version = "0.1.5" }
+contained-music = { features = [], optional = true, path = "../music", version = "0.1.5" }
+contained-net = { features = [], optional = true, path = "../net", version = "0.1.5" }
+contained-turing = { features = [], optional = true, path = "../turing", version = "0.1.5" }
 
 # Standard dependencies
 algae.workspace = true

diff --git a/music/Cargo.toml b/music/Cargo.toml
@@ -39,7 +39,7 @@ tracing.workspace = true
 
 [dependencies.contained-core]
 path = "../core"
-version = "0.1.4"
+version = "0.1.5"
 
 [dev-dependencies]
 tokio = { features = ["macros", "rt"], version = "1"}

diff --git a/music/src/neo/triads/mod.rs b/music/src/neo/triads/mod.rs
@@ -1,23 +1,25 @@
 /*
     Appellation: triads <module>
     Contrib: FL03 <jo3mccain@icloud.com>
-    Description:
-        def. A triad is a set of three notes, called chord factors: root, third, and fifth
-        Generaically, triad's share two of its notes with three of its inversions.
-
-        For our purposes, a triad is said to be a three-tuple (a, b, c) where the intervals [a, b] and [b, c] are both thirds.
 */
-
+//! Triad
+//! 
+//! def. A triad is a set of three notes, called chord factors
+//! 
+//! # Capabilities
+//! 
+//! Justification for considering triads to be viable topological computing environment is found with the [Wolfram (2, 3) UTM](https://www.wolframscience.com/prizes/tm23).
+//! Generally, a universal turing machine is capable of emulating any other turing machine. The (2, 3) UTM is a turing machine that can emulate any other turing machine using only two states and three symbols.
+//! Considering a triad to be a three-tuple (a, b, c) where the intervals [a, b] and [b, c] are both thirds, we can see that the triad is a (2, 3) UTM where each side or "state" is consistently allowed to be either
+//! invalid or valid.
+//! 
 pub use self::{class::*, misc::*, triad::*};
 
 mod class;
 mod misc;
 mod triad;
 
-pub trait Update {
-    fn update(&mut self);
-}
-
+/// [FromTriad] is a simple trait that allows for the explicit conversion of a [Triad] into any type that implements [From<Triad>].
 pub trait FromTriad {
     fn from_triad(triad: Triad) -> Self;
 }
@@ -31,6 +33,7 @@ where
     }
 }
 
+/// [IntoTriad] is a simple trait that allows for the explicit conversion of any type that implements [Into<Triad>] into a [Triad].
 pub trait IntoTriad {
     fn into_triad(self) -> Triad;
 }
@@ -44,6 +47,7 @@ where
     }
 }
 
+/// [TryIntoTriad] is a trait for explicitly attempting to convert any type into a [Triad].
 pub trait TryIntoTriad {
     type Error;
 

diff --git a/music/src/neo/triads/triad.rs b/music/src/neo/triads/triad.rs
@@ -1,8 +1,10 @@
 /*
     Appellation: triad <module>
     Contrib: FL03 <jo3mccain@icloud.com>
-    Description: A triad is a certain type of chord built with thirds. Traditionally, this means that the triad is composed of three notes called chord factors.
 */
+//! Triad
+//! 
+//! 
 use super::{ChordFactor, Triads};
 use crate::intervals::{Fifths, Interval, Thirds};
 use crate::neo::{Dirac, PathFinder, Transform, LPR};

diff --git a/net/Cargo.toml b/net/Cargo.toml
@@ -37,7 +37,7 @@ tracing-subscriber.workspace = true
 
 [dependencies.contained-core]
 path = "../core"
-version = "0.1.4"
+version = "0.1.5"
 
 [dependencies.libp2p]
 features = [

diff --git a/turing/Cargo.toml b/turing/Cargo.toml
@@ -35,7 +35,7 @@ strum.workspace = true
 
 [dependencies.contained-core]
 path = "../core"
-version = "0.1.4"
+version = "0.1.5"
 
 [dev-dependencies]