blob: 7d3d94efe45f35ac35426bba22633a274a46399a [file] [log] [blame]
<!-- HTML header for doxygen 1.8.4-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="keywords" content="madlib,postgres,greenplum,machine learning,data mining,deep learning,ensemble methods,data science,market basket analysis,affinity analysis,pca,lda,regression,elastic net,huber white,proportional hazards,k-means,latent dirichlet allocation,bayes,support vector machines,svm"/>
<title>MADlib: sparse_linear_systems.sql_in File Reference</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<!-- hack in the navigation tree -->
<script type="text/javascript" src="eigen_navtree_hacks.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="madlib_extra.css" rel="stylesheet" type="text/css"/>
<!-- google analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-45382226-1', 'madlib.apache.org');
ga('send', 'pageview');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a href="http://madlib.apache.org"><img alt="Logo" src="madlib.png" height="50" style="padding-left:0.5em;" border="0"/ ></a></td>
<td style="padding-left: 0.5em;">
<div id="projectname">
<span id="projectnumber">1.21.0</span>
</div>
<div id="projectbrief">User Documentation for Apache MADlib</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('sparse__linear__systems_8sql__in.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)">
</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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">sparse_linear_systems.sql_in File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SQL functions for linear systems.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5463eaef5dc5e4040acd56a1035ecc91"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a5463eaef5dc5e4040acd56a1035ecc91">sparse_inmem_iterative_linear_system_transition</a> (float8[] state, integer row_id, integer col_id, float8 value, float8 b, integer num_eqs, integer num_vars, integer nnz, integer algorithm, integer maxiter, float8 termtoler)</td></tr>
<tr class="separator:a5463eaef5dc5e4040acd56a1035ecc91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3daa8daf05cda974b4137ce07c694e2e"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a3daa8daf05cda974b4137ce07c694e2e">sparse_inmem_iterative_linear_system_merge_states</a> (float8[] state1, float8[] state2)</td></tr>
<tr class="separator:a3daa8daf05cda974b4137ce07c694e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ff2f1afd945580fc9cb9bedba84695b"><td class="memItemLeft" align="right" valign="top">sparse_linear_solver_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a5ff2f1afd945580fc9cb9bedba84695b">sparse_inmem_iterative_linear_system_final</a> (float8[] state)</td></tr>
<tr class="separator:a5ff2f1afd945580fc9cb9bedba84695b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace39ff8e846754e3e0709bfbbbee9a60"><td class="memItemLeft" align="right" valign="top">aggregate sparse_linear_solver_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#ace39ff8e846754e3e0709bfbbbee9a60">sparse_inmem_iterative_linear_system</a> (integer row_id, integer col_id, float8 value, float8 right_hand_side, integer numEquations, integer numVars, integer nnz, integer algorithm, integer maxIter, float8 termToler)</td></tr>
<tr class="memdesc:ace39ff8e846754e3e0709bfbbbee9a60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve a system of linear equations using the inmem_iterative method. <a href="#ace39ff8e846754e3e0709bfbbbee9a60">More...</a><br /></td></tr>
<tr class="separator:ace39ff8e846754e3e0709bfbbbee9a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8175311c8e181a3ac73d9cc87814bbb0"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a8175311c8e181a3ac73d9cc87814bbb0">sparse_direct_linear_system_transition</a> (float8[] state, integer row_id, integer col_id, float8 value, float8 b, integer num_eqs, integer num_vars, integer nnz, integer algorithm)</td></tr>
<tr class="separator:a8175311c8e181a3ac73d9cc87814bbb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81014be318749e53d8c3fd58eece9600"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a81014be318749e53d8c3fd58eece9600">sparse_direct_linear_system_merge_states</a> (float8[] state1, float8[] state2)</td></tr>
<tr class="separator:a81014be318749e53d8c3fd58eece9600"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37d42899e8ec22d8642aa2c943689d19"><td class="memItemLeft" align="right" valign="top">sparse_linear_solver_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a37d42899e8ec22d8642aa2c943689d19">sparse_direct_linear_system_final</a> (float8[] state)</td></tr>
<tr class="separator:a37d42899e8ec22d8642aa2c943689d19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d22e4088dedd57a931b465a73a0357a"><td class="memItemLeft" align="right" valign="top">aggregate sparse_linear_solver_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a8d22e4088dedd57a931b465a73a0357a">sparse_direct_linear_system</a> (integer row_id, integer col_id, float8 value, float8 right_hand_side, integer numEquations, integer numVars, integer nnz, integer algorithm)</td></tr>
<tr class="memdesc:a8d22e4088dedd57a931b465a73a0357a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solve a system of linear equations using the direct method. <a href="#a8d22e4088dedd57a931b465a73a0357a">More...</a><br /></td></tr>
<tr class="separator:a8d22e4088dedd57a931b465a73a0357a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b3b7eea8b91c0a16ede3e7a9c6b17ef"><td class="memItemLeft" align="right" valign="top">varchar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a3b3b7eea8b91c0a16ede3e7a9c6b17ef">linear_solver_sparse</a> (varchar input_string)</td></tr>
<tr class="memdesc:a3b3b7eea8b91c0a16ede3e7a9c6b17ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Help function, to print out the supported families. <a href="#a3b3b7eea8b91c0a16ede3e7a9c6b17ef">More...</a><br /></td></tr>
<tr class="separator:a3b3b7eea8b91c0a16ede3e7a9c6b17ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe32393baf3e20ce6906c9307aab6bea"><td class="memItemLeft" align="right" valign="top">varchar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#afe32393baf3e20ce6906c9307aab6bea">linear_solver_sparse</a> ()</td></tr>
<tr class="separator:afe32393baf3e20ce6906c9307aab6bea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03a7296e0a44c42584d2faea62e4fdc1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a03a7296e0a44c42584d2faea62e4fdc1">linear_solver_sparse</a> (varchar lhs_table, varchar rhs_table, varchar out_table, varchar lhs_row_id, varchar lhs_col_id, varchar lhs_value, varchar rhs_row_id, varchar rhs_value, integer num_vars, varchar grouping_cols, varchar optimizer, varchar optimizer_options)</td></tr>
<tr class="memdesc:a03a7296e0a44c42584d2faea62e4fdc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper function for the various marginal linear_systemsion analyzes. <a href="#a03a7296e0a44c42584d2faea62e4fdc1">More...</a><br /></td></tr>
<tr class="separator:a03a7296e0a44c42584d2faea62e4fdc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f6259c7cf82dc93b31694e1a12231e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a3f6259c7cf82dc93b31694e1a12231e8">linear_solver_sparse</a> (varchar lhs_table, varchar rhs_table, varchar out_table, varchar lhs_row_id, varchar lhs_col_id, varchar lhs_value, varchar rhs_row_id, varchar rhs_value, integer num_vars)</td></tr>
<tr class="memdesc:a3f6259c7cf82dc93b31694e1a12231e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variables. <a href="#a3f6259c7cf82dc93b31694e1a12231e8">More...</a><br /></td></tr>
<tr class="separator:a3f6259c7cf82dc93b31694e1a12231e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01d5270cb0badbbd7a581588bfeff98f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#a01d5270cb0badbbd7a581588bfeff98f">linear_solver_sparse</a> (varchar lhs_table, varchar rhs_table, varchar out_table, varchar lhs_row_id, varchar lhs_col_id, varchar lhs_value, varchar rhs_row_id, varchar rhs_value, integer num_vars, varchar grouping_cols)</td></tr>
<tr class="memdesc:a01d5270cb0badbbd7a581588bfeff98f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variables. <a href="#a01d5270cb0badbbd7a581588bfeff98f">More...</a><br /></td></tr>
<tr class="separator:a01d5270cb0badbbd7a581588bfeff98f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc9e20ee876b43f82e5f98dc2b4c88ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sparse__linear__systems_8sql__in.html#acc9e20ee876b43f82e5f98dc2b4c88ea">linear_solver_sparse</a> (varchar lhs_table, varchar rhs_table, varchar out_table, varchar lhs_row_id, varchar lhs_col_id, varchar lhs_value, varchar rhs_row_id, varchar rhs_value, integer num_vars, varchar grouping_cols, varchar optimizer)</td></tr>
<tr class="memdesc:acc9e20ee876b43f82e5f98dc2b4c88ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variables. <a href="#acc9e20ee876b43f82e5f98dc2b4c88ea">More...</a><br /></td></tr>
<tr class="separator:acc9e20ee876b43f82e5f98dc2b4c88ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section date"><dt>Date</dt><dd>January 2011</dd></dl>
<dl class="section see"><dt>See also</dt><dd>Computes the solution of a consistent linear system </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a3b3b7eea8b91c0a16ede3e7a9c6b17ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b3b7eea8b91c0a16ede3e7a9c6b17ef">&#9670;&nbsp;</a></span>linear_solver_sparse() <span class="overload">[1/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">varchar linear_solver_sparse </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>input_string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afe32393baf3e20ce6906c9307aab6bea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe32393baf3e20ce6906c9307aab6bea">&#9670;&nbsp;</a></span>linear_solver_sparse() <span class="overload">[2/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">varchar linear_solver_sparse </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a03a7296e0a44c42584d2faea62e4fdc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03a7296e0a44c42584d2faea62e4fdc1">&#9670;&nbsp;</a></span>linear_solver_sparse() <span class="overload">[3/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linear_solver_sparse </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>out_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>grouping_cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>optimizer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>optimizer_options</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs_table</td><td>String identifying the input A matrix </td></tr>
<tr><td class="paramname">rhs_table</td><td>String identifying the input b vector </td></tr>
<tr><td class="paramname">out_table</td><td>String identifying the output table to be created </td></tr>
<tr><td class="paramname">lhs_row_id</td><td>Column name containing the LHS of the equations </td></tr>
<tr><td class="paramname">lhs_col_id</td><td>Column name containing the LHS of the equations </td></tr>
<tr><td class="paramname">lhs_value</td><td>Column name containing the LHS of the equations </td></tr>
<tr><td class="paramname">rhs_row_id</td><td>Column name containing the RHS of the equations </td></tr>
<tr><td class="paramname">rhs_value</td><td>Column name containing the RHS of the equations </td></tr>
<tr><td class="paramname">num_vars</td><td>Number of variables in the system </td></tr>
<tr><td class="paramname">grouping_cols</td><td>Columns to group the linear systems by </td></tr>
<tr><td class="paramname">optimizer</td><td>Optimizer to be used </td></tr>
<tr><td class="paramname">optimizer_options</td><td>Optimizer options used</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void</dd></dl>
<dl class="section user"><dt>Usage</dt><dd>For function summary information. Run sql&gt; select linear_solver_sparse('help'); OR sql&gt; select <a class="el" href="sparse__linear__systems_8sql__in.html#a3b3b7eea8b91c0a16ede3e7a9c6b17ef" title="Help function, to print out the supported families. ">linear_solver_sparse()</a>; OR sql&gt; select linear_solver_sparse('?'); For function usage information. Run sql&gt; select linear_solver_sparse('usage'); </dd></dl>
</div>
</div>
<a id="a3f6259c7cf82dc93b31694e1a12231e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f6259c7cf82dc93b31694e1a12231e8">&#9670;&nbsp;</a></span>linear_solver_sparse() <span class="overload">[4/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linear_solver_sparse </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>out_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_vars</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a01d5270cb0badbbd7a581588bfeff98f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01d5270cb0badbbd7a581588bfeff98f">&#9670;&nbsp;</a></span>linear_solver_sparse() <span class="overload">[5/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linear_solver_sparse </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>out_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>grouping_cols</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acc9e20ee876b43f82e5f98dc2b4c88ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc9e20ee876b43f82e5f98dc2b4c88ea">&#9670;&nbsp;</a></span>linear_solver_sparse() <span class="overload">[6/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void linear_solver_sparse </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>out_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>lhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rhs_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>grouping_cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>optimizer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8d22e4088dedd57a931b465a73a0357a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d22e4088dedd57a931b465a73a0357a">&#9670;&nbsp;</a></span>sparse_direct_linear_system()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aggregate sparse_linear_solver_result sparse_direct_linear_system </td>
<td>(</td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>right_hand_side</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>numEquations</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>numVars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>nnz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>algorithm</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">row_id</td><td>Column containing the row_id </td></tr>
<tr><td class="paramname">col_id</td><td>Column containing the col_id </td></tr>
<tr><td class="paramname">value</td><td>Value of the LHS matrix </td></tr>
<tr><td class="paramname">right_hand_side</td><td>Column containing the right hand side of the system </td></tr>
<tr><td class="paramname">numEquations</td><td>Number of equations </td></tr>
<tr><td class="paramname">numVars</td><td>Number of variables </td></tr>
<tr><td class="paramname">nnz</td><td>Number of non-zero values </td></tr>
<tr><td class="paramname">algorithm</td><td>Algorithm used for the sparse linear solver</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A composite value:<ul>
<li><code>solution FLOAT8[] </code> - Array of marginal effects</li>
<li><code>residual_norm FLOAT8</code> - Norm of the residual</li>
<li><code>iters INTEGER</code> - Iterations taken</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><ul>
<li>Get all the diagnostic statistics:<br />
<pre class="fragment">SELECT linear_system_sparse(&lt;em&gt;row_id&lt;/em&gt;,
* &lt;em&gt;left_hand_side&lt;/em&gt;,
* &lt;em&gt; right_hand_side &lt;/em&gt;,
* &lt;em&gt; numEquations &lt;/em&gt;)
* FROM &lt;em&gt;dataTable&lt;/em&gt;;
* </pre> </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a37d42899e8ec22d8642aa2c943689d19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37d42899e8ec22d8642aa2c943689d19">&#9670;&nbsp;</a></span>sparse_direct_linear_system_final()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sparse_linear_solver_result sparse_direct_linear_system_final </td>
<td>(</td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a81014be318749e53d8c3fd58eece9600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81014be318749e53d8c3fd58eece9600">&#9670;&nbsp;</a></span>sparse_direct_linear_system_merge_states()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] sparse_direct_linear_system_merge_states </td>
<td>(</td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8175311c8e181a3ac73d9cc87814bbb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8175311c8e181a3ac73d9cc87814bbb0">&#9670;&nbsp;</a></span>sparse_direct_linear_system_transition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] sparse_direct_linear_system_transition </td>
<td>(</td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_eqs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>nnz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>algorithm</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ace39ff8e846754e3e0709bfbbbee9a60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace39ff8e846754e3e0709bfbbbee9a60">&#9670;&nbsp;</a></span>sparse_inmem_iterative_linear_system()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aggregate sparse_linear_solver_result sparse_inmem_iterative_linear_system </td>
<td>(</td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>right_hand_side</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>numEquations</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>numVars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>nnz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>algorithm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>maxIter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>termToler</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">row_id</td><td>Column containing the row_id </td></tr>
<tr><td class="paramname">col_id</td><td>Column containing the col_id </td></tr>
<tr><td class="paramname">value</td><td>Value of the LHS matrix </td></tr>
<tr><td class="paramname">right_hand_side</td><td>Column containing the right hand side of the system </td></tr>
<tr><td class="paramname">numEquations</td><td>Number of equations </td></tr>
<tr><td class="paramname">numVars</td><td>Number of variables </td></tr>
<tr><td class="paramname">nnz</td><td>Number of non-zero values </td></tr>
<tr><td class="paramname">algorithm</td><td>Algorithm used for the sparse linear solver </td></tr>
<tr><td class="paramname">maxIter</td><td>Maximum number of iterations </td></tr>
<tr><td class="paramname">termToler</td><td>Termination tolerance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A composite value:<ul>
<li><code>solution FLOAT8[] </code> - Array of marginal effects</li>
<li><code>residual_norm FLOAT8</code> - Norm of the residual</li>
<li><code>iters INTEGER</code> - Iterations taken</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><ul>
<li>Get all the diagnostic statistics:<br />
<pre class="fragment">SELECT linear_system_sparse(&lt;em&gt;row_id&lt;/em&gt;,
* &lt;em&gt;left_hand_side&lt;/em&gt;,
* &lt;em&gt; right_hand_side &lt;/em&gt;,
* &lt;em&gt; numEquations &lt;/em&gt;)
* FROM &lt;em&gt;dataTable&lt;/em&gt;;
* </pre> </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a5ff2f1afd945580fc9cb9bedba84695b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ff2f1afd945580fc9cb9bedba84695b">&#9670;&nbsp;</a></span>sparse_inmem_iterative_linear_system_final()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sparse_linear_solver_result sparse_inmem_iterative_linear_system_final </td>
<td>(</td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3daa8daf05cda974b4137ce07c694e2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3daa8daf05cda974b4137ce07c694e2e">&#9670;&nbsp;</a></span>sparse_inmem_iterative_linear_system_merge_states()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] sparse_inmem_iterative_linear_system_merge_states </td>
<td>(</td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5463eaef5dc5e4040acd56a1035ecc91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5463eaef5dc5e4040acd56a1035ecc91">&#9670;&nbsp;</a></span>sparse_inmem_iterative_linear_system_transition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] sparse_inmem_iterative_linear_system_transition </td>
<td>(</td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>col_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_eqs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>nnz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>algorithm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>maxiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>termtoler</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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_7513a8b3b7336e99c30a333cfb144104.html">linear_systems</a></li><li class="navelem"><a class="el" href="sparse__linear__systems_8sql__in.html">sparse_linear_systems.sql_in</a></li>
<li class="footer">Generated on Thu Feb 23 2023 19:26:36 for MADlib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>