Vector.ArcTan Method

Overload List

#	Signature	Description
1	function ArcTan: TMtxVec;	Inverse tangens.
	└ indexed: function ArcTan(Index: Integer; Len: Integer): TMtxVec;
2	function ArcTan(const X: TMtxVec): TMtxVec;	Calculate the inverse tangens of all X object elements.
	└ indexed: function ArcTan(const X: TMtxVec; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function ArcTan: TMtxVec;

Inverse tangens.

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

Remarks:

Calculate the inverse tangens for all calling object elements in-place. The return values are expressed in radians.

Examples

var A,B: Vector;
begin
    A.SetIt(2,2,True,[1,0, 2,0
        2,0  4,1]);  // 2x2, complex matrix
    B.ArcTan(A); // or
    B := ArcTan(A);  // or
    A := ArcTan(A);
end;

var
    a, expected: Vector;
begin
    a := [0.0, 0.5, 1.0, 2.0];
    a.ArcTan;
    expected := [0.0, 0.463647609000806, 0.785398163397448, 1.10714871779409];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Vector.ArcTan: mismatch');
end;

See Also: Vector.Tan, Vector.ArcCot, Vector.ArcTan2

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

Calculate the inverse tangens 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 ArcTan(const X: TMtxVec): TMtxVec;

Calculate the inverse tangens of all X object elements.

#	Name	Type	Description
1	X	TMtxVec

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

Remarks:

Store the results in the calling object. Size and Vector.Complex properties of calling object are adjusted automatically.

Examples

var
    a, x, expected: Vector;
begin
    x := [0.0, 0.5, 1.0, 2.0];
    a.ArcTan(x);
    expected := [0.0, 0.463647609000806, 0.785398163397448, 1.10714871779409];
    if not a.IsEqual(expected, 1e-10, TCompare.cmpAbsolute) then
        raise Exception.Create('Vector.ArcTan: mismatch');
end;

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

Calculate the inverse tangens of X object elements [XIndex]...[XIndex+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:

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