JCL Help:TJclComplex.CSub@Float@Float@TComplexKind
JCL Help: TJclComplex.CSub Method (Float, Float, TComplexKind)
Search in JCL Help
Search in all projects
Summary
Subtract the value given by MulValue or X and Y parameters from the value of the current complex number object.
Pascal
public function CSub(const SubValue: TJclComplex): TJclComplex; overload;
public function CSub(const X: Float; const Y: Float; const ComplexType: TComplexKind = crRectangular): TJclComplex; overload;
Parameters
| Parameters | Description |
| const SubValue: TJclComplex | The complex number that is the subtrahend. |
| const X: Float | The real part in the rectangular representation or radius in polar coordinates of the complex number that is the subtrahend. |
| const Y: Float | The imaginary part in the rectangular representation or angle in polar coordinates of the complex number that is the subtrahend. |
| const ComplexType: TComplexKind = crRectangular | Optional. Defines whether X and Y parameters are stated in rectangular representation or in polar coordinates. |
Return Value
Method CSub returns the calling object with the changed value.
Description
Use CSub method to perform a subtraction operation where the current complex number object is the minuend and the value provided through either X and Y or DivValue parameters is the subtrahend. The complex number to be subtracted could be set either as an object of TJclComplex type or a pair of its values (X;Y).
See Also
CNewSub TJclComplex TComplexKind
About
Donator
Earl F. Glynn
Notes
The subtraction of the complex numbers is performed according to the following formula: (X1;Y1) - (X2;Y2) = (X1-X2;Y1-Y2). For leaving the value of the calling object intact use CNewSub method to create a new resulting object of TJclComplex type.
Contribute to this help topic
This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page
