saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-15 18:23:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/java/ai/onnxruntime/OnnxSparseTensor.SparseTensor.html
github-actions[bot] 56118f6a10
[Automated]: Update Java API docs (#13612)
2023-01-19 16:21:07 -08:00

453 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>OnnxSparseTensor.SparseTensor (onnxruntime 1.14.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="OnnxSparseTensor.SparseTensor (onnxruntime 1.14.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>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 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 OnnxSparseTensor.SparseTensor" class="title">Class OnnxSparseTensor.SparseTensor&lt;T extends java.nio.Buffer&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ai.onnxruntime.OnnxSparseTensor.SparseTensor&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="OnnxSparseTensor.BlockSparseTensor.html" title="class in ai.onnxruntime">OnnxSparseTensor.BlockSparseTensor</a></code>, <code><a href="OnnxSparseTensor.COOTensor.html" title="class in ai.onnxruntime">OnnxSparseTensor.COOTensor</a></code>, <code><a href="OnnxSparseTensor.CSRCTensor.html" title="class in ai.onnxruntime">OnnxSparseTensor.CSRCTensor</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="OnnxSparseTensor.html" title="class in ai.onnxruntime">OnnxSparseTensor</a></dd>
</dl>
<hr>
<pre>public abstract static class <span class="typeNameLabel">OnnxSparseTensor.SparseTensor&lt;T extends java.nio.Buffer&gt;</span>
extends java.lang.Object</pre>
<div class="block">Abstract base class for Java sparse tensors
<p>Will be sealed to <a href="OnnxSparseTensor.COOTensor.html" title="class in ai.onnxruntime"><code>OnnxSparseTensor.COOTensor</code></a>, <a href="OnnxSparseTensor.CSRCTensor.html" title="class in ai.onnxruntime"><code>OnnxSparseTensor.CSRCTensor</code></a> and <a href="OnnxSparseTensor.BlockSparseTensor.html" title="class in ai.onnxruntime"><code>OnnxSparseTensor.BlockSparseTensor</code></a> one
day.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>long[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDenseShape()">getDenseShape</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the dense shape of the sparse tensor.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="OnnxSparseTensor.SparseTensor.html" title="type parameter in OnnxSparseTensor.SparseTensor">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndices()">getIndices</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the indices buffer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndicesShape()">getIndicesShape</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the shape of the indices of the sparse tensor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndicesType()">getIndicesType</a></span>()</code></th>
<td class="colLast">
<div class="block">The indices type of the sparse tensor.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumNonZeroElements()">getNumNonZeroElements</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of non-zero elements.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="OnnxSparseTensor.SparseTensorType.html" title="enum in ai.onnxruntime">OnnxSparseTensor.SparseTensorType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSparsityType()">getSparsityType</a></span>()</code></th>
<td class="colLast">
<div class="block">The sparsity type of the sparse tensor.</div>
</td>
</tr>
<tr id="i6" 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="#getType()">getType</a></span>()</code></th>
<td class="colLast">
<div class="block">The data type of the sparse tensor.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.nio.Buffer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValues()">getValues</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the value buffer.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValuesShape()">getValuesShape</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the shape of the values of the sparse tensor.</div>
</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, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getDenseShape()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDenseShape</h4>
<pre class="methodSignature">public&nbsp;long[]&nbsp;getDenseShape()</pre>
<div class="block">Gets the dense shape of the sparse tensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The sparse tensor shape.</dd>
</dl>
</li>
</ul>
<a id="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature">public&nbsp;<a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;getType()</pre>
<div class="block">The data type of the sparse tensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The sparse tensor data type.</dd>
</dl>
</li>
</ul>
<a id="getNumNonZeroElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumNonZeroElements</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getNumNonZeroElements()</pre>
<div class="block">The number of non-zero elements.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of non-zero elements.</dd>
</dl>
</li>
</ul>
<a id="getIndices()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndices</h4>
<pre class="methodSignature">public&nbsp;<a href="OnnxSparseTensor.SparseTensor.html" title="type parameter in OnnxSparseTensor.SparseTensor">T</a>&nbsp;getIndices()</pre>
<div class="block">Get the indices buffer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The indices buffer.</dd>
</dl>
</li>
</ul>
<a id="getValues()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValues</h4>
<pre class="methodSignature">public&nbsp;java.nio.Buffer&nbsp;getValues()</pre>
<div class="block">Get the value buffer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value buffer.</dd>
</dl>
</li>
</ul>
<a id="getValuesShape()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValuesShape</h4>
<pre class="methodSignature">public&nbsp;long[]&nbsp;getValuesShape()</pre>
<div class="block">Gets the shape of the values of the sparse tensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The sparse tensor value shape.</dd>
</dl>
</li>
</ul>
<a id="getIndicesShape()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndicesShape</h4>
<pre class="methodSignature">public&nbsp;long[]&nbsp;getIndicesShape()</pre>
<div class="block">Gets the shape of the indices of the sparse tensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The sparse tensor indices shape.</dd>
</dl>
</li>
</ul>
<a id="getSparsityType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSparsityType</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="OnnxSparseTensor.SparseTensorType.html" title="enum in ai.onnxruntime">OnnxSparseTensor.SparseTensorType</a>&nbsp;getSparsityType()</pre>
<div class="block">The sparsity type of the sparse tensor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The sparse tensor sparsity type.</dd>
</dl>
</li>
</ul>
<a id="getIndicesType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIndicesType</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="OnnxJavaType.html" title="enum in ai.onnxruntime">OnnxJavaType</a>&nbsp;getIndicesType()</pre>
<div class="block">The indices type of the sparse tensor.
<p>Only <a href="OnnxJavaType.html#INT32"><code>OnnxJavaType.INT32</code></a> and <a href="OnnxJavaType.html#INT64"><code>OnnxJavaType.INT64</code></a> are supported.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The sparse tensor indices type.</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>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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in a new issue View git blame Copy permalink