WIP: Commit progress on rosomaxa crate

Author: reinterpretcat

vrp-core/src/lib.rs

@@ -81,9 +81,9 @@
 //! let problem = create_example_problem();
 //! let environment = Arc::new(Environment::default());
 //! // build solver to run 10 secs or 1000 generation
-//! let solver = EvolutionConfigBuilder::new(problem, environment)
+//! let solver = SolverBuilder::new(problem, environment)
 //!     .with_max_time(Some(10))
-//!     .with_max_generations(Some(1000))
+//!     .with_max_generations(Some(10))
 //!     .build()?;
 //! // run solver and get the best known solution within its cost.
 //! let (solution, cost, _) = solver.solve()?;

vrp-core/src/prelude.rs

@@ -1,6 +1,9 @@
 //! This module reimports a common used types.
 
 // Reimport core types
+pub use crate::solver::Solver;
+pub use crate::solver::SolverBuilder;
+
 pub use crate::models::Problem;
 pub use crate::models::Solution;
 

vrp-core/src/solver/builder.rs

@@ -18,9 +18,7 @@ use crate::solver::search::Recreate;
 /// ```
 /// # use vrp_core::models::examples::create_example_problem;
 /// # use std::sync::Arc;
-/// use vrp_core::solver::Builder;
-/// use vrp_core::models::Problem;
-/// use vrp_core::utils::Environment;
+/// use vrp_core::prelude::*;
 ///
 /// // create your VRP problem
 /// let problem: Arc<Problem> = create_example_problem();

vrp-core/src/solver/mod.rs

@@ -216,32 +216,6 @@ pub struct Solver {
 impl Solver {
     /// Solves a Vehicle Routing Problem and returns a _(solution, its cost)_ pair in case of success
     /// or error description, if solution cannot be found.
-    ///
-    /// # Examples
-    ///
-    /// The most simple way to run solver is to use [`Builder`](./struct.Builder.html)
-    /// which has preconfigured settings:
-    ///
-    /// ```
-    /// # use vrp_core::models::examples::create_example_problem;
-    /// # use std::sync::Arc;
-    /// use rosomaxa::prelude::Environment;
-    /// use vrp_core::solver::EvolutionConfigBuilder;
-    /// use vrp_core::models::Problem;
-    ///
-    /// // create your VRP problem
-    /// let problem: Arc<Problem> = create_example_problem();
-    /// let environment = Arc::new(Environment::default());
-    /// // build solver using builder with default settings
-    /// let solver = EvolutionConfigBuilder::new(problem, environment).build()?;
-    /// // run solver and get the best known solution within its cost.
-    /// let (solution, cost, _) = solver.solve()?;
-    ///
-    /// assert_eq!(cost, 42.);
-    /// assert_eq!(solution.routes.len(), 1);
-    /// assert_eq!(solution.unassigned.len(), 0);
-    /// # Ok::<(), String>(())
-    /// ```
     pub fn solve(self) -> Result<(Solution, Cost, Option<TelemetryMetrics>), String> {
         let config = self.config;
         let environment = config.environment.clone();