Bump version to 1.21.0

Changed

* use hierarchical approach for local objective estimation
* avoid unsafe code project-wise:
  * apply `#![forbid(unsafe_code)]` directive fori
    rosomaxa/vrp-core/vrp-pragmatic/vrp-scientific
  * apply `#![deny(unsafe_code)]` directive for vrp-cli
    (due to FFI which is only one exception)
  * allow unsafe code only when necessary in research crates which are
    not used anyhow in production code
* make pyo3 an optional dependency and wrap python bindings under
  `py_bindings` feature
* refactor `Deref` trait usage
* implement `Debug` for essential core types
* refactor job index to lower memory footprint for a large scale VRP
  (tested on 30k CVRP instance)
* use proper objective for tsplib format problems (CVRP)
* error handling types
* fix sort stability issue in elitism's improvement detection method
* switch rosomaxa learning rate to cosine annealing
* rename `shiftTime` limit to `maxDuration`

Added

* experimental `compact-tour` objective which tries to shape routes based
  on job neighbourhood.
* heuristic filtering extension
* simple tabu list implementation used by some ruin methods
* gene pool in rosomaxa to reintroduce some genes while search progresses

Author: reinterpretcat

CHANGELOG.md

@@ -5,8 +5,11 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+
+## [v1.21.0]- 2023-04-27
+
 This release brings hierarchical approach for local objective estimation. Additionally, it focuses on refactoring,
-mostly to avoid usafe code.
+mostly to avoid usafe code. In memory of..
 
 ### Changed
 
@@ -627,7 +630,8 @@ with Self Organizing MAps and eXtrAs (pronounced as "rosomaha", from russian "р
 
 - Initial commit
 
-[Unreleased]: https://github.com/reinterpretcat/vrp/compare/v1.20.0...HEAD
+[Unreleased]: https://github.com/reinterpretcat/vrp/compare/v1.21.0...HEAD
+[v1.21.0]: https://github.com/reinterpretcat/vrp/compare/v1.20.0...v1.21.0
 [v1.20.0]: https://github.com/reinterpretcat/vrp/compare/v1.19.2...v1.20.0
 [v1.19.2]: https://github.com/reinterpretcat/vrp/compare/v1.19.1...v1.90.2
 [v1.19.1]: https://github.com/reinterpretcat/vrp/compare/v1.19.0...v1.90.1

CITATION.cff

@@ -5,7 +5,7 @@ authors:
   given-names: "Ilya"
   orcid: "https://orcid.org/0000-0002-7613-7412"
 title: "Rosomaxa, Vehicle Routing Problem Solver"
-version: 1.20.0
+version: 1.21.0
 doi: 10.5281/zenodo.4624037
 date-released: 2022-05-13
 url: "https://github.com/reinterpretcat/vrp"

README.md

@@ -3,7 +3,7 @@
 ![build](https://github.com/reinterpretcat/vrp/actions/workflows/build.yaml/badge.svg)
 [![downloads](https://img.shields.io/crates/d/vrp-core)](https://crates.io/crates/vrp-core)
 [![codecov](https://codecov.io/gh/reinterpretcat/vrp/branch/master/graph/badge.svg)](https://codecov.io/gh/reinterpretcat/vrp)
-[![dependency status](https://deps.rs/crate/vrp-cli/1.20.0/status.svg)](https://deps.rs/crate/vrp-cli/1.20.0)
+[![dependency status](https://deps.rs/crate/vrp-cli/1.21.0/status.svg)](https://deps.rs/crate/vrp-cli/1.21.0)
 [![DOI](https://zenodo.org/badge/238436117.svg)](https://zenodo.org/badge/latestdoi/238436117)
 
 ![VRP example](docs/resources/vrp-example.png "VRP with Route Balance")
@@ -68,7 +68,7 @@ Another fast way to try vrp solver on your environment is to use `docker` image
 * **run public image** from `Github Container Registry`:
 
 ```bash
-    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.20.0
+    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.21.0
 ```
 
 * **build image locally** using `Dockerfile` provided:

docs/src/getting-started/installation.md

@@ -26,7 +26,7 @@ Another fast way to try vrp solver on your environment is to use `docker` image
 * **run public image** from `Github Container Registry`:
 
 ```bash
-    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.20.0
+    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.21.0
 ```
 
 * **build image locally** using `Dockerfile` provided:

examples/json-pragmatic/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "json-pragmatic"
-version = "1.20.0"
+version = "1.21.0"
 authors = ["Ilya Builuk <ilya.builuk@gmail.com>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]

rosomaxa/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rosomaxa"
-version = "0.4.0"
+version = "0.5.0"
 edition = "2021"
 authors = ["Ilya Builuk <ilya.builuk@gmail.com>"]
 license = "Apache-2.0"

vrp-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-cli"
-version = "1.20.0"
+version = "1.21.0"
 authors = ["Ilya Builuk <ilya.builuk@gmail.com>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -23,9 +23,9 @@ name = "vrp_cli"
 crate-type = ["cdylib", "lib"]
 
 [dependencies]
-vrp-core = { path = "../vrp-core", version = "1.20.0" }
-vrp-scientific = { path = "../vrp-scientific", optional = true, version = "1.20.0" }
-vrp-pragmatic = { path = "../vrp-pragmatic", version = "1.20.0" }
+vrp-core = { path = "../vrp-core", version = "1.21.0" }
+vrp-scientific = { path = "../vrp-scientific", optional = true, version = "1.21.0" }
+vrp-pragmatic = { path = "../vrp-pragmatic", version = "1.21.0" }
 
 csv = { version = "1.2.1", optional = true }
 serde_json = "1.0.96"

vrp-cli/src/main.rs

@@ -29,7 +29,7 @@ mod cli {
 
     pub fn get_app() -> Command {
         Command::new("Vehicle Routing Problem Solver")
-            .version("1.20.0")
+            .version("1.21.0")
             .author("Ilya Builuk <ilya.builuk@gmail.com>")
             .about("A command line interface to Vehicle Routing Problem solver")
             .subcommand(get_analyze_app())

vrp-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-core"
-version = "1.20.0"
+version = "1.21.0"
 authors = ["Ilya Builuk <ilya.builuk@gmail.com>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -12,7 +12,7 @@ edition = "2021"
 description = "A core algorithms to solve a Vehicle Routing Problem"
 
 [dependencies]
-rosomaxa = { path = "../rosomaxa", version = "0.4.0" }
+rosomaxa = { path = "../rosomaxa", version = "0.5.0" }
 
 rayon = "1.7.0"
 rand = { version = "0.8.5", features = ["small_rng"] }

vrp-pragmatic/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-pragmatic"
-version = "1.20.0"
+version = "1.21.0"
 authors = ["Ilya Builuk <ilya.builuk@gmail.com>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -12,7 +12,7 @@ edition = "2021"
 description = "An extension logic for solving rich VRP"
 
 [dependencies]
-vrp-core = { path = "../vrp-core", version = "1.20.0" }
+vrp-core = { path = "../vrp-core", version = "1.21.0" }
 
 serde = { version = "1.0.160", features = ["derive"] }
 serde_json = "1.0.96"

vrp-scientific/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-scientific"
-version = "1.20.0"
+version = "1.21.0"
 authors = ["Ilya Builuk <ilya.builuk@gmail.com>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -12,4 +12,4 @@ edition = "2021"
 description = "An extension logic for solving scientific VRP"
 
 [dependencies]
-vrp-core = { path = "../vrp-core", version = "1.20.0" }
+vrp-core = { path = "../vrp-core", version = "1.21.0" }