http://git-wip-us.apache.org/repos/asf/opennlp-site/blob/267bd24c/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/package-use.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/package-use.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/package-use.html new file mode 100644 index 0000000..5d80435 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/model/package-use.html @@ -0,0 +1,560 @@ +<!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:57 GMT-03:00 2013 --> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +Uses of Package opennlp.model (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="Uses of Package opennlp.model (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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</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"> + PREV + NEXT</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/package-use.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-use.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> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<CENTER> +<H2> +<B>Uses of Package<br>opennlp.model</B></H2> +</CENTER> + +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Packages that use <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#opennlp.maxent"><B>opennlp.maxent</B></A></TD> +<TD>Provides main functionality of the maxent package including data structures and +algorithms for parameter estimation. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#opennlp.maxent.io"><B>opennlp.maxent.io</B></A></TD> +<TD>Provides the I/O functionality of the maxent package including reading +and writting models in several formats. </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#opennlp.maxent.quasinewton"><B>opennlp.maxent.quasinewton</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#opennlp.model"><B>opennlp.model</B></A></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><A HREF="#opennlp.perceptron"><B>opennlp.perceptron</B></A></TD> +<TD> </TD> +</TR> +</TABLE> + +<P> +<A NAME="opennlp.maxent"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A> used by <A HREF="../../opennlp/maxent/package-summary.html">opennlp.maxent</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractEventStream.html#opennlp.maxent"><B>AbstractEventStream</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModel.html#opennlp.maxent"><B>AbstractModel</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Context.html#opennlp.maxent"><B>Context</B></A></B> + +<BR> + Class which associates a real valued parameter or expected value with a particular contextual + predicate or feature.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataIndexer.html#opennlp.maxent"><B>DataIndexer</B></A></B> + +<BR> + Object which compresses events in memory and performs feature selection.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EvalParameters.html#opennlp.maxent"><B>EvalParameters</B></A></B> + +<BR> + This class encapsulates the varibales used in producing probabilities from a model + and facilitaes passing these variables to the eval method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Event.html#opennlp.maxent"><B>Event</B></A></B> + +<BR> + The context of a decision point during training.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EventCollector.html#opennlp.maxent"><B>EventCollector</B></A></B> + +<BR> + An interface for objects which read events during training.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EventStream.html#opennlp.maxent"><B>EventStream</B></A></B> + +<BR> + A object which can deliver a stream of training events for the GIS procedure + (or others such as IIS if and when they are implemented).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/MaxentModel.html#opennlp.maxent"><B>MaxentModel</B></A></B> + +<BR> + Interface for maximum entropy models.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Prior.html#opennlp.maxent"><B>Prior</B></A></B> + +<BR> + This interface allows one to implement a prior distribution for use in + maximum entropy model training.</TD> +</TR> +</TABLE> + +<P> +<A NAME="opennlp.maxent.io"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A> used by <A HREF="../../opennlp/maxent/io/package-summary.html">opennlp.maxent.io</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModel.html#opennlp.maxent.io"><B>AbstractModel</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModelReader.html#opennlp.maxent.io"><B>AbstractModelReader</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModelWriter.html#opennlp.maxent.io"><B>AbstractModelWriter</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/ComparablePredicate.html#opennlp.maxent.io"><B>ComparablePredicate</B></A></B> + +<BR> + A maxent predicate representation which we can use to sort based on the + outcomes.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Context.html#opennlp.maxent.io"><B>Context</B></A></B> + +<BR> + Class which associates a real valued parameter or expected value with a particular contextual + predicate or feature.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataReader.html#opennlp.maxent.io"><B>DataReader</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/IndexHashTable.html#opennlp.maxent.io"><B>IndexHashTable</B></A></B> + +<BR> + 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.</TD> +</TR> +</TABLE> + +<P> +<A NAME="opennlp.maxent.quasinewton"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A> used by <A HREF="../../opennlp/maxent/quasinewton/package-summary.html">opennlp.maxent.quasinewton</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModel.html#opennlp.maxent.quasinewton"><B>AbstractModel</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Context.html#opennlp.maxent.quasinewton"><B>Context</B></A></B> + +<BR> + Class which associates a real valued parameter or expected value with a particular contextual + predicate or feature.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataIndexer.html#opennlp.maxent.quasinewton"><B>DataIndexer</B></A></B> + +<BR> + Object which compresses events in memory and performs feature selection.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/MaxentModel.html#opennlp.maxent.quasinewton"><B>MaxentModel</B></A></B> + +<BR> + Interface for maximum entropy models.</TD> +</TR> +</TABLE> + +<P> +<A NAME="opennlp.model"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A> used by <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractDataIndexer.html#opennlp.model"><B>AbstractDataIndexer</B></A></B> + +<BR> + Abstract class for collecting event and context counts used in training.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractEventStream.html#opennlp.model"><B>AbstractEventStream</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModel.html#opennlp.model"><B>AbstractModel</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModel.ModelType.html#opennlp.model"><B>AbstractModel.ModelType</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModelReader.html#opennlp.model"><B>AbstractModelReader</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModelWriter.html#opennlp.model"><B>AbstractModelWriter</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/ComparableEvent.html#opennlp.model"><B>ComparableEvent</B></A></B> + +<BR> + A maxent event representation which we can use to sort based on the + predicates indexes contained in the events.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/ComparablePredicate.html#opennlp.model"><B>ComparablePredicate</B></A></B> + +<BR> + A maxent predicate representation which we can use to sort based on the + outcomes.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Context.html#opennlp.model"><B>Context</B></A></B> + +<BR> + Class which associates a real valued parameter or expected value with a particular contextual + predicate or feature.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataIndexer.html#opennlp.model"><B>DataIndexer</B></A></B> + +<BR> + Object which compresses events in memory and performs feature selection.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataReader.html#opennlp.model"><B>DataReader</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EvalParameters.html#opennlp.model"><B>EvalParameters</B></A></B> + +<BR> + This class encapsulates the varibales used in producing probabilities from a model + and facilitaes passing these variables to the eval method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Event.html#opennlp.model"><B>Event</B></A></B> + +<BR> + The context of a decision point during training.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EventCollector.html#opennlp.model"><B>EventCollector</B></A></B> + +<BR> + An interface for objects which read events during training.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EventStream.html#opennlp.model"><B>EventStream</B></A></B> + +<BR> + A object which can deliver a stream of training events for the GIS procedure + (or others such as IIS if and when they are implemented).</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/FileEventStream.html#opennlp.model"><B>FileEventStream</B></A></B> + +<BR> + Class for using a file of events as an event stream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/IndexHashTable.html#opennlp.model"><B>IndexHashTable</B></A></B> + +<BR> + 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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/MaxentModel.html#opennlp.model"><B>MaxentModel</B></A></B> + +<BR> + Interface for maximum entropy models.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/OnePassDataIndexer.html#opennlp.model"><B>OnePassDataIndexer</B></A></B> + +<BR> + An indexer for maxent model data which handles cutoffs for uncommon + contextual predicates and provides a unique integer index for each of the + predicates.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Prior.html#opennlp.model"><B>Prior</B></A></B> + +<BR> + This interface allows one to implement a prior distribution for use in + maximum entropy model training.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Sequence.html#opennlp.model"><B>Sequence</B></A></B> + +<BR> + Class which models a sequence.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/SequenceStream.html#opennlp.model"><B>SequenceStream</B></A></B> + +<BR> + Interface for streams of sequences used to train sequence models.</TD> +</TR> +</TABLE> + +<P> +<A NAME="opennlp.perceptron"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +Classes in <A HREF="../../opennlp/model/package-summary.html">opennlp.model</A> used by <A HREF="../../opennlp/perceptron/package-summary.html">opennlp.perceptron</A></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModel.html#opennlp.perceptron"><B>AbstractModel</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModelReader.html#opennlp.perceptron"><B>AbstractModelReader</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/AbstractModelWriter.html#opennlp.perceptron"><B>AbstractModelWriter</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/ComparablePredicate.html#opennlp.perceptron"><B>ComparablePredicate</B></A></B> + +<BR> + A maxent predicate representation which we can use to sort based on the + outcomes.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/Context.html#opennlp.perceptron"><B>Context</B></A></B> + +<BR> + Class which associates a real valued parameter or expected value with a particular contextual + predicate or feature.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataIndexer.html#opennlp.perceptron"><B>DataIndexer</B></A></B> + +<BR> + Object which compresses events in memory and performs feature selection.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/DataReader.html#opennlp.perceptron"><B>DataReader</B></A></B> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/EvalParameters.html#opennlp.perceptron"><B>EvalParameters</B></A></B> + +<BR> + This class encapsulates the varibales used in producing probabilities from a model + and facilitaes passing these variables to the eval method.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/IndexHashTable.html#opennlp.perceptron"><B>IndexHashTable</B></A></B> + +<BR> + 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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/MaxentModel.html#opennlp.perceptron"><B>MaxentModel</B></A></B> + +<BR> + Interface for maximum entropy models.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><B><A HREF="../../opennlp/model/class-use/SequenceStream.html#opennlp.perceptron"><B>SequenceStream</B></A></B> + +<BR> + Interface for streams of sequences used to train sequence models.</TD> +</TR> +</TABLE> + +<P> +<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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</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"> + PREV + NEXT</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/model/package-use.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-use.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> +</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/perceptron/BinaryPerceptronModelReader.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/BinaryPerceptronModelReader.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/BinaryPerceptronModelReader.html new file mode 100644 index 0000000..ddb526e --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/BinaryPerceptronModelReader.html @@ -0,0 +1,269 @@ +<!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> +BinaryPerceptronModelReader (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.perceptron.BinaryPerceptronModelReader class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="BinaryPerceptronModelReader (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"> + PREV CLASS + <A HREF="../../opennlp/perceptron/BinaryPerceptronModelWriter.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/BinaryPerceptronModelReader.html" target="_top"><B>FRAMES</B></A> + <A HREF="BinaryPerceptronModelReader.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="#methods_inherited_from_class_opennlp.perceptron.PerceptronModelReader">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +opennlp.perceptron</FONT> +<BR> +Class BinaryPerceptronModelReader</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/AbstractModelReader.html" title="class in opennlp.model">opennlp.model.AbstractModelReader</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../opennlp/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron">opennlp.perceptron.PerceptronModelReader</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.perceptron.BinaryPerceptronModelReader</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>BinaryPerceptronModelReader</B><DT>extends <A HREF="../../opennlp/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron">PerceptronModelReader</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/perceptron/BinaryPerceptronModelReader.html#BinaryPerceptronModelReader(java.io.DataInputStream)">BinaryPerceptronModelReader</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/DataInputStream.html"; title="class or interface in java.io">DataInputStream</A> dis)</CODE> + +<BR> + Constructor which directly instantiates the DataInputStream containing + the model contents.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/perceptron/BinaryPerceptronModelReader.html#BinaryPerceptronModelReader(java.io.File)">BinaryPerceptronModelReader</A></B>(<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> f)</CODE> + +<BR> + Constructor which takes a File and creates a reader for it.</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> +</TABLE> + <A NAME="methods_inherited_from_class_opennlp.perceptron.PerceptronModelReader"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class opennlp.perceptron.<A HREF="../../opennlp/perceptron/PerceptronModelReader.html" title="class in opennlp.perceptron">PerceptronModelReader</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/perceptron/PerceptronModelReader.html#checkModelType()">checkModelType</A>, <A HREF="../../opennlp/perceptron/PerceptronModelReader.html#constructModel()">constructModel</A></CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_opennlp.model.AbstractModelReader"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class opennlp.model.<A HREF="../../opennlp/model/AbstractModelReader.html" title="class in opennlp.model">AbstractModelReader</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/model/AbstractModelReader.html#getModel()">getModel</A>, <A HREF="../../opennlp/model/AbstractModelReader.html#readDouble()">readDouble</A>, <A HREF="../../opennlp/model/AbstractModelReader.html#readInt()">readInt</A>, <A HREF="../../opennlp/model/AbstractModelReader.html#readUTF()">readUTF</A></CODE></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="BinaryPerceptronModelReader(java.io.DataInputStream)"><!-- --></A><H3> +BinaryPerceptronModelReader</H3> +<PRE> +public <B>BinaryPerceptronModelReader</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/DataInputStream.html"; title="class or interface in java.io">DataInputStream</A> dis)</PRE> +<DL> +<DD>Constructor which directly instantiates the DataInputStream containing + the model contents. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>dis</CODE> - The DataInputStream containing the model information.</DL> +</DL> +<HR> + +<A NAME="BinaryPerceptronModelReader(java.io.File)"><!-- --></A><H3> +BinaryPerceptronModelReader</H3> +<PRE> +public <B>BinaryPerceptronModelReader</B>(<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> f) + 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>Constructor which takes a File and creates a reader for it. Detects + whether the file is gzipped or not based on whether the suffix contains + ".gz" +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>f</CODE> - The File in which the model is stored. +<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> +<!-- ========= 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"> + PREV CLASS + <A HREF="../../opennlp/perceptron/BinaryPerceptronModelWriter.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/BinaryPerceptronModelReader.html" target="_top"><B>FRAMES</B></A> + <A HREF="BinaryPerceptronModelReader.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="#methods_inherited_from_class_opennlp.perceptron.PerceptronModelReader">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | METHOD</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/perceptron/BinaryPerceptronModelWriter.html ---------------------------------------------------------------------- diff --git a/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/BinaryPerceptronModelWriter.html b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/BinaryPerceptronModelWriter.html new file mode 100644 index 0000000..13fc489 --- /dev/null +++ b/opennlp-site/docs/1.5.3/apidocs/opennlp-maxent/opennlp/perceptron/BinaryPerceptronModelWriter.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> +BinaryPerceptronModelWriter (Apache OpenNLP Maxent 3.0.3 API) +</TITLE> + +<META NAME="keywords" CONTENT="opennlp.perceptron.BinaryPerceptronModelWriter class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="BinaryPerceptronModelWriter (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/perceptron/BinaryPerceptronModelReader.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronModel.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/BinaryPerceptronModelWriter.html" target="_top"><B>FRAMES</B></A> + <A HREF="BinaryPerceptronModelWriter.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.perceptron</FONT> +<BR> +Class BinaryPerceptronModelWriter</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 "><A HREF="../../opennlp/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron">opennlp.perceptron.PerceptronModelWriter</A> + <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>opennlp.perceptron.BinaryPerceptronModelWriter</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>BinaryPerceptronModelWriter</B><DT>extends <A HREF="../../opennlp/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron">PerceptronModelWriter</A></DL> +</PRE> + +<P> +Model writer that saves models in binary format. +<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/perceptron/BinaryPerceptronModelWriter.html#BinaryPerceptronModelWriter(opennlp.model.AbstractModel, java.io.DataOutputStream)">BinaryPerceptronModelWriter</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> + Constructor which takes a GISModel and a DataOutputStream and prepares + itself to write the model to that stream.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../opennlp/perceptron/BinaryPerceptronModelWriter.html#BinaryPerceptronModelWriter(opennlp.model.AbstractModel, java.io.File)">BinaryPerceptronModelWriter</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> f)</CODE> + +<BR> + Constructor which takes a GISModel and a File and prepares itself to + write the model to that file.</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/perceptron/BinaryPerceptronModelWriter.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/perceptron/BinaryPerceptronModelWriter.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/perceptron/BinaryPerceptronModelWriter.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/perceptron/BinaryPerceptronModelWriter.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_opennlp.perceptron.PerceptronModelWriter"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class opennlp.perceptron.<A HREF="../../opennlp/perceptron/PerceptronModelWriter.html" title="class in opennlp.perceptron">PerceptronModelWriter</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../opennlp/perceptron/PerceptronModelWriter.html#persist()">persist</A></CODE></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="BinaryPerceptronModelWriter(opennlp.model.AbstractModel, java.io.File)"><!-- --></A><H3> +BinaryPerceptronModelWriter</H3> +<PRE> +public <B>BinaryPerceptronModelWriter</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> f) + 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>Constructor which takes a GISModel and a File and prepares itself to + write the model to that file. Detects whether the file is gzipped or not + based on whether the suffix contains ".gz". +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>model</CODE> - The GISModel which is to be persisted.<DD><CODE>f</CODE> - The File in which the model is to be persisted. +<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="BinaryPerceptronModelWriter(opennlp.model.AbstractModel, java.io.DataOutputStream)"><!-- --></A><H3> +BinaryPerceptronModelWriter</H3> +<PRE> +public <B>BinaryPerceptronModelWriter</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> +<DD>Constructor which takes a GISModel and a DataOutputStream and prepares + itself to write the model to that stream. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>model</CODE> - The GISModel which is to be persisted.<DD><CODE>dos</CODE> - The stream which will be used to persist the model.</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="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> +<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="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="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> +<!-- ========= 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/perceptron/BinaryPerceptronModelReader.html" title="class in opennlp.perceptron"><B>PREV CLASS</B></A> + <A HREF="../../opennlp/perceptron/PerceptronModel.html" title="class in opennlp.perceptron"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../index.html?opennlp/perceptron/BinaryPerceptronModelWriter.html" target="_top"><B>FRAMES</B></A> + <A HREF="BinaryPerceptronModelWriter.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>
