2 * Route searcher - route evaluation
5 * This is part of the YARRG website, a tool for assisting
6 * players of Yohoho Puzzle Pirates.
8 * Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as
12 * published by the Free Software Foundation, either version 3 of the
13 * License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
24 * are used without permission. This program is not endorsed or
25 * sponsored by Three Rings.
32 DEBUG_DEFINE_DEBUGF(value);
33 DEBUG_DEFINE_SOME_DEBUGF(value2,debug2f);
35 typedef struct { int mass, volu; } CommodInfo;
36 static int commodstabsz;
37 static CommodInfo *commodstab;
39 static sqlite3_stmt *ss_ipair_dist;
40 static sqlite3_stmt *ss_ite_buy, *ss_ite_sell;
43 #define MAX_LEGS (MAX_ROUTELEN-1)
46 int commodid, src_price, dst_price;
49 #define TRADES_PER_BLOCK 10
51 typedef struct TradesBlock {
52 struct TradesBlock *next;
54 Trade t[TRADES_PER_BLOCK];
57 static IslandPair ***ipairs; /* ipairs[sislandid][dislandid] */
59 typedef struct IslandTradeEnd {
60 struct IslandTradeEnd *next;
65 unsigned long generation;
70 IslandTradeEnd *src, *dst;
71 } IslandTradeEndHeads;
73 IslandTradeEndHeads *itradeends;
74 /* itradeends[islandid].{src,dst}->commodid etc. */
77 static unsigned long generation;
79 static int nconstraint_rows;
80 static int constraint_rows[1+2+3*MAX_LEGS];
81 static double constraint_coeffs[1+2+3*MAX_LEGS];
82 /* dummy0, src, dst, for_each_leg( [mass], [volume], [capital] ) */
84 static void add_constraint(int row, double coefficient) {
85 nconstraint_rows++; /* glpk indices start from 1 !!! */
86 constraint_rows [nconstraint_rows]= row;
87 constraint_coeffs[nconstraint_rows]= coefficient;
90 static IslandTradeEnd *get_ite(const Trade *t, IslandTradeEnd **trades,
92 IslandTradeEnd *search;
94 for (search= *trades; search; search=search->next)
95 if (search->commodid==t->commodid && search->price==price)
100 static void avail_c(const Trade *t, IslandTradeEnd *ite,
101 int price, const char *srcdst,
102 int islandid, sqlite3_stmt *ss_ite) {
103 /* find row number of trade availability constraint */
104 IslandTradeEnd *search= ite;
106 if (search->generation != generation) {
107 search->rownum= lpx_add_rows(lp, 1);
108 lpx_set_row_bnds(lp, search->rownum, LPX_UP, 0, search->qty);
110 if (DEBUGP(value) || DEBUGP(check)) {
111 char *name= masprintf("%s_i%d_c%d_%d_all",
112 srcdst, islandid, t->commodid, price);
113 lpx_set_row_name(lp,search->rownum,name);
116 int nrows= lpx_get_num_rows(lp);
117 assert(search->rownum == nrows);
119 for (i=1; i<nrows; i++)
120 assert(strcmp(name, lpx_get_row_name(lp,i)));
124 search->generation= generation;
127 add_constraint(search->rownum, 1.0);
130 static int setup_leg_constraints(double max_thing, int legs, const char *wh) {
132 if (max_thing < 0 || !legs) return -1;
133 startrow= lpx_add_rows(lp, legs);
134 for (leg=0; leg<legs; leg++) {
135 int row= leg+startrow;
136 lpx_set_row_bnds(lp, row, LPX_UP, 0, max_thing);
138 char *name= masprintf("%s_%d",wh,leg);
139 lpx_set_row_name(lp,row,name);
146 static void add_leg_c(int startrow, int leg, double value) {
147 if (startrow<=0) return;
149 add_constraint(startrow+leg, value);
152 IslandPair *ipair_get_maybe(int si, int di) {
155 assert(si < islandtablesz);
156 assert(di < islandtablesz);
158 if (!(ipa= ipairs[si])) return 0;
162 static IslandPair *ipair_get_create(int si, int di) {
163 IslandPair *ip, **ipa;
165 assert(si < islandtablesz);
166 assert(di < islandtablesz);
168 if (!(ipa= ipairs[si])) {
169 ipairs[si]= MCALLOC(ipa, islandtablesz);
176 ip->route_tail_value= -1;
178 if (si==di) ctr_islands_arbitrage++;
179 else ctr_ipairs_relevant++;
181 debug2f("VALUE ipair_get(i%d,i%d) running...\n", si,di);
182 SQL_MUST( sqlite3_bind_int(ss_ipair_dist, 1, si) );
183 SQL_MUST( sqlite3_bind_int(ss_ipair_dist, 2, di) );
184 assert(SQL_STEP(ss_ipair_dist));
185 int dist= sqlite3_column_int(ss_ipair_dist, 0);
186 ip->distance_loss_factor= pow(distance_loss_factor_per_league, dist);
187 sqlite3_reset(ss_ipair_dist);
192 double value_route(int nislands, const int *islands, int exclude_arbitrage) {
195 ctr_subroutes_valued++;
197 /* We need to construct the LP problem. GLPK talks
198 * about rows and columns, which are numbered from 1.
200 * Each column is a `structural variable' ie one of the entries in
201 * the objective function. In our case the set of structural
202 * variable is, for each port, the set of Trades which collect at
203 * that island. (We use `port' to mean `specific visit to an
204 * island' so if an island appears more than once so do its trades.)
205 * We don't need to worry about crossing with all the possible
206 * delivery locations as we always deliver on the first port.
207 * We will call such a structural variable a Flow, for brevity.
209 * We iterate over the possible Flows adding them as columns as we
210 * go, and also adding their entries to the various constraints.
212 * Each row is an `auxiliary variable' ie one of the constraints.
213 * We have two kinds of constraint:
214 * - mass/volume/capital: one constraint for each sailed leg
215 * (unless relevant constraint is not satisfied)
216 * - quantity of commodity available for collection
217 * or delivery at particular price and island
218 * The former are numbered predictably: we have first all the mass
219 * limits, then all the volume limits, then all the capital limits
220 * (as applicable) - one for each leg, ie one for each entry
221 * in islands except the first.
223 * The latter are added as needed and the row numbers are stored in
224 * a data structure for later reuse.
227 assert(nislands >= 1);
228 assert(++generation);
231 lp= lpx_create_prob();
232 lpx_set_obj_dir(lp, LPX_MAX);
233 lpx_set_int_parm(lp, LPX_K_MSGLEV, DEBUGP(lp) ? 3 : 1);
234 lpx_set_int_parm(lp, LPX_K_PRESOL, 1);
237 lpx_set_prob_name(lp,(char*)"value_route");
238 lpx_set_obj_name(lp,(char*)"profit");
241 int legs= nislands-1;
242 int mass_constraints= setup_leg_constraints(max_mass, legs, "mass");
243 int volu_constraints= setup_leg_constraints(max_volu, legs, "volu");
244 int capi_constraints= setup_leg_constraints(max_capi, legs, "capi");
246 double delay_slot_loss_factor= 1.0;
249 s++, delay_slot_loss_factor *= LOSS_FACTOR_PER_DELAY_SLOT) {
252 for (d= s + exclude_arbitrage;
257 for (already_d=s+1; already_d<d; already_d++)
258 if (islands[already_d] == di)
259 /* visited this island already since we left s, uninteresting */
263 /* route has returned to si, no need to think more about s */
266 /*----- actually add these trades to the LP problem -----*/
268 IslandPair *ip= ipair_get_maybe(islands[s], islands[d]);
270 if (!ip || !ip->trades)
273 double loss_factor= delay_slot_loss_factor * ip->distance_loss_factor;
274 debugf(" SOME i%d#%d..i%d#%d dslf=%g dlf=%g lf=%g\n",
276 delay_slot_loss_factor, ip->distance_loss_factor, loss_factor);
279 for (block=ip->trades; block; block=block->next) {
281 for (inblock=0; inblock<block->ntrades; inblock++) {
282 Trade *t= &block->t[inblock];
284 debugf(" TRADE i%d#%d..i%d#%d c%d %d-%d ",
285 si,s, di,d, t->commodid, t->src_price, t->dst_price);
288 *src_ite= get_ite(t, &itradeends[si].src, t->src_price),
289 *dst_ite= get_ite(t, &itradeends[di].dst, t->dst_price);
291 int qty= src_ite->qty < dst_ite->qty ? src_ite->qty : dst_ite->qty;
292 int maxprofit= qty * (t->dst_price - t->src_price);
293 debugf("maxprofit=%d ",maxprofit);
294 if (maxprofit < min_trade_maxprofit) {
301 avail_c(t, src_ite, t->src_price, "src", si,ss_ite_sell);
302 avail_c(t, dst_ite, t->dst_price, "dst", di,ss_ite_buy);
305 for (leg=s; leg<d; leg++) {
306 add_leg_c(mass_constraints,leg, commodstab[t->commodid].mass*1e-3);
307 add_leg_c(volu_constraints,leg, commodstab[t->commodid].volu*1e-3);
308 add_leg_c(capi_constraints,leg, t->src_price);
311 double unit_profit= t->dst_price * loss_factor - t->src_price;
312 debugf(" unit profit %f\n", unit_profit);
313 if (unit_profit <= 0) continue;
315 int col= lpx_add_cols(lp,1);
316 lpx_set_col_bnds(lp, col, LPX_LO, 0, 0);
317 lpx_set_obj_coef(lp, col, unit_profit);
318 lpx_set_mat_col(lp, col, nconstraint_rows,
319 constraint_rows, constraint_coeffs);
322 char *name= masprintf("c%d_p%d_%d_p%d_%d", t->commodid,
323 s, t->src_price, d, t->dst_price);
324 lpx_set_col_name(lp, col, name);
330 /*----- that's done adding these trades to the LP problem -----*/
339 if (lpx_get_num_cols(lp)) {
340 ctr_subroutes_nonempty++;
343 lpx_write_cpxlp(lp, (char*)DEBUG_DEV);
345 int ipr= lpx_simplex(lp);
346 assert(ipr==LPX_E_OK);
349 lpx_print_sol(lp, (char*)DEBUG_DEV);
351 int lpst= lpx_get_status(lp);
352 assert(lpst == LPX_OPT);
353 profit= lpx_get_obj_val(lp);
360 exclude_arbitrage ? "base value" : "route value",
366 " FROM sell, buy\n" \
367 " WHERE sell.commodid=buy.commodid AND sell.price < buy.price\n"
369 static void read_trades(void) {
370 /* We would like to use DISTINCT but sqlite3 is too stupid
371 * to notice that it could use the index to do the DISTINCT
372 * which makes it rather slow. */
373 sqlite3_stmt *ss_trades;
376 "sell.commodid, sell.islandid, sell.price, buy.islandid, buy.price"
377 SQL_PREPARE(ss_trades,
378 " SELECT " TRADE_COLS "\n"
380 " ORDER BY " TRADE_COLS);
382 SQL_DISTINCT_DECL(cols,5);
383 while (SQL_DISTINCT_STEP(ss_trades,cols,5)) {
385 IslandPair *ip= ipair_get_create(cols[1], cols[3]);
386 TradesBlock *block= ip->trades;
387 if (!block || ip->trades->ntrades >= TRADES_PER_BLOCK) {
389 block->next= ip->trades;
393 Trade *trade= &block->t[block->ntrades];
394 trade->commodid= cols[0];
395 trade->src_price= cols[2];
396 trade->dst_price= cols[4];
399 sqlite3_finalize(ss_trades);
402 static void read_islandtradeends(const char *bs, int srcdstoff) {
404 #define TRADEEND_KEYCOLS "%s.commodid, %s.islandid, %s.stallid"
405 char *stmt= masprintf(" SELECT " TRADEEND_KEYCOLS ", %s.price, %s.qty\n"
407 " ORDER BY " TRADEEND_KEYCOLS,
408 bs,bs,bs,bs,bs, bs,bs,bs);
409 char *stmt_id= masprintf("qtys (%s)",bs);
410 sqlite3_stmt *ss= sql_prepare(stmt, stmt_id);
411 free(stmt); free(stmt_id);
413 SQL_DISTINCT_DECL(cols,5);
414 while (SQL_DISTINCT_STEP(ss,cols,3)) {
415 ctr_quantities_loaded++;
416 IslandTradeEnd *search;
418 int commodid= cols[0];
419 int islandid= cols[1];
423 IslandTradeEnd **trades= (void*)((char*)&itradeends[islandid] + srcdstoff);
425 for (search= *trades; search; search=search->next)
426 if (search->commodid==commodid && search->price==price)
428 /* not found, add new end */
431 search->commodid= commodid;
432 search->price= price;
433 search->next= *trades;
434 search->generation= 0;
441 sqlite3_finalize(ss);
444 void setup_value(void) {
447 commodstabsz= sql_single_int("SELECT max(commodid) FROM commods") + 1;
448 MCALLOC_INITEACH(commodstab, commodstabsz,
449 this->mass= this->volu= -1
453 "SELECT commodid,unitmass,unitvolume FROM commods");
454 while (SQL_STEP(sst)) {
455 ctr_commodities_loaded++;
456 int id= sqlite3_column_int(sst,0);
457 assert(id>=0 && id<commodstabsz);
458 commodstab[id].mass= sqlite3_column_int(sst,1);
459 commodstab[id].volu= sqlite3_column_int(sst,2);
461 sqlite3_finalize(sst);
463 MCALLOC(ipairs, islandtablesz);
464 MCALLOC(itradeends, islandtablesz);
466 SQL_PREPARE(ss_ipair_dist,
467 " SELECT dist FROM dists\n"
468 " WHERE aiid=? and biid=?");
471 read_islandtradeends("sell", offsetof(IslandTradeEndHeads, src));
472 read_islandtradeends("buy", offsetof(IslandTradeEndHeads, dst));