← Back to branch summary

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

« back to all changes in this revision

Viewing changes to fract.xml

  • Committer: Package Import Robot
  • Author(s): Mathieu Malaterre
  • Date: 2013-05-21 18:06:15 UTC
  • Revision ID: package-import@ubuntu.com-20130521180615-6e0s2n3pai95ip2f
Tags: upstream-1.0~svn21772
Import upstream version 1.0~svn21772

Show diffs side-by-side

added added

removed removed

Lines of Context:
fract.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
<!ENTITY mathFunctionsInc SYSTEM "mathFunctionsInc.xml">
 
5
]>
 
6
 
 
7
<refentry>
 
8
    <refentryinfo>
 
9
        <keywordset>
 
10
            <keyword>fract</keyword>
 
11
        </keywordset>
 
12
    </refentryinfo>
 
13
 
 
14
    <refmeta>
 
15
        <refentrytitle>fract</refentrytitle>
 
16
 
 
17
        <refmiscinfo>
 
18
            <copyright>
 
19
                <year>2007-2011</year>
 
20
                <holder>The Khronos Group Inc.
 
21
 Permission is hereby granted, free of charge, to any person obtaining a
 
22
copy of this software and/or associated documentation files (the
 
23
"Materials"), to deal in the Materials without restriction, including
 
24
without limitation the rights to use, copy, modify, merge, publish,
 
25
distribute, sublicense, and/or sell copies of the Materials, and to
 
26
permit persons to whom the Materials are furnished to do so, subject to
 
27
the condition that this copyright notice and permission notice shall be included
 
28
in all copies or substantial portions of the Materials.</holder>
 
29
            </copyright>
 
30
        </refmiscinfo>
 
31
        <manvolnum>3</manvolnum>
 
32
    </refmeta>
 
33
 
 
34
<!-- ================================ SYNOPSIS -->
 
35
 
 
36
    <refnamediv id="fract">
 
37
        <refname>fract</refname>
 
38
 
 
39
        <refpurpose>
 
40
            Fractional value in <varname>x</varname>.
 
41
        </refpurpose>
 
42
    </refnamediv>
 
43
 
 
44
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
45
        <funcsynopsis>
 
46
            <funcprototype>
 
47
                <funcdef>
 
48
                    gentype
 
49
                    <function>
 
50
                        fract
 
51
                    </function>
 
52
                </funcdef>
 
53
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
54
                <paramdef><link xlink:href="global.html">__global</link> gentype<parameter>*itpr</parameter></paramdef>
 
55
            </funcprototype>
 
56
        </funcsynopsis>
 
57
 
 
58
        <funcsynopsis>
 
59
            <funcprototype>
 
60
                <funcdef>
 
61
                    gentype
 
62
                    <function>
 
63
                        fract
 
64
                    </function>
 
65
                </funcdef>
 
66
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
67
                <paramdef><link xlink:href="local.html">__local</link> gentype<parameter>*itpr</parameter></paramdef>
 
68
            </funcprototype>
 
69
        </funcsynopsis>
 
70
 
 
71
        <funcsynopsis>
 
72
            <funcprototype>
 
73
                <funcdef>
 
74
                    gentype
 
75
                    <function>
 
76
                        fract
 
77
                    </function>
 
78
                </funcdef>
 
79
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
80
                <paramdef><link xlink:href="private.html">__private</link> gentype<parameter>*itpr</parameter></paramdef>
 
81
            </funcprototype>
 
82
        </funcsynopsis>
 
83
    </refsynopsisdiv>
 
84
 
 
85
<!-- ================================ DESCRIPTION  -->
 
86
 
 
87
    <refsect1 id="description"><title>Description</title>
 
88
        <para>
 
89
          Returns
 
90
          <citerefentry><refentrytitle>fmin</refentrytitle></citerefentry>(<varname> x</varname> -
 
91
          <citerefentry><refentrytitle>floor</refentrytitle></citerefentry>(<varname>x</varname>),
 
92
          0x1.fffffep-1f ).
 
93
          <citerefentry><refentrytitle>floor</refentrytitle></citerefentry>(<varname>x</varname>)
 
94
          is returned in <varname>iptr</varname>.
 
95
        </para>
 
96
    </refsect1>
 
97
 
 
98
<!-- ================================ NOTES  -->
 
99
 
 
100
    <refsect1 id="notes"><title>Notes</title>
 
101
        <para>
 
102
            The min() operator is there to prevent <function>fract</function>(-small ) from returning 1.0. It
 
103
            returns the largest positive floating-point number less than 1.0.
 
104
        </para>
 
105
 
 
106
        &mathFunctionsInc;
 
107
 
 
108
    </refsect1>
 
109
 
 
110
<!-- ================================ EXAMPLE  -->
 
111
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
112
<!--
 
113
    <refsect2 id="example1">
 
114
        <title>
 
115
            Example
 
116
        </title>
 
117
 
 
118
        <informaltable frame="none">
 
119
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
120
                <colspec colname="col1" colnum="1" />
 
121
                <tbody>
 
122
                    <row>
 
123
                        <entry>
 
124
                            Example goes here - it will be set in "code" type with white space preserved.
 
125
                        </entry>
 
126
                    </row>
 
127
                </tbody>
 
128
            </tgroup>
 
129
        </informaltable>
 
130
    </refsect2>
 
131
-->
 
132
 
 
133
<!-- ================================ SPECIFICATION  -->
 
134
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
135
-->
 
136
    <refsect1 id="specification"><title>Specification</title>
 
137
        <para>
 
138
            <imageobject>
 
139
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
140
            </imageobject>
 
141
 
 
142
            <olink uri="mathFunctions">OpenCL Specification</olink>
 
143
        </para>
 
144
    </refsect1>
 
145
 
 
146
<!-- ================================ ALSO SEE  -->
 
147
 
 
148
    <refsect1 id="seealso"><title>Also see</title>
 
149
        <para>
 
150
            <citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>
 
151
        </para>
 
152
    </refsect1>
 
153
 
 
154
<!-- ============================== COPYRIGHT -->
 
155
<!-- Content included from copyright.inc.xsl -->
 
156
 
 
157
    <refsect3 id="Copyright"><title></title>
 
158
        <imageobject>
 
159
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
160
        </imageobject>
 
161
        <para />
 
162
    </refsect3>
 
163
 
 
164
<!-- 17-Oct-2011 -->
 
165
</refentry>
 
166