| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_222) on Mon Sep 30 16:21:16 BST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ShapeUtils (The Eclipse January API Documentation)</title> |
| <meta name="date" content="2019-09-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ShapeUtils (The Eclipse January API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ShapeUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/january/dataset/ShapeChangeChecker.html" title="class in org.eclipse.january.dataset"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/january/dataset/ShortDataset.html" title="class in org.eclipse.january.dataset"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/january/dataset/ShapeUtils.html" target="_top">Frames</a></li> |
| <li><a href="ShapeUtils.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.january.dataset</div> |
| <h2 title="Class ShapeUtils" class="title">Class ShapeUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.january.dataset.ShapeUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.21">ShapeUtils</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#areShapesBroadcastCompatible-int:A-int:A-">areShapesBroadcastCompatible</a></span>(int[] ashape, |
| int[] bshape)</code> |
| <div class="block">Check if shapes are broadcast compatible</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#areShapesCompatible-int:A-int:A-">areShapesCompatible</a></span>(int[] ashape, |
| int[] bshape)</code> |
| <div class="block">Check if shapes are compatible, ignoring extra axes of length 1</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#areShapesCompatible-int:A-int:A-int-">areShapesCompatible</a></span>(int[] ashape, |
| int[] bshape, |
| int axis)</code> |
| <div class="block">Check if shapes are compatible but skip axis</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#calcLongSize-int:A-">calcLongSize</a></span>(int[] shape)</code> |
| <div class="block">Calculate total number of items in given shape</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#calcShapePadding-int:A-int:A-">calcShapePadding</a></span>(int[] aShape, |
| int[] bShape)</code> |
| <div class="block">Calculate the padding difference between two shapes.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#calcSize-int:A-">calcSize</a></span>(int[] shape)</code> |
| <div class="block">Calculate total number of items in given shape</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#checkAxes-int-int...-">checkAxes</a></span>(int rank, |
| int... axes)</code> |
| <div class="block">Check that all axes are in range [-rank,rank)</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#checkAxis-int-int-">checkAxis</a></span>(int rank, |
| int axis)</code> |
| <div class="block">Check that axis is in range [-rank,rank)</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#checkCompatibility-org.eclipse.january.dataset.ILazyDataset-org.eclipse.january.dataset.ILazyDataset-">checkCompatibility</a></span>(<a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a> g, |
| <a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a> h)</code> |
| <div class="block">This function takes a dataset and checks its shape against another dataset.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#differsByOnes-int:A-int:A-">differsByOnes</a></span>(int[] a, |
| int[] b)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getFlat1DIndex-int:A-int:A-">getFlat1DIndex</a></span>(int[] shape, |
| int[] pos)</code> |
| <div class="block">Get flattened view index of given position</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getNDPositionFromShape-int-int:A-">getNDPositionFromShape</a></span>(int n, |
| int[] shape)</code> |
| <div class="block">Get n-D position from given index</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getReducedShapeKeepRank-int:A-int...-">getReducedShapeKeepRank</a></span>(int[] shape, |
| int... axes)</code> |
| <div class="block">Set reduced axes to 1</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getRemainingAxes-int-int...-">getRemainingAxes</a></span>(int rank, |
| int... axes)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getShapeFromObject-java.lang.Object-">getShapeFromObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">Get shape from object (array or list supported)</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#reduceShape-int:A-int...-">reduceShape</a></span>(int[] shape, |
| int... axes)</code> |
| <div class="block">Remove axes from shape</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#squeezeShape-int:A-boolean-">squeezeShape</a></span>(int[] oshape, |
| boolean onlyFromEnds)</code> |
| <div class="block">Remove dimensions of 1 in given shape - from both ends only, if true</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#squeezeShape-int:A-int-">squeezeShape</a></span>(int[] oshape, |
| int axis)</code> |
| <div class="block">Remove dimension of 1 in given shape</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="calcLongSize-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>calcLongSize</h4> |
| <pre>public static long <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.31">calcLongSize</a>(int[] shape)</pre> |
| <div class="block">Calculate total number of items in given shape</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shape</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>size</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="calcSize-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>calcSize</h4> |
| <pre>public static int <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.66">calcSize</a>(int[] shape)</pre> |
| <div class="block">Calculate total number of items in given shape</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shape</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>size</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="areShapesBroadcastCompatible-int:A-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areShapesBroadcastCompatible</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.83">areShapesBroadcastCompatible</a>(int[] ashape, |
| int[] bshape)</pre> |
| <div class="block">Check if shapes are broadcast compatible</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ashape</code> - </dd> |
| <dd><code>bshape</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if they are compatible</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="areShapesCompatible-int:A-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areShapesCompatible</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.108">areShapesCompatible</a>(int[] ashape, |
| int[] bshape)</pre> |
| <div class="block">Check if shapes are compatible, ignoring extra axes of length 1</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ashape</code> - </dd> |
| <dd><code>bshape</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if they are compatible</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="areShapesCompatible-int:A-int:A-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areShapesCompatible</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.139">areShapesCompatible</a>(int[] ashape, |
| int[] bshape, |
| int axis)</pre> |
| <div class="block">Check if shapes are compatible but skip axis</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ashape</code> - </dd> |
| <dd><code>bshape</code> - </dd> |
| <dd><code>axis</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if they are compatible</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="squeezeShape-int:A-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>squeezeShape</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.164">squeezeShape</a>(int[] oshape, |
| boolean onlyFromEnds)</pre> |
| <div class="block">Remove dimensions of 1 in given shape - from both ends only, if true</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oshape</code> - </dd> |
| <dd><code>onlyFromEnds</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>newly squeezed shape (or original if unsqueezed)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="squeezeShape-int:A-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>squeezeShape</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.228">squeezeShape</a>(int[] oshape, |
| int axis)</pre> |
| <div class="block">Remove dimension of 1 in given shape</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oshape</code> - </dd> |
| <dd><code>axis</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>newly squeezed shape</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getShapeFromObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShapeFromObject</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.258">getShapeFromObject</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> |
| <div class="block">Get shape from object (array or list supported)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>shape can be null if obj is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNDPositionFromShape-int-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNDPositionFromShape</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.337">getNDPositionFromShape</a>(int n, |
| int[] shape)</pre> |
| <div class="block">Get n-D position from given index</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>n</code> - index</dd> |
| <dd><code>shape</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>n-D position</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlat1DIndex-int:A-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlat1DIndex</h4> |
| <pre>public static int <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.368">getFlat1DIndex</a>(int[] shape, |
| int[] pos)</pre> |
| <div class="block">Get flattened view index of given position</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shape</code> - </dd> |
| <dd><code>pos</code> - the integer array specifying the n-D position</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index on the flattened dataset</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkCompatibility-org.eclipse.january.dataset.ILazyDataset-org.eclipse.january.dataset.ILazyDataset-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkCompatibility</h4> |
| <pre>public static void <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.388">checkCompatibility</a>(<a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a> g, |
| <a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a> h) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> |
| <div class="block">This function takes a dataset and checks its shape against another dataset. If they are both of the same size, |
| then this returns with no error, if there is a problem, then an error is thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>g</code> - The first dataset to be compared</dd> |
| <dd><code>h</code> - The second dataset to be compared</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - This will be thrown if there is a problem with the compatibility</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAxis-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAxis</h4> |
| <pre>public static int <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.402">checkAxis</a>(int rank, |
| int axis)</pre> |
| <div class="block">Check that axis is in range [-rank,rank)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rank</code> - </dd> |
| <dd><code>axis</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>sanitized axis in range [0, rank)</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAxes-int-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAxes</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.429">checkAxes</a>(int rank, |
| int... axes)</pre> |
| <div class="block">Check that all axes are in range [-rank,rank)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rank</code> - </dd> |
| <dd><code>axes</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>sanitized axes in range [0, rank) and sorted in increasing order</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRemainingAxes-int-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemainingAxes</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.455">getRemainingAxes</a>(int rank, |
| int... axes)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rank</code> - </dd> |
| <dd><code>axes</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>remaining axes not given by input</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reduceShape-int:A-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reduceShape</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.475">reduceShape</a>(int[] shape, |
| int... axes)</pre> |
| <div class="block">Remove axes from shape</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shape</code> - </dd> |
| <dd><code>axes</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>reduced shape</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReducedShapeKeepRank-int:A-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReducedShapeKeepRank</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.491">getReducedShapeKeepRank</a>(int[] shape, |
| int... axes)</pre> |
| <div class="block">Set reduced axes to 1</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shape</code> - </dd> |
| <dd><code>axes</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>shape with same rank</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="differsByOnes-int:A-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>differsByOnes</h4> |
| <pre>public static boolean <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.506">differsByOnes</a>(int[] a, |
| int[] b)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>a</code> - </dd> |
| <dd><code>b</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if arrays only differs by unit entries</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="calcShapePadding-int:A-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>calcShapePadding</h4> |
| <pre>public static int[] <a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.551">calcShapePadding</a>(int[] aShape, |
| int[] bShape)</pre> |
| <div class="block">Calculate the padding difference between two shapes. Padding can be positive (negative) |
| for added (removed) dimensions. NB positive or negative padding is given after matched |
| dimensions</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aShape</code> - </dd> |
| <dd><code>bShape</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>padding can be null if shapes are equal</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if one shape is null but not the other, or if shapes do |
| not possess common non-unit lengths</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ShapeUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/january/dataset/ShapeChangeChecker.html" title="class in org.eclipse.january.dataset"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/january/dataset/ShortDataset.html" title="class in org.eclipse.january.dataset"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/january/dataset/ShapeUtils.html" target="_top">Frames</a></li> |
| <li><a href="ShapeUtils.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2014–2019 <a href="http://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
