onnxruntime/docs/api/java/ai/onnxruntime/TensorInfo.html
github-actions[bot] 89eb6eb488
[Automated]: Update Java API docs (#14426)
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Co-authored-by: fs-eire <fs-eire@users.noreply.github.com>
2023-01-26 15:42:09 -08:00

541 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>TensorInfo (onnxruntime 1.15.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TensorInfo (onnxruntime 1.15.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">ai.onnxruntime</a></div>
<h2 title="Class TensorInfo" class="title">Class TensorInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.TensorInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">TensorInfo</span>
extends java.lang.Object
implements <a href="ValueInfo.html" title="interface in ai.onnxruntime">ValueInfo</a></pre>
<div class="block">Describes an <a href="OnnxTensor.html" title="class in ai.onnxruntime"><code>OnnxTensor</code></a>, including it's size, shape and element type.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a></span></code></th>
<td class="colLast">
<div class="block">The native element types supported by the ONNX runtime.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MAX_DIMENSIONS">MAX_DIMENSIONS</a></span></code></th>
<td class="colLast">
<div class="block">Maximum number of dimensions supported by the Java interface methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onnxType">onnxType</a></span></code></th>
<td class="colLast">
<div class="block">The native type of this tensor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#type">type</a></span></code></th>
<td class="colLast">
<div class="block">The Java type of this tensor.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructFromBuffer(java.nio.Buffer,long%5B%5D,ai.onnxruntime.OnnxJavaType)">constructFromBuffer</a></span>&#8203;(java.nio.Buffer&nbsp;buffer,
long[]&nbsp;shape,
<a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Constructs a TensorInfo from the supplied byte buffer.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructFromJavaArray(java.lang.Object)">constructFromJavaArray</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">
<div class="block">Constructs a TensorInfo from the supplied multidimensional Java array, used to allocate the
appropriate amount of native memory.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;T extends java.nio.Buffer&gt;<br><a href="TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructFromSparseTensor(ai.onnxruntime.OnnxSparseTensor.SparseTensor)">constructFromSparseTensor</a></span>&#8203;(<a href="OnnxSparseTensor.SparseTensor.html" title="class in ai.onnxruntime">OnnxSparseTensor.SparseTensor</a>&lt;T&gt;&nbsp;tensor)</code></th>
<td class="colLast">
<div class="block">Constructs a TensorInfo from the supplied <a href="OnnxSparseTensor.SparseTensor.html" title="class in ai.onnxruntime"><code>OnnxSparseTensor.SparseTensor</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShape()">getShape</a></span>()</code></th>
<td class="colLast">
<div class="block">Get a copy of the tensor's shape.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isScalar()">isScalar</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the shape represents a scalar value (i.e.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeCarrier()">makeCarrier</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructs an array the right shape and type to hold this tensor.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="MAX_DIMENSIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_DIMENSIONS</h4>
<pre>public static final&nbsp;int MAX_DIMENSIONS</pre>
<div class="block">Maximum number of dimensions supported by the Java interface methods.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#ai.onnxruntime.TensorInfo.MAX_DIMENSIONS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="type">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public final&nbsp;<a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a> type</pre>
<div class="block">The Java type of this tensor.</div>
</li>
</ul>
<a id="onnxType">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onnxType</h4>
<pre>public final&nbsp;<a href="TensorInfo.OnnxTensorType.html" title="enum in ai.onnxruntime">TensorInfo.OnnxTensorType</a> onnxType</pre>
<div class="block">The native type of this tensor.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getShape()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShape</h4>
<pre class="methodSignature">public&nbsp;long[]&nbsp;getShape()</pre>
<div class="block">Get a copy of the tensor's shape.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A copy of the tensor's shape.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="isScalar()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isScalar</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isScalar()</pre>
<div class="block">Returns true if the shape represents a scalar value (i.e. it has zero dimensions).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the shape is a scalar.</dd>
</dl>
</li>
</ul>
<a id="makeCarrier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeCarrier</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;makeCarrier()
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs an array the right shape and type to hold this tensor.
<p>Note for String tensors, this carrier is a single dimensional array with enough space for
all elements as that's the expected format of the native code. It can be reshaped to the
correct shape using <a href="OrtUtil.html#reshape(java.lang.String%5B%5D,long%5B%5D)"><code>OrtUtil.reshape(String[],long[])</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A multidimensional array of the appropriate primitive type (or String).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the shape isn't representable in Java (i.e. if one of it's indices is
greater than an int).</dd>
</dl>
</li>
</ul>
<a id="constructFromJavaArray(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructFromJavaArray</h4>
<pre class="methodSignature">public static&nbsp;<a href="TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a>&nbsp;constructFromJavaArray&#8203;(java.lang.Object&nbsp;obj)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs a TensorInfo from the supplied multidimensional Java array, used to allocate the
appropriate amount of native memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - The object to inspect.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A TensorInfo which can be used to make the right size Tensor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the supplied Object isn't an array, or is an invalid type.</dd>
</dl>
</li>
</ul>
<a id="constructFromBuffer(java.nio.Buffer,long[],ai.onnxruntime.OnnxJavaType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>constructFromBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a>&nbsp;constructFromBuffer&#8203;(java.nio.Buffer&nbsp;buffer,
long[]&nbsp;shape,
<a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;type)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs a TensorInfo from the supplied byte buffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to inspect.</dd>
<dd><code>shape</code> - The shape of the tensor.</dd>
<dd><code>type</code> - The Java type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A TensorInfo for a tensor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the supplied buffer doesn't match the shape.</dd>
</dl>
</li>
</ul>
<a id="constructFromSparseTensor(ai.onnxruntime.OnnxSparseTensor.SparseTensor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>constructFromSparseTensor</h4>
<pre class="methodSignature">public static&nbsp;&lt;T extends java.nio.Buffer&gt;&nbsp;<a href="TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a>&nbsp;constructFromSparseTensor&#8203;(<a href="OnnxSparseTensor.SparseTensor.html" title="class in ai.onnxruntime">OnnxSparseTensor.SparseTensor</a>&lt;T&gt;&nbsp;tensor)
throws <a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Constructs a TensorInfo from the supplied <a href="OnnxSparseTensor.SparseTensor.html" title="class in ai.onnxruntime"><code>OnnxSparseTensor.SparseTensor</code></a>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The buffer type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tensor</code> - The sparse tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A TensorInfo for a sparse tensor.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the supplied tensor has too many elements for it's shape.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>