usr/src/man/man3m/log1p.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH LOG1P 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 log1p, log1pf, log1pl \- compute natural logarithm
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBdouble\fR \fBlog1p\fR(\fBdouble\fR \fIx\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBlog1pf\fR(\fBfloat\fR \fIx\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBlog1pl\fR(\fBlong double\fR \fIx\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions compute log(e)(1.0 + \fIx\fR).
  73 .SH RETURN VALUES
  74 .sp
  75 .LP
  76 Upon successful completion, these functions return the natural logarithm of 1.0
  77 + \fIx\fR.
  78 .sp
  79 .LP
  80 If \fIx\fR is \(mi1, a pole error occurs and \fBlog1p()\fR, \fBlog1pf()\fR, and
  81 \fBlog1pl()\fR return \(mi\fBHUGE_VAL\fR, \(mi\fBHUGE_VALF\fR, and
  82 \(mi\fBHUGE_VALL\fR, respectively.
  83 .sp
  84 .LP
  85 For finite values of \fIx\fR that are less than \(mi1, or if \fIx\fR is
  86 \(miInf, a domain error occurs and a NaN is returned.
  87 .sp
  88 .LP
  89 If \fIx\fR is NaN, a NaN is returned.
  90 .sp
  91 .LP
  92 If \fIx\fR is \(+-0 or +Inf, \fIx\fR is returned.
  93 .sp
  94 .LP
  95 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
  96 \fBlog1p()\fR as specified by SVID3 and XPG3.
  97 .SH ERRORS
  98 .sp
  99 .LP
 100 These functions will fail if:
 101 .sp
 102 .ne 2
 103 .mk
 104 .na
 105 \fBDomain Error\fR
 106 .ad
 107 .RS 16n
 108 .rt
 109 The finite value of \fIx\fR is less than \(mi1, or \fIx\fR is -Inf.
 110 .sp
 111 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 112 non-zero, the invalid floating-point exception is raised.
 113 .sp
 114 The \fBlog1p()\fR function sets \fBerrno\fR to \fBEDOM\fR if the value of
 115 \fIx\fR is less than \(mi1.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .mk
 121 .na
 122 \fBPole Error\fR
 123 .ad
 124 .RS 16n
 125 .rt
 126 The value of \fIx\fR is \(mi1.
 127 .sp
 128 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 129 non-zero, the divide-by-zero floating-point exception is raised.
 130 .RE
 131
 132 .SH USAGE
 133 .sp
 134 .LP
 135 An application wanting to check for exceptions should call
 136 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 137 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 138 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 139 raised. An application should either examine the return value or check the
 140 floating point exception flags to detect exceptions.
 141 .sp
 142 .LP
 143 An application can also set \fBerrno\fR to 0 before calling \fBlog1p()\fR. On
 144 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBlog1pf()\fR
 145 and \fBlog1pl()\fR functions do not set \fBerrno\fR.
 146 .SH ATTRIBUTES
 147 .sp
 148 .LP
 149 See \fBattributes\fR(5) for descriptions of the following attributes:
 150 .sp
 151
 152 .sp
 153 .TS
 154 tab(    ) box;
 155 cw(2.75i) |cw(2.75i)
 156 lw(2.75i) |lw(2.75i)
 157 .
 158 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 159 _
 160 Interface Stability     Standard
 161 _
 162 MT-Level        MT-Safe
 163 .TE
 164
 165 .SH SEE ALSO
 166 .sp
 167 .LP
 168 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBlog\fR(3M),
 169 \fBmath.h\fR(3HEAD), \fBmatherr\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)