Changes

Jump to navigation Jump to search
900 bytes added ,  21:04, 13 December 2010
no edit summary
The math module defines extension functions to perform mathematical operations, such as <code>pi</code>, <code>asin</code> and <code>acos</code>. All functions are preceded by the <code>math:</code> prefix. Some of the functions have also been specified in the[http://www.w3.org/TR/xpath-functions-11/ Functions and Operators Specification] of the upcoming XQuery 1.1 Recommendation. ==math:pi== {| | -| valign='top' width="'90" ' | <b>'''Signatures</b> ''' | <code> <b>math:pi</b>() as xs:double</code> <br /> |- | <b>valign='top' | '''Summary</b> ''' |Returns the value of the mathematical constant π. |- | <b>valign='top' | '''Rules</b> ''' |This function returns the <code>xs:double</code> value whose lexical representation is 3.141592653589793. <br /> |- | <b>valign='top' | '''Examples</b> ''' |The expression <code>2*math:pi()</code> returns <code>6.283185307179586e0</code>.<br />The expression <code>60 * (math:pi() div 180)</code> converts an angle of 60 degrees to radians. <br />
|}
==math:e== {| | -| valign='top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:e</b>() as xs:double</code><br />
|-
| <b>valign='top' | '''Summary</b> '''
|Returns the value of the mathematical constant <i>e</i>.
|-
| <b>valign='top' | '''Rules</b> '''|This function returns the <code>xs:double</code> value whose lexical representation is 2.718281828459045. <br />|-| valign='top' | '''Examples'''|The expression <code>5*math:e()</code> returns <code>13.591409142295225</code>.<br />|} ==math:sqrt=={|
|-
| <b>Examples</b> |The expression <code>5*math:e()</code> returns <code>13.591409142295225</code>. |} ==math:sqrt=valign= {| |-|'top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:sqrt</b>($arg as xs:double?) as xs:double?</code> <br />
|-
|<b>valign='top' | '''Summary</b> '''
|Returns the square root of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the <code>xs:double</code> value of the mathematical square root of <code>$arg</code>. <br />|} ==math:sin== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:sin</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:sin</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the sine of the argument, expressed in radians.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the sine of <code>$arg</code>, treated as an angle in radians. <br />|} ==math:cos== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:cos</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:cos</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the cosine of the argument, expressed in radians.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the cosine of <code>$arg</code>, treated as an angle in radians. <br />|} ==math:tan== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:tan</b>($ as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:tan</b> ($ as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the tangent of the argument, expressed in radians.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the tangent of <code>$arg</code>, treated as an angle in radians. <br />|} ==math:asin== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:asin</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:asin</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the arc sine of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the arc sine of <code>$arg</code>, returned as an angle in radians in the range -π/2 to +π/2. <br />|} ==math:acos== {| |-|valign='top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:acos</b>($arg as xs:double?) as xs:double?</code> <br />
|-
|<b>valign='top' | '''Summary</b> '''
|Returns the arc cosine of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the arc cosine of <code>$arg</code>, returned as an angle in radians in the range 0 to +π. <br />|} ==math:atan== {| |-|valign='top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:atan</b>($arg as xs:double?) as xs:double?</code> <br />
|-
|<b>valign='top' | '''Summary</b> '''
|Returns the arc tangent of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the arc tangent of <code>$arg</code>, returned as an angle in radians in the range -π/2 to +π/2. <br />|} ==math:atan2== {| |-|valign='top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:atan2</b>($arg1 as xs:double?, $arg2 as xs:double?) as xs:double?</code> <br />
|-
|<b>valign='top' | '''Summary</b> '''
|Returns the arc tangent of the first argument divided by the second argument, the result being in the range -π/2 to +π/2 radians.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg1</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the arc tangent of <code>$arg1</code> divided by <code>$arg2</code>, returned as an angle in radians in the range -π to +π. <br />|} ==math:pow== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:pow</b>($arg1 as xs:double?, $arg2 as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:pow</b> ($arg1 as xs:double?, $arg2 as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the first argument raised to the power of the second argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg1</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the <code>$arg1</code> raised to the power of <code>$arg2</code>. <br />|-| valign='top' | '''Examples'''|The expression <code>math:pow(2, 3)</code> returns <code>8</code>.<br />|} ==math:exp=={|
|-
|<b>Examples</b> |The expression <code>math:pow(2, 3)</code> returns <code>8</code>. |} ==math:exp=valign= {| |-|'top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:exp</b>($arg as xs:double?) as xs:double?</code> <br />
|-
|<b>valign='top' | '''Summary</b> '''
|Returns <i>e</i> raised to the power of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$argarg1</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the value of <i>e</i> raised to the power of <code>$arg</code>. <br />
|-
|<b>valign='top' | '''Examples</b> '''|The expression <code>math:exp(1)</code> returns <i>e</i>. <br />|} ==math:log== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:log</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:log</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the natural logarithm of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$argarg1</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the natural logarithm (base <i>e</i>) of <code>$arg</code>. <br />
|-
|<b>valign='top' | '''Examples</b> '''|The expression <code>math:log(math:e())</code> returns <code>1</code>. <br />|} ==math:log10== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:log10</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:log10</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the base 10 logarithm of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$argarg1</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the base 10 logarithm of <code>$arg</code>. <br />
|-
|<b>valign='top' | '''Examples</b> '''|The expression <code>math:log(100)</code> returns <code>2</code>. <br />|} ==math:random== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:random</b>() as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:random</b> () as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns a random value.
|-
|<b>valign='top' | '''Rules</b> '''|This function returns a random <code>xs:double</code> value between <code>0.0</code> and <code>1.0</code>. <br />|} ==math:sinh== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:sinh</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:sinh</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the hyperbolic sine of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the hyperbolic sine of <code>$arg</code>. <br />
|-
|<b>valign='top' | '''Examples</b> '''|The expression <code>math:sinh(0)</code> returns <code>0</code>. <br />|} ==math:cosh== {| |-|width="90" | <b>Signatures</b> | <code> <b>math:cosh</b>($arg as xs:double?) as xs:double?</code>
|-
| valign='top' width='90' | '''Signatures'''|<code><b>Summarymath:cosh</b> ($arg as xs:double?) as xs:double?</code><br />|-| valign='top' | '''Summary'''
|Returns the hyperbolic cosine of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the hyperbolic cosine of <code>$arg</code>. <br />|-| valign='top' | '''Examples'''|The expression <code>math:cosh(0)</code> returns <code>1</code>.<br />|} ==math:tanh=={|
|-
|<b>Examples</b> |The expression <code>math:cosh(0)</code> returns <code>1</code>. |} valign==math:tanh== {| |-|'top' width="'90" ' | <b>'''Signatures</b> '''| <code> <b>math:tanh</b>($arg as xs:double?) as xs:double?</code><br />
|-
|<b>valign='top' | '''Summary</b> '''
|Returns the hyperbolic tangent of the argument.
|-
|<b>valign='top' | '''Rules</b> '''|If <code>$arg</code> is the empty sequence, the function returns the empty sequence.<br />Otherwise the result is the hyperbolic tangent of <code>$arg</code>. <br />
|-
|<b>valign='top' | '''Examples</b> '''|The expression <code>math:tanh(100)</code> returns <code>1</code>. <br />|}  
[[Category:XQuery]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu