JCL Help:TJclComplex.CAdd@Float@Float@TComplexKind
JCL Help: TJclComplex.CAdd Method (Float, Float, TComplexKind)
Search in JCL Help
Search in all projects
Summary
Adds the value given by AddValue or X and Y parameters to the value of the current complex number object.
Pascal
public function CAdd(const AddValue: TJclComplex): TJclComplex; overload;
public function CAdd(const X: Float; const Y: Float; const ComplexType: TComplexKind = crRectangular): TJclComplex; overload;
Parameters
Parameters | Description |
const AddValue: TJclComplex | The complex number that should be added to the value of the object. |
const X: Float | The real part in the rectangular representation or radius in polar coordinates of the complex number that should be added to the value of the object. |
const Y: Float | The imaginary part in the rectangular representation or angle in polar coordinates of the complex number that should be added to the value of the object. |
const ComplexType: TComplexKind = crRectangular | Optional. Defines whether X and Y parameters are stated in rectangular representation or in polar coordinates. |
Return Value
Method CAdd returns the calling object with the changed value.
Description
Use CAdd method to add the value of the complex number provided to the value of the calling object itself. The complex number to be added could be set either as an object of TJclComplex type or a pair of its values (X;Y).
See Also
CNewAdd TJclComplex TComplexKind
About
Donator
Earl F. Glynn
Notes
The addition 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 CNewAdd 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