HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
| 4 | <refentry id="step">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>2011</year>\r | |
| 9 | <holder>Khronos Group</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>step</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>step</refname>\r | |
| 17 | <refpurpose>generate a step function by comparing two values</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>genType <function>step</function></funcdef>\r | |
| 23 | <paramdef>genType <parameter>edge</parameter></paramdef>\r | |
| 24 | <paramdef>genType <parameter>x</parameter></paramdef>\r | |
| 25 | </funcprototype>\r | |
| 26 | </funcsynopsis>\r | |
| 27 | <funcsynopsis>\r | |
| 28 | <funcprototype>\r | |
| 29 | <funcdef>genType <function>step</function></funcdef>\r | |
| 30 | <paramdef>float <parameter>edge</parameter></paramdef>\r | |
| 31 | <paramdef>genType <parameter>x</parameter></paramdef>\r | |
| 32 | </funcprototype>\r | |
| 33 | </funcsynopsis>\r | |
| 34 | <funcsynopsis>\r | |
| 35 | <funcprototype>\r | |
| 36 | <funcdef>genDType <function>step</function></funcdef>\r | |
| 37 | <paramdef>genDType <parameter>edge</parameter></paramdef>\r | |
| 38 | <paramdef>genDType <parameter>x</parameter></paramdef>\r | |
| 39 | </funcprototype>\r | |
| 40 | </funcsynopsis>\r | |
| 41 | <funcsynopsis>\r | |
| 42 | <funcprototype>\r | |
| 43 | <funcdef>genDType <function>step</function></funcdef>\r | |
| 44 | <paramdef>double <parameter>edge</parameter></paramdef>\r | |
| 45 | <paramdef>genDType <parameter>x</parameter></paramdef>\r | |
| 46 | </funcprototype>\r | |
| 47 | </funcsynopsis>\r | |
| 48 | </refsynopsisdiv>\r | |
| 49 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 50 | <variablelist>\r | |
| 51 | <varlistentry>\r | |
| 52 | <term><parameter>edge</parameter></term>\r | |
| 53 | <listitem>\r | |
| 54 | <para>\r | |
| 55 | Specifies the location of the edge of the step function.\r | |
| 56 | </para>\r | |
| 57 | </listitem>\r | |
| 58 | </varlistentry>\r | |
| 59 | <varlistentry>\r | |
| 60 | <term><parameter>x</parameter></term>\r | |
| 61 | <listitem>\r | |
| 62 | <para>\r | |
| 63 | Specify the value to be used to generate the step function.\r | |
| 64 | </para>\r | |
| 65 | </listitem>\r | |
| 66 | </varlistentry>\r | |
| 67 | </variablelist>\r | |
| 68 | </refsect1>\r | |
| 69 | <refsect1 id="description"><title>Description</title>\r | |
| 70 | <para>\r | |
| 71 | <function>step</function> generates a step function by comparing <parameter>x</parameter> to <parameter>edge</parameter>.\r | |
| 72 | </para>\r | |
| 73 | <para>\r | |
| 74 | For element <emphasis>i</emphasis> of the return value, 0.0 is returned if <parameter>x</parameter>[<emphasis>i</emphasis>]\r | |
| 75 | < <parameter>edge</parameter>[<emphasis>i</emphasis>], and 1.0 is returned otherwise.\r | |
| 76 | </para>\r | |
| 77 | </refsect1>\r | |
| 78 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 79 | <informaltable frame="topbot">\r | |
| 80 | #VARTABLECOLS#\r | |
| 81 | <thead>\r | |
| 82 | #FUNCTABLEHEADER#\r | |
| 83 | <row>\r | |
| 84 | <entry>step (genType)</entry>#newin11#\r | |
| 85 | </row>\r | |
| 86 | <row>\r | |
| 87 | <entry>step (genDType)</entry>#newin40#\r | |
| 88 | </row>\r | |
| 89 | </thead>\r | |
| 90 | </tgroup>\r | |
| 91 | </informaltable>\r | |
| 92 | </refsect1>\r | |
| 93 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 94 | <para>\r | |
| 95 | <citerefentry><refentrytitle>mix</refentrytitle></citerefentry>,\r | |
| 96 | <citerefentry><refentrytitle>smoothstep</refentrytitle></citerefentry>\r | |
| 97 | </para>\r | |
| 98 | </refsect1>\r | |
| 99 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 100 | <para>\r | |
| 101 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 102 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 103 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 104 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 105 | </para>\r | |
| 106 | </refsect1>\r | |
| 107 | </refentry>\r |