blob: be309a9e1dc868f3e1e3a1527a3ab73d752d9ad1 [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 (1.8.0_262-internal) on Thu Jun 04 16:39:37 GMT 2020 -->
<title>com.ibm.cuda (OpenJ9 CUDA Classes)</title>
<meta name="date" content="2020-06-04">
<meta name="keywords" content="com.ibm.cuda package">
<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="com.ibm.cuda (OpenJ9 CUDA Classes)";
}
}
catch(err) {
}
//-->
</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="../../../com/ibm/cuda/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><strong>OpenJ9 CUDA Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/ibm/cuda/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;com.ibm.cuda</h1>
<div class="docSummary">
<div class="block">This package enables access to CUDA-capable devices from Java.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaError.html" title="interface in com.ibm.cuda">CudaError</a></td>
<td class="colLast">
<div class="block">The <code>CudaError</code> interface defines the possible values of <a href="../../../com/ibm/cuda/CudaException.html#code"><code>CudaException.code</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/Cuda.html" title="class in com.ibm.cuda">Cuda</a></td>
<td class="colLast">
<div class="block">The <code>Cuda</code> class provides general CUDA utilities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaBuffer.html" title="class in com.ibm.cuda">CudaBuffer</a></td>
<td class="colLast">
<div class="block">The <code>CudaBuffer</code> class represents a region of memory on a specific
device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a></td>
<td class="colLast">
<div class="block">The <code>CudaDevice</code> class represents a CUDA-capable device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaEvent.html" title="class in com.ibm.cuda">CudaEvent</a></td>
<td class="colLast">
<div class="block">The <code>CudaEvent</code> class represents an event that can be queued in a
stream on a CUDA-capable device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaFunction.html" title="class in com.ibm.cuda">CudaFunction</a></td>
<td class="colLast">
<div class="block">The <code>CudaFunction</code> class represents a kernel entry point found in
a specific <code>CudaModule</code> loaded on a CUDA-capable device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaGlobal.html" title="class in com.ibm.cuda">CudaGlobal</a></td>
<td class="colLast">
<div class="block">The <code>CudaGlobal</code> class represents a global variable found in
a specific <code>CudaModule</code> loaded on a CUDA-capable device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaGrid.html" title="class in com.ibm.cuda">CudaGrid</a></td>
<td class="colLast">
<div class="block">The <code>CudaGrid</code> class represents a kernel launch configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></td>
<td class="colLast">
<div class="block">The <code>CudaJitOptions</code> class represents a set of options that influence
the behavior of linking and loading modules.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaKernel.html" title="class in com.ibm.cuda">CudaKernel</a></td>
<td class="colLast">
<div class="block">The <code>CudaKernel</code> class represents a kernel <a href="../../../com/ibm/cuda/CudaFunction.html" title="class in com.ibm.cuda"><code>function</code></a>
in a loaded <a href="../../../com/ibm/cuda/CudaModule.html" title="class in com.ibm.cuda"><code>CudaModule</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaKernel.Parameters.html" title="class in com.ibm.cuda">CudaKernel.Parameters</a></td>
<td class="colLast">
<div class="block">The <code>Parameters</code> class represents the actual parameters in
a <a href="../../../com/ibm/cuda/CudaKernel.html" title="class in com.ibm.cuda"><code>kernel</code></a> launch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a></td>
<td class="colLast">
<div class="block">The <code>CudaLinker</code> class supports combining one or more code fragments
to form a module that can be then loaded on a CUDA-capable device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaModule.html" title="class in com.ibm.cuda">CudaModule</a></td>
<td class="colLast">
<div class="block">The <code>CudaModule</code> class represents a module that has been loaded
on a CUDA-capable device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaModule.Cache.html" title="class in com.ibm.cuda">CudaModule.Cache</a></td>
<td class="colLast">
<div class="block">The <code>Cache</code> class provides a simple mechanism to avoid reloading
modules repeatedly.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaPermission.html" title="class in com.ibm.cuda">CudaPermission</a></td>
<td class="colLast">
<div class="block">This class defines CUDA permissions as described in the table below.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaStream.html" title="class in com.ibm.cuda">CudaStream</a></td>
<td class="colLast">
<div class="block">The <code>CudaStream</code> class represents an independent queue of work for a
specific <a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda"><code>CudaDevice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaSurface.html" title="class in com.ibm.cuda">CudaSurface</a></td>
<td class="colLast">
<div class="block">The <code>CudaSurface</code> class represents a surface object found in
a specific <code>CudaModule</code> loaded on a CUDA-capable device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaTexture.html" title="class in com.ibm.cuda">CudaTexture</a></td>
<td class="colLast">
<div class="block">The <code>CudaTexture</code> class represents a texture object found in
a specific <code>CudaModule</code> loaded on a CUDA-capable device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/Dim3.html" title="class in com.ibm.cuda">Dim3</a></td>
<td class="colLast">
<div class="block">The <code>Dim3</code> class represents the dimensions of a cube.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaDevice.CacheConfig.html" title="enum in com.ibm.cuda">CudaDevice.CacheConfig</a></td>
<td class="colLast">
<div class="block"><code>CacheConfig</code> identifies the cache configuration choices for
a device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaDevice.Limit.html" title="enum in com.ibm.cuda">CudaDevice.Limit</a></td>
<td class="colLast">
<div class="block"><code>Limit</code> identifies device limits that may be queried or configured.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaDevice.SharedMemConfig.html" title="enum in com.ibm.cuda">CudaDevice.SharedMemConfig</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a></td>
<td class="colLast">
<div class="block"><code>CudaJitInputType</code> identifies the type of input being provided to
<code>CudaLinker#add(...)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaJitOptions.CacheMode.html" title="enum in com.ibm.cuda">CudaJitOptions.CacheMode</a></td>
<td class="colLast">
<div class="block"><code>CacheMode</code> identifies the cache management choices.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaJitOptions.Fallback.html" title="enum in com.ibm.cuda">CudaJitOptions.Fallback</a></td>
<td class="colLast">
<div class="block"><code>Fallback</code> identifies the available fall-back strategies
when an exactly matching object is not available.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaJitTarget.html" title="enum in com.ibm.cuda">CudaJitTarget</a></td>
<td class="colLast">
<div class="block"><code>CudaJitTarget</code> identifies the target compute device class
for linking and loading modules.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></td>
<td class="colLast">
<div class="block">The <code>CudaException</code> class represents an unusual or unexpected response
from a CUDA-capable device.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.ibm.cuda Description">Package com.ibm.cuda Description</h2>
<div class="block">This package enables access to CUDA-capable devices from Java.
<p>
A wealth of background information on CUDA is available <a href="http://www.nvidia.com/object/cuda_home.html">here</a>.</div>
</div>
<!-- ======= 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="../../../com/ibm/cuda/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-use.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 class="aboutLanguage"><strong>OpenJ9 CUDA Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/ibm/cuda/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright &copy; 2013, 2020, IBM Corp. and others.</small></p>
</body>
</html>