share/man/man3m/log10.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 LOG10 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 log10, log10f, log10l \- base 10 logarithm function
  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 \fBlog10\fR(\fBdouble\fR \fIx\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBlog10f\fR(\fBfloat\fR \fIx\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBlog10l\fR(\fBlong double\fR \fIx\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions compute the base 10 logarithm of \fIx\fR, log(10)(\fIx\fR).
  73 .SH RETURN VALUES
  74 .sp
  75 .LP
  76 Upon successful completion, \fBlog10()\fR returns the base 10 logarithm of
  77 \fIx\fR.
  78 .sp
  79 .LP
  80 If \fIx\fR is \(+-0, a pole error occurs and \fBlog10()\fR, \fBlog10f()\fR, and
  81 \fBlog10l()\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 0, or if \fIx\fR is \(miInf, a
  86 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 1, +0 is returned.
  93 .sp
  94 .LP
  95 If \fIx\fR is +Inf, \fIx\fR is returned.
  96 .sp
  97 .LP
  98 For exceptional cases, \fBmatherr\fR(3M) tabulates the values to be returned by
  99 \fBlog10()\fR as specified by SVID3 and XPG3.
 100 .SH ERRORS
 101 .sp
 102 .LP
 103 These functions will fail if:
 104 .sp
 105 .ne 2
 106 .mk
 107 .na
 108 \fBDomain Error\fR
 109 .ad
 110 .RS 16n
 111 .rt
 112 The finite value of \fIx\fR is negative, or \fIx\fR is -Inf.
 113 .sp
 114 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 115 non-zero, the invalid floating-point exception is raised.
 116 .sp
 117 The \fBlog10()\fR function sets \fBerrno\fR to \fBEDOM\fR if the value of
 118 \fIx\fR is negative.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .mk
 124 .na
 125 \fBPole Error\fR
 126 .ad
 127 .RS 16n
 128 .rt
 129 The value of \fIx\fR is 0.
 130 .sp
 131 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 132 non-zero, the divide-by-zero floating-point exception is raised.
 133 .RE
 134
 135 .SH USAGE
 136 .sp
 137 .LP
 138 An application wanting to check for exceptions should call
 139 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 140 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 141 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 142 raised. An application should either examine the return value or check the
 143 floating point exception flags to detect exceptions.
 144 .sp
 145 .LP
 146 An application can also set \fBerrno\fR to 0 before calling \fBlog10()\fR. On
 147 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBlog10f()\fR
 148 and \fBlog10l()\fR functions do not set \fBerrno\fR.
 149 .SH ATTRIBUTES
 150 .sp
 151 .LP
 152 See \fBattributes\fR(5) for descriptions of the following attributes:
 153 .sp
 154
 155 .sp
 156 .TS
 157 tab(    ) box;
 158 cw(2.75i) |cw(2.75i)
 159 lw(2.75i) |lw(2.75i)
 160 .
 161 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 162 _
 163 Interface Stability     Standard
 164 _
 165 MT-Level        MT-Safe
 166 .TE
 167
 168 .SH SEE ALSO
 169 .sp
 170 .LP
 171 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBisnan\fR(3M),
 172 \fBlog\fR(3M), \fBmath.h\fR(3HEAD), \fBmatherr\fR(3M), \fBpow\fR(3M),
 173 \fBattributes\fR(5), \fBstandards\fR(5)