/aima-all/release/javadoc/aima-core/aima/core/learning/learners/DecisionListLearner.html
HTML | 379 lines | 313 code | 42 blank | 24 comment | 0 complexity | 2f0c97a2c620bac44561365cab9537bd MD5 | raw file
Possible License(s): GPL-3.0, Apache-2.0
- <!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.6.0_20) on Sun Jan 08 15:29:05 PST 2012 -->
- <TITLE>
- DecisionListLearner
- </TITLE>
-
- <META NAME="date" CONTENT="2012-01-08">
-
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
-
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="DecisionListLearner";
- }
- }
- </SCRIPT>
- <NOSCRIPT>
- </NOSCRIPT>
-
- </HEAD>
-
- <BODY BGCOLOR="white" onload="windowTitle();">
- <HR>
-
-
- <!-- ========= 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="../../../../aima/core/learning/learners/CurrentBestLearner.html" title="class in aima.core.learning.learners"><B>PREV CLASS</B></A>
- <A HREF="../../../../aima/core/learning/learners/DecisionTreeLearner.html" title="class in aima.core.learning.learners"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?aima/core/learning/learners/DecisionListLearner.html" target="_top"><B>FRAMES</B></A>
- <A HREF="DecisionListLearner.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <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">
- aima.core.learning.learners</FONT>
- <BR>
- Class DecisionListLearner</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>aima.core.learning.learners.DecisionListLearner</B>
- </PRE>
- <DL>
- <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../aima/core/learning/framework/Learner.html" title="interface in aima.core.learning.framework">Learner</A></DD>
- </DL>
- <HR>
- <DL>
- <DT><PRE>public class <B>DecisionListLearner</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../aima/core/learning/framework/Learner.html" title="interface in aima.core.learning.framework">Learner</A></DL>
- </PRE>
-
- <P>
- <DL>
- <DT><B>Author:</B></DT>
- <DD>Ravi Mohan, Mike Stampone</DD>
- </DL>
- <HR>
-
- <P>
- <!-- =========== FIELD SUMMARY =========== -->
-
- <A NAME="field_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>Field Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../aima/core/learning/learners/DecisionListLearner.html#FAILURE">FAILURE</A></B></CODE>
-
- <BR>
- </TD>
- </TR>
- </TABLE>
-
- <!-- ======== 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="../../../../aima/core/learning/learners/DecisionListLearner.html#DecisionListLearner(java.lang.String, java.lang.String, aima.core.learning.inductive.DLTestFactory)">DecisionListLearner</A></B>(java.lang.String positive,
- java.lang.String negative,
- <A HREF="../../../../aima/core/learning/inductive/DLTestFactory.html" title="class in aima.core.learning.inductive">DLTestFactory</A> testFactory)</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="../../../../aima/core/learning/inductive/DecisionList.html" title="class in aima.core.learning.inductive">DecisionList</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../aima/core/learning/learners/DecisionListLearner.html#getDecisionList()">getDecisionList</A></B>()</CODE>
-
- <BR>
- Returns the decision list of this decision list learner</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../aima/core/learning/learners/DecisionListLearner.html#predict(aima.core.learning.framework.Example)">predict</A></B>(<A HREF="../../../../aima/core/learning/framework/Example.html" title="class in aima.core.learning.framework">Example</A> e)</CODE>
-
- <BR>
- Returns the outcome predicted for the specified example</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="../../../../aima/core/learning/learners/DecisionListLearner.html#test(aima.core.learning.framework.DataSet)">test</A></B>(<A HREF="../../../../aima/core/learning/framework/DataSet.html" title="class in aima.core.learning.framework">DataSet</A> ds)</CODE>
-
- <BR>
- Returns the accuracy of the hypothesis on the specified set of examples</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="../../../../aima/core/learning/learners/DecisionListLearner.html#train(aima.core.learning.framework.DataSet)">train</A></B>(<A HREF="../../../../aima/core/learning/framework/DataSet.html" title="class in aima.core.learning.framework">DataSet</A> ds)</CODE>
-
- <BR>
- Induces the decision list from the specified set of examples</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.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
-
- <!-- ============ FIELD DETAIL =========== -->
-
- <A NAME="field_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>Field Detail</B></FONT></TH>
- </TR>
- </TABLE>
-
- <A NAME="FAILURE"><!-- --></A><H3>
- FAILURE</H3>
- <PRE>
- public static final java.lang.String <B>FAILURE</B></PRE>
- <DL>
- <DL>
- <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#aima.core.learning.learners.DecisionListLearner.FAILURE">Constant Field Values</A></DL>
- </DL>
-
- <!-- ========= 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="DecisionListLearner(java.lang.String, java.lang.String, aima.core.learning.inductive.DLTestFactory)"><!-- --></A><H3>
- DecisionListLearner</H3>
- <PRE>
- public <B>DecisionListLearner</B>(java.lang.String positive,
- java.lang.String negative,
- <A HREF="../../../../aima/core/learning/inductive/DLTestFactory.html" title="class in aima.core.learning.inductive">DLTestFactory</A> testFactory)</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="train(aima.core.learning.framework.DataSet)"><!-- --></A><H3>
- train</H3>
- <PRE>
- public void <B>train</B>(<A HREF="../../../../aima/core/learning/framework/DataSet.html" title="class in aima.core.learning.framework">DataSet</A> ds)</PRE>
- <DL>
- <DD>Induces the decision list from the specified set of examples
- <P>
- <DD><DL>
- <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../aima/core/learning/framework/Learner.html#train(aima.core.learning.framework.DataSet)">train</A></CODE> in interface <CODE><A HREF="../../../../aima/core/learning/framework/Learner.html" title="interface in aima.core.learning.framework">Learner</A></CODE></DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>ds</CODE> - a set of examples for constructing the decision list</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="predict(aima.core.learning.framework.Example)"><!-- --></A><H3>
- predict</H3>
- <PRE>
- public java.lang.String <B>predict</B>(<A HREF="../../../../aima/core/learning/framework/Example.html" title="class in aima.core.learning.framework">Example</A> e)</PRE>
- <DL>
- <DD><B>Description copied from interface: <CODE><A HREF="../../../../aima/core/learning/framework/Learner.html#predict(aima.core.learning.framework.Example)">Learner</A></CODE></B></DD>
- <DD>Returns the outcome predicted for the specified example
- <P>
- <DD><DL>
- <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../aima/core/learning/framework/Learner.html#predict(aima.core.learning.framework.Example)">predict</A></CODE> in interface <CODE><A HREF="../../../../aima/core/learning/framework/Learner.html" title="interface in aima.core.learning.framework">Learner</A></CODE></DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>e</CODE> - an example
- <DT><B>Returns:</B><DD>the outcome predicted for the specified example</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="test(aima.core.learning.framework.DataSet)"><!-- --></A><H3>
- test</H3>
- <PRE>
- public int[] <B>test</B>(<A HREF="../../../../aima/core/learning/framework/DataSet.html" title="class in aima.core.learning.framework">DataSet</A> ds)</PRE>
- <DL>
- <DD><B>Description copied from interface: <CODE><A HREF="../../../../aima/core/learning/framework/Learner.html#test(aima.core.learning.framework.DataSet)">Learner</A></CODE></B></DD>
- <DD>Returns the accuracy of the hypothesis on the specified set of examples
- <P>
- <DD><DL>
- <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../aima/core/learning/framework/Learner.html#test(aima.core.learning.framework.DataSet)">test</A></CODE> in interface <CODE><A HREF="../../../../aima/core/learning/framework/Learner.html" title="interface in aima.core.learning.framework">Learner</A></CODE></DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>ds</CODE> - the test data set.
- <DT><B>Returns:</B><DD>the accuracy of the hypothesis on the specified set of examples</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="getDecisionList()"><!-- --></A><H3>
- getDecisionList</H3>
- <PRE>
- public <A HREF="../../../../aima/core/learning/inductive/DecisionList.html" title="class in aima.core.learning.inductive">DecisionList</A> <B>getDecisionList</B>()</PRE>
- <DL>
- <DD>Returns the decision list of this decision list learner
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
-
- <DT><B>Returns:</B><DD>the decision list of this decision list learner</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="../../../../aima/core/learning/learners/CurrentBestLearner.html" title="class in aima.core.learning.learners"><B>PREV CLASS</B></A>
- <A HREF="../../../../aima/core/learning/learners/DecisionTreeLearner.html" title="class in aima.core.learning.learners"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?aima/core/learning/learners/DecisionListLearner.html" target="_top"><B>FRAMES</B></A>
- <A HREF="DecisionListLearner.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <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>
-
- </BODY>
- </HTML>