include/gsl/gsl_sf_log.h

0001 /* specfunc/gsl_sf_log.h
0002  *
0003  * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2004 Gerard Jungman
0004  *
0005  * This program is free software; you can redistribute it and/or modify
0006  * it under the terms of the GNU General Public License as published by
0007  * the Free Software Foundation; either version 3 of the License, or (at
0008  * your option) any later version.
0009  *
0010  * This program is distributed in the hope that it will be useful, but
0011  * WITHOUT ANY WARRANTY; without even the implied warranty of
0012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0013  * General Public License for more details.
0014  *
0015  * You should have received a copy of the GNU General Public License
0016  * along with this program; if not, write to the Free Software
0017  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
0018  */
0019
0020 /* Author:  G. Jungman */
0021
0022 #ifndef __GSL_SF_LOG_H__
0023 #define __GSL_SF_LOG_H__
0024
0025 #include <gsl/gsl_sf_result.h>
0026
0027 #undef __BEGIN_DECLS
0028 #undef __END_DECLS
0029 #ifdef __cplusplus
0030 # define __BEGIN_DECLS extern "C" {
0031 # define __END_DECLS }
0032 #else
0033 # define __BEGIN_DECLS /* empty */
0034 # define __END_DECLS /* empty */
0035 #endif
0036
0037 __BEGIN_DECLS
0038
0039
0040 /* Provide a logarithm function with GSL semantics.
0041  *
0042  * exceptions: GSL_EDOM
0043  */
0044 int gsl_sf_log_e(const double x, gsl_sf_result * result);
0045 double gsl_sf_log(const double x);
0046
0047
0048 /* Log(|x|)
0049  *
0050  * exceptions: GSL_EDOM
0051  */
0052 int gsl_sf_log_abs_e(const double x, gsl_sf_result * result);
0053 double gsl_sf_log_abs(const double x);
0054
0055
0056 /* Complex Logarithm
0057  *   exp(lnr + I theta) = zr + I zi
0058  * Returns argument in [-pi,pi].
0059  *
0060  * exceptions: GSL_EDOM
0061  */
0062 int gsl_sf_complex_log_e(const double zr, const double zi, gsl_sf_result * lnr, gsl_sf_result * theta);
0063
0064
0065 /* Log(1 + x)
0066  *
0067  * exceptions: GSL_EDOM
0068  */
0069 int gsl_sf_log_1plusx_e(const double x, gsl_sf_result * result);
0070 double gsl_sf_log_1plusx(const double x);
0071
0072
0073 /* Log(1 + x) - x
0074  *
0075  * exceptions: GSL_EDOM
0076  */
0077 int gsl_sf_log_1plusx_mx_e(const double x, gsl_sf_result * result);
0078 double gsl_sf_log_1plusx_mx(const double x);
0079
0080 __END_DECLS
0081
0082 #endif /* __GSL_SF_LOG_H__ */