JCL Help:TJclComplex.CMul@Float@Float@TComplexKind
JCL Help: TJclComplex.CMul Method (Float, Float, TComplexKind)
Search in JCL Help
Search in all projects
Summary
Multiply the value of the current complex number object by the value given by MulValue or X and Y parameters.
Pascal
public function CMul(const MulValue: TJclComplex): TJclComplex; overload;
public function CMul(const X: Float; const Y: Float; const ComplexType: TComplexKind = crRectangular): TJclComplex; overload;
Parameters
| Parameters | Description |
| const MulValue: TJclComplex | The complex number that is the second multiplier. |
| const X: Float | The real part in the rectangular representation or radius in polar coordinates of the complex number that is the second multiplier. |
| const Y: Float | The imaginary part in the rectangular representation or angle in polar coordinates of the complex number that is the second multiplier. |
| const ComplexType: TComplexKind = crRectangular | Optional. Defines whether X and Y parameters are stated in rectangular representation or in polar coordinates. |
Return Value
Method CMul returns the calling object with the changed value.
Description
Use CMul method to perform a multiplication operation where the current complex number object is the first and the value provided through either X and Y or DivValue parameters is the second multiplier. The complex number to be multiplied by could be set either as an object of TJclComplex type or a pair of its values (X;Y).
See Also
CNewMul TJclComplex TComplexKind
About
Donator
Earl F. Glynn
Notes
The multiplication of the complex numbers is performed according to the following formula: (X1;Y1) * (X2;Y2) = (X1 *X2-Y1*Y2; X1*Y2+Y1*X2). Note that for complex numbers the operations Z1*Z2 and Z2*Z1 give different results and cannot substitute each other. For leaving the value of the calling object intact use CNewMul 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
