Matrix.ArcTan2 Method

TMtxVec ArcTan2(TMtxVec Y, TMtxVec X)

Inverse tangens of Y/X.

#NameTypeDescription
1YTMtxVecsource TVec or TMtx
2XTMtxVecsource TVec or TMtx

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

Remarks:

Calculates the inverse tangens of Y/X, and returns an angle in the correct quadrant. The results are stored in calling object elements. Size and Dew.Math.Matrix.Complex properties of calling object are adjusted automatically to match those of X and Y objects. An exception is raised if X and Y size and Dew.Math.Matrix.Complex properties do not match.

The result will fall in the range from -PI to PI radians.

Note
Dew.Math.Matrix.ArcTan is calculated as ArcTan2(1, X).

See Also: Matrix.ArcTan

Indexed: TMtxVec ArcTan2(TMtxVec Y, TMtxVec X, Int32 YIndex, Int32 XIndex, Int32 Index, Int32 Len)

Calculate the inverse tangens of Y/X by using Y elements [YIndex]..[YIndex+Len-1], X elements [XIndex]..[XIndex+Len-1] and store the results in calling object elements [Index]..[Index+Len-1].

#NameTypeDescription
1YTMtxVecsource TVec or TMtx
2XTMtxVecsource TVec or TMtx
3YIndexInt32Y start index
4XIndexInt32X start index
5IndexInt32start index
6LenInt32element count

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

Remarks:

An exception is raised if array borders are overrun.