Mercurial > hg > xemacs-beta
view src/floatfns.c @ 665:fdefd0186b75
[xemacs-hg @ 2001-09-20 06:28:42 by ben]
The great integral types renaming.
The purpose of this is to rationalize the names used for various
integral types, so that they match their intended uses and follow
consist conventions, and eliminate types that were not semantically
different from each other.
The conventions are:
-- All integral types that measure quantities of anything are
signed. Some people disagree vociferously with this, but their
arguments are mostly theoretical, and are vastly outweighed by
the practical headaches of mixing signed and unsigned values,
and more importantly by the far increased likelihood of
inadvertent bugs: Because of the broken "viral" nature of
unsigned quantities in C (operations involving mixed
signed/unsigned are done unsigned, when exactly the opposite is
nearly always wanted), even a single error in declaring a
quantity unsigned that should be signed, or even the even more
subtle error of comparing signed and unsigned values and
forgetting the necessary cast, can be catastrophic, as
comparisons will yield wrong results. -Wsign-compare is turned
on specifically to catch this, but this tends to result in a
great number of warnings when mixing signed and unsigned, and
the casts are annoying. More has been written on this
elsewhere.
-- All such quantity types just mentioned boil down to EMACS_INT,
which is 32 bits on 32-bit machines and 64 bits on 64-bit
machines. This is guaranteed to be the same size as Lisp
objects of type `int', and (as far as I can tell) of size_t
(unsigned!) and ssize_t. The only type below that is not an
EMACS_INT is Hashcode, which is an unsigned value of the same
size as EMACS_INT.
-- Type names should be relatively short (no more than 10
characters or so), with the first letter capitalized and no
underscores if they can at all be avoided.
-- "count" == a zero-based measurement of some quantity. Includes
sizes, offsets, and indexes.
-- "bpos" == a one-based measurement of a position in a buffer.
"Charbpos" and "Bytebpos" count text in the buffer, rather than
bytes in memory; thus Bytebpos does not directly correspond to
the memory representation. Use "Membpos" for this.
-- "Char" refers to internal-format characters, not to the C type
"char", which is really a byte.
-- For the actual name changes, see the script below.
I ran the following script to do the conversion. (NOTE: This script
is idempotent. You can safely run it multiple times and it will
not screw up previous results -- in fact, it will do nothing if
nothing has changed. Thus, it can be run repeatedly as necessary
to handle patches coming in from old workspaces, or old branches.)
There are two tags, just before and just after the change:
`pre-integral-type-rename' and `post-integral-type-rename'. When
merging code from the main trunk into a branch, the best thing to
do is first merge up to `pre-integral-type-rename', then apply the
script and associated changes, then merge from
`post-integral-type-change' to the present. (Alternatively, just do
the merging in one operation; but you may then have a lot of
conflicts needing to be resolved by hand.)
Script `fixtypes.sh' follows:
----------------------------------- cut ------------------------------------
files="*.[ch] s/*.h m/*.h config.h.in ../configure.in Makefile.in.in ../lib-src/*.[ch] ../lwlib/*.[ch]"
gr Memory_Count Bytecount $files
gr Lstream_Data_Count Bytecount $files
gr Element_Count Elemcount $files
gr Hash_Code Hashcode $files
gr extcount bytecount $files
gr bufpos charbpos $files
gr bytind bytebpos $files
gr memind membpos $files
gr bufbyte intbyte $files
gr Extcount Bytecount $files
gr Bufpos Charbpos $files
gr Bytind Bytebpos $files
gr Memind Membpos $files
gr Bufbyte Intbyte $files
gr EXTCOUNT BYTECOUNT $files
gr BUFPOS CHARBPOS $files
gr BYTIND BYTEBPOS $files
gr MEMIND MEMBPOS $files
gr BUFBYTE INTBYTE $files
gr MEMORY_COUNT BYTECOUNT $files
gr LSTREAM_DATA_COUNT BYTECOUNT $files
gr ELEMENT_COUNT ELEMCOUNT $files
gr HASH_CODE HASHCODE $files
----------------------------------- cut ------------------------------------
`fixtypes.sh' is a Bourne-shell script; it uses 'gr':
----------------------------------- cut ------------------------------------
#!/bin/sh
# Usage is like this:
# gr FROM TO FILES ...
# globally replace FROM with TO in FILES. FROM and TO are regular expressions.
# backup files are stored in the `backup' directory.
from="$1"
to="$2"
shift 2
echo ${1+"$@"} | xargs global-replace "s/$from/$to/g"
----------------------------------- cut ------------------------------------
`gr' in turn uses a Perl script to do its real work,
`global-replace', which follows:
----------------------------------- cut ------------------------------------
: #-*- Perl -*-
### global-modify --- modify the contents of a file by a Perl expression
## Copyright (C) 1999 Martin Buchholz.
## Copyright (C) 2001 Ben Wing.
## Authors: Martin Buchholz <martin@xemacs.org>, Ben Wing <ben@xemacs.org>
## Maintainer: Ben Wing <ben@xemacs.org>
## Current Version: 1.0, May 5, 2001
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with XEmacs; see the file COPYING. If not, write to the Free
# Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
eval 'exec perl -w -S $0 ${1+"$@"}'
if 0;
use strict;
use FileHandle;
use Carp;
use Getopt::Long;
use File::Basename;
(my $myName = $0) =~ s@.*/@@; my $usage="
Usage: $myName [--help] [--backup-dir=DIR] [--line-mode] [--hunk-mode]
PERLEXPR FILE ...
Globally modify a file, either line by line or in one big hunk.
Typical usage is like this:
[with GNU print, GNU xargs: guaranteed to handle spaces, quotes, etc.
in file names]
find . -name '*.[ch]' -print0 | xargs -0 $0 's/\bCONST\b/const/g'\n
[with non-GNU print, xargs]
find . -name '*.[ch]' -print | xargs $0 's/\bCONST\b/const/g'\n
The file is read in, either line by line (with --line-mode specified)
or in one big hunk (with --hunk-mode specified; it's the default), and
the Perl expression is then evalled with \$_ set to the line or hunk of
text, including the terminating newline if there is one. It should
destructively modify the value there, storing the changed result in \$_.
Files in which any modifications are made are backed up to the directory
specified using --backup-dir, or to `backup' by default. To disable this,
use --backup-dir= with no argument.
Hunk mode is the default because it is MUCH MUCH faster than line-by-line.
Use line-by-line only when it matters, e.g. you want to do a replacement
only once per line (the default without the `g' argument). Conversely,
when using hunk mode, *ALWAYS* use `g'; otherwise, you will only make one
replacement in the entire file!
";
my %options = ();
$Getopt::Long::ignorecase = 0;
&GetOptions (
\%options,
'help', 'backup-dir=s', 'line-mode', 'hunk-mode',
);
die $usage if $options{"help"} or @ARGV <= 1;
my $code = shift;
die $usage if grep (-d || ! -w, @ARGV);
sub SafeOpen {
open ((my $fh = new FileHandle), $_[0]);
confess "Can't open $_[0]: $!" if ! defined $fh;
return $fh;
}
sub SafeClose {
close $_[0] or confess "Can't close $_[0]: $!";
}
sub FileContents {
my $fh = SafeOpen ("< $_[0]");
my $olddollarslash = $/;
local $/ = undef;
my $contents = <$fh>;
$/ = $olddollarslash;
return $contents;
}
sub WriteStringToFile {
my $fh = SafeOpen ("> $_[0]");
binmode $fh;
print $fh $_[1] or confess "$_[0]: $!\n";
SafeClose $fh;
}
foreach my $file (@ARGV) {
my $changed_p = 0;
my $new_contents = "";
if ($options{"line-mode"}) {
my $fh = SafeOpen $file;
while (<$fh>) {
my $save_line = $_;
eval $code;
$changed_p = 1 if $save_line ne $_;
$new_contents .= $_;
}
} else {
my $orig_contents = $_ = FileContents $file;
eval $code;
if ($_ ne $orig_contents) {
$changed_p = 1;
$new_contents = $_;
}
}
if ($changed_p) {
my $backdir = $options{"backup-dir"};
$backdir = "backup" if !defined ($backdir);
if ($backdir) {
my ($name, $path, $suffix) = fileparse ($file, "");
my $backfulldir = $path . $backdir;
my $backfile = "$backfulldir/$name";
mkdir $backfulldir, 0755 unless -d $backfulldir;
print "modifying $file (original saved in $backfile)\n";
rename $file, $backfile;
}
WriteStringToFile ($file, $new_contents);
}
}
----------------------------------- cut ------------------------------------
In addition to those programs, I needed to fix up a few other
things, particularly relating to the duplicate definitions of
types, now that some types merged with others. Specifically:
1. in lisp.h, removed duplicate declarations of Bytecount. The
changed code should now look like this: (In each code snippet
below, the first and last lines are the same as the original, as
are all lines outside of those lines. That allows you to locate
the section to be replaced, and replace the stuff in that
section, verifying that there isn't anything new added that
would need to be kept.)
--------------------------------- snip -------------------------------------
/* Counts of bytes or chars */
typedef EMACS_INT Bytecount;
typedef EMACS_INT Charcount;
/* Counts of elements */
typedef EMACS_INT Elemcount;
/* Hash codes */
typedef unsigned long Hashcode;
/* ------------------------ dynamic arrays ------------------- */
--------------------------------- snip -------------------------------------
2. in lstream.h, removed duplicate declaration of Bytecount.
Rewrote the comment about this type. The changed code should
now look like this:
--------------------------------- snip -------------------------------------
#endif
/* The have been some arguments over the what the type should be that
specifies a count of bytes in a data block to be written out or read in,
using Lstream_read(), Lstream_write(), and related functions.
Originally it was long, which worked fine; Martin "corrected" these to
size_t and ssize_t on the grounds that this is theoretically cleaner and
is in keeping with the C standards. Unfortunately, this practice is
horribly error-prone due to design flaws in the way that mixed
signed/unsigned arithmetic happens. In fact, by doing this change,
Martin introduced a subtle but fatal error that caused the operation of
sending large mail messages to the SMTP server under Windows to fail.
By putting all values back to be signed, avoiding any signed/unsigned
mixing, the bug immediately went away. The type then in use was
Lstream_Data_Count, so that it be reverted cleanly if a vote came to
that. Now it is Bytecount.
Some earlier comments about why the type must be signed: This MUST BE
SIGNED, since it also is used in functions that return the number of
bytes actually read to or written from in an operation, and these
functions can return -1 to signal error.
Note that the standard Unix read() and write() functions define the
count going in as a size_t, which is UNSIGNED, and the count going
out as an ssize_t, which is SIGNED. This is a horrible design
flaw. Not only is it highly likely to lead to logic errors when a
-1 gets interpreted as a large positive number, but operations are
bound to fail in all sorts of horrible ways when a number in the
upper-half of the size_t range is passed in -- this number is
unrepresentable as an ssize_t, so code that checks to see how many
bytes are actually written (which is mandatory if you are dealing
with certain types of devices) will get completely screwed up.
--ben
*/
typedef enum lstream_buffering
--------------------------------- snip -------------------------------------
3. in dumper.c, there are four places, all inside of switch()
statements, where XD_BYTECOUNT appears twice as a case tag. In
each case, the two case blocks contain identical code, and you
should *REMOVE THE SECOND* and leave the first.
author | ben |
---|---|
date | Thu, 20 Sep 2001 06:31:11 +0000 |
parents | b39c14581166 |
children | 943eaba38521 |
line wrap: on
line source
/* Primitive operations on floating point for XEmacs Lisp interpreter. Copyright (C) 1988, 1993, 1994 Free Software Foundation, Inc. This file is part of XEmacs. XEmacs is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. XEmacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with XEmacs; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* Synched up with: FSF 19.30. */ /* ANSI C requires only these float functions: acos, asin, atan, atan2, ceil, cos, cosh, exp, fabs, floor, fmod, frexp, ldexp, log, log10, modf, pow, sin, sinh, sqrt, tan, tanh. Define HAVE_INVERSE_HYPERBOLIC if you have acosh, asinh, and atanh. Define HAVE_CBRT if you have cbrt(). Define HAVE_RINT if you have rint(). If you don't define these, then the appropriate routines will be simulated. Define HAVE_MATHERR if on a system supporting the SysV matherr() callback. (This should happen automatically.) Define FLOAT_CHECK_ERRNO if the float library routines set errno. This has no effect if HAVE_MATHERR is defined. Define FLOAT_CATCH_SIGILL if the float library routines signal SIGILL. (What systems actually do this? Let me know. -jwz) Define FLOAT_CHECK_DOMAIN if the float library doesn't handle errors by either setting errno, or signalling SIGFPE/SIGILL. Otherwise, domain and range checking will happen before calling the float routines. This has no effect if HAVE_MATHERR is defined (since matherr will be called when a domain error occurs). */ #include <config.h> #include "lisp.h" #include "syssignal.h" #ifdef LISP_FLOAT_TYPE /* Need to define a differentiating symbol -- see sysfloat.h */ #define THIS_FILENAME floatfns #include "sysfloat.h" /* The code uses emacs_rint, so that it works to undefine HAVE_RINT if `rint' exists but does not work right. */ #ifdef HAVE_RINT #define emacs_rint rint #else static double emacs_rint (double x) { double r = floor (x + 0.5); double diff = fabs (r - x); /* Round to even and correct for any roundoff errors. */ if (diff >= 0.5 && (diff > 0.5 || r != 2.0 * floor (r / 2.0))) r += r < x ? 1.0 : -1.0; return r; } #endif /* Nonzero while executing in floating point. This tells float_error what to do. */ static int in_float; /* If an argument is out of range for a mathematical function, here is the actual argument value to use in the error message. */ static Lisp_Object float_error_arg, float_error_arg2; static const char *float_error_fn_name; /* Evaluate the floating point expression D, recording NUM as the original argument for error messages. D is normally an assignment expression. Handle errors which may result in signals or may set errno. Note that float_error may be declared to return void, so you can't just cast the zero after the colon to (SIGTYPE) to make the types check properly. */ #ifdef FLOAT_CHECK_ERRNO #define IN_FLOAT(d, name, num) \ do { \ float_error_arg = num; \ float_error_fn_name = name; \ in_float = 1; errno = 0; (d); in_float = 0; \ if (errno != 0) in_float_error (); \ } while (0) #define IN_FLOAT2(d, name, num, num2) \ do { \ float_error_arg = num; \ float_error_arg2 = num2; \ float_error_fn_name = name; \ in_float = 2; errno = 0; (d); in_float = 0; \ if (errno != 0) in_float_error (); \ } while (0) #else #define IN_FLOAT(d, name, num) (in_float = 1, (d), in_float = 0) #define IN_FLOAT2(d, name, num, num2) (in_float = 2, (d), in_float = 0) #endif #define arith_error(op,arg) \ Fsignal (Qarith_error, list2 (build_string (op), arg)) #define range_error(op,arg) \ Fsignal (Qrange_error, list2 (build_string (op), arg)) #define range_error2(op,a1,a2) \ Fsignal (Qrange_error, list3 (build_string (op), a1, a2)) #define domain_error(op,arg) \ Fsignal (Qdomain_error, list2 (build_string (op), arg)) #define domain_error2(op,a1,a2) \ Fsignal (Qdomain_error, list3 (build_string (op), a1, a2)) /* Convert float to Lisp Integer if it fits, else signal a range error using the given arguments. */ static Lisp_Object float_to_int (double x, const char *name, Lisp_Object num, Lisp_Object num2) { if (x >= ((EMACS_INT) 1 << (VALBITS-1)) || x <= - ((EMACS_INT) 1 << (VALBITS-1)) - (EMACS_INT) 1) { if (!UNBOUNDP (num2)) range_error2 (name, num, num2); else range_error (name, num); } return (make_int ((EMACS_INT) x)); } static void in_float_error (void) { switch (errno) { case 0: break; case EDOM: if (in_float == 2) domain_error2 (float_error_fn_name, float_error_arg, float_error_arg2); else domain_error (float_error_fn_name, float_error_arg); break; case ERANGE: range_error (float_error_fn_name, float_error_arg); break; default: arith_error (float_error_fn_name, float_error_arg); break; } } static Lisp_Object mark_float (Lisp_Object obj) { return Qnil; } static int float_equal (Lisp_Object obj1, Lisp_Object obj2, int depth) { return (extract_float (obj1) == extract_float (obj2)); } static Hashcode float_hash (Lisp_Object obj, int depth) { /* mod the value down to 32-bit range */ /* #### change for 64-bit machines */ return (unsigned long) fmod (extract_float (obj), 4e9); } static const struct lrecord_description float_description[] = { { XD_END } }; DEFINE_BASIC_LRECORD_IMPLEMENTATION ("float", float, mark_float, print_float, 0, float_equal, float_hash, float_description, Lisp_Float); /* Extract a Lisp number as a `double', or signal an error. */ double extract_float (Lisp_Object num) { if (FLOATP (num)) return XFLOAT_DATA (num); if (INTP (num)) return (double) XINT (num); return extract_float (wrong_type_argument (Qnumberp, num)); } #endif /* LISP_FLOAT_TYPE */ /* Trig functions. */ #ifdef LISP_FLOAT_TYPE DEFUN ("acos", Facos, 1, 1, 0, /* Return the inverse cosine of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d > 1.0 || d < -1.0) domain_error ("acos", number); #endif IN_FLOAT (d = acos (d), "acos", number); return make_float (d); } DEFUN ("asin", Fasin, 1, 1, 0, /* Return the inverse sine of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d > 1.0 || d < -1.0) domain_error ("asin", number); #endif IN_FLOAT (d = asin (d), "asin", number); return make_float (d); } DEFUN ("atan", Fatan, 1, 2, 0, /* Return the inverse tangent of NUMBER. If optional second argument NUMBER2 is provided, return atan2 (NUMBER, NUMBER2). */ (number, number2)) { double d = extract_float (number); if (NILP (number2)) IN_FLOAT (d = atan (d), "atan", number); else { double d2 = extract_float (number2); #ifdef FLOAT_CHECK_DOMAIN if (d == 0.0 && d2 == 0.0) domain_error2 ("atan", number, number2); #endif IN_FLOAT2 (d = atan2 (d, d2), "atan", number, number2); } return make_float (d); } DEFUN ("cos", Fcos, 1, 1, 0, /* Return the cosine of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = cos (d), "cos", number); return make_float (d); } DEFUN ("sin", Fsin, 1, 1, 0, /* Return the sine of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = sin (d), "sin", number); return make_float (d); } DEFUN ("tan", Ftan, 1, 1, 0, /* Return the tangent of NUMBER. */ (number)) { double d = extract_float (number); double c = cos (d); #ifdef FLOAT_CHECK_DOMAIN if (c == 0.0) domain_error ("tan", number); #endif IN_FLOAT (d = (sin (d) / c), "tan", number); return make_float (d); } #endif /* LISP_FLOAT_TYPE (trig functions) */ /* Bessel functions */ #if 0 /* Leave these out unless we find there's a reason for them. */ /* #ifdef LISP_FLOAT_TYPE */ DEFUN ("bessel-j0", Fbessel_j0, 1, 1, 0, /* Return the bessel function j0 of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = j0 (d), "bessel-j0", number); return make_float (d); } DEFUN ("bessel-j1", Fbessel_j1, 1, 1, 0, /* Return the bessel function j1 of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = j1 (d), "bessel-j1", number); return make_float (d); } DEFUN ("bessel-jn", Fbessel_jn, 2, 2, 0, /* Return the order N bessel function output jn of NUMBER. The first number (the order) is truncated to an integer. */ (number1, number2)) { int i1 = extract_float (number1); double f2 = extract_float (number2); IN_FLOAT (f2 = jn (i1, f2), "bessel-jn", number1); return make_float (f2); } DEFUN ("bessel-y0", Fbessel_y0, 1, 1, 0, /* Return the bessel function y0 of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = y0 (d), "bessel-y0", number); return make_float (d); } DEFUN ("bessel-y1", Fbessel_y1, 1, 1, 0, /* Return the bessel function y1 of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = y1 (d), "bessel-y0", number); return make_float (d); } DEFUN ("bessel-yn", Fbessel_yn, 2, 2, 0, /* Return the order N bessel function output yn of NUMBER. The first number (the order) is truncated to an integer. */ (number1, number2)) { int i1 = extract_float (number1); double f2 = extract_float (number2); IN_FLOAT (f2 = yn (i1, f2), "bessel-yn", number1); return make_float (f2); } #endif /* 0 (bessel functions) */ /* Error functions. */ #if 0 /* Leave these out unless we see they are worth having. */ /* #ifdef LISP_FLOAT_TYPE */ DEFUN ("erf", Ferf, 1, 1, 0, /* Return the mathematical error function of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = erf (d), "erf", number); return make_float (d); } DEFUN ("erfc", Ferfc, 1, 1, 0, /* Return the complementary error function of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = erfc (d), "erfc", number); return make_float (d); } DEFUN ("log-gamma", Flog_gamma, 1, 1, 0, /* Return the log gamma of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = lgamma (d), "log-gamma", number); return make_float (d); } #endif /* 0 (error functions) */ /* Root and Log functions. */ #ifdef LISP_FLOAT_TYPE DEFUN ("exp", Fexp, 1, 1, 0, /* Return the exponential base e of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d > 709.7827) /* Assume IEEE doubles here */ range_error ("exp", number); else if (d < -709.0) return make_float (0.0); else #endif IN_FLOAT (d = exp (d), "exp", number); return make_float (d); } #endif /* LISP_FLOAT_TYPE */ DEFUN ("expt", Fexpt, 2, 2, 0, /* Return the exponential NUMBER1 ** NUMBER2. */ (number1, number2)) { if (INTP (number1) && /* common lisp spec */ INTP (number2)) /* don't promote, if both are ints */ { EMACS_INT retval; EMACS_INT x = XINT (number1); EMACS_INT y = XINT (number2); if (y < 0) { if (x == 1) retval = 1; else if (x == -1) retval = (y & 1) ? -1 : 1; else retval = 0; } else { retval = 1; while (y > 0) { if (y & 1) retval *= x; x *= x; y = (EMACS_UINT) y >> 1; } } return make_int (retval); } #ifdef LISP_FLOAT_TYPE { double f1 = extract_float (number1); double f2 = extract_float (number2); /* Really should check for overflow, too */ if (f1 == 0.0 && f2 == 0.0) f1 = 1.0; # ifdef FLOAT_CHECK_DOMAIN else if ((f1 == 0.0 && f2 < 0.0) || (f1 < 0 && f2 != floor(f2))) domain_error2 ("expt", number1, number2); # endif /* FLOAT_CHECK_DOMAIN */ IN_FLOAT2 (f1 = pow (f1, f2), "expt", number1, number2); return make_float (f1); } #else CHECK_INT_OR_FLOAT (number1); CHECK_INT_OR_FLOAT (number2); return Fexpt (number1, number2); #endif /* LISP_FLOAT_TYPE */ } #ifdef LISP_FLOAT_TYPE DEFUN ("log", Flog, 1, 2, 0, /* Return the natural logarithm of NUMBER. If second optional argument BASE is given, return the logarithm of NUMBER using that base. */ (number, base)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d <= 0.0) domain_error2 ("log", number, base); #endif if (NILP (base)) IN_FLOAT (d = log (d), "log", number); else { double b = extract_float (base); #ifdef FLOAT_CHECK_DOMAIN if (b <= 0.0 || b == 1.0) domain_error2 ("log", number, base); #endif if (b == 10.0) IN_FLOAT2 (d = log10 (d), "log", number, base); else IN_FLOAT2 (d = (log (d) / log (b)), "log", number, base); } return make_float (d); } DEFUN ("log10", Flog10, 1, 1, 0, /* Return the logarithm base 10 of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d <= 0.0) domain_error ("log10", number); #endif IN_FLOAT (d = log10 (d), "log10", number); return make_float (d); } DEFUN ("sqrt", Fsqrt, 1, 1, 0, /* Return the square root of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d < 0.0) domain_error ("sqrt", number); #endif IN_FLOAT (d = sqrt (d), "sqrt", number); return make_float (d); } DEFUN ("cube-root", Fcube_root, 1, 1, 0, /* Return the cube root of NUMBER. */ (number)) { double d = extract_float (number); #ifdef HAVE_CBRT IN_FLOAT (d = cbrt (d), "cube-root", number); #else if (d >= 0.0) IN_FLOAT (d = pow (d, 1.0/3.0), "cube-root", number); else IN_FLOAT (d = -pow (-d, 1.0/3.0), "cube-root", number); #endif return make_float (d); } #endif /* LISP_FLOAT_TYPE */ /* Inverse trig functions. */ #ifdef LISP_FLOAT_TYPE /* #if 0 Not clearly worth adding... */ DEFUN ("acosh", Facosh, 1, 1, 0, /* Return the inverse hyperbolic cosine of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d < 1.0) domain_error ("acosh", number); #endif #ifdef HAVE_INVERSE_HYPERBOLIC IN_FLOAT (d = acosh (d), "acosh", number); #else IN_FLOAT (d = log (d + sqrt (d*d - 1.0)), "acosh", number); #endif return make_float (d); } DEFUN ("asinh", Fasinh, 1, 1, 0, /* Return the inverse hyperbolic sine of NUMBER. */ (number)) { double d = extract_float (number); #ifdef HAVE_INVERSE_HYPERBOLIC IN_FLOAT (d = asinh (d), "asinh", number); #else IN_FLOAT (d = log (d + sqrt (d*d + 1.0)), "asinh", number); #endif return make_float (d); } DEFUN ("atanh", Fatanh, 1, 1, 0, /* Return the inverse hyperbolic tangent of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d >= 1.0 || d <= -1.0) domain_error ("atanh", number); #endif #ifdef HAVE_INVERSE_HYPERBOLIC IN_FLOAT (d = atanh (d), "atanh", number); #else IN_FLOAT (d = 0.5 * log ((1.0 + d) / (1.0 - d)), "atanh", number); #endif return make_float (d); } DEFUN ("cosh", Fcosh, 1, 1, 0, /* Return the hyperbolic cosine of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d > 710.0 || d < -710.0) range_error ("cosh", number); #endif IN_FLOAT (d = cosh (d), "cosh", number); return make_float (d); } DEFUN ("sinh", Fsinh, 1, 1, 0, /* Return the hyperbolic sine of NUMBER. */ (number)) { double d = extract_float (number); #ifdef FLOAT_CHECK_DOMAIN if (d > 710.0 || d < -710.0) range_error ("sinh", number); #endif IN_FLOAT (d = sinh (d), "sinh", number); return make_float (d); } DEFUN ("tanh", Ftanh, 1, 1, 0, /* Return the hyperbolic tangent of NUMBER. */ (number)) { double d = extract_float (number); IN_FLOAT (d = tanh (d), "tanh", number); return make_float (d); } #endif /* LISP_FLOAT_TYPE (inverse trig functions) */ /* Rounding functions */ DEFUN ("abs", Fabs, 1, 1, 0, /* Return the absolute value of NUMBER. */ (number)) { #ifdef LISP_FLOAT_TYPE if (FLOATP (number)) { IN_FLOAT (number = make_float (fabs (XFLOAT_DATA (number))), "abs", number); return number; } #endif /* LISP_FLOAT_TYPE */ if (INTP (number)) return (XINT (number) >= 0) ? number : make_int (- XINT (number)); return Fabs (wrong_type_argument (Qnumberp, number)); } #ifdef LISP_FLOAT_TYPE DEFUN ("float", Ffloat, 1, 1, 0, /* Return the floating point number numerically equal to NUMBER. */ (number)) { if (INTP (number)) return make_float ((double) XINT (number)); if (FLOATP (number)) /* give 'em the same float back */ return number; return Ffloat (wrong_type_argument (Qnumberp, number)); } #endif /* LISP_FLOAT_TYPE */ #ifdef LISP_FLOAT_TYPE DEFUN ("logb", Flogb, 1, 1, 0, /* Return largest integer <= the base 2 log of the magnitude of NUMBER. This is the same as the exponent of a float. */ (number)) { double f = extract_float (number); if (f == 0.0) return make_int (- (EMACS_INT)(((EMACS_UINT) 1) << (VALBITS - 1))); /* most-negative-fixnum */ #ifdef HAVE_LOGB { Lisp_Object val; IN_FLOAT (val = make_int ((EMACS_INT) logb (f)), "logb", number); return val; } #else #ifdef HAVE_FREXP { int exqp; IN_FLOAT (frexp (f, &exqp), "logb", number); return make_int (exqp - 1); } #else { int i; double d; EMACS_INT val; if (f < 0.0) f = -f; val = -1; while (f < 0.5) { for (i = 1, d = 0.5; d * d >= f; i += i) d *= d; f /= d; val -= i; } while (f >= 1.0) { for (i = 1, d = 2.0; d * d <= f; i += i) d *= d; f /= d; val += i; } return make_int (val); } #endif /* ! HAVE_FREXP */ #endif /* ! HAVE_LOGB */ } #endif /* LISP_FLOAT_TYPE */ DEFUN ("ceiling", Fceiling, 1, 1, 0, /* Return the smallest integer no less than NUMBER. (Round toward +inf.) */ (number)) { #ifdef LISP_FLOAT_TYPE if (FLOATP (number)) { double d; IN_FLOAT ((d = ceil (XFLOAT_DATA (number))), "ceiling", number); return (float_to_int (d, "ceiling", number, Qunbound)); } #endif /* LISP_FLOAT_TYPE */ if (INTP (number)) return number; return Fceiling (wrong_type_argument (Qnumberp, number)); } DEFUN ("floor", Ffloor, 1, 2, 0, /* Return the largest integer no greater than NUMBER. (Round towards -inf.) With optional second argument DIVISOR, return the largest integer no greater than NUMBER/DIVISOR. */ (number, divisor)) { CHECK_INT_OR_FLOAT (number); if (! NILP (divisor)) { EMACS_INT i1, i2; CHECK_INT_OR_FLOAT (divisor); #ifdef LISP_FLOAT_TYPE if (FLOATP (number) || FLOATP (divisor)) { double f1 = extract_float (number); double f2 = extract_float (divisor); if (f2 == 0) Fsignal (Qarith_error, Qnil); IN_FLOAT2 (f1 = floor (f1 / f2), "floor", number, divisor); return float_to_int (f1, "floor", number, divisor); } #endif /* LISP_FLOAT_TYPE */ i1 = XINT (number); i2 = XINT (divisor); if (i2 == 0) Fsignal (Qarith_error, Qnil); /* With C's /, the result is implementation-defined if either operand is negative, so use only nonnegative operands. */ i1 = (i2 < 0 ? (i1 <= 0 ? -i1 / -i2 : -1 - ((i1 - 1) / -i2)) : (i1 < 0 ? -1 - ((-1 - i1) / i2) : i1 / i2)); return (make_int (i1)); } #ifdef LISP_FLOAT_TYPE if (FLOATP (number)) { double d; IN_FLOAT ((d = floor (XFLOAT_DATA (number))), "floor", number); return (float_to_int (d, "floor", number, Qunbound)); } #endif /* LISP_FLOAT_TYPE */ return number; } DEFUN ("round", Fround, 1, 1, 0, /* Return the nearest integer to NUMBER. */ (number)) { #ifdef LISP_FLOAT_TYPE if (FLOATP (number)) { double d; /* Screw the prevailing rounding mode. */ IN_FLOAT ((d = emacs_rint (XFLOAT_DATA (number))), "round", number); return (float_to_int (d, "round", number, Qunbound)); } #endif /* LISP_FLOAT_TYPE */ if (INTP (number)) return number; return Fround (wrong_type_argument (Qnumberp, number)); } DEFUN ("truncate", Ftruncate, 1, 1, 0, /* Truncate a floating point number to an integer. Rounds the value toward zero. */ (number)) { #ifdef LISP_FLOAT_TYPE if (FLOATP (number)) return float_to_int (XFLOAT_DATA (number), "truncate", number, Qunbound); #endif /* LISP_FLOAT_TYPE */ if (INTP (number)) return number; return Ftruncate (wrong_type_argument (Qnumberp, number)); } /* Float-rounding functions. */ #ifdef LISP_FLOAT_TYPE /* #if 1 It's not clear these are worth adding... */ DEFUN ("fceiling", Ffceiling, 1, 1, 0, /* Return the smallest integer no less than NUMBER, as a float. \(Round toward +inf.\) */ (number)) { double d = extract_float (number); IN_FLOAT (d = ceil (d), "fceiling", number); return make_float (d); } DEFUN ("ffloor", Fffloor, 1, 1, 0, /* Return the largest integer no greater than NUMBER, as a float. \(Round towards -inf.\) */ (number)) { double d = extract_float (number); IN_FLOAT (d = floor (d), "ffloor", number); return make_float (d); } DEFUN ("fround", Ffround, 1, 1, 0, /* Return the nearest integer to NUMBER, as a float. */ (number)) { double d = extract_float (number); IN_FLOAT (d = emacs_rint (d), "fround", number); return make_float (d); } DEFUN ("ftruncate", Fftruncate, 1, 1, 0, /* Truncate a floating point number to an integral float value. Rounds the value toward zero. */ (number)) { double d = extract_float (number); if (d >= 0.0) IN_FLOAT (d = floor (d), "ftruncate", number); else IN_FLOAT (d = ceil (d), "ftruncate", number); return make_float (d); } #endif /* LISP_FLOAT_TYPE (float-rounding functions) */ #ifdef LISP_FLOAT_TYPE #ifdef FLOAT_CATCH_SIGILL static SIGTYPE float_error (int signo) { if (! in_float) fatal_error_signal (signo); EMACS_REESTABLISH_SIGNAL (signo, arith_error); EMACS_UNBLOCK_SIGNAL (signo); in_float = 0; /* Was Fsignal(), but it just doesn't make sense for an error occurring inside a signal handler to be restartable, considering that anything could happen when the error is signaled and trapped and considering the asynchronous nature of signal handlers. */ signal_error (Qarith_error, 0, float_error_arg); } /* Another idea was to replace the library function `infnan' where SIGILL is signaled. */ #endif /* FLOAT_CATCH_SIGILL */ /* In C++, it is impossible to determine what type matherr expects without some more configure magic. We shouldn't be using matherr anyways - it's a non-standard SYSVism. */ #if defined (HAVE_MATHERR) && !defined(__cplusplus) int matherr (struct exception *x) { Lisp_Object args; if (! in_float) /* Not called from emacs-lisp float routines; do the default thing. */ return 0; /* if (!strcmp (x->name, "pow")) x->name = "expt"; */ args = Fcons (build_string (x->name), Fcons (make_float (x->arg1), ((in_float == 2) ? Fcons (make_float (x->arg2), Qnil) : Qnil))); switch (x->type) { case DOMAIN: Fsignal (Qdomain_error, args); break; case SING: Fsignal (Qsingularity_error, args); break; case OVERFLOW: Fsignal (Qoverflow_error, args); break; case UNDERFLOW: Fsignal (Qunderflow_error, args); break; default: Fsignal (Qarith_error, args); break; } return 1; /* don't set errno or print a message */ } #endif /* HAVE_MATHERR */ #endif /* LISP_FLOAT_TYPE */ void init_floatfns_very_early (void) { #ifdef LISP_FLOAT_TYPE # ifdef FLOAT_CATCH_SIGILL EMACS_SIGNAL (SIGILL, float_error); # endif in_float = 0; #endif /* LISP_FLOAT_TYPE */ } void syms_of_floatfns (void) { INIT_LRECORD_IMPLEMENTATION (float); /* Trig functions. */ #ifdef LISP_FLOAT_TYPE DEFSUBR (Facos); DEFSUBR (Fasin); DEFSUBR (Fatan); DEFSUBR (Fcos); DEFSUBR (Fsin); DEFSUBR (Ftan); #endif /* LISP_FLOAT_TYPE */ /* Bessel functions */ #if 0 DEFSUBR (Fbessel_y0); DEFSUBR (Fbessel_y1); DEFSUBR (Fbessel_yn); DEFSUBR (Fbessel_j0); DEFSUBR (Fbessel_j1); DEFSUBR (Fbessel_jn); #endif /* 0 */ /* Error functions. */ #if 0 DEFSUBR (Ferf); DEFSUBR (Ferfc); DEFSUBR (Flog_gamma); #endif /* 0 */ /* Root and Log functions. */ #ifdef LISP_FLOAT_TYPE DEFSUBR (Fexp); #endif /* LISP_FLOAT_TYPE */ DEFSUBR (Fexpt); #ifdef LISP_FLOAT_TYPE DEFSUBR (Flog); DEFSUBR (Flog10); DEFSUBR (Fsqrt); DEFSUBR (Fcube_root); #endif /* LISP_FLOAT_TYPE */ /* Inverse trig functions. */ #ifdef LISP_FLOAT_TYPE DEFSUBR (Facosh); DEFSUBR (Fasinh); DEFSUBR (Fatanh); DEFSUBR (Fcosh); DEFSUBR (Fsinh); DEFSUBR (Ftanh); #endif /* LISP_FLOAT_TYPE */ /* Rounding functions */ DEFSUBR (Fabs); #ifdef LISP_FLOAT_TYPE DEFSUBR (Ffloat); DEFSUBR (Flogb); #endif /* LISP_FLOAT_TYPE */ DEFSUBR (Fceiling); DEFSUBR (Ffloor); DEFSUBR (Fround); DEFSUBR (Ftruncate); /* Float-rounding functions. */ #ifdef LISP_FLOAT_TYPE DEFSUBR (Ffceiling); DEFSUBR (Fffloor); DEFSUBR (Ffround); DEFSUBR (Fftruncate); #endif /* LISP_FLOAT_TYPE */ } void vars_of_floatfns (void) { #ifdef LISP_FLOAT_TYPE Fprovide (intern ("lisp-float-type")); #endif }