TVec.Mag Method

Overload List

#SignatureDescription
1TMtxVec MagMagnitude.
└ indexed: TMtxVec Mag(Int32 Index, Int32 Len)
2TMtxVec Mag(TMtxVec X)Calculate the magnitude for all X elements.
└ indexed: TMtxVec Mag(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

Overload 1: TMtxVec Mag

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.TMtxVec.Abs method.

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

Indexed: TMtxVec Mag(Int32 Index, Int32 Len)

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

#NameTypeDescription
1IndexInt32start index
2LenInt32element count

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

Remarks:

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

Overload 2: TMtxVec Mag(TMtxVec X)

Calculate the magnitude for all X elements.

#NameTypeDescription
1XTMtxVecsource TVec or TMtx

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

Remarks:

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

Indexed: TMtxVec Mag(TMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

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

#NameTypeDescription
1XTMtxVecsource TVec or TMtx
2XIndexInt32X start index
3IndexInt32start index
4LenInt32element 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 Dew.Math.TMtxVec.Complex properties of the calling object must be set explicitly. An exception is raised if Dew.Math.TMtxVecBase.ConditionCheck is True and array borders are overrun.