Matrix.Mag Method

Overload List

#	Signature	Description
1	TMtxVec Mag	Magnitude.
	└ indexed: TMtxVec Mag(Int32 Index, Int32 Len)
2	TMtxVec Mag(TMtxVec X)	Calculate the magnitude for all X elements and store the results in the calling object elements.
	└ indexed: TMtxVec Mag(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

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 Dew.Math.Matrix.Abs method.

Examples

Matrix a;
a.SetIt(1,4,false,new double[] {1,-2,3,4}); // a = new double[] {1,-2, 3,4}
a.Mag;      // a = new double[] {1, 2, 3,4}

See Also: Matrix.Abs, Matrix.PhaseSpectrum

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

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

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

Remarks:

An exception is raised if Dew.Math.Matrix.ConditionCheck is True and array borders are overrun.

Calculate the magnitude for all X elements and store the results in the calling object elements.

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx

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

Remarks:

Size and and Dew.Math.Matrix.Complex properties of the calling Matrix are set implicitly to match Vec Matrix.

Calculate the magnitude for X elements [XIndex]..[XIndex+Len-1] and store the results in the calling object elements [Index]..[Index+Len-1].

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

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

Remarks:

Size and Dew.Math.Matrix.Complex properties of the calling object must be set explicitly. An exception is raised if Dew.Math.Matrix.ConditionCheck is True and array borders are overrun.