Move from github, collapse gltk and strictmath, add candle
[clnl] / src / main / strictmath / kcos.lisp
1 (in-package #:strictmath)
2 ; This file is taken from part of Evita Common Lisp.
3 ;
4 ; Copyright (C) 1996-2007 by Project Vogue.
5 ; Written by Yoshifumi "VOGUE" INOUE. (yosi@msn.com)
6 ;
7 ; Before that, it was based off of fdlibm
8 ;
9 ;  See fdlibm (http://www.netlib.org/fdlibm/)
10 ;  See http://sources.redhat.com/newlib/
11
12 ; /* @(#)k_cos.c 5.1 93/09/24 */
13 ; /*
14 ;  * ====================================================
15 ;  * Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
16 ;  *
17 ;  * Developed at SunPro, a Sun Microsystems, Inc. business.
18 ;  * Permission to use, copy, modify, and distribute this
19 ;  * software is freely granted, provided that this notice
20 ;  * is preserved.
21 ;  * ====================================================
22 ;  */
23
24 ; /*
25 ;  * __kernel_cos( x,  y )
26 ;  * kernel cos function on [-pi/4, pi/4], pi/4 ~ 0.785398164
27 ;  * Input x is assumed to be bounded by ~pi/4 in magnitude.
28 ;  * Input y is the tail of x.
29 ;  *
30 ;  * Algorithm
31 ;  *      1. Since cos(-x) = cos(x), we need only to consider positive x.
32 ;  *      2. if x < 2^-27 (hx<#x3e400000 0), return 1 with inexact if x!=0.
33 ;  *      3. cos(x) is approximated by a polynomial of degree 14 on
34 ;  *         [0,pi/4]
35 ;  *                                         4            14
36 ;  *                 cos(x) ~ 1 - x*x/2 + C1*x + ... + C6*x
37 ;  *         where the remez error is
38 ;  *
39 ;  *      |              2     4     6     8     10    12     14 |     -58
40 ;  *      |cos(x)-(1-.5*x +C1*x +C2*x +C3*x +C4*x +C5*x  +C6*x  )| <= 2
41 ;  *      |                                                           |
42 ;  *
43 ;  *                     4     6     8     10    12     14
44 ;  *      4. let r = C1*x +C2*x +C3*x +C4*x +C5*x  +C6*x  , then
45 ;  *             cos(x) = 1 - x*x/2 + r
46 ;  *         since cos(x+y) ~ cos(x) - sin(x)*y
47 ;  *                        ~ cos(x) - x*y,
48 ;  *         a correction term is necessary in cos(x) and hence
49 ;  *              cos(x+y) = 1 - (x*x/2 - (r - x*y))
50 ;  *         For better accuracy when x > 0.3, let qx = |x|/4 with
51 ;  *         the last 32 bits mask off, and if x > 0.78125, let qx = 0.28125.
52 ;  *         Then
53 ;  *              cos(x+y) = (1-qx) - ((x*x/2-qx) - (r-x*y)).
54 ;  *         Note that 1-qx and (x*x/2-qx) is EXACT here, and the
55 ;  *         magnitude of the latter is at least a quarter of x*x/2,
56 ;  *         thus, reducing the rounding error in the subtraction.
57 ;  */
58
59 (defun float64-kernel-cos (x y)
60  (declare (values double-float))
61  (declare (type double-float x y))
62  (prog*
63   ((one #+nil 1.00000000000000000000e+00 #.(encode-float64 #x3FF00000 #x00000000))
64    (C1 #+nil 4.16666666666666019037e-02 #.(encode-float64 #x3FA55555 #x5555554C))
65    (C2 #+nil -1.38888888888741095749e-03 #.(encode-float64 #xBF56C16C #x16C15177))
66    (C3 #+nil 2.48015872894767294178e-05 #.(encode-float64 #x3EFA01A0 #x19CB1590))
67    (C4 #+nil -2.75573143513906633035e-07 #.(encode-float64 #xBE927E4F #x809C52AD))
68    (C5 #+nil 2.08757232129817482790e-09 #.(encode-float64 #x3E21EE9E #xBDB4B1C4))
69    (C6 #+nil -1.13596475577881948265e-11 #.(encode-float64 #xBDA8FAE9 #xBE8838D4))
70    ;;
71    (hx (decode-float64 x))
72    (ix (logand hx #x7fffffff)))
73    ;; if x < 2**27
74   (when (< ix #x3e400000)
75    ;; generate inexact
76    (when (eql (truncate x) 0) (return one)))
77
78   (let* ((z (* x x))
79          (r (* z (+ c1 (* z (+ c2 (* z (+ c3 (* z (+ c4 (* z (+ c5 (* z c6)))))))))))))
80    ;; if |x| < 0.3 */
81    (when (< ix #x3FD33333) (return (- one (- (* 0.5d0 z) (- (* z r) (* x y))))))
82
83    (let* ((qx
84            (if (> ix #x3fe90000) ; x > 0.78125
85             0.28125d0
86             (encode-float64 (- ix #x00200000) 0))) ; x/4
87           (hz (- (* 0.5d0 z) qx))
88           (a (- one qx)))
89     (return (- a (- hz (- (* z r) (* x y)))))))))