@graphty/layout / index / FruchtermanReingoldOptions

Interface: FruchtermanReingoldOptions

Defined in: simulation/types.ts:40

Design 9.3 FruchtermanReingoldOptions.

Extends

• CommonLayoutOptions.SimulationOptions

Properties

center?

readonly optional center?: ArrayLike<number>

Defined in: simulation/types.ts:7

Inherited from

CommonLayoutOptions.center

---

cooling?

readonly optional cooling?: "linear" | "adaptive"

Defined in: simulation/types.ts:51

The cooling schedule (default "linear"). "linear": the temperature falls from 0.1 to 0 over iterations steps, so the run always lasts the whole budget. "adaptive": Yifan Hu's step control -- the temperature grows by 1 / 0.9 after five consecutive iterations whose total force energy fell and shrinks by 0.9 whenever it rose (or stayed equal), so the run settles on its own, usually in a few hundred iterations whatever the graph size; iterations is then only a cap, 10,000 when not given, and reheat() restarts the controller at 0.1. The CPU and the GPU simulations run the same rule with the same constants.

---

dim?

readonly optional dim?: 2 | 3

Defined in: simulation/types.ts:5

Inherited from

CommonLayoutOptions.dim

---

fixed?

readonly optional fixed?: string | U32 | null

Defined in: simulation/types.ts:53

A node mask (the bool-column bit layout) or the name of a bool node column with role "fixed".

---

iterations?

readonly optional iterations?: number

Defined in: simulation/types.ts:42

---

iterationsPerStep?

readonly optional iterationsPerStep?: number

Defined in: simulation/types.ts:17

Iterations per step() call; default 1; the element passes its stepMultiplier (design 9.4 item 4).

Inherited from

SimulationOptions.iterationsPerStep

---

k?

readonly optional k?: number | null

Defined in: simulation/types.ts:41

---

maxInFlight?

readonly optional maxInFlight?: number

Defined in: simulation/types.ts:19

GPU simulations only (design 7.19); default 2.

Inherited from

SimulationOptions.maxInFlight

---

scale?

readonly optional scale?: number

Defined in: simulation/types.ts:6

Inherited from

CommonLayoutOptions.scale

---

seed?

readonly optional seed?: number | null

Defined in: simulation/types.ts:8

Inherited from

CommonLayoutOptions.seed

---

settleThreshold?

readonly optional settleThreshold?: number

Defined in: simulation/types.ts:14

Settle when the mean per-node displacement stays below settleThreshold * rmsRadius for settleWindow iterations (design 7.17).

Inherited from

SimulationOptions.settleThreshold

---

settleWindow?

readonly optional settleWindow?: number

Defined in: simulation/types.ts:15

Inherited from

SimulationOptions.settleWindow