Matrix\Operators\Subtraction Class Reference

Inheritance diagram for Matrix\Operators\Subtraction:

Collaboration diagram for Matrix\Operators\Subtraction:

Public Member Functions
	execute ($value)
	Execute the subtraction. 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
	subtractScalar ($value)
	Execute the subtraction for a scalar. More...
	subtractMatrix (Matrix $value)
	Execute the subtraction 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 8 of file Subtraction.php.

Member Function Documentation

execute()

Matrix\Operators\Subtraction::execute

(

$value

)

Execute the subtraction.

Parameters

mixed

$value

The matrix or numeric value to subtract from the current base value

Exceptions

Exception

If the provided argument is not appropriate for the operation

Returns

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

Definition at line 17 of file Subtraction.php.

References Matrix\Operators\Subtraction\subtractMatrix(), and Matrix\Operators\Subtraction\subtractScalar().

                                   : Operator
    {
        if (is_array($value)) {
            $value = new Matrix($value);
        }

        if (is_object($value) && ($value instanceof Matrix)) {
            return $this->subtractMatrix($value);
        } elseif (is_numeric($value)) {
            return $this->subtractScalar($value);
        }

        throw new Exception('Invalid argument for subtraction');
    }

Here is the call graph for this function:

subtractMatrix()

Matrix\Operators\Subtraction::subtractMatrix ( Matrix  $value )

protected

Execute the subtraction for a matrix.

Parameters

Matrix

$value

The numeric value to subtract from the current base value

Returns

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

Exceptions

Exception

If the provided argument is not appropriate for the operation

Definition at line 56 of file Subtraction.php.

References Matrix\Operators\Operator\$columns, $row, Matrix\Operators\Operator\$rows, Matrix\Matrix\getValue(), and Matrix\Operators\Operator\validateMatchingDimensions().

Referenced by Matrix\Operators\Subtraction\execute().

                                                    : Operator
    {
        $this->validateMatchingDimensions($value);

        for ($row = 0; $row < $this->rows; ++$row) {
            for ($column = 0; $column < $this->columns; ++$column) {
                $this->matrix[$row][$column] -= $value->getValue($row + 1, $column + 1);
            }
        }

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

subtractScalar()

Matrix\Operators\Subtraction::subtractScalar (   $value )

protected

Execute the subtraction for a scalar.

Parameters

mixed

$value

The numeric value to subtracted from the current base value

Returns

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

Definition at line 38 of file Subtraction.php.

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

Referenced by Matrix\Operators\Subtraction\execute().

                                             : Operator
    {
        for ($row = 0; $row < $this->rows; ++$row) {
            for ($column = 0; $column < $this->columns; ++$column) {
                $this->matrix[$row][$column] -= $value;
            }
        }

        return $this;
    }

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/Subtraction.php