org.apache.xalan.lib
Class ExsltMath
This class contains EXSLT math extension functions.
It is accessed by specifying a namespace URI as follows:
xmlns:math="http://exslt.org/math"
The documentation for each function has been copied from the relevant
EXSLT Implementer page.
EXSLT
static double | abs(double num) - The math:abs function returns the absolute value of a number.
|
static double | acos(double num) - The math:acos function returns the arccosine value of a number.
|
static double | asin(double num) - The math:asin function returns the arcsine value of a number.
|
static double | atan(double num) - The math:atan function returns the arctangent value of a number.
|
static double | atan2(double num1, double num2) - The math:atan2 function returns the angle ( in radians ) from the X axis to a point (y,x).
|
static double | constant(String name, double precision) - The math:constant function returns the specified constant to a set precision.
|
static double | cos(double num) - The math:cos function returns cosine of the passed argument.
|
static double | exp(double num) - The math:exp function returns e (the base of natural logarithms) raised to a power.
|
static NodeList | highest(NodeList nl) - The math:highest function returns the nodes in the node set whose value is the maximum
value for the node set.
|
static double | log(double num) - The math:log function returns the natural logarithm of a number.
|
static NodeList | lowest(NodeList nl) - The math:lowest function returns the nodes in the node set whose value is the minimum value
for the node set.
|
static double | max(NodeList nl) - The math:max function returns the maximum value of the nodes passed as the argument.
|
static double | min(NodeList nl) - The math:min function returns the minimum value of the nodes passed as the argument.
|
static double | power(double num1, double num2) - The math:power function returns the value of a base expression taken to a specified power.
|
static double | random() - The math:random function returns a random number from 0 to 1.
|
static double | sin(double num) - The math:sin function returns the sine of the number.
|
static double | sqrt(double num) - The math:sqrt function returns the square root of a number.
|
static double | tan(double num) - The math:tan function returns the tangent of the number passed as an argument.
|
abs
public static double abs(double num)
The math:abs function returns the absolute value of a number.
num
- A number
- The absolute value of the number
acos
public static double acos(double num)
The math:acos function returns the arccosine value of a number.
num
- A number
- The arccosine value of the number
asin
public static double asin(double num)
The math:asin function returns the arcsine value of a number.
num
- A number
- The arcsine value of the number
atan
public static double atan(double num)
The math:atan function returns the arctangent value of a number.
num
- A number
- The arctangent value of the number
atan2
public static double atan2(double num1,
double num2)
The math:atan2 function returns the angle ( in radians ) from the X axis to a point (y,x).
num1
- The X axis valuenum2
- The Y axis value
- The angle (in radians) from the X axis to a point (y,x)
constant
public static double constant(String name,
double precision)
The math:constant function returns the specified constant to a set precision.
The possible constants are:
PI
E
SQRRT2
LN2
LN10
LOG2E
SQRT1_2
name
- The name of the constantprecision
- The precision
- The value of the specified constant to the given precision
cos
public static double cos(double num)
The math:cos function returns cosine of the passed argument.
num
- A number
- The cosine value of the number
exp
public static double exp(double num)
The math:exp function returns e (the base of natural logarithms) raised to a power.
num
- A number
- The value of e raised to the given power
highest
public static NodeList highest(NodeList nl)
The math:highest function returns the nodes in the node set whose value is the maximum
value for the node set. The maximum value for the node set is the same as the value as
calculated by math:max. A node has this maximum value if the result of converting its
string value to a number as if by the number function is equal to the maximum value,
where the equality comparison is defined as a numerical comparison using the = operator.
If any of the nodes in the node set has a non-numeric value, the math:max function will
return NaN. The definition numeric comparisons entails that NaN != NaN. Therefore if any
of the nodes in the node set has a non-numeric value, math:highest will return an empty
node set.
nl
- The NodeList for the node-set to be evaluated.
- node-set with nodes containing the maximum value found, an empty node-set
if any node cannot be converted to a number.
log
public static double log(double num)
The math:log function returns the natural logarithm of a number.
num
- A number
- The natural logarithm of the number
lowest
public static NodeList lowest(NodeList nl)
The math:lowest function returns the nodes in the node set whose value is the minimum value
for the node set. The minimum value for the node set is the same as the value as calculated
by math:min. A node has this minimum value if the result of converting its string value to
a number as if by the number function is equal to the minimum value, where the equality
comparison is defined as a numerical comparison using the = operator.
If any of the nodes in the node set has a non-numeric value, the math:min function will return
NaN. The definition numeric comparisons entails that NaN != NaN. Therefore if any of the nodes
in the node set has a non-numeric value, math:lowest will return an empty node set.
nl
- The NodeList for the node-set to be evaluated.
- node-set with nodes containing the minimum value found, an empty node-set
if any node cannot be converted to a number.
max
public static double max(NodeList nl)
The math:max function returns the maximum value of the nodes passed as the argument.
The maximum value is defined as follows. The node set passed as an argument is sorted
in descending order as it would be by xsl:sort with a data type of number. The maximum
is the result of converting the string value of the first node in this sorted list to
a number using the number function.
If the node set is empty, or if the result of converting the string values of any of the
nodes to a number is NaN, then NaN is returned.
nl
- The NodeList for the node-set to be evaluated.
- the maximum value found, NaN if any node cannot be converted to a number.
EXSLT
min
public static double min(NodeList nl)
The math:min function returns the minimum value of the nodes passed as the argument.
The minimum value is defined as follows. The node set passed as an argument is sorted
in ascending order as it would be by xsl:sort with a data type of number. The minimum
is the result of converting the string value of the first node in this sorted list to
a number using the number function.
If the node set is empty, or if the result of converting the string values of any of
the nodes to a number is NaN, then NaN is returned.
nl
- The NodeList for the node-set to be evaluated.
- the minimum value found, NaN if any node cannot be converted to a number.
EXSLT
power
public static double power(double num1,
double num2)
The math:power function returns the value of a base expression taken to a specified power.
num1
- The basenum2
- The power
- The value of the base expression taken to the specified power
random
public static double random()
The math:random function returns a random number from 0 to 1.
- A random double from 0 to 1
sin
public static double sin(double num)
The math:sin function returns the sine of the number.
num
- A number
- The sine value of the number
sqrt
public static double sqrt(double num)
The math:sqrt function returns the square root of a number.
num
- A number
- The square root of the number
tan
public static double tan(double num)
The math:tan function returns the tangent of the number passed as an argument.
num
- A number
- The tangent value of the number
Copyright B) 2004 Apache XML Project. All Rights Reserved.