ModelBuilder

Compilation context that creates variables, constraints, and objectives and emits a SolverRequest for the Python CP-SAT solver service.

​

Constructors

​

new ModelBuilder(config)

• config: ModelBuilderConfig<CpsatRuleRegistry, AnyCpsatRuleConfigEntry>

Returns: ModelBuilder

​

Properties

​

Methods

​

addAtMostOne(vars)

• vars: string[]

​

addBoolAnd(vars)

• vars: string[]

​

addBoolOr(vars)

• vars: string[]

​

addExactlyOne(vars)

• vars: string[]

​

addImplication(ifVar, thenVar)

• ifVar: string
• thenVar: string

​

addLinear(terms, op, rhs, id?)

• terms: object[]
• op: "<=" | ">=" | "=="
• rhs: number
• id?: string

​

addNoOverlap(intervals)

• intervals: string[]

​

addPenalty(varName, weight)

• varName: string
• weight: number

​

addSoftLinear(terms, op, rhs, penalty, id?, stage?)

• terms: object[]
• op: "<=" | ">="
• rhs: number
• penalty: number
• id?: string
• stage?: string

​

assignment(memberId, patternId, day)

Returns the aggregate shift assignment variable for a member, pattern, and day.

• memberId: string
• patternId: string
• day: SchedulingDay

Returns: string

​

boolVar(name)

• name: string

Returns: string

​

calculateCost(assignments)

• assignments: readonly ShiftAssignment[]

Returns: CostContribution

​

canAssign(member, pattern)

• member: SchedulingMember
• pattern: ShiftPattern

Returns: boolean

​

compile()

Returns: CompilationResult

​

endMinutes(pattern, day)

• pattern: ShiftPattern
• day: SchedulingDay

Returns: number

​

getCompiledInstructions()

Returns model-backed coverage and rule instructions in explanation order. Returns: readonly CompiledModelInstruction[]

​

getConstraintTraces()

Returns: readonly ConstraintTrace[]

​

getInstructionResults()

Returns: ReadonlyMap<string, readonly InstructionResult[]>

​

intervalVar(name, start, end, size, presenceVar?)

• name: string
• start: number
• end: number
• size: number
• presenceVar?: string

Returns: string

​

intVar(name, min, max)

• name: string
• min: number
• max: number

Returns: string

​

membersForCoverage(cov)

Returns team members who can satisfy a coverage requirement. Matching logic:

• If only roles: must have ANY of those roles (OR)
• If only skills: must have ALL specified skills (AND)
• If both: must have a matching role AND ALL specified skills
• cov: CoverageRequirement

Returns: SchedulingMember[]

​

membersWithRole(roleId)

• roleId: string

Returns: SchedulingMember[]

​

patternAvailableOnDay(pattern, day)

Checks if a shift pattern can be used on a specific day. Returns false if the pattern has dayOfWeek restrictions that exclude this day.

• pattern: ShiftPattern
• day: SchedulingDay

Returns: boolean

​

patternDuration(patternId)

• patternId: string

Returns: number

​

shiftActive(patternId, day)

• patternId: string
• day: SchedulingDay

Returns: string

​

startMinutes(pattern, day)

• pattern: ShiftPattern
• day: SchedulingDay

Returns: number