Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/estimation/WeightedMeasurement.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> <a name="line.17"></a> <FONT color="green">018</FONT> package org.apache.commons.math.estimation;<a name="line.18"></a> <FONT color="green">019</FONT> <a name="line.19"></a> <FONT color="green">020</FONT> import java.io.Serializable;<a name="line.20"></a> <FONT color="green">021</FONT> <a name="line.21"></a> <FONT color="green">022</FONT> /**<a name="line.22"></a> <FONT color="green">023</FONT> * This class represents measurements in estimation problems.<a name="line.23"></a> <FONT color="green">024</FONT> *<a name="line.24"></a> <FONT color="green">025</FONT> * <p>This abstract class implements all the methods needed to handle<a name="line.25"></a> <FONT color="green">026</FONT> * measurements in a general way. It defines neither the {@link<a name="line.26"></a> <FONT color="green">027</FONT> * #getTheoreticalValue getTheoreticalValue} nor the {@link<a name="line.27"></a> <FONT color="green">028</FONT> * #getPartial getPartial} methods, which should be defined by<a name="line.28"></a> <FONT color="green">029</FONT> * sub-classes according to the specific problem.</p><a name="line.29"></a> <FONT color="green">030</FONT> *<a name="line.30"></a> <FONT color="green">031</FONT> * <p>The {@link #getTheoreticalValue getTheoreticalValue} and {@link<a name="line.31"></a> <FONT color="green">032</FONT> * #getPartial getPartial} methods must always use the current<a name="line.32"></a> <FONT color="green">033</FONT> * estimate of the parameters set by the solver in the problem. These<a name="line.33"></a> <FONT color="green">034</FONT> * parameters can be retrieved through the {@link<a name="line.34"></a> <FONT color="green">035</FONT> * EstimationProblem#getAllParameters<a name="line.35"></a> <FONT color="green">036</FONT> * EstimationProblem.getAllParameters} method if the measurements are<a name="line.36"></a> <FONT color="green">037</FONT> * independent of the problem, or directly if they are implemented as<a name="line.37"></a> <FONT color="green">038</FONT> * inner classes of the problem.</p><a name="line.38"></a> <FONT color="green">039</FONT> *<a name="line.39"></a> <FONT color="green">040</FONT> * <p>The instances for which the <code>ignored</code> flag is set<a name="line.40"></a> <FONT color="green">041</FONT> * through the {@link #setIgnored setIgnored} method are ignored by the<a name="line.41"></a> <FONT color="green">042</FONT> * solvers. This can be used to reject wrong measurements at some<a name="line.42"></a> <FONT color="green">043</FONT> * steps of the estimation.</p><a name="line.43"></a> <FONT color="green">044</FONT> *<a name="line.44"></a> <FONT color="green">045</FONT> * @see EstimationProblem<a name="line.45"></a> <FONT color="green">046</FONT> *<a name="line.46"></a> <FONT color="green">047</FONT> * @version $Revision: 811827 $ $Date: 2009-09-06 11:32:50 -0400 (Sun, 06 Sep 2009) $<a name="line.47"></a> <FONT color="green">048</FONT> * @since 1.2<a name="line.48"></a> <FONT color="green">049</FONT> * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has<a name="line.49"></a> <FONT color="green">050</FONT> * been deprecated and replaced by package org.apache.commons.math.optimization.general<a name="line.50"></a> <FONT color="green">051</FONT> */<a name="line.51"></a> <FONT color="green">052</FONT> <a name="line.52"></a> <FONT color="green">053</FONT> @Deprecated<a name="line.53"></a> <FONT color="green">054</FONT> public abstract class WeightedMeasurement implements Serializable {<a name="line.54"></a> <FONT color="green">055</FONT> <a name="line.55"></a> <FONT color="green">056</FONT> /** Serializable version identifier. */<a name="line.56"></a> <FONT color="green">057</FONT> private static final long serialVersionUID = 4360046376796901941L;<a name="line.57"></a> <FONT color="green">058</FONT> <a name="line.58"></a> <FONT color="green">059</FONT> /** Measurement weight. */<a name="line.59"></a> <FONT color="green">060</FONT> private final double weight;<a name="line.60"></a> <FONT color="green">061</FONT> <a name="line.61"></a> <FONT color="green">062</FONT> /** Value of the measurements. */<a name="line.62"></a> <FONT color="green">063</FONT> private final double measuredValue;<a name="line.63"></a> <FONT color="green">064</FONT> <a name="line.64"></a> <FONT color="green">065</FONT> /** Ignore measurement indicator. */<a name="line.65"></a> <FONT color="green">066</FONT> private boolean ignored;<a name="line.66"></a> <FONT color="green">067</FONT> <a name="line.67"></a> <FONT color="green">068</FONT> /**<a name="line.68"></a> <FONT color="green">069</FONT> * Simple constructor.<a name="line.69"></a> <FONT color="green">070</FONT> * Build a measurement with the given parameters, and set its ignore<a name="line.70"></a> <FONT color="green">071</FONT> * flag to false.<a name="line.71"></a> <FONT color="green">072</FONT> * @param weight weight of the measurement in the least squares problem<a name="line.72"></a> <FONT color="green">073</FONT> * (two common choices are either to use 1.0 for all measurements, or to<a name="line.73"></a> <FONT color="green">074</FONT> * use a value proportional to the inverse of the variance of the measurement<a name="line.74"></a> <FONT color="green">075</FONT> * type)<a name="line.75"></a> <FONT color="green">076</FONT> *<a name="line.76"></a> <FONT color="green">077</FONT> * @param measuredValue measured value<a name="line.77"></a> <FONT color="green">078</FONT> */<a name="line.78"></a> <FONT color="green">079</FONT> public WeightedMeasurement(double weight, double measuredValue) {<a name="line.79"></a> <FONT color="green">080</FONT> this.weight = weight;<a name="line.80"></a> <FONT color="green">081</FONT> this.measuredValue = measuredValue;<a name="line.81"></a> <FONT color="green">082</FONT> ignored = false;<a name="line.82"></a> <FONT color="green">083</FONT> }<a name="line.83"></a> <FONT color="green">084</FONT> <a name="line.84"></a> <FONT color="green">085</FONT> /** Simple constructor.<a name="line.85"></a> <FONT color="green">086</FONT> *<a name="line.86"></a> <FONT color="green">087</FONT> * Build a measurement with the given parameters<a name="line.87"></a> <FONT color="green">088</FONT> *<a name="line.88"></a> <FONT color="green">089</FONT> * @param weight weight of the measurement in the least squares problem<a name="line.89"></a> <FONT color="green">090</FONT> * @param measuredValue measured value<a name="line.90"></a> <FONT color="green">091</FONT> * @param ignored true if the measurement should be ignored<a name="line.91"></a> <FONT color="green">092</FONT> */<a name="line.92"></a> <FONT color="green">093</FONT> public WeightedMeasurement(double weight, double measuredValue,<a name="line.93"></a> <FONT color="green">094</FONT> boolean ignored) {<a name="line.94"></a> <FONT color="green">095</FONT> this.weight = weight;<a name="line.95"></a> <FONT color="green">096</FONT> this.measuredValue = measuredValue;<a name="line.96"></a> <FONT color="green">097</FONT> this.ignored = ignored;<a name="line.97"></a> <FONT color="green">098</FONT> }<a name="line.98"></a> <FONT color="green">099</FONT> <a name="line.99"></a> <FONT color="green">100</FONT> /**<a name="line.100"></a> <FONT color="green">101</FONT> * Get the weight of the measurement in the least squares problem<a name="line.101"></a> <FONT color="green">102</FONT> *<a name="line.102"></a> <FONT color="green">103</FONT> * @return weight<a name="line.103"></a> <FONT color="green">104</FONT> */<a name="line.104"></a> <FONT color="green">105</FONT> public double getWeight() {<a name="line.105"></a> <FONT color="green">106</FONT> return weight;<a name="line.106"></a> <FONT color="green">107</FONT> }<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 measured value<a name="line.110"></a> <FONT color="green">111</FONT> *<a name="line.111"></a> <FONT color="green">112</FONT> * @return measured value<a name="line.112"></a> <FONT color="green">113</FONT> */<a name="line.113"></a> <FONT color="green">114</FONT> public double getMeasuredValue() {<a name="line.114"></a> <FONT color="green">115</FONT> return measuredValue;<a name="line.115"></a> <FONT color="green">116</FONT> }<a name="line.116"></a> <FONT color="green">117</FONT> <a name="line.117"></a> <FONT color="green">118</FONT> /**<a name="line.118"></a> <FONT color="green">119</FONT> * Get the residual for this measurement<a name="line.119"></a> <FONT color="green">120</FONT> * The residual is the measured value minus the theoretical value.<a name="line.120"></a> <FONT color="green">121</FONT> *<a name="line.121"></a> <FONT color="green">122</FONT> * @return residual<a name="line.122"></a> <FONT color="green">123</FONT> */<a name="line.123"></a> <FONT color="green">124</FONT> public double getResidual() {<a name="line.124"></a> <FONT color="green">125</FONT> return measuredValue - getTheoreticalValue();<a name="line.125"></a> <FONT color="green">126</FONT> }<a name="line.126"></a> <FONT color="green">127</FONT> <a name="line.127"></a> <FONT color="green">128</FONT> /**<a name="line.128"></a> <FONT color="green">129</FONT> * Get the theoretical value expected for this measurement<a name="line.129"></a> <FONT color="green">130</FONT> * <p>The theoretical value is the value expected for this measurement<a name="line.130"></a> <FONT color="green">131</FONT> * if the model and its parameter were all perfectly known.</p><a name="line.131"></a> <FONT color="green">132</FONT> * <p>The value must be computed using the current estimate of the parameters<a name="line.132"></a> <FONT color="green">133</FONT> * set by the solver in the problem.</p><a name="line.133"></a> <FONT color="green">134</FONT> *<a name="line.134"></a> <FONT color="green">135</FONT> * @return theoretical value<a name="line.135"></a> <FONT color="green">136</FONT> */<a name="line.136"></a> <FONT color="green">137</FONT> public abstract double getTheoreticalValue();<a name="line.137"></a> <FONT color="green">138</FONT> <a name="line.138"></a> <FONT color="green">139</FONT> /**<a name="line.139"></a> <FONT color="green">140</FONT> * Get the partial derivative of the {@link #getTheoreticalValue<a name="line.140"></a> <FONT color="green">141</FONT> * theoretical value} according to the parameter.<a name="line.141"></a> <FONT color="green">142</FONT> * <p>The value must be computed using the current estimate of the parameters<a name="line.142"></a> <FONT color="green">143</FONT> * set by the solver in the problem.</p><a name="line.143"></a> <FONT color="green">144</FONT> *<a name="line.144"></a> <FONT color="green">145</FONT> * @param parameter parameter against which the partial derivative<a name="line.145"></a> <FONT color="green">146</FONT> * should be computed<a name="line.146"></a> <FONT color="green">147</FONT> * @return partial derivative of the {@link #getTheoreticalValue<a name="line.147"></a> <FONT color="green">148</FONT> * theoretical value}<a name="line.148"></a> <FONT color="green">149</FONT> */<a name="line.149"></a> <FONT color="green">150</FONT> public abstract double getPartial(EstimatedParameter parameter);<a name="line.150"></a> <FONT color="green">151</FONT> <a name="line.151"></a> <FONT color="green">152</FONT> /**<a name="line.152"></a> <FONT color="green">153</FONT> * Set the ignore flag to the specified value<a name="line.153"></a> <FONT color="green">154</FONT> * Setting the ignore flag to true allow to reject wrong<a name="line.154"></a> <FONT color="green">155</FONT> * measurements, which sometimes can be detected only rather late.<a name="line.155"></a> <FONT color="green">156</FONT> *<a name="line.156"></a> <FONT color="green">157</FONT> * @param ignored value for the ignore flag<a name="line.157"></a> <FONT color="green">158</FONT> */<a name="line.158"></a> <FONT color="green">159</FONT> public void setIgnored(boolean ignored) {<a name="line.159"></a> <FONT color="green">160</FONT> this.ignored = ignored;<a name="line.160"></a> <FONT color="green">161</FONT> }<a name="line.161"></a> <FONT color="green">162</FONT> <a name="line.162"></a> <FONT color="green">163</FONT> /**<a name="line.163"></a> <FONT color="green">164</FONT> * Check if this measurement should be ignored<a name="line.164"></a> <FONT color="green">165</FONT> *<a name="line.165"></a> <FONT color="green">166</FONT> * @return true if the measurement should be ignored<a name="line.166"></a> <FONT color="green">167</FONT> */<a name="line.167"></a> <FONT color="green">168</FONT> public boolean isIgnored() {<a name="line.168"></a> <FONT color="green">169</FONT> return ignored;<a name="line.169"></a> <FONT color="green">170</FONT> }<a name="line.170"></a> <FONT color="green">171</FONT> <a name="line.171"></a> <FONT color="green">172</FONT> }<a name="line.172"></a> </PRE> </BODY> </HTML>