Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.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.stat.descriptive;<a name="line.17"></a> <FONT color="green">018</FONT> <a name="line.18"></a> <FONT color="green">019</FONT> import org.apache.commons.math.MathRuntimeException;<a name="line.19"></a> <FONT color="green">020</FONT> <a name="line.20"></a> <FONT color="green">021</FONT> /**<a name="line.21"></a> <FONT color="green">022</FONT> * Abstract base class for all implementations of the<a name="line.22"></a> <FONT color="green">023</FONT> * {@link UnivariateStatistic} interface.<a name="line.23"></a> <FONT color="green">024</FONT> * <p><a name="line.24"></a> <FONT color="green">025</FONT> * Provides a default implementation of <code>evaluate(double[]),</code><a name="line.25"></a> <FONT color="green">026</FONT> * delegating to <code>evaluate(double[], int, int)</code> in the natural way.<a name="line.26"></a> <FONT color="green">027</FONT> * </p><a name="line.27"></a> <FONT color="green">028</FONT> * <p><a name="line.28"></a> <FONT color="green">029</FONT> * Also includes a <code>test</code> method that performs generic parameter<a name="line.29"></a> <FONT color="green">030</FONT> * validation for the <code>evaluate</code> methods.</p><a name="line.30"></a> <FONT color="green">031</FONT> *<a name="line.31"></a> <FONT color="green">032</FONT> * @version $Revision: 894705 $ $Date: 2009-12-30 15:24:54 -0500 (Wed, 30 Dec 2009) $<a name="line.32"></a> <FONT color="green">033</FONT> */<a name="line.33"></a> <FONT color="green">034</FONT> public abstract class AbstractUnivariateStatistic<a name="line.34"></a> <FONT color="green">035</FONT> implements UnivariateStatistic {<a name="line.35"></a> <FONT color="green">036</FONT> <a name="line.36"></a> <FONT color="green">037</FONT> /**<a name="line.37"></a> <FONT color="green">038</FONT> * {@inheritDoc}<a name="line.38"></a> <FONT color="green">039</FONT> */<a name="line.39"></a> <FONT color="green">040</FONT> public double evaluate(final double[] values) {<a name="line.40"></a> <FONT color="green">041</FONT> test(values, 0, 0);<a name="line.41"></a> <FONT color="green">042</FONT> return evaluate(values, 0, values.length);<a name="line.42"></a> <FONT color="green">043</FONT> }<a name="line.43"></a> <FONT color="green">044</FONT> <a name="line.44"></a> <FONT color="green">045</FONT> /**<a name="line.45"></a> <FONT color="green">046</FONT> * {@inheritDoc}<a name="line.46"></a> <FONT color="green">047</FONT> */<a name="line.47"></a> <FONT color="green">048</FONT> public abstract double evaluate(final double[] values, final int begin, final int length);<a name="line.48"></a> <FONT color="green">049</FONT> <a name="line.49"></a> <FONT color="green">050</FONT> /**<a name="line.50"></a> <FONT color="green">051</FONT> * {@inheritDoc}<a name="line.51"></a> <FONT color="green">052</FONT> */<a name="line.52"></a> <FONT color="green">053</FONT> public abstract UnivariateStatistic copy();<a name="line.53"></a> <FONT color="green">054</FONT> <a name="line.54"></a> <FONT color="green">055</FONT> /**<a name="line.55"></a> <FONT color="green">056</FONT> * This method is used by <code>evaluate(double[], int, int)</code> methods<a name="line.56"></a> <FONT color="green">057</FONT> * to verify that the input parameters designate a subarray of positive length.<a name="line.57"></a> <FONT color="green">058</FONT> * <p><a name="line.58"></a> <FONT color="green">059</FONT> * <ul><a name="line.59"></a> <FONT color="green">060</FONT> * <li>returns <code>true</code> iff the parameters designate a subarray of<a name="line.60"></a> <FONT color="green">061</FONT> * positive length</li><a name="line.61"></a> <FONT color="green">062</FONT> * <li>throws <code>IllegalArgumentException</code> if the array is null or<a name="line.62"></a> <FONT color="green">063</FONT> * or the indices are invalid</li><a name="line.63"></a> <FONT color="green">064</FONT> * <li>returns <code>false</li> if the array is non-null, but<a name="line.64"></a> <FONT color="green">065</FONT> * <code>length</code> is 0.<a name="line.65"></a> <FONT color="green">066</FONT> * </ul></p><a name="line.66"></a> <FONT color="green">067</FONT> *<a name="line.67"></a> <FONT color="green">068</FONT> * @param values the input array<a name="line.68"></a> <FONT color="green">069</FONT> * @param begin index of the first array element to include<a name="line.69"></a> <FONT color="green">070</FONT> * @param length the number of elements to include<a name="line.70"></a> <FONT color="green">071</FONT> * @return true if the parameters are valid and designate a subarray of positive length<a name="line.71"></a> <FONT color="green">072</FONT> * @throws IllegalArgumentException if the indices are invalid or the array is null<a name="line.72"></a> <FONT color="green">073</FONT> */<a name="line.73"></a> <FONT color="green">074</FONT> protected boolean test(<a name="line.74"></a> <FONT color="green">075</FONT> final double[] values,<a name="line.75"></a> <FONT color="green">076</FONT> final int begin,<a name="line.76"></a> <FONT color="green">077</FONT> final int length) {<a name="line.77"></a> <FONT color="green">078</FONT> <a name="line.78"></a> <FONT color="green">079</FONT> if (values == null) {<a name="line.79"></a> <FONT color="green">080</FONT> throw MathRuntimeException.createIllegalArgumentException("input values array is null");<a name="line.80"></a> <FONT color="green">081</FONT> }<a name="line.81"></a> <FONT color="green">082</FONT> <a name="line.82"></a> <FONT color="green">083</FONT> if (begin < 0) {<a name="line.83"></a> <FONT color="green">084</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.84"></a> <FONT color="green">085</FONT> "start position cannot be negative ({0})", begin);<a name="line.85"></a> <FONT color="green">086</FONT> }<a name="line.86"></a> <FONT color="green">087</FONT> <a name="line.87"></a> <FONT color="green">088</FONT> if (length < 0) {<a name="line.88"></a> <FONT color="green">089</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.89"></a> <FONT color="green">090</FONT> "length cannot be negative ({0})", length);<a name="line.90"></a> <FONT color="green">091</FONT> }<a name="line.91"></a> <FONT color="green">092</FONT> <a name="line.92"></a> <FONT color="green">093</FONT> if (begin + length > values.length) {<a name="line.93"></a> <FONT color="green">094</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.94"></a> <FONT color="green">095</FONT> "subarray ends after array end");<a name="line.95"></a> <FONT color="green">096</FONT> }<a name="line.96"></a> <FONT color="green">097</FONT> <a name="line.97"></a> <FONT color="green">098</FONT> if (length == 0) {<a name="line.98"></a> <FONT color="green">099</FONT> return false;<a name="line.99"></a> <FONT color="green">100</FONT> }<a name="line.100"></a> <FONT color="green">101</FONT> <a name="line.101"></a> <FONT color="green">102</FONT> return true;<a name="line.102"></a> <FONT color="green">103</FONT> <a name="line.103"></a> <FONT color="green">104</FONT> }<a name="line.104"></a> <FONT color="green">105</FONT> <a name="line.105"></a> <FONT color="green">106</FONT> /**<a name="line.106"></a> <FONT color="green">107</FONT> * This method is used by <code>evaluate(double[], double[], int, int)</code> methods<a name="line.107"></a> <FONT color="green">108</FONT> * to verify that the begin and length parameters designate a subarray of positive length<a name="line.108"></a> <FONT color="green">109</FONT> * and the weights are all non-negative, non-NaN, finite, and not all zero.<a name="line.109"></a> <FONT color="green">110</FONT> * <p><a name="line.110"></a> <FONT color="green">111</FONT> * <ul><a name="line.111"></a> <FONT color="green">112</FONT> * <li>returns <code>true</code> iff the parameters designate a subarray of<a name="line.112"></a> <FONT color="green">113</FONT> * positive length and the weights array contains legitimate values.</li><a name="line.113"></a> <FONT color="green">114</FONT> * <li>throws <code>IllegalArgumentException</code> if any of the following are true:<a name="line.114"></a> <FONT color="green">115</FONT> * <ul><li>the values array is null</li><a name="line.115"></a> <FONT color="green">116</FONT> * <li>the weights array is null</li><a name="line.116"></a> <FONT color="green">117</FONT> * <li>the weights array does not have the same length as the values array</li><a name="line.117"></a> <FONT color="green">118</FONT> * <li>the weights array contains one or more infinite values</li><a name="line.118"></a> <FONT color="green">119</FONT> * <li>the weights array contains one or more NaN values</li><a name="line.119"></a> <FONT color="green">120</FONT> * <li>the weights array contains negative values</li><a name="line.120"></a> <FONT color="green">121</FONT> * <li>the start and length arguments do not determine a valid array</li></ul><a name="line.121"></a> <FONT color="green">122</FONT> * </li><a name="line.122"></a> <FONT color="green">123</FONT> * <li>returns <code>false</li> if the array is non-null, but<a name="line.123"></a> <FONT color="green">124</FONT> * <code>length</code> is 0.<a name="line.124"></a> <FONT color="green">125</FONT> * </ul></p><a name="line.125"></a> <FONT color="green">126</FONT> *<a name="line.126"></a> <FONT color="green">127</FONT> * @param values the input array<a name="line.127"></a> <FONT color="green">128</FONT> * @param weights the weights array<a name="line.128"></a> <FONT color="green">129</FONT> * @param begin index of the first array element to include<a name="line.129"></a> <FONT color="green">130</FONT> * @param length the number of elements to include<a name="line.130"></a> <FONT color="green">131</FONT> * @return true if the parameters are valid and designate a subarray of positive length<a name="line.131"></a> <FONT color="green">132</FONT> * @throws IllegalArgumentException if the indices are invalid or the array is null<a name="line.132"></a> <FONT color="green">133</FONT> * @since 2.1<a name="line.133"></a> <FONT color="green">134</FONT> */<a name="line.134"></a> <FONT color="green">135</FONT> protected boolean test(<a name="line.135"></a> <FONT color="green">136</FONT> final double[] values,<a name="line.136"></a> <FONT color="green">137</FONT> final double[] weights,<a name="line.137"></a> <FONT color="green">138</FONT> final int begin,<a name="line.138"></a> <FONT color="green">139</FONT> final int length) {<a name="line.139"></a> <FONT color="green">140</FONT> <a name="line.140"></a> <FONT color="green">141</FONT> if (weights == null) {<a name="line.141"></a> <FONT color="green">142</FONT> throw MathRuntimeException.createIllegalArgumentException("input weights array is null");<a name="line.142"></a> <FONT color="green">143</FONT> }<a name="line.143"></a> <FONT color="green">144</FONT> <a name="line.144"></a> <FONT color="green">145</FONT> if (weights.length != values.length) {<a name="line.145"></a> <FONT color="green">146</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.146"></a> <FONT color="green">147</FONT> "Different number of weights and values");<a name="line.147"></a> <FONT color="green">148</FONT> }<a name="line.148"></a> <FONT color="green">149</FONT> <a name="line.149"></a> <FONT color="green">150</FONT> boolean containsPositiveWeight = false;<a name="line.150"></a> <FONT color="green">151</FONT> for (int i = begin; i < begin + length; i++) {<a name="line.151"></a> <FONT color="green">152</FONT> if (Double.isNaN(weights[i])) {<a name="line.152"></a> <FONT color="green">153</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.153"></a> <FONT color="green">154</FONT> "NaN weight at index {0}", i);<a name="line.154"></a> <FONT color="green">155</FONT> }<a name="line.155"></a> <FONT color="green">156</FONT> if (Double.isInfinite(weights[i])) {<a name="line.156"></a> <FONT color="green">157</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.157"></a> <FONT color="green">158</FONT> "Infinite weight at index {0}", i);<a name="line.158"></a> <FONT color="green">159</FONT> }<a name="line.159"></a> <FONT color="green">160</FONT> if (weights[i] < 0) {<a name="line.160"></a> <FONT color="green">161</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.161"></a> <FONT color="green">162</FONT> "negative weight {0} at index {1} ", weights[i], i);<a name="line.162"></a> <FONT color="green">163</FONT> }<a name="line.163"></a> <FONT color="green">164</FONT> if (!containsPositiveWeight && weights[i] > 0.0) {<a name="line.164"></a> <FONT color="green">165</FONT> containsPositiveWeight = true;<a name="line.165"></a> <FONT color="green">166</FONT> }<a name="line.166"></a> <FONT color="green">167</FONT> }<a name="line.167"></a> <FONT color="green">168</FONT> <a name="line.168"></a> <FONT color="green">169</FONT> if (!containsPositiveWeight) {<a name="line.169"></a> <FONT color="green">170</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.170"></a> <FONT color="green">171</FONT> "weight array must contain at least one non-zero value");<a name="line.171"></a> <FONT color="green">172</FONT> }<a name="line.172"></a> <FONT color="green">173</FONT> <a name="line.173"></a> <FONT color="green">174</FONT> return test(values, begin, length);<a name="line.174"></a> <FONT color="green">175</FONT> }<a name="line.175"></a> <FONT color="green">176</FONT> }<a name="line.176"></a> <FONT color="green">177</FONT> <a name="line.177"></a> </PRE> </BODY> </HTML>