TSparseMtx.Abs Method

Overload List

#	Signature	Description
1	function Abs: TMtxVec;	Absolute values.
	└ indexed: function Abs(Index: Integer; Len: Integer): TMtxVec;
2	function Abs(const X: TMtxVec): TMtxVec;	Calculate the absolute value for all X object and store the results in the calling object.
	└ indexed: function Abs(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function Abs: TMtxVec;

Absolute values.

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

Remarks:

Calculate the absolute value of all calling object elements in-place.

Examples

var a,b: Matrix;
begin
    a.SetIt(1,2,True,[1,-2,3,4]);
    a.Abs;
    a := Abs(a); //same as a.Abs
    b.Abs(a);   //same as b := Abs(a);
    b := Abs(a);
end;

var
    a, expected: Matrix;
begin
    a := [[-3.0, -1.0], [1.0, 2.0]];
    a.Abs;
    expected := [[3.0, 1.0], [1.0, 2.0]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.Abs: mismatch');
end;

Indexed: function Abs(Index: Integer; Len: Integer): TMtxVec;

Calculate the absolute value for calling object elements [Index]..[Index+Len-1].

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

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

Remarks:

An exception is raised if array borders are overrun or underrun.

Examples

Uses MtxVecInt;

procedure Example;
var a: TMtxInt;
c: double;
begin
    CreateIt(a);
    a.SetIt([1,-2,3,4]);
    a.Abs; // a = [1,2,3,4]
    FreeIt(a);
end;

Overload 2: function Abs(const X: TMtxVec): TMtxVec;

Calculate the absolute value for all X object and store the results in the calling object.

#	Name	Type	Description
1	X	TMtxVec	source TVec or TMtx

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

Remarks:

Size and TMtxVec.Complex properties of calling object are adjusted automatically.

Examples

var
    a, x, expected: Matrix;
begin
    x := [[-3.0, -1.0], [1.0, 2.0]];
    a.Abs(x);
    expected := [[3.0, 1.0], [1.0, 2.0]];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Matrix.Abs: mismatch');
end;

Indexed: function Abs(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Calculate the absolute value of X object elements [XIndex]..[XIndex+Len-1].

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

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

Remarks:

Store the results in calling object elements [Index]..[Index+Len-1]. An exception is raised if array borders are overrun or underrun.