saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/java/ai/onnxruntime/OnnxTensor.html
Adam Pocock a2e4914279 Adding Javadoc to the website (#2554) 
* Adding Javadoc to the website.

* Updated javadoc.
2019-12-15 12:58:06 -08:00

804 lines
39 KiB
HTML
Raw Blame History

<!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_221) on Fri Dec 06 15:15:31 EST 2019 -->
<title>OnnxTensor (OnnxRuntime-Java-API)</title>
<meta name="date" content="2019-12-06">
<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="OnnxTensor (OnnxRuntime-Java-API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":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";
</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="../../ai/onnxruntime/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OnnxTensor.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="../../ai/onnxruntime/OnnxSequence.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OnnxTensor.html" target="_top">Frames</a></li>
<li><a href="OnnxTensor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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">ai.onnxruntime</div>
<h2 title="Class OnnxTensor" class="title">Class OnnxTensor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.OnnxTensor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a>, java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">OnnxTensor</span>
extends java.lang.Object
implements <a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></pre>
<div class="block">A Java object wrapping an OnnxTensor. Tensors are the main input to the library,
and can also be returned as outputs.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.ai.onnxruntime.OnnxValue">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;ai.onnxruntime.<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></h3>
<code><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a></code></li>
</ul>
</li>
</ul>
<!-- ========== 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">&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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#close--">close</a></span>()</code>
<div class="block">Closes the tensor, releasing it's underlying memory (if it's not backed by an NIO buffer).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.ByteBuffer-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.ByteBuffer&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create an OnnxTensor backed by a direct ByteBuffer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.ByteBuffer-long:A-ai.onnxruntime.OnnxJavaType-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.ByteBuffer&nbsp;data,
long[]&nbsp;shape,
<a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;type)</code>
<div class="block">Create an OnnxTensor backed by a direct ByteBuffer.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.DoubleBuffer-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.DoubleBuffer&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create an OnnxTensor backed by a direct DoubleBuffer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.FloatBuffer-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.FloatBuffer&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create an OnnxTensor backed by a direct FloatBuffer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.IntBuffer-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.IntBuffer&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create an OnnxTensor backed by a direct IntBuffer.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.LongBuffer-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.LongBuffer&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create an OnnxTensor backed by a direct LongBuffer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.lang.Object-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.lang.Object&nbsp;data)</code>
<div class="block">Create a Tensor from a Java primitive or String multidimensional array.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.nio.ShortBuffer-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.ShortBuffer&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create an OnnxTensor backed by a direct ShortBuffer.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#createTensor-ai.onnxruntime.OrtEnvironment-java.lang.String:A-long:A-">createTensor</a></span>(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.lang.String[]&nbsp;data,
long[]&nbsp;shape)</code>
<div class="block">Create a tensor from a flattened string array.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getByteBuffer--">getByteBuffer</a></span>()</code>
<div class="block">Returns a copy of the underlying OnnxTensor as a ByteBuffer.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.nio.DoubleBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getDoubleBuffer--">getDoubleBuffer</a></span>()</code>
<div class="block">Returns a copy of the underlying OnnxTensor as a DoubleBuffer if the underlying type is
a double, otherwise it returns null.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.nio.FloatBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getFloatBuffer--">getFloatBuffer</a></span>()</code>
<div class="block">Returns a copy of the underlying OnnxTensor as a FloatBuffer
if it can be losslessly converted into a float (i.e.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getInfo--">getInfo</a></span>()</code>
<div class="block">Gets the type info object associated with this OnnxValue.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.nio.IntBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getIntBuffer--">getIntBuffer</a></span>()</code>
<div class="block">Returns a copy of the underlying OnnxTensor as an IntBuffer if
the underlying type is int32 or uint32, otherwise it returns null.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.nio.LongBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getLongBuffer--">getLongBuffer</a></span>()</code>
<div class="block">Returns a copy of the underlying OnnxTensor as a LongBuffer
if the underlying type is int64 or uint64, otherwise it returns null.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.nio.ShortBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getShortBuffer--">getShortBuffer</a></span>()</code>
<div class="block">Returns a copy of the underlying OnnxTensor as a ShortBuffer if the
underlying type is int16 or uint16, otherwise it returns null.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getType--">getType</a></span>()</code>
<div class="block">Gets the type of this OnnxValue.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#getValue--">getValue</a></span>()</code>
<div class="block">Either returns a boxed primitive if the Tensor is a scalar, or a multidimensional array of
primitives if it has multiple dimensions.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../ai/onnxruntime/OnnxTensor.html#toString--">toString</a></span>()</code>&nbsp;</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ai.onnxruntime.OnnxValue">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;ai.onnxruntime.<a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></h3>
<code><a href="../../ai/onnxruntime/OnnxValue.html#close-java.lang.Iterable-">close</a>, <a href="../../ai/onnxruntime/OnnxValue.html#close-java.util.Map-">close</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="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/OnnxValue.OnnxValueType.html" title="enum in ai.onnxruntime">OnnxValue.OnnxValueType</a>&nbsp;getType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../ai/onnxruntime/OnnxValue.html#getType--">OnnxValue</a></code></span></div>
<div class="block">Gets the type of this OnnxValue.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OnnxValue.html#getType--">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value type.</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getValue()
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Either returns a boxed primitive if the Tensor is a scalar, or a multidimensional array of
primitives if it has multiple dimensions.
<p>
Java multidimensional arrays are quite slow for more than 2 dimensions, in that
case it is recommended you use the java.nio.Buffer extractors below (e.g. <a href="../../ai/onnxruntime/OnnxTensor.html#getFloatBuffer--"><code>getFloatBuffer()</code></a>).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OnnxValue.html#getValue--">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A Java value.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the value could not be extracted as the Tensor is invalid, or if the native code encountered an error.</dd>
</dl>
</li>
</ul>
<a name="getInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfo</h4>
<pre>public&nbsp;<a href="../../ai/onnxruntime/TensorInfo.html" title="class in ai.onnxruntime">TensorInfo</a>&nbsp;getInfo()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../ai/onnxruntime/OnnxValue.html#getInfo--">OnnxValue</a></code></span></div>
<div class="block">Gets the type info object associated with this OnnxValue.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OnnxValue.html#getInfo--">getInfo</a></code>&nbsp;in interface&nbsp;<code><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The type information.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>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 name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block">Closes the tensor, releasing it's underlying memory (if it's not backed by an NIO buffer).
If it is backed by a buffer then the memory is released when the buffer is GC'd.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OnnxValue.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime">OnnxValue</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
</dl>
</li>
</ul>
<a name="getByteBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteBuffer</h4>
<pre>public&nbsp;java.nio.ByteBuffer&nbsp;getByteBuffer()</pre>
<div class="block">Returns a copy of the underlying OnnxTensor as a ByteBuffer.
<p>
This method returns null if the OnnxTensor contains Strings as they are stored externally to the OnnxTensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A ByteBuffer copy of the OnnxTensor.</dd>
</dl>
</li>
</ul>
<a name="getFloatBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloatBuffer</h4>
<pre>public&nbsp;java.nio.FloatBuffer&nbsp;getFloatBuffer()</pre>
<div class="block">Returns a copy of the underlying OnnxTensor as a FloatBuffer
if it can be losslessly converted into a float (i.e. it's a float or fp16), otherwise it
returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A FloatBuffer copy of the OnnxTensor.</dd>
</dl>
</li>
</ul>
<a name="getDoubleBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDoubleBuffer</h4>
<pre>public&nbsp;java.nio.DoubleBuffer&nbsp;getDoubleBuffer()</pre>
<div class="block">Returns a copy of the underlying OnnxTensor as a DoubleBuffer if the underlying type is
a double, otherwise it returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A DoubleBuffer copy of the OnnxTensor.</dd>
</dl>
</li>
</ul>
<a name="getShortBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShortBuffer</h4>
<pre>public&nbsp;java.nio.ShortBuffer&nbsp;getShortBuffer()</pre>
<div class="block">Returns a copy of the underlying OnnxTensor as a ShortBuffer if the
underlying type is int16 or uint16, otherwise it returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A ShortBuffer copy of the OnnxTensor.</dd>
</dl>
</li>
</ul>
<a name="getIntBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntBuffer</h4>
<pre>public&nbsp;java.nio.IntBuffer&nbsp;getIntBuffer()</pre>
<div class="block">Returns a copy of the underlying OnnxTensor as an IntBuffer if
the underlying type is int32 or uint32, otherwise it returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An IntBuffer copy of the OnnxTensor.</dd>
</dl>
</li>
</ul>
<a name="getLongBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLongBuffer</h4>
<pre>public&nbsp;java.nio.LongBuffer&nbsp;getLongBuffer()</pre>
<div class="block">Returns a copy of the underlying OnnxTensor as a LongBuffer
if the underlying type is int64 or uint64, otherwise it returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A LongBuffer copy of the OnnxTensor.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.lang.Object&nbsp;data)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a Tensor from a Java primitive or String multidimensional array.
The shape is inferred from the array using reflection.
The default allocator is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The data to store in a tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor storing the data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - If the onnx runtime threw an error.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.lang.String:A-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.lang.String[]&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create a tensor from a flattened string array.
<p>
Requires the array to be flattened in row-major order. Uses the default allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data</dd>
<dd><code>shape</code> - the shape of the tensor</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.FloatBuffer-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.FloatBuffer&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct FloatBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.DoubleBuffer-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.DoubleBuffer&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct DoubleBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.ByteBuffer-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.ByteBuffer&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct ByteBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator. Tells the runtime it's <a href="../../ai/onnxruntime/OnnxJavaType.html#INT8"><code>OnnxJavaType.INT8</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.ByteBuffer-long:A-ai.onnxruntime.OnnxJavaType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.ByteBuffer&nbsp;data,
long[]&nbsp;shape,
<a href="../../ai/onnxruntime/OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;type)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct ByteBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator. Tells the runtime it's the specified type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dd><code>type</code> - The type to use for the byte buffer elements.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.ShortBuffer-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.ShortBuffer&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct ShortBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.IntBuffer-long:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.IntBuffer&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct IntBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</dd>
</dl>
</li>
</ul>
<a name="createTensor-ai.onnxruntime.OrtEnvironment-java.nio.LongBuffer-long:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createTensor</h4>
<pre>public static&nbsp;<a href="../../ai/onnxruntime/OnnxTensor.html" title="class in ai.onnxruntime">OnnxTensor</a>&nbsp;createTensor(<a href="../../ai/onnxruntime/OrtEnvironment.html" title="class in ai.onnxruntime">OrtEnvironment</a>&nbsp;env,
java.nio.LongBuffer&nbsp;data,
long[]&nbsp;shape)
throws <a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></pre>
<div class="block">Create an OnnxTensor backed by a direct LongBuffer. The buffer should be in nativeOrder.
<p>
If the supplied buffer is not a direct buffer, a direct copy is created tied to the lifetime
of the tensor. Uses the default allocator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The current OrtEnvironment.</dd>
<dd><code>data</code> - The tensor data.</dd>
<dd><code>shape</code> - The shape of tensor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An OnnxTensor of the required shape.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../ai/onnxruntime/OrtException.html" title="class in ai.onnxruntime">OrtException</a></code> - Thrown if there is an onnx error or if the data and shape don't match.</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="../../ai/onnxruntime/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OnnxTensor.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="../../ai/onnxruntime/OnnxSequence.html" title="class in ai.onnxruntime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../ai/onnxruntime/OnnxValue.html" title="interface in ai.onnxruntime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?ai/onnxruntime/OnnxTensor.html" target="_top">Frames</a></li>
<li><a href="OnnxTensor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.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>
</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 ======= -->
</body>
</html>
Reference in a new issue View git blame Copy permalink