Matrix\Operators\Multiplication Class Reference

Inheritance diagram for Matrix\Operators\Multiplication:

Collaboration diagram for Matrix\Operators\Multiplication:

Public Member Functions
	execute ($value, string $type='multiplication')
	Execute the multiplication. More...
Public Member Functions inherited from Matrix\Operators\Operator
	__construct (Matrix $matrix)
	Create an new handler object for the operation. More...
	result ()
	Return the result of the operation. More...

Protected Member Functions
	multiplyScalar ($value, string $type='multiplication')
	Execute the multiplication for a scalar. More...
	multiplyMatrix (Matrix $value, string $type='multiplication')
	Execute the multiplication for a matrix. More...
Protected Member Functions inherited from Matrix\Operators\Operator
	validateMatchingDimensions (Matrix $matrix)
	Compare the dimensions of the matrices being operated on to see if they are valid for addition/subtraction. More...
	validateReflectingDimensions (Matrix $matrix)
	Compare the dimensions of the matrices being operated on to see if they are valid for multiplication/division. More...

Additional Inherited Members
Protected Attributes inherited from Matrix\Operators\Operator
	$matrix
	$rows
	Number of rows in the matrix. More...
	$columns
	Number of columns in the matrix. More...

Detailed Description

Definition at line 10 of file Multiplication.php.

Member Function Documentation

execute()

Matrix\Operators\Multiplication::execute	(		$value,
		string	$type = 'multiplication'
	)

Execute the multiplication.

Parameters

mixed

$value

The matrix or numeric value to multiply the current base value by

Exceptions

Exception

If the provided argument is not appropriate for the operation

Returns

$this The operation object, allowing multiple multiplications to be chained

Reimplemented in Matrix\Operators\Division.

Definition at line 19 of file Multiplication.php.

                                                                    : Operator
    {
        if (is_array($value)) {
            $value = new Matrix($value);
        }
 
        if (is_object($value) && ($value instanceof Matrix)) {
            return $this->multiplyMatrix($value, $type);
        } elseif (is_numeric($value)) {
            return $this->multiplyScalar($value, $type);
        }
 
        throw new Exception("Invalid argument for $type");
    }

References $type, Matrix\Operators\Multiplication\multiplyMatrix(), and Matrix\Operators\Multiplication\multiplyScalar().

Here is the call graph for this function:

multiplyMatrix()

Matrix\Operators\Multiplication::multiplyMatrix ( Matrix  $value, string  $type = 'multiplication'  )

protected

Execute the multiplication for a matrix.

Parameters

Matrix

$value

The numeric value to multiply with the current base value

Returns

$this The operation object, allowing multiple mutiplications to be chained

Exceptions

Exception

If the provided argument is not appropriate for the operation

Definition at line 62 of file Multiplication.php.

                                                                                     : Operator
    {
        $this->validateReflectingDimensions($value);
 
        $newRows = $this->rows;
        $newColumns = $value->columns;
        $matrix = Builder::createFilledMatrix(0, $newRows, $newColumns)
            ->toArray();
        try {
            for ($row = 0; $row < $newRows; ++$row) {
                for ($column = 0; $column < $newColumns; ++$column) {
                    $columnData = $value->getColumns($column + 1)->toArray();
                    foreach ($this->matrix[$row] as $key => $valueData) {
                        $matrix[$row][$column] += $valueData * $columnData[$key][0];
                    }
                }
            }
        } catch (Throwable $e) {
            throw new Exception("Invalid argument for $type");
        }
        $this->matrix = $matrix;
 
        return $this;
    }

References $key, Matrix\Operators\Operator\$matrix, $row, Matrix\Operators\Operator\$rows, Matrix\Matrix\columns(), Matrix\Builder\createFilledMatrix(), Matrix\Matrix\getColumns(), and Matrix\Operators\Operator\validateReflectingDimensions().

Referenced by Matrix\Operators\Division\execute(), and Matrix\Operators\Multiplication\execute().

Here is the call graph for this function:

Here is the caller graph for this function:

multiplyScalar()

Matrix\Operators\Multiplication::multiplyScalar (   $value, string  $type = 'multiplication'  )

protected

Execute the multiplication for a scalar.

Parameters

mixed

$value

The numeric value to multiply with the current base value

Returns

$this The operation object, allowing multiple mutiplications to be chained

Definition at line 40 of file Multiplication.php.

                                                                              : Operator
    {
        try {
            for ($row = 0; $row < $this->rows; ++$row) {
                for ($column = 0; $column < $this->columns; ++$column) {
                    $this->matrix[$row][$column] *= $value;
                }
            }
        } catch (Throwable $e) {
            throw new Exception("Invalid argument for $type");
        }
 
        return $this;
    }

References Matrix\Operators\Operator\$columns, $row, and Matrix\Operators\Operator\$rows.

Referenced by Matrix\Operators\Division\execute(), and Matrix\Operators\Multiplication\execute().

Here is the caller graph for this function:

---

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

• libs/composer/vendor/markbaker/matrix/classes/src/Operators/Multiplication.php