org.nd4j.linalg.api.memory

Interface MemoryWorkspaceManager

public interface MemoryWorkspaceManager

This interface describes backend-specific implementations of MemoryWorkspaceManager, basically Factory + Thread-based provider

Author:

raver119@gmail.com

Method Summary

Modifier and Type	Method and Description
boolean	checkIfWorkspaceExists(String id) This method checks, if Workspace with a given Id was created before this call
MemoryWorkspace	createNewWorkspace() This method builds new Workspace with default configuration
MemoryWorkspace	createNewWorkspace(WorkspaceConfiguration configuration) This method builds new Workspace with given configuration
MemoryWorkspace	createNewWorkspace(WorkspaceConfiguration configuration, String id) This method builds new Workspace with given configuration
MemoryWorkspace	createNewWorkspace(WorkspaceConfiguration configuration, String id, Integer deviceId) This method builds new Workspace with given configuration
void	destroyAllWorkspacesForCurrentThread() This method destroys & deallocates all Workspaces for a calling Thread PLEASE NOTE: This method is NOT safe
void	destroyWorkspace() This method destroys current Workspace for current Thread
void	destroyWorkspace(MemoryWorkspace workspace) This method allows you to destroy given Workspace
MemoryWorkspace	getAndActivateWorkspace() This method gets & activates default workspace
MemoryWorkspace	getAndActivateWorkspace(String id) This method gets & activates workspace with a given Id
MemoryWorkspace	getAndActivateWorkspace(WorkspaceConfiguration configuration, String id) This method gets & activates default with a given configuration and Id
MemoryWorkspace	getWorkspaceForCurrentThread() This method returns you current default Workspace for current Thread PLEASE NOTE: If Workspace wasn't defined, new Workspace will be created using current default configuration
MemoryWorkspace	getWorkspaceForCurrentThread(String id) This method returns you Workspace for a given Id for current Thread PLEASE NOTE: If Workspace wasn't defined, new Workspace will be created using current default configuration
MemoryWorkspace	getWorkspaceForCurrentThread(WorkspaceConfiguration configuration, String id) This method returns you Workspace for a given Id for current Thread PLEASE NOTE: If Workspace wasn't defined, new Workspace will be created using given configuration
void	printAllocationStatisticsForCurrentThread()
MemoryWorkspace	scopeOutOfWorkspaces() This method temporary opens block out of any workspace scope.
void	setDefaultWorkspaceConfiguration(WorkspaceConfiguration configuration) This method sets default workspace configuration for this provider instance
void	setWorkspaceForCurrentThread(MemoryWorkspace workspace) This method allows you to set given Workspace as default for current Thread
void	setWorkspaceForCurrentThread(MemoryWorkspace workspace, String id) This method allows you to set given Workspace for spacific Id for current Thread

Method Detail

setDefaultWorkspaceConfiguration

void setDefaultWorkspaceConfiguration(WorkspaceConfiguration configuration)

This method sets default workspace configuration for this provider instance

Parameters:

configuration -

createNewWorkspace

MemoryWorkspace createNewWorkspace(WorkspaceConfiguration configuration)

This method builds new Workspace with given configuration

Parameters:

configuration -

Returns:

createNewWorkspace

MemoryWorkspace createNewWorkspace()

This method builds new Workspace with default configuration

Returns:

createNewWorkspace

MemoryWorkspace createNewWorkspace(WorkspaceConfiguration configuration,
                                   String id)

This method builds new Workspace with given configuration

Parameters:

configuration -

Returns:

createNewWorkspace

MemoryWorkspace createNewWorkspace(WorkspaceConfiguration configuration,
                                   String id,
                                   Integer deviceId)

This method builds new Workspace with given configuration

Parameters:

configuration -

Returns:

getWorkspaceForCurrentThread

MemoryWorkspace getWorkspaceForCurrentThread()

This method returns you current default Workspace for current Thread PLEASE NOTE: If Workspace wasn't defined, new Workspace will be created using current default configuration

Returns:

getWorkspaceForCurrentThread

MemoryWorkspace getWorkspaceForCurrentThread(String id)

This method returns you Workspace for a given Id for current Thread PLEASE NOTE: If Workspace wasn't defined, new Workspace will be created using current default configuration

Returns:

getWorkspaceForCurrentThread

MemoryWorkspace getWorkspaceForCurrentThread(WorkspaceConfiguration configuration,
                                             String id)

This method returns you Workspace for a given Id for current Thread PLEASE NOTE: If Workspace wasn't defined, new Workspace will be created using given configuration

Returns:

setWorkspaceForCurrentThread

void setWorkspaceForCurrentThread(MemoryWorkspace workspace)

This method allows you to set given Workspace as default for current Thread

Parameters:

workspace -

setWorkspaceForCurrentThread

void setWorkspaceForCurrentThread(MemoryWorkspace workspace,
                                  String id)

This method allows you to set given Workspace for spacific Id for current Thread

Parameters:

workspace -

destroyWorkspace

void destroyWorkspace(MemoryWorkspace workspace)

This method allows you to destroy given Workspace

Parameters:

workspace -

destroyAllWorkspacesForCurrentThread

void destroyAllWorkspacesForCurrentThread()

This method destroys & deallocates all Workspaces for a calling Thread PLEASE NOTE: This method is NOT safe

destroyWorkspace

void destroyWorkspace()

This method destroys current Workspace for current Thread

getAndActivateWorkspace

MemoryWorkspace getAndActivateWorkspace()

This method gets & activates default workspace

Returns:

getAndActivateWorkspace

MemoryWorkspace getAndActivateWorkspace(String id)

This method gets & activates workspace with a given Id

Returns:

getAndActivateWorkspace

MemoryWorkspace getAndActivateWorkspace(WorkspaceConfiguration configuration,
                                        String id)

This method gets & activates default with a given configuration and Id

Returns:

checkIfWorkspaceExists

boolean checkIfWorkspaceExists(String id)

This method checks, if Workspace with a given Id was created before this call

Parameters:

id -

Returns:

scopeOutOfWorkspaces

MemoryWorkspace scopeOutOfWorkspaces()

This method temporary opens block out of any workspace scope. PLEASE NOTE: Do not forget to close this block.

Returns:

printAllocationStatisticsForCurrentThread

void printAllocationStatisticsForCurrentThread()