1 /* Planeteer: Give trade route advice for Planets: The Exploration of Space
2 * Copyright (C) 2011 Scott Worley <sworley@chkno.net>
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Affero General Public License as
6 * published by the Free Software Foundation, either version 3 of the
7 * License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Affero General Public License for more details.
14 * You should have received a copy of the GNU Affero General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 import "encoding/json"
24 import "runtime/pprof"
27 var funds = flag.Int("funds", 0,
30 var start = flag.String("start", "",
31 "The planet to start at")
33 var flight_plan_string = flag.String("flight_plan", "",
34 "Your hyper-holes for the day, comma-separated.")
36 var end_string = flag.String("end", "",
37 "A comma-separated list of acceptable ending planets.")
39 var planet_data_file = flag.String("planet_data_file", "planet-data",
40 "The file to read planet data from")
42 var fuel = flag.Int("fuel", 16, "Hyper Jump power left")
44 var hold = flag.Int("hold", 300, "Size of your cargo hold")
46 var start_hold = flag.String("start_hold", "", "Start with a hold full of cargo")
48 var start_edens = flag.Int("start_edens", 0,
49 "How many Eden Warp Units are you starting with?")
51 var end_edens = flag.Int("end_edens", 0,
52 "How many Eden Warp Units would you like to keep (not use)?")
54 var cloak = flag.Bool("cloak", false,
55 "Make sure to end with a Device of Cloaking")
57 var drones = flag.Int("drones", 0, "Buy this many Fighter Drones")
59 var batteries = flag.Int("batteries", 0, "Buy this many Shield Batterys")
61 var drone_price = flag.Int("drone_price", 0, "Today's Fighter Drone price")
63 var battery_price = flag.Int("battery_price", 0, "Today's Shield Battery price")
65 var visit_string = flag.String("visit", "",
66 "A comma-separated list of planets to make sure to visit")
68 var tomorrow_weight = flag.Float64("tomorrow_weight", 1.0,
69 "Weight for the expected value of tomorrow's trading. 0.0 - 1.0")
71 var cpuprofile = flag.String("cpuprofile", "", "write cpu profile to file")
73 var visit_cache []string
75 func visit() []string {
76 if visit_cache == nil {
77 if *visit_string == "" {
80 visit_cache = strings.Split(*visit_string, ",")
85 var flight_plan_cache []string
87 func flight_plan() []string {
88 if flight_plan_cache == nil {
89 if *flight_plan_string == "" {
92 flight_plan_cache = strings.Split(*flight_plan_string, ",")
94 return flight_plan_cache
97 var end_cache map[string]bool
99 func end() map[string]bool {
100 if end_cache == nil {
101 if *end_string == "" {
104 m := make(map[string]bool)
105 for _, p := range strings.Split(*end_string, ",") {
113 type Commodity struct {
122 /* Use relative prices rather than absolute prices because you
123 can get relative prices without traveling to each planet. */
124 RelativePrices map[string]int
126 type planet_data struct {
127 Commodities map[string]Commodity
128 Planets map[string]Planet
129 p2i, c2i map[string]int // Generated; not read from file
130 i2p, i2c []string // Generated; not read from file
133 func ReadData() (data planet_data) {
134 f, err := os.Open(*planet_data_file)
139 err = json.NewDecoder(f).Decode(&data)
146 /* This program operates by filling in a state table representing the best
147 * possible trips you could make; the ones that makes you the most money.
148 * This is feasible because we don't look at all the possible trips.
149 * We define a list of things that are germane to this game and then only
150 * consider the best outcome in each possible game state.
152 * Each cell in the table represents a state in the game. In each cell,
153 * we track two things: 1. the most money you could possibly have while in
154 * that state and 2. one possible way to get into that state with that
157 * A basic analysis can be done with a two-dimensional table: location and
158 * fuel. planeteer-1.0 used this two-dimensional table. This version
159 * adds features mostly by adding dimensions to this table.
161 * Note that the sizes of each dimension are data driven. Many dimensions
162 * collapse to one possible value (ie, disappear) if the corresponding
163 * feature is not enabled.
165 * The order of the dimensions in the list of constants below determines
166 * their layout in RAM. The cargo-based 'dimensions' are not completely
167 * independent -- some combinations are illegal and not used. They are
168 * handled as three dimensions rather than one for simplicity. Placing
169 * these dimensions first causes the unused cells in the table to be
170 * grouped together in large blocks. This keeps them from polluting
171 * cache lines, and if they are large enough, allows the memory manager
172 * to swap out entire pages.
174 * If the table gets too big to fit in RAM:
175 * * Combine the Edens, Cloaks, and UnusedCargo dimensions. Of the
176 * 24 combinations, only 15 are legal: a 38% savings.
177 * * Reduce the size of the Fuel dimension to 3. We only ever look
178 * backwards 2 units, so just rotate the logical values through
179 * the same 3 physical addresses. This is good for an 82% savings.
180 * * Reduce the size of the Edens dimension from 3 to 2, for the
181 * same reasons as Fuel above. 33% savings.
182 * * Buy more ram. (Just sayin'. It's cheaper than you think.)
186 // The official list of dimensions:
188 // Name Num Size Description
189 Edens = iota // 1 3 # of Eden warp units (0 - 2 typically)
190 Cloaks // 2 1-2 # of Devices of Cloaking (0 or 1)
191 UnusedCargo // 3 4 # of unused cargo spaces (0 - 3 typically)
192 Fuel // 4 17 Hyper jump power left (0 - 16)
193 Location // 5 26 Location (which planet)
194 Hold // 6 15 Cargo bay contents (a *Commodity or nil)
195 Traded // 7 2 Traded yet?
196 BuyFighters // 8 1-2 Errand: Buy fighter drones
197 BuyShields // 9 1-2 Errand: Buy shield batteries
198 Visit // 10 1-2**N Visit: Stop by these N planets in the route
203 func bint(b bool) int {
210 func DimensionSizes(data planet_data) []int {
211 eden_capacity := data.Commodities["Eden Warp Units"].Limit
212 if *start_edens > eden_capacity {
213 eden_capacity = *start_edens
215 cloak_capacity := bint(*cloak)
216 dims := make([]int, NumDimensions)
217 dims[Edens] = eden_capacity + 1
218 dims[Cloaks] = cloak_capacity + 1
219 dims[UnusedCargo] = eden_capacity + cloak_capacity + 1
220 dims[Fuel] = *fuel + 1
221 dims[Location] = len(data.Planets)
222 dims[Hold] = len(data.Commodities) + 1
224 dims[BuyFighters] = bint(*drones > 0) + 1
225 dims[BuyShields] = bint(*batteries > 0) + 1
226 dims[Visit] = 1 << uint(len(visit()))
228 // Remind myself to add a line above when adding new dimensions
229 for i, dim := range dims {
237 func StateTableSize(dims []int) int {
239 for _, size := range dims {
250 FROM_ROOT = -2147483647 + iota
253 VALUE_BEING_EVALUATED
257 func EncodeIndex(dims, addr []int) int32 {
259 if addr[0] > dims[0] {
262 for i := 1; i < NumDimensions; i++ {
263 if addr[i] < 0 || addr[i] >= dims[i] {
266 index = index*dims[i] + addr[i]
271 func DecodeIndex(dims []int, index int32) []int {
272 addr := make([]int, NumDimensions)
273 for i := NumDimensions - 1; i > 0; i-- {
274 addr[i] = int(index) % dims[i]
275 index /= int32(dims[i])
281 func CreateStateTable(data planet_data, dims []int) []State {
282 table := make([]State, StateTableSize(dims))
283 for i := range table {
284 table[i].value = VALUE_UNINITIALIZED
285 table[i].from = FROM_UNINITIALIZED
288 addr := make([]int, NumDimensions)
290 addr[Edens] = *start_edens
291 addr[Location] = data.p2i[*start]
292 if *start_hold != "" {
293 addr[Hold] = data.c2i[*start_hold]
295 start_index := EncodeIndex(dims, addr)
296 table[start_index].value = int32(*funds)
297 table[start_index].from = FROM_ROOT
302 /* CellValue fills in the one cell at address addr by looking at all
303 * the possible ways to reach this cell and selecting the best one. */
305 func Consider(data planet_data, dims []int, table []State, there []int, value_difference int, best_value *int32, best_source []int) {
306 there_value := CellValue(data, dims, table, there)
307 if value_difference < 0 && int32(-value_difference) > there_value {
308 /* Can't afford this transition */
311 possible_value := there_value + int32(value_difference)
312 if possible_value > *best_value {
313 *best_value = possible_value
314 copy(best_source, there)
318 var cell_filled_count int
320 func CellValue(data planet_data, dims []int, table []State, addr []int) int32 {
321 my_index := EncodeIndex(dims, addr)
322 if table[my_index].value == VALUE_BEING_EVALUATED {
323 panic("Circular dependency")
325 if table[my_index].value != VALUE_UNINITIALIZED {
326 return table[my_index].value
328 table[my_index].value = VALUE_BEING_EVALUATED
330 best_value := int32(VALUE_RUBISH)
331 best_source := make([]int, NumDimensions)
332 other := make([]int, NumDimensions)
334 planet := data.i2p[addr[Location]]
337 if addr[Traded] == 0 { /* Can't have traded immediately after traveling. */
338 other[Traded] = 1 /* Travel from states that have done trading. */
340 /* Travel here via a 2-fuel unit jump */
341 if addr[Fuel]+2 < dims[Fuel] {
342 other[Fuel] = addr[Fuel] + 2
343 hole_index := (dims[Fuel] - 1) - (addr[Fuel] + 2)
344 if hole_index >= len(flight_plan()) || addr[Location] != data.p2i[flight_plan()[hole_index]] {
345 for other[Location] = 0; other[Location] < dims[Location]; other[Location]++ {
346 if data.Planets[data.i2p[addr[Location]]].BeaconOn {
347 Consider(data, dims, table, other, 0, &best_value, best_source)
351 other[Location] = addr[Location]
352 other[Fuel] = addr[Fuel]
355 /* Travel here via a 1-fuel unit jump (a hyper hole) */
356 if addr[Fuel]+1 < dims[Fuel] {
357 hole_index := (dims[Fuel] - 1) - (addr[Fuel] + 1)
358 if hole_index < len(flight_plan()) && addr[Location] == data.p2i[flight_plan()[hole_index]] {
359 other[Fuel] = addr[Fuel] + 1
360 for other[Location] = 0; other[Location] < dims[Location]; other[Location]++ {
361 Consider(data, dims, table, other, 0, &best_value, best_source)
363 other[Location] = addr[Location]
364 other[Fuel] = addr[Fuel]
368 /* Travel here via Eden Warp Unit */
369 if addr[Edens]+1 < dims[Edens] && addr[UnusedCargo] > 0 {
370 _, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Eden Warp Units"]
372 other[Edens] = addr[Edens] + 1
373 if other[Hold] != 0 {
374 other[UnusedCargo] = addr[UnusedCargo] - 1
376 for other[Location] = 0; other[Location] < dims[Location]; other[Location]++ {
377 Consider(data, dims, table, other, 0, &best_value, best_source)
379 other[Location] = addr[Location]
380 other[UnusedCargo] = addr[UnusedCargo]
381 other[Edens] = addr[Edens]
384 other[Traded] = addr[Traded]
388 if addr[Traded] == 1 {
391 /* Consider not trading */
392 Consider(data, dims, table, other, 0, &best_value, best_source)
394 if !data.Planets[data.i2p[addr[Location]]].Private {
397 if addr[Hold] == 0 && addr[UnusedCargo] == 0 {
398 for other[Hold] = 0; other[Hold] < dims[Hold]; other[Hold]++ {
399 commodity := data.i2c[other[Hold]]
400 if !data.Commodities[commodity].CanSell {
403 relative_price, available := data.Planets[planet].RelativePrices[commodity]
408 base_price := data.Commodities[commodity].BasePrice
409 absolute_price := float64(base_price) * float64(relative_price) / 100.0
410 sell_price := int(absolute_price * 0.9)
412 for other[UnusedCargo] = 0; other[UnusedCargo] < dims[UnusedCargo]; other[UnusedCargo]++ {
413 quantity := *hold - (other[UnusedCargo] + other[Cloaks] + other[Edens])
414 sale_value := quantity * sell_price
415 Consider(data, dims, table, other, sale_value, &best_value, best_source)
418 other[UnusedCargo] = addr[UnusedCargo]
419 other[Hold] = addr[Hold]
423 other[Traded] = addr[Traded] /* Buy after selling */
425 commodity := data.i2c[addr[Hold]]
426 if data.Commodities[commodity].CanSell {
427 relative_price, available := data.Planets[planet].RelativePrices[commodity]
429 base_price := data.Commodities[commodity].BasePrice
430 absolute_price := int(float64(base_price) * float64(relative_price) / 100.0)
431 quantity := *hold - (addr[UnusedCargo] + addr[Cloaks] + addr[Edens])
432 total_price := quantity * absolute_price
434 other[UnusedCargo] = 0
435 Consider(data, dims, table, other, -total_price, &best_value, best_source)
436 other[UnusedCargo] = addr[UnusedCargo]
437 other[Hold] = addr[Hold]
442 other[Traded] = addr[Traded]
445 /* Buy a Device of Cloaking */
446 if addr[Cloaks] == 1 && addr[UnusedCargo] < dims[UnusedCargo]-1 {
447 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Device Of Cloakings"]
449 absolute_price := int(float64(data.Commodities["Device Of Cloakings"].BasePrice) * float64(relative_price) / 100.0)
451 if other[Hold] != 0 {
452 other[UnusedCargo] = addr[UnusedCargo] + 1
454 Consider(data, dims, table, other, -absolute_price, &best_value, best_source)
455 other[UnusedCargo] = addr[UnusedCargo]
456 other[Cloaks] = addr[Cloaks]
460 /* Buy Fighter Drones */
461 if addr[BuyFighters] == 1 {
462 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Fighter Drones"]
464 absolute_price := int(float64(data.Commodities["Fighter Drones"].BasePrice) * float64(relative_price) / 100.0)
465 other[BuyFighters] = 0
466 Consider(data, dims, table, other, -absolute_price**drones, &best_value, best_source)
467 other[BuyFighters] = addr[BuyFighters]
471 /* Buy Shield Batteries */
472 if addr[BuyShields] == 1 {
473 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Shield Batterys"]
475 absolute_price := int(float64(data.Commodities["Shield Batterys"].BasePrice) * float64(relative_price) / 100.0)
476 other[BuyShields] = 0
477 Consider(data, dims, table, other, -absolute_price**batteries, &best_value, best_source)
478 other[BuyShields] = addr[BuyShields]
482 /* Visit this planet */
484 for i = 0; i < uint(len(visit())); i++ {
485 if addr[Visit]&(1<<i) != 0 && visit()[i] == data.i2p[addr[Location]] {
486 other[Visit] = addr[Visit] & ^(1 << i)
487 Consider(data, dims, table, other, 0, &best_value, best_source)
490 other[Visit] = addr[Visit]
492 /* Buy Eden warp units */
493 eden_limit := data.Commodities["Eden Warp Units"].Limit
494 if addr[Edens] > 0 && addr[Edens] <= eden_limit {
495 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Eden Warp Units"]
497 absolute_price := int(float64(data.Commodities["Eden Warp Units"].BasePrice) * float64(relative_price) / 100.0)
498 for quantity := addr[Edens]; quantity > 0; quantity-- {
499 other[Edens] = addr[Edens] - quantity
501 other[UnusedCargo] = addr[UnusedCargo] + quantity
503 if other[UnusedCargo] < dims[UnusedCargo] {
504 Consider(data, dims, table, other, -absolute_price*quantity, &best_value, best_source)
507 other[Edens] = addr[Edens]
508 other[UnusedCargo] = addr[UnusedCargo]
512 // Check that we didn't lose track of any temporary modifications to other.
513 for i := 0; i < NumDimensions; i++ {
514 if addr[i] != other[i] {
519 // Sanity check: This cell was in state BEING_EVALUATED
520 // the whole time that it was being evaluated.
521 if table[my_index].value != VALUE_BEING_EVALUATED {
525 // Record our findings
526 table[my_index].value = best_value
527 table[my_index].from = EncodeIndex(dims, best_source)
531 if cell_filled_count&0xfff == 0 {
532 print(fmt.Sprintf("\r%3.1f%%", 100*float64(cell_filled_count)/float64(StateTableSize(dims))))
535 return table[my_index].value
538 func FindBestState(data planet_data, dims []int, table []State) int32 {
539 addr := make([]int, NumDimensions)
540 addr[Edens] = *end_edens
541 addr[Cloaks] = dims[Cloaks] - 1
542 addr[BuyFighters] = dims[BuyFighters] - 1
543 addr[BuyShields] = dims[BuyShields] - 1
544 addr[Visit] = dims[Visit] - 1
547 addr[UnusedCargo] = 0
548 max_index := int32(-1)
554 for addr[Fuel] = 0; addr[Fuel] <= max_fuel; addr[Fuel]++ {
555 for addr[Location] = 0; addr[Location] < dims[Location]; addr[Location]++ {
556 planet := data.i2p[addr[Location]]
557 if len(end()) == 0 || end()[planet] {
558 index := EncodeIndex(dims, addr)
559 today_value := CellValue(data, dims, table, addr)
560 tomorrow_value := *tomorrow_weight * float64(*hold+data.Planets[planet].TomorrowValue)
561 value := float64(today_value) + tomorrow_value
562 if value > max_value {
572 func Commas(n int32) (s string) {
576 s = fmt.Sprintf(",%03d", r) + s
580 s = fmt.Sprint(r) + s
584 func DescribePath(data planet_data, dims []int, table []State, start int32) (description []string) {
585 for index := start; table[index].from > FROM_ROOT; index = table[index].from {
586 if table[index].from == FROM_UNINITIALIZED {
590 addr := DecodeIndex(dims, index)
591 prev := DecodeIndex(dims, table[index].from)
592 if addr[Fuel] != prev[Fuel] {
593 from := data.i2p[prev[Location]]
594 to := data.i2p[addr[Location]]
595 line += fmt.Sprintf("Jump from %v to %v (%v hyper jump units)", from, to, prev[Fuel]-addr[Fuel])
597 if addr[Edens] == prev[Edens]-1 {
598 from := data.i2p[prev[Location]]
599 to := data.i2p[addr[Location]]
600 line += fmt.Sprintf("Eden warp from %v to %v", from, to)
602 if addr[Hold] != prev[Hold] {
604 quantity := *hold - (prev[UnusedCargo] + prev[Edens] + prev[Cloaks])
605 line += fmt.Sprintf("Sell %v %v", quantity, data.i2c[prev[Hold]])
606 } else if prev[Hold] == 0 {
607 quantity := *hold - (addr[UnusedCargo] + addr[Edens] + addr[Cloaks])
608 line += fmt.Sprintf("Buy %v %v", quantity, data.i2c[addr[Hold]])
610 panic("Switched cargo?")
614 if addr[Cloaks] == 1 && prev[Cloaks] == 0 {
615 // TODO: Dump cloaks, convert from cargo?
616 line += "Buy a Cloak"
618 if addr[Edens] > prev[Edens] {
619 line += fmt.Sprint("Buy ", addr[Edens]-prev[Edens], " Eden Warp Units")
621 if addr[BuyShields] == 1 && prev[BuyShields] == 0 {
622 line += fmt.Sprint("Buy ", *batteries, " Shield Batterys")
624 if addr[BuyFighters] == 1 && prev[BuyFighters] == 0 {
625 line += fmt.Sprint("Buy ", *drones, " Fighter Drones")
627 if addr[Visit] != prev[Visit] {
628 // TODO: verify that the bit chat changed is addr[Location]
629 line += fmt.Sprint("Visit ", data.i2p[addr[Location]])
631 if line == "" && addr[Hold] == prev[Hold] && addr[Traded] != prev[Traded] {
632 // The Traded dimension is for housekeeping. It doesn't directly
633 // correspond to in-game actions, so don't report transitions.
637 line = fmt.Sprint(prev, " -> ", addr)
639 description = append(description, fmt.Sprintf("%13v ", Commas(table[index].value))+line)
644 // (Example of a use case for generics in Go)
645 func IndexPlanets(m *map[string]Planet, start_at int) (map[string]int, []string) {
646 e2i := make(map[string]int, len(*m)+start_at)
647 i2e := make([]string, len(*m)+start_at)
656 func IndexCommodities(m *map[string]Commodity, start_at int) (map[string]int, []string) {
657 e2i := make(map[string]int, len(*m)+start_at)
658 i2e := make([]string, len(*m)+start_at)
670 if *start == "" || *funds == 0 {
671 print("--start and --funds are required. --help for more\n")
674 if *cpuprofile != "" {
675 f, err := os.Create(*cpuprofile)
679 pprof.StartCPUProfile(f)
680 defer pprof.StopCPUProfile()
683 if *drone_price > 0 {
684 temp := data.Commodities["Fighter Drones"]
685 temp.BasePrice = *drone_price
686 data.Commodities["Fighter Drones"] = temp
688 if *battery_price > 0 {
689 temp := data.Commodities["Shield Batterys"]
690 temp.BasePrice = *battery_price
691 data.Commodities["Shield Batterys"] = temp
693 data.p2i, data.i2p = IndexPlanets(&data.Planets, 0)
694 data.c2i, data.i2c = IndexCommodities(&data.Commodities, 1)
695 dims := DimensionSizes(data)
696 table := CreateStateTable(data, dims)
697 best := FindBestState(data, dims, table)
700 print("Cannot acheive success criteria\n")
702 description := DescribePath(data, dims, table, best)
703 for i := len(description) - 1; i >= 0; i-- {
704 fmt.Println(description[i])