blob: 36a1328ee356f7b03d9202b8a943dc2fefacb35d [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NativeHelper (SystemDS 2.1.0-SNAPSHOT API)</title>
<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="NativeHelper (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="../../../../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/NativeHelper.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/apache/sysds/utils/MLContextProxy.html" title="class in org.apache.sysds.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/sysds/utils/NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sysds/utils/NativeHelper.html" target="_top">Frames</a></li>
<li><a href="NativeHelper.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.apache.sysds.utils</div>
<h2 title="Class NativeHelper" class="title">Class NativeHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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.apache.sysds.utils.NativeHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">NativeHelper</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class helps in loading native library.
By default, it first tries to load Intel MKL, else tries to load OpenBLAS.</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils">NativeHelper.NativeBlasState</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/sysds/utils/NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils">NativeHelper.NativeBlasState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#CURRENT_NATIVE_BLAS_STATE">CURRENT_NATIVE_BLAS_STATE</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#NativeHelper--">NativeHelper</a></span>()</code>&nbsp;</td>
</tr>
</table>
</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="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>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#conv2dBackwardDataDense-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">conv2dBackwardDataDense</a></span>(double[]&nbsp;filter,
double[]&nbsp;dout,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#conv2dBackwardFilterDense-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">conv2dBackwardFilterDense</a></span>(double[]&nbsp;input,
double[]&nbsp;dout,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#conv2dBackwardFilterSparseDense-int-int-int:A-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">conv2dBackwardFilterSparseDense</a></span>(int&nbsp;apos,
int&nbsp;alen,
int[]&nbsp;aix,
double[]&nbsp;avals,
double[]&nbsp;rotatedDoutPtr,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#conv2dDense-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">conv2dDense</a></span>(double[]&nbsp;input,
double[]&nbsp;filter,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#conv2dSparse-int-int-int:A-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">conv2dSparse</a></span>(int&nbsp;apos,
int&nbsp;alen,
int[]&nbsp;aix,
double[]&nbsp;avals,
double[]&nbsp;filter,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#dconv2dBiasAddDense-double:A-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">dconv2dBiasAddDense</a></span>(double[]&nbsp;input,
double[]&nbsp;bias,
double[]&nbsp;filter,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#dmmdd-double:A-double:A-double:A-int-int-int-int-">dmmdd</a></span>(double[]&nbsp;m1,
double[]&nbsp;m2,
double[]&nbsp;ret,
int&nbsp;m1rlen,
int&nbsp;m1clen,
int&nbsp;m2clen,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#getCurrentBLAS--">getCurrentBLAS</a></span>()</code>
<div class="block">Called by Statistics to print the loaded BLAS.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#getMaxNumThreads--">getMaxNumThreads</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#initialize-java.lang.String-java.lang.String-">initialize</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;customLibPath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userSpecifiedBLAS)</code>
<div class="block">Initialize the native library before executing the DML program</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#isNativeLibraryLoaded--">isNativeLibraryLoaded</a></span>()</code>
<div class="block">Called by runtime to check if the BLAS is available for exploitation</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#loadBLAS-java.lang.String-java.lang.String-java.lang.String-">loadBLAS</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;customLibPath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;blas,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;optionalMsg)</code>
<div class="block">Attempts to load native BLAS</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#loadLibraryHelperFromResource-java.lang.String-">loadLibraryHelperFromResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;libFileName)</code>
<div class="block">Attempts to load the JNI shared library from the sysds jar</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#sconv2dBiasAddDense-java.nio.FloatBuffer-java.nio.FloatBuffer-java.nio.FloatBuffer-java.nio.FloatBuffer-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">sconv2dBiasAddDense</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;bias,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#smmdd-java.nio.FloatBuffer-java.nio.FloatBuffer-java.nio.FloatBuffer-int-int-int-int-">smmdd</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;m1,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;m2,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;ret,
int&nbsp;m1rlen,
int&nbsp;m1clen,
int&nbsp;m2clen,
int&nbsp;numThreads)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sysds/utils/NativeHelper.html#tsmm-double:A-double:A-int-int-boolean-int-">tsmm</a></span>(double[]&nbsp;m1,
double[]&nbsp;ret,
int&nbsp;m1rlen,
int&nbsp;m1clen,
boolean&nbsp;leftTrans,
int&nbsp;numThreads)</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.<a href="https://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CURRENT_NATIVE_BLAS_STATE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CURRENT_NATIVE_BLAS_STATE</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/sysds/utils/NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils">NativeHelper.NativeBlasState</a> CURRENT_NATIVE_BLAS_STATE</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NativeHelper--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NativeHelper</h4>
<pre>public&nbsp;NativeHelper()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCurrentBLAS--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentBLAS</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCurrentBLAS()</pre>
<div class="block">Called by Statistics to print the loaded BLAS.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>empty string or the BLAS that is loaded</dd>
</dl>
</li>
</ul>
<a name="isNativeLibraryLoaded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNativeLibraryLoaded</h4>
<pre>public static&nbsp;boolean&nbsp;isNativeLibraryLoaded()</pre>
<div class="block">Called by runtime to check if the BLAS is available for exploitation</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if CURRENT_NATIVE_BLAS_STATE is SUCCESSFULLY_LOADED_NATIVE_BLAS_AND_NOT_IN_USE else false</dd>
</dl>
</li>
</ul>
<a name="initialize-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public static&nbsp;void&nbsp;initialize(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;customLibPath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userSpecifiedBLAS)</pre>
<div class="block">Initialize the native library before executing the DML program</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>customLibPath</code> - specified by sysds.native.blas.directory</dd>
<dd><code>userSpecifiedBLAS</code> - specified by sysds.native.blas</dd>
</dl>
</li>
</ul>
<a name="getMaxNumThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxNumThreads</h4>
<pre>public static&nbsp;int&nbsp;getMaxNumThreads()</pre>
</li>
</ul>
<a name="loadBLAS-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadBLAS</h4>
<pre>public static&nbsp;boolean&nbsp;loadBLAS(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;customLibPath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;blas,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;optionalMsg)</pre>
<div class="block">Attempts to load native BLAS</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>customLibPath</code> - can be null (if we want to only want to use LD_LIBRARY_PATH), else the</dd>
<dd><code>blas</code> - can be gomp, openblas or mkl_rt</dd>
<dd><code>optionalMsg</code> - message for debugging</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if successfully loaded BLAS</dd>
</dl>
</li>
</ul>
<a name="loadLibraryHelperFromResource-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadLibraryHelperFromResource</h4>
<pre>public static&nbsp;boolean&nbsp;loadLibraryHelperFromResource(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;libFileName)</pre>
<div class="block">Attempts to load the JNI shared library from the sysds jar</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>libFileName</code> - library file name)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if successfully loaded BLAS</dd>
</dl>
</li>
</ul>
<a name="dmmdd-double:A-double:A-double:A-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dmmdd</h4>
<pre>public static&nbsp;long&nbsp;dmmdd(double[]&nbsp;m1,
double[]&nbsp;m2,
double[]&nbsp;ret,
int&nbsp;m1rlen,
int&nbsp;m1clen,
int&nbsp;m2clen,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="smmdd-java.nio.FloatBuffer-java.nio.FloatBuffer-java.nio.FloatBuffer-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>smmdd</h4>
<pre>public static&nbsp;long&nbsp;smmdd(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;m1,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;m2,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;ret,
int&nbsp;m1rlen,
int&nbsp;m1clen,
int&nbsp;m2clen,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="tsmm-double:A-double:A-int-int-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tsmm</h4>
<pre>public static&nbsp;long&nbsp;tsmm(double[]&nbsp;m1,
double[]&nbsp;ret,
int&nbsp;m1rlen,
int&nbsp;m1clen,
boolean&nbsp;leftTrans,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="conv2dDense-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conv2dDense</h4>
<pre>public static&nbsp;long&nbsp;conv2dDense(double[]&nbsp;input,
double[]&nbsp;filter,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="dconv2dBiasAddDense-double:A-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dconv2dBiasAddDense</h4>
<pre>public static&nbsp;long&nbsp;dconv2dBiasAddDense(double[]&nbsp;input,
double[]&nbsp;bias,
double[]&nbsp;filter,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="sconv2dBiasAddDense-java.nio.FloatBuffer-java.nio.FloatBuffer-java.nio.FloatBuffer-java.nio.FloatBuffer-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sconv2dBiasAddDense</h4>
<pre>public static&nbsp;long&nbsp;sconv2dBiasAddDense(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;bias,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio">FloatBuffer</a>&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="conv2dBackwardFilterDense-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conv2dBackwardFilterDense</h4>
<pre>public static&nbsp;long&nbsp;conv2dBackwardFilterDense(double[]&nbsp;input,
double[]&nbsp;dout,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="conv2dBackwardDataDense-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conv2dBackwardDataDense</h4>
<pre>public static&nbsp;long&nbsp;conv2dBackwardDataDense(double[]&nbsp;filter,
double[]&nbsp;dout,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="conv2dBackwardFilterSparseDense-int-int-int:A-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conv2dBackwardFilterSparseDense</h4>
<pre>public static&nbsp;boolean&nbsp;conv2dBackwardFilterSparseDense(int&nbsp;apos,
int&nbsp;alen,
int[]&nbsp;aix,
double[]&nbsp;avals,
double[]&nbsp;rotatedDoutPtr,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</li>
</ul>
<a name="conv2dSparse-int-int-int:A-double:A-double:A-double:A-int-int-int-int-int-int-int-int-int-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>conv2dSparse</h4>
<pre>public static&nbsp;boolean&nbsp;conv2dSparse(int&nbsp;apos,
int&nbsp;alen,
int[]&nbsp;aix,
double[]&nbsp;avals,
double[]&nbsp;filter,
double[]&nbsp;ret,
int&nbsp;N,
int&nbsp;C,
int&nbsp;H,
int&nbsp;W,
int&nbsp;K,
int&nbsp;R,
int&nbsp;S,
int&nbsp;stride_h,
int&nbsp;stride_w,
int&nbsp;pad_h,
int&nbsp;pad_w,
int&nbsp;P,
int&nbsp;Q,
int&nbsp;numThreads)</pre>
</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="../../../../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/NativeHelper.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/apache/sysds/utils/MLContextProxy.html" title="class in org.apache.sysds.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/sysds/utils/NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sysds/utils/NativeHelper.html" target="_top">Frames</a></li>
<li><a href="NativeHelper.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>