blob: 0092545ce82ff56a9132c5d8b321cd7a36902ff9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*-<a name="line.1"></a>
<span class="sourceLineNo">002</span> *******************************************************************************<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (c) 2015, 2016 Diamond Light Source Ltd.<a name="line.3"></a>
<span class="sourceLineNo">004</span> * All rights reserved. This program and the accompanying materials<a name="line.4"></a>
<span class="sourceLineNo">005</span> * are made available under the terms of the Eclipse Public License v1.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * which accompanies this distribution, and is available at<a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.eclipse.org/legal/epl-v10.html<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * Contributors:<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Peter Chang - initial API and implementation and/or initial documentation<a name="line.10"></a>
<span class="sourceLineNo">011</span> *******************************************************************************/<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.eclipse.january.dataset;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>/**<a name="line.15"></a>
<span class="sourceLineNo">016</span> * Class to provide slice iteration through a dataset<a name="line.16"></a>
<span class="sourceLineNo">017</span> * &lt;p&gt;It allows a number of axes to be omitted and iterates over<a name="line.17"></a>
<span class="sourceLineNo">018</span> * the axes left over. The omitted axes define an inner shape and<a name="line.18"></a>
<span class="sourceLineNo">019</span> * the remaining axes define an outer shape which is iterated over.<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span>public class SliceNDIterator extends IndexIterator {<a name="line.21"></a>
<span class="sourceLineNo">022</span> final private int[] shape;<a name="line.22"></a>
<span class="sourceLineNo">023</span> final private int[] start;<a name="line.23"></a>
<span class="sourceLineNo">024</span> final private int[] stop;<a name="line.24"></a>
<span class="sourceLineNo">025</span> final private int[] step;<a name="line.25"></a>
<span class="sourceLineNo">026</span> final private int endrank;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span> final private boolean[] omit; // axes to miss out<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span> /**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * position in source dataset<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span> final private int[] pos;<a name="line.33"></a>
<span class="sourceLineNo">034</span> final private int[] end;<a name="line.34"></a>
<span class="sourceLineNo">035</span> private boolean once;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> private SliceND cSlice; // current slice<a name="line.37"></a>
<span class="sourceLineNo">038</span> <a name="line.38"></a>
<span class="sourceLineNo">039</span> private int sRank; // number of dimensions used (i.e. not missing)<a name="line.39"></a>
<span class="sourceLineNo">040</span> final private SliceND iSlice; // omitted source or inner slice<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> final private SliceND sSlice; // shortened slice<a name="line.42"></a>
<span class="sourceLineNo">043</span> final private int[] sStart; // shortened position<a name="line.43"></a>
<span class="sourceLineNo">044</span> final private int[] sStop; // shortened end<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private SliceND dSlice; // destination slice<a name="line.46"></a>
<span class="sourceLineNo">047</span> private int[] dStart;<a name="line.47"></a>
<span class="sourceLineNo">048</span> private int[] dStop;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * Constructor for an iterator that misses out several axes<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @param slice<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @param axes missing axes<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public SliceNDIterator(SliceND slice, int... axes) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> cSlice = slice.clone();<a name="line.56"></a>
<span class="sourceLineNo">057</span> int[] sShape = cSlice.getSourceShape();<a name="line.57"></a>
<span class="sourceLineNo">058</span> shape = cSlice.getShape().clone();<a name="line.58"></a>
<span class="sourceLineNo">059</span> start = cSlice.getStart();<a name="line.59"></a>
<span class="sourceLineNo">060</span> stop = cSlice.getStop();<a name="line.60"></a>
<span class="sourceLineNo">061</span> step = cSlice.getStep();<a name="line.61"></a>
<span class="sourceLineNo">062</span> for (int s : step) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (s &lt; 0) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> throw new UnsupportedOperationException("Negative steps not implemented");<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> int rank = shape.length;<a name="line.67"></a>
<span class="sourceLineNo">068</span> endrank = rank - 1;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> omit = new boolean[rank];<a name="line.70"></a>
<span class="sourceLineNo">071</span> dSlice = new SliceND(shape);<a name="line.71"></a>
<span class="sourceLineNo">072</span> dStart = dSlice.getStart();<a name="line.72"></a>
<span class="sourceLineNo">073</span> dStop = dSlice.getStop();<a name="line.73"></a>
<span class="sourceLineNo">074</span> sRank = rank;<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (axes != null) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> axes = ShapeUtils.checkAxes(rank, axes);<a name="line.76"></a>
<span class="sourceLineNo">077</span> for (int a : axes) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> if (a &gt;= 0 &amp;&amp; a &lt;= endrank) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> sRank--;<a name="line.79"></a>
<span class="sourceLineNo">080</span> omit[a] = true;<a name="line.80"></a>
<span class="sourceLineNo">081</span> shape[a] = 1;<a name="line.81"></a>
<span class="sourceLineNo">082</span> } else if (a &gt; endrank) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> throw new IllegalArgumentException("Specified axis exceeds dataset rank");<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> cSlice = cSlice.clone();<a name="line.88"></a>
<span class="sourceLineNo">089</span> pos = cSlice.getStart();<a name="line.89"></a>
<span class="sourceLineNo">090</span> end = cSlice.getStop();<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (sRank == rank) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> sStart = pos;<a name="line.92"></a>
<span class="sourceLineNo">093</span> sStop = null;<a name="line.93"></a>
<span class="sourceLineNo">094</span> iSlice = null;<a name="line.94"></a>
<span class="sourceLineNo">095</span> sSlice = cSlice;<a name="line.95"></a>
<span class="sourceLineNo">096</span> } else {<a name="line.96"></a>
<span class="sourceLineNo">097</span> int[] dShape = dSlice.getShape();<a name="line.97"></a>
<span class="sourceLineNo">098</span> int[] oShape = new int[sRank]; // outer shape<a name="line.98"></a>
<span class="sourceLineNo">099</span> int[] iShape = new int[rank - sRank]; // inner shape<a name="line.99"></a>
<span class="sourceLineNo">100</span> for (int i = 0, j = 0, k = 0; i &lt; rank; i++) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (omit[i]) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> iShape[j++] = sShape[i];<a name="line.102"></a>
<span class="sourceLineNo">103</span> } else {<a name="line.103"></a>
<span class="sourceLineNo">104</span> oShape[k++] = sShape[i];<a name="line.104"></a>
<span class="sourceLineNo">105</span> dShape[i] = 1;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> sSlice = new SliceND(oShape);<a name="line.108"></a>
<span class="sourceLineNo">109</span> sStart = sSlice.getStart();<a name="line.109"></a>
<span class="sourceLineNo">110</span> sStop = sSlice.getStop();<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> iSlice = new SliceND(iShape);<a name="line.112"></a>
<span class="sourceLineNo">113</span> for (int i = 0, j = 0, k = 0; i &lt; rank; i++) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (omit[i]) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> iSlice.setSlice(j++, start[i], stop[i], step[i]);<a name="line.115"></a>
<span class="sourceLineNo">116</span> } else {<a name="line.116"></a>
<span class="sourceLineNo">117</span> sSlice.setSlice(k++, start[i], stop[i], step[i]);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> <a name="line.121"></a>
<span class="sourceLineNo">122</span> reset();<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span> public boolean hasNext() {<a name="line.126"></a>
<span class="sourceLineNo">127</span> // now move on one position<a name="line.127"></a>
<span class="sourceLineNo">128</span> if (once) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> once = false;<a name="line.129"></a>
<span class="sourceLineNo">130</span> return true;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> int k = sRank - 1;<a name="line.132"></a>
<span class="sourceLineNo">133</span> for (int j = endrank; j &gt;= 0; j--) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (omit[j]) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> continue;<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> pos[j] += step[j];<a name="line.137"></a>
<span class="sourceLineNo">138</span> end[j] = pos[j] + step[j];<a name="line.138"></a>
<span class="sourceLineNo">139</span> dStart[j]++;<a name="line.139"></a>
<span class="sourceLineNo">140</span> dStop[j]++;<a name="line.140"></a>
<span class="sourceLineNo">141</span> if (pos[j] &gt;= stop[j]) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> pos[j] = start[j];<a name="line.142"></a>
<span class="sourceLineNo">143</span> end[j] = pos[j] + step[j];<a name="line.143"></a>
<span class="sourceLineNo">144</span> dStart[j] = 0;<a name="line.144"></a>
<span class="sourceLineNo">145</span> dStop[j] = 1;<a name="line.145"></a>
<span class="sourceLineNo">146</span> if (sStop != null) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> sStart[k] = pos[j];<a name="line.147"></a>
<span class="sourceLineNo">148</span> sStop[k] = end[j];<a name="line.148"></a>
<span class="sourceLineNo">149</span> k--;<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> } else {<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (sStop != null) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> sStart[k] = pos[j];<a name="line.153"></a>
<span class="sourceLineNo">154</span> sStop[k] = end[j];<a name="line.154"></a>
<span class="sourceLineNo">155</span> k--;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> return true;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> return false;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span> public int[] getPos() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return pos;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
<span class="sourceLineNo">169</span> * Get omitted part of source slice which never changes. I.e. the inner slice<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @return slice (can be null)<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> public SliceND getOmittedSlice() {<a name="line.172"></a>
<span class="sourceLineNo">173</span> return iSlice;<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> /**<a name="line.176"></a>
<span class="sourceLineNo">177</span> * Get output or destination slice<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @return slice <a name="line.178"></a>
<span class="sourceLineNo">179</span> */<a name="line.179"></a>
<span class="sourceLineNo">180</span> public SliceND getOutputSlice() {<a name="line.180"></a>
<span class="sourceLineNo">181</span> return dSlice;<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> /**<a name="line.184"></a>
<span class="sourceLineNo">185</span> * Get current slice<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @return slice<a name="line.186"></a>
<span class="sourceLineNo">187</span> */<a name="line.187"></a>
<span class="sourceLineNo">188</span> public SliceND getCurrentSlice() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> return cSlice;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Shortened position where axes are omitted<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @return used position<a name="line.194"></a>
<span class="sourceLineNo">195</span> */<a name="line.195"></a>
<span class="sourceLineNo">196</span> public int[] getUsedPos() {<a name="line.196"></a>
<span class="sourceLineNo">197</span> return sStart;<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> /**<a name="line.200"></a>
<span class="sourceLineNo">201</span> * Shortened slice where axes are omitted<a name="line.201"></a>
<span class="sourceLineNo">202</span> * @return used (or outer) slice<a name="line.202"></a>
<span class="sourceLineNo">203</span> */<a name="line.203"></a>
<span class="sourceLineNo">204</span> public SliceND getUsedSlice() {<a name="line.204"></a>
<span class="sourceLineNo">205</span> return sSlice;<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span><a name="line.207"></a>
<span class="sourceLineNo">208</span> /**<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @return omit array - array where true means miss out<a name="line.209"></a>
<span class="sourceLineNo">210</span> */<a name="line.210"></a>
<span class="sourceLineNo">211</span> public boolean[] getOmit() {<a name="line.211"></a>
<span class="sourceLineNo">212</span> return omit;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> @Override<a name="line.215"></a>
<span class="sourceLineNo">216</span> public void reset() {<a name="line.216"></a>
<span class="sourceLineNo">217</span> for (int i = 0, k = 0; i &lt;= endrank; i++) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> int b = start[i];<a name="line.218"></a>
<span class="sourceLineNo">219</span> int d = step[i];<a name="line.219"></a>
<span class="sourceLineNo">220</span> if (!omit[i]) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> cSlice.setSlice(i, b, b + d, d);<a name="line.221"></a>
<span class="sourceLineNo">222</span> dStart[i] = 0;<a name="line.222"></a>
<span class="sourceLineNo">223</span> dStop[i] = 1;<a name="line.223"></a>
<span class="sourceLineNo">224</span> if (sStop != null) {<a name="line.224"></a>
<span class="sourceLineNo">225</span> sSlice.setSlice(k++, b, b + d, d);<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span> } else {<a name="line.227"></a>
<span class="sourceLineNo">228</span> cSlice.setSlice(i, b, end[i], d);<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> int j = 0;<a name="line.232"></a>
<span class="sourceLineNo">233</span> for (; j &lt;= endrank; j++) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> if (!omit[j])<a name="line.234"></a>
<span class="sourceLineNo">235</span> break;<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span> if (j &gt; endrank) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> once = true;<a name="line.238"></a>
<span class="sourceLineNo">239</span> return;<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> if (omit[endrank]) {<a name="line.242"></a>
<span class="sourceLineNo">243</span> pos[endrank] = start[endrank];<a name="line.243"></a>
<span class="sourceLineNo">244</span> for (int i = endrank - 1; i &gt;= 0; i--) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> if (!omit[i]) {<a name="line.245"></a>
<span class="sourceLineNo">246</span> end[i] = pos[i];<a name="line.246"></a>
<span class="sourceLineNo">247</span> pos[i] -= step[i];<a name="line.247"></a>
<span class="sourceLineNo">248</span> dStart[i]--;<a name="line.248"></a>
<span class="sourceLineNo">249</span> dStop[i]--;<a name="line.249"></a>
<span class="sourceLineNo">250</span> break;<a name="line.250"></a>
<span class="sourceLineNo">251</span> }<a name="line.251"></a>
<span class="sourceLineNo">252</span> }<a name="line.252"></a>
<span class="sourceLineNo">253</span> } else {<a name="line.253"></a>
<span class="sourceLineNo">254</span> end[endrank] = pos[endrank];<a name="line.254"></a>
<span class="sourceLineNo">255</span> pos[endrank] -= step[endrank];<a name="line.255"></a>
<span class="sourceLineNo">256</span> dStart[endrank]--;<a name="line.256"></a>
<span class="sourceLineNo">257</span> dStop[endrank]--;<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> if (sStart != pos) {<a name="line.260"></a>
<span class="sourceLineNo">261</span> for (int i = 0, k = 0; i &lt;= endrank; i++) {<a name="line.261"></a>
<span class="sourceLineNo">262</span> if (!omit[i]) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> sStart[k++] = pos[i];<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span> }<a name="line.265"></a>
<span class="sourceLineNo">266</span> }<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span> @Override<a name="line.269"></a>
<span class="sourceLineNo">270</span> public int[] getShape() {<a name="line.270"></a>
<span class="sourceLineNo">271</span> return shape;<a name="line.271"></a>
<span class="sourceLineNo">272</span> }<a name="line.272"></a>
<span class="sourceLineNo">273</span>}<a name="line.273"></a>
</pre>
</div>
</body>
</html>