TSparseMtx.ImagPart Method

function ImagPart(const Vec: TMtxVec): TMtxVec;

Gets the imaginary part of a complex object.

#	Name	Type	Description
1	Vec	TMtxVec	source TVec or TMtx

Result: stored in self (calling object), returns self for chaining

Remarks:

Gets the imaginary part of a complex object Vec and stores the real results in the calling object. Size and TMtxVec.Complex properties of the calling object are set implicitly to match Vec object. Vec TMtxVec.Complex must be true otherwise the exception will be raised.

Examples

var a,b: Matrix;
begin
    a.SetIt(1,2,True,[1,2,3,4]);  // a= [1+2i, 3+4i]
    b.ImagPart(a);  // b = [2, 4]
end;

Indexed: function ImagPart(const Vec: TMtxVec; VecIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Gets the imaginary part of complex object Vec elements [VecIndex]..[VecIndex+Len-1].

#	Name	Type	Description
1	Vec	TMtxVec	source TVec or TMtx
2	VecIndex	Integer
3	Index	Integer	start index
4	Len	Integer	element count

Result: stored in self (calling object), returns self for chaining

Remarks:

Stores the result in calling object. An exception is raised if the calling object is complex, if Vec is not complex or if array borders are overrun/underrun.