apaam/mlpack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
1c29be5ccb2e971fbe376129f6782d421a47da0c
mlpack/doc/html/classmlpack_1_1kernel_1_1TriangularKernel.html
T

456 lines
21 KiB
HTML
Raw Blame History

<!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: mlpack::kernel::TriangularKernel Class 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#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="namespacemlpack.html">mlpack</a></li><li class="navelem"><a class="el" href="namespacemlpack_1_1kernel.html">kernel</a></li><li class="navelem"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html">TriangularKernel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classmlpack_1_1kernel_1_1TriangularKernel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mlpack::kernel::TriangularKernel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The trivially simple triangular kernel, defined by.
<a href="classmlpack_1_1kernel_1_1TriangularKernel.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a71b77a810c6e82b37a621c4b64166ff6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a71b77a810c6e82b37a621c4b64166ff6">TriangularKernel</a> (const double <a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#ad05db54dd3d43d48f6be76611e99cbbe">bandwidth</a>=1.0)</td></tr>
<tr class="memdesc:a71b77a810c6e82b37a621c4b64166ff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the triangular kernel with the given bandwidth (default 1.0). <a href="#a71b77a810c6e82b37a621c4b64166ff6">More...</a><br /></td></tr>
<tr class="separator:a71b77a810c6e82b37a621c4b64166ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b2c7cb8ee064de83c0fdd0cf9e60c5c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a4b2c7cb8ee064de83c0fdd0cf9e60c5c">Bandwidth</a> () const </td></tr>
<tr class="memdesc:a4b2c7cb8ee064de83c0fdd0cf9e60c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the bandwidth of the kernel. <a href="#a4b2c7cb8ee064de83c0fdd0cf9e60c5c">More...</a><br /></td></tr>
<tr class="separator:a4b2c7cb8ee064de83c0fdd0cf9e60c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61014458600135098f2e52812ff9d8fb"><td class="memItemLeft" align="right" valign="top">double &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a61014458600135098f2e52812ff9d8fb">Bandwidth</a> ()</td></tr>
<tr class="memdesc:a61014458600135098f2e52812ff9d8fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modify the bandwidth of the kernel. <a href="#a61014458600135098f2e52812ff9d8fb">More...</a><br /></td></tr>
<tr class="separator:a61014458600135098f2e52812ff9d8fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a863d4d137fa14bc7c44a3e8d805da5d4"><td class="memTemplParams" colspan="2">template&lt;typename VecTypeA , typename VecTypeB &gt; </td></tr>
<tr class="memitem:a863d4d137fa14bc7c44a3e8d805da5d4"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a863d4d137fa14bc7c44a3e8d805da5d4">Evaluate</a> (const VecTypeA &amp;a, const VecTypeB &amp;b) const </td></tr>
<tr class="memdesc:a863d4d137fa14bc7c44a3e8d805da5d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate the triangular kernel for the two given vectors. <a href="#a863d4d137fa14bc7c44a3e8d805da5d4">More...</a><br /></td></tr>
<tr class="separator:a863d4d137fa14bc7c44a3e8d805da5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7819d40b5ceeca3a960a08ce8b48f375"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a7819d40b5ceeca3a960a08ce8b48f375">Evaluate</a> (const double distance) const </td></tr>
<tr class="memdesc:a7819d40b5ceeca3a960a08ce8b48f375"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate the triangular kernel given that the distance between the two points is known. <a href="#a7819d40b5ceeca3a960a08ce8b48f375">More...</a><br /></td></tr>
<tr class="separator:a7819d40b5ceeca3a960a08ce8b48f375"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e1f37d797b787cc6b587423d5deeb49"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a2e1f37d797b787cc6b587423d5deeb49">Gradient</a> (const double distance) const </td></tr>
<tr class="memdesc:a2e1f37d797b787cc6b587423d5deeb49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate the gradient of triangular kernel given that the distance between the two points is known. <a href="#a2e1f37d797b787cc6b587423d5deeb49">More...</a><br /></td></tr>
<tr class="separator:a2e1f37d797b787cc6b587423d5deeb49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d509322d9ed0468936d14e3512a3c5"><td class="memTemplParams" colspan="2">template&lt;typename Archive &gt; </td></tr>
<tr class="memitem:a34d509322d9ed0468936d14e3512a3c5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#a34d509322d9ed0468936d14e3512a3c5">Serialize</a> (Archive &amp;ar, const unsigned int)</td></tr>
<tr class="memdesc:a34d509322d9ed0468936d14e3512a3c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize the kernel. <a href="#a34d509322d9ed0468936d14e3512a3c5">More...</a><br /></td></tr>
<tr class="separator:a34d509322d9ed0468936d14e3512a3c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ad05db54dd3d43d48f6be76611e99cbbe"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1kernel_1_1TriangularKernel.html#ad05db54dd3d43d48f6be76611e99cbbe">bandwidth</a></td></tr>
<tr class="memdesc:ad05db54dd3d43d48f6be76611e99cbbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bandwidth of the kernel. <a href="#ad05db54dd3d43d48f6be76611e99cbbe">More...</a><br /></td></tr>
<tr class="separator:ad05db54dd3d43d48f6be76611e99cbbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The trivially simple triangular kernel, defined by. </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ K(x, y) = \max \{ 0, 1 - \frac{|| x - y ||_2}{b} \} \]" src="form_22.png"/>
</p>
<p>where <img class="formulaInl" alt="$ b $" src="form_5.png"/> is the bandwidth of the kernel. </p>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00030">30</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a71b77a810c6e82b37a621c4b64166ff6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mlpack::kernel::TriangularKernel::TriangularKernel </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>bandwidth</em> = <code>1.0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the triangular kernel with the given bandwidth (default 1.0). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bandwidth</td><td>Bandwidth of the triangular kernel. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00038">38</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4b2c7cb8ee064de83c0fdd0cf9e60c5c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double mlpack::kernel::TriangularKernel::Bandwidth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the bandwidth of the kernel. </p>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00084">84</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>References <a class="el" href="triangular__kernel_8hpp_source.html#l00097">bandwidth</a>.</p>
</div>
</div>
<a class="anchor" id="a61014458600135098f2e52812ff9d8fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double&amp; mlpack::kernel::TriangularKernel::Bandwidth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify the bandwidth of the kernel. </p>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00086">86</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>References <a class="el" href="triangular__kernel_8hpp_source.html#l00097">bandwidth</a>.</p>
</div>
</div>
<a class="anchor" id="a863d4d137fa14bc7c44a3e8d805da5d4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VecTypeA , typename VecTypeB &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double mlpack::kernel::TriangularKernel::Evaluate </td>
<td>(</td>
<td class="paramtype">const VecTypeA &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const VecTypeB &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the triangular kernel for the two given vectors. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">VecTypeA</td><td>Type of first vector. </td></tr>
<tr><td class="paramname">VecTypeB</td><td>Type of second vector. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>First vector. </td></tr>
<tr><td class="paramname">b</td><td>Second vector. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00049">49</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>References <a class="el" href="triangular__kernel_8hpp_source.html#l00097">bandwidth</a>, and <a class="el" href="classmlpack_1_1metric_1_1LMetric.html#ac55458730b8e36f51d2f2a3741b77181">mlpack::metric::LMetric&lt; TPower, TTakeRoot &gt;::Evaluate()</a>.</p>
</div>
</div>
<a class="anchor" id="a7819d40b5ceeca3a960a08ce8b48f375"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double mlpack::kernel::TriangularKernel::Evaluate </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>distance</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the triangular kernel given that the distance between the two points is known. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">distance</td><td>The distance between the two points. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00061">61</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>References <a class="el" href="triangular__kernel_8hpp_source.html#l00097">bandwidth</a>.</p>
</div>
</div>
<a class="anchor" id="a2e1f37d797b787cc6b587423d5deeb49"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double mlpack::kernel::TriangularKernel::Gradient </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>distance</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the gradient of triangular kernel given that the distance between the two points is known. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">distance</td><td>The distance between the two points. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00073">73</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>References <a class="el" href="triangular__kernel_8hpp_source.html#l00097">bandwidth</a>.</p>
</div>
</div>
<a class="anchor" id="a34d509322d9ed0468936d14e3512a3c5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mlpack::kernel::TriangularKernel::Serialize </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>ar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned&#160;</td>
<td class="paramname"><em>int</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialize the kernel. </p>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00090">90</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>References <a class="el" href="triangular__kernel_8hpp_source.html#l00097">bandwidth</a>, and <a class="el" href="serialization__shim_8hpp_source.html#l00094">mlpack::data::CreateNVP()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ad05db54dd3d43d48f6be76611e99cbbe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double mlpack::kernel::TriangularKernel::bandwidth</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The bandwidth of the kernel. </p>
<p>Definition at line <a class="el" href="triangular__kernel_8hpp_source.html#l00097">97</a> of file <a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a>.</p>
<p>Referenced by <a class="el" href="triangular__kernel_8hpp_source.html#l00084">Bandwidth()</a>, <a class="el" href="triangular__kernel_8hpp_source.html#l00049">Evaluate()</a>, <a class="el" href="triangular__kernel_8hpp_source.html#l00073">Gradient()</a>, and <a class="el" href="triangular__kernel_8hpp_source.html#l00090">Serialize()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mlpack/core/kernels/<a class="el" href="triangular__kernel_8hpp_source.html">triangular_kernel.hpp</a></li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink