move traits into a 'core' crate (#19)

danieleades · web-flow · commit 75b83aa2dce7 · 2022-03-23T12:19:02.000Z
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,17 +1,25 @@
 [package]
 name = "arithmetic-coding"
-description = "fast and felxible arithmetic coding library"
-version = "0.1.0"
+description = "fast and flexible arithmetic coding library"
+version = "0.1.1"
 edition = "2021"
 license = "MIT"
 keywords = ["compression", "encoding", "arithmetic-coding", "lossless"]
 categories = ["compression", "encoding", "parsing"]
 repository = "https://github.com/danieleades/arithmetic-coding"
 
+[workspace]
+members = [
+    ".",
+    "arithmetic-coding-core",
+    "fenwick-model",
+]
+
 [dependencies]
+arithmetic-coding-core = { path = "./arithmetic-coding-core", version = "0.1.0" }
 bitstream-io = "1.2.0"
 thiserror = "1.0.30"
 
 [dev-dependencies]
-fenwick = { version = "1.0.0" }
 test-case = "2.0.0"
+fenwick-model = { path = "./fenwick-model" }
diff --git a/arithmetic-coding-core/Cargo.toml b/arithmetic-coding-core/Cargo.toml
@@ -0,0 +1,15 @@
+[package]
+name = "arithmetic-coding-core"
+description = "core traits for the 'arithmetic-coding' crate"
+version = "0.1.0"
+edition = "2021"
+license = "MIT"
+keywords = ["compression", "encoding", "arithmetic-coding", "lossless"]
+categories = ["compression", "encoding", "parsing"]
+repository = "https://github.com/danieleades/arithmetic-coding"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+thiserror = "1.0.30"
+
diff --git a/arithmetic-coding-core/README.md b/arithmetic-coding-core/README.md
@@ -0,0 +1,3 @@
+# Arithmetic Coding Core
+
+core traits for the `arithmetic-coding` crate
diff --git a/arithmetic-coding-core/src/bitstore.rs b/arithmetic-coding-core/src/bitstore.rs
diff --git a/arithmetic-coding-core/src/fixed_length.rs b/arithmetic-coding-core/src/fixed_length.rs
diff --git a/arithmetic-coding-core/src/lib.rs b/arithmetic-coding-core/src/lib.rs
@@ -0,0 +1,19 @@
+//! Core traits for the [`arithmetic-coding`](https://github.com/danieleades/arithmetic-coding) crate
+
+#![deny(
+    missing_docs,
+    clippy::all,
+    missing_debug_implementations,
+    clippy::cargo
+)]
+#![warn(clippy::pedantic)]
+#![feature(int_log)]
+#![feature(associated_type_defaults)]
+
+mod bitstore;
+pub use bitstore::BitStore;
+
+mod model;
+pub use model::Model;
+
+pub mod fixed_length;
diff --git a/arithmetic-coding-core/src/model.rs b/arithmetic-coding-core/src/model.rs
diff --git a/examples/fenwick_adaptive.rs b/examples/fenwick_adaptive.rs
@@ -3,9 +3,8 @@ use std::{fs::File, io::Read, ops::Range};
 use arithmetic_coding::Model;
 
 mod common;
-mod fenwick;
 
-use self::fenwick::simple::{FenwickModel, ValueError};
+use fenwick_model::simple::{FenwickModel, ValueError};
 
 const ALPHABET: &str =
     "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 .,\n-':()[]#*;\"!?*&é/àâè%@$";
diff --git a/examples/fenwick_context_switching.rs b/examples/fenwick_context_switching.rs
@@ -3,9 +3,8 @@ use std::{fs::File, io::Read, ops::Range};
 use arithmetic_coding::Model;
 
 mod common;
-mod fenwick;
 
-use self::fenwick::context_switching::{FenwickModel, ValueError};
+use fenwick_model::context_switching::{FenwickModel, ValueError};
 
 const ALPHABET: &str =
     "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 .,\n-':()[]#*;\"!?*&é/àâè%@$";
diff --git a/fenwick-model/Cargo.toml b/fenwick-model/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "fenwick-model"
+version = "0.1.0"
+edition = "2021"
+description = "fenwick-tree-based test utils for the 'arithmetic-coding' crate"
+license = "MIT"
+keywords = ["compression", "encoding", "arithmetic-coding", "lossless", "fenwick-tree"]
+categories = ["compression", "encoding", "parsing"]
+repository = "https://github.com/danieleades/arithmetic-coding"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+arithmetic-coding-core = { path = "../arithmetic-coding-core" }
+fenwick = "1.0.0"
+thiserror = "1.0.30"
diff --git a/fenwick-model/README.md b/fenwick-model/README.md
@@ -0,0 +1,3 @@
+# Fenwick Model
+
+a 'fenwick tree'-based implementation of an `arithmetic_coding::Model`, for testing purposes
diff --git a/fenwick-model/src/context_switching.rs b/fenwick-model/src/context_switching.rs
@@ -1,7 +1,7 @@
 #![allow(missing_docs, unused)]
 //! Fenwick tree based context-switching model
 
-use arithmetic_coding::Model;
+use arithmetic_coding_core::Model;
 
 use super::Weights;
 
diff --git a/fenwick-model/src/lib.rs b/fenwick-model/src/lib.rs
diff --git a/fenwick-model/src/simple.rs b/fenwick-model/src/simple.rs
@@ -1,7 +1,7 @@
 #![allow(missing_docs, unused)]
 //! simple adaptive model using a fenwick tree
 
-use arithmetic_coding::Model;
+use arithmetic_coding_core::Model;
 
 use super::Weights;
 
diff --git a/src/lib.rs b/src/lib.rs
@@ -7,22 +7,14 @@
     clippy::cargo
 )]
 #![warn(clippy::pedantic)]
-#![feature(int_log)]
-#![feature(associated_type_defaults)]
 
-mod model;
-pub use model::Model;
+pub use arithmetic_coding_core::{fixed_length, BitStore, Model};
 
+mod decoder;
 mod encoder;
-pub use encoder::Encoder;
 
-mod decoder;
 pub use decoder::Decoder;
-
-mod bitstore;
-pub use bitstore::BitStore;
-
-pub mod fixed_length;
+pub use encoder::Encoder;
 
 /// Errors that can occur during encoding/decoding
 #[derive(Debug, thiserror::Error)]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Arithmetic Coding Core`
	`2`	`+`
	`3`	+core traits for the `arithmetic-coding` crate