trueskill/src/FactorGraphs/FactorGraphLayer.php

<?php

declare(strict_types=1);

namespace DNW\Skills\FactorGraphs;

use DNW\Skills\FactorGraphs\ScheduleSequence;
use DNW\Skills\TrueSkill\TrueSkillFactorGraph;

abstract class FactorGraphLayer
{
    /**
     * @var Factor[] $localFactors
     */
    private array $localFactors = [];

    /**
     * @var array<int,array<int,Variable>>
     */
    private array $outputVarGroups = [];

    /**
     * @var array<int,array<int,Variable>>
     */
    private array $inputVariablesGroups = [];

    public function __construct(private readonly TrueSkillFactorGraph $parentFactorGraph)
    {
    }

    /**
     * @return array<int,array<int,Variable>>
     */
    protected function getInputVariablesGroups(): array
    {
        return $this->inputVariablesGroups;
    }

    public function getParentFactorGraph(): TrueSkillFactorGraph
    {
        return $this->parentFactorGraph;
    }

    /**
     * This reference is still needed
     *
     * @return array<int,array<int,Variable>>
     */
    public function &getOutputVariablesGroups(): array
    {
        return $this->outputVarGroups;
    }

    /**
     * @return Factor[]
     */
    public function getLocalFactors(): array
    {
        return $this->localFactors;
    }

    /**
     * @param array<int,array<int,Variable>> $value
     */
    public function setInputVariablesGroups(array $value): void
    {
        $this->inputVariablesGroups = $value;
    }

    /**
     * @param Schedule[] $itemsToSequence
     */
    protected function scheduleSequence(array $itemsToSequence): ScheduleSequence
    {
        return new ScheduleSequence($itemsToSequence);
    }

    protected function addLayerFactor(Factor $factor): void
    {
        $this->localFactors[] = $factor;
    }

    abstract public function buildLayer(): void;

    public function createPriorSchedule(): ?ScheduleSequence
    {
        return NULL;
    }

    public function createPosteriorSchedule(): ?ScheduleSequence
    {
        return NULL;
    }
}