Formula 1.0.0

Package hirondelle.formula.function.builtin

The built-in functions provided with Formula4J.

See:
          Description

Class Summary
Abs abs(x): absolute value of a number.
Arccosine arccos(x): arc-cosine of a number.
Arcsine arcsin(x): arc-sine of a number.
Arctangent arctan(x): arc-tangent of a number.
Arctangent2 arctan2(y,x): arc-tangent of a number.
ArithmeticMean avg(x1,x2,x3,...): the arithmetic mean of a set of numbers.
Bearing bearing(φ1, λ1, φ2, λ2): the compass bearing from one place to another.
Ceil ceil(x): round a number up to the nearest integer.
Combination combination(n,k): the number of combinations, selecting k of n.
Cosine cos(x): the cosine of an angle.
CubeRoot cbrt(x): cube root of a number.
DayFromJD dayfromjd(jd): convert a Julian Date into a calendar date.
DaysBetween daysbetween(y1,m1,d1, y2,m2,d2): the number of days between two calendar dates.
DaysMinus daysminus(y,m,d,n): a date n days before a given date.
DaysPlus daysplus(y,m,d,n): a date n days after a given date.
DaysSince dayssince(y,m,d): the number of days since a given date.
DaysUntil daysuntil(y,m,d): the number of days until a given date.
Degrees deg(x): convert radians to degrees.
Distance distance(φ1, λ1, φ2, λ2): the distance in kilometres from one place to another.
Exp exp(x): the exponential function; e raised to the given power.
Factorial factorial(x): the factorial of an integer, in the range 0..300.
Floor floor(x): round a number down to the nearest integer.
HyperbolicCosine cosh(x): the hyperbolic cosine of a number.
HyperbolicSine sinh(x): the hyperbolic sine of a number.
HyperbolicTangent tanh(x): the hyperbolic tangent of a number.
Investment invest(principal, interest-rate, years, times-per-year): compound interest on an investment.
JulianDate jd(year, month, day): the Julian Date of a calendar date.
LoanPayment pmt(principal,interest,months): monthly payment needed to pay back a loan or mortgage.
LogBase10 log(x): log base 10 of a positive number.
Max max(x1, x2, x3, ...): the maximum value in a set of numbers.
Median median(x1,x2,x3,...): the median of a set of numbers.
Min min(x1, x2, x3, ...): the minimum value in a set of numbers.
ModifiedJulianDate mjd(year, month, day): the Modified Julian Date of a calendar date.
NaturalLog ln(x): natural log of a positive number.
Permutation permutation(n,k): the number of permutations, selecting k of n.
PopulationStandardDeviation pstdev(x1, x2, x3, ...): the population standard deviation of a set of 2 or more numbers.
Power pow(x,y): raise x to the power y.
Radians rad(x): convert degrees to radians.
RandomGaussian randg(mean, variance): a pseudo-random number with a gaussian distribution.
RandomNumber rand(x): a pseudo-random number in a certain range.
Round round(x): round to 0 or more decimals.
SampleStandardDeviation sstdev(x1, x2, x3, ...): the sample standard deviation of a set of 2 or more numbers.
Sign sign(x): the sign of a number.
Sine sin(x): the sine of an angle.
SquareRoot sqrt(x): the square root of a number.
Sum sum(x1, x2, x3, ...): the sum of a set of numbers.
Tangent tan(x): the tangent of an angle.
Weekday weekday(year, month, day): the day of the week for the given calendar day.
 

Package hirondelle.formula.function.builtin Description

The built-in functions provided with Formula4J.


Formula 1.0.0

Copyright Hirondelle Systems. Published January 31, 2013