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: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 
<?php
/*
 * Math-Matrix library
 *
 * @author Ashley Kitson <akitson@zf4.biz>
 * @copyright Ashley Kitson, UK, 2014
 * @licence GPL V3 or later : http://www.gnu.org/licenses/gpl.html
 * @link http://en.wikipedia.org/wiki/Matrix_(mathematics)
 */
namespace Chippyash\Math\Matrix;

use Chippyash\Matrix\Matrix;
use Chippyash\Math\Matrix\Traits\ConvertNumberToNumeric;
use Chippyash\Math\Matrix\Exceptions\MathMatrixException;
use Chippyash\Math\Matrix\Interfaces\ComputatationInterface;
use Chippyash\Math\Matrix\Interfaces\DerivativeInterface;
use Chippyash\Math\Matrix\Interfaces\DecompositionInterface;
use Chippyash\Matrix\Interfaces\TransformationInterface;
use Chippyash\Type\Number\Rational\RationalTypeFactory;
use Chippyash\Type\TypeFactory;
use Chippyash\Type\Interfaces\NumericTypeInterface;
use Chippyash\Math\Type\Comparator;

/**
 * Construct a matrix whose entries are numeric, i.e int, float, IntType,
 * FloatType or RationalType
 *
 * On construction PHP native ints are converted to IntType and native
 * float types are converted to RationalType
 *
 */
class NumericMatrix extends Matrix
{
    use ConvertNumberToNumeric;

    const NS_NUMERIC_ATTRIBUTE = 'Chippyash\Math\Matrix\Attribute\Is';
    const NS_COMPUTATION = 'Chippyash\Math\Matrix\Computation\\';
    const NS_NTRANSFORMATION = 'Chippyash\Math\Matrix\Transformation\\';
    const NS_DERIVATIVE = 'Chippyash\Math\Matrix\Derivative\\';
    const NS_DECOMPOSITION = 'Chippyash\Math\Matrix\Decomposition\\';

    /**
     * Construct a complete Matrix with all entries set to Chippyash/Type
     * Takes a source matrix or array (which can be incomplete and converts each
     * entry to Chippyash/Type), setting a default value if entry does not exist.
     *
     * If a NumericMatrix is supplied as $source, the data is cloned into the Matrix
     * with no further checks.
     *
     * @param NumericMatrix|array $source Array to initialise the matrix with
     * @param mixed $normalizeDefault Value to set missing vertices
     * @throws \Chippyash\Math\Matrix\Exceptions\MathMatrixException
     */
    public function __construct($source, $normalizeDefault = 0)
    {
        if ($source instanceof self) {
            $this->store($source->toArray());
            return;
        }

        if (is_array($source)) {
            if (is_int($normalizeDefault)) {
                $default = TypeFactory::createInt($normalizeDefault);
            } elseif (is_float($normalizeDefault)) {
                $default = RationalTypeFactory::fromFloat($normalizeDefault);
            } elseif (!$normalizeDefault instanceof NumericTypeInterface) {
                throw new MathMatrixException('NumericMatrix expects numeric default value');
            } else {
                $default = $normalizeDefault;
            }
            parent::__construct($source, false, true, $default);
        } else {
            throw new MathMatrixException('NumericMatrix expects NumericMatrix or array as source data');
        }
    }

    /**
     * Raw form of is() method. You can use this to test for attributes
     * not supplied with the library by passing in $attribute conforming to
     * AttributeInterface.  If it's something you think is important , consider
     * contributing it to the library.
     *
     * @extendAncestor
     *
     * @param string|AttributeInterface $attribute
     *
     * @return boolean
     *
     * @throws NotAnAttributeInterfaceException
     * @throws \BadMethodCallException
     */
    public function test($attribute)
    {
        if (is_string($attribute)) {
            $attribute = ucfirst(strtolower($attribute));
            $class = self::NS_NUMERIC_ATTRIBUTE . $attribute;
            if (class_exists($class)) {
                $obj = new $class();
            } else {
                //let parent try to find the class
                return parent::test($attribute);
            }
        } else {
            $obj = $attribute;
        }

        //pass object to parent for testing
        return parent::test($obj);
    }

    /**
     * Carry out a computation with this matrix as first argument and an
     * optional second argument
     *
     * @param \Chippyash\Math\Matrix\Interfaces\ComputationInterface $computation
     * @param mixed $extra
     * @return \Chippyash\Math\Matrix\NumericMatrix
     */
    public function compute(ComputatationInterface $computation, $extra = null)
    {
        return $computation->compute($this, $extra);
    }

    /**
     * Find a derivative of this matrix as first argument and an
     * optional second argument
     *
     * @param \Chippyash\Math\Matrix\Interfaces\DerivativeInterface $derivative
     * @param mixed $extra
     * @return numeric
     */
    public function derive(DerivativeInterface $derivative, $extra = null)
    {
        return $derivative->derive($this, $extra);
    }

    /**
     * Decompose this matrix
     *
     * @param \Chippyash\Math\Matrix\Interfaces\DecompositionInterface $decomposition
     * @param mixed $extra
     * @return \Chippyash\Math\Matrix\Interfaces\DecompositionInterface
     */
    public function decompose(DecompositionInterface $decomposition, $extra = null)
    {
        return $decomposition->decompose($this, $extra);
    }

    /**
     *
     * @param \Chippyash\Matrix\Interfaces\TransformationInterface $transformation
     * @param mixed $extra
     *
     * @return NumericMatrix
     */
    public function transform(TransformationInterface $transformation, $extra = null)
    {
        return new self(parent::transform($transformation, $extra)->toArray());
    }

    /**
     * Invokable interface - allows object to be called as function
     * Proxies to compute e.g.
     * $matrix("Add\Matrix", $mB)
     * Proxies to transform e.g.
     * $matrix("Invert")
     * Proxies to derive e.g.
     * $matrix("Trace")
     *
     * @overideAncestor
     *
     * @param string $operationName Name of operation to perform
     * @param mixed $extra Additional parameter required by the operation
     *
     * @return \Chippyash\Math\Matrix\NumericMatrix
     *
     * @throws \InvalidArgumentException
     */
    public function __invoke()
    {
        //argument arbitrage
        $numArgs = func_num_args();
        if ($numArgs == 1) {
            $operationName = func_get_arg(0);
            $extra = null;
        } elseif($numArgs == 2) {
            $operationName = func_get_arg(0);
            $extra = func_get_arg(1);
        } else {
            throw new \InvalidArgumentException(self::ERR_INVALID_INVOKE_ARG);
        }

        $cName = self::NS_COMPUTATION . $operationName;
        if (class_exists($cName, true)) {
            return $this->compute(new $cName(), $extra);
        }

        //Numeric transformations
        $tName = self::NS_NTRANSFORMATION . $operationName;
        if (class_exists($tName, true)) {
            return $this->transform(new $tName(), $extra);
        }

        $dName = self::NS_DERIVATIVE . $operationName;
        if (class_exists($dName, true)) {
            return $this->derive(new $dName(), $extra);
        }

        $dcName = self::NS_DECOMPOSITION . $operationName;
        if (class_exists($dcName, true)) {
            return $this->decompose(new $dcName(), $extra);
        }

        //parent transformations
        $tName = self::NS_TRANSFORMATION . $operationName;
        if (class_exists($tName, true)) {
            return $this->transform(new $tName(), $extra);
        }

        //else
        throw new \InvalidArgumentException(self::ERR_INVALID_OP_NAME);
    }

    /**
     * Check equality of each matrix entry
     * Also check that matrices are same type if $strict
     *
     * @override ancestor
     *
     * @param \Chippyash\Matrix\Matrix $mB
     * @param boolean $strict
     *
     * @return boolean
     */
    protected function checkEntryEquality(Matrix $mB, $strict)
    {
        if ($strict) {
            if (get_class($this) !== get_class($mB)) {
                return false;
            }
        }

        $dA = $this->toArray();
        $dB = $mB->toArray();
        $m = $this->rows();
        $n = $this->columns();
        $comp = new Comparator();

        for ($i=0; $i<$m; $i++) {
            for ($j=0; $j<$n; $j++) {
                if ($strict) {
                    if ($dA[$i][$j] !== $dB[$i][$j]) {
                        return false;
                    }
                } else {
                    if ($comp->neq($dA[$i][$j], $dB[$i][$j])) {
                        return false;
                    }
                }
            }
        }

        return true;
    }

    /**
     * Store the data converting to equivalent strong types
     *
     * @param array $data
     *
     * @return void
     *
     * @throws \Chippyash\Math\Matrix\Exceptions\MathMatrixException
     */
    protected function store(array $data) {
        foreach ($data as &$row) {
            foreach ($row as &$item) {
                $item = $this->convertNumberToNumeric($item);
            }
        }
        $this->data = $data;
    }
}
Chippyash Math Matrix API documentation generated by ApiGen