NAME

       vstore_halfn - Convert float vector to half vector and write to a pointer to memory.

       void vstore_halfn(floatn data, size_t offset, __global half *p);

       void vstore_halfn_rte(floatn data, size_t offset, __global half *p);

       void vstore_halfn_rtz(floatn data, size_t offset, __global half *p);

       void vstore_halfn_rtp(floatn data, size_t offset, __global half *p);

       void vstore_halfn_rtn(floatn data, size_t offset, __global half *p);

       void vstore_halfn(floatn data, size_t offset, __local half *p);

       void vstore_halfn_rte(floatn data, size_t offset, __local half *p);

       void vstore_halfn_rtz(floatn data, size_t offset, __local half *p);

       void vstore_halfn_rtp(floatn data, size_t offset, __local half *p);

       void vstore_halfn_rtn(floatn data, size_t offset, __local half *p);

       void vstore_halfn(floatn data, size_t offset, __private half *p);

       void vstore_halfn_rte(floatn data, size_t offset, __private half *p);

       void vstore_halfn_rtz(floatn data, size_t offset, __private half *p);

       void vstore_halfn_rtp(floatn data, size_t offset, __private half *p);

       void vstore_halfn_rtn(floatn data, size_t offset, __private half *p);

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

DESCRIPTION

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

       vstore_halfn uses the default rounding mode. The default 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.

       vload3 and vload_half3 read x, y, z components from address (p + (offset * 3)) into a
       3-component vector.  vstore3, and vstore_half3 write x, y, z components from a 3-component
       vector to address (p + (offset * 3)).

       In addition vloada_half3 reads x, y, z components from address (p + (offset * 4)) into a
       3- component vector and vstorea_half3 writes x, y, z components from a 3-component vector
       to address (p + (offset * 4)).

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