Merge dev into dev-solver

.github/workflows/push_branch.yml

@@ -29,7 +29,7 @@ jobs:
       with:
         toolchain: stable
     - name: Test
-      run: cargo test --verbose
+      run: TEST_SETTING=0 cargo test --verbose
 
   # Push formatting commit even if compilation/testing fails. This does not
   # push a commit if no formatting is required.

.github/workflows/push_main.yml

@@ -33,7 +33,7 @@ jobs:
       with:
         toolchain: stable
     - name: Test
-      run: cargo test --verbose
+      run: TEST_SETTING=0 cargo test --verbose
 
   check_format:
     runs-on: ubuntu-latest

.gitignore

@@ -16,3 +16,6 @@ flamegraph.svg
 
 # MacOS desktop attributes file
 .DS_Store
+
+# Development data
+/dev

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "doc"]
+	path = doc
+	url = [email protected]:GamesCrafters/GamesmanNova.wiki.git

Cargo.toml

@@ -8,7 +8,7 @@ repository = "https://github.com/GamesCrafters/GamesmanNova"
 keywords = ["game", "solver", "strong-solver", "research"]
 edition = "2021"
 readme = "README.md"
-exclude = ["/.github", "/data"]
+exclude = ["/.github", "/dev"]
 
 [[bin]]
 path = "src/main.rs"
@@ -25,9 +25,13 @@ lto = "fat"
 clap = { version = "^4", features = ["derive"] }
 serde_json = "^1"
 exitcode = "^1"
-petgraph = "^0"
 nalgebra = "^0"
 colored = "^2"
 anyhow = "^1"
 bitvec = "^1"
 regex = "^1"
+
+[dev-dependencies]
+strum_macros = "0.26"
+petgraph = "^0"
+strum = "0.26"

src/database/error.rs

@@ -6,7 +6,6 @@
 //! under which all database implementations' errors can be grouped into).
 //!
 //! #### Authorship
-//!
 //! - Max Fierro, 2/24/2024 ([email protected])
 
 use std::{error::Error, fmt};
@@ -106,6 +105,7 @@ impl fmt::Display for DatabaseError {
                 table,
             } => {
                 let rule = match data {
+                    Datatype::BOOL => "of exactly 1 bit",
                     Datatype::DPFP => "of exactly 64 bits",
                     Datatype::SPFP => "of exactly 32 bits",
                     Datatype::SINT => "greater than 1 bit",

src/database/mod.rs

@@ -4,7 +4,6 @@
 //! solution set data, hopefully in an efficient and scalable way.
 //!
 //! #### Authorship
-//!
 //! - Max Fierro, 4/14/2023 ([email protected])
 
 use anyhow::Result;
@@ -14,6 +13,10 @@ use std::path::Path;
 
 use crate::{model::State, solver::RecordType};
 
+/* RE-EXPORTS */
+
+pub use util::SchemaBuilder;
+
 /* UTILITY MODULES */
 
 #[cfg(test)]
@@ -45,15 +48,6 @@ pub struct Schema {
     size: usize,
 }
 
-/// Builder pattern intermediary for constructing a schema declaratively out of
-/// provided attributes. This is here to help ensure schemas are not changed
-/// accidentally after being instantiated.
-pub struct SchemaBuilder {
-    attributes: Vec<Attribute>,
-    record: Option<RecordType>,
-    size: usize,
-}
-
 /// Represents a triad of a name string, a size in bits corresponding to an
 /// "attribute" or "feature" associated with a database record, and the type
 /// of the data it represents.
@@ -67,6 +61,7 @@ pub struct Attribute {
 /// Specifies the type of data being stored within a record within a specific
 /// contiguous subset of bits. This is used for interpretation. Here is the
 /// meaning of each variant, with its possible sizes in bits:
+/// - `BOOL`: Boolean of size exactly 1.
 /// - `ENUM`: Enumeration of arbitrary size.
 /// - `UINT`: Unsigned integer of arbitrary size.
 /// - `SINT`: Signed integer of size greater than 1.
@@ -75,6 +70,7 @@ pub struct Attribute {
 /// - `CSTR`: C-style string (ASCII character array) of a size divisible by 8.
 #[derive(Debug, Copy, Clone)]
 pub enum Datatype {
+    BOOL,
     ENUM,
     UINT,
     SINT,
@@ -87,10 +83,10 @@ pub enum Datatype {
 
 /// Represents the behavior of a Key-Value Store. No assumptions are made about
 /// the size of the records being used, but keys are taken to be fixed-length.
-pub trait KVStore<R: Record> {
-    fn put(&mut self, key: State, record: &R);
+pub trait KVStore {
+    fn put<R: Record>(&mut self, key: State, record: &R);
     fn get(&self, key: State) -> Option<&BitSlice<u8, Msb0>>;
-    fn del(&self, key: State);
+    fn del(&mut self, key: State);
 }
 
 /// Allows a database to be evicted to persistent media. Implementing this trait

src/database/test.rs

@@ -1,9 +1,8 @@
-//! # Database Test Module
+//! # Database Test Utilities Module
 //!
 //! This module provides integration tests for the database module.
 //!
 //! #### Authorship
-//!
 //! - Benjamin Riley Zimmerman, 3/8/2024 ([email protected])
 
 // #[test]