spreadlab/internal/engine/scenario.go
Justin Visser 45fdf7ffa4 engine: Config, scenario runner, golden regression tests; demo CLI
Config is the single source of truth for parameters (TS types will be
generated from these structs in milestone 2); all randomness flows from
its three seeds, so identical configs give identical results. Golden
test pins the default world: none=99/120 (82%), random=70/120 (58%),
most-connected=7/120 (6%). Same story as the prototype's 85/64/8 with
different dice; the ordering and the collapse are asserted explicitly,
exact Python numbers are out of scope by design.
'go run ./cmd/spreadlab' prints the three-scenario comparison.
This completes milestone 1 (engine ported, parameterised, tested).
2026-06-10 12:24:47 +02:00

99 lines
3.7 KiB
Go

package engine
import "fmt"
// Strategy selects who gets educated.
type Strategy string
const (
StrategyNone Strategy = "none"
StrategyRandom Strategy = "random"
StrategyMostConnected Strategy = "most-connected"
)
// Config fully describes one simulation world. It is the single source of
// truth for parameters: API and frontend types will be generated from the
// structs in this file, never redefined by hand. Identical configs produce
// identical results; all randomness flows from the three seeds.
type Config struct {
NumStudents int `json:"numStudents"`
EdgesPerNode int `json:"edgesPerNode"` // attachment edges per new student (network density)
TriangleProb float64 `json:"triangleProb"` // chance to close a friend-of-a-friend triangle
ForwardProb float64 `json:"forwardProb"` // chance a student forwards the fake along an edge
NumEducated int `json:"numEducated"` // students the education program reaches
Origin int `json:"origin"` // student who first posts the fake
GraphSeed uint64 `json:"graphSeed"`
ThresholdSeed uint64 `json:"thresholdSeed"`
EducationSeed uint64 `json:"educationSeed"` // used by the random strategy only
}
// DefaultConfig mirrors the Python prototype: a school year of 120
// students, educate 30% of them, forwarding probability 0.38.
func DefaultConfig() Config {
return Config{
NumStudents: 120,
EdgesPerNode: 3,
TriangleProb: 0.45,
ForwardProb: 0.38,
NumEducated: 36,
Origin: 0,
GraphSeed: 17,
ThresholdSeed: 2,
EducationSeed: 1,
}
}
// Result is the outcome of one scenario run.
type Result struct {
Strategy Strategy `json:"strategy"`
Educated []int `json:"educated"`
ReachedAtRound []int `json:"reachedAtRound"` // per node; -1 means never reached
NumReached int `json:"numReached"`
NumRounds int `json:"numRounds"`
ReachedPct float64 `json:"reachedPct"`
}
// RunScenario builds the world the config describes (network plus edge
// thresholds), picks the educated students per strategy, and runs the
// cascade. Scenarios with the same config share the same world, so
// comparing strategies compares only the lever.
func RunScenario(config Config, strategy Strategy) (Result, error) {
if config.ForwardProb < 0 || config.ForwardProb > 1 {
return Result{}, fmt.Errorf("scenario: need 0 <= forwardProb <= 1, got %v", config.ForwardProb)
}
if config.Origin < 0 || config.Origin >= config.NumStudents {
return Result{}, fmt.Errorf("scenario: origin %d outside 0..%d", config.Origin, config.NumStudents-1)
}
if config.NumEducated < 0 {
return Result{}, fmt.Errorf("scenario: need numEducated >= 0, got %d", config.NumEducated)
}
graph, err := HolmeKim(config.NumStudents, config.EdgesPerNode, config.TriangleProb, newRand(config.GraphSeed))
if err != nil {
return Result{}, err
}
thresholds := NewEdgeThresholds(graph, newRand(config.ThresholdSeed))
var educated []int
switch strategy {
case StrategyNone:
// nobody educated; the baseline
case StrategyRandom:
educated = EducateRandom(graph, config.Origin, config.NumEducated, newRand(config.EducationSeed))
case StrategyMostConnected:
educated = EducateMostConnected(graph, config.Origin, config.NumEducated)
default:
return Result{}, fmt.Errorf("scenario: unknown strategy %q", strategy)
}
cascade := RunCascade(graph, config.Origin, config.ForwardProb, educated, thresholds)
return Result{
Strategy: strategy,
Educated: educated,
ReachedAtRound: cascade.ReachedAtRound,
NumReached: cascade.NumReached,
NumRounds: cascade.NumRounds,
ReachedPct: 100 * float64(cascade.NumReached) / float64(config.NumStudents),
}, nil
}