TSparseMtx.Mag Method

Overload List

#	Signature	Description
1	function Mag: TMtxVec;	Magnitude.
	└ indexed: function Mag(Index: Integer; Len: Integer): TMtxVec;
2	function Mag(const X: TMtxVec): TMtxVec;	Calculate the magnitude for all X elements.
	└ indexed: function Mag(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function Mag: TMtxVec;

Magnitude.

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

Remarks:

Calculate the magnitude for all calling object elements in-place. This method has the same function as the TMtxVec.Abs method.

Examples

var a: Matrix;
begin
    a.SetIt(1,4,false,[1,-2,3,4]); // a = [1,-2, 3,4]
    a.Mag;      // a = [1, 2, 3,4]
end;

Indexed: function Mag(Index: Integer; Len: Integer): TMtxVec;

Calculate the magnitude for calling object elements [Index]..[Index+Len-1] in-place.

#	Name	Type	Description
1	Index	Integer	start index
2	Len	Integer	element count

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

Remarks:

An exception is raised if TMtxVecBase.ConditionCheck is True and array borders are overrun.

Overload 2: function Mag(const X: TMtxVec): TMtxVec;

Calculate the magnitude for all X elements.

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx

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

Remarks:

Store the results in the calling object elements. Size and TMtxVec.Complex properties of the calling vector are set implicitly to match Vec vector.

Indexed: function Mag(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Calculate the magnitude for X elements [XIndex]..[XIndex+Len-1].

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

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

Remarks:

Store the results in the calling object elements [Index]..[Index+Len-1]. Size and TMtxVec.Complex properties of the calling object must be set explicitly. An exception is raised if TMtxVecBase.ConditionCheck is True and array borders are overrun.