blob: 4d9b0b501a08db62b7058a2a9b95771258bc4e14 [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: lmf.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.20.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('lmf_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">lmf.sql_in File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SQL functions for low-rank matrix factorization.
<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:a187574cfe85888b29d6b1658554e7507"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a187574cfe85888b29d6b1658554e7507">lmf_igd_transition</a> (float8[] state, integer row_num, integer column_num, float8 val, float8[] previous_state, integer row_dim, integer column_dim, integer max_rank, float8 stepsize, float8 scale_factor)</td></tr>
<tr class="separator:a187574cfe85888b29d6b1658554e7507"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3bb16a76a927e1e59420d4a8e13012f"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#ae3bb16a76a927e1e59420d4a8e13012f">lmf_igd_merge</a> (float8[] state1, float8[] state2)</td></tr>
<tr class="separator:ae3bb16a76a927e1e59420d4a8e13012f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a298f46c944cd6813b0360514bf8c9ed1"><td class="memItemLeft" align="right" valign="top">float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a298f46c944cd6813b0360514bf8c9ed1">lmf_igd_final</a> (float8[] state)</td></tr>
<tr class="separator:a298f46c944cd6813b0360514bf8c9ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54d2ca2048d9a0c29d5593530b932a23"><td class="memItemLeft" align="right" valign="top">aggregate float8 []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a54d2ca2048d9a0c29d5593530b932a23">lmf_igd_step</a> (integer row_num, integer column_num, float8 val, float8[] previous_state, integer row_dim, integer column_dim, integer max_rank, float8 stepsize, float8 scale_factor)</td></tr>
<tr class="separator:a54d2ca2048d9a0c29d5593530b932a23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05860ded070a214128e0b4e64c9c989e"><td class="memItemLeft" align="right" valign="top">float8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a05860ded070a214128e0b4e64c9c989e">internal_lmf_igd_distance</a> (float8[] state1, float8[] state2)</td></tr>
<tr class="separator:a05860ded070a214128e0b4e64c9c989e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dede6aa8d024f0bb9acca9a83dfd579"><td class="memItemLeft" align="right" valign="top">lmf_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a8dede6aa8d024f0bb9acca9a83dfd579">internal_lmf_igd_result</a> (float8[] state)</td></tr>
<tr class="separator:a8dede6aa8d024f0bb9acca9a83dfd579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea3df2d68e7a289da928b8a584ac719e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#aea3df2d68e7a289da928b8a584ac719e">internal_execute_using_lmf_igd_args</a> (varchar sql, integer, integer, integer, float8, float8, integer, float8)</td></tr>
<tr class="separator:aea3df2d68e7a289da928b8a584ac719e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae221f5f5b2f670a93c00202b251857d"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#aae221f5f5b2f670a93c00202b251857d">internal_compute_lmf_igd</a> (varchar rel_args, varchar rel_state, varchar rel_source, varchar col_row, varchar col_column, varchar col_value)</td></tr>
<tr class="separator:aae221f5f5b2f670a93c00202b251857d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1acb1f0e1f7008118f21c83546a4602"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#ac1acb1f0e1f7008118f21c83546a4602">lmf_igd_run</a> (varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, varchar col_value, integer row_dim=&quot;SELECT max(col_row) FROM rel_source&quot;, integer column_dim=&quot;SELECT max(col_col) FROM rel_source&quot;, integer max_rank=20, float8 stepsize=0.01, float8 scale_factor=0.1, integer num_iterations=10, float8 tolerance=0.0001)</td></tr>
<tr class="memdesc:ac1acb1f0e1f7008118f21c83546a4602"><td class="mdescLeft">&#160;</td><td class="mdescRight">Low-rank matrix factorization of a incomplete matrix into two factors. <a href="#ac1acb1f0e1f7008118f21c83546a4602">More...</a><br /></td></tr>
<tr class="separator:ac1acb1f0e1f7008118f21c83546a4602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a917cb41e439c6786f91a27463dca0732"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a917cb41e439c6786f91a27463dca0732">lmf_igd_run</a> (varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, varchar col_value, integer row_dim, integer column_dim, integer max_rank, float8 stepsize, float8 scale_factor)</td></tr>
<tr class="separator:a917cb41e439c6786f91a27463dca0732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b18ea9dd016d109a5c001762394e788"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a9b18ea9dd016d109a5c001762394e788">lmf_igd_run</a> (varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, varchar col_value, integer row_dim, integer column_dim, integer max_rank, float8 stepsize)</td></tr>
<tr class="separator:a9b18ea9dd016d109a5c001762394e788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c5c2d04936ac341e8c054237266938b"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#a0c5c2d04936ac341e8c054237266938b">lmf_igd_run</a> (varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, varchar col_value, integer row_dim, integer column_dim, integer max_rank)</td></tr>
<tr class="separator:a0c5c2d04936ac341e8c054237266938b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaeef70cbcad01aadbad6fbce81d42fb"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lmf_8sql__in.html#acaeef70cbcad01aadbad6fbce81d42fb">lmf_igd_run</a> (varchar rel_output, regclass rel_source, varchar col_row, varchar col_column, text col_value)</td></tr>
<tr class="separator:acaeef70cbcad01aadbad6fbce81d42fb"><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>June 2012</dd></dl>
<dl class="section see"><dt>See also</dt><dd>For a brief introduction to Low-rank Matrix Factorization, see the module description <a class="el" href="group__grp__lmf.html">Low-Rank Matrix Factorization</a>. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aae221f5f5b2f670a93c00202b251857d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae221f5f5b2f670a93c00202b251857d">&#9670;&nbsp;</a></span>internal_compute_lmf_igd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer internal_compute_lmf_igd </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aea3df2d68e7a289da928b8a584ac719e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea3df2d68e7a289da928b8a584ac719e">&#9670;&nbsp;</a></span>internal_execute_using_lmf_igd_args()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void internal_execute_using_lmf_igd_args </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>sql</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a05860ded070a214128e0b4e64c9c989e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05860ded070a214128e0b4e64c9c989e">&#9670;&nbsp;</a></span>internal_lmf_igd_distance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 internal_lmf_igd_distance </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="a8dede6aa8d024f0bb9acca9a83dfd579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dede6aa8d024f0bb9acca9a83dfd579">&#9670;&nbsp;</a></span>internal_lmf_igd_result()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lmf_result internal_lmf_igd_result </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="a298f46c944cd6813b0360514bf8c9ed1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a298f46c944cd6813b0360514bf8c9ed1">&#9670;&nbsp;</a></span>lmf_igd_final()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] lmf_igd_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="ae3bb16a76a927e1e59420d4a8e13012f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3bb16a76a927e1e59420d4a8e13012f">&#9670;&nbsp;</a></span>lmf_igd_merge()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] lmf_igd_merge </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="ac1acb1f0e1f7008118f21c83546a4602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1acb1f0e1f7008118f21c83546a4602">&#9670;&nbsp;</a></span>lmf_igd_run() <span class="overload">[1/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer lmf_igd_run </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">regclass&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em> = <code>&quot;SELECT&#160;max(col_row)&#160;FROM&#160;rel_source&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em> = <code>&quot;SELECT&#160;max(col_col)&#160;FROM&#160;rel_source&quot;</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em> = <code>20</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>stepsize</em> = <code>0.01</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>scale_factor</em> = <code>0.1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>num_iterations</em> = <code>10</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>tolerance</em> = <code>0.0001</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function takes as input the table representation of a incomplete matrix in the sparse (i, j, value) format and decomposes it into the specified set of most significant features of matrices of U and V matrix. The input matrix is expected to have dimension [1:row_dim][1:column_dim], but in sparse format.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rel_output</td><td>Name of the table that the factors will be appended to </td></tr>
<tr><td class="paramname">rel_source</td><td>Name of the table/view with the source data </td></tr>
<tr><td class="paramname">col_row</td><td>Name of the column containing cell row number </td></tr>
<tr><td class="paramname">col_column</td><td>Name of the column containing cell column number </td></tr>
<tr><td class="paramname">col_value</td><td>Name of the column containing cell value </td></tr>
<tr><td class="paramname">row_dim</td><td>Maximum number of rows of input </td></tr>
<tr><td class="paramname">column_dim</td><td>Maximum number of columns of input </td></tr>
<tr><td class="paramname">max_rank</td><td>Rank of desired approximation </td></tr>
<tr><td class="paramname">stepsize</td><td>Hyper-parameter that decides how aggressive that the gradient steps are </td></tr>
<tr><td class="paramname">scale_factor</td><td>Hyper-parameter that decides scale of initial factors </td></tr>
<tr><td class="paramname">num_iterations</td><td>Maximum number if iterations to perform regardless of convergence </td></tr>
<tr><td class="paramname">tolerance</td><td>Acceptable level of error in convergence. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a917cb41e439c6786f91a27463dca0732"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a917cb41e439c6786f91a27463dca0732">&#9670;&nbsp;</a></span>lmf_igd_run() <span class="overload">[2/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer lmf_igd_run </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">regclass&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>stepsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>scale_factor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9b18ea9dd016d109a5c001762394e788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b18ea9dd016d109a5c001762394e788">&#9670;&nbsp;</a></span>lmf_igd_run() <span class="overload">[3/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer lmf_igd_run </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">regclass&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>stepsize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0c5c2d04936ac341e8c054237266938b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c5c2d04936ac341e8c054237266938b">&#9670;&nbsp;</a></span>lmf_igd_run() <span class="overload">[4/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer lmf_igd_run </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">regclass&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acaeef70cbcad01aadbad6fbce81d42fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaeef70cbcad01aadbad6fbce81d42fb">&#9670;&nbsp;</a></span>lmf_igd_run() <span class="overload">[5/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer lmf_igd_run </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>rel_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">regclass&#160;</td>
<td class="paramname"><em>rel_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>col_column</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">text&#160;</td>
<td class="paramname"><em>col_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a54d2ca2048d9a0c29d5593530b932a23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54d2ca2048d9a0c29d5593530b932a23">&#9670;&nbsp;</a></span>lmf_igd_step()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aggregate float8 [] lmf_igd_step </td>
<td>(</td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>previous_state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>stepsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>scale_factor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a187574cfe85888b29d6b1658554e7507"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a187574cfe85888b29d6b1658554e7507">&#9670;&nbsp;</a></span>lmf_igd_transition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] lmf_igd_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_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8 []&#160;</td>
<td class="paramname"><em>previous_state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>row_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>column_dim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_rank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>stepsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>scale_factor</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_93c42bb4df0f3e1302223b6dfd48c81e.html">convex</a></li><li class="navelem"><a class="el" href="lmf_8sql__in.html">lmf.sql_in</a></li>
<li class="footer">Generated on Tue Jul 19 2022 12:19:22 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>