com.nativelibs4java.opencl

Enum CLMem.Migration

java.lang.Object

java.lang.Enum<CLMem.Migration>

com.nativelibs4java.opencl.CLMem.Migration

All Implemented Interfaces:

ValuedEnum, Serializable, Comparable<CLMem.Migration>

Enclosing class:

CLMem

public static enum CLMem.Migration
extends Enum<CLMem.Migration>
implements ValuedEnum

Memory object migration options (see CLQueue#enqueueMigrateMemObjects(CLMem[], java.lang.EnumSet, CLEvent[])).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ContentUndefined This flag indicates that the contents of the set of memory objects are undefined after migration.
Host This flag indicates that the specified set of memory objects are to be migrated to the host, regardless of the target command-queue.

Method Summary

Modifier and Type	Method and Description
static EnumSet<CLMem.Migration>	getEnumSet(long v)
static long	getValue(EnumSet<CLMem.Migration> set)
long	value()
static CLMem.Migration	valueOf(String name) Returns the enum constant of this type with the specified name.
static CLMem.Migration[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Host

public static final CLMem.Migration Host

This flag indicates that the specified set of memory objects are to be migrated to the host, regardless of the target command-queue.

ContentUndefined

public static final CLMem.Migration ContentUndefined

This flag indicates that the contents of the set of memory objects are undefined after migration. The specified set of memory objects are migrated to the device associated with command_queue without incurring the overhead of migrating their contents.

Method Detail

values

public static CLMem.Migration[] 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 (CLMem.Migration c : CLMem.Migration.values())
    System.out.println(c);

Returns:

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

valueOf

public static CLMem.Migration 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

value

public long value()

Specified by:

value in interface ValuedEnum

getValue

public static long getValue(EnumSet<CLMem.Migration> set)

getEnumSet

public static EnumSet<CLMem.Migration> getEnumSet(long v)