Functions (AgMIP Common Functions 1.3.8 API)

java.lang.Object
- org.agmip.common.Functions

```
public class Functions
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Functions.CompareMode
compare mode

Nested Classes
Modifier and Type	Class and Description
`static class`	`Functions.CompareMode` compare mode

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`acos(String value)` Returns the arc cosine of a value; the returned angle is in the range 0.0 through pi.
`static String`	`asin(String value)` Returns the arc sine of a value; the returned angle is in the range -pi/2 through pi/2.
`static String`	`atan(String value)` Returns the arc tangent of a value; the returned angle is in the range -pi/2 through pi/2.
`static String`	`average(int scale, String... values)` Get the average of all input numbers with given scale.
`static String`	`average(String... values)` Get the average of all input numbers.
`static String`	`calcDAP(String date, String pdate)`
`static String`	`checkPctVal(String pctVal)`
`static boolean`	`clearDirectory(File dir)`
`static boolean`	`compare(String v1, String v2, Functions.CompareMode mode)` Compare the input number by given mode The scale will depends on the scale of input number when the result is indivisible Any numeric string recognized by `BigDecimal` is supported.
`static Date`	`convertFromAgmipDateString(String agmipDate)` Convert from AgMIP standard date string (YYYYMMDD) to a `Date`
`static String`	`convertMsToDay(long ms)`
`static String`	`convertToAgmipDateString(Date date)` Convert from `Date` to AgMIP standard date string (YYYYMMDD)
`static String`	`cos(String value)` Returns the trigonometric cosine of an angle.
`static String`	`dateOffset(String initial, String offset)` Offset an AgMIP standard date string (YYYYMMDD) by a set number of days.
`static String`	`divide(String dividend, String divisor)` Get the result of dividend divided by divisor.
`static String`	`divide(String dividend, String divisor, int scale)` Get the result of dividend divided by divisor with given scale.
`static String`	`exp(String exponent)` Returns Euler's number e raised to the power of a `double` value.
`static String`	`formatAgmipDateString(String agmipDate, String format)` Convert from AgMIP standard date string (YYMMDD) to a custom date string
`static String`	`getStackTrace(Throwable aThrowable)` Gathering the messages from a `Throwable` instance and its back trace
`static String`	`log(String val)` Returns the natural logarithm (base e) of a `double` value.
`static String`	`max(String... values)` Returns the maximum number from a group of input value.
`static String`	`min(String... values)` Returns the minimum number from a group of input value.
`static String`	`multiply(String f1, String f2)` Multiply two numbers together Any numeric string recognized by `BigDecimal` is supported.
`static String`	`numericOffset(String initial, String offset)` Offset a numeric string by another numeric string.
`static BigInteger`	`numericStringToBigInteger(String numeric)` Converts a numeric string to a `BigInteger`.
`static BigInteger`	`numericStringToBigInteger(String numeric, boolean round)` Converts a numeric string to a `BigInteger`.
`static String`	`pow(String base, String exponent)` Returns the value of the first argument raised to the power of the second argument.
`static String`	`product(String... factors)` Get the product of all input numbers Any numeric string recognized by `BigDecimal` is supported.
`static String[]`	`removeNull(String[] in)` Remove the null value in the input String array
`static String`	`revisePath(String path)` Revise output path
`static String`	`round(String value, int scale)` Returns the closest `decimal` to the argument, with given scale, using HALF_UP mode Any numeric string recognized by `BigDecimal` is supported.
`static String`	`sin(String value)` Returns the trigonometric sine of an angle.
`static String`	`sqrt(String value)` Returns the correctly rounded positive square root of a `double` value.
`static String`	`substract(String minuend, String... subtrahends)` Get the difference of minuend and all subtrahends Any numeric string recognized by `BigDecimal` is supported.
`static String`	`sum(String... addends)` Get the sum of all input numbers Any numeric string recognized by `BigDecimal` is supported.
`static String`	`tan(String value)` Returns the trigonometric tangent of an angle.
`static String`	`yearOffset(String initial, String offset)` Offset an AgMIP standard date string (YYYYMMDD) by a set number of years.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - numericStringToBigInteger
```
public static BigInteger numericStringToBigInteger(String numeric)
```
    Converts a numeric string to a BigInteger. This function first converts to a BigDecimal to make sure the base number being used is accurate. By default, this method uses the ROUND_HALF_UP rounding method from BigDecimal. If the string cannot be converted, this method returns null
    
    Parameters:
    numeric - A numeric string (with or without decimals).
    
    Returns:
    BigInteger representation of the string or null.
    See Also:
    BigDecimal
  - numericStringToBigInteger
```
public static BigInteger numericStringToBigInteger(String numeric,
                                   boolean round)
```
    Converts a numeric string to a BigInteger. This function first converts to a BigDecimal to make sure the base number being used is accurate. If round is set to true this method uses the ROUND_HALF_UP rounding method from BigDecimal. Otherwise the decimal part is dropped. If the string cannot be converted, this method returns null
    
    Parameters:
    numeric - A numeric string (with or without decimals).
    round - Use BigDecimal.ROUND_HALF_UP method.
    
    Returns:
    BigInteger representation of the string or null
    See Also:
    BigDecimal
  - convertFromAgmipDateString
```
public static Date convertFromAgmipDateString(String agmipDate)
```
    Convert from AgMIP standard date string (YYYYMMDD) to a Date
    
    Parameters:
    agmipDate - AgMIP standard date string
    
    Returns:
    Date represented by the AgMIP date string or null
  - convertToAgmipDateString
```
public static String convertToAgmipDateString(Date date)
```
    Convert from Date to AgMIP standard date string (YYYYMMDD)
    
    Parameters:
    date - Date object
    
    Returns:
    an AgMIP standard date string representation of date.
  - formatAgmipDateString
```
public static String formatAgmipDateString(String agmipDate,
                           String format)
```
    Convert from AgMIP standard date string (YYMMDD) to a custom date string
    
    Parameters:
    agmipDate - AgMIP standard date string
    format - Destination format
    
    Returns:
    a formatted date string or null
  - calcDAP
```
public static String calcDAP(String date,
             String pdate)
```
  - convertMsToDay
```
public static String convertMsToDay(long ms)
```
  - dateOffset
```
public static String dateOffset(String initial,
                String offset)
```
    Offset an AgMIP standard date string (YYYYMMDD) by a set number of days.
    
    Parameters:
    initial - AgMIP standard date string
    offset - number of days to offset (can be positive or negative integer)
    
    Returns:
    AgMIP standard date string of initial + offset
  - yearOffset
```
public static String yearOffset(String initial,
                String offset)
```
    Offset an AgMIP standard date string (YYYYMMDD) by a set number of years.
    
    Parameters:
    initial - AgMIP standard date string
    offset - number of years to offset (can be positive or negative integer)
    
    Returns:
    AgMIP standard date string of initial + offset
  - numericOffset
```
public static String numericOffset(String initial,
                   String offset)
```
    Offset a numeric string by another numeric string. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    initial - A valid number string
    offset - A valid number string
    
    Returns:
    a number string with the precision matching the highest precision argument.
    See Also:
    BigDecimal
  - multiply
```
public static String multiply(String f1,
              String f2)
```
    Multiply two numbers together Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    f1 - A valid number string
    f2 - A valid number string
    
    Returns:
    f1*f2
    See Also:
    BigDecimal
  - sum
```
public static String sum(String... addends)
```
    Get the sum of all input numbers Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    addends - one or more valid number strings
    
    Returns:
    addends[0] + addends[1] + ...
    See Also:
    BigDecimal
  - substract
```
public static String substract(String minuend,
               String... subtrahends)
```
    Get the difference of minuend and all subtrahends Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    minuend - A valid number string
    subtrahends - one or more valid number strings
    
    Returns:
    minuend - subtrahends[0] - subtrahends[1] - ...
    See Also:
    BigDecimal
  - product
```
public static String product(String... factors)
```
    Get the product of all input numbers Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    factors - one or more valid number strings
    
    Returns:
    factors[0] * factors[1] * ...
    See Also:
    BigDecimal
  - divide
```
public static String divide(String dividend,
            String divisor)
```
    Get the result of dividend divided by divisor. When the result is indivisible, the scale will depends on the scale of dividend and divisor. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    dividend - A valid number string
    divisor - A valid number strings
    
    Returns:
    dividend / divisor
    See Also:
    BigDecimal
  - divide
```
public static String divide(String dividend,
            String divisor,
            int scale)
```
    Get the result of dividend divided by divisor with given scale. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    dividend - A valid number string
    divisor - A valid number strings
    scale - scale of the BigDecimal quotient to be returned.
    
    Returns:
    dividend / divisor
    See Also:
    BigDecimal
  - average
```
public static String average(String... values)
```
    Get the average of all input numbers. When the result is indivisible, the scale will depends on the scale of all input numbers Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    values - one or more valid number strings
    
    Returns:
    (values[0] + values[1] + ...) / values.length
    See Also:
    BigDecimal
  - average
```
public static String average(int scale,
             String... values)
```
    Get the average of all input numbers with given scale. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    scale - of the BigDecimal quotient to be returned.
    values - one or more valid number strings
    
    Returns:
    (values[0] + values[1] + ...) / values.length
    See Also:
    BigDecimal
  - exp
```
public static String exp(String exponent)
```
    Returns Euler's number e raised to the power of a double value. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    exponent - A valid number string
    
    Returns:
    the value e^value, where e is the base of the natural logarithms.
    See Also:
    BigDecimal
  - log
```
public static String log(String val)
```
    Returns the natural logarithm (base e) of a double value. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    val - A valid number string
    
    Returns:
    the value ln a, the natural logarithm of a.
    See Also:
    BigDecimal
  - min
```
public static String min(String... values)
```
    Returns the minimum number from a group of input value. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    values - One of more valid number strings
    
    Returns:
    the minimum number.
    See Also:
    BigDecimal
  - max
```
public static String max(String... values)
```
    Returns the maximum number from a group of input value. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    values - One of more valid number strings
    
    Returns:
    the maximum number.
    See Also:
    BigDecimal
  - pow
```
public static String pow(String base,
         String exponent)
```
    Returns the value of the first argument raised to the power of the second argument. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    base - the base.
    exponent - the exponent.
    
    Returns:
    the value base^exponent.
  - sqrt
```
public static String sqrt(String value)
```
    Returns the correctly rounded positive square root of a double value. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number
    
    Returns:
    the positive square root of value.
  - cos
```
public static String cos(String value)
```
    Returns the trigonometric cosine of an angle. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number for an angle, in radians
    
    Returns:
    the cosine of the argument
  - sin
```
public static String sin(String value)
```
    Returns the trigonometric sine of an angle. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number for an angle, in radians
    
    Returns:
    the sine of the argument
  - tan
```
public static String tan(String value)
```
    Returns the trigonometric tangent of an angle. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number for an angle, in radians
    
    Returns:
    the tangent of the argument
  - acos
```
public static String acos(String value)
```
    Returns the arc cosine of a value; the returned angle is in the range 0.0 through pi. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number for an angle, in radians
    
    Returns:
    the arc cosine of the argument.
  - asin
```
public static String asin(String value)
```
    Returns the arc sine of a value; the returned angle is in the range -pi/2 through pi/2. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number for an angle, in radians
    
    Returns:
    the arc sine of the argument.
  - atan
```
public static String atan(String value)
```
    Returns the arc tangent of a value; the returned angle is in the range -pi/2 through pi/2. Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number for an angle, in radians
    
    Returns:
    the arc tangent of the argument.
  - round
```
public static String round(String value,
           int scale)
```
    Returns the closest decimal to the argument, with given scale, using HALF_UP mode Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    value - A valid number string
    
    Returns:
    the rounded number.
    See Also:
    BigDecimal
  - compare
```
public static boolean compare(String v1,
              String v2,
              Functions.CompareMode mode)
```
    Compare the input number by given mode The scale will depends on the scale of input number when the result is indivisible Any numeric string recognized by BigDecimal is supported.
    
    Parameters:
    v1 - A valid number strings
    v2 - A valid number strings
    mode - The compare mode
    
    Returns:
    the boolean compare result based on given mode; invalid mode or value will return false
    See Also:
    BigDecimal
  - getStackTrace
```
public static String getStackTrace(Throwable aThrowable)
```
    Gathering the messages from a Throwable instance and its back trace
    
    Parameters:
    aThrowable -
    
    Returns:
    The trace messages
  - removeNull
```
public static String[] removeNull(String[] in)
```
    Remove the null value in the input String array
    
    Parameters:
    in - The input String values
    
    Returns:
    The input String without null value
  - clearDirectory
```
public static boolean clearDirectory(File dir)
```
  - checkPctVal
```
public static String checkPctVal(String pctVal)
```
  - revisePath
```
public static String revisePath(String path)
```
    Revise output path
    
    Parameters:
    path - the output path
    
    Returns:
    revised path

Class Functions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

numericStringToBigInteger

numericStringToBigInteger

convertFromAgmipDateString

convertToAgmipDateString

formatAgmipDateString

calcDAP

convertMsToDay

dateOffset

yearOffset

numericOffset

multiply

sum

substract

product

divide

divide

average

average

exp

log

min

max

pow

sqrt

cos

sin

tan

acos

asin

atan

round

compare

getStackTrace

removeNull

clearDirectory

checkPctVal

revisePath