| 
| 
  | execute ($value, string $type='multiplication') | 
|   | 
|   | result () | 
|   | Return the result of the operation.  
  | 
|   | 
 | 
|   | multiplyMatrix (Matrix $value, string $type='multiplication') | 
|   | Execute the multiplication for a matrix.  
  | 
|   | 
|   | multiplyScalar ($value, string $type='multiplication') | 
|   | Execute the multiplication for a scalar.  
  | 
|   | 
|   | validateMatchingDimensions (Matrix $matrix) | 
|   | Compare the dimensions of the matrices being operated on to see if they are valid for addition/subtraction.  
  | 
|   | 
|   | validateReflectingDimensions (Matrix $matrix) | 
|   | Compare the dimensions of the matrices being operated on to see if they are valid for multiplication/division.  
  | 
|   | 
 | 
| 
  | $columns | 
|   | Number of columns in the matrix. 
  | 
|   | 
| 
  | $matrix | 
|   | 
| 
  | $rows | 
|   | Number of rows in the matrix. 
  | 
|   | 
◆ 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  | 
  
   
- Return values
 - 
  
    | $this | The operation object, allowing multiple mutiplications to be chained  | 
  
   
- Exceptions
 - 
  
    | Exception | If the provided argument is not appropriate for the operation  | 
  
   
 
 
◆ 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  | 
  
   
- Return values
 - 
  
    | $this | The operation object, allowing multiple mutiplications to be chained  | 
  
   
 
 
◆ result()
  
  
      
        
          | Matrix\Operators\Operator::result  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
inherited   | 
  
 
Return the result of the operation. 
- Return values
 - 
  
  
 
 
 
◆ validateMatchingDimensions()
  
  
      
        
          | Matrix\Operators\Operator::validateMatchingDimensions  | 
          ( | 
          Matrix |           $matrix | ) | 
           | 
         
       
   | 
  
protectedinherited   | 
  
 
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
 - 
  
  
 
 
 
◆ validateReflectingDimensions()
  
  
      
        
          | Matrix\Operators\Operator::validateReflectingDimensions  | 
          ( | 
          Matrix |           $matrix | ) | 
           | 
         
       
   | 
  
protectedinherited   | 
  
 
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
 - 
  
  
 
 
 
The documentation for this class was generated from the following file:
- lib/phpspreadsheet/markbaker/matrix/classes/src/Operators/Multiplication.php