Files
mlpack/doc/html/cf_8hpp.html
T

189 lines
13 KiB
HTML

<!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.11"/>
<title>mlpack: src/mlpack/methods/cf/cf.hpp 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="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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra-stylesheet.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mlpack
&#160;<span id="projectnumber">master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44a936ef30fc126706c6284a2fc0c990.html">mlpack</a></li><li class="navelem"><a class="el" href="dir_3cfbf900288ec2fe8dd2c2c8482f216e.html">methods</a></li><li class="navelem"><a class="el" href="dir_51f04b16a02a56d32fcaa62b5a9b38be.html">cf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle">
<div class="title">cf.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
Include dependency graph for cf.hpp:</div>
<div class="dyncontent">
<div class="center"><img src="cf_8hpp__incl.png" border="0" usemap="#src_2mlpack_2methods_2cf_2cf_8hpp" alt=""/></div>
<map name="src_2mlpack_2methods_2cf_2cf_8hpp" id="src_2mlpack_2methods_2cf_2cf_8hpp">
<area shape="rect" id="node2" href="prereqs_8hpp.html" title="The core includes that mlpack expects; standard C++ includes and Armadillo. " alt="" coords="1752,377,1888,404"/>
<area shape="rect" id="node29" href="neighbor__search_8hpp.html" title="mlpack/methods/neighbor\l_search/neighbor_search.hpp" alt="" coords="2099,95,2291,136"/>
<area shape="rect" id="node39" href="amf_8hpp.html" title="mlpack/methods/amf\l/amf.hpp" alt="" coords="1191,184,1335,225"/>
<area shape="rect" id="node41" href="nmf__als_8hpp.html" title="mlpack/methods/amf\l/update_rules/nmf_als.hpp" alt="" coords="1850,281,2025,322"/>
<area shape="rect" id="node47" href="simple__residue__termination_8hpp.html" title="mlpack/methods/amf\l/termination_policies\l/simple_residue_termination.hpp" alt="" coords="142,273,352,329"/>
<area shape="rect" id="node19" href="serialization__shim_8hpp.html" title="mlpack/core/data/serialization\l_shim.hpp" alt="" coords="3091,452,3286,493"/>
<area shape="rect" id="node20" href="serialization__template__version_8hpp.html" title="mlpack/core/data/serialization\l_template_version.hpp" alt="" coords="1331,452,1526,493"/>
<area shape="rect" id="node22" href="arma__traits_8hpp.html" title="mlpack/core/util/arma\l_traits.hpp" alt="" coords="1747,452,1894,493"/>
<area shape="rect" id="node23" href="arma__config__check_8hpp.html" title="mlpack/core/util/arma\l_config_check.hpp" alt="" coords="1918,452,2064,493"/>
<area shape="rect" id="node24" href="log_8hpp.html" title="mlpack/core/util/log.hpp" alt="" coords="1147,459,1307,486"/>
<area shape="rect" id="node26" href="timers_8hpp.html" title="mlpack/core/util/timers.hpp" alt="" coords="402,459,580,486"/>
<area shape="rect" id="node28" href="deprecated_8hpp.html" title="mlpack/core/util/deprecated.hpp" alt="" coords="2089,459,2296,486"/>
<area shape="rect" id="node31" href="binary__space__tree_8hpp.html" title="mlpack/core/tree/binary\l_space_tree.hpp" alt="" coords="2398,184,2557,225"/>
<area shape="rect" id="node32" href="binary__space__tree_2binary__space__tree_8hpp.html" title="binary_space_tree/binary\l_space_tree.hpp" alt="" coords="2449,281,2616,322"/>
<area shape="rect" id="node33" href="rectangle__tree_8hpp.html" title="mlpack/core/tree/rectangle\l_tree.hpp" alt="" coords="2582,184,2758,225"/>
<area shape="rect" id="node34" href="neighbor__search__stat_8hpp.html" title="neighbor_search_stat.hpp" alt="" coords="1987,191,2158,218"/>
<area shape="rect" id="node35" href="nearest__neighbor__sort_8hpp.html" title="sort_policies/nearest\l_neighbor_sort.hpp" alt="" coords="2152,281,2294,322"/>
<area shape="rect" id="node36" href="neighbor__search__rules_8hpp.html" title="neighbor_search_rules.hpp" alt="" coords="1505,191,1682,218"/>
<area shape="rect" id="node38" href="methods_2neighbor__search_2typedef_8hpp.html" title="typedef.hpp" alt="" coords="2232,191,2323,218"/>
<area shape="rect" id="node40" href="nmf__mult__dist_8hpp.html" title="mlpack/methods/amf\l/update_rules/nmf_mult\l_dist.hpp" alt="" coords="596,273,754,329"/>
<area shape="rect" id="node42" href="svd__batch__learning_8hpp.html" title="mlpack/methods/amf\l/update_rules/svd_batch\l_learning.hpp" alt="" coords="778,273,942,329"/>
<area shape="rect" id="node43" href="svd__incomplete__incremental__learning_8hpp.html" title="mlpack/methods/amf\l/update_rules/svd_incomplete\l_incremental_learning.hpp" alt="" coords="376,273,571,329"/>
<area shape="rect" id="node44" href="svd__complete__incremental__learning_8hpp.html" title="mlpack/methods/amf\l/update_rules/svd_complete\l_incremental_learning.hpp" alt="" coords="966,273,1152,329"/>
<area shape="rect" id="node45" href="amf_2init__rules_2random__init_8hpp.html" title="mlpack/methods/amf\l/init_rules/random_init.hpp" alt="" coords="1176,281,1350,322"/>
<area shape="rect" id="node46" href="random__acol__init_8hpp.html" title="mlpack/methods/amf\l/init_rules/random_acol\l_init.hpp" alt="" coords="1374,273,1530,329"/>
<area shape="rect" id="node48" href="simple__tolerance__termination_8hpp.html" title="mlpack/methods/amf\l/termination_policies\l/simple_tolerance_termination.hpp" alt="" coords="1554,273,1774,329"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="cf_8hpp__dep__incl.png" border="0" usemap="#src_2mlpack_2methods_2cf_2cf_8hppdep" alt=""/></div>
<map name="src_2mlpack_2methods_2cf_2cf_8hppdep" id="src_2mlpack_2methods_2cf_2cf_8hppdep">
<area shape="rect" id="node2" href="regularized__svd_8hpp.html" title="src/mlpack/methods\l/regularized_svd/regularized\l_svd.hpp" alt="" coords="5,95,189,151"/>
</map>
</div>
</div>
<p><a href="cf_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1cf_1_1CF.html">mlpack::cf::CF</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class implements Collaborative Filtering (<a class="el" href="classmlpack_1_1cf_1_1CF.html" title="This class implements Collaborative Filtering (CF). ">CF</a>). <a href="classmlpack_1_1cf_1_1CF.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmlpack_1_1cf_1_1CF_1_1CandidateCmp.html">mlpack::cf::CF::CandidateCmp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare two candidates based on the value. <a href="structmlpack_1_1cf_1_1CF_1_1CandidateCmp.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmlpack_1_1cf_1_1FactorizerTraits.html">mlpack::cf::FactorizerTraits&lt; FactorizerType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template class for factorizer traits. <a href="structmlpack_1_1cf_1_1FactorizerTraits.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemlpack"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack.html">mlpack</a></td></tr>
<tr class="memdesc:namespacemlpack"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linear algebra utility functions, generally performed on matrices or vectors. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemlpack_1_1cf"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack_1_1cf.html">mlpack::cf</a></td></tr>
<tr class="memdesc:namespacemlpack_1_1cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collaborative filtering. <br /></td></tr>
<tr class="separator:"><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 author"><dt>Author</dt><dd>Mudit Raj Gupta </dd>
<dd>
Sumedh Ghaisas</dd></dl>
<p>Collaborative filtering.</p>
<p>Defines the CF class to perform collaborative filtering on the specified data set using alternating least squares (ALS).</p>
<p>mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see <a href="http://www.opensource.org/licenses/BSD-3-Clause">http://www.opensource.org/licenses/BSD-3-Clause</a> for more information. </p>
<p>Definition in file <a class="el" href="cf_8hpp_source.html">cf.hpp</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
<script type="text/javascript">
var x = document.getElementsByClassName("formulaDsp");
var i;
for (i = 0; i < x.length; i++)
{
x[i].width /= 4;
}
</script>
</html>