Matrix.Round Method

Overload List

#SignatureDescription
1TMtxVec RoundElements rounded to the nearest whole number.
└ indexed: TMtxVec Round(Int32 Index, Int32 Len)
2TMtxVec Round(TMtxVec Src)Round all Src object elements and store the results in calling object elements.
└ indexed: TMtxVec Round(TMtxVec Src, Int32 SrcIndex, Int32 Index, Int32 Len)
3void Round(ref Int32[] Dst)Rounds the calling object elements to 4 byte integers and stores the result in the Dst array.

Overload 1: TMtxVec Round

Elements rounded to the nearest whole number.

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

Remarks:

Rounds all calling object elements to the nearest whole number. The result can be stored to an array of integers or as floating point number.

Examples
Matrix a = new Matrix();
a.SetIt(2, 2, false, new double[] { 1.2, 2.7, -0.5, 3.9 });
a.Round();
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 1.0, 3.0, -1.0, 4.0 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.Round: mismatch");
See Also: Matrix.Trunc, Matrix.Frac

Indexed: TMtxVec Round(Int32 Index, Int32 Len)

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

Overload 2: TMtxVec Round(TMtxVec Src)

Round all Src object elements and store the results in calling object elements.

#NameTypeDescription
1SrcTMtxVecsource TVec or TMtx

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

Remarks:

Size and Dew.Math.Matrix.Complex property of calling object are adjusted automatically.

Examples
Matrix a = new Matrix();
a.SetIt(2, 2, false, new double[] { 1.2, 2.7, -0.5, 3.9 });
a.Round();
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 1.0, 3.0, -1.0, 4.0 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.Round: mismatch");

Indexed: TMtxVec Round(TMtxVec Src, Int32 SrcIndex, Int32 Index, Int32 Len)

Round Src object elements [SrcIndex]..[SrcIndex+Len-1].

#NameTypeDescription
1SrcTMtxVecsource TVec or TMtx
2SrcIndexInt32source start index
3IndexInt32start index
4LenInt32element count

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

Remarks:

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

Overload 3: void Round(ref Int32[] Dst)

Rounds the calling object elements to 4 byte integers and stores the result in the Dst array.

#NameTypeDescription
1DstInt32[] (ref)

Result: stored in self (calling object)

Remarks:

The size of the Dst array is set automatically. If the complex property is True then the length of the array will be equal to Self.Length*2.

Examples
Matrix a = new Matrix();
a.SetIt(2, 2, false, new double[] { 1.2, 2.7, -0.5, 3.9 });
a.Round();
Matrix expected = new Matrix();
expected.SetIt(2, 2, false, new double[] { 1.0, 3.0, -1.0, 4.0 });
if (!a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute))
    throw new Exception("Matrix.Round: mismatch");