Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/ConvergingAlgorithm.html @ 13:cbf34dd4d7e6
commons-math-2.1 added
| author | dwinter |
|---|---|
| date | Tue, 04 Jan 2011 10:02:07 +0100 |
| parents | |
| children |
line wrap: on
line source
<HTML> <BODY BGCOLOR="white"> <PRE> <FONT color="green">001</FONT> /*<a name="line.1"></a> <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> <FONT color="green">008</FONT> *<a name="line.8"></a> <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> <FONT color="green">010</FONT> *<a name="line.10"></a> <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a> <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a> <FONT color="green">016</FONT> */<a name="line.16"></a> <FONT color="green">017</FONT> package org.apache.commons.math;<a name="line.17"></a> <FONT color="green">018</FONT> <a name="line.18"></a> <FONT color="green">019</FONT> <a name="line.19"></a> <FONT color="green">020</FONT> /**<a name="line.20"></a> <FONT color="green">021</FONT> * Interface for algorithms handling convergence settings.<a name="line.21"></a> <FONT color="green">022</FONT> * <p><a name="line.22"></a> <FONT color="green">023</FONT> * This interface only deals with convergence parameters setting, not<a name="line.23"></a> <FONT color="green">024</FONT> * execution of the algorithms per se.<a name="line.24"></a> <FONT color="green">025</FONT> * </p><a name="line.25"></a> <FONT color="green">026</FONT> * @see ConvergenceException<a name="line.26"></a> <FONT color="green">027</FONT> * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $<a name="line.27"></a> <FONT color="green">028</FONT> * @since 2.0<a name="line.28"></a> <FONT color="green">029</FONT> */<a name="line.29"></a> <FONT color="green">030</FONT> public interface ConvergingAlgorithm {<a name="line.30"></a> <FONT color="green">031</FONT> <a name="line.31"></a> <FONT color="green">032</FONT> /**<a name="line.32"></a> <FONT color="green">033</FONT> * Set the upper limit for the number of iterations.<a name="line.33"></a> <FONT color="green">034</FONT> * <p><a name="line.34"></a> <FONT color="green">035</FONT> * Usually a high iteration count indicates convergence problems. However,<a name="line.35"></a> <FONT color="green">036</FONT> * the "reasonable value" varies widely for different algorithms. Users are<a name="line.36"></a> <FONT color="green">037</FONT> * advised to use the default value supplied by the algorithm.</p><a name="line.37"></a> <FONT color="green">038</FONT> * <p><a name="line.38"></a> <FONT color="green">039</FONT> * A {@link ConvergenceException} will be thrown if this number<a name="line.39"></a> <FONT color="green">040</FONT> * is exceeded.</p><a name="line.40"></a> <FONT color="green">041</FONT> *<a name="line.41"></a> <FONT color="green">042</FONT> * @param count maximum number of iterations<a name="line.42"></a> <FONT color="green">043</FONT> */<a name="line.43"></a> <FONT color="green">044</FONT> void setMaximalIterationCount(int count);<a name="line.44"></a> <FONT color="green">045</FONT> <a name="line.45"></a> <FONT color="green">046</FONT> /**<a name="line.46"></a> <FONT color="green">047</FONT> * Get the upper limit for the number of iterations.<a name="line.47"></a> <FONT color="green">048</FONT> *<a name="line.48"></a> <FONT color="green">049</FONT> * @return the actual upper limit<a name="line.49"></a> <FONT color="green">050</FONT> */<a name="line.50"></a> <FONT color="green">051</FONT> int getMaximalIterationCount();<a name="line.51"></a> <FONT color="green">052</FONT> <a name="line.52"></a> <FONT color="green">053</FONT> /**<a name="line.53"></a> <FONT color="green">054</FONT> * Reset the upper limit for the number of iterations to the default.<a name="line.54"></a> <FONT color="green">055</FONT> * <p><a name="line.55"></a> <FONT color="green">056</FONT> * The default value is supplied by the algorithm implementation.</p><a name="line.56"></a> <FONT color="green">057</FONT> *<a name="line.57"></a> <FONT color="green">058</FONT> * @see #setMaximalIterationCount(int)<a name="line.58"></a> <FONT color="green">059</FONT> */<a name="line.59"></a> <FONT color="green">060</FONT> void resetMaximalIterationCount();<a name="line.60"></a> <FONT color="green">061</FONT> <a name="line.61"></a> <FONT color="green">062</FONT> /**<a name="line.62"></a> <FONT color="green">063</FONT> * Set the absolute accuracy.<a name="line.63"></a> <FONT color="green">064</FONT> * <p><a name="line.64"></a> <FONT color="green">065</FONT> * The default is usually chosen so that results in the interval<a name="line.65"></a> <FONT color="green">066</FONT> * -10..-0.1 and +0.1..+10 can be found with a reasonable accuracy. If the<a name="line.66"></a> <FONT color="green">067</FONT> * expected absolute value of your results is of much smaller magnitude, set<a name="line.67"></a> <FONT color="green">068</FONT> * this to a smaller value.</p><a name="line.68"></a> <FONT color="green">069</FONT> * <p><a name="line.69"></a> <FONT color="green">070</FONT> * Algorithms are advised to do a plausibility check with the relative<a name="line.70"></a> <FONT color="green">071</FONT> * accuracy, but clients should not rely on this.</p><a name="line.71"></a> <FONT color="green">072</FONT> *<a name="line.72"></a> <FONT color="green">073</FONT> * @param accuracy the accuracy.<a name="line.73"></a> <FONT color="green">074</FONT> * @throws IllegalArgumentException if the accuracy can't be achieved by<a name="line.74"></a> <FONT color="green">075</FONT> * the solver or is otherwise deemed unreasonable.<a name="line.75"></a> <FONT color="green">076</FONT> */<a name="line.76"></a> <FONT color="green">077</FONT> void setAbsoluteAccuracy(double accuracy);<a name="line.77"></a> <FONT color="green">078</FONT> <a name="line.78"></a> <FONT color="green">079</FONT> /**<a name="line.79"></a> <FONT color="green">080</FONT> * Get the actual absolute accuracy.<a name="line.80"></a> <FONT color="green">081</FONT> *<a name="line.81"></a> <FONT color="green">082</FONT> * @return the accuracy<a name="line.82"></a> <FONT color="green">083</FONT> */<a name="line.83"></a> <FONT color="green">084</FONT> double getAbsoluteAccuracy();<a name="line.84"></a> <FONT color="green">085</FONT> <a name="line.85"></a> <FONT color="green">086</FONT> /**<a name="line.86"></a> <FONT color="green">087</FONT> * Reset the absolute accuracy to the default.<a name="line.87"></a> <FONT color="green">088</FONT> * <p><a name="line.88"></a> <FONT color="green">089</FONT> * The default value is provided by the algorithm implementation.</p><a name="line.89"></a> <FONT color="green">090</FONT> */<a name="line.90"></a> <FONT color="green">091</FONT> void resetAbsoluteAccuracy();<a name="line.91"></a> <FONT color="green">092</FONT> <a name="line.92"></a> <FONT color="green">093</FONT> /**<a name="line.93"></a> <FONT color="green">094</FONT> * Set the relative accuracy.<a name="line.94"></a> <FONT color="green">095</FONT> * <p><a name="line.95"></a> <FONT color="green">096</FONT> * This is used to stop iterations if the absolute accuracy can't be<a name="line.96"></a> <FONT color="green">097</FONT> * achieved due to large values or short mantissa length.</p><a name="line.97"></a> <FONT color="green">098</FONT> * <p><a name="line.98"></a> <FONT color="green">099</FONT> * If this should be the primary criterion for convergence rather then a<a name="line.99"></a> <FONT color="green">100</FONT> * safety measure, set the absolute accuracy to a ridiculously small value,<a name="line.100"></a> <FONT color="green">101</FONT> * like {@link org.apache.commons.math.util.MathUtils#SAFE_MIN MathUtils.SAFE_MIN}.</p><a name="line.101"></a> <FONT color="green">102</FONT> *<a name="line.102"></a> <FONT color="green">103</FONT> * @param accuracy the relative accuracy.<a name="line.103"></a> <FONT color="green">104</FONT> * @throws IllegalArgumentException if the accuracy can't be achieved by<a name="line.104"></a> <FONT color="green">105</FONT> * the algorithm or is otherwise deemed unreasonable.<a name="line.105"></a> <FONT color="green">106</FONT> */<a name="line.106"></a> <FONT color="green">107</FONT> void setRelativeAccuracy(double accuracy);<a name="line.107"></a> <FONT color="green">108</FONT> <a name="line.108"></a> <FONT color="green">109</FONT> /**<a name="line.109"></a> <FONT color="green">110</FONT> * Get the actual relative accuracy.<a name="line.110"></a> <FONT color="green">111</FONT> * @return the accuracy<a name="line.111"></a> <FONT color="green">112</FONT> */<a name="line.112"></a> <FONT color="green">113</FONT> double getRelativeAccuracy();<a name="line.113"></a> <FONT color="green">114</FONT> <a name="line.114"></a> <FONT color="green">115</FONT> /**<a name="line.115"></a> <FONT color="green">116</FONT> * Reset the relative accuracy to the default.<a name="line.116"></a> <FONT color="green">117</FONT> * The default value is provided by the algorithm implementation.<a name="line.117"></a> <FONT color="green">118</FONT> */<a name="line.118"></a> <FONT color="green">119</FONT> void resetRelativeAccuracy();<a name="line.119"></a> <FONT color="green">120</FONT> <a name="line.120"></a> <FONT color="green">121</FONT> /**<a name="line.121"></a> <FONT color="green">122</FONT> * Get the number of iterations in the last run of the algorithm.<a name="line.122"></a> <FONT color="green">123</FONT> * <p><a name="line.123"></a> <FONT color="green">124</FONT> * This is mainly meant for testing purposes. It may occasionally<a name="line.124"></a> <FONT color="green">125</FONT> * help track down performance problems: if the iteration count<a name="line.125"></a> <FONT color="green">126</FONT> * is notoriously high, check whether the problem is evaluated<a name="line.126"></a> <FONT color="green">127</FONT> * properly, and whether another algorithm is more amenable to the<a name="line.127"></a> <FONT color="green">128</FONT> * problem.</p><a name="line.128"></a> <FONT color="green">129</FONT> *<a name="line.129"></a> <FONT color="green">130</FONT> * @return the last iteration count.<a name="line.130"></a> <FONT color="green">131</FONT> * @throws IllegalStateException if there is no result available, either<a name="line.131"></a> <FONT color="green">132</FONT> * because no result was yet computed or the last attempt failed.<a name="line.132"></a> <FONT color="green">133</FONT> */<a name="line.133"></a> <FONT color="green">134</FONT> int getIterationCount();<a name="line.134"></a> <FONT color="green">135</FONT> <a name="line.135"></a> <FONT color="green">136</FONT> }<a name="line.136"></a> </PRE> </BODY> </HTML>