Google Git
Sign in
apache / mahout / master / . / docs / 0.13.0 / api / docs / mahout-mr / org / apache / mahout / classifier / sequencelearning / hmm / HmmModel.html
blob: d72fb2f0ed0429676df87baa7bbfab3545ed217c [file] [log] [blame]
<!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:11:36 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HmmModel (Mahout Map-Reduce 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="HmmModel (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All 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/HmmModel.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/classifier/sequencelearning/hmm/HmmEvaluator.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" target="_top">Frames</a></li>
<li><a href="HmmModel.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.classifier.sequencelearning.hmm</div>
<h2 title="Class HmmModel" class="title">Class HmmModel</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.classifier.sequencelearning.hmm.HmmModel</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">HmmModel</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>
implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre>
<div class="block">Main class defining a Hidden Markov Model</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">&nbsp;</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/classifier/sequencelearning/hmm/HmmModel.html#HmmModel-int-int-">HmmModel</a></span>(int&nbsp;nrOfHiddenStates,
int&nbsp;nrOfOutputStates)</code>
<div class="block">Construct a valid random Hidden-Markov parameter set with the given number
of hidden and output states.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#HmmModel-int-int-long-">HmmModel</a></span>(int&nbsp;nrOfHiddenStates,
int&nbsp;nrOfOutputStates,
long&nbsp;seed)</code>
<div class="block">Construct a valid random Hidden-Markov parameter set with the given number
of hidden and output states using a given seed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#HmmModel-org.apache.mahout.math.Matrix-org.apache.mahout.math.Matrix-org.apache.mahout.math.Vector-">HmmModel</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a>&nbsp;transitionMatrix,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a>&nbsp;emissionMatrix,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;initialProbabilities)</code>
<div class="block">Generates a Hidden Markov model using the specified parameters</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#assign-org.apache.mahout.classifier.sequencelearning.hmm.HmmModel-">assign</a></span>(<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a>&nbsp;model)</code>
<div class="block">Assign the content of another HMM model to this one</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#clone--">clone</a></span>()</code>
<div class="block">Get a copy of this model</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getEmissionMatrix--">getEmissionMatrix</a></span>()</code>
<div class="block">Getter function to get the output state probability matrix</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getHiddenStateID-java.lang.String-">getHiddenStateID</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>&nbsp;name)</code>
<div class="block">Lookup the ID for the given hidden state name</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getHiddenStateName-int-">getHiddenStateName</a></span>(int&nbsp;id)</code>
<div class="block">Lookup the name for the given hidden state ID</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getHiddenStateNames--">getHiddenStateNames</a></span>()</code>
<div class="block">Getter method for the hidden state Names map</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getInitialProbabilities--">getInitialProbabilities</a></span>()</code>
<div class="block">Getter function to return the vector of initial hidden state probabilities</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getNrOfHiddenStates--">getNrOfHiddenStates</a></span>()</code>
<div class="block">Getter Method for the number of hidden states</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getNrOfOutputStates--">getNrOfOutputStates</a></span>()</code>
<div class="block">Getter Method for the number of output states</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getOutputStateID-java.lang.String-">getOutputStateID</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>&nbsp;name)</code>
<div class="block">Lookup the ID for the given output state name</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getOutputStateName-int-">getOutputStateName</a></span>(int&nbsp;id)</code>
<div class="block">Lookup the name for the given output state id</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getOutputStateNames--">getOutputStateNames</a></span>()</code>
<div class="block">Getter method for the output state Names map</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#getTransitionMatrix--">getTransitionMatrix</a></span>()</code>
<div class="block">Getter function to get the hidden state transition matrix</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#registerHiddenStateNames-java.util.Map-">registerHiddenStateNames</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;stateNames)</code>
<div class="block">Register a map of hidden state Names/state IDs</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#registerHiddenStateNames-java.lang.String:A-">registerHiddenStateNames</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>[]&nbsp;stateNames)</code>
<div class="block">Register an array of hidden state Names.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#registerOutputStateNames-java.util.Map-">registerOutputStateNames</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;stateNames)</code>
<div class="block">Register a map of hidden state Names/state IDs</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html#registerOutputStateNames-java.lang.String:A-">registerOutputStateNames</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>[]&nbsp;stateNames)</code>
<div class="block">Register an array of hidden state Names.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#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="HmmModel-int-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HmmModel</h4>
<pre>public&nbsp;HmmModel(int&nbsp;nrOfHiddenStates,
int&nbsp;nrOfOutputStates,
long&nbsp;seed)</pre>
<div class="block">Construct a valid random Hidden-Markov parameter set with the given number
of hidden and output states using a given seed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nrOfHiddenStates</code> - Number of hidden states</dd>
<dd><code>nrOfOutputStates</code> - Number of output states</dd>
<dd><code>seed</code> - Seed for the random initialization, if set to 0 the current time
is used</dd>
</dl>
</li>
</ul>
<a name="HmmModel-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HmmModel</h4>
<pre>public&nbsp;HmmModel(int&nbsp;nrOfHiddenStates,
int&nbsp;nrOfOutputStates)</pre>
<div class="block">Construct a valid random Hidden-Markov parameter set with the given number
of hidden and output states.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nrOfHiddenStates</code> - Number of hidden states</dd>
<dd><code>nrOfOutputStates</code> - Number of output states</dd>
</dl>
</li>
</ul>
<a name="HmmModel-org.apache.mahout.math.Matrix-org.apache.mahout.math.Matrix-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HmmModel</h4>
<pre>public&nbsp;HmmModel(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a>&nbsp;transitionMatrix,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a>&nbsp;emissionMatrix,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;initialProbabilities)</pre>
<div class="block">Generates a Hidden Markov model using the specified parameters</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transitionMatrix</code> - transition probabilities.</dd>
<dd><code>emissionMatrix</code> - emission probabilities.</dd>
<dd><code>initialProbabilities</code> - initial start probabilities.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the given parameter set is invalid</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="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a>&nbsp;clone()</pre>
<div class="block">Get a copy of this model</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="assign-org.apache.mahout.classifier.sequencelearning.hmm.HmmModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assign</h4>
<pre>public&nbsp;void&nbsp;assign(<a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm">HmmModel</a>&nbsp;model)</pre>
<div class="block">Assign the content of another HMM model to this one</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>model</code> - The HmmModel that will be assigned to this one</dd>
</dl>
</li>
</ul>
<a name="getNrOfHiddenStates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNrOfHiddenStates</h4>
<pre>public&nbsp;int&nbsp;getNrOfHiddenStates()</pre>
<div class="block">Getter Method for the number of hidden states</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of hidden states</dd>
</dl>
</li>
</ul>
<a name="getNrOfOutputStates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNrOfOutputStates</h4>
<pre>public&nbsp;int&nbsp;getNrOfOutputStates()</pre>
<div class="block">Getter Method for the number of output states</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of output states</dd>
</dl>
</li>
</ul>
<a name="getTransitionMatrix--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransitionMatrix</h4>
<pre>public&nbsp;<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a>&nbsp;getTransitionMatrix()</pre>
<div class="block">Getter function to get the hidden state transition matrix</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns the model's transition matrix.</dd>
</dl>
</li>
</ul>
<a name="getEmissionMatrix--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmissionMatrix</h4>
<pre>public&nbsp;<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a>&nbsp;getEmissionMatrix()</pre>
<div class="block">Getter function to get the output state probability matrix</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns the models emission matrix.</dd>
</dl>
</li>
</ul>
<a name="getInitialProbabilities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialProbabilities</h4>
<pre>public&nbsp;<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;getInitialProbabilities()</pre>
<div class="block">Getter function to return the vector of initial hidden state probabilities</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns the model's init probabilities.</dd>
</dl>
</li>
</ul>
<a name="getHiddenStateNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHiddenStateNames</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;getHiddenStateNames()</pre>
<div class="block">Getter method for the hidden state Names map</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>hidden state names.</dd>
</dl>
</li>
</ul>
<a name="registerHiddenStateNames-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerHiddenStateNames</h4>
<pre>public&nbsp;void&nbsp;registerHiddenStateNames(<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>[]&nbsp;stateNames)</pre>
<div class="block">Register an array of hidden state Names. We assume that the state name at
position i has the ID i</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateNames</code> - names of hidden states.</dd>
</dl>
</li>
</ul>
<a name="registerHiddenStateNames-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerHiddenStateNames</h4>
<pre>public&nbsp;void&nbsp;registerHiddenStateNames(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;stateNames)</pre>
<div class="block">Register a map of hidden state Names/state IDs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateNames</code> - <String,Integer> Map that assigns each state name an integer ID</dd>
</dl>
</li>
</ul>
<a name="getHiddenStateName-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHiddenStateName</h4>
<pre>public&nbsp;<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>&nbsp;getHiddenStateName(int&nbsp;id)</pre>
<div class="block">Lookup the name for the given hidden state ID</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - Integer id of the hidden state</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String containing the name for the given ID, null if this ID is not
known or no hidden state names were specified</dd>
</dl>
</li>
</ul>
<a name="getHiddenStateID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHiddenStateID</h4>
<pre>public&nbsp;int&nbsp;getHiddenStateID(<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>&nbsp;name)</pre>
<div class="block">Lookup the ID for the given hidden state name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the hidden state</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int containing the ID for the given name, -1 if this name is not
known or no hidden state names were specified</dd>
</dl>
</li>
</ul>
<a name="getOutputStateNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputStateNames</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;getOutputStateNames()</pre>
<div class="block">Getter method for the output state Names map</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>names of output states.</dd>
</dl>
</li>
</ul>
<a name="registerOutputStateNames-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerOutputStateNames</h4>
<pre>public&nbsp;void&nbsp;registerOutputStateNames(<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>[]&nbsp;stateNames)</pre>
<div class="block">Register an array of hidden state Names. We assume that the state name at
position i has the ID i</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateNames</code> - state names to register.</dd>
</dl>
</li>
</ul>
<a name="registerOutputStateNames-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerOutputStateNames</h4>
<pre>public&nbsp;void&nbsp;registerOutputStateNames(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;stateNames)</pre>
<div class="block">Register a map of hidden state Names/state IDs</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateNames</code> - <String,Integer> Map that assigns each state name an integer ID</dd>
</dl>
</li>
</ul>
<a name="getOutputStateName-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputStateName</h4>
<pre>public&nbsp;<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>&nbsp;getOutputStateName(int&nbsp;id)</pre>
<div class="block">Lookup the name for the given output state id</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - Integer id of the output state</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String containing the name for the given id, null if this id is not
known or no output state names were specified</dd>
</dl>
</li>
</ul>
<a name="getOutputStateID-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOutputStateID</h4>
<pre>public&nbsp;int&nbsp;getOutputStateID(<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>&nbsp;name)</pre>
<div class="block">Lookup the ID for the given output state name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the output state</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int containing the ID for the given name, -1 if this name is not
known or no output state names were specified</dd>
</dl>
</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/HmmModel.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/classifier/sequencelearning/hmm/HmmEvaluator.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/mahout/classifier/sequencelearning/hmm/HmmTrainer.html" title="class in org.apache.mahout.classifier.sequencelearning.hmm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mahout/classifier/sequencelearning/hmm/HmmModel.html" target="_top">Frames</a></li>
<li><a href="HmmModel.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>