org.nd4j.linalg.api.buffer.util

Class LibUtils

java.lang.Object

org.nd4j.linalg.api.buffer.util.LibUtils

public final class LibUtils
extends java.lang.Object

Utility class for detecting the operating system and architecture types, and automatically loading the matching native library as a resource or from a file.

The architecture and OS detection has been adapted from http://javablog.co.uk/2007/05/19/making-jni-cross-platform/ and extended with http://lopica.sourceforge.net/os.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LibUtils.ARCHType Enumeration of common CPU architectures.
static class	LibUtils.OSType Enumeration of common operating systems, independent of version or architecture.

Method Summary

Modifier and Type	Method and Description
static void	addLibraryPath(java.lang.String pathToAdd) Adds the specified path to the java library path
static LibUtils.ARCHType	calculateArch() Calculates the current ARCHType
static LibUtils.OSType	calculateOS() Calculates the current OSType
static java.lang.String	createLibName(java.lang.String baseName) Creates the name for the native library with the given base name for the current operating system and architecture.
static java.lang.String	getArchName()
static java.lang.String	getOsName() Get the name of the os for libary discovery on the classpath
static void	loadJavaCpp(java.lang.Class<?> clazz) Prepend jni to the name for certain classes
static void	loadJavaCppResource(java.lang.String libName) Load the library with the given name from a resource.
static void	loadLibrary(java.lang.String baseName) Loads the specified library.
static void	loadTempBinaryFile(java.lang.Class<?> libName) Load the library with the given name from a resource.
static void	loadTempBinaryFile(java.lang.String libName) Load the library with the given name from a resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadJavaCpp

public static void loadJavaCpp(java.lang.Class<?> clazz)

Prepend jni to the name for certain classes

Parameters:

clazz -

loadLibrary

public static void loadLibrary(java.lang.String baseName)

Loads the specified library. The full name of the library is created by calling createLibName(String) with the given argument. The method will attempt to load the library as a as a resource (for usage within a JAR), and, if this fails, using the usual System.loadLibrary call.

Parameters:

baseName - The base name of the library

Throws:

java.lang.UnsatisfiedLinkError - if the native library could not be loaded.

loadTempBinaryFile

public static void loadTempBinaryFile(java.lang.String libName)
                               throws java.lang.Exception

Load the library with the given name from a resource. The extension for the current OS will be appended.

Parameters:

libName - The library name

Throws:

java.lang.Throwable - If the library could not be loaded

java.lang.Exception

loadTempBinaryFile

public static void loadTempBinaryFile(java.lang.Class<?> libName)
                               throws java.lang.Exception

Load the library with the given name from a resource. The extension for the current OS will be appended.

Parameters:

libName - The library name

Throws:

java.lang.Throwable - If the library could not be loaded

java.lang.Exception

loadJavaCppResource

public static void loadJavaCppResource(java.lang.String libName)
                                throws java.lang.Throwable

Load the library with the given name from a resource. The extension for the current OS will be appended.

Parameters:

libName - The library name

Throws:

java.lang.Throwable - If the library could not be loaded

addLibraryPath

public static void addLibraryPath(java.lang.String pathToAdd)
                           throws java.lang.Exception

Adds the specified path to the java library path

Parameters:

pathToAdd - the path to add

Throws:

java.lang.Exception

getOsName

public static java.lang.String getOsName()

Get the name of the os for libary discovery on the classpath

Returns:

getArchName

public static java.lang.String getArchName()

createLibName

public static java.lang.String createLibName(java.lang.String baseName)

Creates the name for the native library with the given base name for the current operating system and architecture. The resulting name will be of the form
baseName-OSType-ARCHType
where OSType and ARCHType are the lower case Strings of the respective enum constants. Example:
jcuda-windows-x86

Parameters:

baseName - The base name of the library

Returns:

The library name

calculateOS

public static LibUtils.OSType calculateOS()

Calculates the current OSType

Returns:

The current OSType

calculateArch

public static LibUtils.ARCHType calculateArch()

Calculates the current ARCHType

Returns:

The current ARCHType