Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/linear/FieldVector.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.linear;<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.Field;<a name="line.19"></a> <FONT color="green">020</FONT> import org.apache.commons.math.FieldElement;<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> * Interface defining a field-valued vector with basic algebraic operations.<a name="line.23"></a> <FONT color="green">024</FONT> * <p><a name="line.24"></a> <FONT color="green">025</FONT> * vector element indexing is 0-based -- e.g., <code>getEntry(0)</code><a name="line.25"></a> <FONT color="green">026</FONT> * returns the first element of the vector.<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> * The various <code>mapXxx</code> and <code>mapXxxToSelf</code> methods operate<a name="line.29"></a> <FONT color="green">030</FONT> * on vectors element-wise, i.e. they perform the same operation (adding a scalar,<a name="line.30"></a> <FONT color="green">031</FONT> * applying a function ...) on each element in turn. The <code>mapXxx</code><a name="line.31"></a> <FONT color="green">032</FONT> * versions create a new vector to hold the result and do not change the instance.<a name="line.32"></a> <FONT color="green">033</FONT> * The <code>mapXxxToSelf</code> versions use the instance itself to store the<a name="line.33"></a> <FONT color="green">034</FONT> * results, so the instance is changed by these methods. In both cases, the result<a name="line.34"></a> <FONT color="green">035</FONT> * vector is returned by the methods, this allows to use the <i>fluent API</i><a name="line.35"></a> <FONT color="green">036</FONT> * style, like this:<a name="line.36"></a> <FONT color="green">037</FONT> * </p><a name="line.37"></a> <FONT color="green">038</FONT> * <pre><a name="line.38"></a> <FONT color="green">039</FONT> * RealVector result = v.mapAddToSelf(3.0).mapTanToSelf().mapSquareToSelf();<a name="line.39"></a> <FONT color="green">040</FONT> * </pre><a name="line.40"></a> <FONT color="green">041</FONT> *<a name="line.41"></a> <FONT color="green">042</FONT> * @param <T> the type of the field elements<a name="line.42"></a> <FONT color="green">043</FONT> * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $<a name="line.43"></a> <FONT color="green">044</FONT> * @since 2.0<a name="line.44"></a> <FONT color="green">045</FONT> */<a name="line.45"></a> <FONT color="green">046</FONT> public interface FieldVector<T extends FieldElement<T>> {<a name="line.46"></a> <FONT color="green">047</FONT> <a name="line.47"></a> <FONT color="green">048</FONT> /**<a name="line.48"></a> <FONT color="green">049</FONT> * Get the type of field elements of the vector.<a name="line.49"></a> <FONT color="green">050</FONT> * @return type of field elements of the vector<a name="line.50"></a> <FONT color="green">051</FONT> */<a name="line.51"></a> <FONT color="green">052</FONT> Field<T> getField();<a name="line.52"></a> <FONT color="green">053</FONT> <a name="line.53"></a> <FONT color="green">054</FONT> /**<a name="line.54"></a> <FONT color="green">055</FONT> * Returns a (deep) copy of this.<a name="line.55"></a> <FONT color="green">056</FONT> * @return vector copy<a name="line.56"></a> <FONT color="green">057</FONT> */<a name="line.57"></a> <FONT color="green">058</FONT> FieldVector<T> copy();<a name="line.58"></a> <FONT color="green">059</FONT> <a name="line.59"></a> <FONT color="green">060</FONT> /**<a name="line.60"></a> <FONT color="green">061</FONT> * Compute the sum of this and v.<a name="line.61"></a> <FONT color="green">062</FONT> * @param v vector to be added<a name="line.62"></a> <FONT color="green">063</FONT> * @return this + v<a name="line.63"></a> <FONT color="green">064</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.64"></a> <FONT color="green">065</FONT> */<a name="line.65"></a> <FONT color="green">066</FONT> FieldVector<T> add(FieldVector<T> v)<a name="line.66"></a> <FONT color="green">067</FONT> throws IllegalArgumentException;<a name="line.67"></a> <FONT color="green">068</FONT> <a name="line.68"></a> <FONT color="green">069</FONT> /**<a name="line.69"></a> <FONT color="green">070</FONT> * Compute the sum of this and v.<a name="line.70"></a> <FONT color="green">071</FONT> * @param v vector to be added<a name="line.71"></a> <FONT color="green">072</FONT> * @return this + v<a name="line.72"></a> <FONT color="green">073</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.73"></a> <FONT color="green">074</FONT> */<a name="line.74"></a> <FONT color="green">075</FONT> FieldVector<T> add(T[] v)<a name="line.75"></a> <FONT color="green">076</FONT> throws IllegalArgumentException;<a name="line.76"></a> <FONT color="green">077</FONT> <a name="line.77"></a> <FONT color="green">078</FONT> /**<a name="line.78"></a> <FONT color="green">079</FONT> * Compute this minus v.<a name="line.79"></a> <FONT color="green">080</FONT> * @param v vector to be subtracted<a name="line.80"></a> <FONT color="green">081</FONT> * @return this + v<a name="line.81"></a> <FONT color="green">082</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.82"></a> <FONT color="green">083</FONT> */<a name="line.83"></a> <FONT color="green">084</FONT> FieldVector<T> subtract(FieldVector<T> v)<a name="line.84"></a> <FONT color="green">085</FONT> throws IllegalArgumentException;<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> * Compute this minus v.<a name="line.88"></a> <FONT color="green">089</FONT> * @param v vector to be subtracted<a name="line.89"></a> <FONT color="green">090</FONT> * @return this + v<a name="line.90"></a> <FONT color="green">091</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.91"></a> <FONT color="green">092</FONT> */<a name="line.92"></a> <FONT color="green">093</FONT> FieldVector<T> subtract(T[] v)<a name="line.93"></a> <FONT color="green">094</FONT> throws IllegalArgumentException;<a name="line.94"></a> <FONT color="green">095</FONT> <a name="line.95"></a> <FONT color="green">096</FONT> /**<a name="line.96"></a> <FONT color="green">097</FONT> * Map an addition operation to each entry.<a name="line.97"></a> <FONT color="green">098</FONT> * @param d value to be added to each entry<a name="line.98"></a> <FONT color="green">099</FONT> * @return this + d<a name="line.99"></a> <FONT color="green">100</FONT> */<a name="line.100"></a> <FONT color="green">101</FONT> FieldVector<T> mapAdd(T d);<a name="line.101"></a> <FONT color="green">102</FONT> <a name="line.102"></a> <FONT color="green">103</FONT> /**<a name="line.103"></a> <FONT color="green">104</FONT> * Map an addition operation to each entry.<a name="line.104"></a> <FONT color="green">105</FONT> * <p>The instance <strong>is</strong> changed by this method.</p><a name="line.105"></a> <FONT color="green">106</FONT> * @param d value to be added to each entry<a name="line.106"></a> <FONT color="green">107</FONT> * @return for convenience, return this<a name="line.107"></a> <FONT color="green">108</FONT> */<a name="line.108"></a> <FONT color="green">109</FONT> FieldVector<T> mapAddToSelf(T d);<a name="line.109"></a> <FONT color="green">110</FONT> <a name="line.110"></a> <FONT color="green">111</FONT> /**<a name="line.111"></a> <FONT color="green">112</FONT> * Map a subtraction operation to each entry.<a name="line.112"></a> <FONT color="green">113</FONT> * @param d value to be subtracted to each entry<a name="line.113"></a> <FONT color="green">114</FONT> * @return this - d<a name="line.114"></a> <FONT color="green">115</FONT> */<a name="line.115"></a> <FONT color="green">116</FONT> FieldVector<T> mapSubtract(T d);<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> * Map a subtraction operation to each entry.<a name="line.119"></a> <FONT color="green">120</FONT> * <p>The instance <strong>is</strong> changed by this method.</p><a name="line.120"></a> <FONT color="green">121</FONT> * @param d value to be subtracted to each entry<a name="line.121"></a> <FONT color="green">122</FONT> * @return for convenience, return this<a name="line.122"></a> <FONT color="green">123</FONT> */<a name="line.123"></a> <FONT color="green">124</FONT> FieldVector<T> mapSubtractToSelf(T d);<a name="line.124"></a> <FONT color="green">125</FONT> <a name="line.125"></a> <FONT color="green">126</FONT> /**<a name="line.126"></a> <FONT color="green">127</FONT> * Map a multiplication operation to each entry.<a name="line.127"></a> <FONT color="green">128</FONT> * @param d value to multiply all entries by<a name="line.128"></a> <FONT color="green">129</FONT> * @return this * d<a name="line.129"></a> <FONT color="green">130</FONT> */<a name="line.130"></a> <FONT color="green">131</FONT> FieldVector<T> mapMultiply(T d);<a name="line.131"></a> <FONT color="green">132</FONT> <a name="line.132"></a> <FONT color="green">133</FONT> /**<a name="line.133"></a> <FONT color="green">134</FONT> * Map a multiplication operation to each entry.<a name="line.134"></a> <FONT color="green">135</FONT> * <p>The instance <strong>is</strong> changed by this method.</p><a name="line.135"></a> <FONT color="green">136</FONT> * @param d value to multiply all entries by<a name="line.136"></a> <FONT color="green">137</FONT> * @return for convenience, return this<a name="line.137"></a> <FONT color="green">138</FONT> */<a name="line.138"></a> <FONT color="green">139</FONT> FieldVector<T> mapMultiplyToSelf(T d);<a name="line.139"></a> <FONT color="green">140</FONT> <a name="line.140"></a> <FONT color="green">141</FONT> /**<a name="line.141"></a> <FONT color="green">142</FONT> * Map a division operation to each entry.<a name="line.142"></a> <FONT color="green">143</FONT> * @param d value to divide all entries by<a name="line.143"></a> <FONT color="green">144</FONT> * @return this / d<a name="line.144"></a> <FONT color="green">145</FONT> */<a name="line.145"></a> <FONT color="green">146</FONT> FieldVector<T> mapDivide(T d);<a name="line.146"></a> <FONT color="green">147</FONT> <a name="line.147"></a> <FONT color="green">148</FONT> /**<a name="line.148"></a> <FONT color="green">149</FONT> * Map a division operation to each entry.<a name="line.149"></a> <FONT color="green">150</FONT> * <p>The instance <strong>is</strong> changed by this method.</p><a name="line.150"></a> <FONT color="green">151</FONT> * @param d value to divide all entries by<a name="line.151"></a> <FONT color="green">152</FONT> * @return for convenience, return this<a name="line.152"></a> <FONT color="green">153</FONT> */<a name="line.153"></a> <FONT color="green">154</FONT> FieldVector<T> mapDivideToSelf(T d);<a name="line.154"></a> <FONT color="green">155</FONT> <a name="line.155"></a> <FONT color="green">156</FONT> /**<a name="line.156"></a> <FONT color="green">157</FONT> * Map the 1/x function to each entry.<a name="line.157"></a> <FONT color="green">158</FONT> * @return a vector containing the result of applying the function to each entry<a name="line.158"></a> <FONT color="green">159</FONT> */<a name="line.159"></a> <FONT color="green">160</FONT> FieldVector<T> mapInv();<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> * Map the 1/x function to each entry.<a name="line.163"></a> <FONT color="green">164</FONT> * <p>The instance <strong>is</strong> changed by this method.</p><a name="line.164"></a> <FONT color="green">165</FONT> * @return for convenience, return this<a name="line.165"></a> <FONT color="green">166</FONT> */<a name="line.166"></a> <FONT color="green">167</FONT> FieldVector<T> mapInvToSelf();<a name="line.167"></a> <FONT color="green">168</FONT> <a name="line.168"></a> <FONT color="green">169</FONT> /**<a name="line.169"></a> <FONT color="green">170</FONT> * Element-by-element multiplication.<a name="line.170"></a> <FONT color="green">171</FONT> * @param v vector by which instance elements must be multiplied<a name="line.171"></a> <FONT color="green">172</FONT> * @return a vector containing this[i] * v[i] for all i<a name="line.172"></a> <FONT color="green">173</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.173"></a> <FONT color="green">174</FONT> */<a name="line.174"></a> <FONT color="green">175</FONT> FieldVector<T> ebeMultiply(FieldVector<T> v) throws IllegalArgumentException;<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> <FONT color="green">178</FONT> * Element-by-element multiplication.<a name="line.178"></a> <FONT color="green">179</FONT> * @param v vector by which instance elements must be multiplied<a name="line.179"></a> <FONT color="green">180</FONT> * @return a vector containing this[i] * v[i] for all i<a name="line.180"></a> <FONT color="green">181</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.181"></a> <FONT color="green">182</FONT> */<a name="line.182"></a> <FONT color="green">183</FONT> FieldVector<T> ebeMultiply(T[] v) throws IllegalArgumentException;<a name="line.183"></a> <FONT color="green">184</FONT> <a name="line.184"></a> <FONT color="green">185</FONT> /**<a name="line.185"></a> <FONT color="green">186</FONT> * Element-by-element division.<a name="line.186"></a> <FONT color="green">187</FONT> * @param v vector by which instance elements must be divided<a name="line.187"></a> <FONT color="green">188</FONT> * @return a vector containing this[i] / v[i] for all i<a name="line.188"></a> <FONT color="green">189</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.189"></a> <FONT color="green">190</FONT> */<a name="line.190"></a> <FONT color="green">191</FONT> FieldVector<T> ebeDivide(FieldVector<T> v) throws IllegalArgumentException;<a name="line.191"></a> <FONT color="green">192</FONT> <a name="line.192"></a> <FONT color="green">193</FONT> /**<a name="line.193"></a> <FONT color="green">194</FONT> * Element-by-element division.<a name="line.194"></a> <FONT color="green">195</FONT> * @param v vector by which instance elements must be divided<a name="line.195"></a> <FONT color="green">196</FONT> * @return a vector containing this[i] / v[i] for all i<a name="line.196"></a> <FONT color="green">197</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.197"></a> <FONT color="green">198</FONT> */<a name="line.198"></a> <FONT color="green">199</FONT> FieldVector<T> ebeDivide(T[] v) throws IllegalArgumentException;<a name="line.199"></a> <FONT color="green">200</FONT> <a name="line.200"></a> <FONT color="green">201</FONT> /**<a name="line.201"></a> <FONT color="green">202</FONT> * Returns vector entries as a T array.<a name="line.202"></a> <FONT color="green">203</FONT> * @return T array of entries<a name="line.203"></a> <FONT color="green">204</FONT> */<a name="line.204"></a> <FONT color="green">205</FONT> T[] getData();<a name="line.205"></a> <FONT color="green">206</FONT> <a name="line.206"></a> <FONT color="green">207</FONT> /**<a name="line.207"></a> <FONT color="green">208</FONT> * Compute the dot product.<a name="line.208"></a> <FONT color="green">209</FONT> * @param v vector with which dot product should be computed<a name="line.209"></a> <FONT color="green">210</FONT> * @return the scalar dot product between instance and v<a name="line.210"></a> <FONT color="green">211</FONT> * @exception IllegalArgumentException if v is not the same size as this<a name="line.211"></a> <FONT color="green">212</FONT> */<a name="line.212"></a> <FONT color="green">213</FONT> T dotProduct(FieldVector<T> v)<a name="line.213"></a> <FONT color="green">214</FONT> throws IllegalArgumentException;<a name="line.214"></a> <FONT color="green">215</FONT> <a name="line.215"></a> <FONT color="green">216</FONT> /**<a name="line.216"></a> <FONT color="green">217</FONT> * Compute the dot product.<a name="line.217"></a> <FONT color="green">218</FONT> * @param v vector with which dot product should be computed<a name="line.218"></a> <FONT color="green">219</FONT> * @return the scalar dot product between instance and v<a name="line.219"></a> <FONT color="green">220</FONT> * @exception IllegalArgumentException if v is not the same size as this<a name="line.220"></a> <FONT color="green">221</FONT> */<a name="line.221"></a> <FONT color="green">222</FONT> T dotProduct(T[] v)<a name="line.222"></a> <FONT color="green">223</FONT> throws IllegalArgumentException;<a name="line.223"></a> <FONT color="green">224</FONT> <a name="line.224"></a> <FONT color="green">225</FONT> /** Find the orthogonal projection of this vector onto another vector.<a name="line.225"></a> <FONT color="green">226</FONT> * @param v vector onto which instance must be projected<a name="line.226"></a> <FONT color="green">227</FONT> * @return projection of the instance onto v<a name="line.227"></a> <FONT color="green">228</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.228"></a> <FONT color="green">229</FONT> */<a name="line.229"></a> <FONT color="green">230</FONT> FieldVector<T> projection(FieldVector<T> v)<a name="line.230"></a> <FONT color="green">231</FONT> throws IllegalArgumentException;<a name="line.231"></a> <FONT color="green">232</FONT> <a name="line.232"></a> <FONT color="green">233</FONT> /** Find the orthogonal projection of this vector onto another vector.<a name="line.233"></a> <FONT color="green">234</FONT> * @param v vector onto which instance must be projected<a name="line.234"></a> <FONT color="green">235</FONT> * @return projection of the instance onto v<a name="line.235"></a> <FONT color="green">236</FONT> * @throws IllegalArgumentException if v is not the same size as this<a name="line.236"></a> <FONT color="green">237</FONT> */<a name="line.237"></a> <FONT color="green">238</FONT> FieldVector<T> projection(T[] v)<a name="line.238"></a> <FONT color="green">239</FONT> throws IllegalArgumentException;<a name="line.239"></a> <FONT color="green">240</FONT> <a name="line.240"></a> <FONT color="green">241</FONT> /**<a name="line.241"></a> <FONT color="green">242</FONT> * Compute the outer product.<a name="line.242"></a> <FONT color="green">243</FONT> * @param v vector with which outer product should be computed<a name="line.243"></a> <FONT color="green">244</FONT> * @return the square matrix outer product between instance and v<a name="line.244"></a> <FONT color="green">245</FONT> * @exception IllegalArgumentException if v is not the same size as this<a name="line.245"></a> <FONT color="green">246</FONT> */<a name="line.246"></a> <FONT color="green">247</FONT> FieldMatrix<T> outerProduct(FieldVector<T> v)<a name="line.247"></a> <FONT color="green">248</FONT> throws IllegalArgumentException;<a name="line.248"></a> <FONT color="green">249</FONT> <a name="line.249"></a> <FONT color="green">250</FONT> /**<a name="line.250"></a> <FONT color="green">251</FONT> * Compute the outer product.<a name="line.251"></a> <FONT color="green">252</FONT> * @param v vector with which outer product should be computed<a name="line.252"></a> <FONT color="green">253</FONT> * @return the square matrix outer product between instance and v<a name="line.253"></a> <FONT color="green">254</FONT> * @exception IllegalArgumentException if v is not the same size as this<a name="line.254"></a> <FONT color="green">255</FONT> */<a name="line.255"></a> <FONT color="green">256</FONT> FieldMatrix<T> outerProduct(T[] v)<a name="line.256"></a> <FONT color="green">257</FONT> throws IllegalArgumentException;<a name="line.257"></a> <FONT color="green">258</FONT> <a name="line.258"></a> <FONT color="green">259</FONT> /**<a name="line.259"></a> <FONT color="green">260</FONT> * Returns the entry in the specified index.<a name="line.260"></a> <FONT color="green">261</FONT> * <p><a name="line.261"></a> <FONT color="green">262</FONT> * The index start at 0 and must be lesser than the size,<a name="line.262"></a> <FONT color="green">263</FONT> * otherwise a {@link MatrixIndexException} is thrown.<a name="line.263"></a> <FONT color="green">264</FONT> * </p><a name="line.264"></a> <FONT color="green">265</FONT> * @param index index location of entry to be fetched<a name="line.265"></a> <FONT color="green">266</FONT> * @return vector entry at index<a name="line.266"></a> <FONT color="green">267</FONT> * @throws MatrixIndexException if the index is not valid<a name="line.267"></a> <FONT color="green">268</FONT> * @see #setEntry(int, FieldElement)<a name="line.268"></a> <FONT color="green">269</FONT> */<a name="line.269"></a> <FONT color="green">270</FONT> T getEntry(int index)<a name="line.270"></a> <FONT color="green">271</FONT> throws MatrixIndexException;<a name="line.271"></a> <FONT color="green">272</FONT> <a name="line.272"></a> <FONT color="green">273</FONT> /**<a name="line.273"></a> <FONT color="green">274</FONT> * Set a single element.<a name="line.274"></a> <FONT color="green">275</FONT> * @param index element index.<a name="line.275"></a> <FONT color="green">276</FONT> * @param value new value for the element.<a name="line.276"></a> <FONT color="green">277</FONT> * @exception MatrixIndexException if the index is<a name="line.277"></a> <FONT color="green">278</FONT> * inconsistent with vector size<a name="line.278"></a> <FONT color="green">279</FONT> * @see #getEntry(int)<a name="line.279"></a> <FONT color="green">280</FONT> */<a name="line.280"></a> <FONT color="green">281</FONT> void setEntry(int index, T value)<a name="line.281"></a> <FONT color="green">282</FONT> throws MatrixIndexException;<a name="line.282"></a> <FONT color="green">283</FONT> <a name="line.283"></a> <FONT color="green">284</FONT> /**<a name="line.284"></a> <FONT color="green">285</FONT> * Returns the size of the vector.<a name="line.285"></a> <FONT color="green">286</FONT> * @return size<a name="line.286"></a> <FONT color="green">287</FONT> */<a name="line.287"></a> <FONT color="green">288</FONT> int getDimension();<a name="line.288"></a> <FONT color="green">289</FONT> <a name="line.289"></a> <FONT color="green">290</FONT> /**<a name="line.290"></a> <FONT color="green">291</FONT> * Construct a vector by appending a vector to this vector.<a name="line.291"></a> <FONT color="green">292</FONT> * @param v vector to append to this one.<a name="line.292"></a> <FONT color="green">293</FONT> * @return a new vector<a name="line.293"></a> <FONT color="green">294</FONT> */<a name="line.294"></a> <FONT color="green">295</FONT> FieldVector<T> append(FieldVector<T> v);<a name="line.295"></a> <FONT color="green">296</FONT> <a name="line.296"></a> <FONT color="green">297</FONT> /**<a name="line.297"></a> <FONT color="green">298</FONT> * Construct a vector by appending a T to this vector.<a name="line.298"></a> <FONT color="green">299</FONT> * @param d T to append.<a name="line.299"></a> <FONT color="green">300</FONT> * @return a new vector<a name="line.300"></a> <FONT color="green">301</FONT> */<a name="line.301"></a> <FONT color="green">302</FONT> FieldVector<T> append(T d);<a name="line.302"></a> <FONT color="green">303</FONT> <a name="line.303"></a> <FONT color="green">304</FONT> /**<a name="line.304"></a> <FONT color="green">305</FONT> * Construct a vector by appending a T array to this vector.<a name="line.305"></a> <FONT color="green">306</FONT> * @param a T array to append.<a name="line.306"></a> <FONT color="green">307</FONT> * @return a new vector<a name="line.307"></a> <FONT color="green">308</FONT> */<a name="line.308"></a> <FONT color="green">309</FONT> FieldVector<T> append(T[] a);<a name="line.309"></a> <FONT color="green">310</FONT> <a name="line.310"></a> <FONT color="green">311</FONT> /**<a name="line.311"></a> <FONT color="green">312</FONT> * Get a subvector from consecutive elements.<a name="line.312"></a> <FONT color="green">313</FONT> * @param index index of first element.<a name="line.313"></a> <FONT color="green">314</FONT> * @param n number of elements to be retrieved.<a name="line.314"></a> <FONT color="green">315</FONT> * @return a vector containing n elements.<a name="line.315"></a> <FONT color="green">316</FONT> * @exception MatrixIndexException if the index is<a name="line.316"></a> <FONT color="green">317</FONT> * inconsistent with vector size<a name="line.317"></a> <FONT color="green">318</FONT> */<a name="line.318"></a> <FONT color="green">319</FONT> FieldVector<T> getSubVector(int index, int n)<a name="line.319"></a> <FONT color="green">320</FONT> throws MatrixIndexException;<a name="line.320"></a> <FONT color="green">321</FONT> <a name="line.321"></a> <FONT color="green">322</FONT> /**<a name="line.322"></a> <FONT color="green">323</FONT> * Set a set of consecutive elements.<a name="line.323"></a> <FONT color="green">324</FONT> * @param index index of first element to be set.<a name="line.324"></a> <FONT color="green">325</FONT> * @param v vector containing the values to set.<a name="line.325"></a> <FONT color="green">326</FONT> * @exception MatrixIndexException if the index is<a name="line.326"></a> <FONT color="green">327</FONT> * inconsistent with vector size<a name="line.327"></a> <FONT color="green">328</FONT> * @see #setSubVector(int, FieldElement[])<a name="line.328"></a> <FONT color="green">329</FONT> */<a name="line.329"></a> <FONT color="green">330</FONT> void setSubVector(int index, FieldVector<T> v)<a name="line.330"></a> <FONT color="green">331</FONT> throws MatrixIndexException;<a name="line.331"></a> <FONT color="green">332</FONT> <a name="line.332"></a> <FONT color="green">333</FONT> /**<a name="line.333"></a> <FONT color="green">334</FONT> * Set a set of consecutive elements.<a name="line.334"></a> <FONT color="green">335</FONT> * @param index index of first element to be set.<a name="line.335"></a> <FONT color="green">336</FONT> * @param v vector containing the values to set.<a name="line.336"></a> <FONT color="green">337</FONT> * @exception MatrixIndexException if the index is<a name="line.337"></a> <FONT color="green">338</FONT> * inconsistent with vector size<a name="line.338"></a> <FONT color="green">339</FONT> * @see #setSubVector(int, FieldVector)<a name="line.339"></a> <FONT color="green">340</FONT> */<a name="line.340"></a> <FONT color="green">341</FONT> void setSubVector(int index, T[] v)<a name="line.341"></a> <FONT color="green">342</FONT> throws MatrixIndexException;<a name="line.342"></a> <FONT color="green">343</FONT> <a name="line.343"></a> <FONT color="green">344</FONT> /**<a name="line.344"></a> <FONT color="green">345</FONT> * Set all elements to a single value.<a name="line.345"></a> <FONT color="green">346</FONT> * @param value single value to set for all elements<a name="line.346"></a> <FONT color="green">347</FONT> */<a name="line.347"></a> <FONT color="green">348</FONT> void set(T value);<a name="line.348"></a> <FONT color="green">349</FONT> <a name="line.349"></a> <FONT color="green">350</FONT> /**<a name="line.350"></a> <FONT color="green">351</FONT> * Convert the vector to a T array.<a name="line.351"></a> <FONT color="green">352</FONT> * <p>The array is independent from vector data, it's elements<a name="line.352"></a> <FONT color="green">353</FONT> * are copied.</p><a name="line.353"></a> <FONT color="green">354</FONT> * @return array containing a copy of vector elements<a name="line.354"></a> <FONT color="green">355</FONT> */<a name="line.355"></a> <FONT color="green">356</FONT> T[] toArray();<a name="line.356"></a> <FONT color="green">357</FONT> <a name="line.357"></a> <FONT color="green">358</FONT> }<a name="line.358"></a> </PRE> </BODY> </HTML>