refactor: create workspace & split examples from core implementation (#8

)

* move current lib to inner integraal folder

* add workspace manifest

* move dependencies def to workspace manifest

* convert examples into a proper workspace member

* add missing doc in main crate

* update CI to exclude examples from coverage

.github/workflows/build.yml

@@ -23,8 +23,8 @@ jobs:
           submodules: recursive
       - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
-      - name: Build crates
-        run: cargo build --all
+      - name: Build main crate
+        run: cargo build -p integraal --all-features
   build_examples:
     name: Build examples for ${{ matrix.os }}
     strategy:

.github/workflows/coverage.yml

@@ -30,12 +30,12 @@ jobs:
       - uses: Swatinem/rust-cache@v2
       # generate raw coverage data
       - name: Build code
-        run: cargo build --all-features
+        run: cargo build --all-features --workspace --exclude integraal-examples
         env:
           RUSTFLAGS: "-Cinstrument-coverage"
           LLVM_PROFILE_FILE: "cargo-test-%p-%m.profraw"
       - name: Run tests
-        run: cargo test --all-features
+        run: cargo test --all-features --workspace --exclude integraal-examples
         env:
           RUSTFLAGS: "-Cinstrument-coverage"
           LLVM_PROFILE_FILE: "cargo-test-%p-%m.profraw"

.github/workflows/publish.yml

@@ -24,6 +24,6 @@ jobs:
 
       # Publish
       - name: Publish core
-        run: cargo publish --token ${CIO_TOKEN}
+        run: cargo publish --package integraal --token ${CIO_TOKEN}
         env:
           CIO_TOKEN: ${{ secrets.CRATESIO_TOKEN }}

.github/workflows/tests.yml

@@ -40,4 +40,4 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
       - name: Run Tests
-        run: cargo test --all
+        run: cargo test --all --all-features

Cargo.toml

@@ -1,5 +1,12 @@
-[package]
-name = "integraal"
+[workspace]
+
+resolver = "2"
+members = [
+    "integraal",
+    "examples"
+]
+
+[workspace.package]
 version = "0.0.1"
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -11,47 +18,11 @@ categories = ["algorithms", "concurrency", "mathematics", "science"]
 keywords = ["algorithms", "analysis", "integration", "numerical-analysis", "numerical-method"]
 authors = ["Isaie Muron <[email protected]>"]
 
+[workspace.dependencies]
+# members
+integraal = { version = "0.0.1", path = "./integraal" }
+integraal-examples = { version = "0.0.1", path = "./examples" }
 
-# FEATURES
-
-[features]
-montecarlo = ["dep:rand"]
-
-# DEPS
-
-[dependencies]
-rand = { version = "0.9.0-alpha.1", features = ["small_rng"], optional = true }
-
-[build-dependencies]
+# external
+rand = "0.9.0-alpha.1"
 rustversion = "1.0.15"
-
-[dev-dependencies]
-rand = { version = "0.9.0-alpha.1", features = ["small_rng"] }
-
-# EXAMPLES
-
-[[example]]
-name = "rectangle_hardcoded"
-path = "examples/rectangle/hardcoded.rs"
-
-[[example]]
-name = "rectangle_integraal"
-path = "examples/rectangle/integraal.rs"
-
-[[example]]
-name = "trapezoid_hardcoded"
-path = "examples/trapezoid/hardcoded.rs"
-
-[[example]]
-name = "trapezoid_integraal"
-path = "examples/trapezoid/integraal.rs"
-
-[[example]]
-name = "montecarlo_hardcoded"
-path = "examples/montecarlo/hardcoded.rs"
-required-features = ["montecarlo"] # not necessary, but enabled for consistency
-
-[[example]]
-name = "montecarlo_integraal"
-path = "examples/montecarlo/integraal.rs"
-required-features = ["montecarlo"]

examples/Cargo.toml

@@ -0,0 +1,42 @@
+[package]
+name = "integraal-examples"
+version = "0.0.1"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+homepage = "https://imrn99.github.io/integraal/"
+repository = "https://github.com/imrn99/integraal"
+readme = "../README.md"
+description = "Example of the Integraal crate"
+categories = ["algorithms", "concurrency", "mathematics", "science"]
+keywords = ["algorithms", "analysis", "integration", "numerical-analysis", "numerical-method"]
+authors = ["Isaie Muron <[email protected]>"]
+
+[dependencies]
+integraal = { workspace = true, features = ["montecarlo"] }
+rand = { workspace = true, features = ["small_rng"] }
+
+# EXAMPLES
+
+[[example]]
+name = "rectangle_hardcoded"
+path = "examples/rectangle/hardcoded.rs"
+
+[[example]]
+name = "rectangle_integraal"
+path = "examples/rectangle/integraal.rs"
+
+[[example]]
+name = "trapezoid_hardcoded"
+path = "examples/trapezoid/hardcoded.rs"
+
+[[example]]
+name = "trapezoid_integraal"
+path = "examples/trapezoid/integraal.rs"
+
+[[example]]
+name = "montecarlo_hardcoded"
+path = "examples/montecarlo/hardcoded.rs"
+
+[[example]]
+name = "montecarlo_integraal"
+path = "examples/montecarlo/integraal.rs"

integraal/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "integraal"
+version = "0.0.1"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+homepage = "https://imrn99.github.io/integraal/"
+repository = "https://github.com/imrn99/integraal"
+readme = "../README.md"
+description = "Integral computation, done in Rust! "
+categories = ["algorithms", "concurrency", "mathematics", "science"]
+keywords = ["algorithms", "analysis", "integration", "numerical-analysis", "numerical-method"]
+authors = ["Isaie Muron <[email protected]>"]
+
+
+# FEATURES
+
+[features]
+montecarlo = ["dep:rand"]
+
+# DEPS
+
+[dependencies]
+rand = { workspace = true, features = ["small_rng"], optional = true }
+
+[build-dependencies]
+rustversion.workspace = true
+
+[dev-dependencies]
+rand = { workspace = true, features = ["small_rng"] }

src/parameters.rs → integraal/src/parameters.rs

@@ -43,6 +43,9 @@ pub enum ComputeMethod {
     /// Trapezoid method [reference](https://en.wikipedia.org/wiki/Trapezoidal_rule)
     Trapezoid,
     #[cfg(feature = "montecarlo")]
-    /// MonteCarlo method [reference](https://en.wikipedia.org/wiki/Monte_Carlo_integration)
-    MonteCarlo { n_sample: usize },
+    /// Monte-Carlo method [reference](https://en.wikipedia.org/wiki/Monte_Carlo_integration)
+    MonteCarlo {
+        /// Number of random number sample per step computation.
+        n_sample: usize,
+    },
 }