Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
view libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/random/ValueServer.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:16 EDT 2010 --> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <TITLE> ValueServer (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="ValueServer (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/ValueServer.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/random/UnitSphereRandomVectorGenerator.html" title="class in org.apache.commons.math.random"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/commons/math/random/ValueServer.html" target="_top"><B>FRAMES</B></A> <A HREF="ValueServer.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.random</FONT> <BR> Class ValueServer</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 "><B>org.apache.commons.math.random.ValueServer</B> </PRE> <HR> <DL> <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.48"><B>ValueServer</B></A><DT>extends <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></DL> </PRE> <P> Generates values for use in simulation applications. <p> How values are generated is determined by the <code>mode</code> property.</p> <p> Supported <code>mode</code> values are: <ul> <li> DIGEST_MODE -- uses an empirical distribution </li> <li> REPLAY_MODE -- replays data from <code>valuesFileURL</code></li> <li> UNIFORM_MODE -- generates uniformly distributed random values with mean = <code>mu</code> </li> <li> EXPONENTIAL_MODE -- generates exponentially distributed random values with mean = <code>mu</code></li> <li> GAUSSIAN_MODE -- generates Gaussian distributed random values with mean = <code>mu</code> and standard deviation = <code>sigma</code></li> <li> CONSTANT_MODE -- returns <code>mu</code> every time.</li></ul></p> <P> <P> <DL> <DT><B>Version:</B></DT> <DD>$Revision: 811827 $ $Date: 2009-09-06 11:32:50 -0400 (Sun, 06 Sep 2009) $</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 int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#CONSTANT_MODE">CONSTANT_MODE</A></B></CODE> <BR> Always return mu</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#DIGEST_MODE">DIGEST_MODE</A></B></CODE> <BR> Use empirical distribution.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#EXPONENTIAL_MODE">EXPONENTIAL_MODE</A></B></CODE> <BR> Exponential random deviates with mean = μ.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#GAUSSIAN_MODE">GAUSSIAN_MODE</A></B></CODE> <BR> Gaussian random deviates with mean = μ, std dev = σ.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#REPLAY_MODE">REPLAY_MODE</A></B></CODE> <BR> Replay data from valuesFilePath.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#UNIFORM_MODE">UNIFORM_MODE</A></B></CODE> <BR> Uniform random deviates with mean = μ.</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/random/ValueServer.html#ValueServer()">ValueServer</A></B>()</CODE> <BR> Creates new ValueServer</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#ValueServer(org.apache.commons.math.random.RandomData)">ValueServer</A></B>(<A HREF="../../../../../org/apache/commons/math/random/RandomData.html" title="interface in org.apache.commons.math.random">RandomData</A> randomData)</CODE> <BR> Construct a ValueServer instance using a RandomData as its source of random data.</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="../../../../../org/apache/commons/math/random/ValueServer.html#closeReplayFile()">closeReplayFile</A></B>()</CODE> <BR> Closes <code>valuesFileURL</code> after use in REPLAY_MODE.</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/random/ValueServer.html#computeDistribution()">computeDistribution</A></B>()</CODE> <BR> Computes the empirical distribution using values from the file in <code>valuesFileURL</code>, using the default number of bins.</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/random/ValueServer.html#computeDistribution(int)">computeDistribution</A></B>(int binCount)</CODE> <BR> Computes the empirical distribution using values from the file in <code>valuesFileURL</code> and <code>binCount</code> bins.</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/random/ValueServer.html#fill(double[])">fill</A></B>(double[] values)</CODE> <BR> Fills the input array with values generated using getNext() repeatedly.</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/random/ValueServer.html#fill(int)">fill</A></B>(int length)</CODE> <BR> Returns an array of length <code>length</code> with values generated using getNext() repeatedly.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/commons/math/random/EmpiricalDistribution.html" title="interface in org.apache.commons.math.random">EmpiricalDistribution</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#getEmpiricalDistribution()">getEmpiricalDistribution</A></B>()</CODE> <BR> Getter for property empiricalDistribution.</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="../../../../../org/apache/commons/math/random/ValueServer.html#getMode()">getMode</A></B>()</CODE> <BR> Getter for property mode.</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/random/ValueServer.html#getMu()">getMu</A></B>()</CODE> <BR> Getter for property mu.</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/random/ValueServer.html#getNext()">getNext</A></B>()</CODE> <BR> Returns the next generated value, generated according to the mode value (see MODE constants).</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/random/ValueServer.html#getSigma()">getSigma</A></B>()</CODE> <BR> Getter for property sigma.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/random/ValueServer.html#getValuesFileURL()">getValuesFileURL</A></B>()</CODE> <BR> Getter for <code>valuesFileURL<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/random/ValueServer.html#resetReplayFile()">resetReplayFile</A></B>()</CODE> <BR> Resets REPLAY_MODE file pointer to the beginning of the <code>valuesFileURL</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/random/ValueServer.html#setMode(int)">setMode</A></B>(int mode)</CODE> <BR> Setter for property mode.</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/random/ValueServer.html#setMu(double)">setMu</A></B>(double mu)</CODE> <BR> Setter for property mu.</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/random/ValueServer.html#setSigma(double)">setSigma</A></B>(double sigma)</CODE> <BR> Setter for property sigma.</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/random/ValueServer.html#setValuesFileURL(java.lang.String)">setValuesFileURL</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url)</CODE> <BR> Sets the <code>valuesFileURL</code> using a string URL representation</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/random/ValueServer.html#setValuesFileURL(java.net.URL)">setValuesFileURL</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> url)</CODE> <BR> Sets the <code>valuesFileURL</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> <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="DIGEST_MODE"><!-- --></A><H3> DIGEST_MODE</H3> <PRE> public static final int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.51"><B>DIGEST_MODE</B></A></PRE> <DL> <DD>Use empirical distribution. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.random.ValueServer.DIGEST_MODE">Constant Field Values</A></DL> </DL> <HR> <A NAME="REPLAY_MODE"><!-- --></A><H3> REPLAY_MODE</H3> <PRE> public static final int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.54"><B>REPLAY_MODE</B></A></PRE> <DL> <DD>Replay data from valuesFilePath. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.random.ValueServer.REPLAY_MODE">Constant Field Values</A></DL> </DL> <HR> <A NAME="UNIFORM_MODE"><!-- --></A><H3> UNIFORM_MODE</H3> <PRE> public static final int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.57"><B>UNIFORM_MODE</B></A></PRE> <DL> <DD>Uniform random deviates with mean = μ. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.random.ValueServer.UNIFORM_MODE">Constant Field Values</A></DL> </DL> <HR> <A NAME="EXPONENTIAL_MODE"><!-- --></A><H3> EXPONENTIAL_MODE</H3> <PRE> public static final int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.60"><B>EXPONENTIAL_MODE</B></A></PRE> <DL> <DD>Exponential random deviates with mean = μ. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.random.ValueServer.EXPONENTIAL_MODE">Constant Field Values</A></DL> </DL> <HR> <A NAME="GAUSSIAN_MODE"><!-- --></A><H3> GAUSSIAN_MODE</H3> <PRE> public static final int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.63"><B>GAUSSIAN_MODE</B></A></PRE> <DL> <DD>Gaussian random deviates with mean = μ, std dev = σ. <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.random.ValueServer.GAUSSIAN_MODE">Constant Field Values</A></DL> </DL> <HR> <A NAME="CONSTANT_MODE"><!-- --></A><H3> CONSTANT_MODE</H3> <PRE> public static final int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.66"><B>CONSTANT_MODE</B></A></PRE> <DL> <DD>Always return mu <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.random.ValueServer.CONSTANT_MODE">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="ValueServer()"><!-- --></A><H3> ValueServer</H3> <PRE> public <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.92"><B>ValueServer</B></A>()</PRE> <DL> <DD>Creates new ValueServer <P> </DL> <HR> <A NAME="ValueServer(org.apache.commons.math.random.RandomData)"><!-- --></A><H3> ValueServer</H3> <PRE> public <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.102"><B>ValueServer</B></A>(<A HREF="../../../../../org/apache/commons/math/random/RandomData.html" title="interface in org.apache.commons.math.random">RandomData</A> randomData)</PRE> <DL> <DD>Construct a ValueServer instance using a RandomData as its source of random data. <P> <DL> <DT><B>Parameters:</B><DD><CODE>randomData</CODE> - the RandomData instance used to source random data<DT><B>Since:</B></DT> <DD>1.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="getNext()"><!-- --></A><H3> getNext</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.113"><B>getNext</B></A>() throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Returns the next generated value, generated according to the mode value (see MODE constants). <P> <DD><DL> <DT><B>Returns:</B><DD>generated value <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - in REPLAY_MODE if a file I/O error occurs</DL> </DD> </DL> <HR> <A NAME="fill(double[])"><!-- --></A><H3> fill</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.137"><B>fill</B></A>(double[] values) throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Fills the input array with values generated using getNext() repeatedly. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>values</CODE> - array to be filled <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - in REPLAY_MODE if a file I/O error occurs</DL> </DD> </DL> <HR> <A NAME="fill(int)"><!-- --></A><H3> fill</H3> <PRE> public double[] <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.151"><B>fill</B></A>(int length) throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Returns an array of length <code>length</code> with values generated using getNext() repeatedly. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>length</CODE> - length of output array <DT><B>Returns:</B><DD>array of generated values <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - in REPLAY_MODE if a file I/O error occurs</DL> </DD> </DL> <HR> <A NAME="computeDistribution()"><!-- --></A><H3> computeDistribution</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.171"><B>computeDistribution</B></A>() throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Computes the empirical distribution using values from the file in <code>valuesFileURL</code>, using the default number of bins. <p> <code>valuesFileURL</code> must exist and be readable by *this at runtime.</p> <p> This method must be called before using <code>getNext()</code> with <code>mode = DIGEST_MODE</code></p> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs reading the input file</DL> </DD> </DL> <HR> <A NAME="computeDistribution(int)"><!-- --></A><H3> computeDistribution</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.190"><B>computeDistribution</B></A>(int binCount) throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Computes the empirical distribution using values from the file in <code>valuesFileURL</code> and <code>binCount</code> bins. <p> <code>valuesFileURL</code> must exist and be readable by this process at runtime.</p> <p> This method must be called before using <code>getNext()</code> with <code>mode = DIGEST_MODE</code></p> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>binCount</CODE> - the number of bins used in computing the empirical distribution <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an error occurs reading the input file</DL> </DD> </DL> <HR> <A NAME="getMode()"><!-- --></A><H3> getMode</H3> <PRE> public int <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.201"><B>getMode</B></A>()</PRE> <DL> <DD>Getter for property mode. <P> <DD><DL> <DT><B>Returns:</B><DD>Value of property mode.</DL> </DD> </DL> <HR> <A NAME="setMode(int)"><!-- --></A><H3> setMode</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.208"><B>setMode</B></A>(int mode)</PRE> <DL> <DD>Setter for property mode. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mode</CODE> - New value of property mode.</DL> </DD> </DL> <HR> <A NAME="getValuesFileURL()"><!-- --></A><H3> getValuesFileURL</H3> <PRE> public <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.216"><B>getValuesFileURL</B></A>()</PRE> <DL> <DD>Getter for <code>valuesFileURL<code> <P> <DD><DL> <DT><B>Returns:</B><DD>Value of property valuesFileURL.</DL> </DD> </DL> <HR> <A NAME="setValuesFileURL(java.lang.String)"><!-- --></A><H3> setValuesFileURL</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.225"><B>setValuesFileURL</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url) throws <A HREF="http://java.sun.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</A></PRE> <DL> <DD>Sets the <code>valuesFileURL</code> using a string URL representation <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>url</CODE> - String representation for new valuesFileURL. <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</A></CODE> - if url is not well formed</DL> </DD> </DL> <HR> <A NAME="setValuesFileURL(java.net.URL)"><!-- --></A><H3> setValuesFileURL</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.233"><B>setValuesFileURL</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> url)</PRE> <DL> <DD>Sets the <code>valuesFileURL</code> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>url</CODE> - New value of property valuesFileURL.</DL> </DD> </DL> <HR> <A NAME="getEmpiricalDistribution()"><!-- --></A><H3> getEmpiricalDistribution</H3> <PRE> public <A HREF="../../../../../org/apache/commons/math/random/EmpiricalDistribution.html" title="interface in org.apache.commons.math.random">EmpiricalDistribution</A> <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.240"><B>getEmpiricalDistribution</B></A>()</PRE> <DL> <DD>Getter for property empiricalDistribution. <P> <DD><DL> <DT><B>Returns:</B><DD>Value of property empiricalDistribution.</DL> </DD> </DL> <HR> <A NAME="resetReplayFile()"><!-- --></A><H3> resetReplayFile</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.249"><B>resetReplayFile</B></A>() throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Resets REPLAY_MODE file pointer to the beginning of the <code>valuesFileURL</code>. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an error occurs opening the file</DL> </DD> </DL> <HR> <A NAME="closeReplayFile()"><!-- --></A><H3> closeReplayFile</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.266"><B>closeReplayFile</B></A>() throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> <DL> <DD>Closes <code>valuesFileURL</code> after use in REPLAY_MODE. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if an error occurs closing the file</DL> </DD> </DL> <HR> <A NAME="getMu()"><!-- --></A><H3> getMu</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.276"><B>getMu</B></A>()</PRE> <DL> <DD>Getter for property mu. <P> <DD><DL> <DT><B>Returns:</B><DD>Value of property mu.</DL> </DD> </DL> <HR> <A NAME="setMu(double)"><!-- --></A><H3> setMu</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.283"><B>setMu</B></A>(double mu)</PRE> <DL> <DD>Setter for property mu. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mu</CODE> - New value of property mu.</DL> </DD> </DL> <HR> <A NAME="getSigma()"><!-- --></A><H3> getSigma</H3> <PRE> public double <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.290"><B>getSigma</B></A>()</PRE> <DL> <DD>Getter for property sigma. <P> <DD><DL> <DT><B>Returns:</B><DD>Value of property sigma.</DL> </DD> </DL> <HR> <A NAME="setSigma(double)"><!-- --></A><H3> setSigma</H3> <PRE> public void <A HREF="../../../../../src-html/org/apache/commons/math/random/ValueServer.html#line.297"><B>setSigma</B></A>(double sigma)</PRE> <DL> <DD>Setter for property sigma. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>sigma</CODE> - New value of property sigma.</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/ValueServer.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/random/UnitSphereRandomVectorGenerator.html" title="class in org.apache.commons.math.random"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/commons/math/random/ValueServer.html" target="_top"><B>FRAMES</B></A> <A HREF="ValueServer.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>