http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/GenericModelWriter.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/GenericModelWriter.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/GenericModelWriter.html new file mode 100644 index 0000000..f3608d4 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/GenericModelWriter.html @@ -0,0 +1,378 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +GenericModelWriter (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.model.GenericModelWriter class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="GenericModelWriter (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/GenericModelReader.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/HashSumEventStream.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/GenericModelWriter.html" target="_top"><B>FRAMES</B></A> + <A HREF="GenericModelWriter.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.model</FONT> +<BR> +Class GenericModelWriter</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">opennlp.model.AbstractModelWriter</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.model.GenericModelWriter</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>GenericModelWriter</B><DT>extends <A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></DL> +</PRE> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#GenericModelWriter(opennlp.model.AbstractModel, java.io.DataOutputStream)">GenericModelWriter</A></B>(<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> model, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/DataOutputStream.html"; title="class or interface in java.io">DataOutputStream</A> dos)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#GenericModelWriter(opennlp.model.AbstractModel, java.io.File)">GenericModelWriter</A></B>(<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> model, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> file)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#close()">close</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#persist()">persist</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#writeDouble(double)">writeDouble</A></B>(double d)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#writeInt(int)">writeInt</A></B>(int i)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/GenericModelWriter.html#writeUTF(java.lang.String)">writeUTF</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> s)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="GenericModelWriter(opennlp.model.AbstractModel, java.io.File)"><!-- --></A><H3> +GenericModelWriter</H3> +<PRE> +public <B>GenericModelWriter</B>(<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> model, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html"; title="class or interface in java.io">File</A> file) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DL> +<HR> + +<A NAME="GenericModelWriter(opennlp.model.AbstractModel, java.io.DataOutputStream)"><!-- --></A><H3> +GenericModelWriter</H3> +<PRE> +public <B>GenericModelWriter</B>(<A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A> model, + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/DataOutputStream.html"; title="class or interface in java.io">DataOutputStream</A> dos)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="close()"><!-- --></A><H3> +close</H3> +<PRE> +public void <B>close</B>() + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#close()">close</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="persist()"><!-- --></A><H3> +persist</H3> +<PRE> +public void <B>persist</B>() + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#persist()">persist</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="writeDouble(double)"><!-- --></A><H3> +writeDouble</H3> +<PRE> +public void <B>writeDouble</B>(double d) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#writeDouble(double)">writeDouble</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="writeInt(int)"><!-- --></A><H3> +writeInt</H3> +<PRE> +public void <B>writeInt</B>(int i) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#writeInt(int)">writeInt</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="writeUTF(java.lang.String)"><!-- --></A><H3> +writeUTF</H3> +<PRE> +public void <B>writeUTF</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> s) + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/AbstractModelWriter.html#writeUTF(java.lang.String)">writeUTF</A></CODE> in class <CODE><A HREF="../../opennlp/model/AbstractModelWriter.html" title="class in opennlp.model">AbstractModelWriter</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/GenericModelReader.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/HashSumEventStream.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/GenericModelWriter.html" target="_top"><B>FRAMES</B></A> + <A HREF="GenericModelWriter.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/HashSumEventStream.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/HashSumEventStream.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/HashSumEventStream.html new file mode 100644 index 0000000..6e0d5b1 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/HashSumEventStream.html @@ -0,0 +1,341 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +HashSumEventStream (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.model.HashSumEventStream class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="HashSumEventStream (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/GenericModelWriter.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/HashSumEventStream.html" target="_top"><B>FRAMES</B></A> + <A HREF="HashSumEventStream.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.model</FONT> +<BR> +Class HashSumEventStream</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.model.HashSumEventStream</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>HashSumEventStream</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></DL> +</PRE> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/model/HashSumEventStream.html#HashSumEventStream(opennlp.model.EventStream)">HashSumEventStream</A></B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html"; title="class or interface in java.math">BigInteger</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/HashSumEventStream.html#calculateHashSum()">calculateHashSum</A></B>()</CODE> + +<BR> + Calculates the hash sum of the stream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/HashSumEventStream.html#hasNext()">hasNext</A></B>()</CODE> + +<BR> + Test whether there are any Events remaining in this EventStream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/Event.html" title="class in opennlp.model">Event</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/HashSumEventStream.html#next()">next</A></B>()</CODE> + +<BR> + Returns the next Event object held in this EventStream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/HashSumEventStream.html#remove()">remove</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="HashSumEventStream(opennlp.model.EventStream)"><!-- --></A><H3> +HashSumEventStream</H3> +<PRE> +public <B>HashSumEventStream</B>(<A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A> eventStream)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="hasNext()"><!-- --></A><H3> +hasNext</H3> +<PRE> +public boolean <B>hasNext</B>() + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/EventStream.html#hasNext()">EventStream</A></CODE></B></DD> +<DD>Test whether there are any Events remaining in this EventStream. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/EventStream.html#hasNext()">hasNext</A></CODE> in interface <CODE><A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true if this EventStream has more Events +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="next()"><!-- --></A><H3> +next</H3> +<PRE> +public <A HREF="../../opennlp/model/Event.html" title="class in opennlp.model">Event</A> <B>next</B>() + throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/EventStream.html#next()">EventStream</A></CODE></B></DD> +<DD>Returns the next Event object held in this EventStream. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/EventStream.html#next()">next</A></CODE> in interface <CODE><A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the Event object which is next in this EventStream +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html"; title="class or interface in java.io">IOException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="calculateHashSum()"><!-- --></A><H3> +calculateHashSum</H3> +<PRE> +public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/math/BigInteger.html"; title="class or interface in java.math">BigInteger</A> <B>calculateHashSum</B>()</PRE> +<DL> +<DD>Calculates the hash sum of the stream. The method must be + called after the stream is completely consumed. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the hash sum +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang">IllegalStateException</A></CODE> - if the stream is not consumed completely, + completely means that hasNext() returns false</DL> +</DD> +</DL> +<HR> + +<A NAME="remove()"><!-- --></A><H3> +remove</H3> +<PRE> +public void <B>remove</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/GenericModelWriter.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/HashSumEventStream.html" target="_top"><B>FRAMES</B></A> + <A HREF="HashSumEventStream.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/IndexHashTable.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/IndexHashTable.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/IndexHashTable.html new file mode 100644 index 0000000..fff4598 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/IndexHashTable.html @@ -0,0 +1,318 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +IndexHashTable (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.model.IndexHashTable class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="IndexHashTable (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/HashSumEventStream.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/ListEventStream.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/IndexHashTable.html" target="_top"><B>FRAMES</B></A> + <A HREF="IndexHashTable.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.model</FONT> +<BR> +Class IndexHashTable<T></H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.model.IndexHashTable<T></B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>IndexHashTable<T></B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></DL> +</PRE> + +<P> +The <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><CODE>IndexHashTable</CODE></A> is a hash table which maps entries + of an array to their index in the array. All entries in the array must + be unique otherwise a well-defined mapping is not possible. + <p> + The entry objects must implement <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(Object)</CODE></A> and + <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang"><CODE>Object.hashCode()</CODE></A> otherwise the behavior of this class is + undefined. + <p> + The implementation uses a hash table with open addressing and linear probing. + <p> + The table is thread safe and can concurrently accessed by multiple threads, + thread safety is achieved through immutability. Though its not strictly immutable + which means, that the table must still be safely published to other threads. +<P> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/model/IndexHashTable.html#IndexHashTable(T[], double)">IndexHashTable</A></B>(<A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A>[] mapping, + double loadfactor)</CODE> + +<BR> + Initializes the current instance.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/IndexHashTable.html#get(T)">get</A></B>(<A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A> key)</CODE> + +<BR> + Retrieves the index for the specified key.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/IndexHashTable.html#size()">size</A></B>()</CODE> + +<BR> + Retrieves the size.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A>[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/IndexHashTable.html#toArray(T[])">toArray</A></B>(<A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A>[] array)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="IndexHashTable(java.lang.Object,double)"><!-- --></A><A NAME="IndexHashTable(T[], double)"><!-- --></A><H3> +IndexHashTable</H3> +<PRE> +public <B>IndexHashTable</B>(<A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A>[] mapping, + double loadfactor)</PRE> +<DL> +<DD>Initializes the current instance. The specified array is copied into the + table and later changes to the array do not affect this table in any way. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - the values to be indexed, all values must be unique otherwise a + well-defined mapping of an entry to an index is not possible<DD><CODE>loadfactor</CODE> - the load factor, usually 0.7 +<DT><B>Throws:</B> +<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html"; title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the entries are not unique</DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(T)"><!-- --></A><H3> +get</H3> +<PRE> +public int <B>get</B>(<A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A> key)</PRE> +<DL> +<DD>Retrieves the index for the specified key. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>key</CODE> - +<DT><B>Returns:</B><DD>the index or -1 if there is no entry to the keys</DL> +</DD> +</DL> +<HR> + +<A NAME="size()"><!-- --></A><H3> +size</H3> +<PRE> +public int <B>size</B>()</PRE> +<DL> +<DD>Retrieves the size. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the number of elements in this map.</DL> +</DD> +</DL> +<HR> + +<A NAME="toArray(java.lang.Object)"><!-- --></A><A NAME="toArray(T[])"><!-- --></A><H3> +toArray</H3> +<PRE> +public <A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A>[] <B>toArray</B>(<A HREF="../../opennlp/model/IndexHashTable.html" title="type parameter in IndexHashTable">T</A>[] array)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/HashSumEventStream.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/ListEventStream.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/IndexHashTable.html" target="_top"><B>FRAMES</B></A> + <A HREF="IndexHashTable.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/ListEventStream.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/ListEventStream.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/ListEventStream.html new file mode 100644 index 0000000..bd6b801 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/ListEventStream.html @@ -0,0 +1,284 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +ListEventStream (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.model.ListEventStream class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="ListEventStream (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/ListEventStream.html" target="_top"><B>FRAMES</B></A> + <A HREF="ListEventStream.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.model</FONT> +<BR> +Class ListEventStream</H2> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">java.lang.Object</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.model.ListEventStream</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>ListEventStream</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></DL> +</PRE> + +<P> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/model/ListEventStream.html#ListEventStream(java.util.List)">ListEventStream</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html"; title="class or interface in java.util">List</A><<A HREF="../../opennlp/model/Event.html" title="class in opennlp.model">Event</A>> events)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/ListEventStream.html#hasNext()">hasNext</A></B>()</CODE> + +<BR> + Test whether there are any Events remaining in this EventStream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../opennlp/model/Event.html" title="class in opennlp.model">Event</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/ListEventStream.html#next()">next</A></B>()</CODE> + +<BR> + Returns the next Event object held in this EventStream.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ListEventStream(java.util.List)"><!-- --></A><H3> +ListEventStream</H3> +<PRE> +public <B>ListEventStream</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html"; title="class or interface in java.util">List</A><<A HREF="../../opennlp/model/Event.html" title="class in opennlp.model">Event</A>> events)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="next()"><!-- --></A><H3> +next</H3> +<PRE> +public <A HREF="../../opennlp/model/Event.html" title="class in opennlp.model">Event</A> <B>next</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/EventStream.html#next()">EventStream</A></CODE></B></DD> +<DD>Returns the next Event object held in this EventStream. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/EventStream.html#next()">next</A></CODE> in interface <CODE><A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the Event object which is next in this EventStream</DL> +</DD> +</DL> +<HR> + +<A NAME="hasNext()"><!-- --></A><H3> +hasNext</H3> +<PRE> +public boolean <B>hasNext</B>()</PRE> +<DL> +<DD><B>Description copied from interface: <CODE><A HREF="../../opennlp/model/EventStream.html#hasNext()">EventStream</A></CODE></B></DD> +<DD>Test whether there are any Events remaining in this EventStream. +<P> +<DD><DL> +<DT><B>Specified by:</B><DD><CODE><A HREF="../../opennlp/model/EventStream.html#hasNext()">hasNext</A></CODE> in interface <CODE><A HREF="../../opennlp/model/EventStream.html" title="interface in opennlp.model">EventStream</A></CODE></DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>true if this EventStream has more Events</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/IndexHashTable.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/MaxentModel.html" title="interface in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/ListEventStream.html" target="_top"><B>FRAMES</B></A> + <A HREF="ListEventStream.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML> http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/MaxentModel.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/MaxentModel.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/MaxentModel.html new file mode 100644 index 0000000..0987dd7 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/MaxentModel.html @@ -0,0 +1,415 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_22) on Wed Apr 03 10:00:59 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +MaxentModel (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.model.MaxentModel interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="MaxentModel (Apache OpenNLP Maxent 3.0.3 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/ListEventStream.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/MutableContext.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/MaxentModel.html" target="_top"><B>FRAMES</B></A> + <A HREF="MaxentModel.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.model</FONT> +<BR> +Interface MaxentModel</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../opennlp/model/AbstractModel.html" title="class in opennlp.model">AbstractModel</A>, <A HREF="../../opennlp/maxent/GISModel.html" title="class in opennlp.maxent">GISModel</A>, <A HREF="../../opennlp/perceptron/PerceptronModel.html" title="class in opennlp.perceptron">PerceptronModel</A>, <A HREF="../../opennlp/maxent/quasinewton/QNModel.html" title="class in opennlp.maxent.quasinewton">QNModel</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>MaxentModel</B></DL> +</PRE> + +<P> +Interface for maximum entropy models. +<P> + +<P> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> double[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#eval(java.lang.String[])">eval</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] context)</CODE> + +<BR> + Evaluates a context.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> double[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#eval(java.lang.String[], double[])">eval</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] context, + double[] probs)</CODE> + +<BR> + Evaluates a context.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> double[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#eval(java.lang.String[], float[])">eval</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] context, + float[] values)</CODE> + +<BR> + Evaluates a contexts with the specified context values.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#getAllOutcomes(double[])">getAllOutcomes</A></B>(double[] outcomes)</CODE> + +<BR> + Return a string matching all the outcome names with all the + probabilities produced by the <code>eval(String[] + context)</code> method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#getBestOutcome(double[])">getBestOutcome</A></B>(double[] outcomes)</CODE> + +<BR> + Simple function to return the outcome associated with the index + containing the highest probability in the double[].</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#getDataStructures()">getDataStructures</A></B>()</CODE> + +<BR> + Returns the data structures relevant to storing the model.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#getIndex(java.lang.String)">getIndex</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> outcome)</CODE> + +<BR> + Gets the index associated with the String name of the given + outcome.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#getNumOutcomes()">getNumOutcomes</A></B>()</CODE> + +<BR> + Returns the number of outcomes for this model.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../opennlp/model/MaxentModel.html#getOutcome(int)">getOutcome</A></B>(int i)</CODE> + +<BR> + Gets the String name of the outcome associated with the index + i.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="eval(java.lang.String[])"><!-- --></A><H3> +eval</H3> +<PRE> +double[] <B>eval</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] context)</PRE> +<DL> +<DD>Evaluates a context. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - A list of String names of the contextual predicates + which are to be evaluated together. +<DT><B>Returns:</B><DD>an array of the probabilities for each of the different + outcomes, all of which sum to 1.</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(java.lang.String[], double[])"><!-- --></A><H3> +eval</H3> +<PRE> +double[] <B>eval</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] context, + double[] probs)</PRE> +<DL> +<DD>Evaluates a context. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - A list of String names of the contextual predicates + which are to be evaluated together.<DD><CODE>probs</CODE> - An array which is populated with the probabilities for each of the different + outcomes, all of which sum to 1. +<DT><B>Returns:</B><DD>an array of the probabilities for each of the different outcomes, all of which sum to 1.</DL> +</DD> +</DL> +<HR> + +<A NAME="eval(java.lang.String[], float[])"><!-- --></A><H3> +eval</H3> +<PRE> +double[] <B>eval</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A>[] context, + float[] values)</PRE> +<DL> +<DD>Evaluates a contexts with the specified context values. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>context</CODE> - A list of String names of the contextual predicates + which are to be evaluated together.<DD><CODE>values</CODE> - The values associated with each context. +<DT><B>Returns:</B><DD>an array of the probabilities for each of the different outcomes, all of which sum to 1.</DL> +</DD> +</DL> +<HR> + +<A NAME="getBestOutcome(double[])"><!-- --></A><H3> +getBestOutcome</H3> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> <B>getBestOutcome</B>(double[] outcomes)</PRE> +<DL> +<DD>Simple function to return the outcome associated with the index + containing the highest probability in the double[]. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>outcomes</CODE> - A <code>double[]</code> as returned by the + <code>eval(String[] context)</code> + method. +<DT><B>Returns:</B><DD>the String name of the best outcome</DL> +</DD> +</DL> +<HR> + +<A NAME="getAllOutcomes(double[])"><!-- --></A><H3> +getAllOutcomes</H3> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> <B>getAllOutcomes</B>(double[] outcomes)</PRE> +<DL> +<DD>Return a string matching all the outcome names with all the + probabilities produced by the <code>eval(String[] + context)</code> method. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>outcomes</CODE> - A <code>double[]</code> as returned by the + <code>eval(String[] context)</code> + method. +<DT><B>Returns:</B><DD>String containing outcome names paired with the normalized + probability (contained in the <code>double[] ocs</code>) + for each one.</DL> +</DD> +</DL> +<HR> + +<A NAME="getOutcome(int)"><!-- --></A><H3> +getOutcome</H3> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> <B>getOutcome</B>(int i)</PRE> +<DL> +<DD>Gets the String name of the outcome associated with the index + i. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>i</CODE> - the index for which the name of the associated outcome is + desired. +<DT><B>Returns:</B><DD>the String name of the outcome</DL> +</DD> +</DL> +<HR> + +<A NAME="getIndex(java.lang.String)"><!-- --></A><H3> +getIndex</H3> +<PRE> +int <B>getIndex</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html"; title="class or interface in java.lang">String</A> outcome)</PRE> +<DL> +<DD>Gets the index associated with the String name of the given + outcome. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>outcome</CODE> - the String name of the outcome for which the + index is desired +<DT><B>Returns:</B><DD>the index if the given outcome label exists for this + model, -1 if it does not.</DL> +</DD> +</DL> +<HR> + +<A NAME="getDataStructures()"><!-- --></A><H3> +getDataStructures</H3> +<PRE> +<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html"; title="class or interface in java.lang">Object</A>[] <B>getDataStructures</B>()</PRE> +<DL> +<DD>Returns the data structures relevant to storing the model. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getNumOutcomes()"><!-- --></A><H3> +getNumOutcomes</H3> +<PRE> +int <B>getNumOutcomes</B>()</PRE> +<DL> +<DD>Returns the number of outcomes for this model. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>The number of outcomes.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../opennlp/model/ListEventStream.html" title="class in opennlp.model"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/model/MutableContext.html" title="class in opennlp.model"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/MaxentModel.html" target="_top"><B>FRAMES</B></A> + <A HREF="MaxentModel.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved. +</BODY> +</HTML>
