blob: 80848637591176b6469c84142fb6e7f9982fabfe [file] [log] [blame]
<!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"/>
<title>MADlib: linear.sql_in Source File</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" />
</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.1</span> <span style="font-size:10pt; font-style:italic"><a href="../latest/./linear_8sql__in_source.html"> A newer version is available</a></span>
</div>
<div id="projectbrief">User Documentation</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 id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<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>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</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('linear_8sql__in_source.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>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">linear.sql_in</div> </div>
</div><!--header-->
<div class="contents">
<a href="linear_8sql__in.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span><span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @file linear.sql_in</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * @brief SQL functions for linear regression</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * @date January 2011</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * @sa For a brief introduction to linear regression, see the module</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * description \ref grp_linreg.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> */</span><span class="comment">/* ----------------------------------------------------------------------- */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;m4_include(`SQLCommon.m4<span class="stringliteral">&#39;)</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="stringliteral"></span><span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">@addtogroup grp_linreg</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">&lt;div class=&quot;toc&quot;&gt;&lt;b&gt;Contents&lt;/b&gt;&lt;ul&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">&lt;li class=&quot;level1&quot;&gt;&lt;a href=&quot;#about&quot;&gt;About&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">&lt;li class=&quot;level1&quot;&gt;&lt;a href=&quot;#train&quot;&gt;Usage&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">&lt;li class=&quot;level2&quot;&gt;&lt;a href=&quot;#train&quot;&gt;Training Function&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">&lt;li class=&quot;level2&quot;&gt;&lt;a href=&quot;#output&quot;&gt;Output Table&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">&lt;li class=&quot;level2&quot;&gt;&lt;a href=&quot;#predict&quot;&gt;Prediction Function&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">&lt;li class=&quot;level1&quot;&gt;&lt;a href=&quot;#examples&quot;&gt;Examples&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">&lt;li class=&quot;level1&quot;&gt;&lt;a href=&quot;#seealso&quot;&gt;See Also&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">&lt;li class=&quot;level1&quot;&gt;&lt;a href=&quot;#background&quot;&gt;Technical Background&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">&lt;li class=&quot;level1&quot;&gt;&lt;a href=&quot;#literature&quot;&gt;Literature&lt;/a&gt;&lt;/li&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">&lt;/ul&gt;&lt;/div&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">@anchor about</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">@about</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">Ordinary Least Squares Regression, also called Linear Regression, is a</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">statistical model used to fit linear models.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">It models a linear relationship of a scalar dependent variable \f$ y \f$ to one</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">or more explanatory independent variables \f$ x \f$ to build a</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">model of coefficients.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">@anchor train</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">@par Training Function</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">@verbatim</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">linregr_train(source_table, out_table,</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> dependent_varname,</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> independent_varname,</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> input_group_cols := NULL,</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> heteroskedasticity_option := NULL)</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment">@endverbatim</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">&lt;DL class=&quot;arglist&quot;&gt;</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment">&lt;DT&gt;source_table&lt;/DT&gt;</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment">&lt;DD&gt;Text value. The name of the table containing the training data.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment">&lt;DT&gt;out_table&lt;/DT&gt;</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">&lt;DD&gt;Text value. Name of the generated table containing the output model.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment">&lt;DT&gt;dependent_varname&lt;/DT&gt;</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment">&lt;DD&gt;Text value. Expression to evaluate for the dependent variable.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment">&lt;DT&gt;independent_varname&lt;/DT&gt;</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment">&lt;DD&gt;Text value. Expression list to evaluate for the independent variables. An intercept variable is not assumed. It is common to provide an explicit intercept term by including a single constant &lt;tt&gt;1&lt;/tt&gt; term in the independent variable list.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment">&lt;DT&gt;input_group_cols&lt;/DT&gt;</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment">&lt;DD&gt;Text value. An expression list used to group the input dataset into discrete groups, running one regression per group. Similar to the SQL &lt;tt&gt;GROUP BY&lt;/tt&gt; clause. When this value is null, no grouping is used and a single result model is generated. Default value: NULL.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment">&lt;DT&gt;heteroskedasticity_option&lt;/DT&gt;</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment">&lt;DD&gt;Boolean value. When True, the heteroskedacity of the model is also calculated and returned with the results. Default value: False.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment">&lt;/DL&gt;</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment">@anchor output</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment">@par Output Table</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment">The output table produced by the linear regression training function contains the following columns.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment">&lt;DL class=&quot;arglist&quot;&gt;</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment">&lt;DT&gt;&lt;...&gt;&lt;/DT&gt;</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment">&lt;DD&gt;Any grouping columns provided during training.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment">Present only if the grouping option is used.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment">&lt;DT&gt;coef&lt;/DT&gt;</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment">&lt;DD&gt;Float array. Vector of the coefficients of the regression.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment">&lt;DT&gt;r2&lt;/DT&gt;</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment">&lt;DD&gt;Float. R-squared coefficient of determination of the model.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment">&lt;DT&gt;std_err&lt;/DT&gt;</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment">&lt;DD&gt;Float array. Vector of the standard error of the coefficients.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment">&lt;DT&gt;t_stats&lt;/DT&gt;</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment">&lt;DD&gt;Float array. Vector of the t-statistics of the coefficients.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment">&lt;DT&gt;p_values&lt;/DT&gt;</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment">&lt;DD&gt;Float array. Vector of the p-values of the coefficients.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment">&lt;DT&gt;condition_no&lt;/DT&gt;</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment">&lt;DD&gt;Float array. The condition number of the \f$X^{*}X\f$</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment">matrix. A high condition number is usually an indication that there may be</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment">some numeric instability in the result yielding a less reliable model. A high</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment">condition number often results when there is a significant amount of</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment">colinearity in the underlying design matrix, in which case other regression</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment">techniques, such as elastic net regression, may be more appropriate.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment">&lt;DT&gt;bp_stats&lt;/DT&gt;</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment">&lt;DD&gt;Float. The Breush-Pagan statistic of heteroskedacity. Present</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment">only if the heteroskedacity argument was set to True when the model was</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment">trained.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment">&lt;DT&gt;bp_p_value&lt;/DT&gt;</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment">&lt;DD&gt;Float. The Breush-Pagan calculated p-value. Present only if</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment">the heteroskedacity parameter was set to True when the model was</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment">trained.&lt;/DD&gt;</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment">&lt;/DL&gt;</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment">@anchor predict</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment">@par Prediction Function</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment">@verbatim</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment">linregr_predict(</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> coef,</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"> col_ind</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment">)</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment">@endverbatim</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment">&lt;dl class=&quot;arglist&quot;&gt;</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment">&lt;dt&gt;coef&lt;/dt&gt;</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment">&lt;dd&gt;Float array. Vector of the coefficients of regression.&lt;/dd&gt;</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="comment">&lt;dt&gt;col_ind&lt;/dt&gt;</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment">&lt;dd&gt;Float array. An array containing the independent variable column names. &lt;/dd&gt;</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment">@anchor examples</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment">@par Examples</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment">-# Create an input data set.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="comment">@verbatim</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment">CREATE TABLE houses (id INT, tax INT, bedroom INT, bath FLOAT, price INT,</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> size INT, lot INT);</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment">COPY houses FROM STDIN WITH DELIMITER &#39;|&#39;;</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment"> 1 | 590 | 2 | 1 | 50000 | 770 | 22100</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="comment"> 2 | 1050 | 3 | 2 | 85000 | 1410 | 12000</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment"> 3 | 20 | 3 | 1 | 22500 | 1060 | 3500</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment"> 4 | 870 | 2 | 2 | 90000 | 1300 | 17500</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment"> 5 | 1320 | 3 | 2 | 133000 | 1500 | 30000</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> 6 | 1350 | 2 | 1 | 90500 | 820 | 25700</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="comment"> 7 | 2790 | 3 | 2.5 | 260000 | 2130 | 25000</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="comment"> 8 | 680 | 2 | 1 | 142500 | 1170 | 22000</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="comment"> 9 | 1840 | 3 | 2 | 160000 | 1500 | 19000</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="comment"> 10 | 3680 | 4 | 2 | 240000 | 2790 | 20000</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="comment"> 11 | 1660 | 3 | 1 | 87000 | 1030 | 17500</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="comment"> 12 | 1620 | 3 | 2 | 118600 | 1250 | 20000</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="comment"> 13 | 3100 | 3 | 2 | 140000 | 1760 | 38000</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="comment"> 14 | 2070 | 2 | 3 | 148000 | 1550 | 14000</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment"> 15 | 650 | 3 | 1.5 | 65000 | 1450 | 12000</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="comment">\.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="comment">@endverbatim</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="comment">-# Train a regression model.</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="comment">@verbatim</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="comment">-- A single regression for all the data</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<span class="comment">SELECT madlib.linregr_train(</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="comment"> &#39;houses&#39;, &#39;houses_linregr&#39;, &#39;price&#39;, &#39;array[1, tax, bath, size]&#39;);</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment">-- 3 output models, one for each value of &quot;bedroom&quot;</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="comment">SELECT madlib.linregr_train(</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="comment"> &#39;houses&#39;, &#39;houses_linregr_bedroom&#39;, &#39;price&#39;, &#39;array[1, tax, bath, size]&#39;,</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> &#39;bedroom&#39;);</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="comment">@endverbatim</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment">-# Examine the resulting models.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment">@verbatim</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="comment">-- Set extended display on for easier reading of output</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="comment">\x on</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="comment">SELECT * from houses_linregr;</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="comment">SELECT * FROM houses_linregr_bedroom;</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;<span class="comment">-- Alternatively you can unnest the results for easier reading of output</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment">\x off</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="comment">SELECT unnest(array[&#39;intercept&#39;,&#39;tax&#39;,&#39;bath&#39;,&#39;size&#39;]) as attribute,</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="comment"> unnest(coef) as coefficient,</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="comment"> unnest(std_err) as standard_error,</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="comment"> unnest(t_stats) as t_stat,</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="comment"> unnest(p_values) as pvalue</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment">FROM houses_linregr;</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="comment">@endverbatim</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="comment">-# Use the prediction function to evaluate residuals.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment">@verbatim</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="comment">SELECT houses.*,</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;<span class="comment"> madlib.linregr_predict(array[1,tax,bath,size], m.coef) as predict,</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;<span class="comment"> price - madlib.linregr_predict(array[1,tax,bath,size], m.coef)</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="comment"> as residual</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="comment">FROM houses, houses_linregr m;</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="comment">@endverbatim</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="comment">@anchor seealso</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="comment">@sa File linear.sql_in, documenting the SQL training functions</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;<span class="comment">@sa linregr()</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;<span class="comment">@sa logregr_train()</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;<span class="comment">@sa elastic_net_train()</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;<span class="comment">@sa grp_robust</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;<span class="comment">@sa grp_clustered_errors</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;<span class="comment">@sa grp_validation</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;<span class="comment">@anchor background</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;<span class="comment">@par Technical Background</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="comment">Ordinary least-squares (OLS) linear regression refers to a stochastic model in</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="comment">which the conditional mean of the dependent variable (usually denoted \f$ Y \f$)</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;<span class="comment">is an affine function of the vector of independent variables (usually denoted</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;<span class="comment">\f$ \boldsymbol x \f$). That is,</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;<span class="comment"> E[Y \mid \boldsymbol x] = \boldsymbol c^T \boldsymbol x</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment">for some unknown vector of coefficients \f$ \boldsymbol c \f$. The assumption is</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="comment">that the residuals are i.i.d. distributed Gaussians. That is, the (conditional)</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;<span class="comment">probability density of \f$ Y \f$ is given by</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;<span class="comment"> f(y \mid \boldsymbol x)</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;<span class="comment"> = \frac{1}{\sqrt{2 \pi \sigma^2}}</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;<span class="comment"> \cdot \exp\left(-\frac{1}{2 \sigma^2}</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;<span class="comment"> \cdot (y - \boldsymbol x^T \boldsymbol c)^2 \right)</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;<span class="comment"> \,.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;<span class="comment">OLS linear regression finds the vector of coefficients \f$ \boldsymbol c \f$</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;<span class="comment">that maximizes the likelihood of the observations.</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;<span class="comment">Let</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;<span class="comment">- \f$ \boldsymbol y \in \mathbf R^n \f$ denote the vector of observed dependent</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;<span class="comment"> variables, with \f$ n \f$ rows, containing the observed values of the</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;<span class="comment"> dependent variable,</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;<span class="comment">- \f$ X \in \mathbf R^{n \times k} \f$ denote the design matrix with \f$ k \f$</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;<span class="comment"> columns and \f$ n \f$ rows, containing all observed vectors of independent</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;<span class="comment"> variables.</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;<span class="comment"> \f$ \boldsymbol x_i \f$ as rows,</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<span class="comment">- \f$ X^T \f$ denote the transpose of \f$ X \f$,</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;<span class="comment">- \f$ X^+ \f$ denote the pseudo-inverse of \f$ X \f$.</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;<span class="comment">Maximizing the likelihood is equivalent to maximizing the log-likelihood</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;<span class="comment">\f$ \sum_{i=1}^n \log f(y_i \mid \boldsymbol x_i) \f$, which simplifies to</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="comment">minimizing the &lt;b&gt;residual sum of squares&lt;/b&gt; \f$ RSS \f$ (also called sum of</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;<span class="comment">squared residuals or sum of squared errors of prediction),</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;<span class="comment"> RSS = \sum_{i=1}^n ( y_i - \boldsymbol c^T \boldsymbol x_i )^2</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;<span class="comment"> = (\boldsymbol y - X \boldsymbol c)^T (\boldsymbol y - X \boldsymbol c)</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;<span class="comment"> \,.</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;<span class="comment">The first-order conditions yield that the \f$ RSS \f$ is minimized at</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;<span class="comment"> \boldsymbol c = (X^T X)^+ X^T \boldsymbol y</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;<span class="comment"> \,.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;<span class="comment">Computing the &lt;b&gt;total sum of squares&lt;/b&gt; \f$ TSS \f$, the &lt;b&gt;explained</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;<span class="comment">sum of squares&lt;/b&gt; \f$ ESS \f$ (also called the regression sum of</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;<span class="comment">squares), and the &lt;b&gt;coefficient of determination&lt;/b&gt; \f$ R^2 \f$ is</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;<span class="comment">done according to the following formulas:</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;<span class="comment">\f{align*}{</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;<span class="comment"> ESS &amp; = \boldsymbol y^T X \boldsymbol c</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;<span class="comment"> - \frac{ \| y \|_1^2 }{n} \\</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;<span class="comment"> TSS &amp; = \sum_{i=1}^n y_i^2</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;<span class="comment"> - \frac{ \| y \|_1^2 }{n} \\</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;<span class="comment"> R^2 &amp; = \frac{ESS}{TSS}</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;<span class="comment">\f}</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;<span class="comment">Note: The last equality follows from the definition</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;<span class="comment">\f$ R^2 = 1 - \frac{RSS}{TSS} \f$ and the fact that for linear regression</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;<span class="comment">\f$ TSS = RSS + ESS \f$. A proof of the latter can be found, e.g., at:</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;<span class="comment">http://en.wikipedia.org/wiki/Sum_of_squares</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;<span class="comment">We estimate the variance</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="comment">\f$ Var[Y - \boldsymbol c^T \boldsymbol x \mid \boldsymbol x] \f$ as</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;<span class="comment"> \sigma^2 = \frac{RSS}{n - k}</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment">and compute the t-statistic for coefficient \f$ i \f$ as</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;<span class="comment"> t_i = \frac{c_i}{\sqrt{\sigma^2 \cdot \left( (X^T X)^{-1} \right)_{ii} }}</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;<span class="comment"> \,.</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;<span class="comment">The \f$ p \f$-value for coefficient \f$ i \f$ gives the probability of seeing a</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="comment">value at least as extreme as the one observed, provided that the null hypothesis</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;<span class="comment">(\f$ c_i = 0 \f$) is true. Letting \f$ F_\nu \f$ denote the</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;<span class="comment">cumulative density function of student-t with \f$ \nu \f$ degrees of freedom,</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;<span class="comment">the \f$ p \f$-value for coefficient \f$ i \f$</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<span class="comment">is therefore</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;<span class="comment"> p_i = \Pr(|T| \geq |t_i|) = 2 \cdot (1 - F_{n - k}( |t_i| ))</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;<span class="comment">where \f$ T \f$ is a student-t distributed random variable with mean 0.</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;<span class="comment">The condition number [2] \f$ \kappa(X) = \|X\|_2\cdot\|X^{-1}\|_2\f$ is computed</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="comment">as the product of two spectral norms [3]. The spectral norm of a matrix \f$X\f$</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;<span class="comment">is the largest singular value of \f$X\f$ i.e. the square root of the largest</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;<span class="comment">eigenvalue of the positive-semidefinite matrix \f$X^{*}X\f$:</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;<span class="comment">\f[</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;<span class="comment"> \|X\|_2 = \sqrt{\lambda_{\max}\left(X^{*}X\right)}\ ,</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;<span class="comment">\f]</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;<span class="comment">where \f$X^{*}\f$ is the conjugate transpose of \f$X\f$.</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;<span class="comment">The condition number of a linear regression problem</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;<span class="comment">is a worst-case measure of how sensitive the</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="comment">result is to small perturbations of the input. A large condition number (say,</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;<span class="comment">more than 1000) indicates the presence of significant multicollinearity.</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160;<span class="comment">@anchor literature</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;<span class="comment">@literature</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;<span class="comment">[1] Cosma Shalizi: Statistics 36-350: Data Mining, Lecture Notes, 21 October</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;<span class="comment"> 2009, http://www.stat.cmu.edu/~cshalizi/350/lectures/17/lecture-17.pdf</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;<span class="comment">[2] Wikipedia: Condition Number, http://en.wikipedia.org/wiki/Condition_number.</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;<span class="comment">[3] Wikipedia: Spectral Norm,</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="comment"> http://en.wikipedia.org/wiki/Spectral_norm#Spectral_norm</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;<span class="comment">[4] Wikipedia: Breusch–Pagan test,</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;<span class="comment"> http://en.wikipedia.org/wiki/Breusch%E2%80%93Pagan_test</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;<span class="comment">[5] Wikipedia: Heteroscedasticity-consistent standard errors,</span></div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;<span class="comment">http://en.wikipedia.org/wiki/Heteroscedasticity-consistent_standard_errors</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;<span class="comment">@internal</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;<span class="comment">@sa Namespace \ref madlib::modules::regress</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;<span class="comment"> documenting the implementation in C++</span></div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160;<span class="comment">@endinternal</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;---------------------------------------------------------------------------</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;CREATE TYPE MADLIB_SCHEMA.linregr_result AS (</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; coef DOUBLE PRECISION[],</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; r2 DOUBLE PRECISION,</div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; std_err DOUBLE PRECISION[],</div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; t_stats DOUBLE PRECISION[],</div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; p_values DOUBLE PRECISION[],</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; condition_no DOUBLE PRECISION</div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;);</div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;</div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.linregr_transition(</div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; state MADLIB_SCHEMA.bytea8,</div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; y DOUBLE PRECISION,</div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; x DOUBLE PRECISION[])</div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;RETURNS MADLIB_SCHEMA.bytea8</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;AS &#39;MODULE_PATHNAME<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;<span class="stringliteral">LANGUAGE C</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;<span class="stringliteral">IMMUTABLE STRICT;</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160;<span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.linregr_merge_states(</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;<span class="stringliteral"> state1 MADLIB_SCHEMA.bytea8,</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;<span class="stringliteral"> state2 MADLIB_SCHEMA.bytea8)</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;<span class="stringliteral">RETURNS MADLIB_SCHEMA.bytea8</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;<span class="stringliteral">AS &#39;</span>MODULE_PATHNAME<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;<span class="stringliteral">LANGUAGE C</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160;<span class="stringliteral">IMMUTABLE STRICT;</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;<span class="stringliteral">-- Final functions</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;<span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.linregr_final(</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;<span class="stringliteral"> state MADLIB_SCHEMA.bytea8)</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="stringliteral">RETURNS MADLIB_SCHEMA.linregr_result</span></div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;<span class="stringliteral">AS &#39;</span>MODULE_PATHNAME<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;<span class="stringliteral">LANGUAGE C IMMUTABLE STRICT;</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;<span class="stringliteral">CREATE TYPE MADLIB_SCHEMA.heteroskedasticity_test_result AS (</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;<span class="stringliteral"> bp_stats DOUBLE PRECISION,</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160;<span class="stringliteral"> bp_p_value DOUBLE PRECISION</span></div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;<span class="stringliteral">);</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;<span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.hetero_linregr_transition(</span></div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160;<span class="stringliteral"> state MADLIB_SCHEMA.bytea8,</span></div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160;<span class="stringliteral"> y DOUBLE PRECISION,</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;<span class="stringliteral"> x DOUBLE PRECISION[],</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;<span class="stringliteral"> coef DOUBLE PRECISION[])</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;<span class="stringliteral">RETURNS MADLIB_SCHEMA.bytea8</span></div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="stringliteral">AS &#39;</span>MODULE_PATHNAME<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="stringliteral">LANGUAGE C</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="stringliteral">IMMUTABLE STRICT;</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.hetero_linregr_merge_states(</span></div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;<span class="stringliteral"> state1 MADLIB_SCHEMA.bytea8,</span></div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;<span class="stringliteral"> state2 MADLIB_SCHEMA.bytea8)</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;<span class="stringliteral">RETURNS MADLIB_SCHEMA.bytea8</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="stringliteral">AS &#39;</span>MODULE_PATHNAME<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160;<span class="stringliteral">LANGUAGE C</span></div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;<span class="stringliteral">IMMUTABLE STRICT;</span></div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160;<span class="stringliteral">-- Final functions</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;<span class="stringliteral">CREATE OR REPLACE FUNCTION MADLIB_SCHEMA.hetero_linregr_final(</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160;<span class="stringliteral"> state MADLIB_SCHEMA.bytea8)</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160;<span class="stringliteral">RETURNS MADLIB_SCHEMA.heteroskedasticity_test_result</span></div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160;<span class="stringliteral">AS &#39;</span>MODULE_PATHNAME<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160;<span class="stringliteral">LANGUAGE C IMMUTABLE STRICT;</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160;<span class="stringliteral"></span><span class="comment"></span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;<span class="comment"> * @brief Compute studentized Breuch-Pagan heteroskedasticity test for</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="comment"> * linear regression.</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;<span class="comment"> * @param dependentVariable Column containing the dependent variable</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"> * @param independentVariables Column containing the array of independent variables</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;<span class="comment"> * @param olsCoefficients Column containing the array of the OLS coefficients (as obtained by linregr)</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160;<span class="comment"> * @par</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;<span class="comment"> * To include an intercept in the model, set one coordinate in the</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160;<span class="comment"> * &lt;tt&gt;independentVariables&lt;/tt&gt; array to 1.</span></div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> * @return A composite value:</span></div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;<span class="comment"> * - &lt;tt&gt;test_statistic FLOAT8[]&lt;/tt&gt; - Prob &gt; test_statistc</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> * - &lt;tt&gt;p_value FLOAT8[]&lt;/tt&gt; - Prob &gt; test_statistc</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160;<span class="comment"> * @usage</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160;<span class="comment"> * &lt;pre&gt; SELECT (heteoskedasticity_test_linregr(&lt;em&gt;dependentVariable&lt;/em&gt;,</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160;<span class="comment"> * &lt;em&gt;independentVariables&lt;/em&gt;, coef)).*</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160;<span class="comment"> * FROM (</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160;<span class="comment"> * SELECT linregr(&lt;em&gt;dependentVariable&lt;/em&gt;, &lt;em&gt;independentVariables&lt;/em&gt;).coef</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160;<span class="comment"> * ) AS ols_coef, &lt;em&gt;sourceName&lt;/em&gt; as src;</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160;<span class="comment"> * &lt;/pre&gt;</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;CREATE AGGREGATE MADLIB_SCHEMA.heteroskedasticity_test_linregr(</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160; /*+ &quot;dependentVariable&quot; */ DOUBLE PRECISION,</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; /*+ &quot;independentVariables&quot; */ DOUBLE PRECISION[],</div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; /*+ &quot;olsCoefficients&quot; */ DOUBLE PRECISION[]) (</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160;</div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160; SFUNC=MADLIB_SCHEMA.hetero_linregr_transition,</div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160; STYPE=MADLIB_SCHEMA.bytea8,</div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; FINALFUNC=MADLIB_SCHEMA.hetero_linregr_final,</div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; m4_ifdef(`GREENPLUM&#39;,`prefunc=MADLIB_SCHEMA.hetero_linregr_merge_states,<span class="stringliteral">&#39;)</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160;<span class="stringliteral"> INITCOND=&#39;</span><span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;<span class="stringliteral">);</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="stringliteral"></span><span class="comment"></span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160;<span class="comment"> * @brief Compute linear regression coefficients and diagnostic statistics.</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160;<span class="comment"> * @param dependentVariable Column containing the dependent variable</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160;<span class="comment"> * @param independentVariables Column containing the array of independent variables</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="comment"> * @par</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160;<span class="comment"> * To include an intercept in the model, set one coordinate in the</span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;<span class="comment"> * &lt;tt&gt;independentVariables&lt;/tt&gt; array to 1.</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"><a class="code" href="linear_8sql__in.html#a85d6d11ff2c93855061515d92d4785c2"> 431</a></span>&#160;<span class="comment"> * @return A composite value:</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;<span class="comment"> * - &lt;tt&gt;coef FLOAT8[]&lt;/tt&gt; - Array of coefficients, \f$ \boldsymbol c \f$</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160;<span class="comment"> * - &lt;tt&gt;r2 FLOAT8&lt;/tt&gt; - Coefficient of determination, \f$ R^2 \f$</span></div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160;<span class="comment"> * - &lt;tt&gt;std_err FLOAT8[]&lt;/tt&gt; - Array of standard errors,</span></div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160;<span class="comment"> * \f$ \mathit{se}(c_1), \dots, \mathit{se}(c_k) \f$</span></div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160;<span class="comment"> * - &lt;tt&gt;t_stats FLOAT8[]&lt;/tt&gt; - Array of t-statistics, \f$ \boldsymbol t \f$</span></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160;<span class="comment"> * - &lt;tt&gt;p_values FLOAT8[]&lt;/tt&gt; - Array of p-values, \f$ \boldsymbol p \f$</span></div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160;<span class="comment"> * - &lt;tt&gt;condition_no FLOAT8&lt;/tt&gt; - The condition number of matrix</span></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160;<span class="comment"> * \f$ X^T X \f$.</span></div>
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160;<span class="comment"> * @usage</span></div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160;<span class="comment"> * - Get vector of coefficients \f$ \boldsymbol c \f$ and all diagnostic</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160;<span class="comment"> * statistics:\n</span></div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160;<span class="comment"> * &lt;pre&gt;SELECT (linregr(&lt;em&gt;dependentVariable&lt;/em&gt;,</span></div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;<span class="comment"> * &lt;em&gt;independentVariables&lt;/em&gt;)).*</span></div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160;<span class="comment"> *FROM &lt;em&gt;sourceName&lt;/em&gt;;&lt;/pre&gt;</span></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160;<span class="comment"> * - Get vector of coefficients \f$ \boldsymbol c \f$:\n</span></div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160;<span class="comment"> * &lt;pre&gt;SELECT (linregr(&lt;em&gt;dependentVariable&lt;/em&gt;,</span></div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160;<span class="comment"> * &lt;em&gt;independentVariables&lt;/em&gt;)).coef</span></div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160;<span class="comment"> *FROM &lt;em&gt;sourceName&lt;/em&gt;;&lt;/pre&gt;</span></div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160;<span class="comment"> * - Get a subset of the output columns, e.g., only the array of coefficients</span></div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160;<span class="comment"> * \f$ \boldsymbol c \f$, the coefficient of determination \f$ R^2 \f$, and</span></div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160;<span class="comment"> * the array of p-values \f$ \boldsymbol p \f$:</span></div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160;<span class="comment"> * &lt;pre&gt;SELECT (lr).coef, (lr).r2, (lr).p_values</span></div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160;<span class="comment"> *FROM (</span></div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160;<span class="comment"> * SELECT linregr( &lt;em&gt;dependentVariable&lt;/em&gt;,</span></div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160;<span class="comment"> * &lt;em&gt;independentVariables&lt;/em&gt;) AS lr</span></div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160;<span class="comment"> * FROM &lt;em&gt;sourceName&lt;/em&gt;</span></div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160;<span class="comment"> *) AS subq;&lt;/pre&gt;</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160;</div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160;CREATE AGGREGATE MADLIB_SCHEMA.linregr(</div>
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160; /*+ &quot;dependentVariable&quot; */ DOUBLE PRECISION,</div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160; /*+ &quot;independentVariables&quot; */ DOUBLE PRECISION[]) (</div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160;</div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160; SFUNC=MADLIB_SCHEMA.linregr_transition,</div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160; STYPE=MADLIB_SCHEMA.bytea8,</div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160; FINALFUNC=MADLIB_SCHEMA.linregr_final,</div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160; m4_ifdef(`__GREENPLUM__&#39;,`prefunc=MADLIB_SCHEMA.linregr_merge_states,<span class="stringliteral">&#39;)</span></div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>&#160;<span class="stringliteral"> INITCOND=&#39;</span><span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>&#160;<span class="stringliteral">);</span></div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160;<span class="stringliteral">--------------------------- INTERNAL ---------------------------------------</span></div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160;<span class="stringliteral"></span><span class="comment"></span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>&#160;<span class="comment"> * @brief Return heteroskedasticity values for specific linear regression</span></div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>&#160;<span class="comment"> * coefficients</span></div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>&#160;<span class="comment">**/</span></div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>&#160;CREATE FUNCTION MADLIB_SCHEMA.__internal_get_hsk_result(</div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>&#160; source_table VARCHAR -- name of input table</div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>&#160; , dependent_varname VARCHAR -- name of dependent variable</div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>&#160; , independent_varname VARCHAR -- name of independent variable</div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>&#160; , linregr_coeffs DOUBLE PRECISION[] -- coeffs from linear regression</div>
<div class="line"><a name="l00484"></a><span class="lineno"><a class="code" href="linear_8sql__in.html#a71d8295a18e93619b3331cefabe6e79b"> 484</a></span>&#160;)</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160;RETURNS MADLIB_SCHEMA.heteroskedasticity_test_result AS $$</div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>&#160;DECLARE</div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160;hsk_value MADLIB_SCHEMA.heteroskedasticity_test_result;</div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>&#160;BEGIN</div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>&#160; EXECUTE &#39;</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>&#160; SELECT (MADLIB_SCHEMA.heteroskedasticity_test_linregr(<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>&#160;<span class="stringliteral"> || dependent_varname || &#39;</span> , <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>&#160;<span class="stringliteral"> || independent_varname || &#39;</span> , <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160;<span class="stringliteral"> || &#39;</span>ARRAY[<span class="stringliteral">&#39; || array_to_string(linregr_coeffs, &#39;</span>,<span class="stringliteral">&#39;) || &#39;</span>])).*</div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>&#160; FROM <span class="stringliteral">&#39; || source_table</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>&#160;<span class="stringliteral"> INTO hsk_value;</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span>&#160;<span class="stringliteral"> RETURN hsk_value;</span></div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>&#160;<span class="stringliteral">END</span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>&#160;<span class="stringliteral">$$ LANGUAGE plpgsql VOLATILE;</span><span class="comment"></span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160;<span class="comment"> * @brief Return linear regression output for source data</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160;<span class="comment">**/</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160;CREATE FUNCTION MADLIB_SCHEMA.__internal_get_linreg_result(</div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160; source_table VARCHAR -- name of input table</div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>&#160; , dependent_varname VARCHAR -- name of dependent variable</div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>&#160; , independent_varname VARCHAR -- name of independent variable</div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>&#160;)</div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>&#160;RETURNS MADLIB_SCHEMA.linregr_result AS $$</div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160;DECLARE</div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>&#160;lin_rst MADLIB_SCHEMA.linregr_result;</div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>&#160;BEGIN</div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span>&#160; EXECUTE &#39;</div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160; SELECT (MADLIB_SCHEMA.linregr( <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>&#160;<span class="stringliteral"> || dependent_varname || &#39;</span> , <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>&#160;<span class="stringliteral"> || independent_varname || &#39;</span>)</div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>&#160; ).*</div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>&#160; FROM <span class="stringliteral">&#39; || source_table</span></div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160;<span class="stringliteral"> INTO lin_rst;</span></div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160;<span class="stringliteral"> RETURN lin_rst;</span></div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>&#160;<span class="stringliteral">END</span></div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>&#160;<span class="stringliteral">$$ LANGUAGE plpgsql VOLATILE;</span></div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>&#160;<span class="stringliteral">CREATE FUNCTION MADLIB_SCHEMA.__internal_get_linregr_insert_string(</span></div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>&#160;<span class="stringliteral"> lin_rst MADLIB_SCHEMA.linregr_result,</span></div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>&#160;<span class="stringliteral"> out_table TEXT</span></div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>&#160;<span class="stringliteral">)</span></div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160;<span class="stringliteral">RETURNS VARCHAR AS $$</span></div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160;<span class="stringliteral">DECLARE</span></div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160;<span class="stringliteral"> insert_string VARCHAR;</span></div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>&#160;<span class="stringliteral">BEGIN</span></div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>&#160;<span class="stringliteral"> insert_string := &#39;</span>INSERT INTO <span class="stringliteral">&#39; || out_table || &#39;</span> VALUES (<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>&#160;<span class="stringliteral"> insert_string := insert_string ||</span></div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>&#160;<span class="stringliteral"> CASE</span></div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>&#160;<span class="stringliteral"> WHEN (lin_rst).coef is NULL</span></div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>&#160;<span class="stringliteral"> THEN &#39;</span><span class="stringliteral">&#39;&#39;</span>{}<span class="stringliteral">&#39;&#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span>&#160;<span class="stringliteral"> ELSE &#39;</span>ARRAY[<span class="stringliteral">&#39; || array_to_string((lin_rst).coef, &#39;</span>,<span class="stringliteral">&#39;) || &#39;</span>], <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160;<span class="stringliteral"> END ||</span></div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>&#160;<span class="stringliteral"> CASE</span></div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160;<span class="stringliteral"> WHEN (lin_rst).r2 is NULL</span></div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160;<span class="stringliteral"> THEN &#39;</span>0.0,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160;<span class="stringliteral"> ELSE (lin_rst).r2 || &#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160;<span class="stringliteral"> END ||</span></div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160;<span class="stringliteral"> CASE</span></div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160;<span class="stringliteral"> WHEN (lin_rst).std_err is NULL</span></div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160;<span class="stringliteral"> THEN &#39;</span><span class="stringliteral">&#39;&#39;</span>{}<span class="stringliteral">&#39;&#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160;<span class="stringliteral"> ELSE &#39;</span>ARRAY[<span class="stringliteral">&#39; || array_to_string((lin_rst).std_err, &#39;</span>,<span class="stringliteral">&#39;) || &#39;</span>], <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160;<span class="stringliteral"> END ||</span></div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160;<span class="stringliteral"> CASE</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160;<span class="stringliteral"> WHEN (lin_rst).t_stats is NULL</span></div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;<span class="stringliteral"> THEN &#39;</span><span class="stringliteral">&#39;&#39;</span>{}<span class="stringliteral">&#39;&#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;<span class="stringliteral"> ELSE &#39;</span>ARRAY[<span class="stringliteral">&#39; || array_to_string((lin_rst).t_stats, &#39;</span>,<span class="stringliteral">&#39;) || &#39;</span>], <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;<span class="stringliteral"> END ||</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160;<span class="stringliteral"> CASE</span></div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160;<span class="stringliteral"> WHEN (lin_rst).p_values is NULL</span></div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span>&#160;<span class="stringliteral"> THEN &#39;</span><span class="stringliteral">&#39;&#39;</span>{}<span class="stringliteral">&#39;&#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span>&#160;<span class="stringliteral"> ELSE &#39;</span>ARRAY[<span class="stringliteral">&#39; || array_to_string((lin_rst).p_values, &#39;</span>,<span class="stringliteral">&#39;) || &#39;</span>], <span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160;<span class="stringliteral"> END ||</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160;<span class="stringliteral"> CASE</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160;<span class="stringliteral"> WHEN (lin_rst).condition_no is NULL</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160;<span class="stringliteral"> THEN &#39;</span>0.0<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160;<span class="stringliteral"> ELSE (lin_rst).condition_no</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160;<span class="stringliteral"> END;</span></div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;<span class="stringliteral"> RETURN insert_string;</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160;<span class="stringliteral">END;</span></div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160;<span class="stringliteral">$$ LANGUAGE plpgsql VOLATILE;</span></div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160;<span class="stringliteral"></span><span class="comment"></span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160;<span class="comment"> * @brief Compute linear regression coefficients and heterskedasticity values</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>&#160;<span class="comment"> **/</span></div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160; CREATE FUNCTION MADLIB_SCHEMA.__internal_linregr_train_hetero(</div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160; source_table VARCHAR -- name of input table</div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160; , out_table VARCHAR -- name of output table</div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160; , dependent_varname VARCHAR -- name of dependent variable</div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160; , independent_varname VARCHAR -- name of independent variable</div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160; , heteroskedasticity_option BOOLEAN -- do you want heteroskedasticity output</div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160;)</div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160;RETURNS VOID AS $$</div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span>&#160;DECLARE</div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160;insert_string VARCHAR;</div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>&#160;lin_rst MADLIB_SCHEMA.linregr_result;</div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160;hsk_value MADLIB_SCHEMA.heteroskedasticity_test_result;</div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span>&#160;BEGIN</div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span>&#160; IF (source_table IS NULL OR source_table = &#39;<span class="stringliteral">&#39;) THEN</span></div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span>&#160;<span class="stringliteral"> RAISE EXCEPTION &#39;</span>Invalid input table name given.<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span>&#160;<span class="stringliteral"> IF (out_table IS NULL OR out_table = &#39;</span><span class="stringliteral">&#39;) THEN</span></div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span>&#160;<span class="stringliteral"> RAISE EXCEPTION &#39;</span>Invalid output table name given.<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span>&#160;<span class="stringliteral"> IF (dependent_varname IS NULL OR dependent_varname = &#39;</span><span class="stringliteral">&#39;) THEN</span></div>
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span>&#160;<span class="stringliteral"> RAISE EXCEPTION &#39;</span>Invalid dependent variable name given.<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>&#160;<span class="stringliteral"> IF (independent_varname IS NULL OR independent_varname = &#39;</span><span class="stringliteral">&#39;) THEN</span></div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>&#160;<span class="stringliteral"> RAISE EXCEPTION &#39;</span>Invalid independent variable name given.<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>&#160;<span class="stringliteral"> IF (MADLIB_SCHEMA.__table_exists(out_table)) THEN</span></div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160;<span class="stringliteral"> RAISE EXCEPTION &#39;</span>Output table name already exists. Drop the table before calling the <span class="keyword">function</span>.<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160;<span class="stringliteral"> -- create output table with appropriate column names</span></div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span>&#160;<span class="stringliteral"> EXECUTE &#39;</span>DROP TABLE IF EXISTS <span class="stringliteral">&#39; || out_table;</span></div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>&#160;<span class="stringliteral"> EXECUTE &#39;</span></div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span>&#160; CREATE TABLE <span class="stringliteral">&#39; || out_table || &#39;</span> (</div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span>&#160; coef DOUBLE PRECISION[],</div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span>&#160; r2 DOUBLE PRECISION,</div>
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span>&#160; std_err DOUBLE PRECISION[],</div>
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span>&#160; t_stats DOUBLE PRECISION[],</div>
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span>&#160; p_values DOUBLE PRECISION[],</div>
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span>&#160; condition_no DOUBLE PRECISION)<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span>&#160;<span class="stringliteral"> IF heteroskedasticity_option THEN</span></div>
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span>&#160;<span class="stringliteral"> -- Alter output table to add heteroskedasticity values</span></div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160;<span class="stringliteral"> EXECUTE &#39;</span></div>
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span>&#160; ALTER TABLE <span class="stringliteral">&#39; || out_table || &#39;</span></div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160; ADD COLUMN bp_stats DOUBLE PRECISION,</div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span>&#160; ADD COLUMN bp_p_value DOUBLE PRECISION<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span>&#160;<span class="stringliteral"> -- compute linear regression and heteroskedasticity values (if required)</span></div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span>&#160;<span class="stringliteral"> lin_rst := MADLIB_SCHEMA.__internal_get_linreg_result(</span></div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span>&#160;<span class="stringliteral"> source_table, dependent_varname, independent_varname);</span></div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span>&#160;<span class="stringliteral"> insert_string := MADLIB_SCHEMA.__internal_get_linregr_insert_string(</span></div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span>&#160;<span class="stringliteral"> lin_rst, out_table);</span></div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span>&#160;<span class="stringliteral"> -- Ensure Infinity and NaN are cast properly</span></div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span>&#160;<span class="stringliteral"> insert_string := REGEXP_REPLACE(insert_string, &#39;</span>Infinity<span class="stringliteral">&#39;,</span></div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span>&#160;<span class="stringliteral"> &#39;</span><span class="stringliteral">&#39;&#39;</span>Infinity<span class="stringliteral">&#39;&#39;</span>::<span class="keywordtype">double</span> precision<span class="stringliteral">&#39;, &#39;</span>gi<span class="stringliteral">&#39;);</span></div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span>&#160;<span class="stringliteral"> insert_string := REGEXP_REPLACE(insert_string, &#39;</span>NaN<span class="stringliteral">&#39;,</span></div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span>&#160;<span class="stringliteral"> &#39;</span><span class="stringliteral">&#39;&#39;</span>NaN<span class="stringliteral">&#39;&#39;</span>::<span class="keywordtype">double</span> precision<span class="stringliteral">&#39;, &#39;</span>gi<span class="stringliteral">&#39;);</span></div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>&#160;<span class="stringliteral"> IF heteroskedasticity_option THEN</span></div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>&#160;<span class="stringliteral"> -- add hsk values in the sql string and execute</span></div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span>&#160;<span class="stringliteral"> hsk_value := MADLIB_SCHEMA.__internal_get_hsk_result(</span></div>
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span>&#160;<span class="stringliteral"> source_table, dependent_varname,</span></div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>&#160;<span class="stringliteral"> independent_varname, (lin_rst).coef);</span></div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span>&#160;<span class="stringliteral"> EXECUTE</span></div>
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span>&#160;<span class="stringliteral"> insert_string || &#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160;<span class="stringliteral"> || (hsk_value).bp_stats || &#39;</span>,<span class="stringliteral">&#39;</span></div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span>&#160;<span class="stringliteral"> || (hsk_value).bp_p_value || &#39;</span>)<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span>&#160;<span class="stringliteral"> ELSE</span></div>
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span>&#160;<span class="stringliteral"> -- complete the sql string and execute</span></div>
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span>&#160;<span class="stringliteral"> EXECUTE insert_string || &#39;</span>)<span class="stringliteral">&#39;;</span></div>
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span>&#160;<span class="stringliteral"> END IF;</span></div>
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span>&#160;<span class="stringliteral">END</span></div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>&#160;<span class="stringliteral">$$ LANGUAGE plpgsql VOLATILE;</span></div>
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span>&#160;<span class="stringliteral">---------------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span>&#160;<span class="comment"> * @brief Compute linear regression coefficients and insert into an output</span></div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>&#160;<span class="comment"> * table. The function drops the table if it already exists before creating</span></div>
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span>&#160;<span class="comment"> * the table.</span></div>
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span>&#160;<span class="comment">**/</span></div>
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span>&#160;CREATE FUNCTION MADLIB_SCHEMA.linregr_train(</div>
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span>&#160; source_table VARCHAR -- name of input table</div>
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span>&#160; , out_table VARCHAR -- name of output table</div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160; , dependent_varname VARCHAR -- name of dependent variable</div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>&#160; , independent_varname VARCHAR -- name of independent variable</div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span>&#160; )</div>
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span>&#160;RETURNS VOID AS $$</div>
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span>&#160;BEGIN</div>
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span>&#160; PERFORM MADLIB_SCHEMA.__internal_linregr_train_hetero(</div>
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span>&#160; source_table, out_table, dependent_varname, independent_varname, False);</div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>&#160; -- RAISE NOTICE &#39;</div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span>&#160; -- Finished linear regression</div>
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span>&#160; -- * table : % (%, %)</div>
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span>&#160; -- Output:</div>
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span>&#160; -- * view : SELECT * FROM % ;<span class="stringliteral">&#39;, source_table, dependent_varname,</span></div>
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span>&#160;<span class="stringliteral"> -- independent_varname, out_table;</span></div>
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span>&#160;<span class="stringliteral">END;</span></div>
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span>&#160;<span class="stringliteral">$$ LANGUAGE plpgsql VOLATILE;</span></div>
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span>&#160;<span class="stringliteral">--------------------- GROUPING ---------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span>&#160;<span class="comment"> * @brief Linear regression training function with grouping support and</span></div>
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span>&#160;<span class="comment"> * option for heteroskedasticity values.</span></div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span>&#160;<span class="comment"> **/</span></div>
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span>&#160;CREATE FUNCTION MADLIB_SCHEMA.linregr_train(</div>
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span>&#160; source_table VARCHAR -- name of input table</div>
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span>&#160; , out_table VARCHAR -- name of output table</div>
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span>&#160; , dependent_varname VARCHAR -- name of dependent variable</div>
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>&#160; , independent_varname VARCHAR -- name of independent variable</div>
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>&#160; , input_group_cols VARCHAR -- names of columns to group-by</div>
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>&#160; , heteroskedasticity_option BOOLEAN -- heteroskedasticity</div>
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span>&#160; )</div>
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>&#160;RETURNS VOID AS $$</div>
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span>&#160;DECLARE</div>
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span>&#160; input_table_name VARCHAR[];</div>
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span>&#160; group_cols VARCHAR[];</div>
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span>&#160; actual_table_name VARCHAR;</div>
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span>&#160; schema_name VARCHAR;</div>
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span>&#160; table_creation_string VARCHAR;</div>
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span>&#160; group_string VARCHAR;</div>
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span>&#160; group_array_length INTEGER;</div>
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span>&#160; col_data_type VARCHAR;</div>
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span>&#160; each_group INTEGER;</div>
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span>&#160; linregr_fitting_rst VARCHAR;</div>
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span>&#160; old_msg_level TEXT;</div>
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span>&#160;BEGIN</div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span>&#160;</div>
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span>&#160; EXECUTE &#39;SELECT setting FROM pg_settings WHERE name=<span class="stringliteral">&#39;&#39;</span>client_min_messages<span class="charliteral">&#39;&#39;&#39;</span> INTO old_msg_level;</div>
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span>&#160; EXECUTE <span class="stringliteral">&#39;SET client_min_messages TO warning&#39;</span>;</div>
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span>&#160;</div>
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span>&#160; IF (source_table IS NULL OR source_table = <span class="stringliteral">&#39;&#39;</span>) THEN</div>
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span>&#160; RAISE EXCEPTION &#39;Invalid input table name given.&#39;;</div>
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span>&#160; END IF;</div>
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span>&#160; IF (out_table IS NULL OR out_table = &#39;&#39;) THEN</div>
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span>&#160; RAISE EXCEPTION &#39;Invalid output table name given.&#39;;</div>
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span>&#160; END IF;</div>
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span>&#160; IF (dependent_varname IS NULL OR dependent_varname = &#39;&#39;) THEN</div>
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span>&#160; RAISE EXCEPTION &#39;Invalid dependent variable name given.&#39;;</div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span>&#160; END IF;</div>
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span>&#160; IF (independent_varname IS NULL OR independent_varname = &#39;&#39;) THEN</div>
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span>&#160; RAISE EXCEPTION &#39;Invalid independent variable name given.&#39;;</div>
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span>&#160; END IF;</div>
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span>&#160;</div>
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span>&#160; IF (NOT MADLIB_SCHEMA.__table_exists(source_table)) THEN</div>
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span>&#160; RAISE EXCEPTION &#39;Source table name does not exist.&#39;;</div>
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span>&#160; END IF;</div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span>&#160;</div>
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span>&#160; IF (MADLIB_SCHEMA.__table_exists(out_table)) THEN</div>
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span>&#160; RAISE EXCEPTION &#39;Output table name already exists. Drop the table before calling the function.&#39;;</div>
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span>&#160; END IF;</div>
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span>&#160;</div>
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span>&#160;</div>
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span>&#160; -- initial validation</div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span>&#160; IF (input_group_cols IS NULL)</div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span>&#160; --OR array_upper(input_group_cols, 1) IS NULL</div>
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span>&#160; --OR array_upper(input_group_cols, 1) = 0)</div>
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span>&#160; THEN</div>
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span>&#160; PERFORM MADLIB_SCHEMA.__internal_linregr_train_hetero(</div>
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span>&#160; source_table, out_table,</div>
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span>&#160; dependent_varname, independent_varname,</div>
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span>&#160; heteroskedasticity_option);</div>
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span>&#160; ELSE</div>
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span>&#160; group_cols = MADLIB_SCHEMA._string_to_array(input_group_cols);</div>
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span>&#160; -- create output table</div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span>&#160; EXECUTE &#39;DROP TABLE IF EXISTS &#39; || out_table;</div>
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span>&#160; table_creation_string := &#39;CREATE TABLE &#39; || out_table || &#39;(&#39;;</div>
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span>&#160; group_array_length = array_upper(group_cols, 1);</div>
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span>&#160;</div>
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span>&#160; input_table_name = regexp_split_to_array(source_table, E&#39;\\.&#39;);</div>
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span>&#160; IF array_upper(input_table_name, 1) = 1 THEN</div>
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span>&#160; actual_table_name = input_table_name[1];</div>
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span>&#160; schema_name := current_schema();</div>
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span>&#160; ELSIF array_upper(input_table_name, 1) = 2 THEN</div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span>&#160; actual_table_name = input_table_name[2];</div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span>&#160; schema_name = input_table_name[1];</div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span>&#160; ELSE</div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span>&#160; RAISE EXCEPTION &#39;Incorrect input source table name provided&#39;;</div>
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span>&#160; END IF;</div>
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span>&#160;</div>
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span>&#160; -- Check that each grouping column exists</div>
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span>&#160; FOR each_group in 1 .. group_array_length</div>
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span>&#160; LOOP</div>
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span>&#160; if NOT MADLIB_SCHEMA.<a class="code" href="utilities_8sql__in.html#ac1f509bd94c6309b59eb4d479fb2a470" title="Check if a column exists in a table. ">check_if_col_exists</a>(source_table,</div>
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span>&#160; group_cols[each_group]) THEN</div>
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span>&#160; RAISE EXCEPTION &#39;Grouping column % does not exist&#39;,</div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span>&#160; group_cols[each_group];</div>
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span>&#160; END IF;</div>
<div class="line"><a name="l00757"></a><span class="lineno"> 757</span>&#160;</div>
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span>&#160;</div>
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span>&#160; END LOOP;</div>
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span>&#160;</div>
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span>&#160; FOR each_group in 1 .. group_array_length</div>
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span>&#160; LOOP</div>
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span>&#160; -- create a <span class="keywordtype">string</span> that makes list of</div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span>&#160; EXECUTE &#39;SELECT data_type FROM information_schema.columns</div>
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span>&#160; WHERE</div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span>&#160; table_schema = &#39;&#39;&#39; || schema_name || &#39;&#39;&#39;</div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span>&#160; AND table_name = &#39;&#39;&#39; || actual_table_name || &#39;&#39;&#39;</div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span>&#160; AND column_name= &#39;&#39;&#39; || group_cols[each_group] || &#39;&#39;&#39;&#39;</div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span>&#160; INTO col_data_type;</div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span>&#160;</div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span>&#160; table_creation_string := table_creation_string</div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span>&#160; || group_cols[each_group]</div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span>&#160; || &#39; &#39; || col_data_type || &#39;,&#39;;</div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span>&#160; END LOOP;</div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>&#160;</div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>&#160; -- finish creating the output table</div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>&#160; EXECUTE table_creation_string || &#39;</div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span>&#160; coef DOUBLE PRECISION[],</div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span>&#160; r2 DOUBLE PRECISION,</div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span>&#160; std_err DOUBLE PRECISION[],</div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>&#160; t_stats DOUBLE PRECISION[],</div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>&#160; p_values DOUBLE PRECISION[],</div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span>&#160; condition_no DOUBLE PRECISION)&#39;;</div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span>&#160; IF heteroskedasticity_option THEN</div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span>&#160; EXECUTE &#39;ALTER TABLE &#39; || out_table || &#39;</div>
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span>&#160; ADD COLUMN bp_stats DOUBLE PRECISION,</div>
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span>&#160; ADD COLUMN bp_p_value DOUBLE PRECISION&#39;;</div>
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span>&#160; END IF;</div>
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span>&#160;</div>
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span>&#160; group_string := &#39;&#39;;</div>
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span>&#160; FOR each_group in 1 .. (group_array_length-1)</div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span>&#160; LOOP</div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>&#160; group_string := group_string || group_cols[each_group] || &#39;,&#39;;</div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>&#160; END LOOP;</div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>&#160; group_string := group_string || group_cols[group_array_length];</div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span>&#160;</div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span>&#160; IF heteroskedasticity_option THEN</div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span>&#160; linregr_fitting_rst := MADLIB_SCHEMA.__unique_string();</div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span>&#160; EXECUTE &#39;</div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span>&#160; DROP TABLE IF EXISTS &#39;|| linregr_fitting_rst ||&#39;;</div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span>&#160; CREATE TEMP TABLE &#39;|| linregr_fitting_rst ||&#39; AS</div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span>&#160; SELECT</div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span>&#160; &#39;|| group_string ||&#39;,</div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span>&#160; (MADLIB_SCHEMA.<a class="code" href="linear_8sql__in.html#a71d8295a18e93619b3331cefabe6e79b" title="Compute linear regression coefficients and diagnostic statistics. ">linregr</a>(&#39;|| dependent_varname ||&#39;,&#39;|| independent_varname ||&#39;)).*</div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span>&#160; FROM &#39;|| source_table ||&#39;</div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span>&#160; GROUP BY &#39;|| group_string;</div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span>&#160;</div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span>&#160; EXECUTE &#39;</div>
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span>&#160; INSERT INTO &#39; || out_table || &#39;</div>
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span>&#160; SELECT *</div>
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span>&#160; FROM</div>
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span>&#160; &#39;|| linregr_fitting_rst ||&#39;</div>
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span>&#160; JOIN (</div>
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span>&#160; SELECT</div>
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span>&#160; &#39;|| group_string ||&#39;,</div>
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span>&#160; (MADLIB_SCHEMA.<a class="code" href="linear_8sql__in.html#a85d6d11ff2c93855061515d92d4785c2" title="Compute studentized Breuch-Pagan heteroskedasticity test for linear regression. ">heteroskedasticity_test_linregr</a>(&#39;</div>
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span>&#160; || dependent_varname || &#39;,&#39;</div>
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span>&#160; || independent_varname || &#39;, t.coef)).*</div>
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span>&#160; FROM</div>
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span>&#160; &#39;|| source_table ||&#39; AS s</div>
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span>&#160; JOIN</div>
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span>&#160; &#39;|| linregr_fitting_rst ||&#39; AS t</div>
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span>&#160; USING (&#39; || group_string || &#39;)</div>
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span>&#160; GROUP BY &#39; || group_string ||&#39;) z</div>
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span>&#160; USING (&#39;|| group_string ||&#39;)&#39;;</div>
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span>&#160;</div>
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span>&#160; EXECUTE &#39;DROP TABLE IF EXISTS &#39;|| linregr_fitting_rst;</div>
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span>&#160; ELSE</div>
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span>&#160; EXECUTE &#39;</div>
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span>&#160; INSERT INTO &#39; || out_table || &#39;</div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span>&#160; SELECT &#39; || group_string || &#39;, (result).coef, (result).r2,</div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>&#160; (result).std_err, (result).t_stats,</div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span>&#160; (result).p_values, (result).condition_no</div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span>&#160; FROM (</div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span>&#160; SELECT &#39; || group_string ||</div>
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span>&#160; &#39;, MADLIB_SCHEMA.<a class="code" href="linear_8sql__in.html#a71d8295a18e93619b3331cefabe6e79b" title="Compute linear regression coefficients and diagnostic statistics. ">linregr</a>( &#39;</div>
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span>&#160; || dependent_varname || &#39; , &#39;</div>
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span>&#160; || independent_varname || &#39; )</div>
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span>&#160; AS result</div>
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span>&#160; FROM &#39; || source_table || &#39;</div>
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span>&#160; GROUP BY &#39; || group_string ||</div>
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span>&#160; &#39;) subq&#39;;</div>
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span>&#160; END IF;</div>
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span>&#160; END IF;</div>
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span>&#160;</div>
<div class="line"><a name="l00846"></a><span class="lineno"> 846</span>&#160; EXECUTE &#39;SET client_min_messages TO &#39;|| old_msg_level;</div>
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span>&#160;END;</div>
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span>&#160;$$ LANGUAGE plpgsql VOLATILE;</div>
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span>&#160;---------------------------------------------------------------------------<span class="comment"></span></div>
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span>&#160;<span class="comment"> * @brief Linear regression training function with grouping support.</span></div>
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span>&#160;<span class="comment"> **/</span></div>
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span>&#160;CREATE FUNCTION MADLIB_SCHEMA.linregr_train(</div>
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span>&#160; source_table VARCHAR -- name of input table</div>
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span>&#160; , out_table VARCHAR -- name of output table</div>
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span>&#160; , dependent_varname VARCHAR -- name of dependent variable</div>
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span>&#160; , independent_varname VARCHAR -- name of independent variable</div>
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span>&#160; , group_cols VARCHAR -- names of columns to group-by</div>
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span>&#160; )</div>
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span>&#160;RETURNS VOID AS $$</div>
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span>&#160;BEGIN</div>
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span>&#160; PERFORM MADLIB_SCHEMA.linregr_train( source_table, out_table,</div>
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span>&#160; dependent_varname,</div>
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span>&#160; independent_varname, group_cols, FALSE);</div>
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span>&#160;END;</div>
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span>&#160;$$ LANGUAGE plpgsql VOLATILE;</div>
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span>&#160;---------------------------------------------------------------------------</div>
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span>&#160;</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_efbcf68973d247bbf15f9eecae7f24e3.html">ports</a></li><li class="navelem"><a class="el" href="dir_a4a48839224ef8488facbffa8a397967.html">postgres</a></li><li class="navelem"><a class="el" href="dir_dc596537ad427a4d866006d1a3e1fe29.html">modules</a></li><li class="navelem"><a class="el" href="dir_ac52a4b89b7b1b1591f2952b5cbd041a.html">regress</a></li><li class="navelem"><a class="el" href="linear_8sql__in.html">linear.sql_in</a></li>
<li class="footer">Generated on Wed Aug 21 2013 16:09:52 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>