-
Notifications
You must be signed in to change notification settings - Fork 1
/
ranking.ts
421 lines (355 loc) · 13.9 KB
/
ranking.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
import { and, assert, assertSoft, eq, implies, not, or, capitalizeFirstLetter} from "./helpers";
import {isDimension, isMeasure } from "./constraints";
function iteFromDict(getValueExpr, dict, type, lastElseValue = 10000){
// dict should be exhaustive
// todo: lowp check values in dict are proper
/*
* Recurse through dict
* */
const helper = ([head, ...tail]) => {
if (head === undefined)
return `${lastElseValue}`;
else {
const [key, value] = head;
return `(ite (= ${getValueExpr} ${capitalizeFirstLetter(key) + type} ) ${value}
${helper(tail)})`;
}
};
return helper((Object as any).entries(dict));
}
/*
greg: penalty functions with maximize let us express:
if enough constraints at a "lower level" of priority are violated
this should override constraints at a higher level
in terms of hierarchies (like the channel_penalty)
expressing the channel penalty as 8 different constraints, we can't
"group them together" to refer to their value and weight that value
(it can be done but have to do the multiplication into the weight, and
that weight isn't a solved for variable, it is defined before the program runs
greg: how to do it with soft constraints
for the single valued penalty functions
(= (channel e1) key) weight: value
*/
function oldEncName(enc, i){
return `old_enc${i}`;
}
function newEncName(enc, i){
return `new_enc${i}`;
}
// https://github.com/vega/compassql/tree/master/src/ranking
// why not use http://rise4fun.com/z3opt/tutorial/ ?
// many functions taken from https://docs.google.com/document/d/1RPs3smH5hq4BOwGPc5tx8IlcelpXzTUozi3bFU0M5Ss/edit#
export function ranking(fields, query, encs) {
let penaltyFunctionDefinitions: string[] = [];
let penaltyFunctionNames: string[] = [];
let markPenaltyFunctions: string[] = [];
// the following penalties are copy-pasted from
// compassql/src/ranking/effectiveness/channel.ts on feb 8
// commit e8023aec8bd12c65bfddf36a1866dfd13869fa2d
const TERRIBLE = 1000;
// From Greg: to get Int arithmetic in z3, I moved decimal
// two places to right and rounded up
// x = y > size > color (ramp) > text > opacity >>> detail > shape ~ strokeDash ~ row = column
const continuous_quant_penalties = {
x: 0,
y: 0,
size: 58,
color: 73,
text: 200,
opacity: 300,
shape: TERRIBLE,
row: TERRIBLE,
column: TERRIBLE,
detail: 2 * TERRIBLE
};
// x = y > size > color (ramp) > text > row = column >> opacity > shape ~ strokeDash > detail
const discretized_ordinal_penalties = (Object as any).assign({
row: 75,
column: 75,
shape: 310,
text: 320,
detail: 400
}, continuous_quant_penalties);
// x = y > color (hue) > shape ~ strokeDash > text > row = column >> detail >> size > opacity
const nominal_penalties = {
x: 0,
y: 0,
color: 60, // TODO: make it adjustable based on preference (shape is better for black and white)
shape: 65,
row: 70,
column: 70,
text: 80,
detail: 200,
size: 300,
opacity: 310
};
let penaltyFunctionName = "type_channel_penalty";
let typeChannelPenalty = `(define-fun ${penaltyFunctionName} ((e Encoding)) Int
; (Continuous) Quantitative / Temporal Fields
(ite (or
(= (type e) Quantitative)
)
${iteFromDict("(channel e)", continuous_quant_penalties, "Channel")}
; else Discretized Quantitative (Binned) / Temporal Fields / Ordinal
(ite (or
;(= (type e) Binned) not yet in types
(= (type e) Ordinal)
)
${iteFromDict("(channel e)", discretized_ordinal_penalties, "Channel")}
; else it is nominal
${iteFromDict("(channel e)", nominal_penalties, "Channel")}
)
)
)`;
penaltyFunctionDefinitions.push(typeChannelPenalty);
penaltyFunctionNames.push(penaltyFunctionName);
// more penalty functions go here that are f(encoding)
// Greg: looks like ham's types have changed a bit?
// compassql/src/ranking/effectiveness/type.ts
// compassql/src/ranking/effectiveness/sizechannel.ts
// if mark bar and channel size, penalty 200
const size_channel_penalties_by_mark = {
bar: 200,
tick: 200,
};
penaltyFunctionName = "size_channel_penalty";
typeChannelPenalty = `(define-fun ${penaltyFunctionName} ((e Encoding)) Int
(ite ${eq("(channel e)", "SizeChannel")}
${iteFromDict("mark", size_channel_penalties_by_mark, "Mark", 0)}
0
)
)`;
penaltyFunctionDefinitions.push(typeChannelPenalty);
penaltyFunctionNames.push(penaltyFunctionName);
// mark compassql/src/ranking/effectiveness/mark.ts
const one_mark_penalties = {
point: 0,
text: 20,
tick: 50,
line: 300,
area: 300,
bar: 300,
rule: 300,
rect: TERRIBLE
};
const two_mark_penalties = {
point: 0,
text: 20,
tick: 50,
line: 300,
area: 300,
bar: 400,
rule: 400,
rect: TERRIBLE
};
const two_b_two_penalties= {
bar: 0,
rule: 3,
point: 5,
text: 20,
tick: 80,
line: 400,
area: 400,
rect: TERRIBLE
};
const three_a_mark_penalties = {
tick: 80,
point: 100,
text: 120,
line: 400,
area: 400,
bar: 500,
rule: 800,
rect: TERRIBLE
};
const three_b_mark_penalties = {
bar: 0,
point: 21,
tick: 40,
text: 60,
line: 400,
area: 400,
rule: 800,
rect: TERRIBLE
};
const four_a_mark_penalties = {
rect: 5,
point: 20,
text: 40,
tick: 120,
bar: 500,
line: 500,
area: 500,
rule: 500,
};
const four_b_mark_penalties = {
point: 6,
text: 20,
rect: 40,
tick: 120,
line: 400,
area: 400,
bar: 400,
rule: 400,
};
let singleVariableMarkPenaltyFunc = (e) => {
let type = `(type ${e})`;
let agg = `(agg ${e})`;
let binned = `(binned ${e})`;
return `
(ite ${and(eq(type, "Quantitative"), not(binned))}
${iteFromDict("m", three_a_mark_penalties, "Mark")}
; else not Quantitative
(ite ${or(eq(type, "Nominal"), eq(type, "Ordinal"), binned)}
(ite ${not(eq(agg, "None"))}
${iteFromDict("m", four_a_mark_penalties, "Mark")}
${iteFromDict("m", four_b_mark_penalties, "Mark")}
)
; should never occur
${TERRIBLE}
)
)
`;
};
// pattern here is to do x or y case then do the y or x case that mirrors it immediately
// after, down the ITE chain.
// First we handle the case where y or x or both have no encoding
// Then we start the main cases after ; y is not null
penaltyFunctionName="mark_penalty";
let mark_penalty_function= `(define-fun ${penaltyFunctionName} ((m Marktype)) Int
(ite ${not(and(eq("getXEnc", "nullEnc"), eq("getYEnc", "nullEnc")))}
(ite ${not(eq("getXEnc", "nullEnc"))}
(ite ${eq("getYEnc", "nullEnc")}
${singleVariableMarkPenaltyFunc("getXEnc")}
; y is not null
; if both are aggregates
(ite ${(and(eq("(type getXEnc)", "Quantitative"), not("(binned getXEnc)"), not(eq("(agg getXEnc)", "None")),
eq("(type getYEnc)", "Quantitative"), not("(binned getYEnc)"), not(eq("(agg getYEnc)", "None"))))}
${iteFromDict("m", one_mark_penalties, "Mark")}
; else if only one is an aggregate and other not binned quant
(ite ${or((and(eq("(type getXEnc)", "Quantitative"), not("(binned getXEnc)"), eq("(agg getXEnc)", "None"),
eq("(type getYEnc)", "Quantitative"), not("(binned getYEnc)"), not(eq("(agg getYEnc)", "None")))),
(and(eq("(type getXEnc)", "Quantitative"), not("(binned getXEnc)"), not(eq("(agg getXEnc)", "None")),
eq("(type getYEnc)", "Quantitative"), not("(binned getYEnc)"), eq("(agg getYEnc)", "None"))))}
${iteFromDict("m", two_b_two_penalties, "Mark")}
; else if only one is an aggregate and other is binned quant
(ite ${or((and(eq("(type getXEnc)", "Quantitative"), "(binned getXEnc)", eq("(agg getXEnc)", "None"),
eq("(type getYEnc)", "Quantitative"), not("(binned getYEnc)"), not(eq("(agg getYEnc)", "None")))),
(and(eq("(type getXEnc)", "Quantitative"), not("(binned getXEnc)"), not(eq("(agg getXEnc)", "None")),
eq("(type getYEnc)", "Quantitative"), "(binned getYEnc)", eq("(agg getYEnc)", "None"))))}
${iteFromDict("m", three_b_mark_penalties, "Mark")}
;else if not binned and not aggregates and quant
(ite ${(and(eq("(type getXEnc)", "Quantitative"), not("(binned getXEnc)"),
eq("(type getYEnc)", "Quantitative"), not("(binned getYEnc)")))}
${iteFromDict("m", two_mark_penalties, "Mark")}
; else if multiple measure values for each dimension (todo: add stats here for multivalue and 3c cases)
(ite ${or(and(isDimension("getXEnc"), isMeasure("getYEnc")),
and(isDimension("getYEnc"), isMeasure("getXEnc")))}
${iteFromDict("m", three_a_mark_penalties, "Mark")}
;else we are into ordinal and below so all 4 cases
; without adding constraints to show count with color here (ie heatmap-ish)
; overplotting very easy
10
)
)
)
)
)
)
; x is null and y is not null
${singleVariableMarkPenaltyFunc("getYEnc")}
)
; x and y were null
0
)
)`;
/*
(ite ${or(and(eq("(type getXEnc)", "Quantitative"),not("(binned getXEnc)")),
and(eq("(type getYEnc)", "Quantitative"),not("(binned getYEnc)")))}
${iteFromDict("m", three_b_mark_penalties)}
${iteFromDict("m", three_b_mark_penalties)}
*/
/*
TODO: implement temporal and stats (eg duplicate values) to support diffs in 3
(ite ${and(eq(chan, "Quantitative"), not(eq(agg, "None")))}
${iteFromDict("m", three_a_mark_penalties)}
; else has an aggregation, for now use same
${iteFromDict("m", three_a_mark_penalties)}
)
*/
// TODO: ask ham to open compassql and use console to output the table directly
// will be easier to parse the full table than copy-paste it's generating logic here
// double-check with ham that it's a static table (seems to be so)
// compassql/src/ranking/effectiveness/dimension.ts
// Penalize if facet channels are the only dimensions
// if there is an aggregation if (not (= (agg enc) None)
// find the encoding that ... ? ask ham
encs.forEach((enc, i) => {
});
// compassql/src/ranking/effectiveness/facet.ts
// effectiveness score for preferred facet
// Greg: we don't have preferred facet I think?
// we would just enter that as an assertion for having it as row or column directly
// in the query part
// Ham just does penalty of 1 for the "non-preferred" opposite eg just col or row
// now we can have any other penalty functions we need
// like if we want one that is comparisonPenalty(oldEncoding, newEncoding)
// penalties hold the expression that refers
// to z3 functions
const penaltyStatements: string[] = [];
encs.forEach((enc, i) => {
penaltyFunctionNames.forEach( (pf, j) => {
// make each constraint
penaltyStatements.push( `(${pf} ${enc} )` );
/* // if want to do compared to old solution iteratively
penaltyStatements.push(
`(- (${pf} ${oldEncName(enc,i)})
(${pf} ${newEncName(enc,i)}) )`);
});
*/
});
});
// single functions
let penaltySumStmt = `(+ ${penaltyStatements.join(" ")} (* 1 (${penaltyFunctionName} mark)))`;
let minimizeStmt = `(minimize ${penaltySumStmt})`;
// if deisred, we can add a constraint for
// sum of the penalties for old > sum of the penalties for the new
// but I'm not including that now, since this should just minimize it
let definitions = penaltyFunctionDefinitions.join(" ");
//definitions = definitions + '\n' + getXEncFunc + '\n' + getYEncFunc + '\n' + mark_penalty_function;
definitions = definitions + '\n' + mark_penalty_function;
definitions += "\n (declare-const mpen Int) (assert (= mpen (mark_penalty mark))) ";
definitions += "\n (declare-const gx Encoding) (assert (= gx getXEnc)) ";
definitions += "\n (declare-const gy Encoding) (assert (= gy getYEnc)) ";
definitions += `\n (declare-const pen Int) (assert (= pen ${penaltySumStmt})) `;
return [definitions, minimizeStmt];
// can also solve for other conditions
// START PARETO OPTIMAL
/*
const penaltyStatements = [];
encs.forEach((enc, i) => {
penaltyFunctionNames.forEach( (pf, j) => {
// make each constraint
penaltyStatements.push(
`(>= (${pf} ${oldEncName(enc)})
(${pf} ${newEncName(enc)}) )`);
});
});
*/
//
// sum of the penalties for old > sum of the penalties for the new
//
// END PARETO OPTIMAL
//
// or can use it via minimize the sum of the penalties
//
// START MINIMIZE OVERALL
//
// (assert ${sum of the old penalties} > ${expression for sum of penalties for new})
//
// (minimize ${expression for sum of penalties for new})
//
// one way to encode that last statement is
// to_minimize_expressions += `(- (${pf} oldEnc) (${pf} newEnc))`
// solver_minimize = `(minimize (+ ${to_minimize_expressions.join(" ")}))`;
}