You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by lu...@apache.org on 2014/10/18 22:10:40 UTC
svn commit: r926176 [9/31] - in
/websites/production/commons/content/proper/commons-math:
apidocs/org/apache/commons/math3/analysis/interpolation/
apidocs/org/apache/commons/math3/analysis/interpolation/class-use/
apidocs/org/apache/commons/math3/distr...
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/distribution/NakagamiDistribution.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/distribution/NakagamiDistribution.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/distribution/NakagamiDistribution.html Sat Oct 18 20:10:38 2014
@@ -0,0 +1,246 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="fr">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.math3.distribution;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import org.apache.commons.math3.exception.NotStrictlyPositiveException;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.commons.math3.exception.NumberIsTooSmallException;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.commons.math3.exception.util.LocalizedFormats;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.commons.math3.random.RandomGenerator;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.commons.math3.random.Well19937c;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.commons.math3.special.Gamma;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.commons.math3.util.FastMath;<a name="line.25"></a>
+<span class="sourceLineNo">026</span><a name="line.26"></a>
+<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * This class implements the Nakagami distribution.<a name="line.28"></a>
+<span class="sourceLineNo">029</span> *<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * @see <a href="http://en.wikipedia.org/wiki/Nakagami_distribution">Nakagami Distribution (Wikipedia)</a><a name="line.30"></a>
+<span class="sourceLineNo">031</span> *<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * @since 3.4<a name="line.32"></a>
+<span class="sourceLineNo">033</span> */<a name="line.33"></a>
+<span class="sourceLineNo">034</span>public class NakagamiDistribution extends AbstractRealDistribution {<a name="line.34"></a>
+<span class="sourceLineNo">035</span><a name="line.35"></a>
+<span class="sourceLineNo">036</span> /** Default inverse cumulative probability accuracy. */<a name="line.36"></a>
+<span class="sourceLineNo">037</span> public static final double DEFAULT_INVERSE_ABSOLUTE_ACCURACY = 1e-9;<a name="line.37"></a>
+<span class="sourceLineNo">038</span><a name="line.38"></a>
+<span class="sourceLineNo">039</span> /** Serializable version identifier. */<a name="line.39"></a>
+<span class="sourceLineNo">040</span> private static final long serialVersionUID = 20141003;<a name="line.40"></a>
+<span class="sourceLineNo">041</span><a name="line.41"></a>
+<span class="sourceLineNo">042</span> /** The shape parameter. */<a name="line.42"></a>
+<span class="sourceLineNo">043</span> private final double mu;<a name="line.43"></a>
+<span class="sourceLineNo">044</span> /** The scale parameter. */<a name="line.44"></a>
+<span class="sourceLineNo">045</span> private final double omega;<a name="line.45"></a>
+<span class="sourceLineNo">046</span> /** Inverse cumulative probability accuracy. */<a name="line.46"></a>
+<span class="sourceLineNo">047</span> private final double inverseAbsoluteAccuracy;<a name="line.47"></a>
+<span class="sourceLineNo">048</span><a name="line.48"></a>
+<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * Build a new instance.<a name="line.50"></a>
+<span class="sourceLineNo">051</span> *<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * @param mu shape parameter<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * @param omega scale parameter (must be positive)<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * @throws NumberIsTooSmallException if {@code mu < 0.5}<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * @throws NotStrictlyPositiveException if {@code omega <= 0}<a name="line.55"></a>
+<span class="sourceLineNo">056</span> */<a name="line.56"></a>
+<span class="sourceLineNo">057</span> public NakagamiDistribution(double mu, double omega) {<a name="line.57"></a>
+<span class="sourceLineNo">058</span> this(mu, omega, DEFAULT_INVERSE_ABSOLUTE_ACCURACY);<a name="line.58"></a>
+<span class="sourceLineNo">059</span> }<a name="line.59"></a>
+<span class="sourceLineNo">060</span><a name="line.60"></a>
+<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * Build a new instance.<a name="line.62"></a>
+<span class="sourceLineNo">063</span> *<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * @param mu shape parameter<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * @param omega scale parameter (must be positive)<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * @param inverseAbsoluteAccuracy the maximum absolute error in inverse<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * cumulative probability estimates (defaults to {@link #DEFAULT_INVERSE_ABSOLUTE_ACCURACY}).<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * @throws NumberIsTooSmallException if {@code mu < 0.5}<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * @throws NotStrictlyPositiveException if {@code omega <= 0}<a name="line.69"></a>
+<span class="sourceLineNo">070</span> */<a name="line.70"></a>
+<span class="sourceLineNo">071</span> public NakagamiDistribution(double mu, double omega, double inverseAbsoluteAccuracy) {<a name="line.71"></a>
+<span class="sourceLineNo">072</span> this(new Well19937c(), mu, omega, inverseAbsoluteAccuracy);<a name="line.72"></a>
+<span class="sourceLineNo">073</span> }<a name="line.73"></a>
+<span class="sourceLineNo">074</span><a name="line.74"></a>
+<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * Build a new instance.<a name="line.76"></a>
+<span class="sourceLineNo">077</span> *<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * @param rng Random number generator<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * @param mu shape parameter<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * @param omega scale parameter (must be positive)<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * @param inverseAbsoluteAccuracy the maximum absolute error in inverse<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * cumulative probability estimates (defaults to {@link #DEFAULT_INVERSE_ABSOLUTE_ACCURACY}).<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * @throws NumberIsTooSmallException if {@code mu < 0.5}<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * @throws NotStrictlyPositiveException if {@code omega <= 0}<a name="line.84"></a>
+<span class="sourceLineNo">085</span> */<a name="line.85"></a>
+<span class="sourceLineNo">086</span> public NakagamiDistribution(RandomGenerator rng, double mu, double omega, double inverseAbsoluteAccuracy) {<a name="line.86"></a>
+<span class="sourceLineNo">087</span> super(rng);<a name="line.87"></a>
+<span class="sourceLineNo">088</span><a name="line.88"></a>
+<span class="sourceLineNo">089</span> if (mu < 0.5) {<a name="line.89"></a>
+<span class="sourceLineNo">090</span> throw new NumberIsTooSmallException(mu, 0.5, true);<a name="line.90"></a>
+<span class="sourceLineNo">091</span> }<a name="line.91"></a>
+<span class="sourceLineNo">092</span> if (omega <= 0) {<a name="line.92"></a>
+<span class="sourceLineNo">093</span> throw new NotStrictlyPositiveException(LocalizedFormats.NOT_POSITIVE_SCALE, omega);<a name="line.93"></a>
+<span class="sourceLineNo">094</span> }<a name="line.94"></a>
+<span class="sourceLineNo">095</span><a name="line.95"></a>
+<span class="sourceLineNo">096</span> this.mu = mu;<a name="line.96"></a>
+<span class="sourceLineNo">097</span> this.omega = omega;<a name="line.97"></a>
+<span class="sourceLineNo">098</span> this.inverseAbsoluteAccuracy = inverseAbsoluteAccuracy;<a name="line.98"></a>
+<span class="sourceLineNo">099</span> }<a name="line.99"></a>
+<span class="sourceLineNo">100</span><a name="line.100"></a>
+<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * Access the shape parameter, {@code mu}.<a name="line.102"></a>
+<span class="sourceLineNo">103</span> *<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * @return the shape parameter.<a name="line.104"></a>
+<span class="sourceLineNo">105</span> */<a name="line.105"></a>
+<span class="sourceLineNo">106</span> public double getShape() {<a name="line.106"></a>
+<span class="sourceLineNo">107</span> return mu;<a name="line.107"></a>
+<span class="sourceLineNo">108</span> }<a name="line.108"></a>
+<span class="sourceLineNo">109</span><a name="line.109"></a>
+<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * Access the scale parameter, {@code omega}.<a name="line.111"></a>
+<span class="sourceLineNo">112</span> *<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * @return the scale parameter.<a name="line.113"></a>
+<span class="sourceLineNo">114</span> */<a name="line.114"></a>
+<span class="sourceLineNo">115</span> public double getScale() {<a name="line.115"></a>
+<span class="sourceLineNo">116</span> return omega;<a name="line.116"></a>
+<span class="sourceLineNo">117</span> }<a name="line.117"></a>
+<span class="sourceLineNo">118</span><a name="line.118"></a>
+<span class="sourceLineNo">119</span> @Override<a name="line.119"></a>
+<span class="sourceLineNo">120</span> protected double getSolverAbsoluteAccuracy() {<a name="line.120"></a>
+<span class="sourceLineNo">121</span> return inverseAbsoluteAccuracy;<a name="line.121"></a>
+<span class="sourceLineNo">122</span> }<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span> /** {@inheritDoc} */<a name="line.124"></a>
+<span class="sourceLineNo">125</span> public double density(double x) {<a name="line.125"></a>
+<span class="sourceLineNo">126</span> if (x <= 0) {<a name="line.126"></a>
+<span class="sourceLineNo">127</span> return 0.0;<a name="line.127"></a>
+<span class="sourceLineNo">128</span> }<a name="line.128"></a>
+<span class="sourceLineNo">129</span> return 2.0 * FastMath.pow(mu, mu) / (Gamma.gamma(mu) * FastMath.pow(omega, mu)) *<a name="line.129"></a>
+<span class="sourceLineNo">130</span> FastMath.pow(x, 2 * mu - 1) * FastMath.exp(-mu * x * x / omega);<a name="line.130"></a>
+<span class="sourceLineNo">131</span> }<a name="line.131"></a>
+<span class="sourceLineNo">132</span><a name="line.132"></a>
+<span class="sourceLineNo">133</span> /** {@inheritDoc} */<a name="line.133"></a>
+<span class="sourceLineNo">134</span> public double cumulativeProbability(double x) {<a name="line.134"></a>
+<span class="sourceLineNo">135</span> return Gamma.regularizedGammaP(mu, mu * x * x / omega);<a name="line.135"></a>
+<span class="sourceLineNo">136</span> }<a name="line.136"></a>
+<span class="sourceLineNo">137</span><a name="line.137"></a>
+<span class="sourceLineNo">138</span> /** {@inheritDoc} */<a name="line.138"></a>
+<span class="sourceLineNo">139</span> public double getNumericalMean() {<a name="line.139"></a>
+<span class="sourceLineNo">140</span> return Gamma.gamma(mu + 0.5) / Gamma.gamma(mu) * FastMath.sqrt(omega / mu);<a name="line.140"></a>
+<span class="sourceLineNo">141</span> }<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span> /** {@inheritDoc} */<a name="line.143"></a>
+<span class="sourceLineNo">144</span> public double getNumericalVariance() {<a name="line.144"></a>
+<span class="sourceLineNo">145</span> double v = Gamma.gamma(mu + 0.5) / Gamma.gamma(mu);<a name="line.145"></a>
+<span class="sourceLineNo">146</span> return omega * (1 - 1 / mu * v * v);<a name="line.146"></a>
+<span class="sourceLineNo">147</span> }<a name="line.147"></a>
+<span class="sourceLineNo">148</span><a name="line.148"></a>
+<span class="sourceLineNo">149</span> /** {@inheritDoc} */<a name="line.149"></a>
+<span class="sourceLineNo">150</span> public double getSupportLowerBound() {<a name="line.150"></a>
+<span class="sourceLineNo">151</span> return 0;<a name="line.151"></a>
+<span class="sourceLineNo">152</span> }<a name="line.152"></a>
+<span class="sourceLineNo">153</span><a name="line.153"></a>
+<span class="sourceLineNo">154</span> /** {@inheritDoc} */<a name="line.154"></a>
+<span class="sourceLineNo">155</span> public double getSupportUpperBound() {<a name="line.155"></a>
+<span class="sourceLineNo">156</span> return Double.POSITIVE_INFINITY;<a name="line.156"></a>
+<span class="sourceLineNo">157</span> }<a name="line.157"></a>
+<span class="sourceLineNo">158</span><a name="line.158"></a>
+<span class="sourceLineNo">159</span> /** {@inheritDoc} */<a name="line.159"></a>
+<span class="sourceLineNo">160</span> public boolean isSupportLowerBoundInclusive() {<a name="line.160"></a>
+<span class="sourceLineNo">161</span> return true;<a name="line.161"></a>
+<span class="sourceLineNo">162</span> }<a name="line.162"></a>
+<span class="sourceLineNo">163</span><a name="line.163"></a>
+<span class="sourceLineNo">164</span> /** {@inheritDoc} */<a name="line.164"></a>
+<span class="sourceLineNo">165</span> public boolean isSupportUpperBoundInclusive() {<a name="line.165"></a>
+<span class="sourceLineNo">166</span> return false;<a name="line.166"></a>
+<span class="sourceLineNo">167</span> }<a name="line.167"></a>
+<span class="sourceLineNo">168</span><a name="line.168"></a>
+<span class="sourceLineNo">169</span> /** {@inheritDoc} */<a name="line.169"></a>
+<span class="sourceLineNo">170</span> public boolean isSupportConnected() {<a name="line.170"></a>
+<span class="sourceLineNo">171</span> return true;<a name="line.171"></a>
+<span class="sourceLineNo">172</span> }<a name="line.172"></a>
+<span class="sourceLineNo">173</span><a name="line.173"></a>
+<span class="sourceLineNo">174</span>}<a name="line.174"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/distribution/NakagamiDistribution.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/distribution/NakagamiDistribution.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/EvaluationRmsChecker.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/EvaluationRmsChecker.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/EvaluationRmsChecker.html Sat Oct 18 20:10:38 2014
@@ -0,0 +1,147 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="fr">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.math3.fitting.leastsquares;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem.Evaluation;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.commons.math3.optim.ConvergenceChecker;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.commons.math3.util.Precision;<a name="line.21"></a>
+<span class="sourceLineNo">022</span><a name="line.22"></a>
+<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * Check if an optimization has converged based on the change in computed RMS.<a name="line.24"></a>
+<span class="sourceLineNo">025</span> *<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * @since 3.4<a name="line.26"></a>
+<span class="sourceLineNo">027</span> */<a name="line.27"></a>
+<span class="sourceLineNo">028</span>public class EvaluationRmsChecker implements ConvergenceChecker<Evaluation> {<a name="line.28"></a>
+<span class="sourceLineNo">029</span><a name="line.29"></a>
+<span class="sourceLineNo">030</span> /** relative tolerance for comparisons. */<a name="line.30"></a>
+<span class="sourceLineNo">031</span> private final double relTol;<a name="line.31"></a>
+<span class="sourceLineNo">032</span> /** absolute tolerance for comparisons. */<a name="line.32"></a>
+<span class="sourceLineNo">033</span> private final double absTol;<a name="line.33"></a>
+<span class="sourceLineNo">034</span><a name="line.34"></a>
+<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * Create a convergence checker for the RMS with the same relative and absolute<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * tolerance.<a name="line.37"></a>
+<span class="sourceLineNo">038</span> *<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * <p>Convenience constructor for when the relative and absolute tolerances are the<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * same. Same as {@code new EvaluationRmsChecker(tol, tol)}.<a name="line.40"></a>
+<span class="sourceLineNo">041</span> *<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * @param tol the relative and absolute tolerance.<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * @see #EvaluationRmsChecker(double, double)<a name="line.43"></a>
+<span class="sourceLineNo">044</span> */<a name="line.44"></a>
+<span class="sourceLineNo">045</span> public EvaluationRmsChecker(final double tol) {<a name="line.45"></a>
+<span class="sourceLineNo">046</span> this(tol, tol);<a name="line.46"></a>
+<span class="sourceLineNo">047</span> }<a name="line.47"></a>
+<span class="sourceLineNo">048</span><a name="line.48"></a>
+<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * Create a convergence checker for the RMS with a relative and absolute tolerance.<a name="line.50"></a>
+<span class="sourceLineNo">051</span> *<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * <p>The optimization has converged when the RMS of consecutive evaluations are equal<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * to within the given relative tolerance or absolute tolerance.<a name="line.53"></a>
+<span class="sourceLineNo">054</span> *<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * @param relTol the relative tolerance.<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * @param absTol the absolute tolerance.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * @see Precision#equals(double, double, double)<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * @see Precision#equalsWithRelativeTolerance(double, double, double)<a name="line.58"></a>
+<span class="sourceLineNo">059</span> */<a name="line.59"></a>
+<span class="sourceLineNo">060</span> public EvaluationRmsChecker(final double relTol, final double absTol) {<a name="line.60"></a>
+<span class="sourceLineNo">061</span> this.relTol = relTol;<a name="line.61"></a>
+<span class="sourceLineNo">062</span> this.absTol = absTol;<a name="line.62"></a>
+<span class="sourceLineNo">063</span> }<a name="line.63"></a>
+<span class="sourceLineNo">064</span><a name="line.64"></a>
+<span class="sourceLineNo">065</span> /** {@inheritDoc} */<a name="line.65"></a>
+<span class="sourceLineNo">066</span> public boolean converged(final int iteration,<a name="line.66"></a>
+<span class="sourceLineNo">067</span> final Evaluation previous,<a name="line.67"></a>
+<span class="sourceLineNo">068</span> final Evaluation current) {<a name="line.68"></a>
+<span class="sourceLineNo">069</span> final double prevRms = previous.getRMS();<a name="line.69"></a>
+<span class="sourceLineNo">070</span> final double currRms = current.getRMS();<a name="line.70"></a>
+<span class="sourceLineNo">071</span> return Precision.equals(prevRms, currRms, this.absTol) ||<a name="line.71"></a>
+<span class="sourceLineNo">072</span> Precision.equalsWithRelativeTolerance(prevRms, currRms, this.relTol);<a name="line.72"></a>
+<span class="sourceLineNo">073</span> }<a name="line.73"></a>
+<span class="sourceLineNo">074</span><a name="line.74"></a>
+<span class="sourceLineNo">075</span>}<a name="line.75"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/EvaluationRmsChecker.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/EvaluationRmsChecker.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ValueAndJacobianFunction.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ValueAndJacobianFunction.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ValueAndJacobianFunction.html Sat Oct 18 20:10:38 2014
@@ -0,0 +1,116 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="fr">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.math3.fitting.leastsquares;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import org.apache.commons.math3.linear.RealMatrix;<a name="line.19"></a>
+<span class="sourceLineNo">020</span>import org.apache.commons.math3.linear.RealVector;<a name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * A interface for functions that compute a vector of values and can compute their<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * derivatives (Jacobian).<a name="line.24"></a>
+<span class="sourceLineNo">025</span> *<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * @since 3.3<a name="line.26"></a>
+<span class="sourceLineNo">027</span> */<a name="line.27"></a>
+<span class="sourceLineNo">028</span>public interface ValueAndJacobianFunction extends MultivariateJacobianFunction {<a name="line.28"></a>
+<span class="sourceLineNo">029</span> /**<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * Compute the value.<a name="line.30"></a>
+<span class="sourceLineNo">031</span> *<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * @param params Point.<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * @return the value at the given point.<a name="line.33"></a>
+<span class="sourceLineNo">034</span> */<a name="line.34"></a>
+<span class="sourceLineNo">035</span> RealVector computeValue(final double[] params);<a name="line.35"></a>
+<span class="sourceLineNo">036</span><a name="line.36"></a>
+<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * Compute the Jacobian.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> *<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * @param params Point.<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * @return the Jacobian at the given point.<a name="line.41"></a>
+<span class="sourceLineNo">042</span> */<a name="line.42"></a>
+<span class="sourceLineNo">043</span> RealMatrix computeJacobian(final double[] params);<a name="line.43"></a>
+<span class="sourceLineNo">044</span>}<a name="line.44"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ValueAndJacobianFunction.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ValueAndJacobianFunction.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision