~ubuntu-branches/ubuntu/trusty/khronos-opencl-man/trusty

<?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" [

<!ENTITY commonFunctionsInc SYSTEM "commonFunctionsInc.xml">

]>

<refentry>

    <refentryinfo>

        <keywordset>

            <keyword>sign</keyword>

        </keywordset>

    </refentryinfo>

 

    <refmeta>

        <refentrytitle>sign</refentrytitle>

 

        <refmiscinfo>

            <copyright>

                <year>2007-2011</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>3</manvolnum>

    </refmeta>

 

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

 

    <refnamediv id="sign">

        <refname>sign</refname>

 

        <refpurpose>

            Sign of a value.

        </refpurpose>

    </refnamediv>

 

    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>

        <funcsynopsis>

            <funcprototype>

                <funcdef>

                    gentype

                    <function>

                        sign

                    </function>

                </funcdef>

                <paramdef>gentype<parameter>x</parameter></paramdef>

            </funcprototype>

        </funcsynopsis>

 

    </refsynopsisdiv>

 

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

 

    <refsect1 id="description"><title>Description</title>

      <para>

        <informalequation><mathphrase>Returns

                1.0 if <emphasis>x</emphasis> &gt; 0, -0.0 if <emphasis>x</emphasis> = -0.0, +0.0 if <emphasis>x</emphasis> = +0.0, or -1.0 if <emphasis>x</emphasis> &lt; 0. Returns 0.0 if <emphasis>x</emphasis> is a NaN.

        </mathphrase></informalequation></para>

    </refsect1>

 

<!-- ================================ NOTES  -->

 

    <refsect1 id="notes"><title>Notes</title>

 

      &commonFunctionsInc;

 

      <para>

        If extended with <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>,

        generic type name <type>gentype</type> may indicate <type>half</type> and

        <type>half{2|3|4|8|16}</type> as arguments and return values.

      </para>

    </refsect1>

 

<!-- ================================ EXAMPLE  --> <!-- DO NOT DELETE IN CASE AN EXAMPLE IS

ADDED IN THE FUTURE --> <!--

    <refsect2 id="example1">

        <title>

            Example

        </title>

 

        <informaltable frame="none">

            <tgroup cols="1" align="left" colsep="0" rowsep="0">

                <colspec colname="col1" colnum="1" />

                <tbody>

                    <row>

                        <entry>

                            Example goes here - it will be set in "code" type with white space preserved.

                        </entry>

                    </row>

                </tbody>

            </tgroup>

        </informaltable>

    </refsect2>

-->

 

<!-- ================================ 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="commonFunctions">OpenCL Specification</olink>

        </para>

    </refsect1>

 

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

 

    <refsect1 id="seealso"><title>Also see</title>

        <para>

            <citerefentry href="commonFunctions"><refentrytitle>Common Functions</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>

 

<!-- 13-Oct-2011 -->

</refentry>