OpenCLLink`

OpenCLMemoryLoad

OpenCLMemoryLoad[list]

loads list into OpenCLMemory manager, returning an OpenCLMemory.

OpenCLMemoryLoad[list,type]

loads list with specified type into OpenCLMemory manager, returning an OpenCLMemory.

Details and Options

The OpenCLLink application must be loaded using Needs["OpenCLLink`"].
Valid OpenCLMemoryLoad types are:

Integer	Real	Complex
"Byte"	"Bit16"	"Integer"
"Byte[2]"	"Bit16[2]"	"Integer32[2]"
"Byte[4]"	"Bit16[4]"	"Integer32[4]"
"Byte[8]"	"Bit16[8]"	"Integer32[8]"
"Byte[16]"	"Bit16[16]"	"Integer32[16]"
"UnsignedByte"	"UnsignedBit16"	"UnsignedInteger"
"UnsignedByte[2]"	"UnsignedBit16[2]"	"UnsignedInteger[2]"
"UnsignedByte[4]"	"UnsignedBit16[4]"	"UnsignedInteger[4]"
"UnsignedByte[8]"	"UnsignedBit16[8]"	"UnsignedInteger[8]"
"UnsignedByte[16]"	"UnsignedBit16[16]"	"UnsignedInteger[16]"
"Double"	"Float"	"Integer64"
"Double[2]"	"Float[2]"	"Integer64[2]"
"Double[4]"	"Float[4]"	"Integer64[4]"
"Double[8]"	"Float[8]"	"Integer64[8]"
"Double[16]"	"Float[16]"	"Integer64[16]"

OpenCLMemory can be queried using OpenCLMemoryInformation.
OpenCLMemory is retrieved using OpenCLMemoryGet.
OpenCLMemory is unloaded using OpenCLMemoryUnload.
OpenCLMemoryAllocate is used when memory needs to be allocated to be written to, such as output memory.
The following options can be given:

"Device"	Automatic	OpenCL device used in computation
"Platform"	Automatic	OpenCL platform used in computation
"TargetPrecision"	Automatic	precision used in computation

Examples

open allclose all

Basic Examples (5)Summary of the most common use cases

First, load the OpenCLLink application:

In[1]:=1

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-crcp6r

This registers the list ConstantArray[0,10] into the OpenCLLink memory manager:

In[2]:=2

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-ghbd1f

Out[2]=2

Vector types can be loaded, but they must obey the width requirement of the type ("Byte[16]" has a width of 16, for example):

In[1]:=1

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-c8o5ao

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-fo53h7

Out[2]=2

An error is returned otherwise:

In[3]:=3

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-g8gobn

Out[3]=3

Images can be loaded as OpenCLMemory:

In[1]:=1

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-gv09

Out[1]=1

By default, images are represented as a list of integers; different types can be used, however:

In[2]:=2

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-dfe1wh

Out[2]=2

When adding graphics objects, the object is rasterized:

In[1]:=1

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-nkjny0

Out[1]=1

When getting the memory, an image is returned:

In[2]:=2

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-19qj3

Out[2]=2

When using the type Real, whether it is a "Float" or "Double" is based on the OpenCL device:

In[1]:=1

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-m1c8

Out[1]=1

In this case, the system supports double precision. This can be overridden using the "TargetPrecision" option:

In[2]:=2

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-cd15h

Out[2]=2

Options (3)Common values & functionality for each option

"Device" (1)

The devices used in computation can be chosen, but cannot be changed once set by any other OpenCL call:

In[13]:=13

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-gt1iw6

Out[13]=13

"Platform" (1)

The platform used in computation can be chosen, but cannot be changed once set by any other OpenCL call:

In[14]:=14

✖

https://wolfram.com/xid/0cewhkl4xs6a84rqsmphy8c4i-cxv8vv

Out[14]=14

"TargetPrecision" (1)

The target precision can be used to tell OpenCLLink how to interpret the Real type. By default, it is determined by detecting whether the system has double-precision support:

In[15]:=15