upstream-doc/manglsl/sign.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="sign">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>sign</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>sign</refname>
  17         <refpurpose>extract the sign of the parameter</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>sign</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26         <funcsynopsis>
  27             <funcprototype>
  28                 <funcdef>genIType <function>sign</function></funcdef>
  29                 <paramdef>genIType <parameter>x</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32         <funcsynopsis>
  33             <funcprototype>
  34                 <funcdef>genDType <function>sign</function></funcdef>
  35                 <paramdef>genDType <parameter>x</parameter></paramdef>
  36             </funcprototype>
  37         </funcsynopsis>
  38     </refsynopsisdiv>
  39     <refsect1 id="parameters"><title>Parameters</title>
  40         <variablelist>
  41         <varlistentry>
  42             <term><parameter>x</parameter></term>
  43             <listitem>
  44                 <para>
  45                     Specify the value from which to extract the sign.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         </variablelist>
  50     </refsect1>
  51     <refsect1 id="description"><title>Description</title>
  52         <para>
  53             <function>sign</function> returns -1.0 if <parameter>x</parameter> is less than 0.0, 0.0 if <parameter>x</parameter>
  54             is equal to 0.0, and +1.0 if <parameter>x</parameter> is greater than 0.0.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="versions"><title>Version Support</title>
  58         <informaltable frame="topbot">
  59             #VARTABLECOLS#
  60                 <thead>
  61                     #FUNCTABLEHEADER#
  62                     <row>
  63                         <entry>sign (genType)</entry>#newin13#
  64                     </row>
  65                     <row>
  66                         <entry>sign (genIType)</entry>#newin15#
  67                     </row>
  68                     <row>
  69                         <entry>sign (genDType)</entry>#newin40#
  70                     </row>
  71                 </thead>
  72             </tgroup>
  73         </informaltable>
  74     </refsect1>
  75     <refsect1 id="seealso"><title>See Also</title>
  76         <para>
  77             <citerefentry><refentrytitle>abs</refentrytitle></citerefentry>
  78         </para>
  79     </refsect1>
  80     <refsect1 id="Copyright"><title>Copyright</title>
  81         <para>
  82             Copyright <trademark class="copyright"></trademark> 2011-2013 Khronos Group.
  83             This material may be distributed subject to the terms and conditions set forth in
  84             the Open Publication License, v 1.0, 8 June 1999.
  85             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  86         </para>
  87     </refsect1>
  88 </refentry>