averagable.html

来自「数据挖掘方面最新软件」· HTML 代码 · 共 826 行 · 第 1/3 页

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the variance of the averagable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getName()">getName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this averagable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getStandardDeviation()">getStandardDeviation</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns the makro standard deviation if it was defined and
 the mikro standard deviation otherwise.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getVariance()">getVariance</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns the makro variance if it was defined and the mikro
 variance otherwise.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.awt.Component</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getVisualizationComponent(com.rapidminer.operator.IOContainer)">getVisualizationComponent</A></B>(<A HREF="../../../../com/rapidminer/operator/IOContainer.html" title="class in com.rapidminer.operator">IOContainer</A>&nbsp;ioContainer)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This default implementation returns a framed text pane containing the string 
  delivered by toResultString().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/rapidminer/tools/math/Averagable.html#toString()">toString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.rapidminer.operator.ResultObjectAdapter"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.rapidminer.operator.<A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html" title="class in com.rapidminer.operator">ResultObjectAdapter</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#addAction(javax.swing.Action)">addAction</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#getActions()">getActions</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#getResultIcon()">getResultIcon</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#isSavable()">isSavable</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#log(java.lang.String)">log</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#logError(java.lang.String)">logError</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#logNote(java.lang.String)">logNote</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#logWarning(java.lang.String)">logWarning</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#readResolve()">readResolve</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#save(java.io.File)">save</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#toHTML(java.lang.String)">toHTML</A>, <A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#toResultString()">toResultString</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.rapidminer.operator.AbstractIOObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.rapidminer.operator.<A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html" title="class in com.rapidminer.operator">AbstractIOObject</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#copy()">copy</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#getLog()">getLog</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#getSource()">getSource</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#initWriting()">initWriting</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#read(java.io.InputStream)">read</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#setSource(java.lang.String)">setSource</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#setWorkingOperator(com.rapidminer.operator.Operator)">setWorkingOperator</A>, <A HREF="../../../../com/rapidminer/operator/AbstractIOObject.html#write(java.io.OutputStream)">write</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<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>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.rapidminer.operator.IOObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.rapidminer.operator.<A HREF="../../../../com/rapidminer/operator/IOObject.html" title="interface in com.rapidminer.operator">IOObject</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/rapidminer/operator/IOObject.html#copy()">copy</A>, <A HREF="../../../../com/rapidminer/operator/IOObject.html#getLog()">getLog</A>, <A HREF="../../../../com/rapidminer/operator/IOObject.html#getSource()">getSource</A>, <A HREF="../../../../com/rapidminer/operator/IOObject.html#setSource(java.lang.String)">setSource</A>, <A HREF="../../../../com/rapidminer/operator/IOObject.html#setWorkingOperator(com.rapidminer.operator.Operator)">setWorkingOperator</A>, <A HREF="../../../../com/rapidminer/operator/IOObject.html#write(java.io.OutputStream)">write</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="Averagable()"><!-- --></A><H3>
Averagable</H3>
<PRE>
public <B>Averagable</B>()</PRE>
<DL>
</DL>
<HR>

<A NAME="Averagable(com.rapidminer.tools.math.Averagable)"><!-- --></A><H3>
Averagable</H3>
<PRE>
public <B>Averagable</B>(<A HREF="../../../../com/rapidminer/tools/math/Averagable.html" title="class in com.rapidminer.tools.math">Averagable</A>&nbsp;o)</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="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public abstract java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Returns the name of this averagable. The returned string should only contain
  lowercase letters and underscore (RapidMiner parameter format) since the names
  will be automatically used for GUI purposes.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rapidminer/operator/ResultObject.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../com/rapidminer/operator/ResultObject.html" title="interface in com.rapidminer.operator">ResultObject</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html#getName()">getName</A></CODE> in class <CODE><A HREF="../../../../com/rapidminer/operator/ResultObjectAdapter.html" title="class in com.rapidminer.operator">ResultObjectAdapter</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMikroAverage()"><!-- --></A><H3>
getMikroAverage</H3>
<PRE>
public abstract double <B>getMikroAverage</B>()</PRE>
<DL>
<DD>Returns the (current) value of the averagable (the average itself). If the 
  method <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#buildSingleAverage(com.rapidminer.tools.math.Averagable)"><CODE>buildSingleAverage(Averagable)</CODE></A> was used, this method must return the 
  micro average from both (or more) criteria. This is usually achieved by
  correctly implementing <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#buildSingleAverage(com.rapidminer.tools.math.Averagable)"><CODE>buildSingleAverage(Averagable)</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMikroVariance()"><!-- --></A><H3>
getMikroVariance</H3>
<PRE>
public abstract double <B>getMikroVariance</B>()</PRE>
<DL>
<DD>Returns the variance of the averagable. The returned value must not be
 negative. If the averagable does not define a variance this method should
 return Double.NaN.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="cloneAveragable(com.rapidminer.tools.math.Averagable)"><!-- --></A><H3>
cloneAveragable</H3>
<PRE>
<FONT SIZE="-1">@Deprecated
</FONT>protected final void <B>cloneAveragable</B>(<A HREF="../../../../com/rapidminer/tools/math/Averagable.html" title="class in com.rapidminer.tools.math">Averagable</A>&nbsp;other)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Please use copy constructors instead</I>
<P>
<DD>Must be implemented by subclasses such that it copies all values of
 <code>other</code> to <code>this</code>. When this method is called,
 it is guaranteed, that <code>other</code> is a subclass of the class of
 the object it is called on.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="buildSingleAverage(com.rapidminer.tools.math.Averagable)"><!-- --></A><H3>
buildSingleAverage</H3>
<PRE>
protected abstract void <B>buildSingleAverage</B>(<A HREF="../../../../com/rapidminer/tools/math/Averagable.html" title="class in com.rapidminer.tools.math">Averagable</A>&nbsp;averagable)</PRE>
<DL>
<DD>This method should build the average of this and another averagable of
 the same type. The next invocation of <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getMikroAverage()"><CODE>getMikroAverage()</CODE></A> should return the
 average of this and the given averagable. Hence, this method is used to build
 the actual micro average value of two criteria. Please refer to
 <A HREF="../../../../com/rapidminer/operator/performance/SimpleCriterion.html" title="class in com.rapidminer.operator.performance"><CODE>SimpleCriterion</CODE></A> for a simple
 implementation example.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="buildAverage(com.rapidminer.tools.math.Averagable)"><!-- --></A><H3>
buildAverage</H3>
<PRE>
public final void <B>buildAverage</B>(<A HREF="../../../../com/rapidminer/tools/math/Averagable.html" title="class in com.rapidminer.tools.math">Averagable</A>&nbsp;averagable)</PRE>
<DL>
<DD>This method builds the makro average of two averagables of the same type.
 First this method checks if the classes of <code>this</code> and
 <code>performance</code> are the same and if the <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getName()"><CODE>getName()</CODE></A>
 methods return the same String. Otherwise a RuntimeException is thrown.
 <br>
 The value of <code>averagable.</code><A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getMikroAverage()"><CODE>getMikroAverage()</CODE></A> is
 added to <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#meanSum"><CODE>meanSum</CODE></A>, its square is added to
 <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#meanSquaredSum"><CODE>meanSquaredSum</CODE></A> and <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#averageCount"><CODE>averageCount</CODE></A> is increased by one.
 These values are used in the <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getMakroAverage()"><CODE>getMakroAverage()</CODE></A> and
 <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getMakroVariance()"><CODE>getMakroVariance()</CODE></A> methods. <br>
 Subclasses should implement the method buildSingleAverage() to build the
 mikro (weighted) average of <code>this</code> averagable and the given
 <code>averagable</code>. They must be weighted by the number of
 examples used for calculating the averagables.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAverage()"><!-- --></A><H3>
getAverage</H3>
<PRE>
public final double <B>getAverage</B>()</PRE>
<DL>
<DD>This method returns the makro average if it was defined and the mikro
 average (the current value) otherwise. This method should be used instead
 of <A HREF="../../../../com/rapidminer/tools/math/Averagable.html#getMikroAverage()"><CODE>getMikroAverage()</CODE></A> for optimization purposes, i.e. by methods like
 <code>getFitness()</code> of performance criteria.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getVariance()"><!-- --></A><H3>
getVariance</H3>
<PRE>
public final double <B>getVariance</B>()</PRE>
<DL>
<DD>This method returns the makro variance if it was defined and the mikro
 variance otherwise.
<P>
<DD><DL>