blob: dd68cfe4775ffe673616da716e04dade6af107a1 [file] [log] [blame]
<!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 (version 1.7.0_80) on Thu Mar 30 04:43:33 EDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ShapeUtils (The Eclipse January API Documentation)</title>
<meta name="date" content="2017-03-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ShapeUtils (The Eclipse January API Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../../org/eclipse/january/dataset/ShortDataset.html" title="class in org.eclipse.january.dataset"><span class="strong">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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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/7/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.17">ShapeUtils</a>
extends <a href="https://docs.oracle.com/javase/7/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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#areShapesBroadcastCompatible(int[],%20int[])">areShapesBroadcastCompatible</a></strong>(int[]&nbsp;ashape,
int[]&nbsp;bshape)</code>
<div class="block">Check if shapes are broadcast compatible</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#areShapesCompatible(int[],%20int[])">areShapesCompatible</a></strong>(int[]&nbsp;ashape,
int[]&nbsp;bshape)</code>
<div class="block">Check if shapes are compatible, ignoring extra axes of length 1</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#areShapesCompatible(int[],%20int[],%20int)">areShapesCompatible</a></strong>(int[]&nbsp;ashape,
int[]&nbsp;bshape,
int&nbsp;axis)</code>
<div class="block">Check if shapes are compatible but skip axis</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#calcLongSize(int[])">calcLongSize</a></strong>(int[]&nbsp;shape)</code>
<div class="block">Calculate total number of items in given shape</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#calcSize(int[])">calcSize</a></strong>(int[]&nbsp;shape)</code>
<div class="block">Calculate total number of items in given shape</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#checkCompatibility(org.eclipse.january.dataset.ILazyDataset,%20org.eclipse.january.dataset.ILazyDataset)">checkCompatibility</a></strong>(<a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a>&nbsp;g,
<a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a>&nbsp;h)</code>
<div class="block">This function takes a dataset and checks its shape against another dataset.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getFlat1DIndex(int[],%20int[])">getFlat1DIndex</a></strong>(int[]&nbsp;shape,
int[]&nbsp;pos)</code>
<div class="block">Get flattened view index of given position</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getNDPositionFromShape(int,%20int[])">getNDPositionFromShape</a></strong>(int&nbsp;n,
int[]&nbsp;shape)</code>
<div class="block">Get n-D position from given index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#getShapeFromObject(java.lang.Object)">getShapeFromObject</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>
<div class="block">Get shape from object (array or list supported)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#squeezeShape(int[],%20boolean)">squeezeShape</a></strong>(int[]&nbsp;oshape,
boolean&nbsp;onlyFromEnds)</code>
<div class="block">Remove dimensions of 1 in given shape - from both ends only, if true</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/january/dataset/ShapeUtils.html#squeezeShape(int[],%20int)">squeezeShape</a></strong>(int[]&nbsp;oshape,
int&nbsp;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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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>
<ul class="blockList">
<li class="blockList">
<h4>calcLongSize</h4>
<pre>public static&nbsp;long&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.27">calcLongSize</a>(int[]&nbsp;shape)</pre>
<div class="block">Calculate total number of items in given shape</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>shape</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>size</dd></dl>
</li>
</ul>
<a name="calcSize(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calcSize</h4>
<pre>public static&nbsp;int&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.62">calcSize</a>(int[]&nbsp;shape)</pre>
<div class="block">Calculate total number of items in given shape</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>shape</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>size</dd></dl>
</li>
</ul>
<a name="areShapesBroadcastCompatible(int[], int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areShapesBroadcastCompatible</h4>
<pre>public static&nbsp;boolean&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.79">areShapesBroadcastCompatible</a>(int[]&nbsp;ashape,
int[]&nbsp;bshape)</pre>
<div class="block">Check if shapes are broadcast compatible</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ashape</code> - </dd><dd><code>bshape</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>true if they are compatible</dd></dl>
</li>
</ul>
<a name="areShapesCompatible(int[], int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areShapesCompatible</h4>
<pre>public static&nbsp;boolean&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.104">areShapesCompatible</a>(int[]&nbsp;ashape,
int[]&nbsp;bshape)</pre>
<div class="block">Check if shapes are compatible, ignoring extra axes of length 1</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ashape</code> - </dd><dd><code>bshape</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>true if they are compatible</dd></dl>
</li>
</ul>
<a name="areShapesCompatible(int[], int[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areShapesCompatible</h4>
<pre>public static&nbsp;boolean&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.135">areShapesCompatible</a>(int[]&nbsp;ashape,
int[]&nbsp;bshape,
int&nbsp;axis)</pre>
<div class="block">Check if shapes are compatible but skip axis</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ashape</code> - </dd><dd><code>bshape</code> - </dd><dd><code>axis</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>true if they are compatible</dd></dl>
</li>
</ul>
<a name="squeezeShape(int[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>squeezeShape</h4>
<pre>public static&nbsp;int[]&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.160">squeezeShape</a>(int[]&nbsp;oshape,
boolean&nbsp;onlyFromEnds)</pre>
<div class="block">Remove dimensions of 1 in given shape - from both ends only, if true</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oshape</code> - </dd><dd><code>onlyFromEnds</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>newly squeezed shape (or original if unsqueezed)</dd></dl>
</li>
</ul>
<a name="squeezeShape(int[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>squeezeShape</h4>
<pre>public static&nbsp;int[]&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.224">squeezeShape</a>(int[]&nbsp;oshape,
int&nbsp;axis)</pre>
<div class="block">Remove dimension of 1 in given shape</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oshape</code> - </dd><dd><code>axis</code> - </dd>
<dt><span class="strong">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&nbsp;int[]&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.254">getShapeFromObject</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<div class="block">Get shape from object (array or list supported)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>shape can be null if obj is null</dd></dl>
</li>
</ul>
<a name="getNDPositionFromShape(int, int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNDPositionFromShape</h4>
<pre>public static&nbsp;int[]&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.333">getNDPositionFromShape</a>(int&nbsp;n,
int[]&nbsp;shape)</pre>
<div class="block">Get n-D position from given index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - index</dd><dd><code>shape</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>n-D position</dd></dl>
</li>
</ul>
<a name="getFlat1DIndex(int[], int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlat1DIndex</h4>
<pre>public static&nbsp;int&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.364">getFlat1DIndex</a>(int[]&nbsp;shape,
int[]&nbsp;pos)</pre>
<div class="block">Get flattened view index of given position</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>shape</code> - </dd><dd><code>pos</code> - the integer array specifying the n-D position</dd>
<dt><span class="strong">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="blockListLast">
<li class="blockList">
<h4>checkCompatibility</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../src-html/org/eclipse/january/dataset/ShapeUtils.html#line.384">checkCompatibility</a>(<a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a>&nbsp;g,
<a href="../../../../org/eclipse/january/dataset/ILazyDataset.html" title="interface in org.eclipse.january.dataset">ILazyDataset</a>&nbsp;h)
throws <a href="https://docs.oracle.com/javase/7/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="strong">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="strong">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/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>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../../org/eclipse/january/dataset/ShortDataset.html" title="class in org.eclipse.january.dataset"><span class="strong">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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2017. All rights reserved.</small></p>
</body>
</html>