'\" t
.\"     Title: pow, pown, powr, half_powr, native_powr
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "POW, POWN, POWR, HAL" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pow,_pown,_powr,_half_powr,_native_powr \- Compute x to the power of y\&.
.SH ""
.HP \w'gentype\ pow('u
.BI "gentype pow(gentype\ " "x" ", gentype\ " "y" ");"
.HP \w'floatn\ pown('u
.BI "floatn pown(floatn\ " "x" ", intn\ " "y" ");"
.HP \w'float\ pown('u
.BI "float pown(float\ " "x" ", int\ " "y" ");"
.HP \w'doublen\ pown('u
.BI "doublen pown(doublen\ " "x" ", intn\ " "y" ");"
.HP \w'double\ pown('u
.BI "double pown(double\ " "x" ", int\ " "y" ");"
.HP \w'gentype\ powr('u
.BI "gentype powr(gentype\ " "x" ", gentype\ " "y" ");"
.HP \w'gentype\ half_powr('u
.BI "gentype half_powr(gentype\ " "x" ", gentype\ " "y" ");"
.HP \w'gentype\ native_powr('u
.BI "gentype native_powr(gentype\ " "x" ", gentype\ " "y" ");"
.HP \w'halfn\ pown('u
.BI "halfn pown(halfn\ " "x" ", intn\ " "y" ");"
.HP \w'half\ pown('u
.BI "half pown(half\ " "x" ", int\ " "y" ");"
.SH "DESCRIPTION"
.PP
\fBpow\fR
Computes
\fIx\fR
to the power of
\fIy\fR\&.
.PP
\fBpown\fR
Computes
\fIx\fR
to the power of
\fIy\fR, where
\fIy\fR
is an integer\&.
.PP
\fBpowr\fR
Computes
\fIx\fR
to the power of
\fIy\fR, where
\fIx\fR
is ≥ 0\&.
.PP
\fBhalf_powr\fR
Computes
\fIx\fR
to the power of
\fIy\fR, where
\fIx\fR
is ≥ 0\&.
.PP
\fBnative_powr\fR
Computes
\fIx\fR
to the power of
\fIy\fR, where
\fIx\fR
is ≥ 0\&. The range of
\fIx\fR
and
\fIy\fR
are implementation\-defined\&. The maximum error is implementation\-defined\&.
.SH "NOTES"
.PP
The vector versions of the math functions operate component\-wise\&. The description is per\-component\&.
.PP
The built\-in math functions are not affected by the prevailing rounding mode in the calling environment, and always return the same value as they would if called with the round to nearest even rounding mode\&.
.PP
The built\-in math functions take scalar or vector arguments\&. For any specific use of these function, the actual type has to be the same for all arguments and the return type unless otherwise specified\&.
.PP
The generic type name
\fBgentype\fR
is used to indicate that the function can take
\fBfloat\fR,
\fBfloat2\fR,
\fBfloat3\fR,
\fBfloat4\fR,
\fBfloat8\fR,
\fBfloat16\fR,
\fBdouble\fR,
\fBdouble2\fR,
\fBdouble3\fR,
\fBdouble4\fR,
\fBdouble8\fR, or
\fBdouble16\fR
as the type for the arguments\&.
.PP
If extended with
\fBcl_khr_fp16\fR(3clc), generic type name
\fBgentype\fR
may indicate
\fBhalf\fR
and
\fBhalf{2|3|4|8|16}\fR
as arguments and return values\&.
.PP
The generic type name
\fBgentypef\fR
is used to indicate that the function can take
\fBfloat\fR,
\fBfloat2\fR,
\fBfloat3\fR,
\fBfloat4\fR,
\fBfloat8\fR, or
\fBfloat16\fR
as the type for the arguments\&.
.PP
The generic type name
\fBgentyped\fR
is used to indicate that the function can take
\fBdouble\fR,
\fBdouble2\fR,
\fBdouble3\fR,
\fBdouble4\fR,
\fBdouble8\fR, or
\fBdouble16\fR
as the type for the arguments\&.
.PP
Functions with the
\fBhalf_\fR
prefix are implemented with a minimum of 10\-bits of accuracy i\&.e\&. an ULP value less than or equal to 8192 ulp\&.
.PP
Functions with the
\fBnative__\fR
prefix may map to one or more native device instructions and will typically have better performance compared to the corresponding functions (without the
\fBnative__\fR
prefix)\&. The accuracy (and in some cases the input range(s)) of these functions is implementation\-defined\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBmathFunctions\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2010 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 244, section 6.12.2 - Math Functions
.RE