xref: /freebsd/share/man/man3/Q_FRAWMASK.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1*5a38af1fSEdward Tomasz Napierala.\"
2*5a38af1fSEdward Tomasz Napierala.\" Copyright (c) 2018 Netflix, Inc.
3*5a38af1fSEdward Tomasz Napierala.\" All rights reserved.
4*5a38af1fSEdward Tomasz Napierala.\"
5*5a38af1fSEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without
6*5a38af1fSEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions
7*5a38af1fSEdward Tomasz Napierala.\" are met:
8*5a38af1fSEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright
9*5a38af1fSEdward Tomasz Napierala.\"    notice, this list of conditions, and the following disclaimer,
10*5a38af1fSEdward Tomasz Napierala.\"    without modification, immediately at the beginning of the file.
11*5a38af1fSEdward Tomasz Napierala.\" 2. The name of the author may not be used to endorse or promote products
12*5a38af1fSEdward Tomasz Napierala.\"    derived from this software without specific prior written permission.
13*5a38af1fSEdward Tomasz Napierala.\"
14*5a38af1fSEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*5a38af1fSEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*5a38af1fSEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*5a38af1fSEdward Tomasz Napierala.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18*5a38af1fSEdward Tomasz Napierala.\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*5a38af1fSEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*5a38af1fSEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*5a38af1fSEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*5a38af1fSEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*5a38af1fSEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*5a38af1fSEdward Tomasz Napierala.\" SUCH DAMAGE.
25*5a38af1fSEdward Tomasz Napierala.\"
26*5a38af1fSEdward Tomasz Napierala.Dd July 8, 2018
27*5a38af1fSEdward Tomasz Napierala.Dt Q_FRAWMASK 3
28*5a38af1fSEdward Tomasz Napierala.Os
29*5a38af1fSEdward Tomasz Napierala.Sh NAME
30*5a38af1fSEdward Tomasz Napierala.Nm Q_FRAWMASK ,
31*5a38af1fSEdward Tomasz Napierala.Nm Q_GFRAW ,
32*5a38af1fSEdward Tomasz Napierala.Nm Q_GFABSVAL ,
33*5a38af1fSEdward Tomasz Napierala.Nm Q_GFVAL ,
34*5a38af1fSEdward Tomasz Napierala.Nm Q_SFVAL
35*5a38af1fSEdward Tomasz Napierala.Nd fixed-point math functions which manipulate the fractional data bits
36*5a38af1fSEdward Tomasz Napierala.Sh SYNOPSIS
37*5a38af1fSEdward Tomasz Napierala.In sys/qmath.h
38*5a38af1fSEdward Tomasz Napierala.Ft ITYPE
39*5a38af1fSEdward Tomasz Napierala.Fn Q_FRAWMASK "QTYPE q"
40*5a38af1fSEdward Tomasz Napierala.Ft ITYPE
41*5a38af1fSEdward Tomasz Napierala.Fn Q_GFRAW "QTYPE q"
42*5a38af1fSEdward Tomasz Napierala.Ft ITYPE
43*5a38af1fSEdward Tomasz Napierala.Fn Q_GFABSVAL "QTYPE q"
44*5a38af1fSEdward Tomasz Napierala.Ft ITYPE
45*5a38af1fSEdward Tomasz Napierala.Fn Q_GFVAL "QTYPE q"
46*5a38af1fSEdward Tomasz Napierala.Ft QTYPE
47*5a38af1fSEdward Tomasz Napierala.Fn Q_SFVAL "QTYPE q" "ITYPE fv"
48*5a38af1fSEdward Tomasz Napierala.Sh DESCRIPTION
49*5a38af1fSEdward Tomasz Napierala.Fn Q_FRAWMASK
50*5a38af1fSEdward Tomasz Napieralareturns a
51*5a38af1fSEdward Tomasz Napierala.Fa q Ns -specific
52*5a38af1fSEdward Tomasz Napieralabit mask for
53*5a38af1fSEdward Tomasz Napierala.Fa q Ap s
54*5a38af1fSEdward Tomasz Napieralafractional data bits.
55*5a38af1fSEdward Tomasz Napierala.Pp
56*5a38af1fSEdward Tomasz Napierala.Fn Q_GFRAW
57*5a38af1fSEdward Tomasz Napieralareturns
58*5a38af1fSEdward Tomasz Napierala.Fa q Ap s
59*5a38af1fSEdward Tomasz Napieralaraw masked fractional data bits.
60*5a38af1fSEdward Tomasz Napierala.Pp
61*5a38af1fSEdward Tomasz Napierala.Fn Q_GFABSVAL
62*5a38af1fSEdward Tomasz Napieralaand
63*5a38af1fSEdward Tomasz Napierala.Fn Q_GFVAL
64*5a38af1fSEdward Tomasz Napieralareturn the absolute and real values of
65*5a38af1fSEdward Tomasz Napierala.Fa q Ap s
66*5a38af1fSEdward Tomasz Napieralafractional data bits respectively.
67*5a38af1fSEdward Tomasz Napierala.Pp
68*5a38af1fSEdward Tomasz Napierala.Fn Q_SFVAL
69*5a38af1fSEdward Tomasz Napieralasets
70*5a38af1fSEdward Tomasz Napierala.Fa q Ap s
71*5a38af1fSEdward Tomasz Napieralafractional data bits to the value
72*5a38af1fSEdward Tomasz Napierala.Fa fv .
73*5a38af1fSEdward Tomasz Napierala.Pp
74*5a38af1fSEdward Tomasz NapieralaAll of those functions operate on
75*5a38af1fSEdward Tomasz Napieralathe following data types:
76*5a38af1fSEdward Tomasz Napierala.Vt s8q_t ,
77*5a38af1fSEdward Tomasz Napierala.Vt u8q_t ,
78*5a38af1fSEdward Tomasz Napierala.Vt s16q_t ,
79*5a38af1fSEdward Tomasz Napierala.Vt u16q_t ,
80*5a38af1fSEdward Tomasz Napierala.Vt s32q_t ,
81*5a38af1fSEdward Tomasz Napierala.Vt u32q_t ,
82*5a38af1fSEdward Tomasz Napierala.Vt s64q_t ,
83*5a38af1fSEdward Tomasz Napieralaand
84*5a38af1fSEdward Tomasz Napierala.Vt u64q_t ,
85*5a38af1fSEdward Tomasz Napieralawhich are referred to generically as
86*5a38af1fSEdward Tomasz Napierala.Fa QTYPE .
87*5a38af1fSEdward Tomasz NapieralaThe
88*5a38af1fSEdward Tomasz Napierala.Fa ITYPE
89*5a38af1fSEdward Tomasz Napieralarefers to the
90*5a38af1fSEdward Tomasz Napierala.Xr stdint 7
91*5a38af1fSEdward Tomasz Napieralainteger types.
92*5a38af1fSEdward Tomasz Napierala.Pp
93*5a38af1fSEdward Tomasz NapieralaFor more details, see
94*5a38af1fSEdward Tomasz Napierala.Xr qmath 3 .
95*5a38af1fSEdward Tomasz Napierala.Sh RETURN VALUES
96*5a38af1fSEdward Tomasz Napierala.Fn Q_FRAWMASK ,
97*5a38af1fSEdward Tomasz Napierala.Fn Q_GFRAW ,
98*5a38af1fSEdward Tomasz Napierala.Fn Q_GFABSVAL
99*5a38af1fSEdward Tomasz Napieralaand
100*5a38af1fSEdward Tomasz Napierala.Fn Q_GFVAL
101*5a38af1fSEdward Tomasz Napieralareturn their respective values as integers of the same underlying ITYPE as
102*5a38af1fSEdward Tomasz Napierala.Fa q .
103*5a38af1fSEdward Tomasz Napierala.Pp
104*5a38af1fSEdward Tomasz Napierala.Fn Q_SFVAL
105*5a38af1fSEdward Tomasz Napieralareturns the value of
106*5a38af1fSEdward Tomasz Napierala.Fa q
107*5a38af1fSEdward Tomasz Napieralapost set.
108*5a38af1fSEdward Tomasz Napierala.Sh SEE ALSO
109*5a38af1fSEdward Tomasz Napierala.Xr errno 2 ,
110*5a38af1fSEdward Tomasz Napierala.Xr qmath 3 ,
111*5a38af1fSEdward Tomasz Napierala.Xr stdint 7
112*5a38af1fSEdward Tomasz Napierala.Sh HISTORY
113*5a38af1fSEdward Tomasz NapieralaThe
114*5a38af1fSEdward Tomasz Napierala.Xr qmath 3
115*5a38af1fSEdward Tomasz Napieralafunctions first appeared in
116*5a38af1fSEdward Tomasz Napierala.Fx 13.0 .
117*5a38af1fSEdward Tomasz Napierala.Sh AUTHORS
118*5a38af1fSEdward Tomasz Napierala.An -nosplit
119*5a38af1fSEdward Tomasz NapieralaThe
120*5a38af1fSEdward Tomasz Napierala.Xr qmath 3
121*5a38af1fSEdward Tomasz Napieralafunctions and this manual page were written by
122*5a38af1fSEdward Tomasz Napierala.An Lawrence Stewart Aq Mt lstewart@FreeBSD.org
123*5a38af1fSEdward Tomasz Napieralaand sponsored by Netflix, Inc.
124