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/>.
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_edens = flag.Int("start_edens", 0,
47 "How many Eden Warp Units are you starting with?")
49 var end_edens = flag.Int("end_edens", 0,
50 "How many Eden Warp Units would you like to keep (not use)?")
52 var cloak = flag.Bool("cloak", false,
53 "Make sure to end with a Device of Cloaking")
55 var drones = flag.Int("drones", 0, "Buy this many Fighter Drones")
57 var batteries = flag.Int("batteries", 0, "Buy this many Shield Batterys")
59 var drone_price = flag.Int("drone_price", 0, "Today's Fighter Drone price")
61 var battery_price = flag.Int("battery_price", 0, "Today's Shield Battery price")
63 var visit_string = flag.String("visit", "",
64 "A comma-separated list of planets to make sure to visit")
66 var cpuprofile = flag.String("cpuprofile", "", "write cpu profile to file")
69 var visit_cache []string
70 func visit() []string {
71 if visit_cache == nil {
72 if *visit_string == "" {
75 visit_cache = strings.Split(*visit_string, ",")
80 var flight_plan_cache []string
81 func flight_plan() []string {
82 if flight_plan_cache == nil {
83 if *flight_plan_string == "" {
86 flight_plan_cache = strings.Split(*flight_plan_string, ",")
88 return flight_plan_cache
91 var end_cache map[string]bool
92 func end() map[string]bool {
94 if *end_string == "" {
97 m := make(map[string]bool)
98 for _, p := range strings.Split(*end_string, ",") {
106 type Commodity struct {
114 /* Use relative prices rather than absolute prices because you
115 can get relative prices without traveling to each planet. */
116 RelativePrices map[string]int
118 type planet_data struct {
119 Commodities map[string]Commodity
120 Planets map[string]Planet
121 p2i, c2i map[string]int // Generated; not read from file
122 i2p, i2c []string // Generated; not read from file
125 func ReadData() (data planet_data) {
126 f, err := os.Open(*planet_data_file)
131 err = json.NewDecoder(f).Decode(&data)
138 /* This program operates by filling in a state table representing the best
139 * possible trips you could make; the ones that makes you the most money.
140 * This is feasible because we don't look at all the possible trips.
141 * We define a list of things that are germane to this game and then only
142 * consider the best outcome in each possible game state.
144 * Each cell in the table represents a state in the game. In each cell,
145 * we track two things: 1. the most money you could possibly have while in
146 * that state and 2. one possible way to get into that state with that
149 * A basic analysis can be done with a two-dimensional table: location and
150 * fuel. planeteer-1.0 used this two-dimensional table. This version
151 * adds features mostly by adding dimensions to this table.
153 * Note that the sizes of each dimension are data driven. Many dimensions
154 * collapse to one possible value (ie, disappear) if the corresponding
155 * feature is not enabled.
157 * The order of the dimensions in the list of constants below determines
158 * their layout in RAM. The cargo-based 'dimensions' are not completely
159 * independent -- some combinations are illegal and not used. They are
160 * handled as three dimensions rather than one for simplicity. Placing
161 * these dimensions first causes the unused cells in the table to be
162 * grouped together in large blocks. This keeps them from polluting
163 * cache lines, and if they are large enough, allows the memory manager
164 * to swap out entire pages.
166 * If the table gets too big to fit in RAM:
167 * * Combine the Edens, Cloaks, and UnusedCargo dimensions. Of the
168 * 24 combinations, only 15 are legal: a 38% savings.
169 * * Reduce the size of the Fuel dimension to 3. We only ever look
170 * backwards 2 units, so just rotate the logical values through
171 * the same 3 physical addresses. This is good for an 82% savings.
172 * * Reduce the size of the Edens dimension from 3 to 2, for the
173 * same reasons as Fuel above. 33% savings.
174 * * Buy more ram. (Just sayin'. It's cheaper than you think.)
178 // The official list of dimensions:
180 // Name Num Size Description
181 Edens = iota // 1 3 # of Eden warp units (0 - 2 typically)
182 Cloaks // 2 1-2 # of Devices of Cloaking (0 or 1)
183 UnusedCargo // 3 4 # of unused cargo spaces (0 - 3 typically)
184 Fuel // 4 17 Hyper jump power left (0 - 16)
185 Location // 5 26 Location (which planet)
186 Hold // 6 15 Cargo bay contents (a *Commodity or nil)
187 Traded // 7 2 Traded yet?
188 BuyFighters // 8 1-2 Errand: Buy fighter drones
189 BuyShields // 9 1-2 Errand: Buy shield batteries
190 Visit // 10 1-2**N Visit: Stop by these N planets in the route
195 func bint(b bool) int {
202 func DimensionSizes(data planet_data) []int {
203 eden_capacity := data.Commodities["Eden Warp Units"].Limit
204 if *start_edens > eden_capacity {
205 eden_capacity = *start_edens
207 cloak_capacity := bint(*cloak)
208 dims := make([]int, NumDimensions)
209 dims[Edens] = eden_capacity + 1
210 dims[Cloaks] = cloak_capacity + 1
211 dims[UnusedCargo] = eden_capacity + cloak_capacity + 1
212 dims[Fuel] = *fuel + 1
213 dims[Location] = len(data.Planets)
214 dims[Hold] = len(data.Commodities) + 1
216 dims[BuyFighters] = bint(*drones > 0) + 1
217 dims[BuyShields] = bint(*batteries > 0) + 1
218 dims[Visit] = 1 << uint(len(visit()))
220 // Remind myself to add a line above when adding new dimensions
221 for i, dim := range dims {
229 func StateTableSize(dims []int) int {
231 for _, size := range dims {
241 const CELL_UNINITIALIZED = -2147483647
242 const CELL_BEING_EVALUATED = -2147483646
243 const CELL_RUBISH = -2147483645
245 func EncodeIndex(dims, addr []int) int32 {
247 if addr[0] > dims[0] {
250 for i := 1; i < NumDimensions; i++ {
251 if addr[i] < 0 || addr[i] >= dims[i] {
254 index = index*dims[i] + addr[i]
259 func DecodeIndex(dims []int, index int32) []int {
260 addr := make([]int, NumDimensions)
261 for i := NumDimensions - 1; i > 0; i-- {
262 addr[i] = int(index) % dims[i]
263 index /= int32(dims[i])
269 func CreateStateTable(data planet_data, dims []int) []State {
270 table := make([]State, StateTableSize(dims))
271 for i := range table {
272 table[i].value = CELL_UNINITIALIZED
275 addr := make([]int, NumDimensions)
277 addr[Edens] = *start_edens
278 addr[Location] = data.p2i[*start]
280 table[EncodeIndex(dims, addr)].value = int32(*funds)
285 /* CellValue fills in the one cell at address addr by looking at all
286 * the possible ways to reach this cell and selecting the best one. */
288 func Consider(data planet_data, dims []int, table []State, there []int, value_difference int, best_value *int32, best_source []int) {
289 there_value := CellValue(data, dims, table, there)
290 if value_difference < 0 && int32(-value_difference) > there_value {
291 /* Can't afford this transition */
294 possible_value := there_value + int32(value_difference)
295 if possible_value > *best_value {
296 *best_value = possible_value
297 copy(best_source, there)
301 var cell_filled_count int
302 func CellValue(data planet_data, dims []int, table []State, addr []int) int32 {
303 my_index := EncodeIndex(dims, addr)
304 if table[my_index].value == CELL_BEING_EVALUATED {
305 panic("Circular dependency")
307 if table[my_index].value != CELL_UNINITIALIZED {
308 return table[my_index].value
310 table[my_index].value = CELL_BEING_EVALUATED
312 best_value := int32(CELL_RUBISH)
313 best_source := make([]int, NumDimensions)
314 other := make([]int, NumDimensions)
316 planet := data.i2p[addr[Location]]
319 if addr[Traded] == 0 { /* Can't have traded immediately after traveling. */
320 other[Traded] = 1 /* Travel from states that have done trading. */
322 /* Travel here via a 2-fuel unit jump */
323 if addr[Fuel]+2 < dims[Fuel] {
324 other[Fuel] = addr[Fuel] + 2
325 hole_index := (dims[Fuel] - 1) - (addr[Fuel] + 2)
326 if hole_index >= len(flight_plan()) || addr[Location] != data.p2i[flight_plan()[hole_index]] {
327 for other[Location] = 0; other[Location] < dims[Location]; other[Location]++ {
328 if data.Planets[data.i2p[addr[Location]]].BeaconOn {
329 Consider(data, dims, table, other, 0, &best_value, best_source)
333 other[Location] = addr[Location]
334 other[Fuel] = addr[Fuel]
337 /* Travel here via a 1-fuel unit jump (a hyper hole) */
338 if addr[Fuel]+1 < dims[Fuel] {
339 hole_index := (dims[Fuel] - 1) - (addr[Fuel] + 1)
340 if hole_index < len(flight_plan()) && addr[Location] == data.p2i[flight_plan()[hole_index]] {
341 other[Fuel] = addr[Fuel] + 1
342 for other[Location] = 0; other[Location] < dims[Location]; other[Location]++ {
343 Consider(data, dims, table, other, 0, &best_value, best_source)
345 other[Location] = addr[Location]
346 other[Fuel] = addr[Fuel]
350 /* Travel here via Eden Warp Unit */
351 if addr[Edens]+1 < dims[Edens] && addr[UnusedCargo] > 0 {
352 _, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Eden Warp Units"]
354 other[Edens] = addr[Edens] + 1
355 if other[Hold] != 0 {
356 other[UnusedCargo] = addr[UnusedCargo] - 1
358 for other[Location] = 0; other[Location] < dims[Location]; other[Location]++ {
359 Consider(data, dims, table, other, 0, &best_value, best_source)
361 other[Location] = addr[Location]
362 other[UnusedCargo] = addr[UnusedCargo]
363 other[Edens] = addr[Edens]
366 other[Traded] = addr[Traded]
370 if addr[Traded] == 1 {
373 /* Consider not trading */
374 Consider(data, dims, table, other, 0, &best_value, best_source)
376 if !data.Planets[data.i2p[addr[Location]]].Private {
379 if addr[Hold] == 0 && addr[UnusedCargo] == 0 {
380 for other[Hold] = 0; other[Hold] < dims[Hold]; other[Hold]++ {
381 commodity := data.i2c[other[Hold]]
382 if !data.Commodities[commodity].CanSell {
385 relative_price, available := data.Planets[planet].RelativePrices[commodity]
390 base_price := data.Commodities[commodity].BasePrice
391 absolute_price := float64(base_price) * float64(relative_price) / 100.0
392 sell_price := int(absolute_price * 0.9)
394 for other[UnusedCargo] = 0; other[UnusedCargo] < dims[UnusedCargo]; other[UnusedCargo]++ {
395 quantity := *hold - (other[UnusedCargo] + other[Cloaks] + other[Edens])
396 sale_value := quantity * sell_price
397 Consider(data, dims, table, other, sale_value, &best_value, best_source)
400 other[UnusedCargo] = addr[UnusedCargo]
401 other[Hold] = addr[Hold]
405 other[Traded] = addr[Traded] /* Buy after selling */
407 commodity := data.i2c[addr[Hold]]
408 if data.Commodities[commodity].CanSell {
409 relative_price, available := data.Planets[planet].RelativePrices[commodity]
411 base_price := data.Commodities[commodity].BasePrice
412 absolute_price := int(float64(base_price) * float64(relative_price) / 100.0)
413 quantity := *hold - (addr[UnusedCargo] + addr[Cloaks] + addr[Edens])
414 total_price := quantity * absolute_price
416 other[UnusedCargo] = 0
417 Consider(data, dims, table, other, -total_price, &best_value, best_source)
418 other[UnusedCargo] = addr[UnusedCargo]
419 other[Hold] = addr[Hold]
426 /* Buy a Device of Cloaking */
427 if addr[Cloaks] == 1 && addr[UnusedCargo] < dims[UnusedCargo]-1 {
428 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Device Of Cloakings"]
430 absolute_price := int(float64(data.Commodities["Device Of Cloakings"].BasePrice) * float64(relative_price) / 100.0)
432 if other[Hold] != 0 {
433 other[UnusedCargo] = addr[UnusedCargo] + 1
435 Consider(data, dims, table, other, -absolute_price, &best_value, best_source)
436 other[UnusedCargo] = addr[UnusedCargo]
437 other[Cloaks] = addr[Cloaks]
441 /* Buy Fighter Drones */
442 if addr[BuyFighters] == 1 {
443 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Fighter Drones"]
445 absolute_price := int(float64(data.Commodities["Fighter Drones"].BasePrice) * float64(relative_price) / 100.0)
446 other[BuyFighters] = 0
447 Consider(data, dims, table, other, -absolute_price * *drones, &best_value, best_source)
448 other[BuyFighters] = addr[BuyFighters]
452 /* Buy Shield Batteries */
453 if addr[BuyShields] == 1 {
454 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Shield Batterys"]
456 absolute_price := int(float64(data.Commodities["Shield Batterys"].BasePrice) * float64(relative_price) / 100.0)
457 other[BuyShields] = 0
458 Consider(data, dims, table, other, -absolute_price * *batteries, &best_value, best_source)
459 other[BuyShields] = addr[BuyShields]
463 /* Visit this planet */
465 for i = 0; i < uint(len(visit())); i++ {
466 if addr[Visit] & (1 << i) != 0 && visit()[i] == data.i2p[addr[Location]] {
467 other[Visit] = addr[Visit] & ^(1 << i)
468 Consider(data, dims, table, other, 0, &best_value, best_source)
471 other[Visit] = addr[Visit]
473 /* Buy Eden warp units */
474 eden_limit := data.Commodities["Eden Warp Units"].Limit
475 if addr[Edens] > 0 && addr[Edens] <= eden_limit {
476 relative_price, available := data.Planets[data.i2p[addr[Location]]].RelativePrices["Eden Warp Units"]
478 absolute_price := int(float64(data.Commodities["Eden Warp Units"].BasePrice) * float64(relative_price) / 100.0)
479 for quantity := addr[Edens]; quantity > 0; quantity-- {
480 other[Edens] = addr[Edens] - quantity
482 other[UnusedCargo] = addr[UnusedCargo] + quantity
484 if other[UnusedCargo] < dims[UnusedCargo] {
485 Consider(data, dims, table, other, -absolute_price * quantity, &best_value, best_source)
488 other[Edens] = addr[Edens]
489 other[UnusedCargo] = addr[UnusedCargo]
493 // Check that we didn't lose track of any temporary modifications to other.
494 for i := 0; i < NumDimensions; i++ {
495 if addr[i] != other[i] {
500 // Sanity check: This cell was in state BEING_EVALUATED
501 // the whole time that it was being evaluated.
502 if table[my_index].value != CELL_BEING_EVALUATED {
506 // Record our findings
507 table[my_index].value = best_value
508 table[my_index].from = EncodeIndex(dims, best_source)
512 if cell_filled_count & 0xff == 0 {
513 print(fmt.Sprintf("\r%3.1f%%", 100*float64(cell_filled_count)/float64(StateTableSize(dims))))
516 return table[my_index].value
519 func FindBestState(data planet_data, dims []int, table []State) int32 {
520 addr := make([]int, NumDimensions)
521 addr[Edens] = *end_edens
522 addr[Cloaks] = dims[Cloaks] - 1
523 addr[BuyFighters] = dims[BuyFighters] - 1
524 addr[BuyShields] = dims[BuyShields] - 1
525 addr[Visit] = dims[Visit] - 1
528 addr[UnusedCargo] = 0
529 max_index := int32(-1)
530 max_value := int32(0)
535 for addr[Fuel] = 0; addr[Fuel] <= max_fuel; addr[Fuel]++ {
536 for addr[Location] = 0; addr[Location] < dims[Location]; addr[Location]++ {
537 if len(end()) == 0 || end()[data.i2p[addr[Location]]] {
538 index := EncodeIndex(dims, addr)
539 value := CellValue(data, dims, table, addr)
540 if value > max_value {
550 func Commas(n int32) (s string) {
554 s = fmt.Sprintf(",%03d", r) + s
558 s = fmt.Sprint(r) + s
562 func DescribePath(data planet_data, dims []int, table []State, start int32) (description []string) {
563 for index := start; index > 0 && table[index].from > 0; index = table[index].from {
565 addr := DecodeIndex(dims, index)
566 prev := DecodeIndex(dims, table[index].from)
567 if addr[Fuel] != prev[Fuel] {
568 from := data.i2p[prev[Location]]
569 to := data.i2p[addr[Location]]
570 line += fmt.Sprintf("Jump from %v to %v (%v hyper jump units)", from, to, prev[Fuel]-addr[Fuel])
572 if addr[Edens] == prev[Edens] - 1 {
573 from := data.i2p[prev[Location]]
574 to := data.i2p[addr[Location]]
575 line += fmt.Sprintf("Eden warp from %v to %v", from, to)
577 if addr[Hold] != prev[Hold] {
579 quantity := *hold - (prev[UnusedCargo] + prev[Edens] + prev[Cloaks])
580 line += fmt.Sprintf("Sell %v %v", quantity, data.i2c[prev[Hold]])
581 } else if prev[Hold] == 0 {
582 quantity := *hold - (addr[UnusedCargo] + addr[Edens] + addr[Cloaks])
583 line += fmt.Sprintf("Buy %v %v", quantity, data.i2c[addr[Hold]])
585 panic("Switched cargo?")
589 if addr[Cloaks] == 1 && prev[Cloaks] == 0 {
590 // TODO: Dump cloaks, convert from cargo?
591 line += "Buy a Cloak"
593 if addr[Edens] > prev[Edens] {
594 line += fmt.Sprint("Buy ", addr[Edens] - prev[Edens], " Eden Warp Units")
596 if addr[BuyShields] == 1 && prev[BuyShields] == 0 {
597 line += fmt.Sprint("Buy ", *batteries, " Shield Batterys")
599 if addr[BuyFighters] == 1 && prev[BuyFighters] == 0 {
600 line += fmt.Sprint("Buy ", *drones, " Fighter Drones")
602 if addr[Visit] != prev[Visit] {
603 // TODO: verify that the bit chat changed is addr[Location]
604 line += fmt.Sprint("Visit ", data.i2p[addr[Location]])
606 if line == "" && addr[Hold] == prev[Hold] && addr[Traded] != prev[Traded] {
607 // The Traded dimension is for housekeeping. It doesn't directly
608 // correspond to in-game actions, so don't report transitions.
612 line = fmt.Sprint(prev, " -> ", addr)
614 description = append(description, fmt.Sprintf("%13v ", Commas(table[index].value)) + line)
619 // (Example of a use case for generics in Go)
620 func IndexPlanets(m *map[string]Planet, start_at int) (map[string]int, []string) {
621 e2i := make(map[string]int, len(*m)+start_at)
622 i2e := make([]string, len(*m)+start_at)
631 func IndexCommodities(m *map[string]Commodity, start_at int) (map[string]int, []string) {
632 e2i := make(map[string]int, len(*m)+start_at)
633 i2e := make([]string, len(*m)+start_at)
645 if *cpuprofile != "" {
646 f, err := os.Create(*cpuprofile)
650 pprof.StartCPUProfile(f)
651 defer pprof.StopCPUProfile()
654 if *drone_price > 0 {
655 temp := data.Commodities["Fighter Drones"]
656 temp.BasePrice = *drone_price
657 data.Commodities["Fighter Drones"] = temp
659 if *battery_price > 0 {
660 temp := data.Commodities["Shield Batterys"]
661 temp.BasePrice = *battery_price
662 data.Commodities["Shield Batterys"] = temp
664 data.p2i, data.i2p = IndexPlanets(&data.Planets, 0)
665 data.c2i, data.i2c = IndexCommodities(&data.Commodities, 1)
666 dims := DimensionSizes(data)
667 table := CreateStateTable(data, dims)
668 best := FindBestState(data, dims, table)
671 print("Cannot acheive success criteria\n")
673 description := DescribePath(data, dims, table, best)
674 for i := len(description) - 1; i >= 0; i-- {
675 fmt.Println(description[i])