Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/linear/SparseFieldMatrix.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> import org.apache.commons.math.util.OpenIntToFieldHashMap;<a name="line.21"></a> <FONT color="green">022</FONT> <a name="line.22"></a> <FONT color="green">023</FONT> /**<a name="line.23"></a> <FONT color="green">024</FONT> * Sparse matrix implementation based on an open addressed map.<a name="line.24"></a> <FONT color="green">025</FONT> *<a name="line.25"></a> <FONT color="green">026</FONT> * @param <T> the type of the field elements<a name="line.26"></a> <FONT color="green">027</FONT> * @version $Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $<a name="line.27"></a> <FONT color="green">028</FONT> * @since 2.0<a name="line.28"></a> <FONT color="green">029</FONT> */<a name="line.29"></a> <FONT color="green">030</FONT> public class SparseFieldMatrix<T extends FieldElement<T>> extends AbstractFieldMatrix<T> {<a name="line.30"></a> <FONT color="green">031</FONT> /**<a name="line.31"></a> <FONT color="green">032</FONT> * Serial id<a name="line.32"></a> <FONT color="green">033</FONT> */<a name="line.33"></a> <FONT color="green">034</FONT> private static final long serialVersionUID = 9078068119297757342L;<a name="line.34"></a> <FONT color="green">035</FONT> /** Storage for (sparse) matrix elements. */<a name="line.35"></a> <FONT color="green">036</FONT> private final OpenIntToFieldHashMap<T> entries;<a name="line.36"></a> <FONT color="green">037</FONT> /**<a name="line.37"></a> <FONT color="green">038</FONT> * row dimension<a name="line.38"></a> <FONT color="green">039</FONT> */<a name="line.39"></a> <FONT color="green">040</FONT> private final int rows;<a name="line.40"></a> <FONT color="green">041</FONT> /**<a name="line.41"></a> <FONT color="green">042</FONT> * column dimension<a name="line.42"></a> <FONT color="green">043</FONT> */<a name="line.43"></a> <FONT color="green">044</FONT> private final int columns;<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> * Creates a matrix with no data.<a name="line.48"></a> <FONT color="green">049</FONT> * @param field field to which the elements belong<a name="line.49"></a> <FONT color="green">050</FONT> */<a name="line.50"></a> <FONT color="green">051</FONT> public SparseFieldMatrix(final Field<T> field) {<a name="line.51"></a> <FONT color="green">052</FONT> super(field);<a name="line.52"></a> <FONT color="green">053</FONT> rows = 0;<a name="line.53"></a> <FONT color="green">054</FONT> columns= 0;<a name="line.54"></a> <FONT color="green">055</FONT> entries = new OpenIntToFieldHashMap<T>(field);<a name="line.55"></a> <FONT color="green">056</FONT> }<a name="line.56"></a> <FONT color="green">057</FONT> <a name="line.57"></a> <FONT color="green">058</FONT> /**<a name="line.58"></a> <FONT color="green">059</FONT> * Create a new SparseFieldMatrix<T> with the supplied row and column dimensions.<a name="line.59"></a> <FONT color="green">060</FONT> *<a name="line.60"></a> <FONT color="green">061</FONT> * @param field field to which the elements belong<a name="line.61"></a> <FONT color="green">062</FONT> * @param rowDimension the number of rows in the new matrix<a name="line.62"></a> <FONT color="green">063</FONT> * @param columnDimension the number of columns in the new matrix<a name="line.63"></a> <FONT color="green">064</FONT> * @throws IllegalArgumentException if row or column dimension is not positive<a name="line.64"></a> <FONT color="green">065</FONT> */<a name="line.65"></a> <FONT color="green">066</FONT> public SparseFieldMatrix(final Field<T> field,<a name="line.66"></a> <FONT color="green">067</FONT> final int rowDimension, final int columnDimension)<a name="line.67"></a> <FONT color="green">068</FONT> throws IllegalArgumentException {<a name="line.68"></a> <FONT color="green">069</FONT> super(field, rowDimension, columnDimension);<a name="line.69"></a> <FONT color="green">070</FONT> this.rows = rowDimension;<a name="line.70"></a> <FONT color="green">071</FONT> this.columns = columnDimension;<a name="line.71"></a> <FONT color="green">072</FONT> entries = new OpenIntToFieldHashMap<T>(field);<a name="line.72"></a> <FONT color="green">073</FONT> }<a name="line.73"></a> <FONT color="green">074</FONT> <a name="line.74"></a> <FONT color="green">075</FONT> /**<a name="line.75"></a> <FONT color="green">076</FONT> * Copy constructor.<a name="line.76"></a> <FONT color="green">077</FONT> * @param other The instance to copy<a name="line.77"></a> <FONT color="green">078</FONT> */<a name="line.78"></a> <FONT color="green">079</FONT> public SparseFieldMatrix(SparseFieldMatrix<T> other) {<a name="line.79"></a> <FONT color="green">080</FONT> super(other.getField(), other.getRowDimension(), other.getColumnDimension());<a name="line.80"></a> <FONT color="green">081</FONT> rows = other.getRowDimension();<a name="line.81"></a> <FONT color="green">082</FONT> columns = other.getColumnDimension();<a name="line.82"></a> <FONT color="green">083</FONT> entries = new OpenIntToFieldHashMap<T>(other.entries);<a name="line.83"></a> <FONT color="green">084</FONT> }<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> * Generic copy constructor.<a name="line.87"></a> <FONT color="green">088</FONT> * @param other The instance to copy<a name="line.88"></a> <FONT color="green">089</FONT> */<a name="line.89"></a> <FONT color="green">090</FONT> public SparseFieldMatrix(FieldMatrix<T> other){<a name="line.90"></a> <FONT color="green">091</FONT> super(other.getField(), other.getRowDimension(), other.getColumnDimension());<a name="line.91"></a> <FONT color="green">092</FONT> rows = other.getRowDimension();<a name="line.92"></a> <FONT color="green">093</FONT> columns = other.getColumnDimension();<a name="line.93"></a> <FONT color="green">094</FONT> entries = new OpenIntToFieldHashMap<T>(getField());<a name="line.94"></a> <FONT color="green">095</FONT> for (int i = 0; i < rows; i++) {<a name="line.95"></a> <FONT color="green">096</FONT> for (int j = 0; j < columns; j++) {<a name="line.96"></a> <FONT color="green">097</FONT> setEntry(i, j, other.getEntry(i, j));<a name="line.97"></a> <FONT color="green">098</FONT> }<a name="line.98"></a> <FONT color="green">099</FONT> }<a name="line.99"></a> <FONT color="green">100</FONT> }<a name="line.100"></a> <FONT color="green">101</FONT> <a name="line.101"></a> <FONT color="green">102</FONT> /** {@inheritDoc} */<a name="line.102"></a> <FONT color="green">103</FONT> @Override<a name="line.103"></a> <FONT color="green">104</FONT> public void addToEntry(int row, int column, T increment)<a name="line.104"></a> <FONT color="green">105</FONT> throws MatrixIndexException {<a name="line.105"></a> <FONT color="green">106</FONT> checkRowIndex(row);<a name="line.106"></a> <FONT color="green">107</FONT> checkColumnIndex(column);<a name="line.107"></a> <FONT color="green">108</FONT> final int key = computeKey(row, column);<a name="line.108"></a> <FONT color="green">109</FONT> final T value = entries.get(key).add(increment);<a name="line.109"></a> <FONT color="green">110</FONT> if (getField().getZero().equals(value)) {<a name="line.110"></a> <FONT color="green">111</FONT> entries.remove(key);<a name="line.111"></a> <FONT color="green">112</FONT> } else {<a name="line.112"></a> <FONT color="green">113</FONT> entries.put(key, value);<a name="line.113"></a> <FONT color="green">114</FONT> }<a name="line.114"></a> <FONT color="green">115</FONT> <a name="line.115"></a> <FONT color="green">116</FONT> }<a name="line.116"></a> <FONT color="green">117</FONT> <a name="line.117"></a> <FONT color="green">118</FONT> /** {@inheritDoc} */<a name="line.118"></a> <FONT color="green">119</FONT> @Override<a name="line.119"></a> <FONT color="green">120</FONT> public FieldMatrix<T> copy() {<a name="line.120"></a> <FONT color="green">121</FONT> return new SparseFieldMatrix<T>(this);<a name="line.121"></a> <FONT color="green">122</FONT> }<a name="line.122"></a> <FONT color="green">123</FONT> <a name="line.123"></a> <FONT color="green">124</FONT> /** {@inheritDoc} */<a name="line.124"></a> <FONT color="green">125</FONT> @Override<a name="line.125"></a> <FONT color="green">126</FONT> public FieldMatrix<T> createMatrix(int rowDimension, int columnDimension)<a name="line.126"></a> <FONT color="green">127</FONT> throws IllegalArgumentException {<a name="line.127"></a> <FONT color="green">128</FONT> return new SparseFieldMatrix<T>(getField(), rowDimension, columnDimension);<a name="line.128"></a> <FONT color="green">129</FONT> }<a name="line.129"></a> <FONT color="green">130</FONT> <a name="line.130"></a> <FONT color="green">131</FONT> /** {@inheritDoc} */<a name="line.131"></a> <FONT color="green">132</FONT> @Override<a name="line.132"></a> <FONT color="green">133</FONT> public int getColumnDimension() {<a name="line.133"></a> <FONT color="green">134</FONT> return columns;<a name="line.134"></a> <FONT color="green">135</FONT> }<a name="line.135"></a> <FONT color="green">136</FONT> <a name="line.136"></a> <FONT color="green">137</FONT> /** {@inheritDoc} */<a name="line.137"></a> <FONT color="green">138</FONT> @Override<a name="line.138"></a> <FONT color="green">139</FONT> public T getEntry(int row, int column) throws MatrixIndexException {<a name="line.139"></a> <FONT color="green">140</FONT> checkRowIndex(row);<a name="line.140"></a> <FONT color="green">141</FONT> checkColumnIndex(column);<a name="line.141"></a> <FONT color="green">142</FONT> return entries.get(computeKey(row, column));<a name="line.142"></a> <FONT color="green">143</FONT> }<a name="line.143"></a> <FONT color="green">144</FONT> <a name="line.144"></a> <FONT color="green">145</FONT> /** {@inheritDoc} */<a name="line.145"></a> <FONT color="green">146</FONT> @Override<a name="line.146"></a> <FONT color="green">147</FONT> public int getRowDimension() {<a name="line.147"></a> <FONT color="green">148</FONT> return rows;<a name="line.148"></a> <FONT color="green">149</FONT> }<a name="line.149"></a> <FONT color="green">150</FONT> <a name="line.150"></a> <FONT color="green">151</FONT> /** {@inheritDoc} */<a name="line.151"></a> <FONT color="green">152</FONT> @Override<a name="line.152"></a> <FONT color="green">153</FONT> public void multiplyEntry(int row, int column, T factor)<a name="line.153"></a> <FONT color="green">154</FONT> throws MatrixIndexException {<a name="line.154"></a> <FONT color="green">155</FONT> checkRowIndex(row);<a name="line.155"></a> <FONT color="green">156</FONT> checkColumnIndex(column);<a name="line.156"></a> <FONT color="green">157</FONT> final int key = computeKey(row, column);<a name="line.157"></a> <FONT color="green">158</FONT> final T value = entries.get(key).multiply(factor);<a name="line.158"></a> <FONT color="green">159</FONT> if (getField().getZero().equals(value)) {<a name="line.159"></a> <FONT color="green">160</FONT> entries.remove(key);<a name="line.160"></a> <FONT color="green">161</FONT> } else {<a name="line.161"></a> <FONT color="green">162</FONT> entries.put(key, value);<a name="line.162"></a> <FONT color="green">163</FONT> }<a name="line.163"></a> <FONT color="green">164</FONT> <a name="line.164"></a> <FONT color="green">165</FONT> }<a name="line.165"></a> <FONT color="green">166</FONT> <a name="line.166"></a> <FONT color="green">167</FONT> /** {@inheritDoc} */<a name="line.167"></a> <FONT color="green">168</FONT> @Override<a name="line.168"></a> <FONT color="green">169</FONT> public void setEntry(int row, int column, T value)<a name="line.169"></a> <FONT color="green">170</FONT> throws MatrixIndexException {<a name="line.170"></a> <FONT color="green">171</FONT> checkRowIndex(row);<a name="line.171"></a> <FONT color="green">172</FONT> checkColumnIndex(column);<a name="line.172"></a> <FONT color="green">173</FONT> if (getField().getZero().equals(value)) {<a name="line.173"></a> <FONT color="green">174</FONT> entries.remove(computeKey(row, column));<a name="line.174"></a> <FONT color="green">175</FONT> } else {<a name="line.175"></a> <FONT color="green">176</FONT> entries.put(computeKey(row, column), value);<a name="line.176"></a> <FONT color="green">177</FONT> }<a name="line.177"></a> <FONT color="green">178</FONT> <a name="line.178"></a> <FONT color="green">179</FONT> }<a name="line.179"></a> <FONT color="green">180</FONT> /**<a name="line.180"></a> <FONT color="green">181</FONT> * Compute the key to access a matrix element<a name="line.181"></a> <FONT color="green">182</FONT> * @param row row index of the matrix element<a name="line.182"></a> <FONT color="green">183</FONT> * @param column column index of the matrix element<a name="line.183"></a> <FONT color="green">184</FONT> * @return key within the map to access the matrix element<a name="line.184"></a> <FONT color="green">185</FONT> */<a name="line.185"></a> <FONT color="green">186</FONT> private int computeKey(int row, int column) {<a name="line.186"></a> <FONT color="green">187</FONT> return row * columns + column;<a name="line.187"></a> <FONT color="green">188</FONT> }<a name="line.188"></a> <FONT color="green">189</FONT> <a name="line.189"></a> <FONT color="green">190</FONT> }<a name="line.190"></a> </PRE> </BODY> </HTML>