blob: 8cb46364e6d271de0a8f4fc2792ed5b0dd66427f [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) 2011, 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>import java.util.ArrayList;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.Arrays;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.util.List;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.eclipse.january.DatasetException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.slf4j.Logger;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.slf4j.LoggerFactory;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Mathematics class for lazy datasets<a name="line.24"></a>
<span class="sourceLineNo">025</span> */<a name="line.25"></a>
<span class="sourceLineNo">026</span>public final class LazyMaths {<a name="line.26"></a>
<span class="sourceLineNo">027</span> /**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Setup the logging facilities<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span> protected static final Logger logger = LoggerFactory.getLogger(LazyMaths.class);<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> /**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @param data<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @param axis (can be negative)<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @return sum along axis in lazy dataset<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @throws DatasetException <a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span> public static Dataset sum(final ILazyDataset data, int axis) throws DatasetException {<a name="line.38"></a>
<span class="sourceLineNo">039</span> if (data instanceof Dataset)<a name="line.39"></a>
<span class="sourceLineNo">040</span> return ((Dataset) data).sum(axis);<a name="line.40"></a>
<span class="sourceLineNo">041</span> int[][] sliceInfo = new int[3][];<a name="line.41"></a>
<span class="sourceLineNo">042</span> int[] shape = data.getShape();<a name="line.42"></a>
<span class="sourceLineNo">043</span> final Dataset result = prepareDataset(axis, shape, sliceInfo);<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> final int[] start = sliceInfo[0];<a name="line.45"></a>
<span class="sourceLineNo">046</span> final int[] stop = sliceInfo[1];<a name="line.46"></a>
<span class="sourceLineNo">047</span> final int[] step = sliceInfo[2];<a name="line.47"></a>
<span class="sourceLineNo">048</span> final int length = shape[axis];<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> for (int i = 0; i &lt; length; i++) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> start[axis] = i;<a name="line.51"></a>
<span class="sourceLineNo">052</span> stop[axis] = i + 1;<a name="line.52"></a>
<span class="sourceLineNo">053</span> result.iadd(data.getSlice(start, stop, step));<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> result.setShape(ShapeUtils.squeezeShape(shape, axis));<a name="line.56"></a>
<span class="sourceLineNo">057</span> return result;<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param data<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param ignoreAxes axes to ignore<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @return sum when given axes are ignored in lazy dataset<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @throws DatasetException <a name="line.64"></a>
<span class="sourceLineNo">065</span> * @since 2.0<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public static Dataset sum(final ILazyDataset data, int... ignoreAxes) throws DatasetException {<a name="line.67"></a>
<span class="sourceLineNo">068</span> return sum(data, true, ignoreAxes);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> <a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param data<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param ignore if true, ignore the provided axes, otherwise use only the provided axes <a name="line.73"></a>
<span class="sourceLineNo">074</span> * @param axes axes to ignore or accept, depending on the preceding flag<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @return sum<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @throws DatasetException <a name="line.76"></a>
<span class="sourceLineNo">077</span> * @since 2.0<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> public static Dataset sum(final ILazyDataset data, boolean ignore, int... axes) throws DatasetException {<a name="line.79"></a>
<span class="sourceLineNo">080</span> Arrays.sort(axes); // ensure they are properly sorted<a name="line.80"></a>
<span class="sourceLineNo">081</span> <a name="line.81"></a>
<span class="sourceLineNo">082</span> ILazyDataset rv = data;<a name="line.82"></a>
<span class="sourceLineNo">083</span> <a name="line.83"></a>
<span class="sourceLineNo">084</span> if (ignore) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> List&lt;Integer&gt; goodAxes = new ArrayList&lt;Integer&gt;();<a name="line.85"></a>
<span class="sourceLineNo">086</span> for (int i = 0 ; i &lt; data.getRank() ; i++) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> boolean found = false;<a name="line.87"></a>
<span class="sourceLineNo">088</span> for (int j = 0 ; j &lt; axes.length ; j++) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (i == axes[j]) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> found = true;<a name="line.90"></a>
<span class="sourceLineNo">091</span> break;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (!found) <a name="line.94"></a>
<span class="sourceLineNo">095</span> goodAxes.add(i);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> for (int i = 0 ; i &lt; goodAxes.size() ; i++) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> rv = sum(rv, goodAxes.get(i) - i);<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> } else {<a name="line.101"></a>
<span class="sourceLineNo">102</span> for (int i = 0 ; i &lt; axes.length ; i++) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> rv = sum(rv, axes[i] - i);<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> return DatasetUtils.sliceAndConvertLazyDataset(rv);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> <a name="line.108"></a>
<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @param data<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @param axis (can be negative)<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @return product along axis in lazy dataset<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @throws DatasetException <a name="line.113"></a>
<span class="sourceLineNo">114</span> */<a name="line.114"></a>
<span class="sourceLineNo">115</span> public static Dataset product(final ILazyDataset data, int axis) throws DatasetException {<a name="line.115"></a>
<span class="sourceLineNo">116</span> int[][] sliceInfo = new int[3][];<a name="line.116"></a>
<span class="sourceLineNo">117</span> int[] shape = data.getShape();<a name="line.117"></a>
<span class="sourceLineNo">118</span> final Dataset result = prepareDataset(axis, shape, sliceInfo);<a name="line.118"></a>
<span class="sourceLineNo">119</span> result.fill(1);<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> final int[] start = sliceInfo[0];<a name="line.121"></a>
<span class="sourceLineNo">122</span> final int[] stop = sliceInfo[1];<a name="line.122"></a>
<span class="sourceLineNo">123</span> final int[] step = sliceInfo[2];<a name="line.123"></a>
<span class="sourceLineNo">124</span> final int length = shape[axis];<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> for (int i = 0; i &lt; length; i++) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> start[axis] = i;<a name="line.127"></a>
<span class="sourceLineNo">128</span> stop[axis] = i + 1;<a name="line.128"></a>
<span class="sourceLineNo">129</span> result.imultiply(data.getSlice(start, stop, step));<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> result.setShape(ShapeUtils.squeezeShape(shape, axis));<a name="line.132"></a>
<span class="sourceLineNo">133</span> return result;<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<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> * @param start<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @param stop inclusive<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param data<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @param ignoreAxes<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @return mean when given axes are ignored in lazy dataset<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @throws DatasetException <a name="line.142"></a>
<span class="sourceLineNo">143</span> */<a name="line.143"></a>
<span class="sourceLineNo">144</span> public static Dataset mean(int start, int stop, ILazyDataset data, int... ignoreAxes) throws DatasetException {<a name="line.144"></a>
<span class="sourceLineNo">145</span> int[] shape = data.getShape();<a name="line.145"></a>
<span class="sourceLineNo">146</span> PositionIterator iter = new PositionIterator(shape, ignoreAxes);<a name="line.146"></a>
<span class="sourceLineNo">147</span> int[] pos = iter.getPos();<a name="line.147"></a>
<span class="sourceLineNo">148</span> boolean[] omit = iter.getOmit();<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> int rank = shape.length;<a name="line.150"></a>
<span class="sourceLineNo">151</span> int[] st = new int[rank];<a name="line.151"></a>
<span class="sourceLineNo">152</span> Arrays.fill(st, 1);<a name="line.152"></a>
<span class="sourceLineNo">153</span> int[] end = new int[rank];<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> RunningAverage av = null;<a name="line.155"></a>
<span class="sourceLineNo">156</span> int c = 0;<a name="line.156"></a>
<span class="sourceLineNo">157</span> while (iter.hasNext() &amp;&amp; c &lt; stop) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (c++ &lt; start) continue;<a name="line.158"></a>
<span class="sourceLineNo">159</span> for (int i = 0; i &lt; rank; i++) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> end[i] = omit[i] ? shape[i] : pos[i] + 1;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> IDataset ds = data.getSlice(pos, end, st);<a name="line.162"></a>
<span class="sourceLineNo">163</span> if (av == null) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> av = new RunningAverage(ds);<a name="line.164"></a>
<span class="sourceLineNo">165</span> } else {<a name="line.165"></a>
<span class="sourceLineNo">166</span> av.update(ds);<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><a name="line.169"></a>
<span class="sourceLineNo">170</span> return av != null ? av.getCurrentAverage().squeeze() : null;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> <a name="line.172"></a>
<span class="sourceLineNo">173</span> public static Dataset mean(ILazyDataset data, int... ignoreAxes) throws DatasetException {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return mean(0, Integer.MAX_VALUE -1 , data, ignoreAxes);<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> @SuppressWarnings("deprecation")<a name="line.177"></a>
<span class="sourceLineNo">178</span> private static Dataset prepareDataset(int axis, int[] shape, int[][] sliceInfo) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> int rank = shape.length;<a name="line.179"></a>
<span class="sourceLineNo">180</span> if (axis &lt; 0)<a name="line.180"></a>
<span class="sourceLineNo">181</span> axis += rank;<a name="line.181"></a>
<span class="sourceLineNo">182</span> if (axis &lt; 0 || axis &gt;= rank) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> logger.error("Axis argument is outside allowed range");<a name="line.183"></a>
<span class="sourceLineNo">184</span> throw new IllegalArgumentException("Axis argument is outside allowed range");<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> sliceInfo[0] = new int[rank];<a name="line.187"></a>
<span class="sourceLineNo">188</span> sliceInfo[1] = shape.clone();<a name="line.188"></a>
<span class="sourceLineNo">189</span> sliceInfo[2] = new int[rank];<a name="line.189"></a>
<span class="sourceLineNo">190</span> Arrays.fill(sliceInfo[2], 1);<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> final int[] nshape = shape.clone();<a name="line.192"></a>
<span class="sourceLineNo">193</span> nshape[axis] = 1;<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> return DatasetFactory.zeros(nshape, Dataset.FLOAT64);<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span>}<a name="line.197"></a>
</pre>
</div>
</body>
</html>