Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/linear/MatrixUtils.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.linear;<a name="line.18"></a> <FONT color="green">019</FONT> <a name="line.19"></a> <FONT color="green">020</FONT> import java.io.IOException;<a name="line.20"></a> <FONT color="green">021</FONT> import java.io.ObjectInputStream;<a name="line.21"></a> <FONT color="green">022</FONT> import java.io.ObjectOutputStream;<a name="line.22"></a> <FONT color="green">023</FONT> import java.lang.reflect.Array;<a name="line.23"></a> <FONT color="green">024</FONT> import java.math.BigDecimal;<a name="line.24"></a> <FONT color="green">025</FONT> import java.util.Arrays;<a name="line.25"></a> <FONT color="green">026</FONT> <a name="line.26"></a> <FONT color="green">027</FONT> import org.apache.commons.math.Field;<a name="line.27"></a> <FONT color="green">028</FONT> import org.apache.commons.math.FieldElement;<a name="line.28"></a> <FONT color="green">029</FONT> import org.apache.commons.math.MathRuntimeException;<a name="line.29"></a> <FONT color="green">030</FONT> import org.apache.commons.math.fraction.BigFraction;<a name="line.30"></a> <FONT color="green">031</FONT> import org.apache.commons.math.fraction.Fraction;<a name="line.31"></a> <FONT color="green">032</FONT> <a name="line.32"></a> <FONT color="green">033</FONT> /**<a name="line.33"></a> <FONT color="green">034</FONT> * A collection of static methods that operate on or return matrices.<a name="line.34"></a> <FONT color="green">035</FONT> *<a name="line.35"></a> <FONT color="green">036</FONT> * @version $Revision: 903046 $ $Date: 2010-01-25 21:07:26 -0500 (Mon, 25 Jan 2010) $<a name="line.36"></a> <FONT color="green">037</FONT> */<a name="line.37"></a> <FONT color="green">038</FONT> public class MatrixUtils {<a name="line.38"></a> <FONT color="green">039</FONT> <a name="line.39"></a> <FONT color="green">040</FONT> /**<a name="line.40"></a> <FONT color="green">041</FONT> * Private constructor.<a name="line.41"></a> <FONT color="green">042</FONT> */<a name="line.42"></a> <FONT color="green">043</FONT> private MatrixUtils() {<a name="line.43"></a> <FONT color="green">044</FONT> super();<a name="line.44"></a> <FONT color="green">045</FONT> }<a name="line.45"></a> <FONT color="green">046</FONT> <a name="line.46"></a> <FONT color="green">047</FONT> /**<a name="line.47"></a> <FONT color="green">048</FONT> * Returns a {@link RealMatrix} with specified dimensions.<a name="line.48"></a> <FONT color="green">049</FONT> * <p>The type of matrix returned depends on the dimension. Below<a name="line.49"></a> <FONT color="green">050</FONT> * 2<sup>12</sup> elements (i.e. 4096 elements or 64&times;64 for a<a name="line.50"></a> <FONT color="green">051</FONT> * square matrix) which can be stored in a 32kB array, a {@link<a name="line.51"></a> <FONT color="green">052</FONT> * Array2DRowRealMatrix} instance is built. Above this threshold a {@link<a name="line.52"></a> <FONT color="green">053</FONT> * BlockRealMatrix} instance is built.</p><a name="line.53"></a> <FONT color="green">054</FONT> * <p>The matrix elements are all set to 0.0.</p><a name="line.54"></a> <FONT color="green">055</FONT> * @param rows number of rows of the matrix<a name="line.55"></a> <FONT color="green">056</FONT> * @param columns number of columns of the matrix<a name="line.56"></a> <FONT color="green">057</FONT> * @return RealMatrix with specified dimensions<a name="line.57"></a> <FONT color="green">058</FONT> * @see #createRealMatrix(double[][])<a name="line.58"></a> <FONT color="green">059</FONT> */<a name="line.59"></a> <FONT color="green">060</FONT> public static RealMatrix createRealMatrix(final int rows, final int columns) {<a name="line.60"></a> <FONT color="green">061</FONT> return (rows * columns <= 4096) ?<a name="line.61"></a> <FONT color="green">062</FONT> new Array2DRowRealMatrix(rows, columns) : new BlockRealMatrix(rows, columns);<a name="line.62"></a> <FONT color="green">063</FONT> }<a name="line.63"></a> <FONT color="green">064</FONT> <a name="line.64"></a> <FONT color="green">065</FONT> /**<a name="line.65"></a> <FONT color="green">066</FONT> * Returns a {@link FieldMatrix} with specified dimensions.<a name="line.66"></a> <FONT color="green">067</FONT> * <p>The type of matrix returned depends on the dimension. Below<a name="line.67"></a> <FONT color="green">068</FONT> * 2<sup>12</sup> elements (i.e. 4096 elements or 64&times;64 for a<a name="line.68"></a> <FONT color="green">069</FONT> * square matrix), a {@link FieldMatrix} instance is built. Above<a name="line.69"></a> <FONT color="green">070</FONT> * this threshold a {@link BlockFieldMatrix} instance is built.</p><a name="line.70"></a> <FONT color="green">071</FONT> * <p>The matrix elements are all set to field.getZero().</p><a name="line.71"></a> <FONT color="green">072</FONT> * @param <T> the type of the field elements<a name="line.72"></a> <FONT color="green">073</FONT> * @param field field to which the matrix elements belong<a name="line.73"></a> <FONT color="green">074</FONT> * @param rows number of rows of the matrix<a name="line.74"></a> <FONT color="green">075</FONT> * @param columns number of columns of the matrix<a name="line.75"></a> <FONT color="green">076</FONT> * @return FieldMatrix with specified dimensions<a name="line.76"></a> <FONT color="green">077</FONT> * @see #createFieldMatrix(FieldElement[][])<a name="line.77"></a> <FONT color="green">078</FONT> * @since 2.0<a name="line.78"></a> <FONT color="green">079</FONT> */<a name="line.79"></a> <FONT color="green">080</FONT> public static <T extends FieldElement<T>> FieldMatrix<T> createFieldMatrix(final Field<T> field,<a name="line.80"></a> <FONT color="green">081</FONT> final int rows,<a name="line.81"></a> <FONT color="green">082</FONT> final int columns) {<a name="line.82"></a> <FONT color="green">083</FONT> return (rows * columns <= 4096) ?<a name="line.83"></a> <FONT color="green">084</FONT> new Array2DRowFieldMatrix<T>(field, rows, columns) : new BlockFieldMatrix<T>(field, rows, columns);<a name="line.84"></a> <FONT color="green">085</FONT> }<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> * Returns a {@link RealMatrix} whose entries are the the values in the<a name="line.88"></a> <FONT color="green">089</FONT> * the input array.<a name="line.89"></a> <FONT color="green">090</FONT> * <p>The type of matrix returned depends on the dimension. Below<a name="line.90"></a> <FONT color="green">091</FONT> * 2<sup>12</sup> elements (i.e. 4096 elements or 64&times;64 for a<a name="line.91"></a> <FONT color="green">092</FONT> * square matrix) which can be stored in a 32kB array, a {@link<a name="line.92"></a> <FONT color="green">093</FONT> * Array2DRowRealMatrix} instance is built. Above this threshold a {@link<a name="line.93"></a> <FONT color="green">094</FONT> * BlockRealMatrix} instance is built.</p><a name="line.94"></a> <FONT color="green">095</FONT> * <p>The input array is copied, not referenced.</p><a name="line.95"></a> <FONT color="green">096</FONT> *<a name="line.96"></a> <FONT color="green">097</FONT> * @param data input array<a name="line.97"></a> <FONT color="green">098</FONT> * @return RealMatrix containing the values of the array<a name="line.98"></a> <FONT color="green">099</FONT> * @throws IllegalArgumentException if <code>data</code> is not rectangular<a name="line.99"></a> <FONT color="green">100</FONT> * (not all rows have the same length) or empty<a name="line.100"></a> <FONT color="green">101</FONT> * @throws NullPointerException if either <code>data</code> or<a name="line.101"></a> <FONT color="green">102</FONT> * <code>data[0]</code> is null<a name="line.102"></a> <FONT color="green">103</FONT> * @see #createRealMatrix(int, int)<a name="line.103"></a> <FONT color="green">104</FONT> */<a name="line.104"></a> <FONT color="green">105</FONT> public static RealMatrix createRealMatrix(double[][] data) {<a name="line.105"></a> <FONT color="green">106</FONT> return (data.length * data[0].length <= 4096) ?<a name="line.106"></a> <FONT color="green">107</FONT> new Array2DRowRealMatrix(data) : new BlockRealMatrix(data);<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> /**<a name="line.110"></a> <FONT color="green">111</FONT> * Returns a {@link FieldMatrix} whose entries are the the values in the<a name="line.111"></a> <FONT color="green">112</FONT> * the input array.<a name="line.112"></a> <FONT color="green">113</FONT> * <p>The type of matrix returned depends on the dimension. Below<a name="line.113"></a> <FONT color="green">114</FONT> * 2<sup>12</sup> elements (i.e. 4096 elements or 64&times;64 for a<a name="line.114"></a> <FONT color="green">115</FONT> * square matrix), a {@link FieldMatrix} instance is built. Above<a name="line.115"></a> <FONT color="green">116</FONT> * this threshold a {@link BlockFieldMatrix} instance is built.</p><a name="line.116"></a> <FONT color="green">117</FONT> * <p>The input array is copied, not referenced.</p><a name="line.117"></a> <FONT color="green">118</FONT> * @param <T> the type of the field elements<a name="line.118"></a> <FONT color="green">119</FONT> * @param data input array<a name="line.119"></a> <FONT color="green">120</FONT> * @return RealMatrix containing the values of the array<a name="line.120"></a> <FONT color="green">121</FONT> * @throws IllegalArgumentException if <code>data</code> is not rectangular<a name="line.121"></a> <FONT color="green">122</FONT> * (not all rows have the same length) or empty<a name="line.122"></a> <FONT color="green">123</FONT> * @throws NullPointerException if either <code>data</code> or<a name="line.123"></a> <FONT color="green">124</FONT> * <code>data[0]</code> is null<a name="line.124"></a> <FONT color="green">125</FONT> * @see #createFieldMatrix(Field, int, int)<a name="line.125"></a> <FONT color="green">126</FONT> * @since 2.0<a name="line.126"></a> <FONT color="green">127</FONT> */<a name="line.127"></a> <FONT color="green">128</FONT> public static <T extends FieldElement<T>> FieldMatrix<T> createFieldMatrix(T[][] data) {<a name="line.128"></a> <FONT color="green">129</FONT> return (data.length * data[0].length <= 4096) ?<a name="line.129"></a> <FONT color="green">130</FONT> new Array2DRowFieldMatrix<T>(data) : new BlockFieldMatrix<T>(data);<a name="line.130"></a> <FONT color="green">131</FONT> }<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> * Returns <code>dimension x dimension</code> identity matrix.<a name="line.134"></a> <FONT color="green">135</FONT> *<a name="line.135"></a> <FONT color="green">136</FONT> * @param dimension dimension of identity matrix to generate<a name="line.136"></a> <FONT color="green">137</FONT> * @return identity matrix<a name="line.137"></a> <FONT color="green">138</FONT> * @throws IllegalArgumentException if dimension is not positive<a name="line.138"></a> <FONT color="green">139</FONT> * @since 1.1<a name="line.139"></a> <FONT color="green">140</FONT> */<a name="line.140"></a> <FONT color="green">141</FONT> public static RealMatrix createRealIdentityMatrix(int dimension) {<a name="line.141"></a> <FONT color="green">142</FONT> final RealMatrix m = createRealMatrix(dimension, dimension);<a name="line.142"></a> <FONT color="green">143</FONT> for (int i = 0; i < dimension; ++i) {<a name="line.143"></a> <FONT color="green">144</FONT> m.setEntry(i, i, 1.0);<a name="line.144"></a> <FONT color="green">145</FONT> }<a name="line.145"></a> <FONT color="green">146</FONT> return m;<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> /**<a name="line.149"></a> <FONT color="green">150</FONT> * Returns <code>dimension x dimension</code> identity matrix.<a name="line.150"></a> <FONT color="green">151</FONT> *<a name="line.151"></a> <FONT color="green">152</FONT> * @param <T> the type of the field elements<a name="line.152"></a> <FONT color="green">153</FONT> * @param field field to which the elements belong<a name="line.153"></a> <FONT color="green">154</FONT> * @param dimension dimension of identity matrix to generate<a name="line.154"></a> <FONT color="green">155</FONT> * @return identity matrix<a name="line.155"></a> <FONT color="green">156</FONT> * @throws IllegalArgumentException if dimension is not positive<a name="line.156"></a> <FONT color="green">157</FONT> * @since 2.0<a name="line.157"></a> <FONT color="green">158</FONT> */<a name="line.158"></a> <FONT color="green">159</FONT> public static <T extends FieldElement<T>> FieldMatrix<T><a name="line.159"></a> <FONT color="green">160</FONT> createFieldIdentityMatrix(final Field<T> field, final int dimension) {<a name="line.160"></a> <FONT color="green">161</FONT> final T zero = field.getZero();<a name="line.161"></a> <FONT color="green">162</FONT> final T one = field.getOne();<a name="line.162"></a> <FONT color="green">163</FONT> @SuppressWarnings("unchecked") // zero is type T<a name="line.163"></a> <FONT color="green">164</FONT> final T[][] d = (T[][]) Array.newInstance(zero.getClass(), new int[] { dimension, dimension });<a name="line.164"></a> <FONT color="green">165</FONT> for (int row = 0; row < dimension; row++) {<a name="line.165"></a> <FONT color="green">166</FONT> final T[] dRow = d[row];<a name="line.166"></a> <FONT color="green">167</FONT> Arrays.fill(dRow, zero);<a name="line.167"></a> <FONT color="green">168</FONT> dRow[row] = one;<a name="line.168"></a> <FONT color="green">169</FONT> }<a name="line.169"></a> <FONT color="green">170</FONT> return new Array2DRowFieldMatrix<T>(d, false);<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> <FONT color="green">173</FONT> /**<a name="line.173"></a> <FONT color="green">174</FONT> * Returns <code>dimension x dimension</code> identity matrix.<a name="line.174"></a> <FONT color="green">175</FONT> *<a name="line.175"></a> <FONT color="green">176</FONT> * @param dimension dimension of identity matrix to generate<a name="line.176"></a> <FONT color="green">177</FONT> * @return identity matrix<a name="line.177"></a> <FONT color="green">178</FONT> * @throws IllegalArgumentException if dimension is not positive<a name="line.178"></a> <FONT color="green">179</FONT> * @since 1.1<a name="line.179"></a> <FONT color="green">180</FONT> * @deprecated since 2.0, replaced by {@link #createFieldIdentityMatrix(Field, int)}<a name="line.180"></a> <FONT color="green">181</FONT> */<a name="line.181"></a> <FONT color="green">182</FONT> @Deprecated<a name="line.182"></a> <FONT color="green">183</FONT> public static BigMatrix createBigIdentityMatrix(int dimension) {<a name="line.183"></a> <FONT color="green">184</FONT> final BigDecimal[][] d = new BigDecimal[dimension][dimension];<a name="line.184"></a> <FONT color="green">185</FONT> for (int row = 0; row < dimension; row++) {<a name="line.185"></a> <FONT color="green">186</FONT> final BigDecimal[] dRow = d[row];<a name="line.186"></a> <FONT color="green">187</FONT> Arrays.fill(dRow, BigMatrixImpl.ZERO);<a name="line.187"></a> <FONT color="green">188</FONT> dRow[row] = BigMatrixImpl.ONE;<a name="line.188"></a> <FONT color="green">189</FONT> }<a name="line.189"></a> <FONT color="green">190</FONT> return new BigMatrixImpl(d, false);<a name="line.190"></a> <FONT color="green">191</FONT> }<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> * Returns a diagonal matrix with specified elements.<a name="line.194"></a> <FONT color="green">195</FONT> *<a name="line.195"></a> <FONT color="green">196</FONT> * @param diagonal diagonal elements of the matrix (the array elements<a name="line.196"></a> <FONT color="green">197</FONT> * will be copied)<a name="line.197"></a> <FONT color="green">198</FONT> * @return diagonal matrix<a name="line.198"></a> <FONT color="green">199</FONT> * @since 2.0<a name="line.199"></a> <FONT color="green">200</FONT> */<a name="line.200"></a> <FONT color="green">201</FONT> public static RealMatrix createRealDiagonalMatrix(final double[] diagonal) {<a name="line.201"></a> <FONT color="green">202</FONT> final RealMatrix m = createRealMatrix(diagonal.length, diagonal.length);<a name="line.202"></a> <FONT color="green">203</FONT> for (int i = 0; i < diagonal.length; ++i) {<a name="line.203"></a> <FONT color="green">204</FONT> m.setEntry(i, i, diagonal[i]);<a name="line.204"></a> <FONT color="green">205</FONT> }<a name="line.205"></a> <FONT color="green">206</FONT> return m;<a name="line.206"></a> <FONT color="green">207</FONT> }<a name="line.207"></a> <FONT color="green">208</FONT> <a name="line.208"></a> <FONT color="green">209</FONT> /**<a name="line.209"></a> <FONT color="green">210</FONT> * Returns a diagonal matrix with specified elements.<a name="line.210"></a> <FONT color="green">211</FONT> *<a name="line.211"></a> <FONT color="green">212</FONT> * @param <T> the type of the field elements<a name="line.212"></a> <FONT color="green">213</FONT> * @param diagonal diagonal elements of the matrix (the array elements<a name="line.213"></a> <FONT color="green">214</FONT> * will be copied)<a name="line.214"></a> <FONT color="green">215</FONT> * @return diagonal matrix<a name="line.215"></a> <FONT color="green">216</FONT> * @since 2.0<a name="line.216"></a> <FONT color="green">217</FONT> */<a name="line.217"></a> <FONT color="green">218</FONT> public static <T extends FieldElement<T>> FieldMatrix<T><a name="line.218"></a> <FONT color="green">219</FONT> createFieldDiagonalMatrix(final T[] diagonal) {<a name="line.219"></a> <FONT color="green">220</FONT> final FieldMatrix<T> m =<a name="line.220"></a> <FONT color="green">221</FONT> createFieldMatrix(diagonal[0].getField(), diagonal.length, diagonal.length);<a name="line.221"></a> <FONT color="green">222</FONT> for (int i = 0; i < diagonal.length; ++i) {<a name="line.222"></a> <FONT color="green">223</FONT> m.setEntry(i, i, diagonal[i]);<a name="line.223"></a> <FONT color="green">224</FONT> }<a name="line.224"></a> <FONT color="green">225</FONT> return m;<a name="line.225"></a> <FONT color="green">226</FONT> }<a name="line.226"></a> <FONT color="green">227</FONT> <a name="line.227"></a> <FONT color="green">228</FONT> /**<a name="line.228"></a> <FONT color="green">229</FONT> * Returns a {@link BigMatrix} whose entries are the the values in the<a name="line.229"></a> <FONT color="green">230</FONT> * the input array. The input array is copied, not referenced.<a name="line.230"></a> <FONT color="green">231</FONT> *<a name="line.231"></a> <FONT color="green">232</FONT> * @param data input array<a name="line.232"></a> <FONT color="green">233</FONT> * @return RealMatrix containing the values of the array<a name="line.233"></a> <FONT color="green">234</FONT> * @throws IllegalArgumentException if <code>data</code> is not rectangular<a name="line.234"></a> <FONT color="green">235</FONT> * (not all rows have the same length) or empty<a name="line.235"></a> <FONT color="green">236</FONT> * @throws NullPointerException if data is null<a name="line.236"></a> <FONT color="green">237</FONT> * @deprecated since 2.0 replaced by {@link #createFieldMatrix(FieldElement[][])}<a name="line.237"></a> <FONT color="green">238</FONT> */<a name="line.238"></a> <FONT color="green">239</FONT> @Deprecated<a name="line.239"></a> <FONT color="green">240</FONT> public static BigMatrix createBigMatrix(double[][] data) {<a name="line.240"></a> <FONT color="green">241</FONT> return new BigMatrixImpl(data);<a name="line.241"></a> <FONT color="green">242</FONT> }<a name="line.242"></a> <FONT color="green">243</FONT> <a name="line.243"></a> <FONT color="green">244</FONT> /**<a name="line.244"></a> <FONT color="green">245</FONT> * Returns a {@link BigMatrix} whose entries are the the values in the<a name="line.245"></a> <FONT color="green">246</FONT> * the input array. The input array is copied, not referenced.<a name="line.246"></a> <FONT color="green">247</FONT> *<a name="line.247"></a> <FONT color="green">248</FONT> * @param data input array<a name="line.248"></a> <FONT color="green">249</FONT> * @return RealMatrix containing the values of the array<a name="line.249"></a> <FONT color="green">250</FONT> * @throws IllegalArgumentException if <code>data</code> is not rectangular<a name="line.250"></a> <FONT color="green">251</FONT> * (not all rows have the same length) or empty<a name="line.251"></a> <FONT color="green">252</FONT> * @throws NullPointerException if data is null<a name="line.252"></a> <FONT color="green">253</FONT> * @deprecated since 2.0 replaced by {@link #createFieldMatrix(FieldElement[][])}<a name="line.253"></a> <FONT color="green">254</FONT> */<a name="line.254"></a> <FONT color="green">255</FONT> @Deprecated<a name="line.255"></a> <FONT color="green">256</FONT> public static BigMatrix createBigMatrix(BigDecimal[][] data) {<a name="line.256"></a> <FONT color="green">257</FONT> return new BigMatrixImpl(data);<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> /**<a name="line.260"></a> <FONT color="green">261</FONT> * Returns a {@link BigMatrix} whose entries are the the values in the<a name="line.261"></a> <FONT color="green">262</FONT> * the input array.<a name="line.262"></a> <FONT color="green">263</FONT> * <p>If an array is built specially in order to be embedded in a<a name="line.263"></a> <FONT color="green">264</FONT> * BigMatrix and not used directly, the <code>copyArray</code> may be<a name="line.264"></a> <FONT color="green">265</FONT> * set to <code>false</code. This will prevent the copying and improve<a name="line.265"></a> <FONT color="green">266</FONT> * performance as no new array will be built and no data will be copied.</p><a name="line.266"></a> <FONT color="green">267</FONT> * @param data data for new matrix<a name="line.267"></a> <FONT color="green">268</FONT> * @param copyArray if true, the input array will be copied, otherwise<a name="line.268"></a> <FONT color="green">269</FONT> * it will be referenced<a name="line.269"></a> <FONT color="green">270</FONT> * @return BigMatrix containing the values of the array<a name="line.270"></a> <FONT color="green">271</FONT> * @throws IllegalArgumentException if <code>data</code> is not rectangular<a name="line.271"></a> <FONT color="green">272</FONT> * (not all rows have the same length) or empty<a name="line.272"></a> <FONT color="green">273</FONT> * @throws NullPointerException if <code>data</code> is null<a name="line.273"></a> <FONT color="green">274</FONT> * @see #createRealMatrix(double[][])<a name="line.274"></a> <FONT color="green">275</FONT> * @deprecated since 2.0 replaced by {@link #createFieldMatrix(FieldElement[][])}<a name="line.275"></a> <FONT color="green">276</FONT> */<a name="line.276"></a> <FONT color="green">277</FONT> @Deprecated<a name="line.277"></a> <FONT color="green">278</FONT> public static BigMatrix createBigMatrix(BigDecimal[][] data, boolean copyArray) {<a name="line.278"></a> <FONT color="green">279</FONT> return new BigMatrixImpl(data, copyArray);<a name="line.279"></a> <FONT color="green">280</FONT> }<a name="line.280"></a> <FONT color="green">281</FONT> <a name="line.281"></a> <FONT color="green">282</FONT> /**<a name="line.282"></a> <FONT color="green">283</FONT> * Returns a {@link BigMatrix} whose entries are the the values in the<a name="line.283"></a> <FONT color="green">284</FONT> * the input array. The input array is copied, not referenced.<a name="line.284"></a> <FONT color="green">285</FONT> *<a name="line.285"></a> <FONT color="green">286</FONT> * @param data input array<a name="line.286"></a> <FONT color="green">287</FONT> * @return RealMatrix containing the values of the array<a name="line.287"></a> <FONT color="green">288</FONT> * @throws IllegalArgumentException if <code>data</code> is not rectangular<a name="line.288"></a> <FONT color="green">289</FONT> * (not all rows have the same length) or empty<a name="line.289"></a> <FONT color="green">290</FONT> * @throws NullPointerException if data is null<a name="line.290"></a> <FONT color="green">291</FONT> * @deprecated since 2.0 replaced by {@link #createFieldMatrix(FieldElement[][])}<a name="line.291"></a> <FONT color="green">292</FONT> */<a name="line.292"></a> <FONT color="green">293</FONT> @Deprecated<a name="line.293"></a> <FONT color="green">294</FONT> public static BigMatrix createBigMatrix(String[][] data) {<a name="line.294"></a> <FONT color="green">295</FONT> return new BigMatrixImpl(data);<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> /**<a name="line.298"></a> <FONT color="green">299</FONT> * Creates a {@link RealVector} using the data from the input array.<a name="line.299"></a> <FONT color="green">300</FONT> *<a name="line.300"></a> <FONT color="green">301</FONT> * @param data the input data<a name="line.301"></a> <FONT color="green">302</FONT> * @return a data.length RealVector<a name="line.302"></a> <FONT color="green">303</FONT> * @throws IllegalArgumentException if <code>data</code> is empty<a name="line.303"></a> <FONT color="green">304</FONT> * @throws NullPointerException if <code>data</code>is null<a name="line.304"></a> <FONT color="green">305</FONT> */<a name="line.305"></a> <FONT color="green">306</FONT> public static RealVector createRealVector(double[] data) {<a name="line.306"></a> <FONT color="green">307</FONT> return new ArrayRealVector(data, true);<a name="line.307"></a> <FONT color="green">308</FONT> }<a name="line.308"></a> <FONT color="green">309</FONT> <a name="line.309"></a> <FONT color="green">310</FONT> /**<a name="line.310"></a> <FONT color="green">311</FONT> * Creates a {@link FieldVector} using the data from the input array.<a name="line.311"></a> <FONT color="green">312</FONT> *<a name="line.312"></a> <FONT color="green">313</FONT> * @param <T> the type of the field elements<a name="line.313"></a> <FONT color="green">314</FONT> * @param data the input data<a name="line.314"></a> <FONT color="green">315</FONT> * @return a data.length FieldVector<a name="line.315"></a> <FONT color="green">316</FONT> * @throws IllegalArgumentException if <code>data</code> is empty<a name="line.316"></a> <FONT color="green">317</FONT> * @throws NullPointerException if <code>data</code>is null<a name="line.317"></a> <FONT color="green">318</FONT> */<a name="line.318"></a> <FONT color="green">319</FONT> public static <T extends FieldElement<T>> FieldVector<T> createFieldVector(final T[] data) {<a name="line.319"></a> <FONT color="green">320</FONT> return new ArrayFieldVector<T>(data, true);<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> /**<a name="line.323"></a> <FONT color="green">324</FONT> * Creates a row {@link RealMatrix} using the data from the input<a name="line.324"></a> <FONT color="green">325</FONT> * array.<a name="line.325"></a> <FONT color="green">326</FONT> *<a name="line.326"></a> <FONT color="green">327</FONT> * @param rowData the input row data<a name="line.327"></a> <FONT color="green">328</FONT> * @return a 1 x rowData.length RealMatrix<a name="line.328"></a> <FONT color="green">329</FONT> * @throws IllegalArgumentException if <code>rowData</code> is empty<a name="line.329"></a> <FONT color="green">330</FONT> * @throws NullPointerException if <code>rowData</code>is null<a name="line.330"></a> <FONT color="green">331</FONT> */<a name="line.331"></a> <FONT color="green">332</FONT> public static RealMatrix createRowRealMatrix(double[] rowData) {<a name="line.332"></a> <FONT color="green">333</FONT> final int nCols = rowData.length;<a name="line.333"></a> <FONT color="green">334</FONT> final RealMatrix m = createRealMatrix(1, nCols);<a name="line.334"></a> <FONT color="green">335</FONT> for (int i = 0; i < nCols; ++i) {<a name="line.335"></a> <FONT color="green">336</FONT> m.setEntry(0, i, rowData[i]);<a name="line.336"></a> <FONT color="green">337</FONT> }<a name="line.337"></a> <FONT color="green">338</FONT> return m;<a name="line.338"></a> <FONT color="green">339</FONT> }<a name="line.339"></a> <FONT color="green">340</FONT> <a name="line.340"></a> <FONT color="green">341</FONT> /**<a name="line.341"></a> <FONT color="green">342</FONT> * Creates a row {@link FieldMatrix} using the data from the input<a name="line.342"></a> <FONT color="green">343</FONT> * array.<a name="line.343"></a> <FONT color="green">344</FONT> *<a name="line.344"></a> <FONT color="green">345</FONT> * @param <T> the type of the field elements<a name="line.345"></a> <FONT color="green">346</FONT> * @param rowData the input row data<a name="line.346"></a> <FONT color="green">347</FONT> * @return a 1 x rowData.length FieldMatrix<a name="line.347"></a> <FONT color="green">348</FONT> * @throws IllegalArgumentException if <code>rowData</code> is empty<a name="line.348"></a> <FONT color="green">349</FONT> * @throws NullPointerException if <code>rowData</code>is null<a name="line.349"></a> <FONT color="green">350</FONT> */<a name="line.350"></a> <FONT color="green">351</FONT> public static <T extends FieldElement<T>> FieldMatrix<T><a name="line.351"></a> <FONT color="green">352</FONT> createRowFieldMatrix(final T[] rowData) {<a name="line.352"></a> <FONT color="green">353</FONT> final int nCols = rowData.length;<a name="line.353"></a> <FONT color="green">354</FONT> if (nCols == 0) {<a name="line.354"></a> <FONT color="green">355</FONT> throw MathRuntimeException.createIllegalArgumentException("matrix must have at least one column");<a name="line.355"></a> <FONT color="green">356</FONT> }<a name="line.356"></a> <FONT color="green">357</FONT> final FieldMatrix<T> m = createFieldMatrix(rowData[0].getField(), 1, nCols);<a name="line.357"></a> <FONT color="green">358</FONT> for (int i = 0; i < nCols; ++i) {<a name="line.358"></a> <FONT color="green">359</FONT> m.setEntry(0, i, rowData[i]);<a name="line.359"></a> <FONT color="green">360</FONT> }<a name="line.360"></a> <FONT color="green">361</FONT> return m;<a name="line.361"></a> <FONT color="green">362</FONT> }<a name="line.362"></a> <FONT color="green">363</FONT> <a name="line.363"></a> <FONT color="green">364</FONT> /**<a name="line.364"></a> <FONT color="green">365</FONT> * Creates a row {@link BigMatrix} using the data from the input<a name="line.365"></a> <FONT color="green">366</FONT> * array.<a name="line.366"></a> <FONT color="green">367</FONT> *<a name="line.367"></a> <FONT color="green">368</FONT> * @param rowData the input row data<a name="line.368"></a> <FONT color="green">369</FONT> * @return a 1 x rowData.length BigMatrix<a name="line.369"></a> <FONT color="green">370</FONT> * @throws IllegalArgumentException if <code>rowData</code> is empty<a name="line.370"></a> <FONT color="green">371</FONT> * @throws NullPointerException if <code>rowData</code>is null<a name="line.371"></a> <FONT color="green">372</FONT> * @deprecated since 2.0 replaced by {@link #createRowFieldMatrix(FieldElement[])}<a name="line.372"></a> <FONT color="green">373</FONT> */<a name="line.373"></a> <FONT color="green">374</FONT> @Deprecated<a name="line.374"></a> <FONT color="green">375</FONT> public static BigMatrix createRowBigMatrix(double[] rowData) {<a name="line.375"></a> <FONT color="green">376</FONT> final int nCols = rowData.length;<a name="line.376"></a> <FONT color="green">377</FONT> final BigDecimal[][] data = new BigDecimal[1][nCols];<a name="line.377"></a> <FONT color="green">378</FONT> for (int i = 0; i < nCols; ++i) {<a name="line.378"></a> <FONT color="green">379</FONT> data[0][i] = new BigDecimal(rowData[i]);<a name="line.379"></a> <FONT color="green">380</FONT> }<a name="line.380"></a> <FONT color="green">381</FONT> return new BigMatrixImpl(data, false);<a name="line.381"></a> <FONT color="green">382</FONT> }<a name="line.382"></a> <FONT color="green">383</FONT> <a name="line.383"></a> <FONT color="green">384</FONT> /**<a name="line.384"></a> <FONT color="green">385</FONT> * Creates a row {@link BigMatrix} using the data from the input<a name="line.385"></a> <FONT color="green">386</FONT> * array.<a name="line.386"></a> <FONT color="green">387</FONT> *<a name="line.387"></a> <FONT color="green">388</FONT> * @param rowData the input row data<a name="line.388"></a> <FONT color="green">389</FONT> * @return a 1 x rowData.length BigMatrix<a name="line.389"></a> <FONT color="green">390</FONT> * @throws IllegalArgumentException if <code>rowData</code> is empty<a name="line.390"></a> <FONT color="green">391</FONT> * @throws NullPointerException if <code>rowData</code>is null<a name="line.391"></a> <FONT color="green">392</FONT> * @deprecated since 2.0 replaced by {@link #createRowFieldMatrix(FieldElement[])}<a name="line.392"></a> <FONT color="green">393</FONT> */<a name="line.393"></a> <FONT color="green">394</FONT> @Deprecated<a name="line.394"></a> <FONT color="green">395</FONT> public static BigMatrix createRowBigMatrix(BigDecimal[] rowData) {<a name="line.395"></a> <FONT color="green">396</FONT> final int nCols = rowData.length;<a name="line.396"></a> <FONT color="green">397</FONT> final BigDecimal[][] data = new BigDecimal[1][nCols];<a name="line.397"></a> <FONT color="green">398</FONT> System.arraycopy(rowData, 0, data[0], 0, nCols);<a name="line.398"></a> <FONT color="green">399</FONT> return new BigMatrixImpl(data, false);<a name="line.399"></a> <FONT color="green">400</FONT> }<a name="line.400"></a> <FONT color="green">401</FONT> <a name="line.401"></a> <FONT color="green">402</FONT> /**<a name="line.402"></a> <FONT color="green">403</FONT> * Creates a row {@link BigMatrix} using the data from the input<a name="line.403"></a> <FONT color="green">404</FONT> * array.<a name="line.404"></a> <FONT color="green">405</FONT> *<a name="line.405"></a> <FONT color="green">406</FONT> * @param rowData the input row data<a name="line.406"></a> <FONT color="green">407</FONT> * @return a 1 x rowData.length BigMatrix<a name="line.407"></a> <FONT color="green">408</FONT> * @throws IllegalArgumentException if <code>rowData</code> is empty<a name="line.408"></a> <FONT color="green">409</FONT> * @throws NullPointerException if <code>rowData</code>is null<a name="line.409"></a> <FONT color="green">410</FONT> * @deprecated since 2.0 replaced by {@link #createRowFieldMatrix(FieldElement[])}<a name="line.410"></a> <FONT color="green">411</FONT> */<a name="line.411"></a> <FONT color="green">412</FONT> @Deprecated<a name="line.412"></a> <FONT color="green">413</FONT> public static BigMatrix createRowBigMatrix(String[] rowData) {<a name="line.413"></a> <FONT color="green">414</FONT> final int nCols = rowData.length;<a name="line.414"></a> <FONT color="green">415</FONT> final BigDecimal[][] data = new BigDecimal[1][nCols];<a name="line.415"></a> <FONT color="green">416</FONT> for (int i = 0; i < nCols; ++i) {<a name="line.416"></a> <FONT color="green">417</FONT> data[0][i] = new BigDecimal(rowData[i]);<a name="line.417"></a> <FONT color="green">418</FONT> }<a name="line.418"></a> <FONT color="green">419</FONT> return new BigMatrixImpl(data, false);<a name="line.419"></a> <FONT color="green">420</FONT> }<a name="line.420"></a> <FONT color="green">421</FONT> <a name="line.421"></a> <FONT color="green">422</FONT> /**<a name="line.422"></a> <FONT color="green">423</FONT> * Creates a column {@link RealMatrix} using the data from the input<a name="line.423"></a> <FONT color="green">424</FONT> * array.<a name="line.424"></a> <FONT color="green">425</FONT> *<a name="line.425"></a> <FONT color="green">426</FONT> * @param columnData the input column data<a name="line.426"></a> <FONT color="green">427</FONT> * @return a columnData x 1 RealMatrix<a name="line.427"></a> <FONT color="green">428</FONT> * @throws IllegalArgumentException if <code>columnData</code> is empty<a name="line.428"></a> <FONT color="green">429</FONT> * @throws NullPointerException if <code>columnData</code>is null<a name="line.429"></a> <FONT color="green">430</FONT> */<a name="line.430"></a> <FONT color="green">431</FONT> public static RealMatrix createColumnRealMatrix(double[] columnData) {<a name="line.431"></a> <FONT color="green">432</FONT> final int nRows = columnData.length;<a name="line.432"></a> <FONT color="green">433</FONT> final RealMatrix m = createRealMatrix(nRows, 1);<a name="line.433"></a> <FONT color="green">434</FONT> for (int i = 0; i < nRows; ++i) {<a name="line.434"></a> <FONT color="green">435</FONT> m.setEntry(i, 0, columnData[i]);<a name="line.435"></a> <FONT color="green">436</FONT> }<a name="line.436"></a> <FONT color="green">437</FONT> return m;<a name="line.437"></a> <FONT color="green">438</FONT> }<a name="line.438"></a> <FONT color="green">439</FONT> <a name="line.439"></a> <FONT color="green">440</FONT> /**<a name="line.440"></a> <FONT color="green">441</FONT> * Creates a column {@link FieldMatrix} using the data from the input<a name="line.441"></a> <FONT color="green">442</FONT> * array.<a name="line.442"></a> <FONT color="green">443</FONT> *<a name="line.443"></a> <FONT color="green">444</FONT> * @param <T> the type of the field elements<a name="line.444"></a> <FONT color="green">445</FONT> * @param columnData the input column data<a name="line.445"></a> <FONT color="green">446</FONT> * @return a columnData x 1 FieldMatrix<a name="line.446"></a> <FONT color="green">447</FONT> * @throws IllegalArgumentException if <code>columnData</code> is empty<a name="line.447"></a> <FONT color="green">448</FONT> * @throws NullPointerException if <code>columnData</code>is null<a name="line.448"></a> <FONT color="green">449</FONT> */<a name="line.449"></a> <FONT color="green">450</FONT> public static <T extends FieldElement<T>> FieldMatrix<T><a name="line.450"></a> <FONT color="green">451</FONT> createColumnFieldMatrix(final T[] columnData) {<a name="line.451"></a> <FONT color="green">452</FONT> final int nRows = columnData.length;<a name="line.452"></a> <FONT color="green">453</FONT> if (nRows == 0) {<a name="line.453"></a> <FONT color="green">454</FONT> throw MathRuntimeException.createIllegalArgumentException("matrix must have at least one row");<a name="line.454"></a> <FONT color="green">455</FONT> }<a name="line.455"></a> <FONT color="green">456</FONT> final FieldMatrix<T> m = createFieldMatrix(columnData[0].getField(), nRows, 1);<a name="line.456"></a> <FONT color="green">457</FONT> for (int i = 0; i < nRows; ++i) {<a name="line.457"></a> <FONT color="green">458</FONT> m.setEntry(i, 0, columnData[i]);<a name="line.458"></a> <FONT color="green">459</FONT> }<a name="line.459"></a> <FONT color="green">460</FONT> return m;<a name="line.460"></a> <FONT color="green">461</FONT> }<a name="line.461"></a> <FONT color="green">462</FONT> <a name="line.462"></a> <FONT color="green">463</FONT> /**<a name="line.463"></a> <FONT color="green">464</FONT> * Creates a column {@link BigMatrix} using the data from the input<a name="line.464"></a> <FONT color="green">465</FONT> * array.<a name="line.465"></a> <FONT color="green">466</FONT> *<a name="line.466"></a> <FONT color="green">467</FONT> * @param columnData the input column data<a name="line.467"></a> <FONT color="green">468</FONT> * @return a columnData x 1 BigMatrix<a name="line.468"></a> <FONT color="green">469</FONT> * @throws IllegalArgumentException if <code>columnData</code> is empty<a name="line.469"></a> <FONT color="green">470</FONT> * @throws NullPointerException if <code>columnData</code>is null<a name="line.470"></a> <FONT color="green">471</FONT> * @deprecated since 2.0 replaced by {@link #createColumnFieldMatrix(FieldElement[])}<a name="line.471"></a> <FONT color="green">472</FONT> */<a name="line.472"></a> <FONT color="green">473</FONT> @Deprecated<a name="line.473"></a> <FONT color="green">474</FONT> public static BigMatrix createColumnBigMatrix(double[] columnData) {<a name="line.474"></a> <FONT color="green">475</FONT> final int nRows = columnData.length;<a name="line.475"></a> <FONT color="green">476</FONT> final BigDecimal[][] data = new BigDecimal[nRows][1];<a name="line.476"></a> <FONT color="green">477</FONT> for (int row = 0; row < nRows; row++) {<a name="line.477"></a> <FONT color="green">478</FONT> data[row][0] = new BigDecimal(columnData[row]);<a name="line.478"></a> <FONT color="green">479</FONT> }<a name="line.479"></a> <FONT color="green">480</FONT> return new BigMatrixImpl(data, false);<a name="line.480"></a> <FONT color="green">481</FONT> }<a name="line.481"></a> <FONT color="green">482</FONT> <a name="line.482"></a> <FONT color="green">483</FONT> /**<a name="line.483"></a> <FONT color="green">484</FONT> * Creates a column {@link BigMatrix} using the data from the input<a name="line.484"></a> <FONT color="green">485</FONT> * array.<a name="line.485"></a> <FONT color="green">486</FONT> *<a name="line.486"></a> <FONT color="green">487</FONT> * @param columnData the input column data<a name="line.487"></a> <FONT color="green">488</FONT> * @return a columnData x 1 BigMatrix<a name="line.488"></a> <FONT color="green">489</FONT> * @throws IllegalArgumentException if <code>columnData</code> is empty<a name="line.489"></a> <FONT color="green">490</FONT> * @throws NullPointerException if <code>columnData</code>is null<a name="line.490"></a> <FONT color="green">491</FONT> * @deprecated since 2.0 replaced by {@link #createColumnFieldMatrix(FieldElement[])}<a name="line.491"></a> <FONT color="green">492</FONT> */<a name="line.492"></a> <FONT color="green">493</FONT> @Deprecated<a name="line.493"></a> <FONT color="green">494</FONT> public static BigMatrix createColumnBigMatrix(BigDecimal[] columnData) {<a name="line.494"></a> <FONT color="green">495</FONT> final int nRows = columnData.length;<a name="line.495"></a> <FONT color="green">496</FONT> final BigDecimal[][] data = new BigDecimal[nRows][1];<a name="line.496"></a> <FONT color="green">497</FONT> for (int row = 0; row < nRows; row++) {<a name="line.497"></a> <FONT color="green">498</FONT> data[row][0] = columnData[row];<a name="line.498"></a> <FONT color="green">499</FONT> }<a name="line.499"></a> <FONT color="green">500</FONT> return new BigMatrixImpl(data, false);<a name="line.500"></a> <FONT color="green">501</FONT> }<a name="line.501"></a> <FONT color="green">502</FONT> <a name="line.502"></a> <FONT color="green">503</FONT> /**<a name="line.503"></a> <FONT color="green">504</FONT> * Creates a column {@link BigMatrix} using the data from the input<a name="line.504"></a> <FONT color="green">505</FONT> * array.<a name="line.505"></a> <FONT color="green">506</FONT> *<a name="line.506"></a> <FONT color="green">507</FONT> * @param columnData the input column data<a name="line.507"></a> <FONT color="green">508</FONT> * @return a columnData x 1 BigMatrix<a name="line.508"></a> <FONT color="green">509</FONT> * @throws IllegalArgumentException if <code>columnData</code> is empty<a name="line.509"></a> <FONT color="green">510</FONT> * @throws NullPointerException if <code>columnData</code>is null<a name="line.510"></a> <FONT color="green">511</FONT> * @deprecated since 2.0 replaced by {@link #createColumnFieldMatrix(FieldElement[])}<a name="line.511"></a> <FONT color="green">512</FONT> */<a name="line.512"></a> <FONT color="green">513</FONT> @Deprecated<a name="line.513"></a> <FONT color="green">514</FONT> public static BigMatrix createColumnBigMatrix(String[] columnData) {<a name="line.514"></a> <FONT color="green">515</FONT> int nRows = columnData.length;<a name="line.515"></a> <FONT color="green">516</FONT> final BigDecimal[][] data = new BigDecimal[nRows][1];<a name="line.516"></a> <FONT color="green">517</FONT> for (int row = 0; row < nRows; row++) {<a name="line.517"></a> <FONT color="green">518</FONT> data[row][0] = new BigDecimal(columnData[row]);<a name="line.518"></a> <FONT color="green">519</FONT> }<a name="line.519"></a> <FONT color="green">520</FONT> return new BigMatrixImpl(data, false);<a name="line.520"></a> <FONT color="green">521</FONT> }<a name="line.521"></a> <FONT color="green">522</FONT> <a name="line.522"></a> <FONT color="green">523</FONT> /**<a name="line.523"></a> <FONT color="green">524</FONT> * Check if a row index is valid.<a name="line.524"></a> <FONT color="green">525</FONT> * @param m matrix containing the submatrix<a name="line.525"></a> <FONT color="green">526</FONT> * @param row row index to check<a name="line.526"></a> <FONT color="green">527</FONT> * @exception MatrixIndexException if index is not valid<a name="line.527"></a> <FONT color="green">528</FONT> */<a name="line.528"></a> <FONT color="green">529</FONT> public static void checkRowIndex(final AnyMatrix m, final int row) {<a name="line.529"></a> <FONT color="green">530</FONT> if (row < 0 || row >= m.getRowDimension()) {<a name="line.530"></a> <FONT color="green">531</FONT> throw new MatrixIndexException("row index {0} out of allowed range [{1}, {2}]",<a name="line.531"></a> <FONT color="green">532</FONT> row, 0, m.getRowDimension() - 1);<a name="line.532"></a> <FONT color="green">533</FONT> }<a name="line.533"></a> <FONT color="green">534</FONT> }<a name="line.534"></a> <FONT color="green">535</FONT> <a name="line.535"></a> <FONT color="green">536</FONT> /**<a name="line.536"></a> <FONT color="green">537</FONT> * Check if a column index is valid.<a name="line.537"></a> <FONT color="green">538</FONT> * @param m matrix containing the submatrix<a name="line.538"></a> <FONT color="green">539</FONT> * @param column column index to check<a name="line.539"></a> <FONT color="green">540</FONT> * @exception MatrixIndexException if index is not valid<a name="line.540"></a> <FONT color="green">541</FONT> */<a name="line.541"></a> <FONT color="green">542</FONT> public static void checkColumnIndex(final AnyMatrix m, final int column)<a name="line.542"></a> <FONT color="green">543</FONT> throws MatrixIndexException {<a name="line.543"></a> <FONT color="green">544</FONT> if (column < 0 || column >= m.getColumnDimension()) {<a name="line.544"></a> <FONT color="green">545</FONT> throw new MatrixIndexException("column index {0} out of allowed range [{1}, {2}]",<a name="line.545"></a> <FONT color="green">546</FONT> column, 0, m.getColumnDimension() - 1);<a name="line.546"></a> <FONT color="green">547</FONT> }<a name="line.547"></a> <FONT color="green">548</FONT> }<a name="line.548"></a> <FONT color="green">549</FONT> <a name="line.549"></a> <FONT color="green">550</FONT> /**<a name="line.550"></a> <FONT color="green">551</FONT> * Check if submatrix ranges indices are valid.<a name="line.551"></a> <FONT color="green">552</FONT> * Rows and columns are indicated counting from 0 to n-1.<a name="line.552"></a> <FONT color="green">553</FONT> *<a name="line.553"></a> <FONT color="green">554</FONT> * @param m matrix containing the submatrix<a name="line.554"></a> <FONT color="green">555</FONT> * @param startRow Initial row index<a name="line.555"></a> <FONT color="green">556</FONT> * @param endRow Final row index<a name="line.556"></a> <FONT color="green">557</FONT> * @param startColumn Initial column index<a name="line.557"></a> <FONT color="green">558</FONT> * @param endColumn Final column index<a name="line.558"></a> <FONT color="green">559</FONT> * @exception MatrixIndexException if the indices are not valid<a name="line.559"></a> <FONT color="green">560</FONT> */<a name="line.560"></a> <FONT color="green">561</FONT> public static void checkSubMatrixIndex(final AnyMatrix m,<a name="line.561"></a> <FONT color="green">562</FONT> final int startRow, final int endRow,<a name="line.562"></a> <FONT color="green">563</FONT> final int startColumn, final int endColumn) {<a name="line.563"></a> <FONT color="green">564</FONT> checkRowIndex(m, startRow);<a name="line.564"></a> <FONT color="green">565</FONT> checkRowIndex(m, endRow);<a name="line.565"></a> <FONT color="green">566</FONT> if (startRow > endRow) {<a name="line.566"></a> <FONT color="green">567</FONT> throw new MatrixIndexException("initial row {0} after final row {1}",<a name="line.567"></a> <FONT color="green">568</FONT> startRow, endRow);<a name="line.568"></a> <FONT color="green">569</FONT> }<a name="line.569"></a> <FONT color="green">570</FONT> <a name="line.570"></a> <FONT color="green">571</FONT> checkColumnIndex(m, startColumn);<a name="line.571"></a> <FONT color="green">572</FONT> checkColumnIndex(m, endColumn);<a name="line.572"></a> <FONT color="green">573</FONT> if (startColumn > endColumn) {<a name="line.573"></a> <FONT color="green">574</FONT> throw new MatrixIndexException("initial column {0} after final column {1}",<a name="line.574"></a> <FONT color="green">575</FONT> startColumn, endColumn);<a name="line.575"></a> <FONT color="green">576</FONT> }<a name="line.576"></a> <FONT color="green">577</FONT> <a name="line.577"></a> <FONT color="green">578</FONT> <a name="line.578"></a> <FONT color="green">579</FONT> }<a name="line.579"></a> <FONT color="green">580</FONT> <a name="line.580"></a> <FONT color="green">581</FONT> /**<a name="line.581"></a> <FONT color="green">582</FONT> * Check if submatrix ranges indices are valid.<a name="line.582"></a> <FONT color="green">583</FONT> * Rows and columns are indicated counting from 0 to n-1.<a name="line.583"></a> <FONT color="green">584</FONT> *<a name="line.584"></a> <FONT color="green">585</FONT> * @param m matrix containing the submatrix<a name="line.585"></a> <FONT color="green">586</FONT> * @param selectedRows Array of row indices.<a name="line.586"></a> <FONT color="green">587</FONT> * @param selectedColumns Array of column indices.<a name="line.587"></a> <FONT color="green">588</FONT> * @exception MatrixIndexException if row or column selections are not valid<a name="line.588"></a> <FONT color="green">589</FONT> */<a name="line.589"></a> <FONT color="green">590</FONT> public static void checkSubMatrixIndex(final AnyMatrix m,<a name="line.590"></a> <FONT color="green">591</FONT> final int[] selectedRows, final int[] selectedColumns)<a name="line.591"></a> <FONT color="green">592</FONT> throws MatrixIndexException {<a name="line.592"></a> <FONT color="green">593</FONT> if (selectedRows.length * selectedColumns.length == 0) {<a name="line.593"></a> <FONT color="green">594</FONT> if (selectedRows.length == 0) {<a name="line.594"></a> <FONT color="green">595</FONT> throw new MatrixIndexException("empty selected row index array");<a name="line.595"></a> <FONT color="green">596</FONT> }<a name="line.596"></a> <FONT color="green">597</FONT> throw new MatrixIndexException("empty selected column index array");<a name="line.597"></a> <FONT color="green">598</FONT> }<a name="line.598"></a> <FONT color="green">599</FONT> <a name="line.599"></a> <FONT color="green">600</FONT> for (final int row : selectedRows) {<a name="line.600"></a> <FONT color="green">601</FONT> checkRowIndex(m, row);<a name="line.601"></a> <FONT color="green">602</FONT> }<a name="line.602"></a> <FONT color="green">603</FONT> for (final int column : selectedColumns) {<a name="line.603"></a> <FONT color="green">604</FONT> checkColumnIndex(m, column);<a name="line.604"></a> <FONT color="green">605</FONT> }<a name="line.605"></a> <FONT color="green">606</FONT> }<a name="line.606"></a> <FONT color="green">607</FONT> <a name="line.607"></a> <FONT color="green">608</FONT> /**<a name="line.608"></a> <FONT color="green">609</FONT> * Check if matrices are addition compatible<a name="line.609"></a> <FONT color="green">610</FONT> * @param left left hand side matrix<a name="line.610"></a> <FONT color="green">611</FONT> * @param right right hand side matrix<a name="line.611"></a> <FONT color="green">612</FONT> * @exception IllegalArgumentException if matrices are not addition compatible<a name="line.612"></a> <FONT color="green">613</FONT> */<a name="line.613"></a> <FONT color="green">614</FONT> public static void checkAdditionCompatible(final AnyMatrix left, final AnyMatrix right)<a name="line.614"></a> <FONT color="green">615</FONT> throws IllegalArgumentException {<a name="line.615"></a> <FONT color="green">616</FONT> if ((left.getRowDimension() != right.getRowDimension()) ||<a name="line.616"></a> <FONT color="green">617</FONT> (left.getColumnDimension() != right.getColumnDimension())) {<a name="line.617"></a> <FONT color="green">618</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.618"></a> <FONT color="green">619</FONT> "{0}x{1} and {2}x{3} matrices are not addition compatible",<a name="line.619"></a> <FONT color="green">620</FONT> left.getRowDimension(), left.getColumnDimension(),<a name="line.620"></a> <FONT color="green">621</FONT> right.getRowDimension(), right.getColumnDimension());<a name="line.621"></a> <FONT color="green">622</FONT> }<a name="line.622"></a> <FONT color="green">623</FONT> }<a name="line.623"></a> <FONT color="green">624</FONT> <a name="line.624"></a> <FONT color="green">625</FONT> /**<a name="line.625"></a> <FONT color="green">626</FONT> * Check if matrices are subtraction compatible<a name="line.626"></a> <FONT color="green">627</FONT> * @param left left hand side matrix<a name="line.627"></a> <FONT color="green">628</FONT> * @param right right hand side matrix<a name="line.628"></a> <FONT color="green">629</FONT> * @exception IllegalArgumentException if matrices are not subtraction compatible<a name="line.629"></a> <FONT color="green">630</FONT> */<a name="line.630"></a> <FONT color="green">631</FONT> public static void checkSubtractionCompatible(final AnyMatrix left, final AnyMatrix right)<a name="line.631"></a> <FONT color="green">632</FONT> throws IllegalArgumentException {<a name="line.632"></a> <FONT color="green">633</FONT> if ((left.getRowDimension() != right.getRowDimension()) ||<a name="line.633"></a> <FONT color="green">634</FONT> (left.getColumnDimension() != right.getColumnDimension())) {<a name="line.634"></a> <FONT color="green">635</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.635"></a> <FONT color="green">636</FONT> "{0}x{1} and {2}x{3} matrices are not subtraction compatible",<a name="line.636"></a> <FONT color="green">637</FONT> left.getRowDimension(), left.getColumnDimension(),<a name="line.637"></a> <FONT color="green">638</FONT> right.getRowDimension(), right.getColumnDimension());<a name="line.638"></a> <FONT color="green">639</FONT> }<a name="line.639"></a> <FONT color="green">640</FONT> }<a name="line.640"></a> <FONT color="green">641</FONT> <a name="line.641"></a> <FONT color="green">642</FONT> /**<a name="line.642"></a> <FONT color="green">643</FONT> * Check if matrices are multiplication compatible<a name="line.643"></a> <FONT color="green">644</FONT> * @param left left hand side matrix<a name="line.644"></a> <FONT color="green">645</FONT> * @param right right hand side matrix<a name="line.645"></a> <FONT color="green">646</FONT> * @exception IllegalArgumentException if matrices are not multiplication compatible<a name="line.646"></a> <FONT color="green">647</FONT> */<a name="line.647"></a> <FONT color="green">648</FONT> public static void checkMultiplicationCompatible(final AnyMatrix left, final AnyMatrix right)<a name="line.648"></a> <FONT color="green">649</FONT> throws IllegalArgumentException {<a name="line.649"></a> <FONT color="green">650</FONT> if (left.getColumnDimension() != right.getRowDimension()) {<a name="line.650"></a> <FONT color="green">651</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.651"></a> <FONT color="green">652</FONT> "{0}x{1} and {2}x{3} matrices are not multiplication compatible",<a name="line.652"></a> <FONT color="green">653</FONT> left.getRowDimension(), left.getColumnDimension(),<a name="line.653"></a> <FONT color="green">654</FONT> right.getRowDimension(), right.getColumnDimension());<a name="line.654"></a> <FONT color="green">655</FONT> }<a name="line.655"></a> <FONT color="green">656</FONT> }<a name="line.656"></a> <FONT color="green">657</FONT> <a name="line.657"></a> <FONT color="green">658</FONT> /**<a name="line.658"></a> <FONT color="green">659</FONT> * Convert a {@link FieldMatrix}/{@link Fraction} matrix to a {@link RealMatrix}.<a name="line.659"></a> <FONT color="green">660</FONT> * @param m matrix to convert<a name="line.660"></a> <FONT color="green">661</FONT> * @return converted matrix<a name="line.661"></a> <FONT color="green">662</FONT> */<a name="line.662"></a> <FONT color="green">663</FONT> public static Array2DRowRealMatrix fractionMatrixToRealMatrix(final FieldMatrix<Fraction> m) {<a name="line.663"></a> <FONT color="green">664</FONT> final FractionMatrixConverter converter = new FractionMatrixConverter();<a name="line.664"></a> <FONT color="green">665</FONT> m.walkInOptimizedOrder(converter);<a name="line.665"></a> <FONT color="green">666</FONT> return converter.getConvertedMatrix();<a name="line.666"></a> <FONT color="green">667</FONT> }<a name="line.667"></a> <FONT color="green">668</FONT> <a name="line.668"></a> <FONT color="green">669</FONT> /** Converter for {@link FieldMatrix}/{@link Fraction}. */<a name="line.669"></a> <FONT color="green">670</FONT> private static class FractionMatrixConverter extends DefaultFieldMatrixPreservingVisitor<Fraction> {<a name="line.670"></a> <FONT color="green">671</FONT> <a name="line.671"></a> <FONT color="green">672</FONT> /** Converted array. */<a name="line.672"></a> <FONT color="green">673</FONT> private double[][] data;<a name="line.673"></a> <FONT color="green">674</FONT> <a name="line.674"></a> <FONT color="green">675</FONT> /** Simple constructor. */<a name="line.675"></a> <FONT color="green">676</FONT> public FractionMatrixConverter() {<a name="line.676"></a> <FONT color="green">677</FONT> super(Fraction.ZERO);<a name="line.677"></a> <FONT color="green">678</FONT> }<a name="line.678"></a> <FONT color="green">679</FONT> <a name="line.679"></a> <FONT color="green">680</FONT> /** {@inheritDoc} */<a name="line.680"></a> <FONT color="green">681</FONT> @Override<a name="line.681"></a> <FONT color="green">682</FONT> public void start(int rows, int columns,<a name="line.682"></a> <FONT color="green">683</FONT> int startRow, int endRow, int startColumn, int endColumn) {<a name="line.683"></a> <FONT color="green">684</FONT> data = new double[rows][columns];<a name="line.684"></a> <FONT color="green">685</FONT> }<a name="line.685"></a> <FONT color="green">686</FONT> <a name="line.686"></a> <FONT color="green">687</FONT> /** {@inheritDoc} */<a name="line.687"></a> <FONT color="green">688</FONT> @Override<a name="line.688"></a> <FONT color="green">689</FONT> public void visit(int row, int column, Fraction value) {<a name="line.689"></a> <FONT color="green">690</FONT> data[row][column] = value.doubleValue();<a name="line.690"></a> <FONT color="green">691</FONT> }<a name="line.691"></a> <FONT color="green">692</FONT> <a name="line.692"></a> <FONT color="green">693</FONT> /** Get the converted matrix.<a name="line.693"></a> <FONT color="green">694</FONT> * @return converted matrix<a name="line.694"></a> <FONT color="green">695</FONT> */<a name="line.695"></a> <FONT color="green">696</FONT> Array2DRowRealMatrix getConvertedMatrix() {<a name="line.696"></a> <FONT color="green">697</FONT> return new Array2DRowRealMatrix(data, false);<a name="line.697"></a> <FONT color="green">698</FONT> }<a name="line.698"></a> <FONT color="green">699</FONT> <a name="line.699"></a> <FONT color="green">700</FONT> }<a name="line.700"></a> <FONT color="green">701</FONT> <a name="line.701"></a> <FONT color="green">702</FONT> /**<a name="line.702"></a> <FONT color="green">703</FONT> * Convert a {@link FieldMatrix}/{@link BigFraction} matrix to a {@link RealMatrix}.<a name="line.703"></a> <FONT color="green">704</FONT> * @param m matrix to convert<a name="line.704"></a> <FONT color="green">705</FONT> * @return converted matrix<a name="line.705"></a> <FONT color="green">706</FONT> */<a name="line.706"></a> <FONT color="green">707</FONT> public static Array2DRowRealMatrix bigFractionMatrixToRealMatrix(final FieldMatrix<BigFraction> m) {<a name="line.707"></a> <FONT color="green">708</FONT> final BigFractionMatrixConverter converter = new BigFractionMatrixConverter();<a name="line.708"></a> <FONT color="green">709</FONT> m.walkInOptimizedOrder(converter);<a name="line.709"></a> <FONT color="green">710</FONT> return converter.getConvertedMatrix();<a name="line.710"></a> <FONT color="green">711</FONT> }<a name="line.711"></a> <FONT color="green">712</FONT> <a name="line.712"></a> <FONT color="green">713</FONT> /** Converter for {@link FieldMatrix}/{@link BigFraction}. */<a name="line.713"></a> <FONT color="green">714</FONT> private static class BigFractionMatrixConverter extends DefaultFieldMatrixPreservingVisitor<BigFraction> {<a name="line.714"></a> <FONT color="green">715</FONT> <a name="line.715"></a> <FONT color="green">716</FONT> /** Converted array. */<a name="line.716"></a> <FONT color="green">717</FONT> private double[][] data;<a name="line.717"></a> <FONT color="green">718</FONT> <a name="line.718"></a> <FONT color="green">719</FONT> /** Simple constructor. */<a name="line.719"></a> <FONT color="green">720</FONT> public BigFractionMatrixConverter() {<a name="line.720"></a> <FONT color="green">721</FONT> super(BigFraction.ZERO);<a name="line.721"></a> <FONT color="green">722</FONT> }<a name="line.722"></a> <FONT color="green">723</FONT> <a name="line.723"></a> <FONT color="green">724</FONT> /** {@inheritDoc} */<a name="line.724"></a> <FONT color="green">725</FONT> @Override<a name="line.725"></a> <FONT color="green">726</FONT> public void start(int rows, int columns,<a name="line.726"></a> <FONT color="green">727</FONT> int startRow, int endRow, int startColumn, int endColumn) {<a name="line.727"></a> <FONT color="green">728</FONT> data = new double[rows][columns];<a name="line.728"></a> <FONT color="green">729</FONT> }<a name="line.729"></a> <FONT color="green">730</FONT> <a name="line.730"></a> <FONT color="green">731</FONT> /** {@inheritDoc} */<a name="line.731"></a> <FONT color="green">732</FONT> @Override<a name="line.732"></a> <FONT color="green">733</FONT> public void visit(int row, int column, BigFraction value) {<a name="line.733"></a> <FONT color="green">734</FONT> data[row][column] = value.doubleValue();<a name="line.734"></a> <FONT color="green">735</FONT> }<a name="line.735"></a> <FONT color="green">736</FONT> <a name="line.736"></a> <FONT color="green">737</FONT> /** Get the converted matrix.<a name="line.737"></a> <FONT color="green">738</FONT> * @return converted matrix<a name="line.738"></a> <FONT color="green">739</FONT> */<a name="line.739"></a> <FONT color="green">740</FONT> Array2DRowRealMatrix getConvertedMatrix() {<a name="line.740"></a> <FONT color="green">741</FONT> return new Array2DRowRealMatrix(data, false);<a name="line.741"></a> <FONT color="green">742</FONT> }<a name="line.742"></a> <FONT color="green">743</FONT> <a name="line.743"></a> <FONT color="green">744</FONT> }<a name="line.744"></a> <FONT color="green">745</FONT> <a name="line.745"></a> <FONT color="green">746</FONT> /** Serialize a {@link RealVector}.<a name="line.746"></a> <FONT color="green">747</FONT> * <p><a name="line.747"></a> <FONT color="green">748</FONT> * This method is intended to be called from within a private<a name="line.748"></a> <FONT color="green">749</FONT> * <code>writeObject</code> method (after a call to<a name="line.749"></a> <FONT color="green">750</FONT> * <code>oos.defaultWriteObject()</code>) in a class that has a<a name="line.750"></a> <FONT color="green">751</FONT> * {@link RealVector} field, which should be declared <code>transient</code>.<a name="line.751"></a> <FONT color="green">752</FONT> * This way, the default handling does not serialize the vector (the {@link<a name="line.752"></a> <FONT color="green">753</FONT> * RealVector} interface is not serializable by default) but this method does<a name="line.753"></a> <FONT color="green">754</FONT> * serialize it specifically.<a name="line.754"></a> <FONT color="green">755</FONT> * </p><a name="line.755"></a> <FONT color="green">756</FONT> * <p><a name="line.756"></a> <FONT color="green">757</FONT> * The following example shows how a simple class with a name and a real vector<a name="line.757"></a> <FONT color="green">758</FONT> * should be written:<a name="line.758"></a> <FONT color="green">759</FONT> * <pre><code><a name="line.759"></a> <FONT color="green">760</FONT> * public class NamedVector implements Serializable {<a name="line.760"></a> <FONT color="green">761</FONT> *<a name="line.761"></a> <FONT color="green">762</FONT> * private final String name;<a name="line.762"></a> <FONT color="green">763</FONT> * private final transient RealVector coefficients;<a name="line.763"></a> <FONT color="green">764</FONT> *<a name="line.764"></a> <FONT color="green">765</FONT> * // omitted constructors, getters ...<a name="line.765"></a> <FONT color="green">766</FONT> *<a name="line.766"></a> <FONT color="green">767</FONT> * private void writeObject(ObjectOutputStream oos) throws IOException {<a name="line.767"></a> <FONT color="green">768</FONT> * oos.defaultWriteObject(); // takes care of name field<a name="line.768"></a> <FONT color="green">769</FONT> * MatrixUtils.serializeRealVector(coefficients, oos);<a name="line.769"></a> <FONT color="green">770</FONT> * }<a name="line.770"></a> <FONT color="green">771</FONT> *<a name="line.771"></a> <FONT color="green">772</FONT> * private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException {<a name="line.772"></a> <FONT color="green">773</FONT> * ois.defaultReadObject(); // takes care of name field<a name="line.773"></a> <FONT color="green">774</FONT> * MatrixUtils.deserializeRealVector(this, "coefficients", ois);<a name="line.774"></a> <FONT color="green">775</FONT> * }<a name="line.775"></a> <FONT color="green">776</FONT> *<a name="line.776"></a> <FONT color="green">777</FONT> * }<a name="line.777"></a> <FONT color="green">778</FONT> * </code></pre><a name="line.778"></a> <FONT color="green">779</FONT> * </p><a name="line.779"></a> <FONT color="green">780</FONT> *<a name="line.780"></a> <FONT color="green">781</FONT> * @param vector real vector to serialize<a name="line.781"></a> <FONT color="green">782</FONT> * @param oos stream where the real vector should be written<a name="line.782"></a> <FONT color="green">783</FONT> * @exception IOException if object cannot be written to stream<a name="line.783"></a> <FONT color="green">784</FONT> * @see #deserializeRealVector(Object, String, ObjectInputStream)<a name="line.784"></a> <FONT color="green">785</FONT> */<a name="line.785"></a> <FONT color="green">786</FONT> public static void serializeRealVector(final RealVector vector,<a name="line.786"></a> <FONT color="green">787</FONT> final ObjectOutputStream oos)<a name="line.787"></a> <FONT color="green">788</FONT> throws IOException {<a name="line.788"></a> <FONT color="green">789</FONT> final int n = vector.getDimension();<a name="line.789"></a> <FONT color="green">790</FONT> oos.writeInt(n);<a name="line.790"></a> <FONT color="green">791</FONT> for (int i = 0; i < n; ++i) {<a name="line.791"></a> <FONT color="green">792</FONT> oos.writeDouble(vector.getEntry(i));<a name="line.792"></a> <FONT color="green">793</FONT> }<a name="line.793"></a> <FONT color="green">794</FONT> }<a name="line.794"></a> <FONT color="green">795</FONT> <a name="line.795"></a> <FONT color="green">796</FONT> /** Deserialize a {@link RealVector} field in a class.<a name="line.796"></a> <FONT color="green">797</FONT> * <p><a name="line.797"></a> <FONT color="green">798</FONT> * This method is intended to be called from within a private<a name="line.798"></a> <FONT color="green">799</FONT> * <code>readObject</code> method (after a call to<a name="line.799"></a> <FONT color="green">800</FONT> * <code>ois.defaultReadObject()</code>) in a class that has a<a name="line.800"></a> <FONT color="green">801</FONT> * {@link RealVector} field, which should be declared <code>transient</code>.<a name="line.801"></a> <FONT color="green">802</FONT> * This way, the default handling does not deserialize the vector (the {@link<a name="line.802"></a> <FONT color="green">803</FONT> * RealVector} interface is not serializable by default) but this method does<a name="line.803"></a> <FONT color="green">804</FONT> * deserialize it specifically.<a name="line.804"></a> <FONT color="green">805</FONT> * </p><a name="line.805"></a> <FONT color="green">806</FONT> * @param instance instance in which the field must be set up<a name="line.806"></a> <FONT color="green">807</FONT> * @param fieldName name of the field within the class (may be private and final)<a name="line.807"></a> <FONT color="green">808</FONT> * @param ois stream from which the real vector should be read<a name="line.808"></a> <FONT color="green">809</FONT> * @exception ClassNotFoundException if a class in the stream cannot be found<a name="line.809"></a> <FONT color="green">810</FONT> * @exception IOException if object cannot be read from the stream<a name="line.810"></a> <FONT color="green">811</FONT> * @see #serializeRealVector(RealVector, ObjectOutputStream)<a name="line.811"></a> <FONT color="green">812</FONT> */<a name="line.812"></a> <FONT color="green">813</FONT> public static void deserializeRealVector(final Object instance,<a name="line.813"></a> <FONT color="green">814</FONT> final String fieldName,<a name="line.814"></a> <FONT color="green">815</FONT> final ObjectInputStream ois)<a name="line.815"></a> <FONT color="green">816</FONT> throws ClassNotFoundException, IOException {<a name="line.816"></a> <FONT color="green">817</FONT> try {<a name="line.817"></a> <FONT color="green">818</FONT> <a name="line.818"></a> <FONT color="green">819</FONT> // read the vector data<a name="line.819"></a> <FONT color="green">820</FONT> final int n = ois.readInt();<a name="line.820"></a> <FONT color="green">821</FONT> final double[] data = new double[n];<a name="line.821"></a> <FONT color="green">822</FONT> for (int i = 0; i < n; ++i) {<a name="line.822"></a> <FONT color="green">823</FONT> data[i] = ois.readDouble();<a name="line.823"></a> <FONT color="green">824</FONT> }<a name="line.824"></a> <FONT color="green">825</FONT> <a name="line.825"></a> <FONT color="green">826</FONT> // create the instance<a name="line.826"></a> <FONT color="green">827</FONT> final RealVector vector = new ArrayRealVector(data, false);<a name="line.827"></a> <FONT color="green">828</FONT> <a name="line.828"></a> <FONT color="green">829</FONT> // set up the field<a name="line.829"></a> <FONT color="green">830</FONT> final java.lang.reflect.Field f =<a name="line.830"></a> <FONT color="green">831</FONT> instance.getClass().getDeclaredField(fieldName);<a name="line.831"></a> <FONT color="green">832</FONT> f.setAccessible(true);<a name="line.832"></a> <FONT color="green">833</FONT> f.set(instance, vector);<a name="line.833"></a> <FONT color="green">834</FONT> <a name="line.834"></a> <FONT color="green">835</FONT> } catch (NoSuchFieldException nsfe) {<a name="line.835"></a> <FONT color="green">836</FONT> IOException ioe = new IOException();<a name="line.836"></a> <FONT color="green">837</FONT> ioe.initCause(nsfe);<a name="line.837"></a> <FONT color="green">838</FONT> throw ioe;<a name="line.838"></a> <FONT color="green">839</FONT> } catch (IllegalAccessException iae) {<a name="line.839"></a> <FONT color="green">840</FONT> IOException ioe = new IOException();<a name="line.840"></a> <FONT color="green">841</FONT> ioe.initCause(iae);<a name="line.841"></a> <FONT color="green">842</FONT> throw ioe;<a name="line.842"></a> <FONT color="green">843</FONT> }<a name="line.843"></a> <FONT color="green">844</FONT> <a name="line.844"></a> <FONT color="green">845</FONT> }<a name="line.845"></a> <FONT color="green">846</FONT> <a name="line.846"></a> <FONT color="green">847</FONT> /** Serialize a {@link RealMatrix}.<a name="line.847"></a> <FONT color="green">848</FONT> * <p><a name="line.848"></a> <FONT color="green">849</FONT> * This method is intended to be called from within a private<a name="line.849"></a> <FONT color="green">850</FONT> * <code>writeObject</code> method (after a call to<a name="line.850"></a> <FONT color="green">851</FONT> * <code>oos.defaultWriteObject()</code>) in a class that has a<a name="line.851"></a> <FONT color="green">852</FONT> * {@link RealMatrix} field, which should be declared <code>transient</code>.<a name="line.852"></a> <FONT color="green">853</FONT> * This way, the default handling does not serialize the matrix (the {@link<a name="line.853"></a> <FONT color="green">854</FONT> * RealMatrix} interface is not serializable by default) but this method does<a name="line.854"></a> <FONT color="green">855</FONT> * serialize it specifically.<a name="line.855"></a> <FONT color="green">856</FONT> * </p><a name="line.856"></a> <FONT color="green">857</FONT> * <p><a name="line.857"></a> <FONT color="green">858</FONT> * The following example shows how a simple class with a name and a real matrix<a name="line.858"></a> <FONT color="green">859</FONT> * should be written:<a name="line.859"></a> <FONT color="green">860</FONT> * <pre><code><a name="line.860"></a> <FONT color="green">861</FONT> * public class NamedMatrix implements Serializable {<a name="line.861"></a> <FONT color="green">862</FONT> *<a name="line.862"></a> <FONT color="green">863</FONT> * private final String name;<a name="line.863"></a> <FONT color="green">864</FONT> * private final transient RealMatrix coefficients;<a name="line.864"></a> <FONT color="green">865</FONT> *<a name="line.865"></a> <FONT color="green">866</FONT> * // omitted constructors, getters ...<a name="line.866"></a> <FONT color="green">867</FONT> *<a name="line.867"></a> <FONT color="green">868</FONT> * private void writeObject(ObjectOutputStream oos) throws IOException {<a name="line.868"></a> <FONT color="green">869</FONT> * oos.defaultWriteObject(); // takes care of name field<a name="line.869"></a> <FONT color="green">870</FONT> * MatrixUtils.serializeRealMatrix(coefficients, oos);<a name="line.870"></a> <FONT color="green">871</FONT> * }<a name="line.871"></a> <FONT color="green">872</FONT> *<a name="line.872"></a> <FONT color="green">873</FONT> * private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException {<a name="line.873"></a> <FONT color="green">874</FONT> * ois.defaultReadObject(); // takes care of name field<a name="line.874"></a> <FONT color="green">875</FONT> * MatrixUtils.deserializeRealMatrix(this, "coefficients", ois);<a name="line.875"></a> <FONT color="green">876</FONT> * }<a name="line.876"></a> <FONT color="green">877</FONT> *<a name="line.877"></a> <FONT color="green">878</FONT> * }<a name="line.878"></a> <FONT color="green">879</FONT> * </code></pre><a name="line.879"></a> <FONT color="green">880</FONT> * </p><a name="line.880"></a> <FONT color="green">881</FONT> *<a name="line.881"></a> <FONT color="green">882</FONT> * @param matrix real matrix to serialize<a name="line.882"></a> <FONT color="green">883</FONT> * @param oos stream where the real matrix should be written<a name="line.883"></a> <FONT color="green">884</FONT> * @exception IOException if object cannot be written to stream<a name="line.884"></a> <FONT color="green">885</FONT> * @see #deserializeRealMatrix(Object, String, ObjectInputStream)<a name="line.885"></a> <FONT color="green">886</FONT> */<a name="line.886"></a> <FONT color="green">887</FONT> public static void serializeRealMatrix(final RealMatrix matrix,<a name="line.887"></a> <FONT color="green">888</FONT> final ObjectOutputStream oos)<a name="line.888"></a> <FONT color="green">889</FONT> throws IOException {<a name="line.889"></a> <FONT color="green">890</FONT> final int n = matrix.getRowDimension();<a name="line.890"></a> <FONT color="green">891</FONT> final int m = matrix.getColumnDimension();<a name="line.891"></a> <FONT color="green">892</FONT> oos.writeInt(n);<a name="line.892"></a> <FONT color="green">893</FONT> oos.writeInt(m);<a name="line.893"></a> <FONT color="green">894</FONT> for (int i = 0; i < n; ++i) {<a name="line.894"></a> <FONT color="green">895</FONT> for (int j = 0; j < m; ++j) {<a name="line.895"></a> <FONT color="green">896</FONT> oos.writeDouble(matrix.getEntry(i, j));<a name="line.896"></a> <FONT color="green">897</FONT> }<a name="line.897"></a> <FONT color="green">898</FONT> }<a name="line.898"></a> <FONT color="green">899</FONT> }<a name="line.899"></a> <FONT color="green">900</FONT> <a name="line.900"></a> <FONT color="green">901</FONT> /** Deserialize a {@link RealMatrix} field in a class.<a name="line.901"></a> <FONT color="green">902</FONT> * <p><a name="line.902"></a> <FONT color="green">903</FONT> * This method is intended to be called from within a private<a name="line.903"></a> <FONT color="green">904</FONT> * <code>readObject</code> method (after a call to<a name="line.904"></a> <FONT color="green">905</FONT> * <code>ois.defaultReadObject()</code>) in a class that has a<a name="line.905"></a> <FONT color="green">906</FONT> * {@link RealMatrix} field, which should be declared <code>transient</code>.<a name="line.906"></a> <FONT color="green">907</FONT> * This way, the default handling does not deserialize the matrix (the {@link<a name="line.907"></a> <FONT color="green">908</FONT> * RealMatrix} interface is not serializable by default) but this method does<a name="line.908"></a> <FONT color="green">909</FONT> * deserialize it specifically.<a name="line.909"></a> <FONT color="green">910</FONT> * </p><a name="line.910"></a> <FONT color="green">911</FONT> * @param instance instance in which the field must be set up<a name="line.911"></a> <FONT color="green">912</FONT> * @param fieldName name of the field within the class (may be private and final)<a name="line.912"></a> <FONT color="green">913</FONT> * @param ois stream from which the real matrix should be read<a name="line.913"></a> <FONT color="green">914</FONT> * @exception ClassNotFoundException if a class in the stream cannot be found<a name="line.914"></a> <FONT color="green">915</FONT> * @exception IOException if object cannot be read from the stream<a name="line.915"></a> <FONT color="green">916</FONT> * @see #serializeRealMatrix(RealMatrix, ObjectOutputStream)<a name="line.916"></a> <FONT color="green">917</FONT> */<a name="line.917"></a> <FONT color="green">918</FONT> public static void deserializeRealMatrix(final Object instance,<a name="line.918"></a> <FONT color="green">919</FONT> final String fieldName,<a name="line.919"></a> <FONT color="green">920</FONT> final ObjectInputStream ois)<a name="line.920"></a> <FONT color="green">921</FONT> throws ClassNotFoundException, IOException {<a name="line.921"></a> <FONT color="green">922</FONT> try {<a name="line.922"></a> <FONT color="green">923</FONT> <a name="line.923"></a> <FONT color="green">924</FONT> // read the matrix data<a name="line.924"></a> <FONT color="green">925</FONT> final int n = ois.readInt();<a name="line.925"></a> <FONT color="green">926</FONT> final int m = ois.readInt();<a name="line.926"></a> <FONT color="green">927</FONT> final double[][] data = new double[n][m];<a name="line.927"></a> <FONT color="green">928</FONT> for (int i = 0; i < n; ++i) {<a name="line.928"></a> <FONT color="green">929</FONT> final double[] dataI = data[i];<a name="line.929"></a> <FONT color="green">930</FONT> for (int j = 0; j < m; ++j) {<a name="line.930"></a> <FONT color="green">931</FONT> dataI[j] = ois.readDouble();<a name="line.931"></a> <FONT color="green">932</FONT> }<a name="line.932"></a> <FONT color="green">933</FONT> }<a name="line.933"></a> <FONT color="green">934</FONT> <a name="line.934"></a> <FONT color="green">935</FONT> // create the instance<a name="line.935"></a> <FONT color="green">936</FONT> final RealMatrix matrix = new Array2DRowRealMatrix(data, false);<a name="line.936"></a> <FONT color="green">937</FONT> <a name="line.937"></a> <FONT color="green">938</FONT> // set up the field<a name="line.938"></a> <FONT color="green">939</FONT> final java.lang.reflect.Field f =<a name="line.939"></a> <FONT color="green">940</FONT> instance.getClass().getDeclaredField(fieldName);<a name="line.940"></a> <FONT color="green">941</FONT> f.setAccessible(true);<a name="line.941"></a> <FONT color="green">942</FONT> f.set(instance, matrix);<a name="line.942"></a> <FONT color="green">943</FONT> <a name="line.943"></a> <FONT color="green">944</FONT> } catch (NoSuchFieldException nsfe) {<a name="line.944"></a> <FONT color="green">945</FONT> IOException ioe = new IOException();<a name="line.945"></a> <FONT color="green">946</FONT> ioe.initCause(nsfe);<a name="line.946"></a> <FONT color="green">947</FONT> throw ioe;<a name="line.947"></a> <FONT color="green">948</FONT> } catch (IllegalAccessException iae) {<a name="line.948"></a> <FONT color="green">949</FONT> IOException ioe = new IOException();<a name="line.949"></a> <FONT color="green">950</FONT> ioe.initCause(iae);<a name="line.950"></a> <FONT color="green">951</FONT> throw ioe;<a name="line.951"></a> <FONT color="green">952</FONT> }<a name="line.952"></a> <FONT color="green">953</FONT> <a name="line.953"></a> <FONT color="green">954</FONT> }<a name="line.954"></a> <FONT color="green">955</FONT> <a name="line.955"></a> <FONT color="green">956</FONT> }<a name="line.956"></a> </PRE> </BODY> </HTML>