You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2014/12/30 18:15:37 UTC
svn commit: r934426 [7/10] - in
/websites/production/commons/content/proper/commons-math/apidocs:
org/apache/commons/math3/analysis/interpolation/
org/apache/commons/math3/analysis/interpolation/class-use/
org/apache/commons/math3/fitting/ org/apache/c...
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/SimpleCurveFitter.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/SimpleCurveFitter.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/SimpleCurveFitter.html Tue Dec 30 17:15:36 2014
@@ -0,0 +1,197 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<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;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import java.util.Collection;<a name="line.19"></a>
+<span class="sourceLineNo">020</span><a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.commons.math3.analysis.ParametricUnivariateFunction;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.commons.math3.fitting.leastsquares.LeastSquaresBuilder;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.commons.math3.linear.DiagonalMatrix;<a name="line.24"></a>
+<span class="sourceLineNo">025</span><a name="line.25"></a>
+<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * Fits points to a user-defined {@link ParametricUnivariateFunction function}.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> *<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * @since 3.4<a name="line.29"></a>
+<span class="sourceLineNo">030</span> */<a name="line.30"></a>
+<span class="sourceLineNo">031</span>public class SimpleCurveFitter extends AbstractCurveFitter {<a name="line.31"></a>
+<span class="sourceLineNo">032</span> /** Function to fit. */<a name="line.32"></a>
+<span class="sourceLineNo">033</span> private final ParametricUnivariateFunction function;<a name="line.33"></a>
+<span class="sourceLineNo">034</span> /** Initial guess for the parameters. */<a name="line.34"></a>
+<span class="sourceLineNo">035</span> private final double[] initialGuess;<a name="line.35"></a>
+<span class="sourceLineNo">036</span> /** Maximum number of iterations of the optimization algorithm. */<a name="line.36"></a>
+<span class="sourceLineNo">037</span> private final int maxIter;<a name="line.37"></a>
+<span class="sourceLineNo">038</span><a name="line.38"></a>
+<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * Contructor used by the factory methods.<a name="line.40"></a>
+<span class="sourceLineNo">041</span> *<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * @param function Function to fit.<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * @param initialGuess Initial guess. Cannot be {@code null}. Its length must<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * be consistent with the number of parameters of the {@code function} to fit.<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * @param maxIter Maximum number of iterations of the optimization algorithm.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> */<a name="line.46"></a>
+<span class="sourceLineNo">047</span> private SimpleCurveFitter(ParametricUnivariateFunction function,<a name="line.47"></a>
+<span class="sourceLineNo">048</span> double[] initialGuess,<a name="line.48"></a>
+<span class="sourceLineNo">049</span> int maxIter) {<a name="line.49"></a>
+<span class="sourceLineNo">050</span> this.function = function;<a name="line.50"></a>
+<span class="sourceLineNo">051</span> this.initialGuess = initialGuess;<a name="line.51"></a>
+<span class="sourceLineNo">052</span> this.maxIter = maxIter;<a name="line.52"></a>
+<span class="sourceLineNo">053</span> }<a name="line.53"></a>
+<span class="sourceLineNo">054</span><a name="line.54"></a>
+<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * Creates a curve fitter.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * The maximum number of iterations of the optimization algorithm is set<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * to {@link Integer#MAX_VALUE}.<a name="line.58"></a>
+<span class="sourceLineNo">059</span> *<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * @param f Function to fit.<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * @param start Initial guess for the parameters. Cannot be {@code null}.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * Its length must be consistent with the number of parameters of the<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * function to fit.<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * @return a curve fitter.<a name="line.64"></a>
+<span class="sourceLineNo">065</span> *<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * @see #withStartPoint(double[])<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * @see #withMaxIterations(int)<a name="line.67"></a>
+<span class="sourceLineNo">068</span> */<a name="line.68"></a>
+<span class="sourceLineNo">069</span> public static SimpleCurveFitter create(ParametricUnivariateFunction f,<a name="line.69"></a>
+<span class="sourceLineNo">070</span> double[] start) {<a name="line.70"></a>
+<span class="sourceLineNo">071</span> return new SimpleCurveFitter(f, start, Integer.MAX_VALUE);<a name="line.71"></a>
+<span class="sourceLineNo">072</span> }<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> * Configure the start point (initial guess).<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * @param newStart new start point (initial guess)<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * @return a new instance.<a name="line.77"></a>
+<span class="sourceLineNo">078</span> */<a name="line.78"></a>
+<span class="sourceLineNo">079</span> public SimpleCurveFitter withStartPoint(double[] newStart) {<a name="line.79"></a>
+<span class="sourceLineNo">080</span> return new SimpleCurveFitter(function,<a name="line.80"></a>
+<span class="sourceLineNo">081</span> newStart.clone(),<a name="line.81"></a>
+<span class="sourceLineNo">082</span> maxIter);<a name="line.82"></a>
+<span class="sourceLineNo">083</span> }<a name="line.83"></a>
+<span class="sourceLineNo">084</span><a name="line.84"></a>
+<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * Configure the maximum number of iterations.<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * @param newMaxIter maximum number of iterations<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * @return a new instance.<a name="line.88"></a>
+<span class="sourceLineNo">089</span> */<a name="line.89"></a>
+<span class="sourceLineNo">090</span> public SimpleCurveFitter withMaxIterations(int newMaxIter) {<a name="line.90"></a>
+<span class="sourceLineNo">091</span> return new SimpleCurveFitter(function,<a name="line.91"></a>
+<span class="sourceLineNo">092</span> initialGuess,<a name="line.92"></a>
+<span class="sourceLineNo">093</span> newMaxIter);<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> /** {@inheritDoc} */<a name="line.96"></a>
+<span class="sourceLineNo">097</span> @Override<a name="line.97"></a>
+<span class="sourceLineNo">098</span> protected LeastSquaresProblem getProblem(Collection<WeightedObservedPoint> observations) {<a name="line.98"></a>
+<span class="sourceLineNo">099</span> // Prepare least-squares problem.<a name="line.99"></a>
+<span class="sourceLineNo">100</span> final int len = observations.size();<a name="line.100"></a>
+<span class="sourceLineNo">101</span> final double[] target = new double[len];<a name="line.101"></a>
+<span class="sourceLineNo">102</span> final double[] weights = new double[len];<a name="line.102"></a>
+<span class="sourceLineNo">103</span><a name="line.103"></a>
+<span class="sourceLineNo">104</span> int count = 0;<a name="line.104"></a>
+<span class="sourceLineNo">105</span> for (WeightedObservedPoint obs : observations) {<a name="line.105"></a>
+<span class="sourceLineNo">106</span> target[count] = obs.getY();<a name="line.106"></a>
+<span class="sourceLineNo">107</span> weights[count] = obs.getWeight();<a name="line.107"></a>
+<span class="sourceLineNo">108</span> ++count;<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> final AbstractCurveFitter.TheoreticalValuesFunction model<a name="line.111"></a>
+<span class="sourceLineNo">112</span> = new AbstractCurveFitter.TheoreticalValuesFunction(function,<a name="line.112"></a>
+<span class="sourceLineNo">113</span> observations);<a name="line.113"></a>
+<span class="sourceLineNo">114</span><a name="line.114"></a>
+<span class="sourceLineNo">115</span> // Create an optimizer for fitting the curve to the observed points.<a name="line.115"></a>
+<span class="sourceLineNo">116</span> return new LeastSquaresBuilder().<a name="line.116"></a>
+<span class="sourceLineNo">117</span> maxEvaluations(Integer.MAX_VALUE).<a name="line.117"></a>
+<span class="sourceLineNo">118</span> maxIterations(maxIter).<a name="line.118"></a>
+<span class="sourceLineNo">119</span> start(initialGuess).<a name="line.119"></a>
+<span class="sourceLineNo">120</span> target(target).<a name="line.120"></a>
+<span class="sourceLineNo">121</span> weight(new DiagonalMatrix(weights)).<a name="line.121"></a>
+<span class="sourceLineNo">122</span> model(model.getModelFunction(), model.getModelFunctionJacobian()).<a name="line.122"></a>
+<span class="sourceLineNo">123</span> build();<a name="line.123"></a>
+<span class="sourceLineNo">124</span> }<a name="line.124"></a>
+<span class="sourceLineNo">125</span>}<a name="line.125"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/SimpleCurveFitter.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ParameterValidator.html
==============================================================================
--- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ParameterValidator.html (added)
+++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ParameterValidator.html Tue Dec 30 17:15:36 2014
@@ -0,0 +1,106 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<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.RealVector;<a name="line.19"></a>
+<span class="sourceLineNo">020</span><a name="line.20"></a>
+<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * Interface for validating a set of model parameters.<a name="line.22"></a>
+<span class="sourceLineNo">023</span> *<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * @since 3.4<a name="line.24"></a>
+<span class="sourceLineNo">025</span> */<a name="line.25"></a>
+<span class="sourceLineNo">026</span>public interface ParameterValidator {<a name="line.26"></a>
+<span class="sourceLineNo">027</span> /**<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * Validates the set of parameters.<a name="line.28"></a>
+<span class="sourceLineNo">029</span> *<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * @param params Input parameters.<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * @return the validated values.<a name="line.31"></a>
+<span class="sourceLineNo">032</span> */<a name="line.32"></a>
+<span class="sourceLineNo">033</span> RealVector validate(RealVector params);<a name="line.33"></a>
+<span class="sourceLineNo">034</span>}<a name="line.34"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
Propchange: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/fitting/leastsquares/ParameterValidator.html
------------------------------------------------------------------------------
svn:eol-style = native