blob: f65cf07c62afdb94c0ebee89ab9a6c0d1606f527 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.4-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<meta name="keywords" content="madlib,postgres,greenplum,machine learning,data mining,deep learning,ensemble methods,data science,market basket analysis,affinity analysis,pca,lda,regression,elastic net,huber white,proportional hazards,k-means,latent dirichlet allocation,bayes,support vector machines,svm"/>
<title>MADlib: DB Administrator Utilities</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="../mathjax/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="madlib_extra.css" rel="stylesheet" type="text/css"/>
<!-- google analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-45382226-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">MADlib
&#160;<span id="projectnumber">1.3</span> <span style="font-size:10pt; font-style:italic"><a href="../latest/./group__grp__utilities.html"> A newer version is available</a></span>
</div>
<div id="projectbrief">User Documentation</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__grp__utilities.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Groups</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">DB Administrator Utilities<div class="ingroups"><a class="el" href="group__grp__early__stage.html">Early Stage Development</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><b>Contents</b> </p>
<ul>
<li>
<a href="#utilities">Utility Functions</a> </li>
<li>
<a href="#rel;ated">Related Topics</a> </li>
</ul>
</div><dl class="section warning"><dt>Warning</dt><dd><em> This MADlib method is still in early stage development. There may be some issues that will be addressed in a future version. Interface and implementation is subject to change. </em></dd></dl>
<p>The utility module consists of useful utility functions to assist data scientists in using the product. Several of these functions can be used while implementing new algorithms.</p>
<p><a class="anchor" id="utilities"></a></p>
<dl class="section user"><dt>Utility Functions</dt><dd></dd></dl>
<table class="output">
<tr>
<th><a class="el" href="utilities_8sql__in.html#a9ce7ffa76acc8a0638e9bc48be99f36a" title="Return MADlib build information. ">version()</a> </th><td><p class="starttd">Return MADlib build information. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a76cfdbed8a6782f37f50710d855434bd" title="Raise an exception if the given condition is not satisfied. ">assert()</a> </th><td><p class="starttd">Raise an exception if the given condition is not satisfied. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a4d49e00b4dd6059f61ffb9fdc0a696f7" title="Compute the relative error of an approximate value. ">relative_error()</a> </th><td><p class="starttd">Compute the relative error of an approximate value. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a4d49e00b4dd6059f61ffb9fdc0a696f7" title="Compute the relative error of an approximate value. ">relative_error()</a> </th><td><p class="starttd">Compute the relative error (w.r.t. the 2-norm) of an apprixmate vector. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#aa90ffaebb43a5cbcb5c48281cbadd3b0" title="Check if a SQL statement raises an error. ">check_if_raises_error()</a> </th><td><p class="starttd">Check if a SQL statement raises an error. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#ac1f509bd94c6309b59eb4d479fb2a470" title="Check if a column exists in a table. ">check_if_col_exists()</a> </th><td><p class="starttd">Check if a column exists in a table. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a48bed63cab78a5446fa4c122eaae3a40" title="Check if a floating-point number is NaN (not a number) ">isnan()</a> </th><td><p class="starttd">Check if a floating-point number is NaN (not a number) </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a56501b6f9fabe65d7a6a6beb70a0e000" title="Create the temporary schema if it does not exist yet. ">create_schema_pg_temp()</a> </th><td><p class="starttd">Create the temporary schema if it does not exist yet. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#ab194d6a1222672c314ea39b78aad8fd0" title="Create volatile noop function. ">noop()</a> </th><td><p class="starttd">Create volatile noop function. </p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a60c4765ce8dc639cbb0ad4c389f5f1ad">bytea8in()</a> </th><td><p class="starttd"></p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#adff923d42d4bdb2b631d6cafd5f37a43">bytea8out()</a> </th><td><p class="starttd"></p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#a244a7ff30f2788a6f4816417982eb13b">bytea8recv()</a> </th><td><p class="starttd"></p>
<p class="endtd"></p>
</td></tr>
<tr>
<th><a class="el" href="utilities_8sql__in.html#aeb90c740e8e6b67aa60a11c430fa9050">bytea8send()</a> </th><td><p class="starttd"></p>
<p class="endtd"></p>
</td></tr>
</table>
<p><a class="anchor" id="related"></a></p>
<dl class="section user"><dt>Related Topics</dt><dd></dd></dl>
<p>File <a class="el" href="utilities_8sql__in.html" title="SQL functions for carrying out routine tasks. ">utilities.sql_in</a> documenting the SQL functions. </p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Jan 9 2014 20:27:18 for MADlib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
</ul>
</div>
</body>
</html>