Overload List
| # | Signature | Description |
|---|---|---|
| 1 | TMtxVec Mul(TCplx Value) | Multiply all calling object elements with complex Value in-place. |
| └ indexed: TMtxVec Mul(TCplx Value, Int32 Index, Int32 Len) | ||
| 2 | TMtx Mul(TMtx Mtx1, TMtx Mtx2) | Matrix multiplication. |
| 3 | TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtx Mtx3) | Returns the matrix product of three matrices. |
| 4 | TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtx Mtx3, TMtx Mtx4) | Returns the matrix product of four matrices. |
| 5 | TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtxOperation Operation1, TMtxOperation Operation2) | Left side multiply Mtx2 with Mtx1 matrix and store the results in the calling matrix. |
| 6 | TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtxType Mtx1Type, TMtxType Mtx2Type, TMtxOperation Operation1, TMtxOperation Operation2) | Left side multiply Mtx2 with Mtx1 matrix and store the results in the calling matrix. If parameters Mtx1Type and/or Mtx2Type are specified, the optimized multiplication method will be used. |
| 7 | TMtxVec Mul(TMtxVec Vec) | Matrix multiplication. |
| └ indexed: TMtxVec Mul(TMtxVec Vec, Int32 VecIndex, Int32 Index, Int32 Len) | ||
| 8 | TMtxVec Mul(TMtxVec Vec, TCplx Value) | Multiply each element of Vec with complex Value and store the result in the calling object. |
| └ indexed: TMtxVec Mul(TMtxVec Vec, TCplx Value, Int32 VecIndex, Int32 Index, Int32 Len) | ||
| 9 | TMtxVec Mul(TMtxVec Vec, Double Value) | Multiply each element of Vec with Value and store the result in the calling object. |
| └ indexed: TMtxVec Mul(TMtxVec Vec, Double Value, Int32 VecIndex, Int32 Index, Int32 Len) | ||
| 10 | TMtxVec Mul(Double Value) | Multiply object elements with Value. |
| └ indexed: TMtxVec Mul(Double Value, Int32 Index, Int32 Len) | ||
| 11 | TMtxVec Mul(TMtxVec Vec1, TMtxVec Vec2, Int32 Vec1Index, Int32 Vec2Index, Int32 Index, Int32 Len) | Multiply Vec1 elements [Vec1Index]..[Vec1Index+Len-1] with Vec2 object elements [Vec2Index]..[Vec2Index+Len-1] and store the results in calling object elements [Index]..[Index+Len-1]. |
Overload 1: TMtxVec Mul(TCplx Value)
Multiply all calling object elements with complex Value in-place.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | TCplx | scalar |
Result: stored in self (calling object), returns self for chaining
Indexed: TMtxVec Mul(TCplx Value, Int32 Index, Int32 Len)
Multipy calling object elements [Index]..[Index+Len-1] with complex Value in-place.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | TCplx | scalar |
| 2 | Index | Int32 | start index |
| 3 | Len | Int32 | element count |
Result: stored in self (calling object), returns self for chaining
An exception is raised if array borders are overrun or underrun.
Overload 2: TMtx Mul(TMtx Mtx1, TMtx Mtx2)
Matrix multiplication.
Result: stored in self (calling object), returns self for chaining
Performs matrix multiplication, which is JIT-ed (faster) up to size 64 for square matrices. In most general case the matrix multiplication is defined by the following equation (result = calling matrix):
where a and b are and variables. The default values for a and b are Cplx(1,0) and Cplx(0,0), so the above equation is reduced to:
The Operation1 and Operation2 indicate additional Dew.Math.TMtxOperation, performed on Mtx1 and Mtx2 respectively. Default value for operation is opNone (no additional operation). The Mtx1Type and Mtx2Type parameters indicate the Dew.Math.TMtxType of Mtx1 and Mtx2 matrices. Depending what type of matrices you are multiplying, the Mul method will choose most optimized multiplication method. So, choosing the correct values for Mtx1Type and Mtx2Type can significantly speed up the multiplication. This overloaded function performs a left side multiply operation Mtx2 with Mtx1 matrix and stores the results in the calling matrix. If Operation1 and/or Operation2 parameters are specified, perform additional operation on Mtx1 or Mtx2. If Operation1 and/or Operation2 parameters are omitted, the default values (no operation) will be used. The Dew.Math.Matrix.Rows, Dew.Math.Matrix.Cols and Dew.Math.Matrix.Complex properties of the calling matrix are adjusted automatically. An exception is raised is Mtx1 Cols property does not match the Mtx2 Rows property (matrix multiplication is not possible). An exception is raised, if Dew.Math.Matrix.Complex property of Mtx1 and Mtx2 does not match.
Notes
1. NOTE: If you are not sure, which Dew.Math.TMtxType of matrix are you multiplying, you can use the mtGeneral type (general case). You can also use the Dew.Math.Matrix.DetectMtxType method to determine the type of matrix. 2. The routine is multithreaded, if specified by the environment variable.
Matrix A;
Matrix B;
Matrix C;
A.SetIt(2,2,false,[1,2,
2,4]);
B.SetIt(2,2,false,[1,2,
2,4]);
C.Mul(A,B); //or
C = Mul(a,b); // but this is !the same as:
c = a*b; //which is the same as
c.MulElem(A,B);sOverload 3: TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtx Mtx3)
Returns the matrix product of three matrices.
Result: stored in self (calling object), returns self for chaining
Internally calls Dew.Math.TMtx.Mul and does JIT-ed (faster) multiply for small square matrices.
Overload 4: TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtx Mtx3, TMtx Mtx4)
Returns the matrix product of four matrices.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Mtx1 | TMtx | source TMtx |
| 2 | Mtx2 | TMtx | source TMtx |
| 3 | Mtx3 | TMtx | source TMtx |
| 4 | Mtx4 | TMtx | source TMtx |
Result: stored in self (calling object), returns self for chaining
Internally calls Dew.Math.TMtx.Mul and does JIT-ed (faster) multiply for small square matrices.
Overload 5: TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtxOperation Operation1, TMtxOperation Operation2)
Left side multiply Mtx2 with Mtx1 matrix and store the results in the calling matrix.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Mtx1 | TMtx | source TMtx |
| 2 | Mtx2 | TMtx | source TMtx |
| 3 | Operation1 | TMtxOperation | |
| 4 | Operation2 | TMtxOperation |
Result: stored in self (calling object), returns self for chaining
If Operation1 and/or Operation2 parameters are specified, perform additional operation on Mtx1 or Mtx2. If Operation1 and/or Operation2 parameters are omitted, the default values (no operation) will be used. The Dew.Math.Matrix.Rows, Dew.Math.Matrix.Cols and Dew.Math.Matrix.Complex properties of the calling matrix are adjusted automatically. An exception is raised is Mtx1 Cols property does not match the Mtx2 Rows property (matrix multiplication is not possible). An exception is raised, if Complex property of Mtx1 and Mtx2 does not match.
Overload 6: TMtx Mul(TMtx Mtx1, TMtx Mtx2, TMtxType Mtx1Type, TMtxType Mtx2Type, TMtxOperation Operation1, TMtxOperation Operation2)
Left side multiply Mtx2 with Mtx1 matrix and store the results in the calling matrix. If parameters Mtx1Type and/or Mtx2Type are specified, the optimized multiplication method will be used.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Mtx1 | TMtx | source TMtx |
| 2 | Mtx2 | TMtx | source TMtx |
| 3 | Mtx1Type | TMtxType | |
| 4 | Mtx2Type | TMtxType | |
| 5 | Operation1 | TMtxOperation | |
| 6 | Operation2 | TMtxOperation |
Result: stored in self (calling object), returns self for chaining
If parameters Mtx1Type and/or Mtx2Type are omitted, default values (general matrix) will be used. If Operation1 and/or Operation2 parameters are specified, perform additional operation on Mtx1 or Mtx2. If Operation1 and/or Operation2 parameters are omitted, the default values (no operation) will be used. The Dew.Math.Matrix.Rows, Dew.Math.Matrix.Cols and Dew.Math.Matrix.Complex properties of the calling matrix are adjusted automatically. An exception is raised is Mtx1 Cols property does not match the Mtx2 Rows property (matrix multiplication is not possible). An exception is raised, if Complex property of Mtx1 and Mtx2 does not match.
Overload 7: TMtxVec Mul(TMtxVec Vec)
Matrix multiplication.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TMtxVec | source TVec or TMtx |
Result: stored in self (calling object), returns self for chaining
Multiply each of Vec elements with corresponding elements in the calling object. Size and Dew.Math.Matrix.Complex property of the calling object are set automatically. The result is stored in the calling object.
Indexed: TMtxVec Mul(TMtxVec Vec, Int32 VecIndex, Int32 Index, Int32 Len)
Multiply Vec elements [VecIndex]..[VecIndex+Len-1] with calling object elements [Index]..[Index+Len-1] in-place.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TMtxVec | source TVec or TMtx |
| 2 | VecIndex | Int32 | |
| 3 | Index | Int32 | start index |
| 4 | Len | Int32 | element count |
Result: stored in self (calling object), returns self for chaining
An exception is raised if Vec and calling object Dew.Math.Matrix.Complex property do not match or if array borders are overrun/underrun.
Overload 8: TMtxVec Mul(TMtxVec Vec, TCplx Value)
Multiply each element of Vec with complex Value and store the result in the calling object.
Result: stored in self (calling object), returns self for chaining
Size of the calling object is set automatically. Dew.Math.Matrix.Complex property of the calling object is set to True.
Indexed: TMtxVec Mul(TMtxVec Vec, TCplx Value, Int32 VecIndex, Int32 Index, Int32 Len)
Multiply Vec elements [VecIndex]..[VecIndex+Len-1] with complex Value and store the result in calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TMtxVec | source TVec or TMtx |
| 2 | Value | TCplx | scalar |
| 3 | VecIndex | Int32 | |
| 4 | Index | Int32 | start index |
| 5 | Len | Int32 | element count |
Result: stored in self (calling object), returns self for chaining
Size of the calling object is not changed. An exception is raised if array borders are overrun or underrun. Dew.Math.Matrix.Complex propertiy of the calling object is set to True.
Overload 9: TMtxVec Mul(TMtxVec Vec, Double Value)
Multiply each element of Vec with Value and store the result in the calling object.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TMtxVec | source TVec or TMtx |
| 2 | Value | Double | scalar |
Result: stored in self (calling object), returns self for chaining
Size and Dew.Math.Matrix.Complex properties of the calling object are adjusted automatically.
Indexed: TMtxVec Mul(TMtxVec Vec, Double Value, Int32 VecIndex, Int32 Index, Int32 Len)
Multiply Vec elements [VecIndex]..[VecIndex+Len-1] with Value and store the result in calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec | TMtxVec | source TVec or TMtx |
| 2 | Value | Double | scalar |
| 3 | VecIndex | Int32 | |
| 4 | Index | Int32 | start index |
| 5 | Len | Int32 | element count |
Result: stored in self (calling object), returns self for chaining
Size of the calling object is not changed. An exception is raised if array borders are overrun or underrun. Dew.Math.Matrix.Complex propertiy of the calling object is set implicitly.
Overload 10: TMtxVec Mul(Double Value)
Multiply object elements with Value.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | Double | scalar |
Result: stored in self (calling object), returns self for chaining
Multiply all calling object elements with Value in-place.
Vector v;
v.SetIt(1,3,false,new double[] {2,3,5}); // v = new double[] {2,3,5}
v = v*3; // v = new double[] {6,9,15}Indexed: TMtxVec Mul(Double Value, Int32 Index, Int32 Len)
Multipy calling object elements [Index]..[Index+Len-1] with Value in-place.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | Double | scalar |
| 2 | Index | Int32 | start index |
| 3 | Len | Int32 | element count |
Result: stored in self (calling object), returns self for chaining
An exception is raised if array borders are overrun or underrun.
Overload 11: TMtxVec Mul(TMtxVec Vec1, TMtxVec Vec2, Int32 Vec1Index, Int32 Vec2Index, Int32 Index, Int32 Len)
Multiply Vec1 elements [Vec1Index]..[Vec1Index+Len-1] with Vec2 object elements [Vec2Index]..[Vec2Index+Len-1] and store the results in calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Vec1 | TMtxVec | source TVec or TMtx |
| 2 | Vec2 | TMtxVec | source TVec or TMtx |
| 3 | Vec1Index | Int32 | |
| 4 | Vec2Index | Int32 | |
| 5 | Index | Int32 | start index |
| 6 | Len | Int32 | element count |
Result: stored in self (calling object), returns self for chaining
Size and Dew.Math.Matrix.Complex properties of the calling object must be set explicitly. An exception is raised if Dew.Math.Matrix.ConditionCheck is True and array borders are overrun or underrun.