org.nd4j.linalg.api.memory.abstracts

Class DummyWorkspace

java.lang.Object

org.nd4j.linalg.api.memory.abstracts.DummyWorkspace

All Implemented Interfaces:

AutoCloseable, Deallocatable, MemoryWorkspace

public class DummyWorkspace
extends Object
implements MemoryWorkspace

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.memory.MemoryWorkspace

MemoryWorkspace.Type

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, DataType dataType, boolean initialize) This method does allocation from a given Workspace
PagedPointer	alloc(long requiredMemory, MemoryKind kind, DataType dataType, boolean initialize) This method does allocation from a given Workspace
void	close() This method is for compatibility with "try-with-resources" java blocks.
Deallocator	deallocator() This method returns deallocator associated with this instance
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	getCurrentOffset() This mehtod returns current offset within buffer
long	getCurrentSize() This methos returns current allocated size of this workspace
int	getDeviceId() Returns deviceId for this workspace
long	getGenerationId() This method returns current generation Id
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	getPrimaryOffset()
long	getThisCycleAllocations() This method returns amount of memory consumed in last successful cycle, in bytes
Long	getThreadId() This method returns threadId where this workspace was created
String	getUniqueId() This method returns unique ID for this instance
WorkspaceConfiguration	getWorkspaceConfiguration() This method returns WorkspaceConfiguration bean that was used for given Workspace instance
MemoryWorkspace.Type	getWorkspaceType() This method returns Type of this workspace
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
void	setPreviousWorkspace(MemoryWorkspace memoryWorkspace) Set the previous workspace, if any NOTE: this method should only be used if you are fully aware of the consequences of doing so.
MemoryWorkspace	tagOutOfScopeUse() This method temporary disables this workspace
int	targetDevice() This method returns deviceId it's affined with, so deallocator thread will be guaranteed to match it
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()

Description copied from interface: MemoryWorkspace

This method returns threadId where this workspace was created

Specified by:

getThreadId in interface MemoryWorkspace

Returns:

getDeviceId

public int getDeviceId()

Description copied from interface: MemoryWorkspace

Returns deviceId for this workspace

Specified by:

getDeviceId in interface MemoryWorkspace

Returns:

getWorkspaceType

public MemoryWorkspace.Type getWorkspaceType()

Description copied from interface: MemoryWorkspace

This method returns Type of this workspace

Specified by:

getWorkspaceType in interface MemoryWorkspace

Returns:

alloc

public PagedPointer alloc(long requiredMemory,
                          DataType 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,
                          DataType 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:

getGenerationId

public long getGenerationId()

Description copied from interface: MemoryWorkspace

This method returns current generation Id

Specified by:

getGenerationId in interface MemoryWorkspace

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()

Description copied from interface: MemoryWorkspace

This method is for compatibility with "try-with-resources" java blocks. Internally it should be equal to notifyScopeLeft() method

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()

Description copied from interface: MemoryWorkspace

This method temporary disables this workspace

Specified by:

tagOutOfScopeUse in interface MemoryWorkspace

Returns:

setPreviousWorkspace

public void setPreviousWorkspace(MemoryWorkspace memoryWorkspace)

Description copied from interface: MemoryWorkspace

Set the previous workspace, if any
NOTE: this method should only be used if you are fully aware of the consequences of doing so. Incorrect use of this method may leave workspace management in an invalid/indeterminant state!

Specified by:

setPreviousWorkspace in interface MemoryWorkspace

Parameters:

memoryWorkspace - Workspace to set as the previous workspace. This is the workspace that will become active when this workspace is closed.

getCurrentOffset

public long getCurrentOffset()

Description copied from interface: MemoryWorkspace

This mehtod returns current offset within buffer

Specified by:

getCurrentOffset in interface MemoryWorkspace

Returns:

getUniqueId

public String getUniqueId()

Description copied from interface: Deallocatable

This method returns unique ID for this instance

Specified by:

getUniqueId in interface Deallocatable

Returns:

deallocator

public Deallocator deallocator()

Description copied from interface: Deallocatable

This method returns deallocator associated with this instance

Specified by:

deallocator in interface Deallocatable

Returns:

targetDevice

public int targetDevice()

Description copied from interface: Deallocatable

This method returns deviceId it's affined with, so deallocator thread will be guaranteed to match it

Specified by:

targetDevice in interface Deallocatable

getPrimaryOffset

public long getPrimaryOffset()

Specified by:

getPrimaryOffset in interface MemoryWorkspace