clVector::NormL2 Method

clVector Struct

Overload List

#SignatureDescription
1double NormL2(TOpenCLMtxVec *Vec, bool RelativeError = false) const;The L2-norm.
2double NormL2(TOpenCLMtxVec *Vec, int VecIndex, int Index, int Len, bool RelativeError = false) const;Calculates the L2 norm ||V-Vec|| between Vec elements [VecIndex]..[VecIndex+Len-1] and calling vector elements [Index]..[Index+Len-1].
3double NormL2() const;Calculate the L2-norm of the calling vector.
4double NormL2(int Index, int Len) const;Calculates the L2 norm from calling vector elements [Index]..[Index+Len-1].

Overload 1: double NormL2(TOpenCLMtxVec *Vec, bool RelativeError = false) const;

The L2-norm.

#NameTypeDescription
1VecTOpenCLMtxVec *
2RelativeError = falsebool

Returns: L2 norm, defined by ||V-Vec||, where V is calling vector.

Remarks:

If the NormL2 is called without any parameters, the NormL2 calculates the norm of calling vector. The L2 norm of ||V-Vec|| is defined by the formula:

∥V−Vec∥L2=∑k=0Length−1(∣V[k]−Vec[k]∣)2\|\text{V} - \text{Vec}\| _{L2} = \sqrt{\sum _{k=0} ^{\text{Length}-1}\left(|\text{V}[k]-\text{Vec}[k]| \right)^2}

If RelativeError is true then the computed norm is divided by the norm of V, and the function returns the "relative error":

∥V−Vec∥∥V∥\frac{\| \text{V} - \text{Vec}\|}{\|\text{V}\|}
See Also: clVector::NormC, clVector::NormL1
Declared in Dew::Math::clVector · Dew.Math/clMtxExpr.h · Cross-compiler

Overload 2: double NormL2(TOpenCLMtxVec *Vec, int VecIndex, int Index, int Len, bool RelativeError = false) const;

Calculates the L2 norm ||V-Vec|| between Vec elements [VecIndex]..[VecIndex+Len-1] and calling vector elements [Index]..[Index+Len-1].

#NameTypeDescription
1VecTOpenCLMtxVec *
2VecIndexint
3Indexint
4Lenint
5RelativeError = falsebool
Declared in Dew::Math::clVector · Dew.Math/clMtxExpr.h · Cross-compiler

Overload 3: double NormL2() const;

Calculate the L2-norm of the calling vector.

Returns: L2 norm, defined by: NormaL2 = ( Sum(|a[i]|^2) )^0.5 , 0 < i < Length-1 .

Declared in Dew::Math::clVector · Dew.Math/clMtxExpr.h · Cross-compiler

Overload 4: double NormL2(int Index, int Len) const;

Calculates the L2 norm from calling vector elements [Index]..[Index+Len-1].

#NameTypeDescription
1Indexint
2Lenint
Declared in Dew::Math::clVector · Dew.Math/clMtxExpr.h · Cross-compiler