Skip to content

Commit

Permalink
docs([README]): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HarukiMoriarty committed Jun 24, 2024
1 parent 97dc47d commit d38b37d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,31 @@ Last, build the project.
cmake -B build && make -C build
```

## Command

```
-ac / --agent-capacity | Capacity of agents. Defaults to 100.
-ct / --cache-type | Type of cache to use: NONE, LRU, FIFO, RANDOM. Defaults to NONE.
-dl / --debug-log | Enable debug logging. Implicitly true when set.
-ddl / --delay-deadline-limit | Delay deadline limit for task assignment. Defaults to 1.
-ggs / --goals-gen-strategy | Strategy for goals generation: MK, Zhang, Real. (Required)
-gmk / --goals-max-k | Maximum 'k' different goals in 'm' segments of all goals. Defaults to 0.
-gmm / --goals-max-m | Maximum 'k' different goals in 'm' segments of all goals. Defaults to 100.
-lan / --look-ahead-num | Number for look-ahead logic. Defaults to 1.
-mf / --map-file | Path to the map file. (Required)
-na / --num-agents | Number of agents to use. (Required)
-ng / --num-goals | Number of goals to achieve. (Required)
-ocf / --output-csv-file | Path to the throughput output file. Defaults to './result/result.csv'.
-osrf / --output-step-file | Path to the step result output file. Defaults to './result/step_result.txt'.
-otf / --output-throughput-file | Path to the throughput output file. Defaults to './result/throughput.csv'.
-op / --optimize | Enable optimization. Enable checking empty space for cache insert while moving.
-rdfp / --real-dist-file-path | Path to the real distribution data file. Defaults to './data/order_data.csv'.
-rs / --random-seed | Seed for random number generation. Defaults to 0.
-slf / --short-log-format | Enable short log format. Implicitly true when set.
-tls / --time-limit-sec | Time limit in seconds. Defaults to 10.
-vof / --visual-output-file | Path to the visual output file. Defaults to './result/vis.yaml'.
```

## Assumption

1. Assume cargo in the warehouse is infinite
2 changes: 1 addition & 1 deletion calmapf/src/parser.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Parser::Parser(int argc, char* argv[]) {
short_log_format = program.get<bool>("short-log-format");
debug_log = program.get<bool>("debug-log");

optimization = program.get<bool>("debug-log");
optimization = program.get<bool>("optimize");

// Post parse
_post_parse();
Expand Down

0 comments on commit d38b37d

Please sign in to comment.