| Package | Description |
|---|---|
| com.marklogic.client.expression |
The package provides classes for building Optic plan pipelines and expressions for execution on the REST server.
|
| com.marklogic.client.type |
The package provides interfaces specifying the type of an expression or value as passed to a
PlanBuilder method or returned from a RowRecord method. |
| Modifier and Type | Method and Description |
|---|---|
XsDoubleExpr |
MathExpr.acos(XsDoubleExpr x)
Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
|
XsDoubleExpr |
MathExpr.asin(XsDoubleExpr x)
Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
|
XsDoubleExpr |
MathExpr.atan(XsDoubleExpr x)
Returns the arc tangent of x, in radians.
|
XsDoubleExpr |
MathExpr.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 |
MathExpr.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 |
MathExpr.ceil(XsDoubleExpr x)
Returns the smallest integer greater than or equal to x.
|
XsDoubleExpr |
MathExpr.correlation(JsonArraySeqExpr arg)
Returns the Pearson correlation coefficient of a data set.
|
XsDoubleExpr |
MathExpr.cos(XsDoubleExpr x)
Returns the cosine of x, in the range from -1 to +1 (inclusive).
|
XsDoubleExpr |
MathExpr.cosh(XsDoubleExpr x)
Returns the hyperbolic cosine of x.
|
XsDoubleExpr |
MathExpr.cot(XsDoubleExpr x)
Returns the cotangent of x.
|
XsDoubleExpr |
MathExpr.covariance(JsonArraySeqExpr arg)
Returns the sample covariance of a data set.
|
XsDoubleExpr |
MathExpr.covarianceP(JsonArraySeqExpr arg)
Returns the population covariance of a data set.
|
XsDoubleExpr |
MathExpr.degrees(XsDoubleExpr x)
Returns numeric expression converted from radians to degrees.
|
XsDoubleExpr |
XsExpr.doubleExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:double server data type.
|
XsDoubleExpr |
MathExpr.exp(XsDoubleExpr x)
Returns e (approximately 2.71828182845905) to the xth power.
|
XsDoubleExpr |
MathExpr.fabs(XsDoubleExpr x)
Returns the absolute value of x.
|
XsDoubleExpr |
MathExpr.floor(XsDoubleExpr x)
Returns the largest integer less than or equal to x.
|
XsDoubleExpr |
MathExpr.fmod(XsDoubleExpr x,
double y)
Returns the remainder of x/y.
|
XsDoubleExpr |
MathExpr.fmod(XsDoubleExpr x,
XsDoubleExpr y)
Returns the remainder of x/y.
|
XsDoubleExpr |
MathExpr.ldexp(XsDoubleExpr y,
long i)
Returns x*2^i.
|
XsDoubleExpr |
MathExpr.ldexp(XsDoubleExpr y,
XsIntegerExpr i)
Returns x*2^i.
|
XsDoubleExpr |
MathExpr.linearModelIntercept(MathLinearModelExpr linearModel)
Returns the intercept of the linear model.
|
XsDoubleExpr |
MathExpr.linearModelRsquared(MathLinearModelExpr linearModel)
Returns the R^2 value of the linear model.
|
XsDoubleExpr |
MathExpr.log(XsDoubleExpr x)
Returns the base-e logarithm of x.
|
XsDoubleExpr |
MathExpr.log10(XsDoubleExpr x)
Returns the base-10 logarithm of x.
|
XsDoubleExpr |
MathExpr.median(XsDoubleSeqExpr arg)
Returns the median of a sequence of values.
|
XsDoubleExpr |
FnExpr.number(XsAnyAtomicTypeExpr arg)
Returns the value indicated by arg or, if arg is not specified, the context item after atomization, converted to an xs:double.
|
XsDoubleExpr |
MathExpr.percentRank(XsAnyAtomicTypeSeqExpr arg,
String value)
Returns the rank of a value in a data set as a percentage of the data set.
|
XsDoubleExpr |
MathExpr.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 |
MathExpr.percentRank(XsAnyAtomicTypeSeqExpr arg,
XsAnyAtomicTypeExpr value)
Returns the rank of a value in a data set as a percentage of the data set.
|
XsDoubleExpr |
MathExpr.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 |
MathExpr.pi()
Returns the value of pi.
|
XsDoubleExpr |
MathExpr.pow(XsDoubleExpr x,
double y)
Returns x^y.
|
XsDoubleExpr |
MathExpr.pow(XsDoubleExpr x,
XsDoubleExpr y)
Returns x^y.
|
XsDoubleExpr |
MathExpr.radians(XsDoubleExpr x)
Returns numeric expression converted from degrees to radians.
|
XsDoubleExpr |
SemExpr.random()
Returns a random double between 0 and 1.
|
XsDoubleExpr |
MathExpr.sin(XsDoubleExpr x)
Returns the sine of x, in the range from -1 to +1 (inclusive).
|
XsDoubleExpr |
MathExpr.sinh(XsDoubleExpr x)
Returns the hyperbolic sine of x.
|
XsDoubleExpr |
MathExpr.sqrt(XsDoubleExpr x)
Returns the square root of x.
|
XsDoubleExpr |
MathExpr.stddev(XsDoubleSeqExpr arg)
Returns the sample standard deviation of a sequence of values.
|
XsDoubleExpr |
MathExpr.stddevP(XsDoubleSeqExpr arg)
Returns the standard deviation of a population.
|
XsDoubleExpr |
MathExpr.tan(XsDoubleExpr x)
Returns the tangent of x.
|
XsDoubleExpr |
MathExpr.tanh(XsDoubleExpr x)
Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
|
XsDoubleExpr |
MathExpr.variance(XsDoubleSeqExpr arg)
Returns the sample variance of a sequence of values.
|
XsDoubleExpr |
MathExpr.varianceP(XsDoubleSeqExpr arg)
Returns the population variance of a sequence of values.
|
| Modifier and Type | Method and Description |
|---|---|
XsDoubleExpr |
MathExpr.acos(XsDoubleExpr x)
Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
|
XsDoubleExpr |
MathExpr.asin(XsDoubleExpr x)
Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
|
XsDoubleExpr |
MathExpr.atan(XsDoubleExpr x)
Returns the arc tangent of x, in radians.
|
XsDoubleExpr |
MathExpr.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 |
MathExpr.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 |
MathExpr.ceil(XsDoubleExpr x)
Returns the smallest integer greater than or equal to x.
|
XsDoubleExpr |
MathExpr.cos(XsDoubleExpr x)
Returns the cosine of x, in the range from -1 to +1 (inclusive).
|
XsDoubleExpr |
MathExpr.cosh(XsDoubleExpr x)
Returns the hyperbolic cosine of x.
|
XsDoubleExpr |
MathExpr.cot(XsDoubleExpr x)
Returns the cotangent of x.
|
XsIntegerExpr |
FnExpr.count(ItemSeqExpr arg,
XsDoubleExpr maximum)
Returns the number of items in the value of arg.
|
XsDoubleExpr |
MathExpr.degrees(XsDoubleExpr x)
Returns numeric expression converted from radians to degrees.
|
XsDoubleSeqExpr |
XsExpr.doubleExprSeq(XsDoubleExpr... items)
Constructs a sequence of XsDoubleExpr items.
|
XsDoubleExpr |
MathExpr.exp(XsDoubleExpr x)
Returns e (approximately 2.71828182845905) to the xth power.
|
XsDoubleExpr |
MathExpr.fabs(XsDoubleExpr x)
Returns the absolute value of x.
|
XsDoubleExpr |
MathExpr.floor(XsDoubleExpr x)
Returns the largest integer less than or equal to x.
|
XsDoubleExpr |
MathExpr.fmod(XsDoubleExpr x,
double y)
Returns the remainder of x/y.
|
XsDoubleExpr |
MathExpr.fmod(XsDoubleExpr x,
XsDoubleExpr y)
Returns the remainder of x/y.
|
ItemSeqExpr |
MathExpr.frexp(XsDoubleExpr x)
Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent.
|
XsDoubleExpr |
MathExpr.ldexp(XsDoubleExpr y,
long i)
Returns x*2^i.
|
XsDoubleExpr |
MathExpr.ldexp(XsDoubleExpr y,
XsIntegerExpr i)
Returns x*2^i.
|
XsDoubleExpr |
MathExpr.log(XsDoubleExpr x)
Returns the base-e logarithm of x.
|
XsDoubleExpr |
MathExpr.log10(XsDoubleExpr x)
Returns the base-10 logarithm of x.
|
XsDoubleSeqExpr |
MathExpr.modf(XsDoubleExpr x)
Returns x broken up into fraction and integer.
|
XsDoubleExpr |
MathExpr.pow(XsDoubleExpr x,
double y)
Returns x^y.
|
XsDoubleExpr |
MathExpr.pow(XsDoubleExpr x,
XsDoubleExpr y)
Returns x^y.
|
XsDoubleExpr |
MathExpr.radians(XsDoubleExpr x)
Returns numeric expression converted from degrees to radians.
|
XsDoubleExpr |
MathExpr.sin(XsDoubleExpr x)
Returns the sine of x, in the range from -1 to +1 (inclusive).
|
XsDoubleExpr |
MathExpr.sinh(XsDoubleExpr x)
Returns the hyperbolic sine of x.
|
XsDoubleExpr |
MathExpr.sqrt(XsDoubleExpr x)
Returns the square root of x.
|
XsDoubleExpr |
MathExpr.tan(XsDoubleExpr x)
Returns the tangent of x.
|
XsDoubleExpr |
MathExpr.tanh(XsDoubleExpr x)
Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
PlanColumn
An instance of a column expression returned by a col() call in a row pipeline.
|
interface |
PlanParamExpr
An instance of a placeholder parameter returned by a call to the param() function that can represent a literal value in expressions and can be passed on a bind() call to be assigned a literal value when invoking a row pipeline.
|
interface |
PlanSystemColumn
An instance of a fragment id, graph id, or other system column for a row pipeline.
|
interface |
XsDoubleVal
An instance of a server double value.
|
Copyright © 2013-2017 MarkLogic Corporation.