xref: /netbsd-src/lib/libm/man/finite.3 (revision 23e71456eadc7254900038e2bb119bcf893f6011)
16cfcd0daSjruoho.\" Copyright (c) 1985, 1991 Regents of the University of California.
26cfcd0daSjruoho.\" All rights reserved.
36cfcd0daSjruoho.\"
46cfcd0daSjruoho.\" Redistribution and use in source and binary forms, with or without
56cfcd0daSjruoho.\" modification, are permitted provided that the following conditions
66cfcd0daSjruoho.\" are met:
76cfcd0daSjruoho.\" 1. Redistributions of source code must retain the above copyright
86cfcd0daSjruoho.\"    notice, this list of conditions and the following disclaimer.
96cfcd0daSjruoho.\" 2. Redistributions in binary form must reproduce the above copyright
106cfcd0daSjruoho.\"    notice, this list of conditions and the following disclaimer in the
116cfcd0daSjruoho.\"    documentation and/or other materials provided with the distribution.
126cfcd0daSjruoho.\" 3. Neither the name of the University nor the names of its contributors
136cfcd0daSjruoho.\"    may be used to endorse or promote products derived from this software
146cfcd0daSjruoho.\"    without specific prior written permission.
156cfcd0daSjruoho.\"
166cfcd0daSjruoho.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
176cfcd0daSjruoho.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
186cfcd0daSjruoho.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
196cfcd0daSjruoho.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
206cfcd0daSjruoho.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
216cfcd0daSjruoho.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
226cfcd0daSjruoho.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
236cfcd0daSjruoho.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
246cfcd0daSjruoho.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
256cfcd0daSjruoho.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
266cfcd0daSjruoho.\" SUCH DAMAGE.
276cfcd0daSjruoho.\"
286cfcd0daSjruoho.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
29*23e71456Swiz.\"	$NetBSD: finite.3,v 1.2 2011/08/06 11:09:22 wiz Exp $
306cfcd0daSjruoho.\"
316cfcd0daSjruoho.Dd July 28, 2011
326cfcd0daSjruoho.Dt FINITE 3
336cfcd0daSjruoho.Os
346cfcd0daSjruoho.Sh NAME
356cfcd0daSjruoho.Nm finite ,
366cfcd0daSjruoho.Nm finitef
376cfcd0daSjruoho.Nd tests for finite values
386cfcd0daSjruoho.Sh LIBRARY
396cfcd0daSjruoho.Lb libm
406cfcd0daSjruoho.Sh SYNOPSIS
416cfcd0daSjruoho.In math.h
426cfcd0daSjruoho.Ft int
436cfcd0daSjruoho.Fn finite "double x"
446cfcd0daSjruoho.Ft int
456cfcd0daSjruoho.Fn finitef "float x"
466cfcd0daSjruoho.Sh DESCRIPTION
476cfcd0daSjruohoThe
486cfcd0daSjruoho.Fn finite
496cfcd0daSjruohofunction returns the value 1 when
506cfcd0daSjruoho.Bd -ragged -offset indent
516cfcd0daSjruoho\-\*(If \*(Lt
526cfcd0daSjruoho.Fa x
536cfcd0daSjruoho\*(Lt +\*(If.
546cfcd0daSjruoho.Ed
556cfcd0daSjruoho.Pp
566cfcd0daSjruohoOtherwise a zero is returned
576cfcd0daSjruoho(that is,
586cfcd0daSjruoho.Pf \*(Ba Ns Fa x Ns \*(Ba
596cfcd0daSjruoho= \*(If or
606cfcd0daSjruoho.Fa x
616cfcd0daSjruohois \*(Na).
626cfcd0daSjruoho.Sh SEE ALSO
63*23e71456Swiz.Xr isfinite 3 ,
64*23e71456Swiz.Xr math 3
656cfcd0daSjruoho.Sh STANDARDS
666cfcd0daSjruohoThe described functions conform to
676cfcd0daSjruoho.St -ieee754 .
686cfcd0daSjruohoNote that unlike
696cfcd0daSjruoho.Xr isfinite 3 ,
706cfcd0daSjruohoneither function is present in the
716cfcd0daSjruoho.Dv ISO
726cfcd0daSjruohoC-language standards or in the
736cfcd0daSjruoho.Dv IEEE
746cfcd0daSjruoho.Dv POSIX
756cfcd0daSjruohostandards.
766cfcd0daSjruoho.Sh HISTORY
776cfcd0daSjruohoThe
786cfcd0daSjruoho.Nm finite
796cfcd0daSjruohoand
806cfcd0daSjruoho.Fn finitef
816cfcd0daSjruohofunctions first appeared in
826cfcd0daSjruoho.Bx 4.3 .
83