elkai-rs 0.1.0

elkai-rs - a Rust library for solving TSP problems
Documentation

Installation

[dependencies]

elkai-rs = { git = "https://github.com/HellOwhatAs/elkai-rs", tag = "v0.0.1" }

Example usage

use std::collections::HashMap;
use elkai_rs::Coordinates2D;

fn main() {
    let cities = Coordinates2D::new(HashMap::from_iter([
        ("city1", (0, 0)),
        ("city2", (0, 4)),
        ("city3", (5, 0)),
    ]));
    println!("{:?}", cities.solve(10));
}
use elkai_rs::DistanceMatrix;

fn main() {
    let cities = DistanceMatrix::new(vec![
        vec![0, 4, 0],
        vec![0, 0, 5],
        vec![0, 0, 0]
    ]);
    println!("{:?}", cities.solve(10));
}

License

The LKH native code by Helsgaun is released for non-commercial use only. Therefore the same restriction applies to elkai-rs, which is explained in the LICENSE file.

How it works internally

  • We refactored LKH such that it doesn't have global state and you don't need to restart the program in order to run another input problem
  • We added a hook in ReadProblem that allows reading problems from memory instead of files
  • We read the solution from the Tour variable and put it in a PyObject (Python list).
  • ✓ Valgrind passed on d3d8c12.

⚠️ elkai-rs takes a global mutex (just like what elkai did) during the solving phase which means two threads cannot solve problems at the same time. If you want to run other workloads at the same time, you have to run another process.