sdk/1.0/docs/man/mathConstants.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>                            
                Symbolic Math Constants
            </keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>                                    
        <refentrytitle>Symbolic Math Constants</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2009</year>
                <holder>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.</holder>
            </copyright>
        </refmiscinfo>
        <manvolnum>2</manvolnum>
    </refmeta>

<!-- ================================ SYNOPSIS -->

 
    <refnamediv id="Other Data Types">          
        <refname>Symbolic Math Constants</refname>

        <refpurpose>
			 The following symbolic constants are available.
        </refpurpose>
    </refnamediv>



<!-- ================================ DESCRIPTION  -->


    <refsect1 id="description"><title>Built-in Math Constants</title>
        <para>
        </para>

        <informaltable frame="all">
            <tgroup cols="2" align="left" colsep="1" rowsep="1">
                <colspec colname="col1" colnum="1" />
                <colspec colname="col2" colnum="2" />

                <thead>
                    <row>
                        <entry>Constant Name</entry>
                        <entry>Description</entry>
                    </row>
                </thead>

                <tbody>

                    <row>
                        <entry>
							MAXFLOAT
                        </entry>
                        <entry>
							Value of maximum non-infinite single-precision floating-point number.
                        </entry>
                    </row>
                    <row>
                        <entry>
							HUGE_VALF
                        </entry>

                        <entry>
							A positive float constant expression. HUGE_VALF evaluates to +infinity. Used as an error value returned by the <citerefentry href="mathFunctions"><refentrytitle>built-in math functions</refentrytitle></citerefentry>.
                        </entry>
                    </row>

                    <row>
                        <entry>
							INFINITY
                        </entry>

                        <entry>
							A constant expression of type float representing positive or unsigned infinity.
                        </entry>
                    </row>

                    <row>
                        <entry>
							NAN
                        </entry>

                        <entry>
							A constant expression of type float representing a quiet NaN.
                        </entry>
                    </row>

                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>

	
 <refsect1 id="double"><title>Double Math Constants</title>
        <para>
		The following constants are also available if the built-in math functions are extended with  <citerefentry><refentrytitle>cl_khr_fp64</refentrytitle></citerefentry>. They are of type <type>double</type> and are accurate within
the precision of the <type>double</type> type.
        </para>

        <informaltable frame="all">
            <tgroup cols="2" align="left" colsep="1" rowsep="1">
                <colspec colname="col1" colnum="1" />
                <colspec colname="col2" colnum="2" />

                <thead>
                    <row>
                        <entry>Constant Name</entry>
                        <entry>Description</entry>
                    </row>
                </thead>

                <tbody>
                    <row>
                        <entry>M_E</entry>
                        <entry>Value of e</entry>
                    </row>
                    <row>
                        <entry>M_LOG2E</entry>
                        <entry>Value of log<subscript>2</subscript>e</entry>
                    </row>
                    <row>
                        <entry>M_LOG10E</entry>
                        <entry>Value of log<subscript>10</subscript>e</entry>
                    </row>
                    <row>
                        <entry>M_LN2</entry>
                        <entry>Value of log<subscript>e</subscript>2</entry>
                    </row>
                    <row>
                        <entry>M_LN10</entry>
                        <entry>Value of log<subscript>e</subscript>10</entry>
                    </row>
                    <row>
                        <entry>M_PI</entry>
                        <entry>Value of pi</entry>
                    </row>
                    <row>
                        <entry>M_PI_2</entry>
                        <entry>Value of pi / 2</entry>
                    </row>
                    <row>
                        <entry>M_PI_4</entry>
                        <entry>Value of pi / 4</entry>
                    </row>
                    <row>
                        <entry>M_1_PI</entry>
                        <entry>Value of 1 / pi</entry>
                    </row>
                    <row>
                        <entry>M_2_PI</entry>
                        <entry>Value of 2 / pi</entry>
                    </row>
                    <row>
                        <entry>M_2_SQRTPI</entry>
                        <entry>Value of 2 / (square root of pi)</entry>
                    </row>
                    <row>
                        <entry>M_SQRT2</entry>
                        <entry>Value of square root of 2</entry>
                    </row>
                    <row>
                        <entry>M_SQRT1_2</entry>
                        <entry>Value of 1 / (square root of 2)</entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
	
<!-- ================================ SPECIFICATION  -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
    <refsect1 id="specification"><title>Specification</title>
        <para>
            <imageobject>
                <imagedata fileref="pdficon_small1.gif" format="gif" />
            </imageobject>
                                                 
            <olink uri="mathConstants">OpenCL Specification</olink>
        </para>
    </refsect1>


<!-- ================================ ALSO SEE  -->

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>, 
			<citerefentry href="FP_CONTRACT"><refentrytitle>Floating Point Pragma</refentrytitle></citerefentry>, 
			<citerefentry href="macroLimits"><refentrytitle>Macros and Limits</refentrytitle></citerefentry> 
        </para>
    </refsect1>



<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->

    <refsect3 id="Copyright"><title></title>
		<imageobject>
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
        </imageobject>
		<para />
    </refsect3>

</refentry>