org.nd4j.linalg.factory

Class Nd4jBackend

java.lang.Object

org.nd4j.linalg.factory.Nd4jBackend

public abstract class Nd4jBackend
extends Object

An ND4j backend.

Author:

eronwright

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Nd4jBackend.NoAvailableBackendException

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKEND_PRIORITY_CPU
static int	BACKEND_PRIORITY_GPU

Constructor Summary

Constructors

Constructor and Description
Nd4jBackend()

Method Summary

Modifier and Type	Method and Description
abstract boolean	allowsOrder() Returns true if the backend allows order to be specified on blas operations (cblas)
abstract boolean	canRun() Returns true if the backend can run on the os or not
abstract Class	getComplexNDArrayClass() Get the actual (concrete/implementation) class for complex INDArrays for this backend
abstract Resource	getConfigurationResource() Get the configuration resource
Nd4jContext	getContext()
abstract Class	getNDArrayClass() Get the actual (concrete/implementation) class for standard INDArrays for this backend
abstract int	getPriority() Gets a priority number for the backend.
Properties	getProperties()
abstract boolean	isAvailable() Determines whether a given backend is available in the current environment.
static Nd4jBackend	load() Loads the best available backend.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BACKEND_PRIORITY_CPU

public static final int BACKEND_PRIORITY_CPU

See Also:

Constant Field Values

BACKEND_PRIORITY_GPU

public static final int BACKEND_PRIORITY_GPU

See Also:

Constant Field Values

Constructor Detail

Nd4jBackend

public Nd4jBackend()

Method Detail

allowsOrder

public abstract boolean allowsOrder()

Returns true if the backend allows order to be specified on blas operations (cblas)

Returns:

true if the backend allows order to be specified on blas operations

getPriority

public abstract int getPriority()

Gets a priority number for the backend. Backends are loaded in priority order (highest first).

Returns:

a priority number.

isAvailable

public abstract boolean isAvailable()

Determines whether a given backend is available in the current environment.

Returns:

true if the backend is available; false otherwise.

canRun

public abstract boolean canRun()

Returns true if the backend can run on the os or not

Returns:

getConfigurationResource

public abstract Resource getConfigurationResource()

Get the configuration resource

Returns:

getNDArrayClass

public abstract Class getNDArrayClass()

Get the actual (concrete/implementation) class for standard INDArrays for this backend

getComplexNDArrayClass

public abstract Class getComplexNDArrayClass()

Get the actual (concrete/implementation) class for complex INDArrays for this backend

load

public static Nd4jBackend load()
                        throws Nd4jBackend.NoAvailableBackendException

Loads the best available backend.

Returns:

Throws:

Nd4jBackend.NoAvailableBackendException

getProperties

public Properties getProperties()
                         throws IOException

Returns:

Throws:

IOException

getContext

public Nd4jContext getContext()
                       throws IOException

Returns:

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object