bionic (3) vstore_half.3clc.gz

NAME

       vstore_half - Convert float to half and write to a pointer to memory.

       void vstore_half(float data, size_t offset, __global half *p);

       void vstore_half_rte(float data, size_t offset, __global half *p);

       void vstore_half_rtz(float data, size_t offset, __global half *p);

       void vstore_half_rtp(float data, size_t offset, __global half *p);

       void vstore_half_rtn(float data, size_t offset, __global half *p);

       void vstore_half(float data, size_t offset, __local half *p);

       void vstore_half_rte(float data, size_t offset, __local half *p);

       void vstore_half_rtz(float data, size_t offset, __local half *p);

       void vstore_half_rtp(float data, size_t offset, __local half *p);

       void vstore_half_rtn(float data, size_t offset, __local half *p);

       void vstore_half(float data, size_t offset, __private half *p);

       void vstore_half_rte(float data, size_t offset, __private half *p);

       void vstore_half_rtz(float data, size_t offset, __private half *p);

       void vstore_half_rtp(float data, size_t offset, __private half *p);

       void vstore_half_rtn(float data, size_t offset, __private half *p);

       If the optional double is supported, you may use double
       instead of float.

DESCRIPTION

       The float (or double if optional double is supported) value given by data is first converted to a half
       value using the appropriate rounding mode. The half value is then written to address computed as (p +
       offset). The address computed as (p + offset) must be 16-bit aligned.

       vstore_half uses the current rounding mode. The default current rounding mode is round to nearest even.

NOTES

       Vector Data Load and Store Functions allow you to read and write vector types from a pointer to memory.

       The generic type gentype is used to indicate the built-in data types char, uchar, short, ushort, int,
       uint, long, ulong, float, or double.

       The generic type name gentypen represents n-element vectors of gentype elements. The suffix n is also
       used in the function names (i.e.  vloadn, vstoren, etc.), where n = 2, 3, 4, 8, or 16.

       The results of vector data load and store functions are undefined if the address being read from or
       written to is not correctly aligned. The pointer argument p can be a pointer to global(3clc),
       local(3clc), or private(3clc) memory for store functions. The pointer argument p can be a pointer to
       __global, __local, constant(3clc) or __private memory for load functions.

SPECIFICATION

       OpenCL Specification[1]

SEE ALSO

       vectorDataLoadandStoreFunctions(3clc)

AUTHORS

       The Khronos Group

COPYRIGHT

       Copyright © 2007-2011 The Khronos Group Inc.
       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or
       associated documentation files (the "Materials"), to deal in the Materials without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to
       the condition that this copyright notice and permission notice shall be included in all copies or
       substantial portions of the Materials.

NOTES

        1. OpenCL Specification
           page 267, section 6.12.7 - Vector Data Load and Store Functions