org.bytedeco.dnnl.global

Enum dnnl.scratchpad_mode

java.lang.Object

java.lang.Enum<dnnl.scratchpad_mode>

org.bytedeco.dnnl.global.dnnl.scratchpad_mode

All Implemented Interfaces:

Serializable, Comparable<dnnl.scratchpad_mode>

Enclosing class:

dnnl

@Namespace(value="dnnl")
public static enum dnnl.scratchpad_mode
extends Enum<dnnl.scratchpad_mode>

\} dnnl_api_primitives_common

\addtogroup dnnl_api_attributes A container for parameters that extend primitives behavior. Attributes can also contain Post-ops, which are computations executed after the primitive.

See Also:

dev_guide_attributes, dev_guide_attributes_post_ops \{

Scratchpad mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
library The library manages the scratchpad allocation according to the policy specified by the DNNL_ENABLE_CONCURRENT_EXEC [build option](\ref dev_guide_build_options) (default).
user The user manages the scratchpad allocation by querying and providing the scratchpad memory to primitives.

Field Summary

Fields

Modifier and Type	Field and Description
int	value

Method Summary

Modifier and Type	Method and Description
dnnl.scratchpad_mode	intern()
String	toString()
static dnnl.scratchpad_mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static dnnl.scratchpad_mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

library

public static final dnnl.scratchpad_mode library

The library manages the scratchpad allocation according to the policy specified by the DNNL_ENABLE_CONCURRENT_EXEC [build option](\ref dev_guide_build_options) (default). When DNNL_ENABLE_CONCURRENT_EXEC=OFF (default), the library scratchpad is common to all primitives to reduce the memory footprint. This configuration comes with limited thread-safety properties, namely primitives can be created and executed in parallel but cannot migrate between threads (in other words, each primitive should be executed in the same thread it was created in). When DNNL_ENABLE_CONCURRENT_EXEC=ON, the library scratchpad is private to each primitive. The memory footprint is larger than when using DNNL_ENABLE_CONCURRENT_EXEC=OFF but different primitives can be created and run concurrently (the same primitive cannot be run concurrently from two different threads though).

user

public static final dnnl.scratchpad_mode user

The user manages the scratchpad allocation by querying and providing the scratchpad memory to primitives. This mode is thread-safe as long as the scratchpad buffers are not used concurrently by two primitive executions.

Field Detail

value

public final int value

Method Detail

values

public static dnnl.scratchpad_mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (dnnl.scratchpad_mode c : dnnl.scratchpad_mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static dnnl.scratchpad_mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

intern

public dnnl.scratchpad_mode intern()

toString

public String toString()

Overrides:

toString in class Enum<dnnl.scratchpad_mode>