Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/util/DoubleArray.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.util;<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> * Provides a standard interface for double arrays. Allows different<a name="line.21"></a> <FONT color="green">022</FONT> * array implementations to support various storage mechanisms<a name="line.22"></a> <FONT color="green">023</FONT> * such as automatic expansion, contraction, and array "rolling".<a name="line.23"></a> <FONT color="green">024</FONT> *<a name="line.24"></a> <FONT color="green">025</FONT> * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $<a name="line.25"></a> <FONT color="green">026</FONT> */<a name="line.26"></a> <FONT color="green">027</FONT> public interface DoubleArray {<a name="line.27"></a> <FONT color="green">028</FONT> <a name="line.28"></a> <FONT color="green">029</FONT> /**<a name="line.29"></a> <FONT color="green">030</FONT> * Returns the number of elements currently in the array. Please note<a name="line.30"></a> <FONT color="green">031</FONT> * that this may be different from the length of the internal storage array.<a name="line.31"></a> <FONT color="green">032</FONT> *<a name="line.32"></a> <FONT color="green">033</FONT> * @return number of elements<a name="line.33"></a> <FONT color="green">034</FONT> */<a name="line.34"></a> <FONT color="green">035</FONT> int getNumElements();<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> * Returns the element at the specified index. Note that if an<a name="line.38"></a> <FONT color="green">039</FONT> * out of bounds index is supplied a ArrayIndexOutOfBoundsException<a name="line.39"></a> <FONT color="green">040</FONT> * will be thrown.<a name="line.40"></a> <FONT color="green">041</FONT> *<a name="line.41"></a> <FONT color="green">042</FONT> * @param index index to fetch a value from<a name="line.42"></a> <FONT color="green">043</FONT> * @return value stored at the specified index<a name="line.43"></a> <FONT color="green">044</FONT> * @throws ArrayIndexOutOfBoundsException if <code>index</code> is less than<a name="line.44"></a> <FONT color="green">045</FONT> * zero or is greater than <code>getNumElements() - 1</code>.<a name="line.45"></a> <FONT color="green">046</FONT> */<a name="line.46"></a> <FONT color="green">047</FONT> double getElement(int index);<a name="line.47"></a> <FONT color="green">048</FONT> <a name="line.48"></a> <FONT color="green">049</FONT> /**<a name="line.49"></a> <FONT color="green">050</FONT> * Sets the element at the specified index. If the specified index is greater than<a name="line.50"></a> <FONT color="green">051</FONT> * <code>getNumElements() - 1</code>, the <code>numElements</code> property<a name="line.51"></a> <FONT color="green">052</FONT> * is increased to <code>index +1</code> and additional storage is allocated<a name="line.52"></a> <FONT color="green">053</FONT> * (if necessary) for the new element and all (uninitialized) elements<a name="line.53"></a> <FONT color="green">054</FONT> * between the new element and the previous end of the array).<a name="line.54"></a> <FONT color="green">055</FONT> *<a name="line.55"></a> <FONT color="green">056</FONT> * @param index index to store a value in<a name="line.56"></a> <FONT color="green">057</FONT> * @param value value to store at the specified index<a name="line.57"></a> <FONT color="green">058</FONT> * @throws ArrayIndexOutOfBoundsException if <code>index</code> is less than<a name="line.58"></a> <FONT color="green">059</FONT> * zero.<a name="line.59"></a> <FONT color="green">060</FONT> */<a name="line.60"></a> <FONT color="green">061</FONT> void setElement(int index, double value);<a name="line.61"></a> <FONT color="green">062</FONT> <a name="line.62"></a> <FONT color="green">063</FONT> /**<a name="line.63"></a> <FONT color="green">064</FONT> * Adds an element to the end of this expandable array<a name="line.64"></a> <FONT color="green">065</FONT> *<a name="line.65"></a> <FONT color="green">066</FONT> * @param value to be added to end of array<a name="line.66"></a> <FONT color="green">067</FONT> */<a name="line.67"></a> <FONT color="green">068</FONT> void addElement(double value);<a name="line.68"></a> <FONT color="green">069</FONT> <a name="line.69"></a> <FONT color="green">070</FONT> /**<a name="line.70"></a> <FONT color="green">071</FONT> * <p><a name="line.71"></a> <FONT color="green">072</FONT> * Adds an element to the end of the array and removes the first<a name="line.72"></a> <FONT color="green">073</FONT> * element in the array. Returns the discarded first element.<a name="line.73"></a> <FONT color="green">074</FONT> * The effect is similar to a push operation in a FIFO queue.<a name="line.74"></a> <FONT color="green">075</FONT> * </p><a name="line.75"></a> <FONT color="green">076</FONT> * <p><a name="line.76"></a> <FONT color="green">077</FONT> * Example: If the array contains the elements 1, 2, 3, 4 (in that order)<a name="line.77"></a> <FONT color="green">078</FONT> * and addElementRolling(5) is invoked, the result is an array containing<a name="line.78"></a> <FONT color="green">079</FONT> * the entries 2, 3, 4, 5 and the value returned is 1.<a name="line.79"></a> <FONT color="green">080</FONT> * </p><a name="line.80"></a> <FONT color="green">081</FONT> *<a name="line.81"></a> <FONT color="green">082</FONT> * @param value the value to be added to the array<a name="line.82"></a> <FONT color="green">083</FONT> * @return the value which has been discarded or "pushed" out of the array<a name="line.83"></a> <FONT color="green">084</FONT> * by this rolling insert<a name="line.84"></a> <FONT color="green">085</FONT> */<a name="line.85"></a> <FONT color="green">086</FONT> double addElementRolling(double value);<a name="line.86"></a> <FONT color="green">087</FONT> <a name="line.87"></a> <FONT color="green">088</FONT> /**<a name="line.88"></a> <FONT color="green">089</FONT> * Returns a double[] array containing the elements of this<a name="line.89"></a> <FONT color="green">090</FONT> * <code>DoubleArray</code>. If the underlying implementation is<a name="line.90"></a> <FONT color="green">091</FONT> * array-based, this method should always return a copy, rather than a<a name="line.91"></a> <FONT color="green">092</FONT> * reference to the underlying array so that changes made to the returned<a name="line.92"></a> <FONT color="green">093</FONT> * array have no effect on the <code>DoubleArray.</code><a name="line.93"></a> <FONT color="green">094</FONT> *<a name="line.94"></a> <FONT color="green">095</FONT> * @return all elements added to the array<a name="line.95"></a> <FONT color="green">096</FONT> */<a name="line.96"></a> <FONT color="green">097</FONT> double[] getElements();<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> * Clear the double array<a name="line.100"></a> <FONT color="green">101</FONT> */<a name="line.101"></a> <FONT color="green">102</FONT> void clear();<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> </PRE> </BODY> </HTML>