xref: /minix3/lib/libm/man/finite.3 (revision 84d9c625bfea59e274550651111ae9edfdc40fbd)
1*84d9c625SLionel Sambuc.\" Copyright (c) 1985, 1991 Regents of the University of California.
2*84d9c625SLionel Sambuc.\" All rights reserved.
3*84d9c625SLionel Sambuc.\"
4*84d9c625SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
5*84d9c625SLionel Sambuc.\" modification, are permitted provided that the following conditions
6*84d9c625SLionel Sambuc.\" are met:
7*84d9c625SLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
8*84d9c625SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
9*84d9c625SLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
10*84d9c625SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
11*84d9c625SLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
12*84d9c625SLionel Sambuc.\" 3. Neither the name of the University nor the names of its contributors
13*84d9c625SLionel Sambuc.\"    may be used to endorse or promote products derived from this software
14*84d9c625SLionel Sambuc.\"    without specific prior written permission.
15*84d9c625SLionel Sambuc.\"
16*84d9c625SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17*84d9c625SLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*84d9c625SLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*84d9c625SLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20*84d9c625SLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*84d9c625SLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*84d9c625SLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*84d9c625SLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*84d9c625SLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*84d9c625SLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*84d9c625SLionel Sambuc.\" SUCH DAMAGE.
27*84d9c625SLionel Sambuc.\"
28*84d9c625SLionel Sambuc.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
29*84d9c625SLionel Sambuc.\"	$NetBSD: finite.3,v 1.2 2011/08/06 11:09:22 wiz Exp $
30*84d9c625SLionel Sambuc.\"
31*84d9c625SLionel Sambuc.Dd July 28, 2011
32*84d9c625SLionel Sambuc.Dt FINITE 3
33*84d9c625SLionel Sambuc.Os
34*84d9c625SLionel Sambuc.Sh NAME
35*84d9c625SLionel Sambuc.Nm finite ,
36*84d9c625SLionel Sambuc.Nm finitef
37*84d9c625SLionel Sambuc.Nd tests for finite values
38*84d9c625SLionel Sambuc.Sh LIBRARY
39*84d9c625SLionel Sambuc.Lb libm
40*84d9c625SLionel Sambuc.Sh SYNOPSIS
41*84d9c625SLionel Sambuc.In math.h
42*84d9c625SLionel Sambuc.Ft int
43*84d9c625SLionel Sambuc.Fn finite "double x"
44*84d9c625SLionel Sambuc.Ft int
45*84d9c625SLionel Sambuc.Fn finitef "float x"
46*84d9c625SLionel Sambuc.Sh DESCRIPTION
47*84d9c625SLionel SambucThe
48*84d9c625SLionel Sambuc.Fn finite
49*84d9c625SLionel Sambucfunction returns the value 1 when
50*84d9c625SLionel Sambuc.Bd -ragged -offset indent
51*84d9c625SLionel Sambuc\-\*(If \*(Lt
52*84d9c625SLionel Sambuc.Fa x
53*84d9c625SLionel Sambuc\*(Lt +\*(If.
54*84d9c625SLionel Sambuc.Ed
55*84d9c625SLionel Sambuc.Pp
56*84d9c625SLionel SambucOtherwise a zero is returned
57*84d9c625SLionel Sambuc(that is,
58*84d9c625SLionel Sambuc.Pf \*(Ba Ns Fa x Ns \*(Ba
59*84d9c625SLionel Sambuc= \*(If or
60*84d9c625SLionel Sambuc.Fa x
61*84d9c625SLionel Sambucis \*(Na).
62*84d9c625SLionel Sambuc.Sh SEE ALSO
63*84d9c625SLionel Sambuc.Xr isfinite 3 ,
64*84d9c625SLionel Sambuc.Xr math 3
65*84d9c625SLionel Sambuc.Sh STANDARDS
66*84d9c625SLionel SambucThe described functions conform to
67*84d9c625SLionel Sambuc.St -ieee754 .
68*84d9c625SLionel SambucNote that unlike
69*84d9c625SLionel Sambuc.Xr isfinite 3 ,
70*84d9c625SLionel Sambucneither function is present in the
71*84d9c625SLionel Sambuc.Dv ISO
72*84d9c625SLionel SambucC-language standards or in the
73*84d9c625SLionel Sambuc.Dv IEEE
74*84d9c625SLionel Sambuc.Dv POSIX
75*84d9c625SLionel Sambucstandards.
76*84d9c625SLionel Sambuc.Sh HISTORY
77*84d9c625SLionel SambucThe
78*84d9c625SLionel Sambuc.Nm finite
79*84d9c625SLionel Sambucand
80*84d9c625SLionel Sambuc.Fn finitef
81*84d9c625SLionel Sambucfunctions first appeared in
82*84d9c625SLionel Sambuc.Bx 4.3 .
83