MathExpr (MarkLogic Java Client API 4.0.1 2017-05-03)

```
public interface MathExpr
```
Builds expressions to call functions in the math server library for a row pipeline.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`XsDoubleExpr`	`acos(XsDoubleExpr x)` Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
`XsDoubleExpr`	`asin(XsDoubleExpr x)` Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
`XsDoubleExpr`	`atan(XsDoubleExpr x)` Returns the arc tangent of x, in radians.
`XsDoubleExpr`	`atan2(XsDoubleExpr y, double x)` Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
`XsDoubleExpr`	`atan2(XsDoubleExpr y, XsDoubleExpr x)` Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
`XsDoubleExpr`	`ceil(XsDoubleExpr x)` Returns the smallest integer greater than or equal to x.
`XsDoubleExpr`	`correlation(JsonArraySeqExpr arg)` Returns the Pearson correlation coefficient of a data set.
`XsDoubleExpr`	`cos(XsDoubleExpr x)` Returns the cosine of x, in the range from -1 to +1 (inclusive).
`XsDoubleExpr`	`cosh(XsDoubleExpr x)` Returns the hyperbolic cosine of x.
`XsDoubleExpr`	`cot(XsDoubleExpr x)` Returns the cotangent of x.
`XsDoubleExpr`	`covariance(JsonArraySeqExpr arg)` Returns the sample covariance of a data set.
`XsDoubleExpr`	`covarianceP(JsonArraySeqExpr arg)` Returns the population covariance of a data set.
`XsDoubleExpr`	`degrees(XsDoubleExpr x)` Returns numeric expression converted from radians to degrees.
`XsDoubleExpr`	`exp(XsDoubleExpr x)` Returns e (approximately 2.71828182845905) to the xth power.
`XsDoubleExpr`	`fabs(XsDoubleExpr x)` Returns the absolute value of x.
`XsDoubleExpr`	`floor(XsDoubleExpr x)` Returns the largest integer less than or equal to x.
`XsDoubleExpr`	`fmod(XsDoubleExpr x, double y)` Returns the remainder of x/y.
`XsDoubleExpr`	`fmod(XsDoubleExpr x, XsDoubleExpr y)` Returns the remainder of x/y.
`ItemSeqExpr`	`frexp(XsDoubleExpr x)` Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent.
`XsDoubleExpr`	`ldexp(XsDoubleExpr y, long i)` Returns x*2^i.
`XsDoubleExpr`	`ldexp(XsDoubleExpr y, XsIntegerExpr i)` Returns x*2^i.
`MathLinearModelExpr`	`linearModel(JsonArraySeqExpr arg)` Returns a linear model that fits the given data set.
`XsDoubleSeqExpr`	`linearModelCoeff(MathLinearModelExpr linearModel)` Returns the coefficients of the linear model.
`XsDoubleExpr`	`linearModelIntercept(MathLinearModelExpr linearModel)` Returns the intercept of the linear model.
`XsDoubleExpr`	`linearModelRsquared(MathLinearModelExpr linearModel)` Returns the R^2 value of the linear model.
`MathLinearModelSeqExpr`	`linearModelSeq(MathLinearModelExpr... items)` Constructs a sequence of MathLinearModelExpr items.
`XsDoubleExpr`	`log(XsDoubleExpr x)` Returns the base-e logarithm of x.
`XsDoubleExpr`	`log10(XsDoubleExpr x)` Returns the base-10 logarithm of x.
`XsDoubleExpr`	`median(XsDoubleSeqExpr arg)` Returns the median of a sequence of values.
`XsAnyAtomicTypeSeqExpr`	`mode(XsAnyAtomicTypeSeqExpr arg)` Returns the mode of a sequence.
`XsAnyAtomicTypeSeqExpr`	`mode(XsAnyAtomicTypeSeqExpr arg, String options)` Returns the mode of a sequence.
`XsAnyAtomicTypeSeqExpr`	`mode(XsAnyAtomicTypeSeqExpr arg, XsStringSeqExpr options)` Returns the mode of a sequence.
`XsDoubleSeqExpr`	`modf(XsDoubleExpr x)` Returns x broken up into fraction and integer.
`XsDoubleSeqExpr`	`percentile(XsDoubleSeqExpr arg, double p)` Returns a sequence of percentile(s) given a sequence of percentage(s).
`XsDoubleSeqExpr`	`percentile(XsDoubleSeqExpr arg, XsDoubleSeqExpr p)` Returns a sequence of percentile(s) given a sequence of percentage(s).
`XsDoubleExpr`	`percentRank(XsAnyAtomicTypeSeqExpr arg, String value)` Returns the rank of a value in a data set as a percentage of the data set.
`XsDoubleExpr`	`percentRank(XsAnyAtomicTypeSeqExpr arg, String value, String options)` Returns the rank of a value in a data set as a percentage of the data set.
`XsDoubleExpr`	`percentRank(XsAnyAtomicTypeSeqExpr arg, XsAnyAtomicTypeExpr value)` Returns the rank of a value in a data set as a percentage of the data set.
`XsDoubleExpr`	`percentRank(XsAnyAtomicTypeSeqExpr arg, XsAnyAtomicTypeExpr value, XsStringSeqExpr options)` Returns the rank of a value in a data set as a percentage of the data set.
`XsDoubleExpr`	`pi()` Returns the value of pi.
`XsDoubleExpr`	`pow(XsDoubleExpr x, double y)` Returns x^y.
`XsDoubleExpr`	`pow(XsDoubleExpr x, XsDoubleExpr y)` Returns x^y.
`XsDoubleExpr`	`radians(XsDoubleExpr x)` Returns numeric expression converted from degrees to radians.
`XsIntegerExpr`	`rank(XsAnyAtomicTypeSeqExpr arg1, String arg2)` Returns the rank of a value in a data set.
`XsIntegerExpr`	`rank(XsAnyAtomicTypeSeqExpr arg1, String arg2, String options)` Returns the rank of a value in a data set.
`XsIntegerExpr`	`rank(XsAnyAtomicTypeSeqExpr arg1, XsAnyAtomicTypeExpr arg2)` Returns the rank of a value in a data set.
`XsIntegerExpr`	`rank(XsAnyAtomicTypeSeqExpr arg1, XsAnyAtomicTypeExpr arg2, XsStringSeqExpr options)` Returns the rank of a value in a data set.
`XsDoubleExpr`	`sin(XsDoubleExpr x)` Returns the sine of x, in the range from -1 to +1 (inclusive).
`XsDoubleExpr`	`sinh(XsDoubleExpr x)` Returns the hyperbolic sine of x.
`XsDoubleExpr`	`sqrt(XsDoubleExpr x)` Returns the square root of x.
`XsDoubleExpr`	`stddev(XsDoubleSeqExpr arg)` Returns the sample standard deviation of a sequence of values.
`XsDoubleExpr`	`stddevP(XsDoubleSeqExpr arg)` Returns the standard deviation of a population.
`XsDoubleExpr`	`tan(XsDoubleExpr x)` Returns the tangent of x.
`XsDoubleExpr`	`tanh(XsDoubleExpr x)` Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
`XsNumericExpr`	`trunc(XsNumericExpr arg)` Returns the number truncated to a certain number of decimal places.
`XsNumericExpr`	`trunc(XsNumericExpr arg, long n)` Returns the number truncated to a certain number of decimal places.
`XsNumericExpr`	`trunc(XsNumericExpr arg, XsIntegerExpr n)` Returns the number truncated to a certain number of decimal places.
`XsDoubleExpr`	`variance(XsDoubleSeqExpr arg)` Returns the sample variance of a sequence of values.
`XsDoubleExpr`	`varianceP(XsDoubleSeqExpr arg)` Returns the population variance of a sequence of values.

- Method Detail
  - acos
```
XsDoubleExpr acos(XsDoubleExpr x)
```
    Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
    Provides a client interface to a server function. See math:acos
    
    Parameters:
    
    x - The fraction to be evaluated. Must be in the range of -1 to +1 (inclusive).
    
    Returns:
    
    a XsDoubleExpr expression
  - asin
```
XsDoubleExpr asin(XsDoubleExpr x)
```
    Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
    Provides a client interface to a server function. See math:asin
    
    Parameters:
    
    x - The fraction to be evaluated. Must be in the range of -1 to +1 (inclusive).
    
    Returns:
    
    a XsDoubleExpr expression
  - atan
```
XsDoubleExpr atan(XsDoubleExpr x)
```
    Returns the arc tangent of x, in radians. in the range from -pi/2 to +pi/2 (inclusive).
    Provides a client interface to a server function. See math:atan
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - atan2
```
XsDoubleExpr atan2(XsDoubleExpr y,
                   double x)
```
    Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
    Provides a client interface to a server function. See math:atan2
    
    Parameters:
    
    y - The floating point dividend.
    
    x - The floating point divisor.
    
    Returns:
    
    a XsDoubleExpr expression
  - atan2
```
XsDoubleExpr atan2(XsDoubleExpr y,
                   XsDoubleExpr x)
```
    Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
    Provides a client interface to a server function. See math:atan2
    
    Parameters:
    
    y - The floating point dividend.
    
    x - The floating point divisor.
    
    Returns:
    
    a XsDoubleExpr expression
  - ceil
```
XsDoubleExpr ceil(XsDoubleExpr x)
```
    Returns the smallest integer greater than or equal to x.
    Provides a client interface to a server function. See math:ceil
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - correlation
```
XsDoubleExpr correlation(JsonArraySeqExpr arg)
```
    Returns the Pearson correlation coefficient of a data set. The size of the input array should be 2. The function eliminates all pairs for which either the first element or the second element is empty. After the elimination, if the length of the input is less than 2, the function returns the empty sequence. After the elimination, if the standard deviation of the first column or the standard deviation of the second column is 0, the function returns the empty sequence.
    Provides a client interface to a server function. See math:correlation
    
    Parameters:
    
    arg - The input data set. Each array should contain a pair of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - cos
```
XsDoubleExpr cos(XsDoubleExpr x)
```
    Returns the cosine of x, in the range from -1 to +1 (inclusive).
    Provides a client interface to a server function. See math:cos
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - cosh
```
XsDoubleExpr cosh(XsDoubleExpr x)
```
    Returns the hyperbolic cosine of x.
    Provides a client interface to a server function. See math:cosh
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - cot
```
XsDoubleExpr cot(XsDoubleExpr x)
```
    Returns the cotangent of x.
    Provides a client interface to a server function. See math:cot
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - covariance
```
XsDoubleExpr covariance(JsonArraySeqExpr arg)
```
    Returns the sample covariance of a data set. The size of the input array should be 2. The function eliminates all pairs for which either the first element or the second element is empty. After the elimination, if the length of the input is less than 2, the function returns the empty sequence.
    For the version of this that uses range indexes, see cts:covariance.
    Provides a client interface to a server function. See math:covariance
    
    Parameters:
    
    arg - The input data set. Each array should contain a pair of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - covarianceP
```
XsDoubleExpr covarianceP(JsonArraySeqExpr arg)
```
    Returns the population covariance of a data set. The size of the input array should be 2. The function eliminates all pairs for which either the first element or the second element is empty. After the elimination, if the length of the input is 0, the function returns the empty sequence.
    For the version of this that uses range indexes, see cts:covariance-p.
    Provides a client interface to a server function. See math:covariance-p
    
    Parameters:
    
    arg - The input data set. Each array should contain a pair of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - degrees
```
XsDoubleExpr degrees(XsDoubleExpr x)
```
    Returns numeric expression converted from radians to degrees.
    Provides a client interface to a server function. See math:degrees
    
    Parameters:
    
    x - An angle expressed in radians.
    
    Returns:
    
    a XsDoubleExpr expression
  - exp
```
XsDoubleExpr exp(XsDoubleExpr x)
```
    Returns e (approximately 2.71828182845905) to the xth power.
    Provides a client interface to a server function. See math:exp
    
    Parameters:
    
    x - The exponent to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - fabs
```
XsDoubleExpr fabs(XsDoubleExpr x)
```
    Returns the absolute value of x.
    Provides a client interface to a server function. See math:fabs
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - floor
```
XsDoubleExpr floor(XsDoubleExpr x)
```
    Returns the largest integer less than or equal to x.
    Provides a client interface to a server function. See math:floor
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - fmod
```
XsDoubleExpr fmod(XsDoubleExpr x,
                  double y)
```
    Returns the remainder of x/y.
    Provides a client interface to a server function. See math:fmod
    
    Parameters:
    
    x - The floating point dividend.
    
    y - The floating point divisor.
    
    Returns:
    
    a XsDoubleExpr expression
  - fmod
```
XsDoubleExpr fmod(XsDoubleExpr x,
                  XsDoubleExpr y)
```
    Returns the remainder of x/y.
    Provides a client interface to a server function. See math:fmod
    
    Parameters:
    
    x - The floating point dividend.
    
    y - The floating point divisor.
    
    Returns:
    
    a XsDoubleExpr expression
  - frexp
```
ItemSeqExpr frexp(XsDoubleExpr x)
```
    Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent.
    Provides a client interface to a server function. See math:frexp
    
    Parameters:
    
    x - The exponent to be evaluated.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - ldexp
```
XsDoubleExpr ldexp(XsDoubleExpr y,
                   long i)
```
    Returns x*2^i.
    Provides a client interface to a server function. See math:ldexp
    
    Parameters:
    
    y - The floating-point number to be multiplied.
    
    i - The exponent integer.
    
    Returns:
    
    a XsDoubleExpr expression
  - ldexp
```
XsDoubleExpr ldexp(XsDoubleExpr y,
                   XsIntegerExpr i)
```
    Returns x*2^i.
    Provides a client interface to a server function. See math:ldexp
    
    Parameters:
    
    y - The floating-point number to be multiplied.
    
    i - The exponent integer.
    
    Returns:
    
    a XsDoubleExpr expression
  - linearModel
```
MathLinearModelExpr linearModel(JsonArraySeqExpr arg)
```
    Returns a linear model that fits the given data set. The size of the input array should be 2, as currently only simple linear regression model is supported. The first element of the array should be the value of the dependent variable while the other element should be the value of the independent variable.
    The function eliminates all pairs for which either the first element or the second element is empty. After the elimination, if the length of the input is less than 2, the function returns the empty sequence. After the elimination, if the standard deviation of the independent variable is 0, the function returns a linear model with intercept = the mean of the dependent variable, coefficients = NaN and r-squared = NaN. After the elimination, if the standard deviation of the dependent variable is 0, the function returns a linear model with r-squared = NaN.
    For the version of this function that uses Range Indexes, see cts:linear-model.
    Provides a client interface to a server function. See math:linear-model
    
    Parameters:
    
    arg - The input data set. Each array should contain a pair of values.
    
    Returns:
    
    a MathLinearModelExpr expression
  - linearModelCoeff
```
XsDoubleSeqExpr linearModelCoeff(MathLinearModelExpr linearModel)
```
    Returns the coefficients of the linear model. Currently only simple linear regression model is supported so the return should contain only one coefficient (also called “slope”).
    Provides a client interface to a server function. See math:linear-model-coeff
    
    Parameters:
    
    linearModel - A linear model.
    
    Returns:
    
    a XsDoubleSeqExpr expression sequence
  - linearModelIntercept
```
XsDoubleExpr linearModelIntercept(MathLinearModelExpr linearModel)
```
    Returns the intercept of the linear model.
    Provides a client interface to a server function. See math:linear-model-intercept
    
    Parameters:
    
    linearModel - A linear model.
    
    Returns:
    
    a XsDoubleExpr expression
  - linearModelRsquared
```
XsDoubleExpr linearModelRsquared(MathLinearModelExpr linearModel)
```
    Returns the R^2 value of the linear model.
    Provides a client interface to a server function. See math:linear-model-rsquared
    
    Parameters:
    
    linearModel - A linear model.
    
    Returns:
    
    a XsDoubleExpr expression
  - log
```
XsDoubleExpr log(XsDoubleExpr x)
```
    Returns the base-e logarithm of x.
    Provides a client interface to a server function. See math:log
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - log10
```
XsDoubleExpr log10(XsDoubleExpr x)
```
    Returns the base-10 logarithm of x.
    Provides a client interface to a server function. See math:log10
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - median
```
XsDoubleExpr median(XsDoubleSeqExpr arg)
```
    Returns the median of a sequence of values. The function returns the empty sequence if the input is the empty sequence.
    Provides a client interface to a server function. See math:median
    
    Parameters:
    
    arg - The sequence of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - mode
```
XsAnyAtomicTypeSeqExpr mode(XsAnyAtomicTypeSeqExpr arg)
```
    Returns the mode of a sequence. The mode is the value that occurs most frequently in a data set. If no value occurs more than once in the data set, the function returns the empty sequence. If the input is the empty sequence, the function returns the empty sequence.
    Note that a data set can have multiple “modes”. The order of multiple modes in the returned sequence is undefined.
    Also note that values from a lexicon lookup are repeated cts:frequency times before calculating the mode.
    The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:mode
    
    Parameters:
    
    arg - The sequence of values.
    
    Returns:
    
    a XsAnyAtomicTypeSeqExpr expression sequence
  - mode
```
XsAnyAtomicTypeSeqExpr mode(XsAnyAtomicTypeSeqExpr arg,
                            String options)
```
    Returns the mode of a sequence. The mode is the value that occurs most frequently in a data set. If no value occurs more than once in the data set, the function returns the empty sequence. If the input is the empty sequence, the function returns the empty sequence.
    Note that a data set can have multiple “modes”. The order of multiple modes in the returned sequence is undefined.
    Also note that values from a lexicon lookup are repeated cts:frequency times before calculating the mode.
    The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:mode
    
    Parameters:
    
    arg - The sequence of values.
    
    options - Options. The default is ().
    Options include:
    
    “collation=URI”
    
    Applies only when $arg is of the xs:string type. If no specified, the default collation is used.
    
    “coordinate-system=name”
    
    Applies only when $arg is of the cts:point type. If no specified, the default coordinate system is used.
    
    Returns:
    
    a XsAnyAtomicTypeSeqExpr expression sequence
  - mode
```
XsAnyAtomicTypeSeqExpr mode(XsAnyAtomicTypeSeqExpr arg,
                            XsStringSeqExpr options)
```
    Returns the mode of a sequence. The mode is the value that occurs most frequently in a data set. If no value occurs more than once in the data set, the function returns the empty sequence. If the input is the empty sequence, the function returns the empty sequence.
    Note that a data set can have multiple “modes”. The order of multiple modes in the returned sequence is undefined.
    Also note that values from a lexicon lookup are repeated cts:frequency times before calculating the mode.
    The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:mode
    
    Parameters:
    
    arg - The sequence of values.
    
    options - Options. The default is ().
    Options include:
    
    “collation=URI”
    
    Applies only when $arg is of the xs:string type. If no specified, the default collation is used.
    
    “coordinate-system=name”
    
    Applies only when $arg is of the cts:point type. If no specified, the default coordinate system is used.
    
    Returns:
    
    a XsAnyAtomicTypeSeqExpr expression sequence
  - modf
```
XsDoubleSeqExpr modf(XsDoubleExpr x)
```
    Returns x broken up into fraction and integer. x = fraction+integer.
    Provides a client interface to a server function. See math:modf
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleSeqExpr expression sequence
  - percentRank
```
XsDoubleExpr percentRank(XsAnyAtomicTypeSeqExpr arg,
                         String value)
```
    Returns the rank of a value in a data set as a percentage of the data set. If the given value is not equal to any item in the sequence, the function returns the empty sequence. See math:rank.
    Provides a client interface to a server function. See math:percent-rank
    
    Parameters:
    
    arg - The sequence of values.
    
    value - The value to be “ranked”.
    
    Returns:
    
    a XsDoubleExpr expression
  - percentRank
```
XsDoubleExpr percentRank(XsAnyAtomicTypeSeqExpr arg,
                         XsAnyAtomicTypeExpr value)
```
    Returns the rank of a value in a data set as a percentage of the data set. If the given value is not equal to any item in the sequence, the function returns the empty sequence. See math:rank.
    Provides a client interface to a server function. See math:percent-rank
    
    Parameters:
    
    arg - The sequence of values.
    
    value - The value to be “ranked”.
    
    Returns:
    
    a XsDoubleExpr expression
  - percentRank
```
XsDoubleExpr percentRank(XsAnyAtomicTypeSeqExpr arg,
                         String value,
                         String options)
```
    Returns the rank of a value in a data set as a percentage of the data set. If the given value is not equal to any item in the sequence, the function returns the empty sequence. See math:rank.
    Provides a client interface to a server function. See math:percent-rank
    
    Parameters:
    
    arg - The sequence of values.
    
    value - The value to be “ranked”.
    
    options - Options. The default is ().
    Options include:
    
    “ascending”(default)
    
    Rank the value as if the sequence was sorted in ascending order.
    
    “descending”
    
    Rank the value as if the sequence was sorted in descending order.
    
    “collation=URI”
    
    Applies only when $arg is of the xs:string type. If no specified, the default collation is used.
    
    “coordinate-system=name”
    
    Applies only when $arg is of the cts:point type. If no specified, the default coordinate system is used.
    
    Returns:
    
    a XsDoubleExpr expression
  - percentRank
```
XsDoubleExpr percentRank(XsAnyAtomicTypeSeqExpr arg,
                         XsAnyAtomicTypeExpr value,
                         XsStringSeqExpr options)
```
    Returns the rank of a value in a data set as a percentage of the data set. If the given value is not equal to any item in the sequence, the function returns the empty sequence. See math:rank.
    Provides a client interface to a server function. See math:percent-rank
    
    Parameters:
    
    arg - The sequence of values.
    
    value - The value to be “ranked”.
    
    options - Options. The default is ().
    Options include:
    
    “ascending”(default)
    
    Rank the value as if the sequence was sorted in ascending order.
    
    “descending”
    
    Rank the value as if the sequence was sorted in descending order.
    
    “collation=URI”
    
    Applies only when $arg is of the xs:string type. If no specified, the default collation is used.
    
    “coordinate-system=name”
    
    Applies only when $arg is of the cts:point type. If no specified, the default coordinate system is used.
    
    Returns:
    
    a XsDoubleExpr expression
  - percentile
```
XsDoubleSeqExpr percentile(XsDoubleSeqExpr arg,
                           double p)
```
    Returns a sequence of percentile(s) given a sequence of percentage(s). The function returns the empty sequence if either arg or p is the empty sequence.
    Provides a client interface to a server function. See math:percentile
    
    Parameters:
    
    arg - The sequence of values to calculate the percentile(s) on.
    
    p - The sequence of percentage(s).
    
    Returns:
    
    a XsDoubleSeqExpr expression sequence
  - percentile
```
XsDoubleSeqExpr percentile(XsDoubleSeqExpr arg,
                           XsDoubleSeqExpr p)
```
    Returns a sequence of percentile(s) given a sequence of percentage(s). The function returns the empty sequence if either arg or p is the empty sequence.
    Provides a client interface to a server function. See math:percentile
    
    Parameters:
    
    arg - The sequence of values to calculate the percentile(s) on.
    
    p - The sequence of percentage(s).
    
    Returns:
    
    a XsDoubleSeqExpr expression sequence
  - pi
```
XsDoubleExpr pi()
```
    Returns the value of pi.
    Provides a client interface to a server function. See math:pi
  - pow
```
XsDoubleExpr pow(XsDoubleExpr x,
                 double y)
```
    Returns x^y.
    Provides a client interface to a server function. See math:pow
    
    Parameters:
    
    x - The floating-point base number.
    
    y - The exponent to be applied to x.
    
    Returns:
    
    a XsDoubleExpr expression
  - pow
```
XsDoubleExpr pow(XsDoubleExpr x,
                 XsDoubleExpr y)
```
    Returns x^y.
    Provides a client interface to a server function. See math:pow
    
    Parameters:
    
    x - The floating-point base number.
    
    y - The exponent to be applied to x.
    
    Returns:
    
    a XsDoubleExpr expression
  - radians
```
XsDoubleExpr radians(XsDoubleExpr x)
```
    Returns numeric expression converted from degrees to radians.
    Provides a client interface to a server function. See math:radians
    
    Parameters:
    
    x - An angle expressed in degrees.
    
    Returns:
    
    a XsDoubleExpr expression
  - rank
```
XsIntegerExpr rank(XsAnyAtomicTypeSeqExpr arg1,
                   String arg2)
```
    Returns the rank of a value in a data set. Ranks are skipped in the event of ties. If the given value is not equal to any item in the sequence, the function returns the empty sequence. The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:rank
    
    Parameters:
    
    arg1 - The sequence of values.
    
    arg2 - The value to be “ranked”.
    
    Returns:
    
    a XsIntegerExpr expression
  - rank
```
XsIntegerExpr rank(XsAnyAtomicTypeSeqExpr arg1,
                   XsAnyAtomicTypeExpr arg2)
```
    Returns the rank of a value in a data set. Ranks are skipped in the event of ties. If the given value is not equal to any item in the sequence, the function returns the empty sequence. The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:rank
    
    Parameters:
    
    arg1 - The sequence of values.
    
    arg2 - The value to be “ranked”.
    
    Returns:
    
    a XsIntegerExpr expression
  - rank
```
XsIntegerExpr rank(XsAnyAtomicTypeSeqExpr arg1,
                   String arg2,
                   String options)
```
    Returns the rank of a value in a data set. Ranks are skipped in the event of ties. If the given value is not equal to any item in the sequence, the function returns the empty sequence. The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:rank
    
    Parameters:
    
    arg1 - The sequence of values.
    
    arg2 - The value to be “ranked”.
    
    options - Options. The default is ().
    Options include:
    
    “ascending”(default)
    
    Rank the value as if the sequence was sorted in ascending order.
    
    “descending”
    
    Rank the value as if the sequence was sorted in descending order.
    
    “collation=URI”
    
    Applies only when $arg is of the xs:string type. If no specified, the default collation is used.
    
    “coordinate-system=name”
    
    Applies only when $arg is of the cts:point type. If no specified, the default coordinate system is used.
    
    Returns:
    
    a XsIntegerExpr expression
  - rank
```
XsIntegerExpr rank(XsAnyAtomicTypeSeqExpr arg1,
                   XsAnyAtomicTypeExpr arg2,
                   XsStringSeqExpr options)
```
    Returns the rank of a value in a data set. Ranks are skipped in the event of ties. If the given value is not equal to any item in the sequence, the function returns the empty sequence. The function can be used on numeric values, xs:yearMonthDuration, xs:dayTimeDuration, xs:string, xs:anyURI, xs:date, xs:dateTime, xs:time, and cts:point.
    Provides a client interface to a server function. See math:rank
    
    Parameters:
    
    arg1 - The sequence of values.
    
    arg2 - The value to be “ranked”.
    
    options - Options. The default is ().
    Options include:
    
    “ascending”(default)
    
    Rank the value as if the sequence was sorted in ascending order.
    
    “descending”
    
    Rank the value as if the sequence was sorted in descending order.
    
    “collation=URI”
    
    Applies only when $arg is of the xs:string type. If no specified, the default collation is used.
    
    “coordinate-system=name”
    
    Applies only when $arg is of the cts:point type. If no specified, the default coordinate system is used.
    
    Returns:
    
    a XsIntegerExpr expression
  - sin
```
XsDoubleExpr sin(XsDoubleExpr x)
```
    Returns the sine of x, in the range from -1 to +1 (inclusive).
    Provides a client interface to a server function. See math:sin
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - sinh
```
XsDoubleExpr sinh(XsDoubleExpr x)
```
    Returns the hyperbolic sine of x.
    Provides a client interface to a server function. See math:sinh
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - sqrt
```
XsDoubleExpr sqrt(XsDoubleExpr x)
```
    Returns the square root of x.
    Provides a client interface to a server function. See math:sqrt
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - stddev
```
XsDoubleExpr stddev(XsDoubleSeqExpr arg)
```
    Returns the sample standard deviation of a sequence of values. The function returns the empty sequence if the length of the input sequence is less than 2.
    Provides a client interface to a server function. See math:stddev
    
    Parameters:
    
    arg - The sequence of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - stddevP
```
XsDoubleExpr stddevP(XsDoubleSeqExpr arg)
```
    Returns the standard deviation of a population. The function returns the empty sequence if the input is the empty sequence.
    Provides a client interface to a server function. See math:stddev-p
    
    Parameters:
    
    arg - The sequence of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - tan
```
XsDoubleExpr tan(XsDoubleExpr x)
```
    Returns the tangent of x.
    Provides a client interface to a server function. See math:tan
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - tanh
```
XsDoubleExpr tanh(XsDoubleExpr x)
```
    Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
    Provides a client interface to a server function. See math:tanh
    
    Parameters:
    
    x - The floating point number to be evaluated.
    
    Returns:
    
    a XsDoubleExpr expression
  - trunc
```
XsNumericExpr trunc(XsNumericExpr arg)
```
    Returns the number truncated to a certain number of decimal places. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
    For xs:float and xs:double arguments, if the argument is positive infinity, then positive infinity is returned. If the argument is negative infinity, then negative infinity is returned. If the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned.
    Provides a client interface to a server function. See math:trunc
    
    Parameters:
    
    arg - A numeric value to truncate.
    
    Returns:
    
    a XsNumericExpr expression
  - trunc
```
XsNumericExpr trunc(XsNumericExpr arg,
                    long n)
```
    Returns the number truncated to a certain number of decimal places. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
    For xs:float and xs:double arguments, if the argument is positive infinity, then positive infinity is returned. If the argument is negative infinity, then negative infinity is returned. If the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned.
    Provides a client interface to a server function. See math:trunc
    
    Parameters:
    
    arg - A numeric value to truncate.
    
    n - The numbers of decimal places to truncate to. The default is 0. Negative values cause that many digits to the left of the decimal point to be truncated.
    
    Returns:
    
    a XsNumericExpr expression
  - trunc
```
XsNumericExpr trunc(XsNumericExpr arg,
                    XsIntegerExpr n)
```
    Returns the number truncated to a certain number of decimal places. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
    For xs:float and xs:double arguments, if the argument is positive infinity, then positive infinity is returned. If the argument is negative infinity, then negative infinity is returned. If the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned.
    Provides a client interface to a server function. See math:trunc
    
    Parameters:
    
    arg - A numeric value to truncate.
    
    n - The numbers of decimal places to truncate to. The default is 0. Negative values cause that many digits to the left of the decimal point to be truncated.
    
    Returns:
    
    a XsNumericExpr expression
  - variance
```
XsDoubleExpr variance(XsDoubleSeqExpr arg)
```
    Returns the sample variance of a sequence of values. The function returns the empty sequence if the length of the input sequence is less than 2.
    Provides a client interface to a server function. See math:variance
    
    Parameters:
    
    arg - The sequence of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - varianceP
```
XsDoubleExpr varianceP(XsDoubleSeqExpr arg)
```
    Returns the population variance of a sequence of values. The function returns the empty sequence if the input is the empty sequence.
    Provides a client interface to a server function. See math:variance-p
    
    Parameters:
    
    arg - The sequence of values.
    
    Returns:
    
    a XsDoubleExpr expression
  - linearModelSeq
```
MathLinearModelSeqExpr linearModelSeq(MathLinearModelExpr... items)
```
    Constructs a sequence of MathLinearModelExpr items.

Interface MathExpr

Method Summary

Method Detail

acos

asin

atan

atan2

atan2

ceil

correlation

cos

cosh

cot

covariance

covarianceP

degrees

exp

fabs

floor

fmod

fmod

frexp

ldexp

ldexp

linearModel

linearModelCoeff

linearModelIntercept

linearModelRsquared

log

log10

median

mode

mode

mode

modf

percentRank

percentRank

percentRank

percentRank

percentile

percentile

pi

pow

pow

radians

rank

rank

rank

rank

sin

sinh

sqrt

stddev

stddevP

tan

tanh

trunc

trunc

trunc

variance

varianceP

linearModelSeq