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: 
<?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\Attribute;

use Chippyash\Matrix\Interfaces\AttributeInterface;
use Chippyash\Matrix\Matrix;
use Chippyash\Math\Matrix\NumericMatrix;
use Chippyash\Type\Interfaces\NumericTypeInterface;
use Chippyash\Type\Number\Complex\ComplexType;

/**
 * Is matrix an identity matrix?
 * Can only be applied to numeric and complex matrices
 */
class IsIdentity implements AttributeInterface
{

    /**
     * Does the matrix have this attribute
     * @link http://en.wikipedia.org/wiki/Identity_matrix
     *
     * @param Matrix $mA
     * @return boolean
     */
    public function is(Matrix $mA)
    {
        if (!$mA instanceof NumericMatrix) {
            return false;
        }
        $rows = $mA->rows();
        $cols = $mA->columns();
        $data = $mA->toArray();
        for ($r = 0; $r < $rows; $r++) {
            for ($c = 0; $c < $cols; $c++) {
                $item = $this->checkItem($data[$r][$c]);
                //diagonal == 1
                if (($r == $c) && $item != 1) {
                    return false;
                //non-diagonal == 0
                } elseif (($r != $c) && $item != 0) {
                    return false;
                }
            }
        }

        return true;
    }

    protected function checkItem($item)
    {
        if ($item instanceof ComplexType) {
            if ($item() == '1+0i') {
                return 1;
            } elseif ($item->isZero()) {
                return 0;
            } else {
                return -1;
            }
        }
        //any other numericType will caste down as required
        return $item();
    }
}
Chippyash Math Matrix API documentation generated by ApiGen