OpenCLLink`
OpenCLLink`

OpenCLMemoryAllocate

OpenCLMemoryAllocate[t,len]

allocates a new one-dimensional list of type t returning OpenCLMemory.

OpenCLMemoryAllocate[t,{d1,d2,…}]

allocates a new list of dimensions {d1,d2,…} type t returning OpenCLMemory.

Details and Options

  • The OpenCLLink application must be loaded using Needs["OpenCLLink`"].
  • Valid OpenCLMemoryAllocate types are:
  • IntegerRealComplex
    "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" AutomaticOpenCL device used in computation
    "Platform" AutomaticOpenCL platform used in computation
    "TargetPrecision" Automaticprecision used in computation

Examples

open allclose all

Basic Examples  (2)

First, load the OpenCLLink application:

This allocates memory and registers it with the OpenCLLink memory manager:

This allocates a rank-3 tensor into the OpenCLLink memory manager:

This returns information on the memory allocated:

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

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

Scope  (1)

Input dimensions cannot be 0. This is not allowed in the one-dimensional case:

Nor the two-dimensional case:

Options  (3)

"Device"  (1)

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

"Platform"  (1)

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

"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:

This system has double-precision support:

The Real type is interpreted as a "Double". To force the use of "Float", set the "TargetPrecision" to "Single":

Applications  (1)

This sets all elements in a list to 0:

This allocates the required memory:

This loads the function using OpenCLFunctionLoad:

This runs the OpenCLFunction:

This shows information about the memory; note that the "DeviceStatus" is "Synchronized":

This gets the memory from the GPU:

This shows information about the memory; note that the "DeviceStatus" and "HostStatus" are "Synchronized":

Possible Issues  (1)

OpenCLMemoryAllocate does not set the memory elements allocated:

This gets whatever the memory location has stored:

Further allocations are likely to return different values:

This gets the memory allocated; note that it is different from the values allocated before:

Wolfram Research (2010), OpenCLMemoryAllocate, Wolfram Language function, https://reference.wolfram.com/language/OpenCLLink/ref/OpenCLMemoryAllocate.html.

Text

Wolfram Research (2010), OpenCLMemoryAllocate, Wolfram Language function, https://reference.wolfram.com/language/OpenCLLink/ref/OpenCLMemoryAllocate.html.

CMS

Wolfram Language. 2010. "OpenCLMemoryAllocate." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/OpenCLLink/ref/OpenCLMemoryAllocate.html.

APA

Wolfram Language. (2010). OpenCLMemoryAllocate. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/OpenCLLink/ref/OpenCLMemoryAllocate.html

BibTeX

@misc{reference.wolfram_2024_openclmemoryallocate, author="Wolfram Research", title="{OpenCLMemoryAllocate}", year="2010", howpublished="\url{https://reference.wolfram.com/language/OpenCLLink/ref/OpenCLMemoryAllocate.html}", note=[Accessed: 18-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_openclmemoryallocate, organization={Wolfram Research}, title={OpenCLMemoryAllocate}, year={2010}, url={https://reference.wolfram.com/language/OpenCLLink/ref/OpenCLMemoryAllocate.html}, note=[Accessed: 18-November-2024 ]}