| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>NativeHelper (Apache SystemDS 3.2.0-SNAPSHOT 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="NativeHelper (Apache SystemDS 3.2.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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"; |
| 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="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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.sysds.utils</a></div> |
| <h2 title="Class NativeHelper" class="title">Class NativeHelper</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| <pre>public class <span class="typeNameLabel">NativeHelper</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils">NativeHelper.NativeBlasState</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils">NativeHelper.NativeBlasState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CURRENT_NATIVE_BLAS_STATE">CURRENT_NATIVE_BLAS_STATE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">NativeHelper</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conv2dBackwardDataDense(double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int,int,int,int,int,int,int,int,int,int,int)">conv2dBackwardDataDense</a></span>​(double[] filter, |
| double[] dout, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conv2dBackwardFilterDense(double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int,int,int,int,int,int,int,int,int,int,int)">conv2dBackwardFilterDense</a></span>​(double[] input, |
| double[] dout, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conv2dBackwardFilterSparseDense(int,int,int%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int,int,int,int,int,int,int,int,int,int,int)">conv2dBackwardFilterSparseDense</a></span>​(int apos, |
| int alen, |
| int[] aix, |
| double[] avals, |
| double[] rotatedDoutPtr, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conv2dDense(double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int,int,int,int,int,int,int,int,int,int,int)">conv2dDense</a></span>​(double[] input, |
| double[] filter, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conv2dSparse(int,int,int%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int,int,int,int,int,int,int,int,int,int,int)">conv2dSparse</a></span>​(int apos, |
| int alen, |
| int[] aix, |
| double[] avals, |
| double[] filter, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dconv2dBiasAddDense(double%5B%5D,double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int,int,int,int,int,int,int,int,int,int,int)">dconv2dBiasAddDense</a></span>​(double[] input, |
| double[] bias, |
| double[] filter, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dmmdd(double%5B%5D,double%5B%5D,double%5B%5D,int,int,int,int)">dmmdd</a></span>​(double[] m1, |
| double[] m2, |
| double[] ret, |
| int m1rlen, |
| int m1clen, |
| int m2clen, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentBLAS()">getCurrentBLAS</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxNumThreads()">getMaxNumThreads</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.lang.String,java.lang.String)">initialize</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> customLibPath, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> userSpecifiedBLAS)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNativeLibraryLoaded()">isNativeLibraryLoaded</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadBLAS(java.lang.String,java.lang.String,java.lang.String)">loadBLAS</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> customLibPath, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> blas, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> optionalMsg)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to load native BLAS</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadLibraryHelperFromResource(java.lang.String)">loadLibraryHelperFromResource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> libFileName)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> input, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> bias, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> filter, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#smmdd(java.nio.FloatBuffer,java.nio.FloatBuffer,java.nio.FloatBuffer,int,int,int,int)">smmdd</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> m1, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> m2, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> ret, |
| int m1rlen, |
| int m1clen, |
| int m2clen, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tsmm(double%5B%5D,double%5B%5D,int,int,boolean,int)">tsmm</a></span>​(double[] m1, |
| double[] ret, |
| int m1rlen, |
| int m1clen, |
| boolean leftTrans, |
| int numThreads)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="CURRENT_NATIVE_BLAS_STATE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CURRENT_NATIVE_BLAS_STATE</h4> |
| <pre>public static <a href="NativeHelper.NativeBlasState.html" title="enum in org.apache.sysds.utils">NativeHelper.NativeBlasState</a> CURRENT_NATIVE_BLAS_STATE</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NativeHelper</h4> |
| <pre>public NativeHelper()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getCurrentBLAS()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentBLAS</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> 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 id="isNativeLibraryLoaded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNativeLibraryLoaded</h4> |
| <pre class="methodSignature">public static boolean 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 id="initialize(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">public static void initialize​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> customLibPath, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> 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 id="getMaxNumThreads()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxNumThreads</h4> |
| <pre class="methodSignature">public static int getMaxNumThreads()</pre> |
| </li> |
| </ul> |
| <a id="loadBLAS(java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadBLAS</h4> |
| <pre class="methodSignature">public static boolean loadBLAS​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> customLibPath, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> blas, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> 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 id="loadLibraryHelperFromResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadLibraryHelperFromResource</h4> |
| <pre class="methodSignature">public static boolean loadLibraryHelperFromResource​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> 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 id="dmmdd(double[],double[],double[],int,int,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dmmdd</h4> |
| <pre class="methodSignature">public static long dmmdd​(double[] m1, |
| double[] m2, |
| double[] ret, |
| int m1rlen, |
| int m1clen, |
| int m2clen, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="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 class="methodSignature">public static long smmdd​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> m1, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> m2, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> ret, |
| int m1rlen, |
| int m1clen, |
| int m2clen, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="tsmm(double[],double[],int,int,boolean,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tsmm</h4> |
| <pre class="methodSignature">public static long tsmm​(double[] m1, |
| double[] ret, |
| int m1rlen, |
| int m1clen, |
| boolean leftTrans, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="conv2dDense(double[],double[],double[],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 class="methodSignature">public static long conv2dDense​(double[] input, |
| double[] filter, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="dconv2dBiasAddDense(double[],double[],double[],double[],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 class="methodSignature">public static long dconv2dBiasAddDense​(double[] input, |
| double[] bias, |
| double[] filter, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="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 class="methodSignature">public static long sconv2dBiasAddDense​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> input, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> bias, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> filter, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/FloatBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">FloatBuffer</a> ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="conv2dBackwardFilterDense(double[],double[],double[],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 class="methodSignature">public static long conv2dBackwardFilterDense​(double[] input, |
| double[] dout, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="conv2dBackwardDataDense(double[],double[],double[],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 class="methodSignature">public static long conv2dBackwardDataDense​(double[] filter, |
| double[] dout, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="conv2dBackwardFilterSparseDense(int,int,int[],double[],double[],double[],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 class="methodSignature">public static boolean conv2dBackwardFilterSparseDense​(int apos, |
| int alen, |
| int[] aix, |
| double[] avals, |
| double[] rotatedDoutPtr, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </li> |
| </ul> |
| <a id="conv2dSparse(int,int,int[],double[],double[],double[],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 class="methodSignature">public static boolean conv2dSparse​(int apos, |
| int alen, |
| int[] aix, |
| double[] avals, |
| double[] filter, |
| double[] ret, |
| int N, |
| int C, |
| int H, |
| int W, |
| int K, |
| int R, |
| int S, |
| int stride_h, |
| int stride_w, |
| int pad_h, |
| int pad_w, |
| int P, |
| int Q, |
| int numThreads)</pre> |
| </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="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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
