draft/man3/log1p.3

   1 .\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com>
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Modified 2002-07-27 by Walter Harms
  26 .\"     (walter.harms@informatik.uni-oldenburg.de)
  27 .\"
  28 .\" Japanese Version Copyright (c) 2003  Akihiro MOTOKI
  29 .\"         all rights reserved.
  30 .\" Translated Wed Aug  6 00:35:20 JST 2003
  31 .\"         by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  32 .\" Updated 2008-09-16, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  33 .\"
  34 .TH LOG1P 3   2010-09-20 "" "Linux Programmer's Manual"
  35 .\"O .SH NAME
  36 .SH Ì¾Á°
  37 .\"O log1p, log1pf, log1pl \-  logarithm of 1 plus argument
  38 log1p, log1pf, log1pl \-  °ú¤¿ô¤Ë 1 ¤ò²Ã¤¨¤¿ÃÍ¤ÎÂÐ¿ô
  39 .\"O .SH SYNOPSIS
  40 .SH ½ñ¼°
  41 .nf
  42 .B #include <math.h>
  43 .sp
  44 .BI "double log1p(double " x );
  45 .br
  46 .BI "float log1pf(float " x );
  47 .br
  48 .BI "long double log1pl(long double " x );
  49 .sp
  50 .fi
  51 .\"O Link with \fI\-lm\fP.
  52 \fI\-lm\fP ¤Ç¥ê¥ó¥¯¤¹¤ë¡£
  53 .sp
  54 .in -4n
  55 .\"O Feature Test Macro Requirements for glibc (see
  56 .\"O .BR feature_test_macros (7)):
  57 glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
  58 .RB ( feature_test_macros (7)
  59 »²¾È):
  60 .in
  61 .sp
  62 .ad l
  63 .BR log1p ():
  64 .RS 4
  65 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  66 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
  67 _POSIX_C_SOURCE\ >=\ 200112L;
  68 .br
  69 or
  70 .I cc\ -std=c99
  71 .RE
  72 .br
  73 .BR log1pf (),
  74 .BR log1pl ():
  75 .RS 4
  76 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  77 _POSIX_C_SOURCE\ >=\ 200112L;
  78 .br
  79 or
  80 .I cc\ -std=c99
  81 .RE
  82 .ad b
  83 .\"O .SH DESCRIPTION
  84 .SH ÀâÌÀ
  85 .\"O .I log1p(x)
  86 .\"O returns a value equivalent to
  87 .I log1p(x)
  88 ¤Ï°Ê²¼¤ÈÅù²Á¤ÊÃÍ¤òÊÖ¤¹¡£
  89 .nf
  90
  91     log (1 + \fIx\fP)
  92
  93 .fi
  94 .\"O It is computed in a way
  95 .\"O that is accurate even if the value of \fIx\fP is near zero.
  96 \fIx\fP ¤ÎÃÍ¤¬ 0 ¤Ë¶á¤¤¾ì¹ç¤Ç¤âÀµ³Î¤Ë·×»»¤Ç¤¤ëÊýË¡¤¬ÍÑ¤¤¤é¤ì¤ë¡£
  97 .\"O .SH RETURN VALUE
  98 .SH ÊÖ¤êÃÍ
  99 .\"O On success, these functions return the natural logarithm of
 100 .\"O .IR "(1\ +\ x)" .
 101 À®¸ù¤¹¤ë¤È¡¢¤³¤ì¤é¤Î´Ø¿ô¤Ï
 102 .I "(1\ +\ x)"
 103 ¤Î¼«Á³ÂÐ¿ô¤òÊÖ¤¹¡£
 104
 105 .\"O If
 106 .\"O .I x
 107 .\"O is a NaN,
 108 .\"O a NaN is returned.
 109 .I x
 110 ¤¬ NaN ¤Î¾ì¹ç¡¢NaN ¤¬ÊÖ¤µ¤ì¤ë¡£
 111
 112 .\"O If
 113 .\"O .I x
 114 .\"O is positive infinity, positive infinity is returned.
 115 .I x
 116 ¤¬Àµ¤ÎÌµ¸ÂÂç¤Î¾ì¹ç¡¢Àµ¤ÎÌµ¸ÂÂç¤¬ÊÖ¤µ¤ì¤ë¡£
 117
 118 .\"O If
 119 .\"O .I x
 120 .\"O is \-1, a pole error occurs,
 121 .\"O and the functions return
 122 .\"O .RB - HUGE_VAL ,
 123 .\"O .RB - HUGE_VALF ,
 124 .\"O or
 125 .\"O .RB - HUGE_VALL ,
 126 .\"O respectively.
 127 .I x
 128 ¤¬ \-1 ¤Î¾ì¹ç¡¢¶Ë¥¨¥é¡¼ (pole error) ¤¬È¯À¸¤·¡¢
 129 ³Æ´Ø¿ô¤Ï¤½¤ì¤¾¤ì
 130 .RB - HUGE_VAL ,
 131 .RB - HUGE_VALF ,
 132 .RB - HUGE_VALL
 133 ¤òÊÖ¤¹¡£
 134
 135 .\"O If
 136 .\"O .I x
 137 .\"O is less than \-1 (including negative infinity),
 138 .\"O a domain error occurs,
 139 .\"O and a NaN (not a number) is returned.
 140 .I x
 141 ¤¬ \-1 ¤è¤ê¾®¤µ¤¤¾ì¹ç (Éé¤ÎÌµ¸ÂÂç¤â´Þ¤à)¡¢
 142 ÎÎ°è¥¨¥é¡¼ (domain error) ¤¬È¯À¸¤·¡¢
 143 NaN (not a number) ¤¬ÊÖ¤µ¤ì¤ë¡£
 144 .\" POSIX.1 specifies a possible range error if x is subnormal
 145 .\" glibc 2.8 doesn't do this
 146 .\"O .SH ERRORS
 147 .SH ¥¨¥é¡¼
 148 .\"O See
 149 .\"O .BR math_error (7)
 150 .\"O for information on how to determine whether an error has occurred
 151 .\"O when calling these functions.
 152 ¤³¤ì¤é¤Î´Ø¿ô¤ò¸Æ¤Ó½Ð¤·¤¿ºÝ¤Ë¥¨¥é¡¼¤¬È¯À¸¤·¤¿¤«¤ÎÈ½ÄêÊýË¡¤Ë¤Ä¤¤¤Æ¤Î¾ðÊó¤Ï
 153 .BR math_error (7)
 154 ¤ò»²¾È¤Î¤³¤È¡£
 155 .PP
 156 .\"O The following errors can occur:
 157 °Ê²¼¤Î¥¨¥é¡¼¤¬È¯À¸¤¹¤ë²ÄÇ½À¤¬¤¢¤ë¡£
 158 .TP
 159 .\"O Domain error: \fIx\fP is less than \-1
 160 ÎÎ°è¥¨¥é¡¼ (domain error): \fIx\fP ¤¬ \-1 ¤è¤ê¾®¤µ¤¤
 161 .\" .I errno
 162 .\" is set to
 163 .\" .BR EDOM .
 164 .\"O An invalid floating-point exception
 165 .\"O .RB ( FE_INVALID )
 166 .\"O is raised.
 167 ÉÔÀµ (invalid) ÉâÆ°¾®¿ôÅÀÎã³°
 168 .RB ( FE_INVALID )
 169 ¤¬¾å¤¬¤ë¡£
 170 .TP
 171 .\"O Pole error: \fIx\fP is \-1
 172 ¶Ë¥¨¥é¡¼ (pole error): \fIx\fP ¤¬ \-1 ¤Ç¤¢¤ë
 173 .\" .I errno
 174 .\" is set to
 175 .\" .BR ERANGE .
 176 .\"O A divide-by-zero floating-point exception
 177 .\"O .RB ( FE_DIVBYZERO )
 178 .\"O is raised.
 179 0 ¤Ë¤è¤ë½ü»» (divide-by-zero) ÉâÆ°¾®¿ôÅÀÎã³°
 180 .RB ( FE_DIVBYZERO )
 181 ¤¬¾å¤¬¤ë¡£
 182 .PP
 183 .\"O These functions do not set
 184 .\"O .IR errno .
 185 ¤³¤ì¤é¤Î´Ø¿ô¤Ï
 186 .I errno
 187 ¤òÀßÄê¤·¤Ê¤¤¡£
 188 .\" FIXME . Is it intentional that these functions do not set errno?
 189 .\" log(), log2(), log10() do set errno
 190 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6792
 191 .\"O .SH "CONFORMING TO"
 192 .SH ½àµò
 193 C99, POSIX.1-2001.
 194 .\" BSD
 195 .\"O .SH "SEE ALSO"
 196 .SH ´ØÏ¢¹àÌÜ
 197 .BR exp (3),
 198 .BR expm1 (3),
 199 .BR log (3)