Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
view libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/distribution/CauchyDistributionImpl.html @ 32:d7a43156a79b default tip
new tabs
| author | dwinter |
|---|---|
| date | Mon, 10 Oct 2011 17:52:22 +0200 |
| parents | 878723cc40fb |
| children |
line wrap: on
line source
<!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_17) on Sat Mar 27 22:46:10 EDT 2010 --> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <TITLE> CauchyDistributionImpl (Commons Math 2.1 API) </TITLE> <META NAME="date" CONTENT="2010-03-27"> <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="CauchyDistributionImpl (Commons Math 2.1 API)"; } } </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="class-use/CauchyDistributionImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/commons/math/distribution/ChiSquaredDistribution.html" title="interface in org.apache.commons.math.distribution"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/commons/math/distribution/CauchyDistributionImpl.html" target="_top"><B>FRAMES</B></A> <A HREF="CauchyDistributionImpl.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"> org.apache.commons.math.distribution</FONT> <BR> Class CauchyDistributionImpl</H2> <PRE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/commons/math/distribution/AbstractDistribution.html" title="class in org.apache.commons.math.distribution">org.apache.commons.math.distribution.AbstractDistribution</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">org.apache.commons.math.distribution.AbstractContinuousDistribution</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.math.distribution.CauchyDistributionImpl</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution">CauchyDistribution</A>, <A HREF="../../../../../org/apache/commons/math/distribution/ContinuousDistribution.html" title="interface in org.apache.commons.math.distribution">ContinuousDistribution</A>, <A HREF="../../../../../org/apache/commons/math/distribution/Distribution.html" title="interface in org.apache.commons.math.distribution">Distribution</A></DD> </DL> <HR> <DL> <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.31"><B>CauchyDistributionImpl</B></A><DT>extends <A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A><DT>implements <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution">CauchyDistribution</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL> </PRE> <P> Default implementation of <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution"><CODE>CauchyDistribution</CODE></A>. <P> <P> <DL> <DT><B>Since:</B></DT> <DD>1.1</DD> <DT><B>Version:</B></DT> <DD>$Revision: 925900 $ $Date: 2010-03-21 17:10:07 -0400 (Sun, 21 Mar 2010) $</DD> <DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.commons.math.distribution.CauchyDistributionImpl">Serialized Form</A></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 double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#DEFAULT_INVERSE_ABSOLUTE_ACCURACY">DEFAULT_INVERSE_ABSOLUTE_ACCURACY</A></B></CODE> <BR> Default inverse cumulative probability accuracy</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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#CauchyDistributionImpl()">CauchyDistributionImpl</A></B>()</CODE> <BR> Creates cauchy distribution with the medain equal to zero and scale equal to one.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#CauchyDistributionImpl(double, double)">CauchyDistributionImpl</A></B>(double median, double s)</CODE> <BR> Create a cauchy distribution using the given median and scale.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#CauchyDistributionImpl(double, double, double)">CauchyDistributionImpl</A></B>(double median, double s, double inverseCumAccuracy)</CODE> <BR> Create a cauchy distribution using the given median and scale.</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> double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#cumulativeProbability(double)">cumulativeProbability</A></B>(double x)</CODE> <BR> For this distribution, X, this method returns P(X < <code>x</code>).</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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#density(double)">density</A></B>(double x)</CODE> <BR> Returns the probability density for a particular point.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#getDomainLowerBound(double)">getDomainLowerBound</A></B>(double p)</CODE> <BR> Access the domain value lower bound, based on <code>p</code>, used to bracket a CDF root.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#getDomainUpperBound(double)">getDomainUpperBound</A></B>(double p)</CODE> <BR> Access the domain value upper bound, based on <code>p</code>, used to bracket a CDF root.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#getInitialDomain(double)">getInitialDomain</A></B>(double p)</CODE> <BR> Access the initial domain value, based on <code>p</code>, used to bracket a CDF root.</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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#getMedian()">getMedian</A></B>()</CODE> <BR> Access the median.</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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#getScale()">getScale</A></B>()</CODE> <BR> Access the scale parameter.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#getSolverAbsoluteAccuracy()">getSolverAbsoluteAccuracy</A></B>()</CODE> <BR> Return the absolute accuracy setting of the solver used to estimate inverse cumulative probabilities.</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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#inverseCumulativeProbability(double)">inverseCumulativeProbability</A></B>(double p)</CODE> <BR> For this distribution, X, this method returns the critical point x, such that P(X < x) = <code>p</code>.</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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#setMedian(double)">setMedian</A></B>(double median)</CODE> <BR> <B>Deprecated.</B> <I>as of 2.1 (class will become immutable in 3.0)</I></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="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#setScale(double)">setScale</A></B>(double s)</CODE> <BR> <B>Deprecated.</B> <I>as of 2.1 (class will become immutable in 3.0)</I></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.apache.commons.math.distribution.AbstractDistribution"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class org.apache.commons.math.distribution.<A HREF="../../../../../org/apache/commons/math/distribution/AbstractDistribution.html" title="class in org.apache.commons.math.distribution">AbstractDistribution</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractDistribution.html#cumulativeProbability(double, double)">cumulativeProbability</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://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.apache.commons.math.distribution.Distribution"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface org.apache.commons.math.distribution.<A HREF="../../../../../org/apache/commons/math/distribution/Distribution.html" title="interface in org.apache.commons.math.distribution">Distribution</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/Distribution.html#cumulativeProbability(double, double)">cumulativeProbability</A></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="DEFAULT_INVERSE_ABSOLUTE_ACCURACY"><!-- --></A><H3> DEFAULT_INVERSE_ABSOLUTE_ACCURACY</H3> <PRE> public static final double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.38"><B>DEFAULT_INVERSE_ABSOLUTE_ACCURACY</B></A></PRE> <DL> <DD>Default inverse cumulative probability accuracy <P> <DL> <DT><B>Since:</B></DT> <DD>2.1</DD> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.distribution.CauchyDistributionImpl.DEFAULT_INVERSE_ABSOLUTE_ACCURACY">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="CauchyDistributionImpl()"><!-- --></A><H3> CauchyDistributionImpl</H3> <PRE> public <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.56"><B>CauchyDistributionImpl</B></A>()</PRE> <DL> <DD>Creates cauchy distribution with the medain equal to zero and scale equal to one. <P> </DL> <HR> <A NAME="CauchyDistributionImpl(double, double)"><!-- --></A><H3> CauchyDistributionImpl</H3> <PRE> public <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.65"><B>CauchyDistributionImpl</B></A>(double median, double s)</PRE> <DL> <DD>Create a cauchy distribution using the given median and scale. <P> <DL> <DT><B>Parameters:</B><DD><CODE>median</CODE> - median for this distribution<DD><CODE>s</CODE> - scale parameter for this distribution</DL> </DL> <HR> <A NAME="CauchyDistributionImpl(double, double, double)"><!-- --></A><H3> CauchyDistributionImpl</H3> <PRE> public <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.77"><B>CauchyDistributionImpl</B></A>(double median, double s, double inverseCumAccuracy)</PRE> <DL> <DD>Create a cauchy distribution using the given median and scale. <P> <DL> <DT><B>Parameters:</B><DD><CODE>median</CODE> - median for this distribution<DD><CODE>s</CODE> - scale parameter for this distribution<DD><CODE>inverseCumAccuracy</CODE> - the maximum absolute error in inverse cumulative probability estimates (defaults to <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#DEFAULT_INVERSE_ABSOLUTE_ACCURACY"><CODE>DEFAULT_INVERSE_ABSOLUTE_ACCURACY</CODE></A>)<DT><B>Since:</B></DT> <DD>2.1</DD> </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="cumulativeProbability(double)"><!-- --></A><H3> cumulativeProbability</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.89"><B>cumulativeProbability</B></A>(double x)</PRE> <DL> <DD>For this distribution, X, this method returns P(X < <code>x</code>). <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/Distribution.html#cumulativeProbability(double)">cumulativeProbability</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/distribution/Distribution.html" title="interface in org.apache.commons.math.distribution">Distribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>x</CODE> - the value at which the CDF is evaluated. <DT><B>Returns:</B><DD>CDF evaluted at <code>x</code>.</DL> </DD> </DL> <HR> <A NAME="getMedian()"><!-- --></A><H3> getMedian</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.97"><B>getMedian</B></A>()</PRE> <DL> <DD>Access the median. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html#getMedian()">getMedian</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution">CauchyDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>median for this distribution</DL> </DD> </DL> <HR> <A NAME="getScale()"><!-- --></A><H3> getScale</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.105"><B>getScale</B></A>()</PRE> <DL> <DD>Access the scale parameter. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html#getScale()">getScale</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution">CauchyDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>scale parameter for this distribution</DL> </DD> </DL> <HR> <A NAME="density(double)"><!-- --></A><H3> density</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.117"><B>density</B></A>(double x)</PRE> <DL> <DD>Returns the probability density for a particular point. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html#density(double)">density</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>x</CODE> - The point at which the density should be computed. <DT><B>Returns:</B><DD>The pdf at point x.<DT><B>Since:</B></DT> <DD>2.1</DD> </DL> </DD> </DL> <HR> <A NAME="inverseCumulativeProbability(double)"><!-- --></A><H3> inverseCumulativeProbability</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.135"><B>inverseCumulativeProbability</B></A>(double p)</PRE> <DL> <DD>For this distribution, X, this method returns the critical point x, such that P(X < x) = <code>p</code>. <p> Returns <code>Double.NEGATIVE_INFINITY</code> for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/ContinuousDistribution.html#inverseCumulativeProbability(double)">inverseCumulativeProbability</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/distribution/ContinuousDistribution.html" title="interface in org.apache.commons.math.distribution">ContinuousDistribution</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html#inverseCumulativeProbability(double)">inverseCumulativeProbability</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - the desired probability <DT><B>Returns:</B><DD>x, such that P(X < x) = <code>p</code> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>p</code> is not a valid probability.</DL> </DD> </DL> <HR> <A NAME="setMedian(double)"><!-- --></A><H3> setMedian</H3> <PRE> <FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> </FONT>public void <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.156"><B>setMedian</B></A>(double median)</PRE> <DL> <DD><B>Deprecated.</B> <I>as of 2.1 (class will become immutable in 3.0)</I> <P> <DD>Modify the median. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html#setMedian(double)">setMedian</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution">CauchyDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>median</CODE> - for this distribution</DL> </DD> </DL> <HR> <A NAME="setScale(double)"><!-- --></A><H3> setScale</H3> <PRE> <FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> </FONT>public void <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.174"><B>setScale</B></A>(double s)</PRE> <DL> <DD><B>Deprecated.</B> <I>as of 2.1 (class will become immutable in 3.0)</I> <P> <DD>Modify the scale parameter. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html#setScale(double)">setScale</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution">CauchyDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>s</CODE> - scale parameter for this distribution <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>sd</code> is not positive.</DL> </DD> </DL> <HR> <A NAME="getDomainLowerBound(double)"><!-- --></A><H3> getDomainLowerBound</H3> <PRE> protected double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.200"><B>getDomainLowerBound</B></A>(double p)</PRE> <DL> <DD>Access the domain value lower bound, based on <code>p</code>, used to bracket a CDF root. This method is used by <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#inverseCumulativeProbability(double)"><CODE>inverseCumulativeProbability(double)</CODE></A> to find critical values. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html#getDomainLowerBound(double)">getDomainLowerBound</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - the desired probability for the critical value <DT><B>Returns:</B><DD>domain value lower bound, i.e. P(X < <i>lower bound</i>) < <code>p</code></DL> </DD> </DL> <HR> <A NAME="getDomainUpperBound(double)"><!-- --></A><H3> getDomainUpperBound</H3> <PRE> protected double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.222"><B>getDomainUpperBound</B></A>(double p)</PRE> <DL> <DD>Access the domain value upper bound, based on <code>p</code>, used to bracket a CDF root. This method is used by <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#inverseCumulativeProbability(double)"><CODE>inverseCumulativeProbability(double)</CODE></A> to find critical values. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html#getDomainUpperBound(double)">getDomainUpperBound</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - the desired probability for the critical value <DT><B>Returns:</B><DD>domain value upper bound, i.e. P(X < <i>upper bound</i>) > <code>p</code></DL> </DD> </DL> <HR> <A NAME="getInitialDomain(double)"><!-- --></A><H3> getInitialDomain</H3> <PRE> protected double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.243"><B>getInitialDomain</B></A>(double p)</PRE> <DL> <DD>Access the initial domain value, based on <code>p</code>, used to bracket a CDF root. This method is used by <A HREF="../../../../../org/apache/commons/math/distribution/CauchyDistributionImpl.html#inverseCumulativeProbability(double)"><CODE>inverseCumulativeProbability(double)</CODE></A> to find critical values. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html#getInitialDomain(double)">getInitialDomain</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>p</CODE> - the desired probability for the critical value <DT><B>Returns:</B><DD>initial domain value</DL> </DD> </DL> <HR> <A NAME="getSolverAbsoluteAccuracy()"><!-- --></A><H3> getSolverAbsoluteAccuracy</H3> <PRE> protected double <A HREF="../../../../../src-html/org/apache/commons/math/distribution/CauchyDistributionImpl.html#line.265"><B>getSolverAbsoluteAccuracy</B></A>()</PRE> <DL> <DD>Return the absolute accuracy setting of the solver used to estimate inverse cumulative probabilities. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html#getSolverAbsoluteAccuracy()">getSolverAbsoluteAccuracy</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/math/distribution/AbstractContinuousDistribution.html" title="class in org.apache.commons.math.distribution">AbstractContinuousDistribution</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the solver absolute accuracy<DT><B>Since:</B></DT> <DD>2.1</DD> </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="class-use/CauchyDistributionImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../../org/apache/commons/math/distribution/CauchyDistribution.html" title="interface in org.apache.commons.math.distribution"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/commons/math/distribution/ChiSquaredDistribution.html" title="interface in org.apache.commons.math.distribution"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/commons/math/distribution/CauchyDistributionImpl.html" target="_top"><B>FRAMES</B></A> <A HREF="CauchyDistributionImpl.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> Copyright © 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. </BODY> </HTML>