| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:10:59 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>HebbianSolver (Mahout Math 0.13.0 API)</title> |
| <meta name="date" content="2017-04-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HebbianSolver (Mahout Math 0.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HebbianSolver.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html" target="_top">Frames</a></li> |
| <li><a href="HebbianSolver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mahout.math.decomposer.hebbian</div> |
| <h2 title="Class HebbianSolver" class="title">Class HebbianSolver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mahout.math.decomposer.hebbian.HebbianSolver</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HebbianSolver</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">The Hebbian solver is an iterative, sparse, singular value decomposition solver, based on the paper |
| <a href="http://www.dcs.shef.ac.uk/~genevieve/gorrell_webb.pdf">Generalized Hebbian Algorithm for |
| Latent Semantic Analysis</a> (2005) by Genevieve Gorrell and Brandyn Webb (a.k.a. Simon Funk). |
| TODO: more description here! For now: read the inline comments, and the comments for the constructors.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#HebbianSolver-double-">HebbianSolver</a></span>(double convergenceTarget)</code> |
| <div class="block">Creates a new HebbianSolver with the default <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>HebbianUpdater</code></a> to do the updating work, and the default |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> to check for convergence in a (single) |
| background thread, with |
| maxPassesPerEigen set to Integer.MAX_VALUE.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#HebbianSolver-double-int-">HebbianSolver</a></span>(double convergenceTarget, |
| int maxPassesPerEigen)</code> |
| <div class="block"><b>This is the recommended constructor to use if you're not sure</b> |
| Creates a new HebbianSolver with the default <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>HebbianUpdater</code></a> to do the updating work, and the default |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> to check for convergence in a |
| (single) background thread.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#HebbianSolver-org.apache.mahout.math.decomposer.hebbian.EigenUpdater-org.apache.mahout.math.decomposer.SingularVectorVerifier-double-">HebbianSolver</a></span>(<a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian">EigenUpdater</a> updater, |
| <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer">SingularVectorVerifier</a> verifier, |
| double convergenceTarget)</code> |
| <div class="block">Creates a new HebbianSolver with maxPassesPerEigen = Integer.MAX_VALUE (i.e.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#HebbianSolver-org.apache.mahout.math.decomposer.hebbian.EigenUpdater-org.apache.mahout.math.decomposer.SingularVectorVerifier-double-int-">HebbianSolver</a></span>(<a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian">EigenUpdater</a> updater, |
| <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer">SingularVectorVerifier</a> verifier, |
| double convergenceTarget, |
| int maxPassesPerEigen)</code> |
| <div class="block">Creates a new HebbianSolver</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#HebbianSolver-int-">HebbianSolver</a></span>(int numPassesPerEigen)</code> |
| <div class="block">Creates a new HebbianSolver with the default <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>HebbianUpdater</code></a> to do the updating work, and the default |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> to check for convergence in a (single) |
| background thread, with |
| convergenceTarget set to 0, which means that the solver will not really care about convergence as a loop-exiting |
| criterion (but will be checking for convergence anyways, so it will be logged and singular values will be |
| saved).</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#hasNotConverged-org.apache.mahout.math.Vector-org.apache.mahout.math.Matrix-org.apache.mahout.math.decomposer.hebbian.TrainingState-">hasNotConverged</a></span>(<a href="../../../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a> currentPseudoEigen, |
| <a href="../../../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a> corpus, |
| <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/TrainingState.html" title="class in org.apache.mahout.math.decomposer.hebbian">TrainingState</a> state)</code> |
| <div class="block">Uses the <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer"><code>SingularVectorVerifier</code></a> to check for convergence</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/TrainingState.html" title="class in org.apache.mahout.math.decomposer.hebbian">TrainingState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#solve-org.apache.mahout.math.Matrix-int-">solve</a></span>(<a href="../../../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a> corpus, |
| int desiredRank)</code> |
| <div class="block">Primary singular vector solving method.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/mahout/math/decomposer/EigenStatus.html" title="class in org.apache.mahout.math.decomposer">EigenStatus</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html#verify-org.apache.mahout.math.Matrix-org.apache.mahout.math.Vector-">verify</a></span>(<a href="../../../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a> corpus, |
| <a href="../../../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a> currentPseudoEigen)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HebbianSolver-org.apache.mahout.math.decomposer.hebbian.EigenUpdater-org.apache.mahout.math.decomposer.SingularVectorVerifier-double-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HebbianSolver</h4> |
| <pre>public HebbianSolver(<a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian">EigenUpdater</a> updater, |
| <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer">SingularVectorVerifier</a> verifier, |
| double convergenceTarget, |
| int maxPassesPerEigen)</pre> |
| <div class="block">Creates a new HebbianSolver</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>updater</code> - <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian"><code>EigenUpdater</code></a> used to do the actual work of iteratively updating the current "best guess" |
| singular vector one data-point presentation at a time.</dd> |
| <dd><code>verifier</code> - <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer"><code>SingularVectorVerifier</code></a> an object which perpetually tries to check how close to |
| convergence the current singular vector is (typically is a |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> which does this |
| in the background in another thread, while the main thread continues to converge)</dd> |
| <dd><code>convergenceTarget</code> - a small "epsilon" value which tells the solver how small you want the cosine of the |
| angle between a proposed eigenvector and that same vector after being multiplied by the (square of the) input |
| corpus</dd> |
| <dd><code>maxPassesPerEigen</code> - a cutoff which tells the solver after how many times of checking for convergence (done |
| by the verifier) should the solver stop trying, even if it has not reached the convergenceTarget.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HebbianSolver-org.apache.mahout.math.decomposer.hebbian.EigenUpdater-org.apache.mahout.math.decomposer.SingularVectorVerifier-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HebbianSolver</h4> |
| <pre>public HebbianSolver(<a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian">EigenUpdater</a> updater, |
| <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer">SingularVectorVerifier</a> verifier, |
| double convergenceTarget)</pre> |
| <div class="block">Creates a new HebbianSolver with maxPassesPerEigen = Integer.MAX_VALUE (i.e. keep on iterating until |
| convergenceTarget is reached). <b>Not recommended</b> unless only looking for |
| the first few (5, maybe 10?) singular |
| vectors, as small errors which compound early on quickly put a minimum error on subsequent vectors.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>updater</code> - <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian"><code>EigenUpdater</code></a> used to do the actual work of iteratively updating the current "best guess" |
| singular vector one data-point presentation at a time.</dd> |
| <dd><code>verifier</code> - <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer"><code>SingularVectorVerifier</code></a> |
| an object which perpetually tries to check how close to |
| convergence the current singular vector is (typically is a |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> which does this |
| in the background in another thread, while the main thread continues to converge)</dd> |
| <dd><code>convergenceTarget</code> - a small "epsilon" value which tells the solver how small you want the cosine of the |
| angle between a proposed eigenvector and that same vector after being multiplied by the (square of the) input |
| corpus</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HebbianSolver-double-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HebbianSolver</h4> |
| <pre>public HebbianSolver(double convergenceTarget, |
| int maxPassesPerEigen)</pre> |
| <div class="block"><b>This is the recommended constructor to use if you're not sure</b> |
| Creates a new HebbianSolver with the default <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>HebbianUpdater</code></a> to do the updating work, and the default |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> to check for convergence in a |
| (single) background thread.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>convergenceTarget</code> - a small "epsilon" value which tells the solver how small you want the cosine of the |
| angle between a proposed eigenvector and that same vector after being multiplied by the (square of the) input |
| corpus</dd> |
| <dd><code>maxPassesPerEigen</code> - a cutoff which tells the solver after how many times of checking for convergence (done |
| by the verifier) should the solver stop trying, even if it has not reached the convergenceTarget.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HebbianSolver-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HebbianSolver</h4> |
| <pre>public HebbianSolver(double convergenceTarget)</pre> |
| <div class="block">Creates a new HebbianSolver with the default <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>HebbianUpdater</code></a> to do the updating work, and the default |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> to check for convergence in a (single) |
| background thread, with |
| maxPassesPerEigen set to Integer.MAX_VALUE. <b>Not recommended</b> unless only looking |
| for the first few (5, maybe 10?) singular |
| vectors, as small errors which compound early on quickly put a minimum error on subsequent vectors.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>convergenceTarget</code> - a small "epsilon" value which tells the solver how small you want the cosine of the |
| angle between a proposed eigenvector and that same vector after being multiplied by the (square of the) input |
| corpus</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HebbianSolver-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HebbianSolver</h4> |
| <pre>public HebbianSolver(int numPassesPerEigen)</pre> |
| <div class="block">Creates a new HebbianSolver with the default <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>HebbianUpdater</code></a> to do the updating work, and the default |
| <a href="../../../../../../org/apache/mahout/math/decomposer/AsyncEigenVerifier.html" title="class in org.apache.mahout.math.decomposer"><code>AsyncEigenVerifier</code></a> to check for convergence in a (single) |
| background thread, with |
| convergenceTarget set to 0, which means that the solver will not really care about convergence as a loop-exiting |
| criterion (but will be checking for convergence anyways, so it will be logged and singular values will be |
| saved).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numPassesPerEigen</code> - the exact number of times the verifier will check convergence status in the background |
| before the solver will move on to the next eigen-vector.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="solve-org.apache.mahout.math.Matrix-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>solve</h4> |
| <pre>public <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/TrainingState.html" title="class in org.apache.mahout.math.decomposer.hebbian">TrainingState</a> solve(<a href="../../../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a> corpus, |
| int desiredRank)</pre> |
| <div class="block">Primary singular vector solving method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>corpus</code> - input matrix to find singular vectors of. Needs not be symmetric, should probably be sparse (in |
| fact the input vectors are not mutated, and accessed only via dot-products and sums, so they should be |
| <a href="../../../../../../org/apache/mahout/math/SequentialAccessSparseVector.html" title="class in org.apache.mahout.math"><code>SequentialAccessSparseVector</code></a></dd> |
| <dd><code>desiredRank</code> - the number of singular vectors to find (in roughly decreasing order by singular value)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the final <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/TrainingState.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>TrainingState</code></a> of the solver, after desiredRank singular vectors (and approximate |
| singular values) have been found.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasNotConverged-org.apache.mahout.math.Vector-org.apache.mahout.math.Matrix-org.apache.mahout.math.decomposer.hebbian.TrainingState-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasNotConverged</h4> |
| <pre>protected boolean hasNotConverged(<a href="../../../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a> currentPseudoEigen, |
| <a href="../../../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a> corpus, |
| <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/TrainingState.html" title="class in org.apache.mahout.math.decomposer.hebbian">TrainingState</a> state)</pre> |
| <div class="block">Uses the <a href="../../../../../../org/apache/mahout/math/decomposer/SingularVectorVerifier.html" title="interface in org.apache.mahout.math.decomposer"><code>SingularVectorVerifier</code></a> to check for convergence</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>currentPseudoEigen</code> - the purported singular vector whose convergence is being checked</dd> |
| <dd><code>corpus</code> - the corpus to check against</dd> |
| <dd><code>state</code> - contains the previous eigens, various other solving state <a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/TrainingState.html" title="class in org.apache.mahout.math.decomposer.hebbian"><code>TrainingState</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if <em>either</em> we have converged, <em>or</em> maxPassesPerEigen has been exceeded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="verify-org.apache.mahout.math.Matrix-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>verify</h4> |
| <pre>protected <a href="../../../../../../org/apache/mahout/math/decomposer/EigenStatus.html" title="class in org.apache.mahout.math.decomposer">EigenStatus</a> verify(<a href="../../../../../../org/apache/mahout/math/Matrix.html" title="interface in org.apache.mahout.math">Matrix</a> corpus, |
| <a href="../../../../../../org/apache/mahout/math/Vector.html" title="interface in org.apache.mahout.math">Vector</a> currentPseudoEigen)</pre> |
| </li> |
| </ul> |
| <a name="main-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>main</h4> |
| <pre>public static void main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HebbianSolver.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/EigenUpdater.html" title="interface in org.apache.mahout.math.decomposer.hebbian"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mahout/math/decomposer/hebbian/HebbianUpdater.html" title="class in org.apache.mahout.math.decomposer.hebbian"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mahout/math/decomposer/hebbian/HebbianSolver.html" target="_top">Frames</a></li> |
| <li><a href="HebbianSolver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |