Matrix\Builder Class Reference

Collaboration diagram for Matrix\Builder:

Static Public Member Functions
static	createFilledMatrix ($fillValue, $rows, $columns=null)
	Create a new matrix of specified dimensions, and filled with a specified value If the column argument isn't provided, then a square matrix will be created. More...
static	createIdentityMatrix ($dimensions, $fillValue=null)
	Create a new identity matrix of specified dimensions This will always be a square matrix, with the number of rows and columns matching the provided dimension. More...

Detailed Description

Definition at line 18 of file Builder.php.

Member Function Documentation

createFilledMatrix()

static Matrix\Builder::createFilledMatrix (   $fillValue,   $rows,   $columns = null  )

static

Create a new matrix of specified dimensions, and filled with a specified value If the column argument isn't provided, then a square matrix will be created.

Parameters

mixed	$fillValue
int	$rows
int | null	$columns

Returns

Matrix

Exceptions

Exception

Definition at line 30 of file Builder.php.

References $columns, and $rows.

Referenced by PhpOffice\PhpSpreadsheet\Calculation\MathTrig\MatrixFunctions\identity(), and Matrix\Operators\Multiplication\multiplyMatrix().

    {
        if ($columns === null) {
            $columns = $rows;
        }

        $rows = Matrix::validateRow($rows);
        $columns = Matrix::validateColumn($columns);

        return new Matrix(
            array_fill(
                0,
                $rows,
                array_fill(
                    0,
                    $columns,
                    $fillValue
                )
            )
        );
    }

Here is the caller graph for this function:

createIdentityMatrix()

static Matrix\Builder::createIdentityMatrix (   $dimensions,   $fillValue = null  )

static

Create a new identity matrix of specified dimensions This will always be a square matrix, with the number of rows and columns matching the provided dimension.

Parameters

int

$dimensions

Returns

Matrix

Exceptions

Exception

Definition at line 60 of file Builder.php.

References $grid, and $x.

    {
        $grid = static::createFilledMatrix($fillValue, $dimensions)->toArray();

        for ($x = 0; $x < $dimensions; ++$x) {
            $grid[$x][$x] = 1;
        }

        return new Matrix($grid);
    }

---

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

• libs/composer/vendor/markbaker/matrix/classes/src/Builder.php