ai.djl.ndarray

Class BaseNDManager

java.lang.Object

ai.djl.ndarray.BaseNDManager

All Implemented Interfaces:

NDManager, java.lang.AutoCloseable

public abstract class BaseNDManager
extends java.lang.Object
implements NDManager

BaseNDManager is the default implementation of NDManager.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicBoolean	closed
protected Device	device
protected NDManager	parent
protected java.util.Map<java.lang.String,java.lang.ref.Reference<java.lang.AutoCloseable>>	resources
protected java.lang.String	uid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseNDManager(NDManager parent, Device device)

Method Summary

Modifier and Type	Method and Description
void	attach(java.lang.String resourceId, java.lang.AutoCloseable resource) Attaches a NDArray or NDManager to this NDManager.
void	close()
void	debugDump(int level) Prints information about this NDManager and all sub-managers to the console.
void	detach(java.lang.String resourceId) Detaches a NDArray from this NDManager's lifecycle.
Device	getDevice() Returns the default Device of this NDManager.
NDManager	getParentManager() Returns the parent NDManager.
boolean	isOpen() Check if the manager is still valid.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.ndarray.NDManager

allocateDirect, arange, arange, arange, arange, arange, arange, arange, arange, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, createCSR, createCSR, createRowSparse, createRowSparse, decode, decode, eye, eye, eye, eye, getEngine, invoke, invoke, linspace, linspace, linspace, linspace, load, load, newBaseManager, newBaseManager, newBaseManager, newSubManager, newSubManager, ones, ones, ones, randomMultinomial, randomMultinomial, randomNormal, randomNormal, randomNormal, randomUniform, randomUniform, zeros, zeros, zeros

Field Detail

parent

protected NDManager parent

uid

protected java.lang.String uid

device

protected Device device

resources

protected java.util.Map<java.lang.String,java.lang.ref.Reference<java.lang.AutoCloseable>> resources

closed

protected java.util.concurrent.atomic.AtomicBoolean closed

Constructor Detail

BaseNDManager

protected BaseNDManager(NDManager parent,
                        Device device)

Method Detail

isOpen

public boolean isOpen()

Check if the manager is still valid.

Specified by:

isOpen in interface NDManager

Returns:

the current status

getParentManager

public NDManager getParentManager()

Returns the parent NDManager.

Specified by:

getParentManager in interface NDManager

Returns:

the parent NDManager

getDevice

public Device getDevice()

Returns the default Device of this NDManager.

Specified by:

getDevice in interface NDManager

Returns:

the default Device of this NDManager

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

attach

public void attach(java.lang.String resourceId,
                   java.lang.AutoCloseable resource)

Attaches a NDArray or NDManager to this NDManager.

Attached resource will be closed when this NDManager is closed.

Specified by:

attach in interface NDManager

Parameters:

resourceId - the unique resourceId

resource - the AutoCloseable resource to be attached

detach

public void detach(java.lang.String resourceId)

Detaches a NDArray from this NDManager's lifecycle.

The detached NDArray become un-managed, it's user's responsibility to close the resource. Failed to close the resource has to wait on GC to be freed, and might cause out of native memory.

Specified by:

detach in interface NDManager

Parameters:

resourceId - the resourceId to be removed from this NDManager's lifecycle

close

public void close()

Specified by:

close in interface NDManager

Specified by:

close in interface java.lang.AutoCloseable

debugDump

public void debugDump(int level)

Prints information about this NDManager and all sub-managers to the console.

Parameters:

level - the level of this NDManager in the hierarchy