upstream-man-pages/manglsl/inversesqrt.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="inversesqrt">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>inversesqrt</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>inversesqrt</refname>
  17         <refpurpose>return the inverse of the square root of the parameter</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>inversesqrt</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26         <funcsynopsis>
  27             <funcprototype>
  28                 <funcdef>genDType <function>inversesqrt</function></funcdef>
  29                 <paramdef>genDType <parameter>x</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>x</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specify the value of which to take the inverse of the square root.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         </variablelist>
  44     </refsect1>
  45     <refsect1 id="description"><title>Description</title>
  46         <para>
  47             <function>inversesqrt</function> returns the inverse of the square root of <parameter>x</parameter>.
  48             i.e., the value <inlineequation><mml:math><mml:mfrac><mml:mn>1</mml:mn><mml:msqrt><mml:mi>x</mml:mi></mml:msqrt></mml:mfrac></mml:math></inlineequation>.
  49             Results are undefined if <inlineequation><mml:math><mml:apply><mml:leq /><mml:mi>x</mml:mi><mml:mn>0</mml:mn></mml:apply></mml:math></inlineequation>.
  50         </para>
  51     </refsect1>
  52     <refsect1 id="versions"><title>Version Support</title>
  53         <informaltable frame="topbot">
  54             #VARTABLECOLS#
  55                 <thead>
  56                     #FUNCTABLEHEADER#
  57                     <row>
  58                         <entry>inversesqrt (genType)</entry>#newin13#
  59                     </row>
  60                     <row>
  61                         <entry>inversesqrt (genDType)</entry>#newin40#
  62                     </row>
  63                 </thead>
  64             </tgroup>
  65         </informaltable>
  66     </refsect1>
  67     <refsect1 id="seealso"><title>See Also</title>
  68         <para>
  69             <citerefentry><refentrytitle>pow</refentrytitle></citerefentry>,
  70             <citerefentry><refentrytitle>sqrt</refentrytitle></citerefentry>
  71         </para>
  72     </refsect1>
  73     <refsect1 id="Copyright"><title>Copyright</title>
  74         <para>
  75             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  76             This material may be distributed subject to the terms and conditions set forth in
  77             the Open Publication License, v 1.0, 8 June 1999.
  78             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  79         </para>
  80     </refsect1>
  81 </refentry>