clMatrix.Mag Method

Overload List

#	Signature	Description
1	TOpenCLMtxVec Mag	Magnitude.
	└ indexed: TOpenCLMtxVec Mag(Int32 Index, Int32 Len)
2	TOpenCLMtxVec Mag(TOpenCLMtxVec X)	Calculate the magnitude for all X elements.
	└ indexed: TOpenCLMtxVec Mag(TOpenCLMtxVec X, Int32 XIndex, Int32 Index, Int32 Len)

Overload 1: TOpenCLMtxVec 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.clMatrix.Abs method.

Examples

clMatrix a;
a.CopyFromArray(2,2,TSingleArray.Create(1,-2,3,4)); // a = new double[] {1,-2, 3,4}
a.Mag;      // a = new double[] {1, 2, 3,4}

See Also: clMatrix.Abs, clMatrix.PhaseSpectrum

Indexed: TOpenCLMtxVec Mag(Int32 Index, Int32 Len)

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 array borders are overrun.

Overload 2: TOpenCLMtxVec Mag(TOpenCLMtxVec X)

Calculate the magnitude for all X elements.

#	Name	Type	Description
1	X	TOpenCLMtxVec	source TOpenCLVector or TOpenCLMatrix

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

Remarks:

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

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

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

#	Name	Type	Description
1	X	TOpenCLMtxVec	source TOpenCLVector or TOpenCLMatrix
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:

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