CpuEnvironment (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.nd4j.linalg.cpu.nativecpu.CpuEnvironment

All Implemented Interfaces:

Environment
```
public class CpuEnvironment
extends Object
implements Environment
```
CPU backend implementation of Environment

Author:

Alex Black

Constructor Summary

Constructors
Modifier Constructor and Description

protected CpuEnvironment(Nd4jCpu.Environment environment)

Constructors
Modifier	Constructor and Description
`protected`	`CpuEnvironment(Nd4jCpu.Environment environment)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allowHelpers(boolean reallyAllow)` Set whether helpers (cuDNN, DNNL/MKLDNN etc) are allowed
`int`	`blasMajorVersion()` BLAS major version number (if applicable)
`int`	`blasMinorVersion()` BLAS minor version number (if applicable)
`int`	`blasPatchVersion()` BLAS patch version number (if applicable)
`int`	`elementwiseThreshold()` Returns the elementwise threshold for ops
`long`	`getDeviceCouner(int deviceId)` This method returns current allocated amount for a specific device.
`long`	`getDeviceLimit(int deviceId)` This method returns current device limit
`long`	`getGroupLimit(int group)` This method returns current group limit
`static CpuEnvironment`	`getInstance()`
`boolean`	`helpersAllowed()` Returns true if helpers (cuDNN, DNNL/MKLDNN etc) are allowed
`boolean`	`isCPU()` Return true if the backend is a CPU backend, or false otherwise
`boolean`	`isDebug()` Returns true if ND4J is set to debug mode
`boolean`	`isDebugAndVerbose()` Returns true if ND4J is set to debug and verbose mode
`boolean`	`isDetectingLeaks()` Returns true if ND4J is set to detecting leaks mode
`boolean`	`isProfiling()` Returns true if ND4J is set to profiling mode
`boolean`	`isVerbose()` Returns true if ND4J is set to verbose mode
`int`	`maxMasterThreads()` Returns the maximum number of master threads for C++ op execution (if applicable)
`int`	`maxThreads()` Returns the maximum number of threads for C++ op execution (if applicable)
`void`	`setDebug(boolean reallyDebug)` Set debug mode
`void`	`setDeviceLimit(int deviceId, long numBytes)` This method allows to set memory limit for a specific device.
`void`	`setElementwiseThreshold(int threshold)` Set the elementwise threshold for ops
`void`	`setGroupLimit(int group, long numBytes)` This method allows to set memory limit for a specific group of devices.
`void`	`setLeaksDetector(boolean reallyDetect)` Set leaks detection mode
`void`	`setMaxDeviceMemory(long maxBytes)` Set the maximum device memory
`void`	`setMaxMasterThreads(int max)` Set the maximum number of master threads for C++ op execution (if applicable)
`void`	`setMaxPrimaryMemory(long maxBytes)` Set the maximum primary memory
`void`	`setMaxSpecialMemory(long maxBytes)` Set the maximum special memory
`void`	`setMaxThreads(int max)` Set the maximum number of threads for C++ op execution (if applicable)
`void`	`setProfiling(boolean reallyProfile)` Set profiling mode
`void`	`setTadThreshold(int threshold)` Set the TAD (tensor along dimension) threshold for ops
`void`	`setVerbose(boolean reallyVerbose)` Set verbose mode
`int`	`tadThreshold()` Returns the TAD (tensor along dimension) threshold for ops

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CpuEnvironment
```
protected CpuEnvironment(Nd4jCpu.Environment environment)
```
- Method Detail
  - getInstance
```
public static CpuEnvironment getInstance()
```
  - blasMajorVersion
```
public int blasMajorVersion()
```
    Description copied from interface: Environment
    
    BLAS major version number (if applicable)
    
    Specified by:
    
    blasMajorVersion in interface Environment
  - blasMinorVersion
```
public int blasMinorVersion()
```
    Description copied from interface: Environment
    
    BLAS minor version number (if applicable)
    
    Specified by:
    
    blasMinorVersion in interface Environment
  - blasPatchVersion
```
public int blasPatchVersion()
```
    Description copied from interface: Environment
    
    BLAS patch version number (if applicable)
    
    Specified by:
    
    blasPatchVersion in interface Environment
  - isVerbose
```
public boolean isVerbose()
```
    Description copied from interface: Environment
    
    Returns true if ND4J is set to verbose mode
    
    Specified by:
    
    isVerbose in interface Environment
  - setVerbose
```
public void setVerbose(boolean reallyVerbose)
```
    Description copied from interface: Environment
    
    Set verbose mode
    
    Specified by:
    
    setVerbose in interface Environment
  - isDebug
```
public boolean isDebug()
```
    Description copied from interface: Environment
    
    Returns true if ND4J is set to debug mode
    
    Specified by:
    
    isDebug in interface Environment
  - isProfiling
```
public boolean isProfiling()
```
    Description copied from interface: Environment
    
    Returns true if ND4J is set to profiling mode
    
    Specified by:
    
    isProfiling in interface Environment
  - isDetectingLeaks
```
public boolean isDetectingLeaks()
```
    Description copied from interface: Environment
    
    Returns true if ND4J is set to detecting leaks mode
    
    Specified by:
    
    isDetectingLeaks in interface Environment
  - isDebugAndVerbose
```
public boolean isDebugAndVerbose()
```
    Description copied from interface: Environment
    
    Returns true if ND4J is set to debug and verbose mode
    
    Specified by:
    
    isDebugAndVerbose in interface Environment
  - setDebug
```
public void setDebug(boolean reallyDebug)
```
    Description copied from interface: Environment
    
    Set debug mode
    
    Specified by:
    
    setDebug in interface Environment
  - setProfiling
```
public void setProfiling(boolean reallyProfile)
```
    Description copied from interface: Environment
    
    Set profiling mode
    
    Specified by:
    
    setProfiling in interface Environment
  - setLeaksDetector
```
public void setLeaksDetector(boolean reallyDetect)
```
    Description copied from interface: Environment
    
    Set leaks detection mode
    
    Specified by:
    
    setLeaksDetector in interface Environment
  - helpersAllowed
```
public boolean helpersAllowed()
```
    Description copied from interface: Environment
    
    Returns true if helpers (cuDNN, DNNL/MKLDNN etc) are allowed
    
    Specified by:
    
    helpersAllowed in interface Environment
  - allowHelpers
```
public void allowHelpers(boolean reallyAllow)
```
    Description copied from interface: Environment
    
    Set whether helpers (cuDNN, DNNL/MKLDNN etc) are allowed
    
    Specified by:
    
    allowHelpers in interface Environment
  - tadThreshold
```
public int tadThreshold()
```
    Description copied from interface: Environment
    
    Returns the TAD (tensor along dimension) threshold for ops
    
    Specified by:
    
    tadThreshold in interface Environment
  - setTadThreshold
```
public void setTadThreshold(int threshold)
```
    Description copied from interface: Environment
    
    Set the TAD (tensor along dimension) threshold for ops
    
    Specified by:
    
    setTadThreshold in interface Environment
  - elementwiseThreshold
```
public int elementwiseThreshold()
```
    Description copied from interface: Environment
    
    Returns the elementwise threshold for ops
    
    Specified by:
    
    elementwiseThreshold in interface Environment
  - setElementwiseThreshold
```
public void setElementwiseThreshold(int threshold)
```
    Description copied from interface: Environment
    
    Set the elementwise threshold for ops
    
    Specified by:
    
    setElementwiseThreshold in interface Environment
  - maxThreads
```
public int maxThreads()
```
    Description copied from interface: Environment
    
    Returns the maximum number of threads for C++ op execution (if applicable)
    
    Specified by:
    
    maxThreads in interface Environment
  - setMaxThreads
```
public void setMaxThreads(int max)
```
    Description copied from interface: Environment
    
    Set the maximum number of threads for C++ op execution (if applicable)
    
    Specified by:
    
    setMaxThreads in interface Environment
  - maxMasterThreads
```
public int maxMasterThreads()
```
    Description copied from interface: Environment
    
    Returns the maximum number of master threads for C++ op execution (if applicable)
    
    Specified by:
    
    maxMasterThreads in interface Environment
  - setMaxMasterThreads
```
public void setMaxMasterThreads(int max)
```
    Description copied from interface: Environment
    
    Set the maximum number of master threads for C++ op execution (if applicable)
    
    Specified by:
    
    setMaxMasterThreads in interface Environment
  - setMaxPrimaryMemory
```
public void setMaxPrimaryMemory(long maxBytes)
```
    Description copied from interface: Environment
    
    Set the maximum primary memory
    
    Specified by:
    
    setMaxPrimaryMemory in interface Environment
  - setMaxSpecialMemory
```
public void setMaxSpecialMemory(long maxBytes)
```
    Description copied from interface: Environment
    
    Set the maximum special memory
    
    Specified by:
    
    setMaxSpecialMemory in interface Environment
  - setMaxDeviceMemory
```
public void setMaxDeviceMemory(long maxBytes)
```
    Description copied from interface: Environment
    
    Set the maximum device memory
    
    Specified by:
    
    setMaxDeviceMemory in interface Environment
  - isCPU
```
public boolean isCPU()
```
    Description copied from interface: Environment
    
    Return true if the backend is a CPU backend, or false otherwise
    
    Specified by:
    
    isCPU in interface Environment
  - setGroupLimit
```
public void setGroupLimit(int group,
                          long numBytes)
```
    Description copied from interface: Environment
    
    This method allows to set memory limit for a specific group of devices. I.e. CUDA or CPU
    
    Specified by:
    
    setGroupLimit in interface Environment
  - setDeviceLimit
```
public void setDeviceLimit(int deviceId,
                           long numBytes)
```
    Description copied from interface: Environment
    
    This method allows to set memory limit for a specific device. I.e. GPU_0
    
    Specified by:
    
    setDeviceLimit in interface Environment
  - getGroupLimit
```
public long getGroupLimit(int group)
```
    Description copied from interface: Environment
    
    This method returns current group limit
    
    Specified by:
    
    getGroupLimit in interface Environment
    
    Returns:
  - getDeviceLimit
```
public long getDeviceLimit(int deviceId)
```
    Description copied from interface: Environment
    
    This method returns current device limit
    
    Specified by:
    
    getDeviceLimit in interface Environment
    
    Returns:
  - getDeviceCouner
```
public long getDeviceCouner(int deviceId)
```
    Description copied from interface: Environment
    
    This method returns current allocated amount for a specific device. I.e. GPU_0
    
    Specified by:
    
    getDeviceCouner in interface Environment
    
    Returns:

Class CpuEnvironment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CpuEnvironment

Method Detail

getInstance

blasMajorVersion

blasMinorVersion

blasPatchVersion

isVerbose

setVerbose

isDebug

isProfiling

isDetectingLeaks

isDebugAndVerbose

setDebug

setProfiling

setLeaksDetector

helpersAllowed

allowHelpers

tadThreshold

setTadThreshold

elementwiseThreshold

setElementwiseThreshold

maxThreads

setMaxThreads

maxMasterThreads

setMaxMasterThreads

setMaxPrimaryMemory

setMaxSpecialMemory

setMaxDeviceMemory

isCPU

setGroupLimit

setDeviceLimit

getGroupLimit

getDeviceLimit

getDeviceCouner