hirondelle.formula.function.builtin
Class Arctangent2

Object
  hirondelle.formula.function.builtin.Arctangent2

All Implemented Interfaces:

Function

public final class Arctangent2
extends Object
implements Function

arctan2(y,x): arc-tangent of a number.

Constructor Summary

Arctangent2()

Method Summary

Decimal

calculate(Decimal... aArgs) Returns a value in the range -pi..+pi.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Arctangent2

public Arctangent2()

Method Detail

calculate

public Decimal calculate(Decimal... aArgs)

Returns a value in the range -pi..+pi.

This function takes two arguments, y and x, corresponding to Cartesian coordinates. Note the order of the arguments (y comes first).

Converts the position to polar coordinates (r,θ), and returns the value of θ.

Specified by:

calculate in interface Function

Parameters:

aArgs - 0 or more arguments to the function.