Overview

Namespaces

  • Chippyash
    • Math
      • Matrix
        • Attribute
        • Computation
          • Add
          • Div
          • Mul
          • Sub
        • Decomposition
        • Derivative
          • Strategy
            • Determinant
        • Exceptions
        • Formatter
          • DirectedGraph
        • Interfaces
        • Special
        • Traits
        • Transformation
          • Strategy
            • Invert

Classes

  • Chippyash\Math\Matrix\Attribute\IsComplex
  • Chippyash\Math\Matrix\Attribute\IsIdentity
  • Chippyash\Math\Matrix\Attribute\IsMarkov
  • Chippyash\Math\Matrix\Attribute\IsNonsingular
  • Chippyash\Math\Matrix\Attribute\IsNumeric
  • Chippyash\Math\Matrix\Attribute\IsRational
  • Chippyash\Math\Matrix\ComplexMatrix
  • Chippyash\Math\Matrix\Computation\AbstractComputation
  • Chippyash\Math\Matrix\Computation\AbstractEntryWiseComputation
  • Chippyash\Math\Matrix\Computation\Add\Matrix
  • Chippyash\Math\Matrix\Computation\Add\Scalar
  • Chippyash\Math\Matrix\Computation\Div\Entrywise
  • Chippyash\Math\Matrix\Computation\Div\Matrix
  • Chippyash\Math\Matrix\Computation\Div\Scalar
  • Chippyash\Math\Matrix\Computation\Mul\Entrywise
  • Chippyash\Math\Matrix\Computation\Mul\Matrix
  • Chippyash\Math\Matrix\Computation\Mul\Scalar
  • Chippyash\Math\Matrix\Computation\Sub\Matrix
  • Chippyash\Math\Matrix\Computation\Sub\Scalar
  • Chippyash\Math\Matrix\Decomposition\AbstractDecomposition
  • Chippyash\Math\Matrix\Decomposition\GaussJordanElimination
  • Chippyash\Math\Matrix\Decomposition\Lu
  • Chippyash\Math\Matrix\Derivative\AbstractDerivative
  • Chippyash\Math\Matrix\Derivative\Determinant
  • Chippyash\Math\Matrix\Derivative\MarkovWeightedRandom
  • Chippyash\Math\Matrix\Derivative\Strategy\Determinant\Laplace
  • Chippyash\Math\Matrix\Derivative\Strategy\Determinant\Lu
  • Chippyash\Math\Matrix\Derivative\Sum
  • Chippyash\Math\Matrix\Derivative\Trace
  • Chippyash\Math\Matrix\Exceptions\ComputationException
  • Chippyash\Math\Matrix\Exceptions\MathMatrixException
  • Chippyash\Math\Matrix\Exceptions\NoInverseException
  • Chippyash\Math\Matrix\Exceptions\NotMarkovException
  • Chippyash\Math\Matrix\Exceptions\SingularMatrixException
  • Chippyash\Math\Matrix\Exceptions\UndefinedComputationException
  • Chippyash\Math\Matrix\Formatter\AsciiNumeric
  • Chippyash\Math\Matrix\Formatter\DirectedGraph
  • Chippyash\Math\Matrix\Formatter\DirectedGraph\VertexDescription
  • Chippyash\Math\Matrix\FunctionMatrix
  • Chippyash\Math\Matrix\IdentityMatrix
  • Chippyash\Math\Matrix\MatrixFactory
  • Chippyash\Math\Matrix\NumericMatrix
  • Chippyash\Math\Matrix\RationalMatrix
  • Chippyash\Math\Matrix\ShiftMatrix
  • Chippyash\Math\Matrix\Special\AbstractSpecial
  • Chippyash\Math\Matrix\Special\Cauchy
  • Chippyash\Math\Matrix\Special\Chebspsec
  • Chippyash\Math\Matrix\Special\Functional
  • Chippyash\Math\Matrix\Special\Identity
  • Chippyash\Math\Matrix\Special\Ones
  • Chippyash\Math\Matrix\Special\Zeros
  • Chippyash\Math\Matrix\SpecialMatrix
  • Chippyash\Math\Matrix\Transformation\Invert
  • Chippyash\Math\Matrix\Transformation\MarkovRandomWalk
  • Chippyash\Math\Matrix\Transformation\Strategy\Invert\Determinant
  • Chippyash\Math\Matrix\ZeroMatrix

Interfaces

  • Chippyash\Math\Matrix\Interfaces\ComputatationInterface
  • Chippyash\Math\Matrix\Interfaces\DecompositionInterface
  • Chippyash\Math\Matrix\Interfaces\DerivativeInterface
  • Chippyash\Math\Matrix\Interfaces\DeterminantStrategyInterface
  • Chippyash\Math\Matrix\Interfaces\InversionStrategyInterface
  • Chippyash\Math\Matrix\Interfaces\TuningInterface
  • Chippyash\Math\Matrix\Special\SpecialMatrixInterface

Traits

  • Chippyash\Math\Matrix\Traits\AssertMatrixIsNonSingular
  • Chippyash\Math\Matrix\Traits\AssertMatrixIsNumeric
  • Chippyash\Math\Matrix\Traits\AssertMatrixIsRational
  • Chippyash\Math\Matrix\Traits\AssertParameterIsNotString
  • Chippyash\Math\Matrix\Traits\AssertParameterIsRationalMatrix
  • Chippyash\Math\Matrix\Traits\AssertParameterIsRationalNumber
  • Chippyash\Math\Matrix\Traits\ConvertNumberToComplex
  • Chippyash\Math\Matrix\Traits\ConvertNumberToNumeric
  • Chippyash\Math\Matrix\Traits\ConvertNumberToRational
  • Chippyash\Math\Matrix\Traits\CreateCorrectMatrixType
  • Chippyash\Math\Matrix\Traits\CreateCorrectScalarType
  • Overview
  • Namespace
  • Class
  • Tree
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 
<?php
/**
 * Math-Matrix
 *
 * @author Ashley Kitson
 * @copyright Ashley Kitson, 2016, UK
 * @license GPL V3+ See LICENSE.md
 */

namespace Chippyash\Math\Matrix\Derivative;


use Chippyash\Math\Matrix\Exceptions\MathMatrixException;
use Chippyash\Math\Matrix\Exceptions\NotMarkovException;
use Chippyash\Math\Matrix\NumericMatrix;
use Chippyash\Math\Type\Calculator;
use Chippyash\Math\Type\Comparator;
use Chippyash\Type\Interfaces\NumericTypeInterface;
use Chippyash\Type\Number\IntType;
use Chippyash\Type\TypeFactory;
use Assembler\FFor;
use Monad\FTry;

class MarkovWeightedRandom extends AbstractDerivative
{
    /**
     * @var Comparator;
     */
    protected $comp;
    /**
     * @var Calculator
     */
    protected $calc;
    /**
     * @var IntType
     */
    protected $zero;

    /**
     * Find the derivative
     *
     * @param NumericMatrix $mA
     * @param IntType $extra The current row to find the next weighted random row from
     *
     * @throws MathMatrixException
     * @throws NotMarkovException
     *
     * @return IntType
     */
    public function derive(NumericMatrix $mA, $extra = null)
    {
        if (!$mA->is('Markov')) {
            throw new NotMarkovException();
        }

        if (!$extra instanceof IntType) {
            throw new MathMatrixException('The extra parameter is not an IntType');
        }

        $this->comp = new Comparator();
        $this->calc = new Calculator();
        $this->zero = TypeFactory::createInt(0);

        return $this->nextWeightedRandom($mA, $extra);
    }

    /**
     * Returns random key from input array by its weight
     * Array must be specified in [key => weight, ...] form
     *
     * @param NumericMatrix $mA Matrix to process
     * @param NumericTypeInterface $current Chain row to get next pick from
     *
     * @return IntType Random key to matrix row
     *
     * @throws MathMatrixException
     */
    protected function nextWeightedRandom(NumericMatrix $mA, NumericTypeInterface $current)
    {
        $array = FFor::create(['row' => $current, 'mA' => $mA])
            ->slice(function($row, $mA) {$t = $mA('Rowslice', [$row()])->toArray(); return array_pop($t);})
            ->array(function($slice) {
                return array_filter(
                    $slice,
                    function ($item) {
                        return $this->comp->neq($this->zero, $item);
                    }
                );
            })
            ->fyield('array');

        if (count($array) <= 1) {
            return TypeFactory::createInt(key($array));
        }
        $sum = (new NumericMatrix([$array]))->derive(new Sum())->asIntType();
        if ($this->comp->lte($sum, $this->zero)) {
            throw new MathMatrixException('Negative or all-zero weights not allowed');
        }

        return $this->getNextRow($sum, $array);;
    }

    /**
     * @param $sum
     * @param $rowArray
     *
     * @return mixed
     *
     * @throws MathMatrixException
     */
    protected function getNextRow($sum, $rowArray)
    {
        return FFor::create(['sum' => $sum, 'rowArray' => $rowArray])
            ->targetWeight(function($sum) {
                return TypeFactory::createInt(mt_rand(1, $sum()));
            })
            ->nextRow(function($targetWeight, $rowArray) {
                foreach ($rowArray as $key => $weight) {
                    if ($this->comp->lt($weight, $this->zero)) {
                        throw new MathMatrixException('Negative weights not allowed');
                    }
                    $targetWeight = $this->calc->sub($targetWeight, $weight);
                    if ($this->comp->lte($targetWeight, $this->zero)) {
                        return TypeFactory::createInt($key + 1);
                    }
                }
            })
            ->fyield('nextRow');
    }
}
Chippyash Math Matrix API documentation generated by ApiGen