Difference between revisions of "Math Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
−
The math [[Module Library|XQuery Module]] defines functions to perform mathematical operations, such as <code>pi</code>, <code>asin</code> and <code>acos</code>. Most functions are specified in the [http://www.w3.org/TR/xpath-functions-30/ Functions and Operators Specification] of the upcoming XQuery 3.0 Recommendation, and some additional ones have been added in this module.
+
The math [[Module Library|XQuery Module]] defines functions to perform mathematical operations, such as {{Code|pi}}, {{Code|asin}} and {{Code|acos}}. Most functions are specified in the [http://www.w3.org/TR/xpath-functions-30/ Functions and Operators Specification] of the upcoming XQuery 3.0 Recommendation, and some additional ones have been added in this module.
  
 
=Conventions=
 
=Conventions=
  
−
All functions in this module are assigned to the <code>http://www.w3.org/2005/xpath-functions/math</code> namespace, which is statically bound to the <code>math</code> prefix.<br/>
+
All functions in this module are assigned to the {{Code|http://www.w3.org/2005/xpath-functions/math}} namespace, which is statically bound to the {{Code|math}} prefix.<br/>
  
 
=Functions=
 
=Functions=
Line 11: Line 11:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:pi</b>() as xs:double</code>
+
|{{Func|math:pi||xs:double}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the <code>xs:double</code> value  of the mathematical constant π whose lexical representation is 3.141592653589793.
+
|Returns the {{Code|xs:double}} value  of the mathematical constant π whose lexical representation is 3.141592653589793.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>2*math:pi()</code> returns <code>6.283185307179586e0</code>.
+
* {{Code|2*math:pi()}} returns {{Code|6.283185307179586e0}}.
−
* <code>60 * (math:pi() div 180)</code> converts an angle of 60 degrees to radians.
+
* {{Code|60 * (math:pi() div 180)}} converts an angle of 60 degrees to radians.
 
|}
 
|}
  
Line 26: Line 26:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:e</b>() as xs:double</code>
+
|{{Func|math:e||xs:double}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the <code>xs:double</code> value of the mathematical constant <i>e</i> whose lexical representation is 2.718281828459045.
+
|Returns the {{Code|xs:double}} value of the mathematical constant <i>e</i> whose lexical representation is 2.718281828459045.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>5*math:e()</code> returns <code>13.591409142295225</code>.
+
* {{Code|5*math:e()}} returns {{Code|13.591409142295225}}.
 
|}
 
|}
  
Line 40: Line 40:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:sqrt</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:sqrt|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the square root of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the <code>xs:double</code> value of the mathematical square root of <code>$arg</code>.
+
|Returns the square root of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the {{Code|xs:double}} value of the mathematical square root of {{Code|$arg}}.
 
|}
 
|}
  
Line 50: Line 50:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:sin</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:sin|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the sine of the <code>$arg</code>, expressed in radians.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the sine of <code>$arg</code>, treated as an angle in radians.
+
|Returns the sine of the {{Code|$arg}}, expressed in radians.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the sine of {{Code|$arg}}, treated as an angle in radians.
 
|}
 
|}
  
Line 60: Line 60:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:cos</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:cos|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the cosine of <code>$arg</code>, expressed in radians.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the cosine of <code>$arg</code>, treated as an angle in radians.
+
|Returns the cosine of {{Code|$arg}}, expressed in radians.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the cosine of {{Code|$arg}}, treated as an angle in radians.
 
|}
 
|}
  
Line 70: Line 70:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:tan</b>($ as xs:double?) as xs:double?</code>
+
|{{Func|math:tan|$ as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the tangent of <code>$arg</code>, expressed in radians.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the tangent of <code>$arg</code>, treated as an angle in radians.
+
|Returns the tangent of {{Code|$arg}}, expressed in radians.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the tangent of {{Code|$arg}}, treated as an angle in radians.
 
|}
 
|}
  
Line 80: Line 80:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:asin</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:asin|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the arc sine of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc sine of <code>$arg</code>, returned as an angle in radians in the range -π/2 to +π/2.
+
|Returns the arc sine of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc sine of {{Code|$arg}}, returned as an angle in radians in the range -π/2 to +π/2.
 
|}
 
|}
  
Line 90: Line 90:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:acos</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:acos|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the arc cosine of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc cosine of <code>$arg</code>, returned as an angle in radians in the range 0 to +π.
+
|Returns the arc cosine of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc cosine of {{Code|$arg}}, returned as an angle in radians in the range 0 to +π.
 
|}
 
|}
  
Line 100: Line 100:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:atan</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:atan|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the arc tangent of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc tangent of <code>$arg</code>, returned as an angle in radians in the range -π/2 to +π/2.
+
|Returns the arc tangent of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc tangent of {{Code|$arg}}, returned as an angle in radians in the range -π/2 to +π/2.
 
|}
 
|}
  
Line 110: Line 110:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:atan2</b>($arg1 as xs:double?, $arg2 as xs:double) as xs:double?</code>
+
|{{Func|math:atan2|$arg1 as xs:double?, $arg2 as xs:double|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the arc tangent of <code>$arg1</code> divided by <code>$arg2</code>, the result being in the range -π/2 to +π/2 radians.<br/>If <code>$arg1</code> is the empty sequence, the empty sequence is returned.<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 +π.
+
|Returns the arc tangent of {{Code|$arg1}} divided by {{Code|$arg2}}, the result being in the range -π/2 to +π/2 radians.<br/>If {{Code|$arg1}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the arc tangent of {{Code|$arg1}} divided by {{Code|$arg2}}, returned as an angle in radians in the range -π to +π.
 
|}
 
|}
  
Line 120: Line 120:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:pow</b>($arg1 as xs:double?, $arg2 as xs:double) as xs:double?</code>
+
|{{Func|math:pow|$arg1 as xs:double?, $arg2 as xs:double|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns <code>$arg1</code> raised to the power of <code>$arg2</code>.<br/>If <code>$arg1</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the <code>$arg1</code> raised to the power of <code>$arg2</code>.
+
|Returns {{Code|$arg1}} raised to the power of {{Code|$arg2}}.<br/>If {{Code|$arg1}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the {{Code|$arg1}} raised to the power of {{Code|$arg2}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:pow(2, 3)</code> returns <code>8</code>.
+
* {{Code|math:pow(2, 3)}} returns {{Code|8}}.
 
|}
 
|}
  
Line 134: Line 134:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:exp</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:exp|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns <i>e</i> raised to the power of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the value of <i>e</i> raised to the power of <code>$arg</code>.
+
|Returns <i>e</i> raised to the power of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the value of <i>e</i> raised to the power of {{Code|$arg}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:exp(1)</code> returns <i>e</i>.
+
* {{Code|math:exp(1)}} returns <i>e</i>.
 
|}
 
|}
  
Line 148: Line 148:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:log</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:log|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the natural logarithm of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the natural logarithm (base <i>e</i>) of <code>$arg</code>.
+
|Returns the natural logarithm of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the natural logarithm (base <i>e</i>) of {{Code|$arg}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:log(math:e())</code> returns <code>1</code>.
+
* {{Code|math:log(math:e())}} returns {{Code|1}}.
 
|}
 
|}
  
Line 162: Line 162:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:log10</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:log10|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the base 10 logarithm of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the base 10 logarithm of <code>$arg</code>.
+
|Returns the base 10 logarithm of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the base 10 logarithm of {{Code|$arg}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:log(100)</code> returns <code>2</code>.
+
* {{Code|math:log(100)}} returns {{Code|2}}.
 
|}
 
|}
  
Line 176: Line 176:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:random</b>() as xs:double?</code>
+
|{{Func|math:random||xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns a random <code>xs:double</code> value between <code>0.0</code> and <code>1.0</code>.
+
|Returns a random {{Code|xs:double}} value between {{Code|0.0}} and {{Code|1.0}}.
 
|}
 
|}
  
Line 186: Line 186:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:sinh</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:sinh|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the hyperbolic sine of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the hyperbolic sine of <code>$arg</code>.
+
|Returns the hyperbolic sine of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the hyperbolic sine of {{Code|$arg}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:sinh(0)</code> returns <code>0</code>.
+
* {{Code|math:sinh(0)}} returns {{Code|0}}.
 
|}
 
|}
  
Line 200: Line 200:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:cosh</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:cosh|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the hyperbolic cosine of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the hyperbolic cosine of <code>$arg</code>.
+
|Returns the hyperbolic cosine of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the hyperbolic cosine of {{Code|$arg}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:cosh(0)</code> returns <code>1</code>.
+
* {{Code|math:cosh(0)}} returns {{Code|1}}.
 
|}
 
|}
  
Line 214: Line 214:
 
|-
 
|-
 
| width='90' | '''Signatures'''
 
| width='90' | '''Signatures'''
−
|<code><b>math:tanh</b>($arg as xs:double?) as xs:double?</code>
+
|{{Func|math:tanh|$arg as xs:double?|xs:double?}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Returns the hyperbolic tangent of <code>$arg</code>.<br/>If <code>$arg</code> is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the hyperbolic tangent of <code>$arg</code>.
+
|Returns the hyperbolic tangent of {{Code|$arg}}.<br/>If {{Code|$arg}} is the empty sequence, the empty sequence is returned.<br />Otherwise the result is the hyperbolic tangent of {{Code|$arg}}.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* <code>math:tanh(100)</code> returns <code>1</code>.
+
* {{Code|math:tanh(100)}} returns {{Code|1}}.
 
|}
 
|}
  
 
[[Category:XQuery]]
 
[[Category:XQuery]]

Revision as of 16:13, 26 May 2012

The math XQuery Module defines functions to perform mathematical operations, such as pi, asin and acos. Most functions are specified in the Functions and Operators Specification of the upcoming XQuery 3.0 Recommendation, and some additional ones have been added in this module.

Conventions

All functions in this module are assigned to the http://www.w3.org/2005/xpath-functions/math namespace, which is statically bound to the math prefix.

Functions

math:pi

Signatures math:pi() as xs:double
Summary Returns the xs:double value of the mathematical constant π whose lexical representation is 3.141592653589793.
Examples
  • 2*math:pi() returns 6.283185307179586e0.
  • 60 * (math:pi() div 180) converts an angle of 60 degrees to radians.

math:e

Signatures math:e() as xs:double
Summary Returns the xs:double value of the mathematical constant e whose lexical representation is 2.718281828459045.
Examples
  • 5*math:e() returns 13.591409142295225.

math:sqrt

Signatures math:sqrt($arg as xs:double?) as xs:double?
Summary Returns the square root of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the xs:double value of the mathematical square root of $arg.

math:sin

Signatures math:sin($arg as xs:double?) as xs:double?
Summary Returns the sine of the $arg, expressed in radians.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the sine of $arg, treated as an angle in radians.

math:cos

Signatures math:cos($arg as xs:double?) as xs:double?
Summary Returns the cosine of $arg, expressed in radians.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the cosine of $arg, treated as an angle in radians.

math:tan

Signatures math:tan($ as xs:double?) as xs:double?
Summary Returns the tangent of $arg, expressed in radians.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the tangent of $arg, treated as an angle in radians.

math:asin

Signatures math:asin($arg as xs:double?) as xs:double?
Summary Returns the arc sine of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the arc sine of $arg, returned as an angle in radians in the range -π/2 to +π/2.

math:acos

Signatures math:acos($arg as xs:double?) as xs:double?
Summary Returns the arc cosine of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the arc cosine of $arg, returned as an angle in radians in the range 0 to +π.

math:atan

Signatures math:atan($arg as xs:double?) as xs:double?
Summary Returns the arc tangent of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the arc tangent of $arg, returned as an angle in radians in the range -π/2 to +π/2.

math:atan2

Signatures math:atan2($arg1 as xs:double?, $arg2 as xs:double) as xs:double?
Summary Returns the arc tangent of $arg1 divided by $arg2, the result being in the range -π/2 to +π/2 radians.
If $arg1 is the empty sequence, the empty sequence is returned.
Otherwise the result is the arc tangent of $arg1 divided by $arg2, returned as an angle in radians in the range -π to +π.

math:pow

Signatures math:pow($arg1 as xs:double?, $arg2 as xs:double) as xs:double?
Summary Returns $arg1 raised to the power of $arg2.
If $arg1 is the empty sequence, the empty sequence is returned.
Otherwise the result is the $arg1 raised to the power of $arg2.
Examples
  • math:pow(2, 3) returns 8.

math:exp

Signatures math:exp($arg as xs:double?) as xs:double?
Summary Returns e raised to the power of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the value of e raised to the power of $arg.
Examples
  • math:exp(1) returns e.

math:log

Signatures math:log($arg as xs:double?) as xs:double?
Summary Returns the natural logarithm of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the natural logarithm (base e) of $arg.
Examples
  • math:log(math:e()) returns 1.

math:log10

Signatures math:log10($arg as xs:double?) as xs:double?
Summary Returns the base 10 logarithm of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the base 10 logarithm of $arg.
Examples
  • math:log(100) returns 2.

math:random

Signatures math:random() as xs:double?
Summary Returns a random xs:double value between 0.0 and 1.0.

math:sinh

Signatures math:sinh($arg as xs:double?) as xs:double?
Summary Returns the hyperbolic sine of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the hyperbolic sine of $arg.
Examples
  • math:sinh(0) returns 0.

math:cosh

Signatures math:cosh($arg as xs:double?) as xs:double?
Summary Returns the hyperbolic cosine of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the hyperbolic cosine of $arg.
Examples
  • math:cosh(0) returns 1.

math:tanh

Signatures math:tanh($arg as xs:double?) as xs:double?
Summary Returns the hyperbolic tangent of $arg.
If $arg is the empty sequence, the empty sequence is returned.
Otherwise the result is the hyperbolic tangent of $arg.
Examples
  • math:tanh(100) returns 1.
Retrieved from "http://docs.basex.org/index.php?title=Math_Module&oldid=7262"