From 9d5998933340ecdc962e0f4be2170cd22f06d533 Mon Sep 17 00:00:00 2001 From: Ashish Kumar Date: Sat, 18 Dec 2021 01:35:38 +0530 Subject: [PATCH] Update documentation and CHANGELOG --- CHANGELOG.md | 6 ++++++ docs/API.md | 3 ++- docs/example_2_sol.json | 4 ++++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b88f8d47c..d60cb4152 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## [Unreleased] +### Added + +- `description` key to unallocated tasks in the output, if provided (#403) +- `location_index` key to to unassigned tasks and each step, if provided (#625) +- Shared target to makefile, for creating Position Independent Code (#617) + ## [v1.11.0] - 2021-11-19 ### Added diff --git a/docs/API.md b/docs/API.md index bd9305eea..7410971c9 100644 --- a/docs/API.md +++ b/docs/API.md @@ -301,7 +301,7 @@ The computed solution is written as `json` on standard output or a file | `code` | status code | | `error` | error message (present iff `code` is different from `0`) | | [`summary`](#summary) | object summarizing solution indicators | -| `unassigned` | array of objects describing unassigned tasks with their `id`, `type` and `location` (if provided) | +| `unassigned` | array of objects describing unassigned tasks with their `id`, `type`, and if provided, `description`, `location` and `location_index` | | [`routes`](#routes) | array of `route` objects | ## Code @@ -376,6 +376,7 @@ A `step` object has the following properties: | `violations` | array of `violation` objects for this step | | [`description`] | step description, if provided in input | | [`location`] | coordinates array for this step (if provided in input) | +| [`location_index`] | index of relevant row and column in custom matrices for this step (if provided in input) | | [`id`] | id of the task performed at this step, only provided if `type` value is `job`, `pickup`, `delivery` or `break` | | ~~[`job`]~~ | ~~id of the job performed at this step, only provided if `type` value is `job`~~ | | [`load`] | vehicle load after step completion (with capacity constraints) | diff --git a/docs/example_2_sol.json b/docs/example_2_sol.json index fb8e2d84a..0d5604e3c 100644 --- a/docs/example_2_sol.json +++ b/docs/example_2_sol.json @@ -24,6 +24,7 @@ "steps": [ { "type": "start", + "location_index": 0, "setup": 0, "service": 0, "waiting_time": 0, @@ -34,6 +35,7 @@ { "type": "job", "id": 1414, + "location_index": 1, "setup": 0, "service": 0, "waiting_time": 0, @@ -45,6 +47,7 @@ { "type": "job", "id": 1515, + "location_index": 2, "setup": 0, "service": 0, "waiting_time": 0, @@ -55,6 +58,7 @@ }, { "type": "end", + "location_index": 3, "setup": 0, "service": 0, "waiting_time": 0,