Overload List
| # | Signature | Description |
|---|---|---|
| 1 | function SubFrom(Value: TCplx): TMtxVec; | Subtract each of calling object elements from complex Value. |
| └ indexed: function SubFrom(Value: TCplx; Index: Integer; Len: Integer): TMtxVec; | ||
| 2 | function SubFrom(Value: TCplx; Vec: TMtxVec): TMtxVec; | subtract complex Vec elements from Value and store the result in the calling object. |
| └ indexed: function SubFrom(Value: TCplx; Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec; | ||
| 3 | function SubFrom(Value: Double): TMtxVec; | Subtraction from value. |
| └ indexed: function SubFrom(Value: Double; Index: Integer; Len: Integer): TMtxVec; | ||
| 4 | function SubFrom(Value: Double; Vec: TMtxVec): TMtxVec; | subtract Vec elements from Value and store the result in the calling object. |
| └ indexed: function SubFrom(Value: Double; Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec; |
Overload 1: function SubFrom(Value: TCplx): TMtxVec;
Subtract each of calling object elements from complex Value.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | TCplx | scalar |
Result: stored in self (calling object), returns self for chaining
If the calling Matrix is not complex, the conversion is performed automatically in a performance efficient way.
Indexed: function SubFrom(Value: TCplx; Index: Integer; Len: Integer): TMtxVec;
Subtract elements [Index]..[Index+Len-1] from complex Value and store the result in Self.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | TCplx | scalar |
| 2 | Index | Integer | start index |
| 3 | Len | Integer | element count |
Result: stored in self (calling object), returns self for chaining
If the calling Matrix is not complex, the conversion to complex is performed automatically in performance efficient way. An exception is raised if Matrix.ConditionCheck is True and array borders are overrun or underrun.
Overload 2: function SubFrom(Value: TCplx; Vec: TMtxVec): TMtxVec;
subtract complex Vec elements from Value and store the result in the calling object.
Result: stored in self (calling object), returns self for chaining
Size property of the calling object is set automatically. Matrix.Complex property of the calling object is set to True.
Indexed: function SubFrom(Value: TCplx; Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
subtract Vec elements [VecIndex]..[VecIndex+Len-1] from complex Value and store the result to the calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | TCplx | scalar |
| 2 | Vec | TMtxVec | source TVec or TMtx |
| 3 | VecIndex | Integer | |
| 4 | Index | Integer | start index |
| 5 | Len | Integer | element count |
Result: stored in self (calling object), returns self for chaining
Size property of the calling object is not changed. An exception is raised if Matrix.ConditionCheck is True and array borders are overrun or underrun. Matrix.Complex property of the calling object is set to True.
Overload 3: function SubFrom(Value: Double): TMtxVec;
Subtraction from value.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | Double | scalar |
Result: stored in self (calling object), returns self for chaining
Subtract each of calling object elements from Value.
Indexed: function SubFrom(Value: Double; Index: Integer; Len: Integer): TMtxVec;
Subtract elements [Index]..[Index+Len-1] from Value and store the result in Self.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | Double | scalar |
| 2 | Index | Integer | start index |
| 3 | Len | Integer | element count |
Result: stored in self (calling object), returns self for chaining
An exception is raised if Matrix.ConditionCheck is True and array borders are overrun or underrun.
Overload 4: function SubFrom(Value: Double; Vec: TMtxVec): TMtxVec;
subtract Vec elements from Value and store the result in the calling object.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | Double | scalar |
| 2 | Vec | TMtxVec | source TVec or TMtx |
Result: stored in self (calling object), returns self for chaining
Size and Matrix.Complex properties of calling object are adjusted automatically.
Indexed: function SubFrom(Value: Double; Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
subtract Vec elements [VecIndex]..[VecIndex+Len-1] from Value and store the result to the calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Value | Double | scalar |
| 2 | Vec | TMtxVec | source TVec or TMtx |
| 3 | VecIndex | Integer | |
| 4 | Index | Integer | start index |
| 5 | Len | Integer | element count |
Result: stored in self (calling object), returns self for chaining
Size property of the calling object is not changed. An exception is raised if Matrix.ConditionCheck is True and array borders are overrun or underrun. Matrix.Complex property of the calling object is adjusted automatically.