blob: 1716f4243b23ccf09d49d1fa2e6668a929849860 [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> * Copyright 2016 Diamond Light Source Ltd.<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<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><a name="line.9"></a>
<span class="sourceLineNo">010</span>package org.eclipse.january.dataset;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.Arrays;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>/**<a name="line.14"></a>
<span class="sourceLineNo">015</span> * Base class for boolean iterators for pairs of dataset where the second dataset could be broadcast to the first and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * is used to select where {{@link #hasNext()} returns true. An optional third dataset can specify the output.<a name="line.16"></a>
<span class="sourceLineNo">017</span> * For speed, there are public members.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>public abstract class BooleanIterator extends IndexIterator {<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span> /**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Create a boolean iterator that stops at every position in the choice dataset with a true value<a name="line.22"></a>
<span class="sourceLineNo">023</span> * @param a primary dataset<a name="line.23"></a>
<span class="sourceLineNo">024</span> * @param c choice dataset, can be null to choose all<a name="line.24"></a>
<span class="sourceLineNo">025</span> * @since 2.1<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span> public static BooleanIterator createIterator(Dataset a, Dataset c) {<a name="line.27"></a>
<span class="sourceLineNo">028</span> return createIterator(true, a, c, null, false);<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> /**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Create a boolean iterator that stops at every position in the choice dataset with a true value<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @param a primary dataset<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @param c choice dataset, can be null to choose all<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @param o output dataset, can be null<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @since 2.1<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span> public static BooleanIterator createIterator(Dataset a, Dataset c, Dataset o) {<a name="line.38"></a>
<span class="sourceLineNo">039</span> return createIterator(true, a, c, o, false);<a name="line.39"></a>
<span class="sourceLineNo">040</span> }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Create a boolean iterator that stops at every position in the choice dataset where its value matches<a name="line.43"></a>
<span class="sourceLineNo">044</span> * the given boolean<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param v boolean value<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param a primary dataset<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @param c choice dataset, can be null to choose all<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @param o output dataset, can be null<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @since 2.1<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> public static BooleanIterator createIterator(boolean v, Dataset a, Dataset c, Dataset o) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return createIterator(v, a, c, o, false);<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Create a boolean iterator that stops at every position in the choice dataset where its value matches<a name="line.56"></a>
<span class="sourceLineNo">057</span> * the given boolean<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param v boolean value<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param a primary dataset<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @param c choice dataset, can be null to choose all<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param o output dataset, can be null<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param createIfNull if true create the output dataset if that is null<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @since 2.1<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public static BooleanIterator createIterator(boolean v, Dataset a, Dataset c, Dataset o, boolean createIfNull) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (c == null) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return new BooleanNullIterator(a, o, createIfNull);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> if (Arrays.equals(a.getShapeRef(), c.getShapeRef()) &amp;&amp; a.getStrides() == null &amp;&amp; c.getStrides() == null) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (o == null || (o.getStrides() == null &amp;&amp; Arrays.equals(a.getShapeRef(), o.getShapeRef()))) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return new BooleanContiguousIterator(v, a, c, o, createIfNull);<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> return new BooleanBroadcastIterator(v, a, c, o, createIfNull);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> protected final boolean value;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Index in choice dataset<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public int cIndex;<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Index in output dataset<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public int oIndex;<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Output dataset<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> protected Dataset oDataset;<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> final protected boolean outputA;<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> protected int[] maxShape;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> protected final int aStep; // step over items<a name="line.98"></a>
<span class="sourceLineNo">099</span> protected int oStep;<a name="line.99"></a>
<span class="sourceLineNo">100</span> protected int aMax; // maximum index in array<a name="line.100"></a>
<span class="sourceLineNo">101</span> protected int aStart, oStart;<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> protected Dataset aDataset;<a name="line.103"></a>
<span class="sourceLineNo">104</span> protected Dataset cDataset;<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @return choice<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @since 2.1<a name="line.108"></a>
<span class="sourceLineNo">109</span> */<a name="line.109"></a>
<span class="sourceLineNo">110</span> public Dataset getChoice() {<a name="line.110"></a>
<span class="sourceLineNo">111</span> return cDataset;<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> @Override<a name="line.114"></a>
<span class="sourceLineNo">115</span> public int[] getShape() {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return maxShape;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<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> * Construct a boolean iterator that stops at the given boolean value in choice dataset<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @param v boolean value<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @param a primary dataset<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @param c choice dataset<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @param o output dataset, can be null<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> protected BooleanIterator(boolean v, Dataset a, Dataset c, Dataset o) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> value = v;<a name="line.127"></a>
<span class="sourceLineNo">128</span> aDataset = a;<a name="line.128"></a>
<span class="sourceLineNo">129</span> aStep = a.getElementsPerItem();<a name="line.129"></a>
<span class="sourceLineNo">130</span> cDataset = c;<a name="line.130"></a>
<span class="sourceLineNo">131</span> oDataset = o;<a name="line.131"></a>
<span class="sourceLineNo">132</span> outputA = a == o;<a name="line.132"></a>
<span class="sourceLineNo">133</span> if (c != null &amp;&amp; c == o) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> throw new IllegalArgumentException("Output dataset must not be same as mask dataset");<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> if (c != null) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> BroadcastUtils.checkItemSize(a, c, o);<a name="line.138"></a>
<span class="sourceLineNo">139</span> } else if (o != null) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> BroadcastUtils.checkItemSize(a, o);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> if (o != null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> o.setDirty();<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
<span class="sourceLineNo">148</span> * @return output dataset (can be null)<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @since 2.1<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> public Dataset getOutput() {<a name="line.151"></a>
<span class="sourceLineNo">152</span> return oDataset;<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span>}<a name="line.154"></a>
</pre>
</div>
</body>
</html>