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: 
<?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\Type\Number\Complex\ComplexType;
use Chippyash\Type\Number\Complex\ComplexTypeFactory;
use Chippyash\Type\Number\Rational\RationalType;
use Chippyash\Type\Number\Rational\RationalTypeFactory;
use Chippyash\Math\Matrix\Exceptions\MathMatrixException;
use Chippyash\Type\Number\IntType;

/**
 * Static factory to create the various standard numerical matrices
 *
 */
abstract class MatrixFactory
{

    /**
     *
     * @param string $type
     * @param array $data
     * @return \Chippyash\Math\Matrix\NumericMatrix
     */
    public static function create($type, array $data)
    {
        switch (strtolower($type)) {
            case 'complex':
                return self::createComplex($data);
            case 'rational':
                return self::createRational($data);
            case 'numeric':
            default:
                return self::createNumeric($data);
        }
    }

    /**
     * Create and return a complex number matrix
     * $data elements are either:
     *  - a ComplexType
     *  - string representations of complex number
     *  - a 2 item array representing r & i e.g. [2,-4] = '2-4i'
     *
     * @param array $data
     *
     * @return \Chippyash\Math\Matrix\ComplexMatrix
     *
     * @throws \Chippyash\Math\Matrix\Exceptions\MathMatrixException
     */
    public static function createComplex(array $data)
    {
        foreach ($data as &$row) {
            foreach ($row as &$item) {
                if (!$item instanceof ComplexType) {
                    if (is_array($item) && count($item) == 2) {
                        $item = ComplexTypeFactory::create($item[0], $item[1]);
                    } elseif (is_string($item)) {
                        try {
                            $item = ComplexTypeFactory::fromString($item);
                        } catch (\InvalidArgumentException $e) {
                            throw new MathMatrixException('Invalid item type for Complex Matrix');
                        }
                    } else {
                        throw new MathMatrixException('Invalid item type for Complex Matrix');
                    }
                }
            }
        }
        return new ComplexMatrix($data);
    }

    /**
     * Create and return a rational number matrix
     * $data elements are either:
     *  - a RationalType
     *  - string representations of rational number
     *  - a PHP float
     *  - a 2 item array representing numerator & denominator e.g. [2,-4] = '-2/4'
     *
     * @param array $data
     *
     * @return \Chippyash\Math\Matrix\RationalMatrix
     *
     * @throws \Chippyash\Math\Matrix\Exceptions\MathMatrixException
     */
    public static function createRational(array $data)
    {
        foreach ($data as &$row) {
            foreach ($row as &$item) {
                if (!$item instanceof RationalType) {
                    if (is_array($item) && count($item) == 2) {
                        $item = RationalTypeFactory::create($item[0], $item[1]);
                    } elseif (is_string($item)) {
                        try {
                            $item = RationalTypeFactory::fromString($item);
                        } catch (\InvalidArgumentException $e) {
                            throw new MathMatrixException('Invalid item type for Rational Matrix');
                        }
                    } elseif(is_float($item)) {
                        $item = RationalTypeFactory::fromFloat($item);
                    } else {
                        throw new MathMatrixException('Invalid item type for Rational Matrix');
                    }
                }
            }
        }

        return new RationalMatrix($data);
    }

    /**
     * Create and return a numeric value matrix
     *
     * @param array $data
     * @return \Chippyash\Math\Matrix\NumericMatrix
     */
    public static function createNumeric(array $data)
    {
        return new NumericMatrix($data);
    }

    /**
     * Construct a complete matrix whose entries are a result of a function
     *
     * The function must accept two parameters
     *  e.g. $function($row, $col) {return $row - $col;}
     *
     * $row and $col are 1 based
     *
     * @param callable $fn
     * @param IntType $rows Number of required rows
     * @param IntType $cols Number or required columns
     * @param string $type ['numeric'|'rational'|'complex']
     *
     * @return \Chippyash\Math\Matrix\ComplexMatrix|\Chippyash\Math\Matrix\NumericMatrix|\Chippyash\Math\Matrix\RationalMatrix
     *
     * @throws \InvalidArgumentException
     */
    public static function createFromFunction(callable $fn, IntType $rows, IntType $cols, $type = 'numeric')
    {
        if ($rows() < 1) {
            throw new \InvalidArgumentException('$rows must be >= 1');
        }
        if ($cols() < 1) {
            throw new \InvalidArgumentException('$cols must be >= 1');
        }

        $source = array();
        $rc = $rows();
        $cc = $cols();
        for ($r = 0; $r < $rc; $r++) {
            for ($c = 0; $c < $cc; $c++) {
                $source[$r][$c] = $fn($r + 1, $c + 1);
            }
        }

        return self::create($type, $source);
    }
    
    /**
     * Create a matrix representation of a complex number
     * For z = a+bi
     * Returns [[a, -b]
     *          [b, a]]
     * 
     * @param \Chippyash\Type\Number\Complex\ComplexType $c
     * @return \Chippyash\Math\Matrix\RationalMatrix
     */
    public static function createFromComplex(ComplexType $c)
    {
        $a = clone $c->r();
        $b = clone $c->i();
        $b2 = clone $c->i();
        $bi = new RationalType($b2->numerator()->negate(), $b->denominator());
        return self::createRational([[$a, $bi],[$b, $a]]);
    }
}
Chippyash Math Matrix API documentation generated by ApiGen