update Readme and Doc: Local search can be used in parallel

Cargo.toml

@@ -1,20 +1,21 @@
 [package]
 name = "rapid_solve"
-version = "0.1.4"
+version = "0.1.5"
 edition = "2021"
 license = "MIT"
 description = "This library provides a metaheuristic framework for solving combinatorial optimization problems."
-keywords = ["metaheuristic", "local_search", "simulated_annealing", "threshold_accepting", "tabu_search"]
+keywords = [
+  "metaheuristic",
+  "local_search",
+  "simulated_annealing",
+  "threshold_accepting",
+  "tabu_search",
+]
 categories = ["algorithms", "science"]
 repository = "https://github.com/LeonSering/rapid_solve"
 readme = "README.md"
 authors = ["Leon Sering"]
-include = [
-    "**/*.rs",
-    "Cargo.toml",
-    "README.md",
-    "resources/**",
-]
+include = ["**/*.rs", "Cargo.toml", "README.md", "resources/**"]
 
 [[bin]]
 name = "rapid_solve_tsp_example"
@@ -25,6 +26,8 @@ path = "src/examples/tsp/main.rs"
 [dependencies]
 rayon = "1.5.1" # for parallel iterator
 itertools = "0.12.0"
-serde_json = { version = "1.0", features = ["preserve_order"]} # for reading json-files
+serde_json = { version = "1.0", features = [
+  "preserve_order",
+] } # for reading json-files
 rand = "0.8.4" # for random number generation
 rapid_time = "0.1.2" # for durations and datetime

README.md

@@ -10,9 +10,9 @@ problems.
 The following metaheuristics are included:
 
 - [local search](https://docs.rs/rapid_solve/latest/rapid_solve/heuristics/local_search/index.html) (with several neighborhood
-  exploration strategies)
+  exploration strategies, supports recursion for multiple modifications in one step)
 - [parallel local search](https://docs.rs/rapid_solve/latest/rapid_solve/heuristics/parallel_local_search/index.html)
-  (the neighborhood is explored in parallel using [`rayon`](https://docs.rs/rayon/))
+  (the neighborhood is explored in parallel using [`rayon`](https://docs.rs/rayon/), supports recursion)
 - [threshold accepting](https://docs.rs/rapid_solve/latest/rapid_solve/heuristics/threshold_accepting/index.html)
 - [simulated annealing](https://docs.rs/rapid_solve/latest/rapid_solve/heuristics/simulated_annealing/index.html)
 - [tabu search](https://docs.rs/rapid_solve/latest/rapid_solve/heuristics/tabu_search/index.html) (and a faster [parallel

src/lib.rs

@@ -6,13 +6,13 @@
 //! ### Metaheuristics
 //! The following [metaheuristics][heuristics] are included:
 //! - [local search][heuristics::local_search] (with recursion and several neighborhood
-//! exploration strategies)
+//!   exploration strategies, supports recursion for multiple modifactions in one step)
 //! - [parallel local search][heuristics::parallel_local_search] (the neighborhood is explored in
-//! parallel using [`rayon`](https://docs.rs/rayon/))
+//!   parallel using [`rayon`](https://docs.rs/rayon/), supports recursion)
 //! - [threshold accepting][heuristics::threshold_accepting]
 //! - [simulated annealing][heuristics::simulated_annealing]
 //! - [tabu search][heuristics::tabu_search] (and a faster [parallel
-//! version][heuristics::parallel_tabu_search])
+//!   version][heuristics::parallel_tabu_search])
 //!
 //! ### Hierarchical Objective
 //! The framework supports [hierarchical objective][objective], i.e., objectives