Matrix.Sqr Method

Overload List

#	Signature	Description
1	function Sqr: TMtxVec;	Square.
	└ indexed: function Sqr(Index: Integer; Len: Integer): TMtxVec;
2	function Sqr(const X: TMtxVec): TMtxVec;	Calculate the square of all X object elements and store the results in the calling object.
	└ indexed: function Sqr(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function Sqr: TMtxVec;

Square.

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

Remarks:

Calculate the square of all caling object elements in-place.

Examples

var a: Matrix;
begin
    a.SetIt(True,[1,2,3,4]);
    a.Sqr; // a=[1,4,9,16]
end;

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

See Also: Matrix.Sqrt, Matrix.Power

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

Calculate the square of calling object elements [Index]...[Index+Len-1] in-place.

#	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.

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

Calculate the square of all X object elements and store the results in the calling object.

#	Name	Type	Description
1	X	TMtxVec

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

Remarks:

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

Examples

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

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

Calculate the square of X object elements [XIndex]..[XIndex+Len-1]. The results are stored in calling object elements [Index]..[Index+Len-1].

#	Name	Type	Description
1	X	TMtxVec
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:

Size and Matrix.Complex properties of the calling object are not changed. An exception is raised if array borders are overrun.