Collaboration diagram for Matrix\Matrix:

Public Member Functions
	__construct (array $grid)

	getRows (int $row, int $rowCount=1)
	Return a new matrix as a subset of rows from this matrix, starting at row number $row, and $rowCount rows A $rowCount value of 0 will return all rows of the matrix from $row A negative $rowCount value will return rows until that many rows from the end of the matrix. More...

	getColumns (int $column, int $columnCount=1)
	Return a new matrix as a subset of columns from this matrix, starting at column number $column, and $columnCount columns A $columnCount value of 0 will return all columns of the matrix from $column A negative $columnCount value will return columns until that many columns from the end of the matrix. More...

	dropRows (int $row, int $rowCount=1)
	Return a new matrix as a subset of rows from this matrix, dropping rows starting at row number $row, and $rowCount rows A negative $rowCount value will drop rows until that many rows from the end of the matrix A $rowCount value of 0 will remove all rows of the matrix from $row. More...

	dropColumns (int $column, int $columnCount=1)
	Return a new matrix as a subset of columns from this matrix, dropping columns starting at column number $column, and $columnCount columns A negative $columnCount value will drop columns until that many columns from the end of the matrix A $columnCount value of 0 will remove all columns of the matrix from $column. More...

	getValue (int $row, int $column)
	Return a value from this matrix, from the "cell" identified by the row and column numbers Note that row and column numbers start from 1, not from 0. More...

	rows ()
	Returns a Generator that will yield each row of the matrix in turn as a vector matrix or the value of each cell if the matrix is a column vector. More...

	columns ()
	Returns a Generator that will yield each column of the matrix in turn as a vector matrix or the value of each cell if the matrix is a row vector. More...

	isSquare ()
	Identify if the row and column dimensions of this matrix are equal, i.e. More...

	isVector ()
	Identify if this matrix is a vector i.e. More...

	toArray ()
	Return the matrix as a 2-dimensional array. More...

	solve (Matrix $B)
	Solve A*X = B. More...

	__get (string $propertyName)
	Access specific properties as read-only (no setters) More...

	__call (string $functionName, $arguments)
	Returns the result of the function call or operation. More...

Static Public Member Functions
static	validateRow (int $row)
	Validate that a row number is a positive integer. More...

static	validateColumn (int $column)
	Validate that a column number is a positive integer. More...

Protected Member Functions
	buildFromArray (array $grid)

	validateRowInRange (int $row)
	Validate that a row number falls within the set of rows for this matrix. More...

	validateColumnInRange (int $column)
	Validate that a column number falls within the set of columns for this matrix. More...

Protected Attributes
	$rows

	$columns

	$grid = []

Static Protected Attributes
static	$getters

static	$functions

static	$operations

Detailed Description

Definition at line 42 of file Matrix.php.

Constructor & Destructor Documentation

◆ __construct()

Matrix\Matrix::__construct ( array $grid )

final

Definition at line 53 of file Matrix.php.

    {
        $this->buildFromArray(array_values($grid));
    }

References $grid.

Member Function Documentation

◆ __call()

Matrix\Matrix::__call	(	string	$functionName,
			$arguments
	)

Returns the result of the function call or operation.

Parameters

string	$functionName
mixed[]	$arguments

Returns: Matrix|float

Exceptions

Exception

Definition at line 410 of file Matrix.php.

    {
        $functionName = strtolower(str_replace('_', '', $functionName));
 
        if (in_array($functionName, self::$functions, true) || in_array($functionName, self::$operations, true)) {
            $functionName = "\\" . __NAMESPACE__ . "\\{$functionName}";
            if (is_callable($functionName)) {
                $arguments = array_values(array_merge([$this], $arguments));
                return call_user_func_array($functionName, $arguments);
            }
        }
        throw new Exception('Function or Operation does not exist');
    }

◆ __get()

Matrix\Matrix::__get ( string $propertyName )

Access specific properties as read-only (no setters)

Parameters

string $propertyName

Returns: mixed

Exceptions

Exception

Definition at line 368 of file Matrix.php.

    {
        $propertyName = strtolower($propertyName);
 
        // Test for function calls
        if (in_array($propertyName, self::$getters)) {
            return $this->$propertyName;
        }
 
        throw new Exception('Property does not exist');
    }

◆ buildFromArray()

Matrix\Matrix::buildFromArray ( array $grid )

protected

Definition at line 63 of file Matrix.php.

                                                  : void
    {
        $this->rows = count($grid);
        $columns = array_reduce(
            $grid,
            function ($carry, $value) {
                return max($carry, is_array($value) ? count($value) : 1);
            }
        );
        $this->columns = $columns;
 
        array_walk(
            $grid,
            function (&$value) use ($columns) {
                if (!is_array($value)) {
                    $value = [$value];
                }
                $value = array_pad(array_values($value), $columns, null);
            }
        );
 
        $this->grid = $grid;
    }

References $columns, and $grid.

◆ columns()

Matrix\Matrix::columns ( )

Returns a Generator that will yield each column of the matrix in turn as a vector matrix or the value of each cell if the matrix is a row vector.

Returns: Generator|Matrix[]|mixed[]

Definition at line 297 of file Matrix.php.

                             : Generator
    {
        for ($i = 0; $i < $this->columns; ++$i) {
            yield $i + 1 => ($this->rows == 1)
                ? $this->grid[0][$i]
                : new static(array_column($this->grid, $i));
        }
    }

References $columns, and $i.

Referenced by Matrix\Operators\Multiplication\multiplyMatrix(), and Matrix\Decomposition\LU\solve().

Here is the caller graph for this function:

◆ dropColumns()

Matrix\Matrix::dropColumns	(	int	$column,
		int	$columnCount = `1`
	)

Return a new matrix as a subset of columns from this matrix, dropping columns starting at column number $column, and $columnCount columns A negative $columnCount value will drop columns until that many columns from the end of the matrix A $columnCount value of 0 will remove all columns of the matrix from $column.

Note that column numbers start from 1, not from 0

Parameters

int	$column
int	$columnCount

Returns: static

Exceptions

Exception

Definition at line 241 of file Matrix.php.

                                                                  : Matrix
    {
        $this->validateColumnInRange($column);
        if ($columnCount < 1) {
            $columnCount = $this->columns + $columnCount - $column + 1;
        }
 
        $grid = $this->grid;
        array_walk(
            $grid,
            function (&$row) use ($column, $columnCount) {
                array_splice($row, $column - 1, (int)$columnCount);
            }
        );
 
        return new static($grid);
    }

References $columnCount, $grid, and $row.

◆ dropRows()

Matrix\Matrix::dropRows	(	int	$row,
		int	$rowCount = `1`
	)

Return a new matrix as a subset of rows from this matrix, dropping rows starting at row number $row, and $rowCount rows A negative $rowCount value will drop rows until that many rows from the end of the matrix A $rowCount value of 0 will remove all rows of the matrix from $row.

Note that row numbers start from 1, not from 0

Parameters

int	$row
int	$rowCount

Returns: static

Exceptions

Exception

Definition at line 215 of file Matrix.php.

                                                         : Matrix
    {
        $this->validateRowInRange($row);
        if ($rowCount === 0) {
            $rowCount = $this->rows - $row + 1;
        }
 
        $grid = $this->grid;
        array_splice($grid, $row - 1, (int)$rowCount);
 
        return new static($grid);
    }

References $grid, and $row.

◆ getColumns()

Matrix\Matrix::getColumns	(	int	$column,
		int	$columnCount = `1`
	)

Return a new matrix as a subset of columns from this matrix, starting at column number $column, and $columnCount columns A $columnCount value of 0 will return all columns of the matrix from $column A negative $columnCount value will return columns until that many columns from the end of the matrix.

Note that column numbers start from 1, not from 0

Parameters

int	$column
int	$columnCount

Returns: Matrix

Exceptions

Exception

Definition at line 187 of file Matrix.php.

                                                                 : Matrix
    {
        $column = $this->validateColumnInRange($column);
        if ($columnCount < 1) {
            $columnCount = $this->columns + $columnCount - $column + 1;
        }
 
        $grid = [];
        for ($i = $column - 1; $i < $column + $columnCount - 1; ++$i) {
            $grid[] = array_column($this->grid, $i);
        }
 
        return (new static($grid))->transpose();
    }

References $columnCount, $grid, and $i.

Referenced by Matrix\Operators\Multiplication\multiplyMatrix().

Here is the caller graph for this function:

◆ getRows()

Matrix\Matrix::getRows	(	int	$row,
		int	$rowCount = `1`
	)

Return a new matrix as a subset of rows from this matrix, starting at row number $row, and $rowCount rows A $rowCount value of 0 will return all rows of the matrix from $row A negative $rowCount value will return rows until that many rows from the end of the matrix.

Note that row numbers start from 1, not from 0

Parameters

int	$row
int	$rowCount

Returns: static

Exceptions

Exception

Definition at line 165 of file Matrix.php.

                                                        : Matrix
    {
        $row = $this->validateRowInRange($row);
        if ($rowCount === 0) {
            $rowCount = $this->rows - $row + 1;
        }
 
        return new static(array_slice($this->grid, $row - 1, (int)$rowCount));
    }

References $row.

Referenced by Matrix\Decomposition\LU\pivotB().

Here is the caller graph for this function:

◆ getValue()

Matrix\Matrix::getValue	(	int	$row,
		int	$column
	)

Return a value from this matrix, from the "cell" identified by the row and column numbers Note that row and column numbers start from 1, not from 0.

Parameters

int	$row
int	$column

Returns: mixed

Exceptions

Exception

Definition at line 268 of file Matrix.php.

    {
        $row = $this->validateRowInRange($row);
        $column = $this->validateColumnInRange($column);
 
        return $this->grid[$row - 1][$column - 1];
    }

References $row.

Referenced by Matrix\Operators\Addition\addMatrix(), and Matrix\Operators\Subtraction\subtractMatrix().

Here is the caller graph for this function:

◆ isSquare()

Matrix\Matrix::isSquare ( )

Identify if the row and column dimensions of this matrix are equal, i.e.

if it is a "square" matrix

Returns: bool

Definition at line 312 of file Matrix.php.

                              : bool
    {
        return $this->rows === $this->columns;
    }

References $columns.

◆ isVector()

Matrix\Matrix::isVector ( )

Identify if this matrix is a vector i.e.

if it comprises only a single row or a single column

Returns: bool

Definition at line 323 of file Matrix.php.

                              : bool
    {
        return $this->rows === 1 || $this->columns === 1;
    }

◆ rows()

Matrix\Matrix::rows ( )

Returns a Generator that will yield each row of the matrix in turn as a vector matrix or the value of each cell if the matrix is a column vector.

Returns: Generator|Matrix[]|mixed[]

Definition at line 282 of file Matrix.php.

                          : Generator
    {
        foreach ($this->grid as $i => $row) {
            yield $i + 1 => ($this->columns == 1)
                ? $row[0]
                : new static([$row]);
        }
    }

References $i, and $row.

Referenced by Matrix\Decomposition\LU\solve(), and Matrix\Decomposition\QR\solve().

Here is the caller graph for this function:

◆ solve()

Matrix\Matrix::solve ( Matrix $B )

Solve A*X = B.

Parameters

Matrix $B Right hand side

Exceptions

Exception

Returns: Matrix ... Solution if A is square, least squares solution otherwise

Definition at line 347 of file Matrix.php.

                                    : Matrix
    {
        if ($this->columns === $this->rows) {
            return (new LU($this))->solve($B);
        }
 
        return (new QR($this))->solve($B);
    }

◆ toArray()

Matrix\Matrix::toArray ( )

Return the matrix as a 2-dimensional array.

Returns: array

Definition at line 333 of file Matrix.php.

                             : array
    {
        return $this->grid;
    }

References $grid.

◆ validateColumn()

static Matrix\Matrix::validateColumn ( int $column )

static

Validate that a column number is a positive integer.

Parameters

int $column

Returns: int

Exceptions

Exception

Definition at line 110 of file Matrix.php.

                                                      : int
    {
        if ((!is_numeric($column)) || (intval($column) < 1)) {
            throw new Exception('Invalid Column');
        }
 
        return (int)$column;
    }

◆ validateColumnInRange()

Matrix\Matrix::validateColumnInRange ( int $column )

protected

Validate that a column number falls within the set of columns for this matrix.

Parameters

int $column

Returns: int

Exceptions

Exception

Definition at line 143 of file Matrix.php.

                                                         : int
    {
        $column = static::validateColumn($column);
        if ($column > $this->columns) {
            throw new Exception('Requested Column exceeds matrix size');
        }
 
        return $column;
    }

◆ validateRow()

static Matrix\Matrix::validateRow ( int $row )

static

Validate that a row number is a positive integer.

Parameters

int $row

Returns: int

Exceptions

Exception

Definition at line 94 of file Matrix.php.

                                                : int
    {
        if ((!is_numeric($row)) || (intval($row) < 1)) {
            throw new Exception('Invalid Row');
        }
 
        return (int)$row;
    }

References $row.

◆ validateRowInRange()

Matrix\Matrix::validateRowInRange ( int $row )

protected

Validate that a row number falls within the set of rows for this matrix.

Parameters

int $row

Returns: int

Exceptions

Exception

Definition at line 126 of file Matrix.php.

                                                   : int
    {
        $row = static::validateRow($row);
        if ($row > $this->rows) {
            throw new Exception('Requested Row exceeds matrix size');
        }
 
        return $row;
    }

References $row.

Field Documentation

◆ $columns

Matrix\Matrix::$columns

protected

Definition at line 45 of file Matrix.php.

◆ $functions

Matrix\Matrix::$functions

staticprotected

Initial value:

= [
        'adjoint',
        'antidiagonal',
        'cofactors',
        'determinant',
        'diagonal',
        'identity',
        'inverse',
        'minors',
        'trace',
        'transpose',
    ]

Definition at line 380 of file Matrix.php.

◆ $getters

Matrix\Matrix::$getters

staticprotected

Initial value:

= [
        'rows',
        'columns',
    ]

Definition at line 356 of file Matrix.php.

◆ $grid

Matrix\Matrix::$grid = []

protected

Definition at line 46 of file Matrix.php.

◆ $operations

Matrix\Matrix::$operations

staticprotected

Initial value:

= [
        'add',
        'subtract',
        'multiply',
        'divideby',
        'divideinto',
        'directsum',
    ]

Definition at line 393 of file Matrix.php.

◆ $rows

Matrix\Matrix::$rows

protected

Definition at line 44 of file Matrix.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/markbaker/matrix/classes/src/Matrix.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __get()

◆ buildFromArray()

◆ columns()

◆ dropColumns()

◆ dropRows()

◆ getColumns()

◆ getRows()

◆ getValue()

◆ isSquare()

◆ isVector()

◆ rows()

◆ solve()

◆ toArray()

◆ validateColumn()

◆ validateColumnInRange()

◆ validateRow()

◆ validateRowInRange()

Field Documentation

◆ $columns

◆ $functions

◆ $getters

◆ $grid

◆ $operations

◆ $rows