Matrix\Operators\Operator Class Reference

Inheritance diagram for Matrix\Operators\Operator:

Collaboration diagram for Matrix\Operators\Operator:

Public Member Functions
	__construct (Matrix $matrix)
	Create an new handler object for the operation. More...
	result ()
	Return the result of the operation. More...

Protected Member Functions
	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...

Protected Attributes
	$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 Operator.php.

Constructor & Destructor Documentation

__construct()

Matrix\Operators\Operator::__construct

(

Matrix

$matrix

)

Create an new handler object for the operation.

Parameters

Matrix

$matrix

The base Matrix object on which the operation will be performed

Definition at line 36 of file Operator.php.

References Matrix\Matrix\columns(), Matrix\Matrix\rows(), and Matrix\Matrix\toArray().

    {
        $this->rows = $matrix->rows;
        $this->columns = $matrix->columns;
        $this->matrix = $matrix->toArray();
    }

Here is the call graph for this function:

Member Function Documentation

result()

Matrix\Operators\Operator::result

(

)

Return the result of the operation.

Returns

Matrix

Definition at line 74 of file Operator.php.

                            : Matrix
    {
        return new Matrix($this->matrix);
    }

validateMatchingDimensions()

Matrix\Operators\Operator::validateMatchingDimensions ( Matrix  $matrix )

protected

Compare the dimensions of the matrices being operated on to see if they are valid for addition/subtraction.

Parameters

Matrix

$matrix

The second Matrix object on which the operation will be performed

Exceptions

Exception

Definition at line 49 of file Operator.php.

References Matrix\Matrix\columns(), and Matrix\Matrix\rows().

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

                                                                 : void
    {
        if (($this->rows != $matrix->rows) || ($this->columns != $matrix->columns)) {
            throw new Exception('Matrices have mismatched dimensions');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateReflectingDimensions()

Matrix\Operators\Operator::validateReflectingDimensions ( Matrix  $matrix )

protected

Compare the dimensions of the matrices being operated on to see if they are valid for multiplication/division.

Parameters

Matrix

$matrix

The second Matrix object on which the operation will be performed

Exceptions

Exception

Definition at line 62 of file Operator.php.

References Matrix\Matrix\rows().

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

                                                                   : void
    {
        if ($this->columns != $matrix->rows) {
            throw new Exception('Matrices have mismatched dimensions');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$columns

integer Matrix\Operators\Operator::$columns

protected

Number of columns in the matrix.

Definition at line 29 of file Operator.php.

Referenced by Matrix\Operators\Addition\addMatrix(), Matrix\Operators\Addition\addScalar(), Matrix\Operators\Multiplication\multiplyScalar(), Matrix\Operators\Subtraction\subtractMatrix(), and Matrix\Operators\Subtraction\subtractScalar().

$matrix

Matrix\Operators\Operator::$matrix

protected

Definition at line 15 of file Operator.php.

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

$rows

integer Matrix\Operators\Operator::$rows

protected

Number of rows in the matrix.

Definition at line 22 of file Operator.php.

Referenced by Matrix\Operators\Addition\addMatrix(), Matrix\Operators\Addition\addScalar(), Matrix\Operators\DirectSum\directSumMatrix(), Matrix\Operators\Multiplication\multiplyMatrix(), Matrix\Operators\Multiplication\multiplyScalar(), Matrix\Operators\Subtraction\subtractMatrix(), and Matrix\Operators\Subtraction\subtractScalar().

---

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

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