org.nd4j.linalg.memory.abstracts

Class DummyWorkspace

java.lang.Object

org.nd4j.linalg.memory.abstracts.DummyWorkspace

All Implemented Interfaces:

AutoCloseable, MemoryWorkspace

public class DummyWorkspace
extends Object
implements MemoryWorkspace

This MemoryWorkspace implementation is basically No-Op impl. Do not use it anywhere, unless you 100% sure you need it.

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field and Description
protected MemoryWorkspace	parentWorkspace

Fields inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

DEFAULT_ID

Constructor Summary

Constructors

Constructor and Description
DummyWorkspace()

Method Summary

Modifier and Type	Method and Description
PagedPointer	alloc(long requiredMemory, DataBuffer.Type dataType, boolean initialize) This method does allocation from a given Workspace
PagedPointer	alloc(long requiredMemory, MemoryKind kind, DataBuffer.Type dataType, boolean initialize) This method does allocation from a given Workspace
void	close()
void	destroyWorkspace() This method causes Workspace destruction: all memory allocations are released after this call.
void	destroyWorkspace(boolean extended)
void	enableDebug(boolean reallyEnable) This method enabled debugging mode for this workspace
long	getCurrentSize() This methos returns current allocated size of this workspace
int	getDeviceId()
String	getId() This method returns Id of this workspace
long	getLastCycleAllocations() This method returns amount of memory consumed in last successful cycle, in bytes
long	getMaxCycleAllocations() This method returns amount of memory consumed by largest successful cycle, in bytes
MemoryWorkspace	getParentWorkspace() This method returns parent Workspace, if any.
long	getThisCycleAllocations() This method returns amount of memory consumed in last successful cycle, in bytes
Long	getThreadId()
WorkspaceConfiguration	getWorkspaceConfiguration() This method returns WorkspaceConfiguration bean that was used for given Workspace instance
void	initializeWorkspace() This method causes Workspace initialization
boolean	isScopeActive() This method returns True if scope was opened, and not closed yet.
MemoryWorkspace	notifyScopeBorrowed() This method TEMPORARY enters this workspace, without reset applied
MemoryWorkspace	notifyScopeEntered() This method notifies given Workspace that new use cycle is starting now
MemoryWorkspace	notifyScopeLeft() This method notifies given Workspace that use cycle just ended
MemoryWorkspace	tagOutOfScopeUse()
void	toggleWorkspaceUse(boolean isEnabled) This method allows you to temporary disable/enable given Workspace use.

Methods inherited from class java.lang.Object

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

Field Detail

parentWorkspace

protected MemoryWorkspace parentWorkspace

Constructor Detail

DummyWorkspace

public DummyWorkspace()

Method Detail

getWorkspaceConfiguration

public WorkspaceConfiguration getWorkspaceConfiguration()

This method returns WorkspaceConfiguration bean that was used for given Workspace instance

Specified by:

getWorkspaceConfiguration in interface MemoryWorkspace

Returns:

getId

public String getId()

This method returns Id of this workspace

Specified by:

getId in interface MemoryWorkspace

Returns:

getThreadId

public Long getThreadId()

Specified by:

getThreadId in interface MemoryWorkspace

getDeviceId

public int getDeviceId()

Specified by:

getDeviceId in interface MemoryWorkspace

alloc

public PagedPointer alloc(long requiredMemory,
                          DataBuffer.Type dataType,
                          boolean initialize)

This method does allocation from a given Workspace

Specified by:

alloc in interface MemoryWorkspace

Parameters:

requiredMemory - allocation size, in bytes

dataType - dataType that is going to be used

initialize -

Returns:

alloc

public PagedPointer alloc(long requiredMemory,
                          MemoryKind kind,
                          DataBuffer.Type dataType,
                          boolean initialize)

This method does allocation from a given Workspace

Specified by:

alloc in interface MemoryWorkspace

Parameters:

requiredMemory - allocation size, in bytes

kind - MemoryKind for allocation

dataType - dataType that is going to be used

initialize -

Returns:

notifyScopeEntered

public MemoryWorkspace notifyScopeEntered()

This method notifies given Workspace that new use cycle is starting now

Specified by:

notifyScopeEntered in interface MemoryWorkspace

Returns:

notifyScopeBorrowed

public MemoryWorkspace notifyScopeBorrowed()

This method TEMPORARY enters this workspace, without reset applied

Specified by:

notifyScopeBorrowed in interface MemoryWorkspace

Returns:

notifyScopeLeft

public MemoryWorkspace notifyScopeLeft()

This method notifies given Workspace that use cycle just ended

Specified by:

notifyScopeLeft in interface MemoryWorkspace

Returns:

isScopeActive

public boolean isScopeActive()

This method returns True if scope was opened, and not closed yet.

Specified by:

isScopeActive in interface MemoryWorkspace

Returns:

initializeWorkspace

public void initializeWorkspace()

This method causes Workspace initialization

PLEASE NOTE: This call will have no effect on previously initialized Workspace

Specified by:

initializeWorkspace in interface MemoryWorkspace

destroyWorkspace

public void destroyWorkspace()

This method causes Workspace destruction: all memory allocations are released after this call.

Specified by:

destroyWorkspace in interface MemoryWorkspace

destroyWorkspace

public void destroyWorkspace(boolean extended)

Specified by:

destroyWorkspace in interface MemoryWorkspace

toggleWorkspaceUse

public void toggleWorkspaceUse(boolean isEnabled)

This method allows you to temporary disable/enable given Workspace use. If turned off - direct memory allocations will be used.

Specified by:

toggleWorkspaceUse in interface MemoryWorkspace

Parameters:

isEnabled -

getThisCycleAllocations

public long getThisCycleAllocations()

This method returns amount of memory consumed in last successful cycle, in bytes

Specified by:

getThisCycleAllocations in interface MemoryWorkspace

Returns:

enableDebug

public void enableDebug(boolean reallyEnable)

This method enabled debugging mode for this workspace

Specified by:

enableDebug in interface MemoryWorkspace

Parameters:

reallyEnable -

getLastCycleAllocations

public long getLastCycleAllocations()

This method returns amount of memory consumed in last successful cycle, in bytes

Specified by:

getLastCycleAllocations in interface MemoryWorkspace

Returns:

getMaxCycleAllocations

public long getMaxCycleAllocations()

This method returns amount of memory consumed by largest successful cycle, in bytes

Specified by:

getMaxCycleAllocations in interface MemoryWorkspace

Returns:

getCurrentSize

public long getCurrentSize()

This methos returns current allocated size of this workspace

Specified by:

getCurrentSize in interface MemoryWorkspace

Returns:

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MemoryWorkspace

getParentWorkspace

public MemoryWorkspace getParentWorkspace()

This method returns parent Workspace, if any. Null if there's none.

Specified by:

getParentWorkspace in interface MemoryWorkspace

Returns:

tagOutOfScopeUse

public MemoryWorkspace tagOutOfScopeUse()

Specified by:

tagOutOfScopeUse in interface MemoryWorkspace