Skip to content

Commit 08bffab

Browse files
committed
Add more description of the "struct of arrays" layout
1 parent 6f461e7 commit 08bffab

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

extensions/ql-vscode/src/log-insights/performance-comparison.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ export interface PipelineSummary {
1717
* to a web view (which rules out `Map` values, for example).
1818
*/
1919
export interface PerformanceComparisonDataFromLog {
20-
/** Names of predicates mentioned in the log */
20+
/**
21+
* Names of predicates mentioned in the log.
22+
*
23+
* For compactness, details of these predicates are stored in a "struct of arrays" style.
24+
*
25+
* All fields (except those ending with `Indices`) should contain an array of the same length as `names`;
26+
* details of a given predicate should be stored at the same index in each of those arrays.
27+
*/
2128
names: string[];
2229

2330
/** Number of milliseconds spent evaluating the `i`th predicate from the `names` array. */

0 commit comments

Comments
 (0)