122 lines
15 KiB
HTML
122 lines
15 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/core/metrics/ip_metric.hpp 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="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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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_f7ac9cdfd28b2e882eb44d163e3b98b4.html">core</a></li><li class="navelem"><a class="el" href="dir_4efb564a11712fe6ab1802c27ccee872.html">metrics</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ip_metric.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ip__metric_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef MLPACK_METHODS_FASTMKS_IP_METRIC_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define MLPACK_METHODS_FASTMKS_IP_METRIC_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="namespacemlpack_1_1metric.html"> 17</a></span> <span class="keyword">namespace </span>metric {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">template</span><<span class="keyword">typename</span> KernelType></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classmlpack_1_1metric_1_1IPMetric.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1metric_1_1IPMetric.html">IPMetric</a></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#a22701e4059168a42152e496f4bde53db">IPMetric</a>();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#a22701e4059168a42152e496f4bde53db">IPMetric</a>(KernelType& <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#ab08fac98ecccda9902b5869b62aa005e">kernel</a>);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#a6bcc0236d53f2a071191de0ab6902e65">~IPMetric</a>();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">template</span><<span class="keyword">typename</span> VecTypeA, <span class="keyword">typename</span> VecTypeB></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">typename</span> VecTypeA::elem_type <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#aeeaaa6e72c5e9c9c5f43fb66a25c2b04">Evaluate</a>(<span class="keyword">const</span> VecTypeA& a, <span class="keyword">const</span> VecTypeB& b);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classmlpack_1_1metric_1_1IPMetric.html#a71c118f0e6039164d898b5063fc23f2e"> 57</a></span>  <span class="keyword">const</span> KernelType& <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#a71c118f0e6039164d898b5063fc23f2e">Kernel</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#ab08fac98ecccda9902b5869b62aa005e">kernel</a>; }</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmlpack_1_1metric_1_1IPMetric.html#a83d7940700aa1b17486d5def5374ffef"> 59</a></span>  KernelType& <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#a83d7940700aa1b17486d5def5374ffef">Kernel</a>() { <span class="keywordflow">return</span> *<a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#ab08fac98ecccda9902b5869b62aa005e">kernel</a>; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Archive></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#a52b143cf6887bebda320cf86812de9e6">Serialize</a>(Archive& ar, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> version);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classmlpack_1_1metric_1_1IPMetric.html#ab08fac98ecccda9902b5869b62aa005e"> 67</a></span>  KernelType* <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#ab08fac98ecccda9902b5869b62aa005e">kernel</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classmlpack_1_1metric_1_1IPMetric.html#ac92225c871d2306651d7df24aa239287"> 69</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1metric_1_1IPMetric.html#ac92225c871d2306651d7df24aa239287">kernelOwner</a>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> } <span class="comment">// namespace metric</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#include "ip_metric_impl.hpp"</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_a22701e4059168a42152e496f4bde53db"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#a22701e4059168a42152e496f4bde53db">mlpack::metric::IPMetric::IPMetric</a></div><div class="ttdeci">IPMetric()</div><div class="ttdoc">Create the IPMetric without an instantiated kernel. </div></div>
|
|
<div class="ttc" id="namespacemlpack_html"><div class="ttname"><a href="namespacemlpack.html">mlpack</a></div><div class="ttdoc">Linear algebra utility functions, generally performed on matrices or vectors. </div><div class="ttdef"><b>Definition:</b> <a href="binarize_8hpp_source.html#l00018">binarize.hpp:18</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_a71c118f0e6039164d898b5063fc23f2e"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#a71c118f0e6039164d898b5063fc23f2e">mlpack::metric::IPMetric::Kernel</a></div><div class="ttdeci">const KernelType & Kernel() const </div><div class="ttdoc">Get the kernel. </div><div class="ttdef"><b>Definition:</b> <a href="ip__metric_8hpp_source.html#l00057">ip_metric.hpp:57</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_ac92225c871d2306651d7df24aa239287"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#ac92225c871d2306651d7df24aa239287">mlpack::metric::IPMetric::kernelOwner</a></div><div class="ttdeci">bool kernelOwner</div><div class="ttdoc">If true, we are responsible for deleting the kernel. </div><div class="ttdef"><b>Definition:</b> <a href="ip__metric_8hpp_source.html#l00069">ip_metric.hpp:69</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_ab08fac98ecccda9902b5869b62aa005e"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#ab08fac98ecccda9902b5869b62aa005e">mlpack::metric::IPMetric::kernel</a></div><div class="ttdeci">KernelType * kernel</div><div class="ttdoc">The kernel we are using. </div><div class="ttdef"><b>Definition:</b> <a href="ip__metric_8hpp_source.html#l00067">ip_metric.hpp:67</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html">mlpack::metric::IPMetric</a></div><div class="ttdoc">The inner product metric, IPMetric, takes a given Mercer kernel (KernelType), and when Evaluate() is ...</div><div class="ttdef"><b>Definition:</b> <a href="ip__metric_8hpp_source.html#l00032">ip_metric.hpp:32</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_a6bcc0236d53f2a071191de0ab6902e65"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#a6bcc0236d53f2a071191de0ab6902e65">mlpack::metric::IPMetric::~IPMetric</a></div><div class="ttdeci">~IPMetric()</div><div class="ttdoc">Destroy the IPMetric object. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_a83d7940700aa1b17486d5def5374ffef"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#a83d7940700aa1b17486d5def5374ffef">mlpack::metric::IPMetric::Kernel</a></div><div class="ttdeci">KernelType & Kernel()</div><div class="ttdoc">Modify the kernel. </div><div class="ttdef"><b>Definition:</b> <a href="ip__metric_8hpp_source.html#l00059">ip_metric.hpp:59</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_aeeaaa6e72c5e9c9c5f43fb66a25c2b04"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#aeeaaa6e72c5e9c9c5f43fb66a25c2b04">mlpack::metric::IPMetric::Evaluate</a></div><div class="ttdeci">VecTypeA::elem_type Evaluate(const VecTypeA &a, const VecTypeB &b)</div><div class="ttdoc">Evaluate the metric. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1metric_1_1IPMetric_html_a52b143cf6887bebda320cf86812de9e6"><div class="ttname"><a href="classmlpack_1_1metric_1_1IPMetric.html#a52b143cf6887bebda320cf86812de9e6">mlpack::metric::IPMetric::Serialize</a></div><div class="ttdeci">void Serialize(Archive &ar, const unsigned int version)</div><div class="ttdoc">Serialize the metric. </div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <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>
|