summaryrefslogtreecommitdiffstats
path: root/www/lang_mathfunc.html
blob: 6379e346f2c0efa71e34bd92042d776b3d27e95e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html>
<html><head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link href="sqlite.css" rel="stylesheet">
<title>Built-In Mathematical SQL Functions</title>
<!-- path= -->
</head>
<body>
<div class=nosearch>
<a href="index.html">
<img class="logo" src="images/sqlite370_banner.gif" alt="SQLite" border="0">
</a>
<div><!-- IE hack to prevent disappearing logo --></div>
<div class="tagline desktoponly">
Small. Fast. Reliable.<br>Choose any three.
</div>
<div class="menu mainmenu">
<ul>
<li><a href="index.html">Home</a>
<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
<li class='wideonly'><a href='about.html'>About</a>
<li class='desktoponly'><a href="docs.html">Documentation</a>
<li class='desktoponly'><a href="download.html">Download</a>
<li class='wideonly'><a href='copyright.html'>License</a>
<li class='desktoponly'><a href="support.html">Support</a>
<li class='desktoponly'><a href="prosupport.html">Purchase</a>
<li class='search' id='search_menubutton'>
<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
</ul>
</div>
<div class="menu submenu" id="submenu">
<ul>
<li><a href='about.html'>About</a>
<li><a href='docs.html'>Documentation</a>
<li><a href='download.html'>Download</a>
<li><a href='support.html'>Support</a>
<li><a href='prosupport.html'>Purchase</a>
</ul>
</div>
<div class="searchmenu" id="searchmenu">
<form method="GET" action="search">
<select name="s" id="searchtype">
<option value="d">Search Documentation</option>
<option value="c">Search Changelog</option>
</select>
<input type="text" name="q" id="searchbox" value="">
<input type="submit" value="Go">
</form>
</div>
</div>
<script>
function toggle_div(nm) {
var w = document.getElementById(nm);
if( w.style.display=="block" ){
w.style.display = "none";
}else{
w.style.display = "block";
}
}
function toggle_search() {
var w = document.getElementById("searchmenu");
if( w.style.display=="block" ){
w.style.display = "none";
} else {
w.style.display = "block";
setTimeout(function(){
document.getElementById("searchbox").focus()
}, 30);
}
}
function div_off(nm){document.getElementById(nm).style.display="none";}
window.onbeforeunload = function(e){div_off("submenu");}
/* Disable the Search feature if we are not operating from CGI, since */
/* Search is accomplished using CGI and will not work without it. */
if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
document.getElementById("search_menubutton").style.display = "none";
}
/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
function hideorshow(btn,obj){
var x = document.getElementById(obj);
var b = document.getElementById(btn);
if( x.style.display!='none' ){
x.style.display = 'none';
b.innerHTML='show';
}else{
x.style.display = '';
b.innerHTML='hide';
}
return false;
}
var antiRobot = 0;
function antiRobotGo(){
if( antiRobot!=3 ) return;
antiRobot = 7;
var j = document.getElementById("mtimelink");
if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
}
function antiRobotDefense(){
document.body.onmousedown=function(){
antiRobot |= 2;
antiRobotGo();
document.body.onmousedown=null;
}
document.body.onmousemove=function(){
antiRobot |= 2;
antiRobotGo();
document.body.onmousemove=null;
}
setTimeout(function(){
antiRobot |= 1;
antiRobotGo();
}, 100)
antiRobotGo();
}
antiRobotDefense();
</script>
<div class=fancy>
<div class=nosearch>
<div class="fancy_title">
Built-In Mathematical SQL Functions
</div>
</div>





<h1 id="overview"><span>1. </span>Overview</h1>

<p>The math functions shown below are a subgroup of
<a href="lang_corefunc.html">scalar functions</a> that are built into the
<a href="amalgamation.html">SQLite amalgamation source file</a> but are only active
if the amalgamation is compiled using the
<a href="compile.html#enable_math_functions">-DSQLITE_ENABLE_MATH_FUNCTIONS</a> compile-time option.

</p><p>The arguments to math functions can be integers, floating-point numbers,
or strings or blobs that look like integers or real numbers.  If any argument
is NULL or is a string or blob that is not readily converted into a number,
then the function will return NULL.
These functions also return NULL for domain errors, such as trying to
take the square root of a negative number, or compute the arccosine of a
value greater than 1.0 or less than -1.0.

</p><p>The values returned by these functions are often approximations.
For example, the <a href="lang_mathfunc.html#pi">pi()</a> function returns 
3.141592653589793115997963468544185161590576171875 which 
is about 1.22465e-16 too small, but it is the closest approximation available
for IEEE754 doubles.

<p>
<div class='columns' style='columns: 15em auto;'>
<ul style='padding-top:0;'>
<li><a href='lang_mathfunc.html#acos'>acos(X)</a></li>
<li><a href='lang_mathfunc.html#acosh'>acosh(X)</a></li>
<li><a href='lang_mathfunc.html#asin'>asin(X)</a></li>
<li><a href='lang_mathfunc.html#asinh'>asinh(X)</a></li>
<li><a href='lang_mathfunc.html#atan'>atan(X)</a></li>
<li><a href='lang_mathfunc.html#atan2'>atan2(Y,X)</a></li>
<li><a href='lang_mathfunc.html#atanh'>atanh(X)</a></li>
<li><a href='lang_mathfunc.html#ceil'>ceil(X)</a></li>
<li><a href='lang_mathfunc.html#ceil'>ceiling(X)</a></li>
<li><a href='lang_mathfunc.html#cos'>cos(X)</a></li>
<li><a href='lang_mathfunc.html#cosh'>cosh(X)</a></li>
<li><a href='lang_mathfunc.html#degrees'>degrees(X)</a></li>
<li><a href='lang_mathfunc.html#exp'>exp(X)</a></li>
<li><a href='lang_mathfunc.html#floor'>floor(X)</a></li>
<li><a href='lang_mathfunc.html#ln'>ln(X)</a></li>
<li><a href='lang_mathfunc.html#log'>log(B,X)</a></li>
<li><a href='lang_mathfunc.html#log'>log(X)</a></li>
<li><a href='lang_mathfunc.html#log'>log10(X)</a></li>
<li><a href='lang_mathfunc.html#log2'>log2(X)</a></li>
<li><a href='lang_mathfunc.html#mod'>mod(X,Y)</a></li>
<li><a href='lang_mathfunc.html#pi'>pi()</a></li>
<li><a href='lang_mathfunc.html#pow'>pow(X,Y)</a></li>
<li><a href='lang_mathfunc.html#pow'>power(X,Y)</a></li>
<li><a href='lang_mathfunc.html#radians'>radians(X)</a></li>
<li><a href='lang_mathfunc.html#sin'>sin(X)</a></li>
<li><a href='lang_mathfunc.html#sinh'>sinh(X)</a></li>
<li><a href='lang_mathfunc.html#sqrt'>sqrt(X)</a></li>
<li><a href='lang_mathfunc.html#tan'>tan(X)</a></li>
<li><a href='lang_mathfunc.html#tanh'>tanh(X)</a></li>
<li><a href='lang_mathfunc.html#trunc'>trunc(X)</a></li>
</ul>
</div>


</p><h1 id="descriptions_of_built_in_scalar_sql_math_functions"><span>2. </span>Descriptions of built-in scalar SQL math functions</h1>
<dl>

<a name="acos"></a>
<dt><p><b>acos(<i>X</i>)</b></dt><dd><p>
  Return the arccosine of X.  The result is in radians.
</dd>
<a name="acosh"></a>
<dt><p><b>acosh(<i>X</i>)</b></dt><dd><p>
  Return the hyperbolic arccosine of X.
</dd>
<a name="asin"></a>
<dt><p><b>asin(<i>X</i>)</b></dt><dd><p>
  Return the arcsine of X.  The result is in radians.
</dd>
<a name="asinh"></a>
<dt><p><b>asinh(<i>X</i>)</b></dt><dd><p>
  Return the hyperbolic arcsine of X.
</dd>
<a name="atan"></a>
<dt><p><b>atan(<i>X</i>)</b></dt><dd><p>
  Return the arctangent of X.  The result is in radians.
</dd>
<a name="atan2"></a>
<dt><p><b>atan2(<i>Y</i>,<i>X</i>)</b></dt><dd><p>
  Return the arctangent of Y/X.  The result is in radians.  The
  result is placed into correct quadrant depending on the signs
  of X and Y.
</dd>
<a name="atanh"></a>
<dt><p><b>atanh(<i>X</i>)</b></dt><dd><p>
  Return the hyperbolic arctangent of X.
</dd>
<a name="ceil"></a>
<dt><p><b>ceil(<i>X</i>)<br />ceiling(<i>X</i>)</b></dt><dd><p>
  Return the first representable integer value greater than or equal to X.
  For positive values of X, this routine rounds away from zero.
  For negative values of X, this routine rounds toward zero.
</dd>
<a name="cos"></a>
<dt><p><b>cos(<i>X</i>)</b></dt><dd><p>
  Return the cosine of X.  X is in radians.
</dd>
<a name="cosh"></a>
<dt><p><b>cosh(<i>X</i>)</b></dt><dd><p>
  Return the hyperbolic cosine of X.
</dd>
<a name="degrees"></a>
<dt><p><b>degrees(<i>X</i>)</b></dt><dd><p>
  Convert value X from radians into degrees.
</dd>
<a name="exp"></a>
<dt><p><b>exp(<i>X</i>)</b></dt><dd><p>
  Compute <i>e</i> (Euler's number, approximately 2.71828182845905) raised
  to the power X.
</dd>
<a name="floor"></a>
<dt><p><b>floor(<i>X</i>)</b></dt><dd><p>
  Return the first representable integer value less than or equal to X.
  For positive numbers, this function rounds toward zero.
  For negative numbers, this function rounds away from zero.
</dd>
<a name="ln"></a>
<dt><p><b>ln(<i>X</i>)</b></dt><dd><p>
  Return the natural logarithm of X.
</dd>
<a name="log"></a>
<dt><p><b>log(<i>X</i>)<br />log10(<i>X</i>)<br />log(<i>B</i>,<i>X</i>)</b></dt><dd><p>
  Return the base-10 logarithm for X.  Or, for the two-argument version,
  return the base-B logarithm of X.
  <p>
  Compatibility note:  SQLite works like PostgreSQL in that the log() function
  computes a base-10 logarithm.  Most other SQL database engines compute a
  natural logarithm for log().  In the two-argument version of log(B,X), the
  first argument is the base and the second argument is the operand.  This is
  the same as in PostgreSQL and MySQL, but is reversed from SQL Server which
  uses the second argument as the base and the first argument as the operand.
</dd>
<a name="log2"></a>
<dt><p><b>log2(<i>X</i>)</b></dt><dd><p>
  Return the logarithm base-2 for the number X.
</dd>
<a name="mod"></a>
<dt><p><b>mod(<i>X</i>,<i>Y</i>)</b></dt><dd><p>
  Return the remainder after dividing X by Y.  This is similar to the '%'
  operator, except that it works for non-integer arguments.
</dd>
<a name="pi"></a>
<dt><p><b>pi()</b></dt><dd><p>
  Return an approximation for &pi;.
</dd>
<a name="pow"></a>
<dt><p><b>pow(<i>X</i>,<i>Y</i>)<br />power(<i>X</i>,<i>Y</i>)</b></dt><dd><p>
  Compute X raised to the power Y.
</dd>
<a name="radians"></a>
<dt><p><b>radians(<i>X</i>)</b></dt><dd><p>
  Convert X from degrees into radians.
</dd>
<a name="sin"></a>
<dt><p><b>sin(<i>X</i>)</b></dt><dd><p>
  Return the sine of X.  X is in radians.
</dd>
<a name="sinh"></a>
<dt><p><b>sinh(<i>X</i>)</b></dt><dd><p>
  Return the hyperbolic sine of X.
</dd>
<a name="sqrt"></a>
<dt><p><b>sqrt(<i>X</i>)</b></dt><dd><p>
  Return the square root of X.  NULL is returned if X is negative.
</dd>
<a name="tan"></a>
<dt><p><b>tan(<i>X</i>)</b></dt><dd><p>
  Return the tangent of X.  X is in radians.
</dd>
<a name="tanh"></a>
<dt><p><b>tanh(<i>X</i>)</b></dt><dd><p>
  Return the hyperbolic tangent of X.
</dd>
<a name="trunc"></a>
<dt><p><b>trunc(<i>X</i>)</b></dt><dd><p>
  Return the representable integer in between X and 0 (inclusive)
  that is furthest away from zero.  Or, in other words, return the
  integer part of X, rounding toward zero.
  The trunc() function is similar to <a href="lang_mathfunc.html#ceil">ceiling(X)</a> and <a href="lang_mathfunc.html#floor">floor(X)</a> except
  that it always rounds toward zero whereas ceiling(X) and floor(X) round
  up and down, respectively.
</dd>

</dl>
<p align="center"><small><i>This page last modified on  <a href="https://sqlite.org/docsrc/honeypot" id="mtimelink"  data-href="https://sqlite.org/docsrc/finfo/pages/lang_mathfunc.in?m=5307cdcb91">2023-12-05 14:43:20</a> UTC </small></i></p>