@mark1russell7/packing 0.1.7 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package",
3
3
  "name": "@mark1russell7/packing",
4
- "version": "0.1.7",
4
+ "version": "0.2.1",
5
5
  "description": "Rectangle packing: shelf, guillotine and skyline strategies, push cascades and measures of a layout.",
6
6
  "keywords": [
7
7
  "rectangle-packing",
@@ -48,15 +48,18 @@
48
48
  "engines": {
49
49
  "node": ">=22.12"
50
50
  },
51
+ "dependencies": {
52
+ "@mark1russell7/layout-contract": "^0.2.1"
53
+ },
51
54
  "devDependencies": {
52
55
  "@mark1russell7/cue": "^1.0.2",
53
- "@mark1russell7/layout-contract": "github:mark1russell7/layout-contract#710ec519027dbc122d111cc5e76a1c18877f4237&path:packages/layout-contract",
54
56
  "@types/node": "^26.6.4",
55
57
  "tsdown": "^0.23.1",
56
58
  "typescript": "^7.0.2",
57
59
  "vitest": "^5.0.3"
58
60
  },
59
61
  "scripts": {
62
+ "bench": "node bench/main.ts",
60
63
  "build": "tsdown",
61
64
  "test": "vitest run",
62
65
  "test:watch": "vitest",
package/src/adapters.ts CHANGED
@@ -8,6 +8,7 @@ import { pack } from "./pack.ts";
8
8
  import { pushCascade } from "./push.ts";
9
9
  import { Rect } from "./rect.ts";
10
10
  import { packSkyline } from "./skyline.ts";
11
+ import { spaceOf } from "./space.ts";
11
12
  import { assertSupported, cellOf, UnsupportedCell, type PackContext, type SizeSearch, type Strategy, type Supports } from "./strategy.ts";
12
13
 
13
14
  /** The options of the strategies `rows`, `skyline` and `shelf`. */
@@ -26,10 +27,13 @@ export interface PushStrategyOptions {
26
27
  maxShovesPerItem: number;
27
28
  }
28
29
 
29
- /** The cells of `rows`, `skyline` and `shelf`, without the movement of the obstacles. */
30
+ /**
31
+ * The cells of `rows`, `skyline` and `shelf`, without the movement of the obstacles. The container layer of `src/space.ts`
32
+ * gives them each container shape.
33
+ */
30
34
  const LAYOUT_CELLS = {
31
35
  containerSize: ["fixed", "freeHeight", "freeWidth", "freeAspect", "freeArea"],
32
- containerShape: ["rect"],
36
+ containerShape: ["rect", "convex", "polygon", "circle", "ellipse", "holes"],
33
37
  itemShape: ["rect"],
34
38
  rotation: ["none"],
35
39
  groups: ["none"],
@@ -55,10 +59,9 @@ function packFixedWidth(id: "rows" | "skyline" | "shelf", input: PackInput, opti
55
59
  const start = now();
56
60
  const frame = buildFrame(input);
57
61
  const rects = rectsOf(frame);
58
- if (frame.w > 0) pack(rects, outerOf(frame), { strategy: id, sortOrder: options.sortOrder });
62
+ if (frame.w > 0) pack(rects, outerOf(frame), { strategy: id, sortOrder: options.sortOrder, space: spaceOf(input, frame) });
59
63
  const output = readFrame(input, frame, []);
60
- output.trace.push({ id, ms: now() - start, measures: { "pack.overflow": output.overflow.length } });
61
- return output;
64
+ return { ...output, trace: [{ id, ms: now() - start, measures: { "pack.overflow": output.overflow.length } }] };
62
65
  }
63
66
 
64
67
  /** This function makes the strategy of one function of `pack`. */
@@ -92,17 +95,18 @@ function layoutStrategy(
92
95
  }
93
96
 
94
97
  /**
95
- * The strategy `rows` uses `packRows`: a guillotine row packing with a recursive gap fill. It supports no obstacle and
96
- * no locked item, because `packRows` does not go around them. Turnable items, groups and shapes throw `UnsupportedCell`.
98
+ * The strategy `rows` uses `packRows`: a guillotine row packing with a recursive gap fill. With obstacles, locked items or a
99
+ * container shape, the rows go around the holes of the free space and lose the gap fill. Turnable items, groups and item
100
+ * shapes throw `UnsupportedCell`.
97
101
  */
98
102
  export const rows: Strategy<LayoutStrategyOptions> = layoutStrategy("rows", "shelf", ["rows-gap-fill", "rows-input"], {
99
- obstacleMove: [],
103
+ obstacleMove: ["fixed"],
100
104
  order: ["free", "soft", "hard"],
101
105
  });
102
106
 
103
107
  /**
104
108
  * The strategy `skyline` uses `packSkyline`: each item goes to the lowest place where it fits. It packs around the
105
- * locked items and the fixed obstacles. Turnable items, groups and shapes throw `UnsupportedCell`.
109
+ * locked items and the fixed obstacles, in each container shape. Turnable items, groups and item shapes throw `UnsupportedCell`.
106
110
  */
107
111
  export const skyline: Strategy<LayoutStrategyOptions> = layoutStrategy("skyline", "skyline", ["skyline-bl"], {
108
112
  obstacleMove: ["fixed"],
@@ -111,7 +115,7 @@ export const skyline: Strategy<LayoutStrategyOptions> = layoutStrategy("skyline"
111
115
 
112
116
  /**
113
117
  * The strategy `shelf` uses `packShelf`: rows filled left to right, around the locked items and the fixed obstacles.
114
- * With the sort order `input`, the rows keep the rank order. Turnable items, groups and shapes throw `UnsupportedCell`.
118
+ * With the sort order `input`, the rows keep the rank order. Turnable items, groups and item shapes throw `UnsupportedCell`.
115
119
  */
116
120
  export const shelf: Strategy<LayoutStrategyOptions> = layoutStrategy("shelf", "shelf", ["shelf-nf", "shelf-nfdh"], {
117
121
  obstacleMove: ["fixed"],
@@ -134,6 +138,7 @@ export const logSweep: SizeSearch = {
134
138
  const result = packFree(rectsOf(frame), new Rect<number>(), {
135
139
  strategy: id,
136
140
  sortOrder: o.sortOrder,
141
+ space: spaceOf(input, frame),
137
142
  samples: o.samples,
138
143
  aspect: input.container.aspect ?? 1,
139
144
  aspectWeight: input.container.aspectWeight ?? 1,
@@ -141,11 +146,13 @@ export const logSweep: SizeSearch = {
141
146
  const ms = now() - start;
142
147
  const runs = result.tried.length + 1;
143
148
  const output = readFrame(input, frame, []);
144
- output.trace.push(
145
- { id: "log-sweep", ms, measures: { "pack.search.widths": result.tried.length, "pack.search.ms": ms } },
146
- { id, ms: ms / runs, measures: { "pack.overflow": output.overflow.length } },
147
- );
148
- return output;
149
+ return {
150
+ ...output,
151
+ trace: [
152
+ { id: "log-sweep", ms, measures: { "pack.search.widths": result.tried.length, "pack.search.ms": ms } },
153
+ { id, ms: ms / runs, measures: { "pack.overflow": output.overflow.length } },
154
+ ],
155
+ };
149
156
  },
150
157
  };
151
158
 
@@ -191,7 +198,7 @@ function pushFixedWidth(input: PackInput, options: PushStrategyOptions, previous
191
198
 
192
199
  // An obstacle that the cascade pushed out of the container or onto a locked item goes back to its start
193
200
  const { bounds } = frame;
194
- const moved: PackOutput["moved"] = [];
201
+ const moved: { id: string; x: number; y: number }[] = [];
195
202
  for (const e of obstacles) {
196
203
  const startAt = starts.get(e)!;
197
204
  const x = e.rect.position.x + e.dx + frame.ox;
@@ -224,11 +231,13 @@ function pushFixedWidth(input: PackInput, options: PushStrategyOptions, previous
224
231
  packSkyline([...pending.map((e) => e.rect), ...kept], outerOf(frame), { sortOrder: options.sortOrder });
225
232
  }
226
233
  const output = readFrame(input, frame, [], moved);
227
- output.trace.push(
228
- { id: "push", ms: pushMs, measures: { "pack.push.moved": moved.length } },
229
- { id: "skyline", ms: now() - skylineStart, measures: { "pack.push.replaced": pending.length, "pack.overflow": output.overflow.length } },
230
- );
231
- return output;
234
+ return {
235
+ ...output,
236
+ trace: [
237
+ { id: "push", ms: pushMs, measures: { "pack.push.moved": moved.length } },
238
+ { id: "skyline", ms: now() - skylineStart, measures: { "pack.push.replaced": pending.length, "pack.overflow": output.overflow.length } },
239
+ ],
240
+ };
232
241
  }
233
242
 
234
243
  /**
package/src/check.ts CHANGED
@@ -1,13 +1,7 @@
1
- import { DEFAULT_TOLERANCE, marginOf, RECORD_EPS, turnItem, type Item, type PackInput, type PackOutput, type Tolerance } from "./contract.ts";
2
- import { boundsOf } from "./frame.ts";
1
+ import { boundsOf, regionHitsRect, translate, type PackHard, type Rect, type Region } from "@mark1russell7/layout-contract";
2
+ import { DEFAULT_TOLERANCE, marginOf, RECORD_EPS, turnItem, type Item, type PackInput, type PackOutput, type Placement, type Tolerance } from "./contract.ts";
3
3
 
4
- /** The count of the breaks of each hard rule of the packer (`docs/FORMAT.md`). A good run has 0 for each rule. */
5
- export interface HardBreaks {
6
- "no-overlap": number;
7
- "in-container": number;
8
- "locked-kept": number;
9
- complete: number;
10
- }
4
+ export type { PackHard } from "@mark1russell7/layout-contract";
11
5
 
12
6
  /** A box with its margin: the left, top, right and bottom edges. */
13
7
  interface Box {
@@ -22,6 +16,11 @@ function overlap(a: Box, b: Box, tolerance: number): boolean {
22
16
  return Math.min(a.r, b.r) - Math.max(a.l, b.l) > tolerance && Math.min(a.b, b.b) - Math.max(a.t, b.t) > tolerance;
23
17
  }
24
18
 
19
+ /** This function gives the box made smaller by a tolerance on each side, as a rectangle. */
20
+ function inner(box: Box, tolerance: number): Rect {
21
+ return { x: box.l + tolerance, y: box.t + tolerance, w: box.r - box.l - 2 * tolerance, h: box.b - box.t - 2 * tolerance };
22
+ }
23
+
25
24
  /**
26
25
  * This function counts the breaks of the 4 hard rules of the packer for an output.
27
26
  *
@@ -32,32 +31,35 @@ function overlap(a: Box, b: Box, tolerance: number): boolean {
32
31
  * - `complete`: each item with no placement that is not in the overflow. A locked item breaks `locked-kept` in its place.
33
32
  *
34
33
  * A locked item with no placement stays at its input position for `no-overlap` and `in-container`. A locked item with no
35
- * `x` or no `y` in the input is not locked for these rules.
34
+ * `x` or no `y` in the input is a bad input. The rules skip it, as `packHard` of the contract does. `checkInput` finds it.
36
35
  *
37
- * The rules read a shape of the container, of an obstacle or of an item as its bounding box (decision 5). The bounding box
38
- * of an item shape is relative to the position of the item. The result has no tolerance in it.
36
+ * The test of an obstacle is exact: a circle, an ellipse and a polygon with holes count only their insides, as in `packHard`.
37
+ * The rules read a shape of the container or of an item as its bounding box (decision 5). The bounding box of an item
38
+ * shape is relative to the position of the item. The result has no tolerance in it.
39
39
  */
40
- export function checkHard(input: PackInput, output: PackOutput, tolerance: Pick<Tolerance, "overlap"> = DEFAULT_TOLERANCE): HardBreaks {
40
+ export function checkHard(input: PackInput, output: PackOutput, tolerance: Pick<Tolerance, "overlap"> = DEFAULT_TOLERANCE): PackHard {
41
41
  const tol = tolerance.overlap;
42
- const placements = new Map<string, PackOutput["placements"][number]>();
42
+ const placements = new Map<string, Placement>();
43
43
  for (const p of output.placements) if (!placements.has(p.id)) placements.set(p.id, p);
44
44
  const overflow = new Set(output.overflow);
45
- const breaks: HardBreaks = { "no-overlap": 0, "in-container": 0, "locked-kept": 0, complete: 0 };
45
+ let lockedKept = 0;
46
+ let complete = 0;
46
47
 
47
48
  const boxes: Box[] = [];
48
49
  for (const item of input.items) {
49
- const lockedAt = item.locked === true && item.x !== undefined && item.y !== undefined ? { x: item.x, y: item.y } : undefined;
50
- let p: Pick<PackOutput["placements"][number], "x" | "y" | "turn"> | undefined = placements.get(item.id);
50
+ if (item.locked === true && (item.x === undefined || item.y === undefined)) continue;
51
+ const lockedAt = item.locked === true ? { x: item.x!, y: item.y! } : undefined;
52
+ let p: Pick<Placement, "x" | "y" | "turn"> | undefined = placements.get(item.id);
51
53
  if (p === undefined) {
52
54
  if (lockedAt === undefined) {
53
- if (!overflow.has(item.id)) breaks.complete += 1;
55
+ if (!overflow.has(item.id)) complete += 1;
54
56
  continue;
55
57
  }
56
58
  // A locked item with no placement breaks locked-kept, and it stays at its input position for the other rules
57
- breaks["locked-kept"] += 1;
59
+ lockedKept += 1;
58
60
  p = lockedAt;
59
61
  } else if (lockedAt !== undefined) {
60
- if (Math.abs(p.x - lockedAt.x) > RECORD_EPS || Math.abs(p.y - lockedAt.y) > RECORD_EPS) breaks["locked-kept"] += 1;
62
+ if (Math.abs(p.x - lockedAt.x) > RECORD_EPS || Math.abs(p.y - lockedAt.y) > RECORD_EPS) lockedKept += 1;
61
63
  }
62
64
  const placed: Item = p.turn === 90 ? turnItem(item) : item;
63
65
  const m = marginOf(placed);
@@ -68,15 +70,19 @@ export function checkHard(input: PackInput, output: PackOutput, tolerance: Pick<
68
70
  }
69
71
 
70
72
  const moved = new Map(output.moved.map((m) => [m.id, m]));
71
- const obstacles: Box[] = (input.obstacles ?? []).map((o) => {
73
+ const obstacles: Region[] = (input.obstacles ?? []).map((o) => {
74
+ const at = moved.get(o.id);
75
+ if (at === undefined) return o.region;
72
76
  const b = boundsOf(o.region);
73
- const at = moved.get(o.id) ?? b;
74
- return { l: at.x, t: at.y, r: at.x + b.w, b: at.y + b.h };
77
+ return translate(o.region, at.x - b.x, at.y - b.y);
75
78
  });
76
79
 
80
+ let overlaps = 0;
77
81
  for (const [i, a] of boxes.entries()) {
78
- for (let j = i + 1; j < boxes.length; j++) if (overlap(a, boxes[j]!, tol)) breaks["no-overlap"] += 1;
79
- for (const o of obstacles) if (overlap(a, o, tol)) breaks["no-overlap"] += 1;
82
+ for (let j = i + 1; j < boxes.length; j++) if (overlap(a, boxes[j]!, tol)) overlaps += 1;
83
+ if (obstacles.length === 0) continue;
84
+ const rect = inner(a, tol);
85
+ for (const region of obstacles) if (regionHitsRect(region, rect)) overlaps += 1;
80
86
  }
81
87
 
82
88
  const { container } = input;
@@ -88,10 +94,11 @@ export function checkHard(input: PackInput, output: PackOutput, tolerance: Pick<
88
94
  const inset = container.inset ?? 0;
89
95
  const fixedW = container.fixed === "size" || container.fixed === "width";
90
96
  const fixedH = container.fixed === "size" || container.fixed === "height";
97
+ let outside = 0;
91
98
  for (const box of boxes) {
92
99
  const outX = fixedW && (box.l < x + inset - tol || box.r > x + w - inset + tol);
93
100
  const outY = fixedH && (box.t < y + inset - tol || box.b > y + h - inset + tol);
94
- if (outX || outY) breaks["in-container"] += 1;
101
+ if (outX || outY) outside += 1;
95
102
  }
96
- return breaks;
103
+ return { "no-overlap": overlaps, "in-container": outside, "locked-kept": lockedKept, complete };
97
104
  }
package/src/contract.ts CHANGED
@@ -1,205 +1,43 @@
1
1
  // The data types of the Packer contract (docs/PACKER.md). They are plain data, with no class and no method.
2
- // The shared package `@mark1russell7/layout-contract` gets these types later. Until then, this file is a local copy.
3
-
4
- /** A region. The forms and the rules are those of `docs/FORMAT.md`. The y axis points down. */
5
- export type Region =
6
- | { kind: "rect"; x: number; y: number; w: number; h: number }
7
- | { kind: "polygon"; points: [number, number][]; holes?: [number, number][][] }
8
- | { kind: "circle"; cx: number; cy: number; r: number }
9
- | { kind: "ellipse"; cx: number; cy: number; rx: number; ry: number };
10
-
11
- /** The container of a packing. */
12
- export interface Container {
13
- /** The width. Without it, the packer searches the width. */
14
- w?: number;
15
- /** The height. Without it, the packer searches the height. */
16
- h?: number;
17
- /** The sides that stay: `size` keeps `w` and `h`, `width` keeps `w`, `height` keeps `h`, and `none` searches both. */
18
- fixed: "size" | "width" | "height" | "none";
19
- /** The target aspect (the width divided by the height) for the value `none` of `fixed`. The default is 1. */
20
- aspect?: number;
21
- /** The weight of the aspect error in the objective. The value 0 gives the least area. The default is 1. */
22
- aspectWeight?: number;
23
- /** The shape. Without it, the container is the rectangle from 0, 0 to `w`, `h`. */
24
- shape?: Region;
25
- /** The space between the border and the items with their margins. The default is 0. */
26
- inset?: number;
27
- }
28
-
29
- /** An obstacle: an area that no item enters. */
30
- export interface Obstacle {
31
- id: string;
32
- region: Region;
33
- /** Without it, the obstacle stays. With it, the packer can move the obstacle for `cost` times the distance. */
34
- move?: { cost: number };
35
- }
36
-
37
- /** The margin of an item on each side. */
38
- export interface Margin {
39
- top: number;
40
- right: number;
41
- bottom: number;
42
- left: number;
43
- }
44
-
45
- /** A port on the border of an item. */
46
- export interface Port {
47
- id: string;
48
- side: "top" | "right" | "bottom" | "left";
49
- /** The point on the border of the item, relative to its top-left corner. Without it, the router chooses the point. */
50
- x?: number;
51
- y?: number;
52
- }
53
-
54
- /** An item to pack. The file format names it a box. */
55
- export interface Item {
56
- id: string;
57
- w: number;
58
- h: number;
59
- /** The reading order. Without it, the index in the array is the rank. */
60
- rank?: number;
61
- group?: string;
62
- parent?: string;
63
- /** A shape relative to the origin of the item. Without it, the item is the rectangle `w` by `h`. */
64
- shape?: Region;
65
- /** A locked item keeps `x` and `y`. The packer reads it as an obstacle. */
66
- locked?: boolean;
67
- x?: number;
68
- y?: number;
69
- /** The value `true` lets the packer turn the item by 90 degrees. The default is `false`. */
70
- turnable?: boolean;
71
- /** A ring around the item that no other item and no route enters. The default is 0. */
72
- margin?: number | Margin;
73
- /** The ports. The packer keeps them, and turns them with the item. */
74
- ports?: Port[];
75
- /** The free data of the item. The packer does not read it, and the turn and the converters keep it. */
76
- data?: Readonly<Record<string, unknown>>;
77
- }
78
-
79
- /** The input of a packing: a `layout-input/1` file without `edges`, with `items` for `boxes`. */
80
- export interface PackInput {
81
- container: Container;
82
- items: Item[];
83
- obstacles?: Obstacle[];
84
- /** The free space between two items with their margins. Routes use this space. The default is 0. */
85
- gap?: number;
86
- }
87
-
88
- /** The position of one item after the packing. */
89
- export interface Placement {
90
- id: string;
91
- x: number;
92
- y: number;
93
- /** The turn: 0 or 90, only for an item with `turnable` set to `true`. */
94
- turn?: 0 | 90;
95
- }
96
-
97
- /** The facts of one stage of a packing. */
98
- export interface StageTrace {
99
- /** The id of the stage, for example `skyline` or `log-sweep`. */
100
- id: string;
101
- /** The time of the stage in milliseconds. */
102
- ms: number;
103
- /** The measures of the stage, by the names of `docs/FORMAT.md`. */
104
- measures: Record<string, number>;
105
- }
106
-
107
- /** The output of a packing. The output does not change the input. */
108
- export interface PackOutput {
109
- placements: Placement[];
110
- /** The ids of the items that the packer did not place. */
111
- overflow: string[];
112
- /** The size of the container after the packing. For a free size, the size that the search found. */
113
- size: { w: number; h: number };
114
- /** The new positions of the obstacles that moved. */
115
- moved: { id: string; x: number; y: number }[];
116
- /** The facts of each stage, for the site and the records. */
117
- trace: StageTrace[];
118
- }
119
-
120
- /** The tolerances of the hard rules. */
121
- export interface Tolerance {
122
- /** The rule `no-overlap`: two boxes overlap only by more than this value. */
123
- overlap: number;
124
- /** The router rule that a route does not go through a box. */
125
- through: number;
126
- }
127
-
128
- /** The tolerance for the comparison of two numbers in an engine. */
129
- export const EPS = 1e-6;
130
-
131
- /** The tolerance for the comparison of two numbers of a file. The files round to 3 decimals. */
132
- export const RECORD_EPS = 1e-3;
133
-
134
- /** The default tolerances of the hard rules. Each record writes its tolerances in its top-level field `tolerance`. */
135
- export const DEFAULT_TOLERANCE: Readonly<Tolerance> = Object.freeze({ overlap: 0.001, through: 0.5 });
2
+ // Since 0.2.0, the types and the shared values come from `@mark1russell7/layout-contract`. This file adds the packer names.
3
+
4
+ import { marginSides, turnBox, type Item, type Sides } from "@mark1russell7/layout-contract";
5
+
6
+ export {
7
+ DEFAULT_TOLERANCE,
8
+ EPS,
9
+ RECORD_EPS,
10
+ checkInput,
11
+ turnPoint,
12
+ turnPort,
13
+ turnRegion,
14
+ type Item,
15
+ type LayoutContainer,
16
+ type Margin,
17
+ type Obstacle,
18
+ type PackInput,
19
+ type PackOutput,
20
+ type Placement,
21
+ type Port,
22
+ type Region,
23
+ type Side,
24
+ type Sides,
25
+ type StageTrace,
26
+ type Tolerance,
27
+ } from "@mark1russell7/layout-contract";
136
28
 
137
29
  /** This function gives the margin of an item on each side. A number is the same margin on each side. */
138
- export function marginOf(item: Pick<Item, "margin">): Margin {
139
- const m = item.margin ?? 0;
140
- if (typeof m === "number") return { top: m, right: m, bottom: m, left: m };
30
+ export function marginOf(item: Pick<Item, "margin">): Sides {
31
+ const m = marginSides(item.margin);
141
32
  return { top: m.top, right: m.right, bottom: m.bottom, left: m.left };
142
33
  }
143
34
 
144
- /** The side of a port after a turn of 90 degrees clockwise. */
145
- const TURNED_SIDE = { top: "right", right: "bottom", bottom: "left", left: "top" } as const;
146
-
147
- /** This function gives the point `px`, `py` of an item of height `h` after a turn of 90 degrees clockwise. */
148
- export function turnPoint(px: number, py: number, h: number): [number, number] {
149
- return [h - py, px];
150
- }
151
-
152
- /** This function turns a port of an item of height `h` by 90 degrees clockwise. The side turns from top to right. */
153
- export function turnPort(port: Port, h: number): Port {
154
- const turned: Port = { id: port.id, side: TURNED_SIDE[port.side] };
155
- if (port.x !== undefined && port.y !== undefined) {
156
- const [x, y] = turnPoint(port.x, port.y, h);
157
- turned.x = x;
158
- turned.y = y;
159
- } else if (port.x !== undefined) {
160
- // Only x is set: x becomes the new y, and the router chooses the new x
161
- turned.y = port.x;
162
- } else if (port.y !== undefined) {
163
- // Only y is set: h - y becomes the new x, and the router chooses the new y
164
- turned.x = h - port.y;
165
- }
166
- return turned;
167
- }
168
-
169
- /** This function turns a region relative to an item of height `h` by 90 degrees clockwise. */
170
- export function turnRegion(region: Region, h: number): Region {
171
- switch (region.kind) {
172
- case "rect":
173
- return { kind: "rect", x: h - region.y - region.h, y: region.x, w: region.h, h: region.w };
174
- case "circle": {
175
- const [cx, cy] = turnPoint(region.cx, region.cy, h);
176
- return { kind: "circle", cx, cy, r: region.r };
177
- }
178
- case "ellipse": {
179
- const [cx, cy] = turnPoint(region.cx, region.cy, h);
180
- return { kind: "ellipse", cx, cy, rx: region.ry, ry: region.rx };
181
- }
182
- case "polygon": {
183
- const turnRing = (ring: [number, number][]): [number, number][] => ring.map(([x, y]) => turnPoint(x, y, h));
184
- const turned: Region = { kind: "polygon", points: turnRing(region.points) };
185
- if (region.holes) turned.holes = region.holes.map(turnRing);
186
- return turned;
187
- }
188
- }
189
- }
190
-
191
35
  /**
192
36
  * This function gives an item after a turn of 90 degrees clockwise, with the y axis down (decision 1 of
193
37
  * `docs/PACKER.md`). The width and the height change places. The top-left corner, the id and the other fields stay.
194
38
  * The ports, the shape and the margin turn with the item. The function does not change its argument.
39
+ * It is `turnBox` of the contract.
195
40
  */
196
41
  export function turnItem(item: Item): Item {
197
- const turned: Item = { ...item, w: item.h, h: item.w };
198
- if (item.ports) turned.ports = item.ports.map((p) => turnPort(p, item.h));
199
- if (item.shape) turned.shape = turnRegion(item.shape, item.h);
200
- if (item.margin !== undefined && typeof item.margin !== "number") {
201
- const m = item.margin;
202
- turned.margin = { top: m.left, right: m.top, bottom: m.right, left: m.bottom };
203
- }
204
- return turned;
42
+ return turnBox(item);
205
43
  }
package/src/convert.ts CHANGED
@@ -10,21 +10,17 @@ import type { Rect } from "./rect.ts";
10
10
  */
11
11
  export function fromRects<T>(rects: readonly Rect<T>[], outer: Rect<T>): PackInput {
12
12
  const fixed = outer.fixedSize ? "size" : outer.fixedWidth ? "width" : "none";
13
- const container: PackInput["container"] = { fixed };
14
- if (fixed !== "none") container.w = outer.size.x;
15
- if (fixed === "size") container.h = outer.size.y;
16
- if (outer.position.x !== 0 || outer.position.y !== 0) {
17
- container.shape = { kind: "rect", x: outer.position.x, y: outer.position.y, w: outer.size.x, h: outer.size.y };
18
- }
19
- const items = rects.map((r, i): Item => {
20
- const item: Item = { id: String(i), w: r.size.x, h: r.size.y };
21
- if (r.locked) {
22
- item.locked = true;
23
- item.x = r.position.x;
24
- item.y = r.position.y;
25
- }
26
- return item;
27
- });
13
+ const container: PackInput["container"] = {
14
+ fixed,
15
+ ...(fixed === "none" ? {} : { w: outer.size.x }),
16
+ ...(fixed === "size" ? { h: outer.size.y } : {}),
17
+ ...(outer.position.x !== 0 || outer.position.y !== 0
18
+ ? { shape: { kind: "rect", x: outer.position.x, y: outer.position.y, w: outer.size.x, h: outer.size.y } as const }
19
+ : {}),
20
+ };
21
+ const items = rects.map(
22
+ (r, i): Item => ({ id: String(i), w: r.size.x, h: r.size.y, ...(r.locked ? { locked: true, x: r.position.x, y: r.position.y } : {}) }),
23
+ );
28
24
  return { container, items };
29
25
  }
30
26
 
package/src/corpus.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // The manifest of a corpus: `layout-corpus/1` of `docs/FORMAT.md`.
2
2
 
3
3
  import { generator } from "./generators.ts";
4
- import type { CorpusCell, GeneratorParams, LayoutInput } from "./layout-input.ts";
4
+ import type { CorpusCell, GeneratedInput, GeneratorParams } from "./layout-input.ts";
5
5
 
6
6
  /** One spec of a corpus: a generator, its parameters and its seeds. */
7
7
  export interface CorpusSpec {
@@ -34,7 +34,7 @@ export interface CorpusManifest {
34
34
  /** A corpus: the manifest and the input files, in the order of the specs and the seeds. */
35
35
  export interface Corpus {
36
36
  manifest: CorpusManifest;
37
- inputs: LayoutInput[];
37
+ inputs: GeneratedInput[];
38
38
  }
39
39
 
40
40
  /**
@@ -43,7 +43,7 @@ export interface Corpus {
43
43
  */
44
44
  export function corpus(name: string, specs: readonly CorpusSpec[]): Corpus {
45
45
  const manifest: CorpusManifest = { schema: "layout-corpus/1", corpus: name, specs: [], inputs: [] };
46
- const inputs: LayoutInput[] = [];
46
+ const inputs: GeneratedInput[] = [];
47
47
  const ids = new Set<string>();
48
48
  for (const spec of specs) {
49
49
  const gen = generator(spec.generator);