SlotFlow API Documentation

GreedyFlowSolver
in package
implements SolverInterface

FinalYes

Executes flows with deterministic greedy semantics.

Tags
psalm-import-type

TSlotPattern from SlotSpace

Table of Contents

Interfaces

SolverInterface
Executes one flow against one quantity state.

Methods

execute()  : MovementResult
allocateEdges()  : array<int, AllocationDecision>
applyMovement()  : MovementEvent
filterEdges()  : array<int, MovementEdge>
limitMovable()  : int|float
orderEdges()  : array<int, MovementEdge>
resolvePatternParameters()  : string|array<string|int, mixed>|null
resolveStepEdges()  : array<int, MovementEdge>
resolveStringParameter()  : string

Methods

execute()

public execute(QuantityState $state, SlotSpace $space, Flow $flow, int|float $quantity[, mixed $subject = null ][, array<string|int, mixed> $appContext = [] ][, array<string, scalar|null> $params = [] ]) : MovementResult
Parameters
$state : QuantityState
$space : SlotSpace
$flow : Flow
$quantity : int|float
$subject : mixed = null
$appContext : array<string|int, mixed> = []
$params : array<string, scalar|null> = []
Attributes
#[Override]
Return values
MovementResult

limitMovable()

private limitMovable(QuantityState $state, MovementEdge $edge, int|float $requested, int|float $quantity, FlowStep $step, mixed $subject, array<string|int, mixed> $context) : int|float
Parameters
$state : QuantityState
$edge : MovementEdge
$requested : int|float
$quantity : int|float
$step : FlowStep
$subject : mixed
$context : array<string|int, mixed>
Return values
int|float

resolvePatternParameters()

private resolvePatternParameters(string|array<int|string, string|null>|null $pattern, array<string|int, mixed> $context) : string|array<string|int, mixed>|null
Parameters
$pattern : string|array<int|string, string|null>|null
$context : array<string|int, mixed>
Tags
psalm-param

TSlotPattern $pattern

psalm-return

TSlotPattern

Return values
string|array<string|int, mixed>|null

resolveStringParameter()

private resolveStringParameter(non-empty-string $value, array<string, string> $params) : string
Parameters
$value : non-empty-string
$params : array<string, string>
Tags
psalm-return

non-empty-string

Return values
string

        
On this page

Search results