;;;; This file contains floating-point-specific transforms, and may be
;;;; somewhat implementation-dependent in its assumptions of what the
;;;; formats are.

;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.

(in-package "SB-C")

;;;; coercions

(deftransform float ((n f) (t single-float) *)
  '(%single-float n))

(deftransform float ((n f) (t double-float) *)
  '(%double-float n))

(deftransform float ((n) * * :node node)
  ;; ;; Run after constraint propagation or deleting the cast might lead
  ;; ;; to the second if leg to conclude N is not a real and issue a warning.
  (delay-ir1-transform node :ir1-phases)
  (delete-lvar-cast-if (specifier-type 'real) n)
  `(if (floatp n)
       (truly-the float n)
       (%single-float n)))

(deftransform float ((n) (float))
  'n)

(deftransform float ((n) ((and real (not double-float))))
  `(%single-float n))

(deftransform %single-float ((n) (single-float) * :important nil)
  'n)

(deftransform %double-float ((n) (double-float) * :important nil)
  'n)

(deftransform %single-float ((n) (ratio) * :important nil)
  '(sb-kernel::single-float-ratio n))

(deftransform %double-float ((n) (ratio) * :important nil)
  '(sb-kernel::double-float-ratio n))

(make-defs (($type double-float single-float))
  (deftransform %$type ((n) (rational) * :important nil)
    (cond ((combination-match n (/ #1=(:type (integer ($value most-negative-exactly-$type-integer)
                                                      ($value most-positive-exactly-$type-integer)))
                                   #1#)
             t)
           (splice-fun-args n '/ 2)
           `(lambda (n d)
              (/ (%$type n)
                 (%$type d))))
          (t
           (give-up-ir1-transform)))))

;;; (%double-float (%single-float x)) => (%double-float x) if it doesn't lose precision
(deftransform %double-float ((n) (single-float) * :important nil)
  (combination-match n
      (%single-float (:type (or single-float
                                (integer #.most-negative-exactly-single-float-integer
                                         #.most-positive-exactly-single-float-integer))))
    (splice-fun-args n '%single-float 1))
  (give-up-ir1-transform))

(deftransform %single-float ((n) (double-float) * :important nil)
  (combination-match n
      (%double-float (:type (or float
                                (integer #.most-negative-exactly-single-float-integer
                                         #.most-positive-exactly-single-float-integer))))
    (splice-fun-args n '%double-float 1))
  (give-up-ir1-transform))

(macrolet ((def (type from-type)
             `(deftransform ,(symbolicate "%" type) ((n) ((or ,type ,from-type)) * :important nil)
                (when (or (csubtypep (lvar-type n) (specifier-type ',type))
                          (csubtypep (lvar-type n) (specifier-type ',from-type)))
                  (give-up-ir1-transform))
                `(if (,',(symbolicate type "-P") n)
                     (truly-the ,',type n)
                     (,',(symbolicate "%" type) (truly-the ,',from-type n))))))
  (def single-float double-float)
  (def single-float sb-vm:signed-word)
  (def single-float word)
  (def double-float single-float)
  (def double-float sb-vm:signed-word)
  (def double-float word))

(macrolet ((def (type)
             `(deftransform ,(symbolicate "%" type) ((n) (integer) * :important nil :node node)
                (when (or (csubtypep (lvar-type n) (specifier-type 'word))
                          (csubtypep (lvar-type n) (specifier-type 'sb-vm:signed-word))
                          (not (types-equal-or-intersect (lvar-type n) (specifier-type 'fixnum))))
                  (give-up-ir1-transform))
                (delay-ir1-transform node :ir1-phases)
                '(if (fixnump n)
                  (,(symbolicate "%" type) (truly-the fixnum n))
                  (,(symbolicate "%" type) (truly-the (not fixnum) n))))))
  (def single-float)
  (def double-float))

(deftransform %single-float-no-double-float ((n) ((or single-float integer)) * :important nil)
  '(%single-float n))

(deftransform %single-float-no-double-float ((n) (ratio))
  '(sb-kernel::single-float-ratio n))
;;; RANDOM
(macrolet ((frob (fun type)
             `(deftransform random ((num &optional state)
                                    (,type &optional t) * :node node)
                "Use inline float operations."
                (delay-ir1-transform node :constraint)
                '(,fun num (or state *random-state*)))))
  (frob %random-single-float single-float)
  (frob %random-double-float double-float))

;;; Return an expression to generate an integer of N-BITS many random
;;; bits, using the minimal number of random chunks possible.
(defun generate-random-expr-for-power-of-2 (n-bits state)
  (declare (type (integer 1 #.sb-vm:n-word-bits) n-bits))
  (multiple-value-bind (n-chunk-bits chunk-expr)
      (cond ((<= n-bits n-random-chunk-bits)
             (values n-random-chunk-bits `(random-chunk ,state)))
            ((<= n-bits (* 2 n-random-chunk-bits))
             (values (* 2 n-random-chunk-bits) `(big-random-chunk ,state)))
            (t
             (error "Unexpectedly small N-RANDOM-CHUNK-BITS")))
    (if (< n-bits n-chunk-bits)
        `(logand ,(1- (ash 1 n-bits)) ,chunk-expr)
        chunk-expr)))

;;; This transform for compile-time constant word-sized integers
;;; generates an accept-reject loop to achieve equidistribution of the
;;; returned values. Several optimizations are done: If NUM is a power
;;; of two no loop is needed. If the random chunk size is half the word
;;; size only one chunk is used where sufficient. For values of NUM
;;; where it is possible and results in faster code, the rejection
;;; probability is reduced by accepting all values below the largest
;;; multiple of the limit that fits into one or two chunks and and doing
;;; a division to get the random value into the desired range.
(deftransform random ((num &optional state)
                      ((constant-arg (integer 1 #.(expt 2 sb-vm:n-word-bits)))
                       &optional t)
                      *
                      :policy (and (> speed compilation-speed)
                                   (> speed space)))
  "optimize to inlined RANDOM-CHUNK operations"
  (let ((num (lvar-value num)))
    (if (= num 1)
        0
        (flet ((chunk-n-bits-and-expr (n-bits)
                 (cond ((<= n-bits n-random-chunk-bits)
                        (values n-random-chunk-bits
                                '(random-chunk (or state *random-state*))))
                       ((<= n-bits (* 2 n-random-chunk-bits))
                        (values (* 2 n-random-chunk-bits)
                                '(big-random-chunk (or state *random-state*))))
                       (t
                        (error "Unexpectedly small N-RANDOM-CHUNK-BITS")))))
          (if (zerop (logand num (1- num)))
              ;; NUM is a power of 2.
              (let ((n-bits (integer-length (1- num))))
                (multiple-value-bind (n-chunk-bits chunk-expr)
                    (chunk-n-bits-and-expr n-bits)
                  (if (< n-bits n-chunk-bits)
                      `(logand ,(1- (ash 1 n-bits)) ,chunk-expr)
                      chunk-expr)))
              ;; Generate an accept-reject loop.
              (let ((n-bits (integer-length num)))
                (multiple-value-bind (n-chunk-bits chunk-expr)
                    (chunk-n-bits-and-expr n-bits)
                  (if (or (> (* num 3) (expt 2 n-chunk-bits))
                          (logbitp (- n-bits 2) num))
                      ;; Division can't help as the quotient is below 3,
                      ;; or is too costly as the rejection probability
                      ;; without it is already small (namely at most 1/4
                      ;; with the given test, which is experimentally a
                      ;; reasonable threshold and cheap to test for).
                      `(loop
                         (let ((bits ,(generate-random-expr-for-power-of-2
                                       n-bits '(or state *random-state*))))
                           (when (< bits num)
                             (return bits))))
                      (let ((d (truncate (expt 2 n-chunk-bits) num)))
                        `(loop
                           (let ((bits ,chunk-expr))
                             (when (< bits ,(* num d))
                               (return (values (truncate bits ,d)))))))))))))))


;;;; float accessors

;;; On the face of it, these transforms are ridiculous because if we're going
;;; to express (MINUSP X) as (MINUSP (foo-FLOAT-BITS X)), then why not _always_
;;; transform MINUSP of a float into an integer comparison instead of a
;;; floating-point comparison, and then express this as (if (minusp float) ...)
;;; rather than (if (minusp (bits float)) ...) ?
;;; I suspect that the difference is that FLOAT-SIGN must remain silent
;;; when given a signaling NaN.
(deftransform float-sign ((float &optional float2)
                          (single-float &optional single-float) *)
  (if (vop-existsp :translate single-float-copysign)
      (if float2
          `(single-float-copysign float float2)
          `(single-float-sign float))
      (if float2
          (let ((temp (gensym)))
            `(let ((,temp (abs float2)))
               (if (minusp (single-float-bits float)) (- ,temp) ,temp)))
          '(if (minusp (single-float-bits float)) -1f0 1f0))))

(deftransform float-sign ((float &optional float2)
                          (double-float &optional double-float) *)
  ;; If words are 64 bits, then it's actually simpler to  extract _all_ bits
  ;; instead of only the upper bits.
  (let ((bits #+64-bit '(double-float-bits float)
              #-64-bit '(double-float-high-bits float)))
    (if float2
        (let ((temp (gensym)))
          `(let ((,temp (abs float2)))
            (if (minusp ,bits) (- ,temp) ,temp)))
        `(if (minusp ,bits) -1d0 1d0))))

(deftransform float-sign-bit ((x) (single-float) *)
  `(logand (ash (single-float-bits x) -31) 1))
(deftransform float-sign-bit ((x) (double-float) *)
  #-64-bit `(logand (ash (double-float-high-bits x) -31) 1)
  #+64-bit `(ash (logand (double-float-bits x) most-positive-word) -63))

(deftransform float-sign-bit-set-p ((x) (single-float) * :node node)
  (delay-ir1-transform node :constraint)
  `(logbitp 31 (single-float-bits x)))
(deftransform float-sign-bit-set-p ((x) (double-float) * :node node)
  (delay-ir1-transform node :constraint)
  #-64-bit `(logbitp 31 (double-float-high-bits x))
  #+64-bit `(logbitp 63 (double-float-bits x)))

(defoptimizer (float-sign-bit-set-p constraint-propagate-if)
    ((x))
  (values x (specifier-type '(or (float * (0.0)) (member -0.0 -0d0)))))

;;; This doesn't deal with complex at the moment.
(deftransform signum ((x) (number))
  (let* ((ctype (lvar-type x))
         (result-type
          (dolist (x '(single-float double-float rational))
            (when (csubtypep ctype (specifier-type x))
              (return x)))))
    ;; SB-XC:COERCE doesn't like RATIONAL for some reason.
    (when (eq result-type 'rational) (setq result-type 'integer))
    (if result-type
        `(cond ((zerop x) x)
               ((plusp x) ,(sb-xc:coerce 1 result-type))
               (t ,(sb-xc:coerce -1 result-type)))
        (give-up-ir1-transform))))

;;;; DECODE-FLOAT, INTEGER-DECODE-FLOAT, and SCALE-FLOAT

(defknown decode-single-float (single-float)
  (values single-float single-float-exponent (member -1f0 1f0))
  (movable foldable flushable))

(defknown decode-double-float (double-float)
  (values double-float double-float-exponent (member -1d0 1d0))
  (movable foldable flushable))

(defknown integer-decode-single-float (single-float)
  (values single-float-significand single-float-int-exponent (member -1 1))
  (movable foldable flushable))

(defknown integer-decode-double-float (double-float)
  (values double-float-significand double-float-int-exponent (member -1 1))
  (movable foldable flushable))

(defknown scale-single-float (single-float integer) single-float
  (movable foldable flushable fixed-args unboxed-return))
(defknown scale-double-float (double-float integer) double-float
    (movable foldable flushable fixed-args unboxed-return))

(defknown sb-kernel::scale-single-float-maybe-overflow
    (single-float integer) single-float
    (movable foldable flushable fixed-args unboxed-return))
(defknown sb-kernel::scale-single-float-maybe-underflow
    (single-float integer) single-float
  (movable foldable flushable fixed-args unboxed-return))
(defknown sb-kernel::scale-double-float-maybe-overflow
    (double-float integer) double-float
    (movable foldable flushable fixed-args unboxed-return))
(defknown sb-kernel::scale-double-float-maybe-underflow
    (double-float integer) double-float
    (movable foldable flushable fixed-args unboxed-return))

(deftransform decode-float ((x) (single-float) *)
  '(decode-single-float x))

(deftransform decode-float ((x) (double-float) *)
  '(decode-double-float x))

(deftransform integer-decode-float ((x) (single-float) *)
  '(integer-decode-single-float x))

(deftransform integer-decode-float ((x) (double-float) *)
  '(integer-decode-double-float x))

(deftransform scale-float ((f ex) (single-float t) *)
  '(scale-single-float f ex))

(deftransform scale-float ((f ex) (double-float t) *)
  '(scale-double-float f ex))

;;; Given a number X, create a form suitable as a bound for an
;;; interval. Make the bound open if OPEN-P is T. NIL remains NIL.
;;; FIXME: as this is a constructor, shouldn't it be named MAKE-BOUND?
(declaim (inline set-bound))
(defun set-bound (x open-p)
  (if (and x open-p) (list x) x))

;;; optimizers for SCALE-FLOAT. If the float has bounds, new bounds
;;; are computed for the result, if possible.
(defun scale-float-derive-type-aux (f ex same-arg)
  (declare (ignore same-arg))
  (flet ((scale-bound (x n)
           ;; We need to be a bit careful here and catch any overflows
           ;; that might occur. We can ignore underflows which become
           ;; zeros.
           (set-bound
            (handler-case
                (scale-float (type-bound-number x) n)
              (floating-point-overflow ()
                nil))
            (consp x))))
    (when (and (numeric-type-p f) (numeric-type-p ex))
      (let ((f-lo (numeric-type-low f))
            (f-hi (numeric-type-high f))
            (ex-lo (numeric-type-low ex))
            (ex-hi (numeric-type-high ex))
            (new-lo nil)
            (new-hi nil))
        (when f-hi
          (if (sb-xc:< (float-sign (type-bound-number f-hi)) 0.0)
              (when ex-lo
                (setf new-hi (scale-bound f-hi ex-lo)))
              (when ex-hi
                (setf new-hi (scale-bound f-hi ex-hi)))))
        (when f-lo
          (if (sb-xc:< (float-sign (type-bound-number f-lo)) 0.0)
              (when ex-hi
                (setf new-lo (scale-bound f-lo ex-hi)))
              (when ex-lo
                (setf new-lo (scale-bound f-lo ex-lo)))))
        (make-numeric-union-type :class (numeric-type-class f)
                                 :format (numeric-type-format f)
                                 :low new-lo
                                 :high new-hi)))))
(defoptimizer (scale-single-float derive-type) ((f ex))
  (two-arg-derive-type f ex #'scale-float-derive-type-aux))
(defoptimizer (scale-double-float derive-type) ((f ex))
  (two-arg-derive-type f ex #'scale-float-derive-type-aux))

;;; DEFOPTIMIZERs for %SINGLE-FLOAT and %DOUBLE-FLOAT. This makes the
;;; FLOAT function return the correct ranges if the input has some
;;; defined range. Quite useful if we want to convert some type of
;;; bounded integer into a float.
(macrolet
    ((frob (fun type most-negative most-positive)
       (let ((aux-name (symbolicate fun "-DERIVE-TYPE-AUX")))
         `(progn
            (defun ,aux-name (num)
              ;; When converting a number to a float, the limits are
              ;; the same.
              (let* ((lo (bound-func (lambda (x)
                                       (if (and (not (and (floatp x)
                                                          (float-infinity-p x)))
                                                (sb-xc:< x ,most-negative))
                                           ,most-negative
                                           (coerce x ',type)))
                                     (numeric-type-low num)
                                     nil))
                     (hi (bound-func (lambda (x)
                                       (if (and (not (and (floatp x)
                                                          (float-infinity-p x)))
                                                (sb-xc:< ,most-positive x ))
                                           ,most-positive
                                           (coerce x ',type)))
                                     (numeric-type-high num)
                                     nil)))
                (make-numeric-type ',type lo hi)))

            (defoptimizer (,fun derive-type) ((num))
              (handler-case
                  (one-arg-derive-type num #',aux-name)
                (type-error ()
                  nil)))))))
  (frob %single-float single-float
        most-negative-single-float most-positive-single-float)
  (frob %double-float double-float
        most-negative-double-float most-positive-double-float)
  (frob %single-float-no-double-float single-float
        most-negative-single-float most-positive-single-float))

(defoptimizer (float derive-type) ((number prototype))
  (let ((type (lvar-type prototype)))
    (unless (or (csubtypep type (specifier-type 'double-float))
                (csubtypep type (specifier-type 'single-float)))
      (handler-case
          (type-union
           (one-arg-derive-type number #'%single-float-derive-type-aux)
           (one-arg-derive-type number #'%double-float-derive-type-aux))
        (type-error ()
          nil)))))

(macrolet ((def (type &rest args)
             `(deftransform * ((x y) (,type (constant-arg (member ,@args))) *
                               ;; Beware the SNaN!
                               :policy (zerop float-accuracy))
                "optimize multiplication by one"
                (let ((y (lvar-value y)))
                  (if (minusp y)
                      '(%negate x)
                      'x)))))
  (def single-float 1.0 -1.0)
  (def double-float 1.0d0 -1.0d0))

;;; Return the reciprocal of X if it can be represented exactly, NIL otherwise.
(defun maybe-exact-reciprocal (x)
  (unless (zerop x)
    (handler-case
        (multiple-value-bind (significand exponent sign)
            (integer-decode-float x)
          ;; only powers of 2 can be inverted exactly
          (unless (zerop (logand significand (1- significand)))
            (return-from maybe-exact-reciprocal nil))
          (let ((expected   (/ sign significand (expt 2 exponent)))
                (reciprocal (/ x)))
            (multiple-value-bind (significand exponent sign)
                (integer-decode-float reciprocal)
              ;; Denorms can't be inverted safely.
              (and (eql expected (* sign significand (expt 2 exponent)))
                   reciprocal))))
      (error () (return-from maybe-exact-reciprocal nil)))))

;;; Replace constant division by multiplication with exact reciprocal,
;;; if one exists.
(macrolet ((def (type)
             `(deftransform / ((x y) (,type (constant-arg ,type)) *
                               :node node)
                "convert to multiplication by reciprocal"
                (let ((n (lvar-value y)))
                  (if (policy node (zerop float-accuracy))
                      `(* x ,(/ n))
                      (let ((r (maybe-exact-reciprocal n)))
                        (if r
                            `(* x ,r)
                            (give-up-ir1-transform))))))))
  (def single-float)
  (def double-float))

;;; Optimize addition and subtraction of zero
(macrolet ((def (op type &rest args)
             `(deftransform ,op ((x y) (,type (constant-arg (member ,@args))) *
                                 ;; Beware the SNaN!
                                 :policy (zerop float-accuracy))
                'x)))
  ;; No signed zeros, thanks.
  (def + single-float 0 0.0)
  (def - single-float 0 0.0)
  (def + double-float 0 0.0 0.0d0)
  (def - double-float 0 0.0 0.0d0))

;;; On most platforms (+ x x) is faster than (* x 2)
(macrolet ((def (type &rest args)
             `(deftransform * ((x y) (,type (constant-arg (member ,@args))))
                '(+ x x))))
  (def single-float 2 2.0)
  (def double-float 2 2.0 2.0d0))

;;; Prevent ZEROP, PLUSP, and MINUSP from losing horribly. We can't in
;;; general float rational args to comparison, since Common Lisp
;;; semantics says we are supposed to compare as rationals, but we can
;;; do it for any rational that has a precise representation as a
;;; float (such as 0).
(macrolet ((frob (op &optional complex)
             `(deftransform ,op ((x y) (:or ((,(if complex
                                                   '(complex single-float)
                                                   'single-float)
                                              rational) *)
                                            ((,(if complex
                                                   '(complex double-float)
                                                   'double-float)
                                              rational) *)))
                "open-code FLOAT to RATIONAL comparison"
                (unless (constant-lvar-p y)
                  (give-up-ir1-transform
                   "The RATIONAL value isn't known at compile time."))
                (let ((val (lvar-value y)))
                  (multiple-value-bind (low high type)
                      (if (csubtypep (lvar-type x) (specifier-type 'double-float))
                          (values most-negative-double-float most-positive-double-float
                                  'double-float)
                          (values most-negative-single-float most-positive-single-float
                                  'single-float))
                    (unless (and (sb-xc:<= low val high)
                                 (eql (rational (coerce val type)) val))
                      (give-up-ir1-transform
                       "~S doesn't have a precise float representation."
                       val))))
                `(,',op x (float y ,',(if complex
                                          '(realpart x)
                                          'x))))))
  (frob <)
  (frob >)
  (frob <=)
  (frob >=)
  (frob =)
  (frob = t))


;;;; irrational transforms

(make-defs ((($type $log $sqrt)
             (double-float %log %sqrt)
             (single-float %logf %sqrtf)))
  (deftransform log ((x) ($type) * :node node)
    (let ((cast (cast-or-check-bound-type node (specifier-type 'real))))
      (if cast
          `(if (< x 0)
               (sb-vm::op-not-type1-error x '(,(type-specifier cast) . log))
               ($log x))
          (give-up-ir1-transform))))

  (deftransform log ((x y) ($type $type) * :node node)
    (let ((cast (cast-or-check-bound-type node (specifier-type 'real))))
      (if cast
          `(if (= y 0)
               (coerce 0 '$type)
               (if (or (< x 0)
                       (< y 0))
                   (sb-vm::op-not-type2-error x y '(,(type-specifier cast) . log))
                   (/ ($log x) ($log y))))
          (give-up-ir1-transform))))

  (deftransform sqrt ((x) ($type) * :node node)
    (let ((cast (cast-or-check-bound-type node (specifier-type 'real))))
      (if cast
          `(if (< x 0)
               (sb-vm::op-not-type1-error x '(,(type-specifier cast) . sqrt))
               ($sqrt x))
          (give-up-ir1-transform)))))

(deftransform sqrt ((x) (rational) * :node node)
  (let ((cast (cast-or-check-bound-type node (specifier-type 'real))))
    (if cast
        `(if (< x 0)
             (sb-vm::op-not-type1-error x '(,(type-specifier cast) . sqrt))
             (%single-float (%sqrt (%double-float x))))
        (give-up-ir1-transform))))

(deftransform sqrt ((x) ((rational 0)))
  `(%single-float (%sqrt (%double-float x))))

(macrolet ((def (name prim rtype)
             `(progn
               (deftransform ,name ((x) (single-float) ,rtype :node node)
                 (delay-ir1-transform node :ir1-phases)
                 `(,',(symbolicate prim "F") x))
               (deftransform ,name ((x) (double-float) ,rtype :node node)
                 (delay-ir1-transform node :ir1-phases)
                 `(,',prim x)))))
  (def exp %exp *)
  (def log %log float)
  (def sqrt %sqrt float)
  (def asin %asin float)
  (def acos %acos float)
  (def sin %sin *)
  (def cos %cos *)
  (def tan %tan *)
  (def atan %atan *)
  (def sinh %sinh *)
  (def cosh %cosh *)
  (def tanh %tanh *)
  (def asinh %asinh *)
  (def acosh %acosh float)
  (def atanh %atanh float))

(deftransform atan ((x y) (single-float single-float) *)
  `(%atan2f x y))

(deftransform atan ((x y) (double-float double-float) *)
  `(%atan2 x y))

(deftransform expt ((x y) (single-float single-float) single-float)
  `(%powf x y))
(deftransform expt ((x y) (double-float double-float) double-float)
  `(%pow x y))

(deftransform expt ((x y) (single-float integer) single-float)
  #+libmf
  `(%powf x (%single-float y))
  #-libmf
  `(%single-float (%pow (%double-float x) (%double-float y))))
(deftransform expt ((x y) (double-float integer) double-float)
  `(%pow x (%double-float y)))

;;; ANSI says log with base zero returns zero.
(deftransform log ((x y) (single-float single-float) single-float :node node)
  (delay-ir1-transform node :ir1-phases)
  `(if (zerop y)
       0.0f0
       (/ (%logf x) (%logf y))))
(deftransform log ((x y) (single-float double-float) double-float :node node)
  (delay-ir1-transform node :ir1-phases)
  `(if (zerop y)
       0.0d0
       (/ (%log (coerce x 'double-float)) (%log y))))
(deftransform log ((x y) (double-float single-float) double-float :node node)
  (delay-ir1-transform node :ir1-phases)
  `(if (zerop y)
       0.0d0
       (/ (%log x) (%log (coerce y 'double-float)))))
(deftransform log ((x y) (double-float double-float) double-float :node node)
  (delay-ir1-transform node :ir1-phases)
  `(if (zerop y)
       0.0d0
       (/ (%log x) (%log y))))

(defoptimizer (log rewrite-full-call) ((number &optional base) node)
  (if base
      (cond ((csubtypep (lvar-type number) (specifier-type 'double-float))
             (and (csubtypep (lvar-type base) (specifier-type 'double-float))
                  'log-double-float2))
            ((csubtypep (lvar-type number) (specifier-type 'single-float))
             (and (csubtypep (lvar-type base) (specifier-type 'single-float))
                  'log-single-float2)))
      (cond ((csubtypep (lvar-type number) (specifier-type 'double-float))
             'log-double-float)
            ((csubtypep (lvar-type number) (specifier-type 'single-float))
             'log-single-float))))

(defoptimizer (sqrt rewrite-full-call) ((number) node)
  (cond ((csubtypep (lvar-type number) (specifier-type 'double-float))
         'sqrt-double-float)
        ((csubtypep (lvar-type number) (specifier-type 'single-float))
         'sqrt-single-float)))

(defoptimizer (expt rewrite-full-call) ((base power) node)
  (cond ((csubtypep (lvar-type base) (specifier-type 'double-float))
         (and (csubtypep (lvar-type power) (specifier-type 'double-float))
              'expt-double-float))
        ((csubtypep (lvar-type base) (specifier-type 'single-float))
         (and (csubtypep (lvar-type power) (specifier-type 'single-float))
              'expt-single-float))))


;;; Handle some simple transformations.

(deftransform abs ((x) ((and (real 0)
                             (not (member -0f0 -0d0)))) * :important nil :before-vop t)
  'x)

(deftransform abs ((x) ((and (real * 0)
                             (not (member 0f0 0d0)))) * :important nil :before-vop t)
  '(%negate x))

(deftransform abs ((x) ((complex double-float)) double-float)
  '(%hypot (realpart x) (imagpart x)))

(deftransform abs ((x) ((complex single-float)) single-float)
  '(%hypotf (realpart x) (imagpart x)))

(deftransform phase ((x) ((complex double-float)) double-float)
  '(%atan2 (imagpart x) (realpart x)))

(deftransform phase ((x) ((complex single-float)) single-float)
  '(%atan2f (imagpart x) (realpart x)))

(deftransform phase ((x) ((float)) float)
  '(if (minusp (float-sign x))
       (float pi x)
       (float 0 x)))

(deftransform conjugate ((x) (real))
  'x)

(deftransform conjugate ((x) (complex) * :node node)
  (delay-ir1-transform node :ir1-phases)
  `(complex (realpart x) (- (imagpart x))))

;;; The number is of type REAL.
(defun numeric-type-real-p (type)
  (and (numeric-type-p type)
       (eq (numeric-type-complexp type) :real)))

;;;; optimizers for elementary functions
;;;;
;;;; These optimizers compute the output range of the elementary
;;;; function, based on the domain of the input.

;;; Generate a specifier for a complex type specialized to the same
;;; type as the argument.
(defun complex-float-type (arg)
  (declare (type numeric-type arg))
  (let* ((format (case (numeric-type-class arg)
                   ((integer rational) 'single-float)
                   (t (numeric-type-format arg))))
         (float-type (or format 'float)))
    (make-numeric-type 'complex float-type)))

;;; Compute a specifier like '(OR FLOAT (COMPLEX FLOAT)), except float
;;; should be the right kind of float. Allow bounds for the float
;;; part too.
(defun float-or-complex-float-type (arg &optional lo hi)
  (typecase arg
    (numeric-type
     (let ((format (case (numeric-type-class arg)
                     ((integer rational) 'single-float)
                     (t (numeric-type-format arg)))))
       (type-union (make-numeric-type format lo hi)
                   (make-numeric-type 'complex format))))
    ((or union-type numeric-union-type)
     (apply #'type-union
            (loop for type in (sb-kernel::flatten-numeric-union-types arg)
                  collect (float-or-complex-float-type type lo hi))))
    (t (specifier-type 'number))))

;;; Test whether the numeric-type ARG is within the domain specified by
;;; DOMAIN-LOW and DOMAIN-HIGH, consider negative and positive zero to
;;; be distinct.
(defun domain-subtypep (arg domain-low domain-high)
  (declare (type numeric-type arg)
           (type (or real null) domain-low domain-high))
  (let* ((arg-lo (numeric-type-low arg))
         (arg-lo-val (type-bound-number arg-lo))
         (arg-hi (numeric-type-high arg))
         (arg-hi-val (type-bound-number arg-hi)))
    ;; Check that the ARG bounds are correctly canonicalized.
    (when (and arg-lo (floatp arg-lo-val) (zerop arg-lo-val) (consp arg-lo)
               (minusp (float-sign arg-lo-val)))
      (setf arg-lo
            (typecase arg-lo-val
              (single-float 0f0)
              (double-float 0d0)
              #+long-float
              (long-float 0l0))
            arg-lo-val arg-lo))
    (when (and arg-hi (zerop arg-hi-val) (floatp arg-hi-val) (consp arg-hi)
               (plusp (float-sign arg-hi-val)))
      (setf arg-hi
            (typecase arg-lo-val
              (single-float -0f0)
              (double-float -0d0)
              #+long-float
              (long-float   -0L0))
            arg-hi-val arg-hi))
    (flet ((fp-neg-zero-p (f)           ; Is F -0.0?
             (and (floatp f) (zerop f) (float-sign-bit-set-p f)))
           (fp-pos-zero-p (f)           ; Is F +0.0?
             (and (floatp f) (zerop f) (not (float-sign-bit-set-p f)))))
      (and (or (null domain-low)
               (and arg-lo (sb-xc:>= arg-lo-val domain-low)
                    (not (and (fp-pos-zero-p domain-low)
                              (fp-neg-zero-p arg-lo)))))
           (or (null domain-high)
               (and arg-hi (sb-xc:<= arg-hi-val domain-high)
                    (not (and (fp-neg-zero-p domain-high)
                              (fp-pos-zero-p arg-hi)))))))))


;;; Handle monotonic functions of a single variable whose domain is
;;; possibly part of the real line. ARG is the variable, FUN is the
;;; function, and DOMAIN is a specifier that gives the (real) domain
;;; of the function. If ARG is a subset of the DOMAIN, we compute the
;;; bounds directly. Otherwise, we compute the bounds for the
;;; intersection between ARG and DOMAIN, and then append a complex
;;; result, which occurs for the parts of ARG not in the DOMAIN.
;;;
;;; Negative and positive zero are considered distinct within
;;; DOMAIN-LOW and DOMAIN-HIGH.
;;;
;;; DEFAULT-LOW and DEFAULT-HIGH are the lower and upper bounds if we
;;; can't compute the bounds using FUN.
(defun elfun-derive-type-simple (arg fun domain-low domain-high
                                     default-low default-high
                                     &optional (increasingp t)
                                               double-float-for-integers)
  (declare (type (or null real) domain-low domain-high))
  (etypecase arg
    (numeric-type
     (cond ((eq (numeric-type-complexp arg) :complex)
            (complex-float-type arg))
           ((numeric-type-real-p arg)
            ;; The argument is real, so let's find the intersection
            ;; between the argument and the domain of the function.
            ;; We compute the bounds on the intersection, and for
            ;; everything else, we return a complex number of the
            ;; appropriate type.
            (multiple-value-bind (intersection difference)
                (interval-intersection/difference (numeric-type->interval arg)
                                                  (make-interval
                                                   :low domain-low
                                                   :high domain-high))
              (cond
                (intersection
                 ;; Process the intersection.
                 (let* ((low (interval-low intersection))
                        (high (interval-high intersection))
                        (res-lo (or (bound-func fun (if increasingp low high) nil)
                                    default-low))
                        (res-hi (or (bound-func fun (if increasingp high low) nil)
                                    default-high))
                        (format (case (numeric-type-class arg)
                                  ((integer rational) (if double-float-for-integers
                                                          'double-float
                                                          'single-float))
                                  (t (numeric-type-format arg))))
                        (result-type
                          (make-numeric-type format res-lo res-hi)))
                   ;; If the ARG is a subset of the domain, we don't
                   ;; have to worry about the difference, because that
                   ;; can't occur.
                   (if (or (null difference)
                           ;; Check whether the arg is within the domain.
                           (domain-subtypep arg domain-low domain-high))
                       result-type
                       (list result-type
                             (make-numeric-type 'complex format)))))
                (t
                 ;; No intersection so the result must be purely complex.
                 (complex-float-type arg)))))
           (t
            (float-or-complex-float-type arg default-low default-high))))))

(macrolet
    ((frob (name domain-low domain-high def-low-bnd def-high-bnd
                 &key (increasingp t))
       (let ((num (gensym)))
         `(defoptimizer (,name derive-type) ((,num))
           (one-arg-derive-type
            ,num
            (lambda (arg)
              (elfun-derive-type-simple arg #',name
                                        ,domain-low ,domain-high
                                        ,def-low-bnd ,def-high-bnd
                                        ,increasingp)))))))
  ;; These functions are easy because they are defined for the whole
  ;; real line.
  (frob exp nil nil 0 nil)
  (frob sinh nil nil nil nil)
  (frob tanh nil nil -1 1)
  (frob asinh nil nil nil nil)

  ;; These functions are only defined for part of the real line. The
  ;; condition selects the desired part of the line.
  (frob asin -1d0 1d0 (sb-xc:- (sb-xc:/ pi 2)) (sb-xc:/ pi 2))
  ;; Acos is monotonic decreasing, so we need to swap the function
  ;; values at the lower and upper bounds of the input domain.
  (frob acos -1d0 1d0 0 pi :increasingp nil)
  (frob acosh 1d0 nil nil nil)
  (frob atanh -1d0 1d0 nil nil)
  ;; Kahan says that (sqrt -0.0) is -0.0, so use a specifier that
  ;; includes -0.0.
  (frob sqrt -0.0d0 nil 0 nil))

;;; Compute bounds for (expt x y). This should be easy since (expt x
;;; y) = (exp (* y (log x))). However, computations done this way
;;; have too much roundoff. Thus we have to do it the hard way.
(defun safe-expt (x y)
  (when (and (numberp x) (numberp y))
    (handler-case
        (when (sb-xc:< (abs y) 10000)
          (expt x y))
      ;; Currently we can hide unanticipated errors (such as failure to use SB-XC: math
      ;; when cross-compiling) as well as the anticipated potential problem of overflow.
      ;; So don't handle anything when cross-compiling.
      ;; FIXME: I think this should not handle ERROR, but just FLOATING-POINT-OVERFLOW.
      (#+sb-xc-host nil
       #-sb-xc-host error ()
        nil))))

;;; Handle the case when x >= 1.
(defun interval-expt-> (x y)
  (let ((zero (intervals-zero x y)))
    (case (interval-range-info y zero)
      (+
       ;; Y is positive and log X >= 0. The range of exp(y * log(x)) is
       ;; obviously non-negative. We just have to be careful for
       ;; infinite bounds (given by nil).
       (let ((lo (safe-expt (type-bound-number (interval-low x))
                            (type-bound-number (interval-low y))))
             (hi (safe-expt (type-bound-number (interval-high x))
                            (type-bound-number (interval-high y)))))
         (list (make-interval :low (or lo (sb-xc:+ zero 1)) :high hi))))
      (-
       ;; Y is negative and log x >= 0. The range of exp(y * log(x)) is
       ;; obviously [0, 1]. However, underflow (nil) means 0 is the
       ;; result.
       (let ((lo (safe-expt (type-bound-number (interval-high x))
                            (type-bound-number (interval-low y))))
             (hi (safe-expt (type-bound-number (interval-low x))
                            (type-bound-number (interval-high y)))))
         (list (make-interval :low (or lo zero) :high (or hi (sb-xc:+ zero 1))))))
      (t
       ;; Split the interval in half.
       (multiple-value-bind (y- y+)
           (interval-split zero y t)
         (list (interval-expt-> x y-)
               (interval-expt-> x y+)))))))

;;; Handle the case when 0 <= x <= 1
(defun interval-expt-< (x y)
  (let ((zero (intervals-zero x y)))
    (case (interval-range-info x zero)
      (+
       ;; The case of 0 <= x <= 1 is easy
       (case (interval-range-info y)
         (+
          ;; Y is positive and log X <= 0. The range of exp(y * log(x)) is
          ;; obviously [0, 1]. We just have to be careful for infinite bounds
          ;; (given by nil).
          (let ((lo (safe-expt (type-bound-number (interval-low x))
                               (type-bound-number (interval-high y))))
                (hi (safe-expt (type-bound-number (interval-high x))
                               (type-bound-number (interval-low y)))))
            (list (make-interval :low (or lo zero) :high (or hi (sb-xc:+ zero 1))))))
         (-
          ;; Y is negative and log x <= 0. The range of exp(y * log(x)) is
          ;; obviously [1, inf].
          (let ((hi (safe-expt (type-bound-number (interval-low x))
                               (type-bound-number (interval-low y))))
                (lo (safe-expt (type-bound-number (interval-high x))
                               (type-bound-number (interval-high y)))))
            (list (make-interval :low (or lo (sb-xc:+ zero 1)) :high hi))))
         (t
          ;; Split the interval in half
          (multiple-value-bind (y- y+)
              (interval-split zero y t)
            (list (interval-expt-< x y-)
                  (interval-expt-< x y+))))))
      (-
       ;; The case where x <= 0. Y MUST be an INTEGER for this to work!
       ;; The calling function must insure this!
       (loop for interval in (flatten-list (interval-expt (interval-neg x) y))
             for low = (interval-low interval)
             for high = (interval-high interval)
             collect interval
             when (or high low)
             collect (interval-neg interval)))
      (t
       (multiple-value-bind (neg pos)
           (interval-split zero x t t)
         (list (interval-expt-< neg y)
               (interval-expt-< pos y)))))))

;;; Compute bounds for (expt x y).
(defun interval-expt (x y)
  (setf (values x y) (interval-contagion x y))
  (case (interval-range-info x 1)
    (+
     ;; X >= 1
         (interval-expt-> x y))
    (-
     ;; X <= 1
     (interval-expt-< x y))
    (t
     (multiple-value-bind (left right)
         (interval-split 1 x t t)
       (list (interval-expt left y)
             (interval-expt right y))))))

(defun fixup-interval-expt (bnd x-int y-int x-type y-type)
  (declare (ignore x-int))
  ;; Figure out what the return type should be, given the argument
  ;; types and bounds and the result type and bounds.
  (cond ((csubtypep x-type (specifier-type 'integer))
         ;; an integer to some power
         (case (numeric-type-class y-type)
           (integer
            ;; Positive integer to an integer power is either an
            ;; integer or a rational.
            (let ((lo (interval-low bnd))
                  (hi (interval-high bnd))
                  (y-lo (interval-low y-int))
                  (y-hi (interval-high y-int)))
              (cond ((and (not lo)
                          (eql y-lo y-hi)
                          (typep y-lo 'unsigned-byte)
                          (evenp y-lo))
                     (make-numeric-type 'integer 0 hi))
                    ((and (interval-low y-int)
                          (>= (type-bound-number y-lo) 0))
                     (make-numeric-type 'integer lo hi))
                    (t
                     (make-numeric-type 'rational lo hi)))))
           (rational
            ;; Positive integer to rational power is either a rational
            ;; or a single-float.
            (let* ((lo (interval-low bnd))
                   (hi (interval-high bnd))
                   (int-lo (and lo
                                (floor (type-bound-number lo))))
                   (int-hi (and hi
                                (ceiling (type-bound-number hi))))
                   (f-lo (bound-func #'float lo nil))
                   (f-hi (bound-func #'float hi nil)))
              (type-union (make-numeric-type 'rational int-lo int-hi)
                          (make-numeric-type 'single-float f-lo f-hi))))
           (float
            ;; A positive integer to a float power is a float.
            (let ((format (numeric-type-format y-type)))
              (aver format)
              (modified-numeric-type
               y-type
               :low (coerce-numeric-bound (interval-low bnd) format)
               :high (coerce-numeric-bound (interval-high bnd) format))))
           (t
            ;; A positive integer to a number is a number (for now).
            (specifier-type 'number))))
        ((csubtypep x-type (specifier-type 'rational))
         ;; a rational to some power
         (case (numeric-type-class y-type)
           (integer
            ;; A positive rational to an integer power is always a rational.
            (interval-to-type bnd 'rational))
           (rational
            ;; A positive rational to rational power is either a rational
            ;; or a single-float.
            (let* ((lo (interval-low bnd))
                   (hi (interval-high bnd))
                   (int-lo (and lo
                                (floor (type-bound-number lo))))
                   (int-hi (and hi
                                (ceiling (type-bound-number hi))))
                   (f-lo (bound-func #'float lo nil))
                   (f-hi (bound-func #'float hi nil)))
              (type-union (make-numeric-type 'rational int-lo int-hi)
                          (make-numeric-type 'single-float f-lo f-hi))))
           (float
            ;; A positive rational to a float power is a float.
            (let ((format (numeric-type-format y-type)))
              (modified-numeric-type
               y-type
               :low (coerce-numeric-bound (interval-low bnd) format)
               :high (coerce-numeric-bound (interval-high bnd) format))))
           (t
            ;; A positive rational to a number is a number (for now).
            (specifier-type 'number))))
        ((csubtypep x-type (specifier-type 'float))
         ;; a float to some power
         (case (numeric-type-class y-type)
           ((or integer rational)
            ;; A positive float to an integer or rational power is
            ;; always a float.
            (interval-to-type bnd (numeric-type-format x-type)))
           (float
            ;; A positive float to a float power is a float of the
            ;; higher type.
            (let ((format (or (float-format-max (numeric-type-format x-type)
                                                (numeric-type-format y-type))
                              'float)))
              (interval-to-type bnd format nil)))
           (t
            ;; A positive float to a number is a number (for now)
            (specifier-type 'number))))
        (t
         ;; A number to some power is a number.
         (specifier-type 'number))))

(defun merged-interval-expt (x y)
  (let* ((x-int (numeric-type->interval x))
         (y-int (numeric-type->interval y)))
    (mapcar (lambda (type)
              (fixup-interval-expt type x-int y-int x y))
            (flatten-list (interval-expt x-int y-int)))))

(defun expt-derive-type-aux (x y same-arg)
  (declare (ignore same-arg))
  (cond ((or (not (numeric-type-real-p x))
             (not (numeric-type-real-p y)))
         ;; Use numeric contagion if either is not real.
         (numeric-contagion x y))
        ((or (csubtypep y (specifier-type 'integer))
             (sb-kernel::integer-float-p (nth-value 1 (type-singleton-p y))))
         ;; A real raised to an integer power is well-defined.
         (merged-interval-expt x y))
        ;; A real raised to a non-integral power can be a float or a
        ;; complex number.
        ((csubtypep x (specifier-type '(real 0)))
         ;; But a positive real to any power is well-defined.
         (merged-interval-expt x y))
        ((and (csubtypep x (specifier-type 'rational))
              (csubtypep y (specifier-type 'rational)))
         ;; A rational to the power of a rational could be a rational
         ;; or a possibly-complex single float
         (specifier-type '(or rational single-float (complex single-float))))
        (t
         ;; a real to some power. The result could be a real or a
         ;; complex.
         (float-or-complex-float-type (numeric-contagion x y)))))

(defoptimizer (expt derive-type) ((x y))
  (two-arg-derive-type x y #'expt-derive-type-aux))

(defun coerce-float-type (type format)
  (cond ((listp type)
         (loop for e in type
               collect (coerce-float-type e format)))
        ((eq (numeric-type-format type) format)
         type)
        (t
         (make-numeric-union-type :class 'float
                                  :format format
                                  :complexp (numeric-type-complexp type)
                                  :low (coerce-for-bound (numeric-type-low type) format)
                                  :high (coerce-for-bound (numeric-type-high type) format)))))

(defun log-derive-type-aux-1 (x &optional (fun #'log) double-float-for-integers)
  (elfun-derive-type-simple x fun
                            (if (rational-type-p x) 0 -0d0)
                            nil
                            nil
                            nil
                            t
                            double-float-for-integers))

(defun log-derive-type-aux-2 (x y same-arg)
  (multiple-value-bind (log-x log-y coerce)
      (flet (#-sb-xc-host
             (rational-float (x y)
               (values (log-derive-type-aux-1 x
                                              #'sb-kernel::log2/rational t)
                       (log-derive-type-aux-1 (coerce-float-type y 'double-float)
                                              #'sb-kernel::log2/double-float t)
                       (numeric-type-format y))))
        ;; LOG on rationals is computed using double-float and then coerced to single-float
        (cond #-sb-xc-host
              ((and (rational-type-p x)
                    (rational-type-p y))
               (values (log-derive-type-aux-1 x #'sb-kernel::log2/rational t)
                       (log-derive-type-aux-1 y #'sb-kernel::log2/rational t)
                       'single-float))
              #-sb-xc-host
              ((and (rational-type-p x)
                    (float-type-p y))
               (rational-float x y))
              #-sb-xc-host
              ((and (float-type-p x)
                    (rational-type-p y))
               (multiple-value-bind (y x coerce) (rational-float y x)
                 (values x y coerce)))
              (t
               (values (log-derive-type-aux-1 x)
                       (log-derive-type-aux-1 y)
                       nil))))
    (let ((accumulated-list nil))
      ;; LOG-X or LOG-Y might be union types. We need to run through
      ;; the union types ourselves because /-DERIVE-TYPE-AUX doesn't.
      (dolist (x-type (prepare-arg-for-derive-type log-x))
        (dolist (y-type (prepare-arg-for-derive-type log-y))
          (push (/-derive-type-aux x-type y-type same-arg) accumulated-list)))
      (when coerce
        (setf accumulated-list (coerce-float-type accumulated-list coerce)))
      (let ((union (apply #'type-union (flatten-list accumulated-list))))
        (if (types-equal-or-intersect y (specifier-type '(or (real 0 0) complex)))
            ;; If Y can be zero the result can be zero too
            (type-union union
                        (type-intersection (specifier-type '(member 0.0 0d0))
                                           (numeric-contagion x y :float t :complex nil)))
            union)))))

(defoptimizer (log derive-type) ((x &optional y))
  (if y
      (two-arg-derive-type x y #'log-derive-type-aux-2)
      (one-arg-derive-type x #'log-derive-type-aux-1)))

(defun atan-derive-type-aux-1 (y)
  (elfun-derive-type-simple y #'atan nil nil (sb-xc:- (sb-xc:/ pi 2)) (sb-xc:/ pi 2)))

(defun atan-derive-type-aux-2 (y x same-arg)
  (declare (ignore same-arg))
  ;; The hard case with two args. We just return the max bounds.
  (let ((result-type (numeric-contagion y x)))
    (cond ((and (numeric-type-real-p x)
                (numeric-type-real-p y))
           (let* (;; FIXME: This expression for FORMAT seems to
                  ;; appear multiple times, and should be factored out.
                  (format (case (numeric-type-class result-type)
                            ((integer rational) 'single-float)
                            (t (numeric-type-format result-type)))))
             (make-numeric-type format (sb-xc:- pi) pi)))
          (t
           ;; The result is a float or a complex number
           (float-or-complex-float-type result-type)))))

(defoptimizer (atan derive-type) ((y &optional x))
  (if x
      (two-arg-derive-type y x #'atan-derive-type-aux-2)
      (one-arg-derive-type y #'atan-derive-type-aux-1)))

(defun cosh-derive-type-aux (x)
  (%one-arg-derive-type
   ;; We note that cosh x = cosh |x| for all real x.
   (if (numeric-type-real-p x)
       (abs-derive-type-aux x)
       x)
   (lambda (x) (elfun-derive-type-simple x #'cosh nil nil 0 nil))))

(defoptimizer (cosh derive-type) ((num))
  (one-arg-derive-type num #'cosh-derive-type-aux))

(defun phase-derive-type-aux (arg)
  (let* ((format (case (numeric-type-class arg)
                   ((integer rational) 'single-float)
                   (t (numeric-type-format arg)))))
    (cond ((numeric-type-real-p arg)
           (case (let ((int (numeric-type->interval arg)))
                   (interval-range-info int (interval-zero int 0.0)))
             (+
              ;; The number is positive, so the phase is 0.
              (make-numeric-type format 0 0))
             (-
              ;; The number is always negative, so the phase is pi.
              (make-numeric-type format pi pi))
             (t
              ;; We can't tell. The result is 0 or pi. Use a union
              ;; type for this.
              (list
               (make-numeric-type format 0 0)
               (make-numeric-type format pi pi)))))
          (t
           ;; We have a complex number. The answer is the range -pi
           ;; to pi. (-pi is included because we have -0.)
           (make-numeric-type format (sb-xc:- pi) pi)))))

(defoptimizer (phase derive-type) ((num))
  (one-arg-derive-type num #'phase-derive-type-aux))

(deftransform realpart ((x) ((complex rational)) * :important nil)
  '(%realpart x))
(deftransform imagpart ((x) ((complex rational)) * :important nil)
  '(%imagpart x))

(deftransform realpart ((x) (real) * :important nil)
  'x)

(deftransform imagpart ((x) (float) * :important nil)
  `(if (single-float-p x)
       0f0
       0d0))

;;; Make REALPART and IMAGPART return the appropriate types. This
;;; should help a lot in optimized code.
(defun realpart-derive-type-aux (type)
  (let ((class (numeric-type-class type))
        (format (numeric-type-format type)))
    (cond ((numeric-type-real-p type)
           ;; The realpart of a real has the same type and range as
           ;; the input.
           (make-numeric-union-type :class class
                                    :format format
                                    :low (numeric-type-low type)
                                    :high (numeric-type-high type)))
          (t
           ;; We have a complex number. The result has the same type
           ;; as the real part, except that it's real, not complex,
           ;; obviously.
           (make-numeric-union-type :class class
                                    :format format
                                    :low (numeric-type-low type)
                                    :high (numeric-type-high type))))))

(defoptimizer (realpart derive-type) ((num))
  (one-arg-derive-type num #'realpart-derive-type-aux))

(defun imagpart-derive-type-aux (type)
  (let ((class (numeric-type-class type))
        (format (numeric-type-format type)))
    (cond ((numeric-type-real-p type)
           ;; The imagpart of a real has the same type as the input,
           ;; except that it's zero.
           (let ((bound-format (or format class 'real)))
             (make-numeric-union-type :class class
                                      :format format
                                      :low (coerce 0 bound-format)
                                      :high (coerce 0 bound-format)
                                      :normalize-zeros nil)))
          (t
           ;; We have a complex number. The result has the same type as
           ;; the imaginary part, except that it's real, not complex,
           ;; obviously.
           (make-numeric-union-type :class class
                                    :format format
                                    :low (numeric-type-low type)
                                    :high (numeric-type-high type))))))

(defoptimizer (imagpart derive-type) ((num))
  (one-arg-derive-type num #'imagpart-derive-type-aux))

(defun complex-derive-type-aux-1 (re-type)
  (if (numeric-type-p re-type)
      (make-numeric-union-type :class (numeric-type-class re-type)
                               :format (numeric-type-format re-type)
                               :complexp (if (csubtypep re-type
                                                        (specifier-type 'rational))
                                             :real
                                             :complex))
      (specifier-type 'complex)))

(defun complex-derive-type-aux-2 (re-type im-type same-arg)
  (declare (ignore same-arg))
  (if (and (numeric-type-p re-type)
           (numeric-type-p im-type)
           (not (eq (numeric-type-complexp re-type) :complex))
           (not (eq (numeric-type-complexp im-type) :complex)))
      ;; Need to check to make sure numeric-contagion returns the
      ;; right type for what we want here.

      ;; Also, what about rational canonicalization, like (complex 5 0)
      ;; is 5?  So, if the result must be complex, we make it so.
      ;; If the result might be complex, which happens only if the
      ;; arguments are rational, we make it a union type of (or
      ;; rational (complex rational)).
      (let* ((element-type (numeric-contagion re-type im-type))
             (maybe-rat-result-p (types-equal-or-intersect
                                  element-type (specifier-type 'rational)))
             (definitely-rat-result-p (csubtypep element-type (specifier-type 'rational)))
             (real-result-p (and definitely-rat-result-p
                                 (csubtypep im-type (specifier-type '(eql 0))))))
        (cond
          (real-result-p re-type)
          (maybe-rat-result-p
           (let ((complex (specifier-type
                           `(complex ,(numeric-type-class element-type)))))
             (if (types-equal-or-intersect im-type (specifier-type '(eql 0)))
                 (type-union element-type complex)
                 complex)))
          (t
           (make-numeric-union-type :class (numeric-type-class element-type)
                                    :format (numeric-type-format element-type)
                                    :complexp :complex))))
      (specifier-type 'complex)))

(defoptimizer (complex derive-type) ((re &optional im))
  (if im
      (two-arg-derive-type re im #'complex-derive-type-aux-2)
      (one-arg-derive-type re #'complex-derive-type-aux-1)))

;;; Define some transforms for complex operations in lieu of complex operation
;;; VOPs for most backends. If vops exist, they must support the following
;;; on complex-single-float and complex-double-float:
;;;   * real-complex, complex-real and complex-complex addition and subtraction
;;;   * complex-real and real-complex multiplication
;;;   * complex-real division
;;;   * sb-vm::swap-complex, which swaps the real and imaginary parts.
;;;   * conjugate
;;;   * complex-real, real-complex and complex-complex CL:=
;;;     (complex-complex EQL would usually be a good idea).
(macrolet ((frob (type contagion)
             `(progn
                (deftransform complex ((r) (,type))
                  '(complex r ,(coerce 0 type)))
                (deftransform complex ((r i) (,type ,contagion))
                  (when (csubtypep (lvar-type i) (specifier-type ',type))
                    (give-up-ir1-transform))
                  '(complex r (truly-the ,type (coerce i ',type))))
                (deftransform complex ((r i) (,contagion ,type))
                  (when (csubtypep (lvar-type r) (specifier-type ',type))
                    (give-up-ir1-transform))
                  '(complex (truly-the ,type (coerce r ',type)) i))

                ;; Arbitrarily use %NEGATE/COMPLEX-DOUBLE-FLOAT as an indicator
                ;; of whether all the operations below are translated by vops.
                ;; We could be more fine-grained, but it seems reasonable that
                ;; they be implemented on an all-or-none basis.
                (unless (vop-existsp :named sb-vm::%negate/complex-double-float)
                ;; negation
                (deftransform %negate ((z) ((complex ,type)) * :important nil)
                  '(complex (%negate (realpart z)) (%negate (imagpart z))))
                ;; complex addition and subtraction
                (deftransform + ((w z) ((complex ,type) (complex ,type)) * :important nil)
                  '(complex (+ (realpart w) (realpart z))
                            (+ (imagpart w) (imagpart z))))
                (deftransform - ((w z) ((complex ,type) (complex ,type)) * :important nil)
                  '(complex (- (realpart w) (realpart z))
                            (- (imagpart w) (imagpart z))))
                ;; Add and subtract a complex and a real.
                (deftransform + ((w z) ((complex ,type) real) * :important nil)
                  `(complex (+ (realpart w) z)
                            (+ (imagpart w) ,(coerce 0 ',type))))
                (deftransform + ((z w) (real (complex ,type)) * :important nil)
                  `(complex (+ (realpart w) z)
                            (+ (imagpart w) ,(coerce 0 ',type))))
                ;; Add and subtract a real and a complex number.
                (deftransform - ((w z) ((complex ,type) real) * :important nil)
                  `(complex (- (realpart w) z)
                            (- (imagpart w) ,(coerce 0 ',type))))
                (deftransform - ((z w) (real (complex ,type)) * :important nil)
                  `(complex (- z (realpart w))
                            (- ,(coerce 0 ',type) (imagpart w))))
                ;; Multiply a complex by a real or vice versa.
                (deftransform * ((w z) ((complex ,type) real) * :important nil)
                  '(complex (* (realpart w) z) (* (imagpart w) z)))
                (deftransform * ((z w) (real (complex ,type)) * :important nil)
                  '(complex (* (realpart w) z) (* (imagpart w) z)))
                ;; conjugate of complex number
                (deftransform conjugate ((z) ((complex ,type)) * :important nil)
                  '(complex (realpart z) (- (imagpart z))))
                ;; comparison
                (deftransform = ((w z) ((complex ,type) (complex ,type)) * :important nil)
                  '(and (= (realpart w) (realpart z))
                    (= (imagpart w) (imagpart z))))
                (deftransform = ((w z) ((complex ,type) real) * :important nil)
                  '(and (= (realpart w) z) (zerop (imagpart w))))
                (deftransform = ((w z) (real (complex ,type)) * :important nil)
                  '(and (= (realpart z) w) (zerop (imagpart z))))
                ;; Multiply two complex numbers.
                (deftransform * ((x y) ((complex ,type) (complex ,type)) * :important nil)
                  '(let* ((rx (realpart x))
                          (ix (imagpart x))
                          (ry (realpart y))
                          (iy (imagpart y)))
                    (complex (- (* rx ry) (* ix iy))
                             (+ (* rx iy) (* ix ry)))))
                ;; Divide a complex by a real.
                (deftransform / ((w z) ((complex ,type) real) * :important nil)
                  '(complex (/ (realpart w) z) (/ (imagpart w) z)))
                )


                (deftransform / ((x y) (:or (((complex ,type) (complex ,type)) *)
                                            ((real (complex ,type)) *)) * :important nil)
                  (if (vop-existsp :translate sb-vm::swap-complex)
                      (let ((real (csubtypep (lvar-type x) (specifier-type 'real))))
                       `(let* (,@(if real
                                     '((x (coerce x 'float))))
                               (cs ,(if real
                                        '(complex 0 (%negate x))
                                        '(conjugate (sb-vm::swap-complex x))))
                               ,@(if real
                                     '((x (complex x 0))))
                               (ry (realpart y))
                               (iy (imagpart y)))
                          (if (> (abs ry) (abs iy))
                              (let* ((r (/ iy ry))
                                     (dn (+ ry (* r iy))))
                                (/ (+ x (* cs r)) dn))
                              (let* ((r (/ ry iy))
                                     (dn (+ iy (* r ry))))
                                (/ (+ (* x r) cs) dn)))))
                      '(let* ((rx (realpart x))
                              (ix (imagpart x))
                              (ry (realpart y))
                              (iy (imagpart y)))
                        (if (> (abs ry) (abs iy))
                            (let* ((r (/ iy ry))
                                   (dn (+ ry (* r iy))))
                              (complex (/ (+ rx (* ix r)) dn)
                                       (/ (- ix (* rx r)) dn)))
                            (let* ((r (/ ry iy))
                                   (dn (+ iy (* r ry))))
                              (complex (/ (+ (* rx r) ix) dn)
                                       (/ (- (* ix r) rx) dn)))))))
                ;; CIS
                (deftransform cis ((z) ((,type)) *)
                  '(complex (cos z) (sin z)))
                )))
  (frob single-float (or rational single-float))
  (frob double-float (or rational single-float double-float)))


;;;; float contagion

(make-defs (($type single-float double-float))
  (deftransform $type-real-contagion ((x y) * * :node node :defun-only t)
    (if (csubtypep (lvar-type y) (specifier-type '$type))
        (give-up-ir1-transform)
        `(,(lvar-fun-name (basic-combination-fun node)) x (%$type y))))

  (deftransform real-$type-contagion ((x y) * * :node node :defun-only t)
    (if (csubtypep (lvar-type x) (specifier-type '$type))
        (give-up-ir1-transform)
        `(,(lvar-fun-name (basic-combination-fun node)) (%$type x) y))))

(deftransform double-float-number-contagion ((x y) * * :node node :defun-only t)
  (if (and (not (csubtypep (lvar-type y) (specifier-type 'double-float)))
           (or (csubtypep (lvar-type y) (specifier-type 'real))
               (cast-or-check-bound-type node (specifier-type 'real))))
      `(,(lvar-fun-name (basic-combination-fun node)) x (%double-float y))
      (give-up-ir1-transform)))

(deftransform number-double-float-contagion ((x y) * * :node node :defun-only t)
  (if (and (not (csubtypep (lvar-type x) (specifier-type 'double-float)))
           (or (csubtypep (lvar-type x) (specifier-type 'real))
               (cast-or-check-bound-type node (specifier-type 'real))))
      `(,(lvar-fun-name (basic-combination-fun node)) (%double-float x) y)
      (give-up-ir1-transform)))

(deftransform single-float-number-contagion ((x y) * * :node node :defun-only t)
   (if (and (not (csubtypep (lvar-type y) (specifier-type 'single-float)))
            (if (csubtypep (single-value-type (node-derived-type node))
                           (specifier-type '(and number (not double-float))))
                (or (csubtypep (lvar-type y) (specifier-type 'real))
                    (cast-or-check-bound-type node (specifier-type 'real)))
                (cast-or-check-bound-type node (specifier-type 'single-float))))
       `(,(lvar-fun-name (basic-combination-fun node)) x (%single-float-no-double-float y))
       (give-up-ir1-transform)))

(deftransform number-single-float-contagion ((x y) * * :node node :defun-only t)
  (if (and (not (csubtypep (lvar-type x) (specifier-type 'single-float)))
           (if (csubtypep (single-value-type (node-derived-type node))
                          (specifier-type '(and number (not double-float))))
               (or (csubtypep (lvar-type x) (specifier-type 'real))
                   (cast-or-check-bound-type node (specifier-type 'real)))
               (cast-or-check-bound-type node (specifier-type 'single-float))))
      `(,(lvar-fun-name (basic-combination-fun node)) (%single-float-no-double-float x) y)
      (give-up-ir1-transform)))

;;; Handle (the double-float (+ x 10)), where X must be a double-float
(deftransform float-cast-contagion ((x y) * * :node node :defun-only t)
  (flet ((contagion (type test)
           (let* ((x x)
                  (y y)
                  (x-float-p (types-equal-or-intersect (lvar-type x) type))
                  (y-float-p (types-equal-or-intersect (lvar-type y) type)))
             (unless (or (and x-float-p y-float-p)
                         (not (or x-float-p y-float-p)))
               (when y-float-p
                 (rotatef x y))
               (let ((cast (cast-or-check-bound-type node type)))
                 (when (and cast
                            (csubtypep cast type))
                   (delay-ir1-transform node :ir1-phases)
                   (let ((op (lvar-fun-name (basic-combination-fun node))))
                     (delete-lvar-cast-if (specifier-type 'number) x)
                     (if y-float-p
                         `(if (,test y)
                              (,op x (truly-the ,type y))
                              (sb-vm::op-not-type2-error x y '(,(type-specifier cast) . ,op)))
                         `(if (,test x)
                              (,op (truly-the ,type x) y)
                              (sb-vm::op-not-type2-error x y '(,(type-specifier cast) . ,op)))))))))))
    (or (contagion (specifier-type 'single-float) 'single-float-p)
        (contagion (specifier-type 'double-float) 'double-float-p)
        (give-up-ir1-transform))))

(make-defs (($op * + - /))
  (%deftransform '$op nil '(function (number t)) #'float-cast-contagion nil))

(deftransform %negate ((x) (number) * :node node :important nil)
  (flet ((contagion (type test)
           (unless (csubtypep (lvar-type x) type)
             (let ((cast (cast-or-check-bound-type node type)))
               (when (and cast
                          (csubtypep cast type))
                 (delay-ir1-transform node :ir1-phases)
                 (delete-lvar-cast-if (specifier-type 'number) x)
                 `(if (,test x)
                      (%negate (truly-the ,type x))
                      (sb-vm::op-not-type1-error x '(,(type-specifier cast) . %negate))))))))
    (or (contagion (specifier-type 'single-float) 'single-float-p)
        (contagion (specifier-type 'double-float) 'double-float-p)
        (give-up-ir1-transform))))

(deftransform double-float-real-contagion-cmp ((x y) * * :node node :defun-only t)
  (cond ((csubtypep (lvar-type y) (specifier-type 'double-float))
         (give-up-ir1-transform))
        ;; Turn (= single-float 1d0) into (= single-float 1f0)
        ((and (constant-lvar-p x)
              (csubtypep (lvar-type y) (specifier-type 'single-float))
              (let ((x (lvar-value x)))
                (when (and (safe-single-coercion-p x)
                           (= x (coerce x 'single-float)))
                  `(,(lvar-fun-name (basic-combination-fun node)) ,(coerce x 'single-float) y)))))
        (t
         `(,(lvar-fun-name (basic-combination-fun node)) x (%double-float y)))))

(deftransform real-double-float-contagion-cmp ((x y) * * :node node :defun-only t)
  (cond ((csubtypep (lvar-type x) (specifier-type 'double-float))
         (give-up-ir1-transform))
        ((and (constant-lvar-p y)
              (csubtypep (lvar-type x) (specifier-type 'single-float))
              (let ((y (lvar-value y)))
                (when (and (safe-single-coercion-p y)
                           (= y (coerce y 'single-float)))
                  `(,(lvar-fun-name (basic-combination-fun node)) x ,(coerce y 'single-float))))))
        (t
         `(,(lvar-fun-name (basic-combination-fun node)) (%double-float x) y))))

(flet ((def (op)
         (%deftransform op nil '(function (single-float number))
                        #'single-float-number-contagion nil)
         (%deftransform op nil '(function (number single-float))
                        #'number-single-float-contagion nil)
         (%deftransform op nil '(function (double-float number))
                        #'double-float-number-contagion nil)
         (%deftransform op nil '(function (number double-float))
                        #'number-double-float-contagion nil)

         (%deftransform op nil '(function ((complex single-float) real) (complex single-float))
                        #'single-float-real-contagion nil)
         (%deftransform op nil '(function (real (complex single-float)) (complex single-float))
                        #'real-single-float-contagion nil)
         (%deftransform op nil '(function ((complex double-float) real) (complex double-float))
                        #'double-float-real-contagion nil)
         (%deftransform op nil '(function (real (complex double-float)) (complex double-float))
                        #'real-double-float-contagion nil)))
  (dolist (op '(+ * / -))
    (def op)))

(flet ((def (op)
           (%deftransform op nil '(function (single-float real) (values t single-float))
                          #'single-float-real-contagion nil)
           (%deftransform op nil '(function (real single-float) (values t single-float))
                          #'real-single-float-contagion nil)
           (%deftransform op nil '(function (double-float real))
                          #'double-float-real-contagion nil)
           (%deftransform op nil '(function (real double-float))
                          #'real-double-float-contagion nil)))
  (dolist (op '(floor ceiling round truncate ffloor fceiling fround ftruncate))
    (def op)))

(flet ((def (op)
         (%deftransform op nil `(function (single-float (integer ,most-negative-exactly-single-float-integer
                                                                 ,most-positive-exactly-single-float-integer)))
                        #'single-float-real-contagion nil)
         (%deftransform op nil `(function ((integer ,most-negative-exactly-single-float-integer
                                                    ,most-positive-exactly-single-float-integer)
                                           single-float))
                        #'real-single-float-contagion nil)

         (%deftransform op nil `(function (double-float
                                           (or single-float
                                               (integer ,most-negative-exactly-double-float-integer
                                                        ,most-positive-exactly-double-float-integer))))
                        #'double-float-real-contagion-cmp nil)
         (%deftransform op nil `(function ((or single-float
                                               (integer ,most-negative-exactly-double-float-integer
                                                        ,most-positive-exactly-double-float-integer))
                                           double-float))
                        #'real-double-float-contagion-cmp nil)))
  (dolist (op '(= < > <= >=))
    (def op)))

(%deftransform '= nil '(function ((complex double-float) single-float))
               #'double-float-real-contagion nil)
(%deftransform '= nil '(function (single-float (complex double-float)))
               #'real-double-float-contagion nil)

(deftransform complex ((realpart &optional imagpart) (rational &optional (or null (integer 0 0))) * :important nil)
  'realpart)

;;; Here are simple optimizers for SIN, COS, and TAN. They do not
;;; produce a minimal range for the result; the result is the widest
;;; possible answer. This gets around the problem of doing range
;;; reduction correctly but still provides useful results when the
;;; inputs are union types.
(defun trig-derive-type-aux (arg domain fun
                             &optional def-lo def-hi (increasingp t))
  (etypecase arg
    (numeric-type
     (flet ((floatify-format ()
              (case (numeric-type-class arg)
                ((integer rational) 'single-float)
                (t (numeric-type-format arg)))))
       (cond ((eq (numeric-type-complexp arg) :complex)
              (make-numeric-type 'complex
                                 (floatify-format)))
             ((numeric-type-real-p arg)
              (let* ((format (floatify-format)))
                ;; If the argument is a subset of the "principal" domain
                ;; of the function, we can compute the bounds because
                ;; the function is monotonic. We can't do this in
                ;; general for these periodic functions because we can't
                ;; (and don't want to) do the argument reduction in
                ;; exactly the same way as the functions themselves do
                ;; it.
                (if (csubtypep arg domain)
                    (let ((res-lo (bound-func fun (numeric-type-low arg) nil))
                          (res-hi (bound-func fun (numeric-type-high arg) nil)))
                      (unless increasingp
                        (rotatef res-lo res-hi))
                      (make-numeric-type format res-lo res-hi))
                    (make-numeric-type format def-lo def-hi))))
             (t
              (float-or-complex-float-type arg def-lo def-hi)))))))

(defoptimizer (sin derive-type) ((num))
  (one-arg-derive-type
   num
   (lambda (arg)
     ;; Derive the bounds if the arg is in [-pi/2, pi/2].
     (trig-derive-type-aux
      arg
      (specifier-type `(float ,(sb-xc:- (sb-xc:/ pi 2)) ,(sb-xc:/ pi 2)))
      #'sin
      -1 1))))

(defoptimizer (cos derive-type) ((num))
  (one-arg-derive-type
   num
   (lambda (arg)
     ;; Derive the bounds if the arg is in [0, pi].
     (trig-derive-type-aux arg
                           (specifier-type `(float 0d0 ,pi))
                           #'cos
                           -1 1
                           nil))))

(defoptimizer (tan derive-type) ((num))
  (one-arg-derive-type
   num
   (lambda (arg)
     ;; Derive the bounds if the arg is in [-pi/2, pi/2].
     (trig-derive-type-aux arg
                           (specifier-type `(or (double-float ,(sb-xc:- (sb-xc:/ pi 2))
                                                              ,(sb-xc:/ pi 2))
                                                ;; 1.5707964 coerced back to double-float is greater than (/ pi 2)
                                                (single-float -1.5707963 1.5707963)))
                           #'tan
                           nil nil))))

(defoptimizer (conjugate derive-type) ((num))
  (one-arg-derive-type num
    (lambda (arg)
      (flet ((most-negative-bound (l h)
               (and l h
                    (if (< (type-bound-number l) (- (type-bound-number h)))
                        l
                        (set-bound (- (type-bound-number h)) (consp h)))))
             (most-positive-bound (l h)
               (and l h
                    (if (> (type-bound-number h) (- (type-bound-number l)))
                        h
                        (set-bound (- (type-bound-number l)) (consp l))))))
        (if (numeric-type-real-p arg)
            (lvar-type num)
            (let ((low (numeric-type-low arg))
                  (high (numeric-type-high arg)))
              (let ((new-low (most-negative-bound low high))
                    (new-high (most-positive-bound low high)))
                (modified-numeric-type arg :low new-low :high new-high))))))))

(defoptimizer (cis derive-type) ((num))
  (one-arg-derive-type num
    (lambda (arg)
      (specifier-type
       `(complex ,(or (numeric-type-format arg) 'float))))))


;;;; TRUNCATE, FLOOR, CEILING, and ROUND
(deftransform truncate ((x &optional by)
                        (t &optional (constant-arg (member 1))))
  '(unary-truncate x))

(deftransform round ((x &optional by)
                     (t &optional (constant-arg (member 1))))
  '(let ((res (%unary-round x)))
    (values res (locally
                    (declare (flushable %single-float
                                        %double-float))
                  (- x res)))))

(deftransform %unary-truncate ((x) (single-float))
  `(values (unary-truncate x)))
(deftransform %unary-truncate ((x) (double-float))
  `(values (unary-truncate x)))

#-(or sb-xc-host 64-bit)
(progn
  (declaim (inline %make-double-float))
  (defun %make-double-float (bits)
    (make-double-float (ash bits -32) (ldb (byte 32 0) bits))))

;;; Transform inclusive integer bounds so that they work on floats
;;; before truncating to zero.
(macrolet
    ((def (type)
       `(defun ,(symbolicate type '-integer-bounds) (low high)
          (macrolet ((const (name)
                       (package-symbolicate :sb-vm ',type '- name)))
            (labels ((fractions-p (number)
                       (< (integer-length (abs number))
                          (const digits)))
                     (c (number round)
                       (if (zerop number)
                           (sb-kernel:make-single-float 0)
                           (let* ((negative (minusp number))
                                  (number (abs number))
                                  (length (integer-length number))
                                  (shift (- length (const digits)))
                                  (shifted (truly-the fixnum
                                                      (ash number
                                                           (- shift))))
                                  ;; Cut off the hidden bit
                                  (signif (ldb (const significand-byte) shifted))
                                  (exp (+ (const bias) length))
                                  (bits (ash exp
                                             (byte-position (const exponent-byte)))))
                             (incf signif round)
                             ;; If rounding up overflows this will increase the exponent too
                             (let ((bits (+ bits signif)))
                               (when negative
                                 (setf bits (logior (ash -1 ,(case type
                                                               (double-float 63)
                                                               (single-float 31)))
                                                    bits)))
                               (,(case type
                                   (single-float 'make-single-float)
                                   (double-float '%make-double-float)) bits))))))
              (values (if (<= low 0)
                          (if (fractions-p low)
                              (c (1- low) -1)
                              (c low 0))
                          (c low 0))
                      (if (< high 0)
                          (c high 0)
                          (if (fractions-p high)
                              (c (1+ high) -1)
                              (c high 0)))))))))
  (def single-float)
  (def double-float))

(deftransform unary-truncate ((x) * * :result result :node node)
  (delay-ir1-transform node :constraint)
  (unless (or (lvar-single-value-p result)
              (mv-bind-unused-p result 1))
    (give-up-ir1-transform))
  (erase-node-type node t 1)
  `(values (%unary-truncate x) 0))

(macrolet ((def (type)
             `(deftransform unary-truncate ((number) (,type) * :node node)
                (multiple-value-bind (cast result-type)
                    (cast-or-check-bound-type node (specifier-type 'sb-vm:signed-word))
                  (if cast
                      (let ((int (type-approximate-interval result-type)))
                        (when int
                          (multiple-value-bind (low high) (,(symbolicate type '-integer-bounds)
                                                           (interval-low int)
                                                           (interval-high int))
                            `(if (typep number
                                        '(,',type ,low ,high))
                                 (let ((truncated (truly-the ,(type-specifier result-type) (,',(symbolicate '%unary-truncate/ type) number))))
                                   (declare (flushable ,',(symbolicate "%" type)))
                                   (values truncated
                                           (- number
                                              (coerce truncated ',',type))))
                                 ,(internal-type-error-call 'number (type-specifier cast) 'truncate-to-integer)))))
                      '(if (typep number
                            '(,type
                              ,(symbol-value (package-symbolicate :sb-kernel 'most-negative-fixnum- type))
                              ,(symbol-value (package-symbolicate :sb-kernel 'most-positive-fixnum- type))))
                        (let ((truncated (truly-the fixnum (,(symbolicate '%unary-truncate/ type) number))))
                          (declare (flushable ,(symbolicate "%" type)))
                          (values truncated
                                  (- number
                                     (coerce truncated ',type))))
                        (,(symbolicate 'unary-truncate- type '-to-bignum) number)))))))
  (def single-float)
  (def double-float))

(make-defs (($float single-float double-float))
  (deftransform unary-truncate-$float-to-bignum-div ((quot number divisor) * * :result result)
    (if (or (lvar-single-value-p result)
            #+64-bit
            (and (constant-lvar-p divisor) (sb-xc:= 1 (lvar-value divisor))))
        `(values (unary-truncate-$float-to-bignum quot) (coerce 0 '$float))
        (give-up-ir1-transform))))

#-round-float
(macrolet ((def (fun type other-float-arg-types &optional bignum-rounder adjust-bound)
             (let* ((unary (if (eq fun 'round)
                               (symbolicate "%UNARY-" fun)
                               (symbolicate "%UNARY-" fun "/" type)))
                    (to-bignum-div (or (and bignum-rounder
                                            (package-symbolicate "SB-BIGNUM"
                                                                 bignum-rounder
                                                                 '-div))
                                       (symbolicate 'unary-truncate- type '-to-bignum-div)))
                    (to-bignum (or (and (neq fun 'truncate)
                                        bignum-rounder)
                                   (symbolicate 'unary-truncate- type '-to-bignum)))
                    (coerce (symbolicate "%" type))
                    (fixnum-type `(,type
                                   ,(symbol-value (package-symbolicate :sb-kernel 'most-negative-fixnum- type))
                                   ,(let ((value (symbol-value (package-symbolicate :sb-kernel 'most-positive-fixnum- type))))
                                      ;; on 32-bit it has a fraction and can be rounded up
                                      (if adjust-bound
                                          (ftruncate value)
                                          value)))))
               `(deftransform ,fun ((x &optional y)
                                    (,type
                                     &optional (or ,type ,@other-float-arg-types integer))
                                    * :node node)
                  (let ((one-p (or (not y)
                                   (and (constant-lvar-p y) (sb-xc:= 1 (lvar-value y))))))
                    (if one-p
                        `(if (typep x ',',fixnum-type)
                             (let ((r (truly-the fixnum (,',unary x))))
                               (values r
                                       (- x (locally
                                                (declare (flushable ,',coerce))
                                              (,',coerce r)))))
                             (truly-the (values ,(type-specifier (single-value-type (node-derived-type node))) t &optional)
                                        (,',to-bignum x)))
                        `(let* ((f (,',coerce y))
                                (div (/ x f)))
                           (if (typep div ',',fixnum-type)
                               (let ((r (truly-the fixnum (,',unary div))))
                                 (values r
                                         (- x (* f
                                                 (locally
                                                     (declare (flushable ,',coerce))
                                                   (,',coerce r))))))
                               (truly-the (values ,(type-specifier (single-value-type (node-derived-type node))) t &optional)
                                          (,',to-bignum-div div x f))))))))))
  (def truncate single-float ())
  (def truncate double-float (single-float) #-64-bit sb-bignum::truncate-double-float-to-bignum-truncating)
  (def round single-float ())
  (def round double-float (single-float) #-64-bit sb-bignum::round-double-float-to-bignum #-64-bit t))

(macrolet ((def (name type other-float-arg-types)
             (let* ((to-bignum-div (symbolicate 'unary-truncate- type '-to-bignum-div))
                    (to-bignum (symbolicate 'unary-truncate- type '-to-bignum))
                    (coerce (symbolicate "%" type))
                    (fixnum-type `(,type
                                   ,(symbol-value (package-symbolicate :sb-kernel 'most-negative-fixnum- type))
                                   ,(symbol-value (package-symbolicate :sb-kernel 'most-positive-fixnum- type)))))
               `(deftransform ,name ((number &optional divisor)
                                     (,type
                                      &optional (or ,type ,@other-float-arg-types integer))
                                     * :node node)
                  (let ((one-p (or (not divisor)
                                   (and (constant-lvar-p divisor) (sb-xc:= (lvar-value divisor) 1)))))
                    `(let* (,@(if one-p
                                  `((div number))
                                  `((f-divisor (,',coerce divisor))
                                    (div (/ number f-divisor))))
                            (quot
                              (,',(ecase type
                                    (double-float 'round-double)
                                    (single-float 'round-single))
                               div ,,(keywordicate name))))
                       (if (typep div ',',fixnum-type)
                           (values ,',(if-vop-existsp (:translate %unary-ceiling)
                                                      `(truly-the fixnum (,(symbolicate '%unary- name) div))
                                                      `(%unary-truncate (truly-the ,fixnum-type quot)))
                                   (- number (* ,@(unless one-p
                                                    '(f-divisor))
                                                (+ quot
                                                   ;; Turn -0 into 0
                                                   ,,(ecase type
                                                       (double-float 0.0d0)
                                                       (single-float 0.0f0))))))
                           (truly-the (values ,(type-specifier (single-value-type (node-derived-type node))) t &optional)
                                      ,(if one-p
                                           `(,',to-bignum #+64-bit div
                                                          #-64-bit quot)
                                           `(,',to-bignum-div #+64-bit div
                                                              #-64-bit quot number f-divisor))))))))))
  (def floor single-float ())
  (def floor double-float (single-float))
  (def ceiling single-float ())
  (def ceiling double-float (single-float))
  #+round-float
  (def round single-float ())
  #+round-float
  (def round double-float (single-float))
  #+round-float
  (def truncate single-float ())
  #+round-float
  (def truncate double-float (single-float)))

#-round-float
(progn
  (defknown (%unary-fround) (real) float (movable foldable flushable))
  #-64-bit
  (defknown (%unary-fround/double) (double-float) double-float
      (movable foldable flushable))

  (deftransform %unary-fround ((x) (single-float))
    `(cond ((typep x '(or (single-float -0.5f0 (0f0)) (eql -0f0)))
            -0f0)
           ((typep x '(single-float ,(float (- (expt 2 sb-vm:single-float-digits)) 1f0)
                       ,(float (1- (expt 2 sb-vm:single-float-digits)) 1f0)))
            (float (round x) 1f0))
           (t
            x)))

  #+64-bit
  (deftransform %unary-fround ((x) (double-float))
    `(cond ((typep x '(or (double-float -0.5d0 (0d0)) (eql -0d0)))
            -0d0)
           ((typep x '(double-float ,(float (- (expt 2 sb-vm:double-float-digits)) 1d0)
                       ,(float (1- (expt 2 sb-vm:double-float-digits)) 1d0)))
            (float (round x) 1d0))
           (t
            x)))

  #-64-bit
  (progn
    #-sb-xc-host
    (defun %unary-fround/double (x)
      (declare (muffle-conditions compiler-note))
      (declare (type double-float x))
      (declare (optimize speed (safety 0)))
      (let* ((high (double-float-high-bits x))
             (low (double-float-low-bits x))
             (exp (ldb sb-vm:double-float-hi-exponent-byte high))
             (biased (the double-float-exponent
                          (- exp sb-vm:double-float-bias))))
        (declare (type (signed-byte 32) high)
                 (type (unsigned-byte 32) low))
        (cond
          ((= exp sb-vm:double-float-normal-exponent-max) x)
          ((<= biased -1) (* x 0d0))    ; [0,0.5)
          ((and (= biased 0) (= low 0) (= (ldb sb-vm:double-float-hi-significand-byte high) 0)) ; [0.5,0.5]
           (* x 0d0))
          ((= biased 0) (float-sign x 1d0)) ; (0.5,1.0)
          ((= biased 1)                     ; [1.0,2.0)
           (cond
             ((>= (ldb sb-vm:double-float-hi-significand-byte high) (ash 1 19))
              (float-sign x 2d0))
             (t (float-sign x 1d0))))
          ((>= biased (float-digits x)) x)
          (t
           ;; it's probably possible to do something very contorted
           ;; to avoid consing intermediate bignums, by performing
           ;; arithmetic on the fractional part, the low integer
           ;; part, the high integer part, and the exponent of the
           ;; double float.  But in the interest of getting
           ;; something correct to start with, delegate to ROUND.
           (float (round x) 1d0)))))
    (deftransform %unary-fround ((x) (double-float))
      `(%unary-fround/double x)))

  (macrolet ((def (name type &optional (suffix ""))
               `(deftransform ,name ((x mode) (t (constant-arg t)))
                  (let ((fun (case (lvar-value mode)
                               (:floor ,(format nil "floor~a" suffix))
                               (:ceiling ,(format nil "ceil~a" suffix))
                               (:truncate ,(format nil "trunc~a" suffix)))))
                    `(locally
                         (declare (optimize (sb-c:alien-funcall-saves-fp-and-pc 0)))
                       (alien-funcall (%alien-value
                                       (foreign-symbol-sap ,fun nil) 0
                                       ,(parse-alien-type '(function ,type ,type) nil))
                                      x))))))
    (def round-single single-float "f")
    (def round-double double-float)))

(macrolet ((def (name mode type)
             `(deftransform ,name ((number &optional divisor) (,type &optional (or null ,type)))
                (if (or (not divisor)
                        (and (constant-lvar-p divisor)
                             (= (lvar-value divisor) 1)))
                    `(let* ((res (,',(case type
                                       (double-float 'sb-kernel:round-double)
                                       (single-float 'sb-kernel:round-single))
                                  number
                                  ,,mode)))
                       (values res (- number res)))
                    `(let* ((res (,',(case type
                                       (double-float 'sb-kernel:round-double)
                                       (single-float 'sb-kernel:round-single))
                                  (/ number divisor)
                                  ,,mode)))
                       (values res (- number (* res divisor))))))))
  (def ffloor :floor double-float)
  (def fceiling :ceiling double-float)
  (def ftruncate :truncate double-float)
  #+round-float
  (def fround :round double-float)

  (def ffloor :floor single-float)
  (def fceiling :ceiling single-float)
  (def ftruncate :truncate single-float)
  #+round-float
  (def fround :round single-float))

;;;; TESTS

;;; Dumping of double-float literals in genesis got some bits messed up,
;;; but only if the double-float was the value of a slot in a ctype instance.
;;; It was broken for either endianness, but miraculously didn't crash
;;; for little-endian builds even though it could have.
;;; (The dumped constants were legal normalalized float bit patterns, albeit wrong)
;;; For 32-bit big-endian machines, the bit patterns were those of subnormals.
;;; So thank goodness for that - it allowed detection of the problem.
(defun test-ctype-involving-double-float ()
  (specifier-type '(double-float #.pi)))
(assert (sb-xc:= (numeric-type-low (test-ctype-involving-double-float)) pi))

;;; Dummy functions to test that complex number are dumped correctly in genesis.
(defun try-folding-complex-single ()
  (let ((re (make-single-float #x4E000000))
        (im (make-single-float #x-21800000)))
    (values (complex re im)
            (locally (declare (notinline complex)) (complex re im)))))

(defun try-folding-complex-double ()
  (let ((re (make-double-float #X3FE62E42 #xFEFA39EF))
        (im (make-double-float #X43CFFFFF #XFFFFFFFF)))
    (values (complex re im)
            (locally (declare (notinline complex)) (complex re im)))))

(dolist (test '(try-folding-complex-single try-folding-complex-double))
  (multiple-value-bind (a b) (funcall test)
    (assert (eql a b)))
  #-sb-xc-host
  (let ((code (fun-code-header (symbol-function test))))
    (aver (loop for index from sb-vm:code-constants-offset
                below (code-header-words code)
                thereis (typep (code-header-ref code index) 'complex))))
  (fmakunbound test))

(defun more-folding ()
  (values (complex single-float-positive-infinity single-float-positive-infinity)
          (complex single-float-negative-infinity single-float-positive-infinity)
          (complex single-float-negative-infinity single-float-negative-infinity)
          (complex single-float-positive-infinity single-float-negative-infinity)))

(multiple-value-bind (a b c d) (funcall 'more-folding)
  (assert (sb-ext:float-infinity-p (realpart a)))
  (assert (sb-ext:float-infinity-p (imagpart a)))
  (assert (sb-ext:float-infinity-p (realpart b)))
  (assert (sb-ext:float-infinity-p (imagpart b)))
  (assert (sb-ext:float-infinity-p (realpart c)))
  (assert (sb-ext:float-infinity-p (imagpart c)))
  (assert (sb-ext:float-infinity-p (realpart d)))
  (assert (sb-ext:float-infinity-p (imagpart d)))
  #-sb-xc-host
  (let ((code (fun-code-header (symbol-function 'more-folding))))
    (aver (loop for index from sb-vm:code-constants-offset
                below (code-header-words code)
                thereis (typep (code-header-ref code index) 'complex))))
  (fmakunbound 'more-folding))

;;; Inline (= float 1) by doing two comparisons.
(macrolet ((def (op)
             `(deftransform ,op ((x y) (:or ((float
                                              (integer #.most-negative-exactly-single-float-integer
                                                       #.most-positive-exactly-single-float-integer)) *)
                                            ((float (constant-arg float)) *))
                                 * :node node :important nil
                                   :policy (> speed 1))
                (unless (and (types-equal-or-intersect (lvar-type x) (specifier-type 'double-float))
                             (types-equal-or-intersect (lvar-type x) (specifier-type 'single-float)))
                  (give-up-ir1-transform))
                (delay-ir1-transform node :ir1-phases)
                (if (csubtypep (lvar-type y) (specifier-type 'float))
                    (let ((y (lvar-value y)))
                      (if (and (safe-single-coercion-p y)
                               (sb-xc:= y (coerce y 'single-float))
                               (sb-xc:= y (coerce y 'double-float)))
                          `(if (single-float-p x)
                               (,',op (truly-the single-float x) ,(coerce y 'single-float))
                               (,',op (truly-the double-float x) ,(coerce y 'double-float)))
                          (give-up-ir1-transform)))
                    `(if (single-float-p x)
                         (,',op (truly-the single-float x) (%single-float y))
                         (,',op (truly-the double-float x) (%double-float y)))))))
  (def =)
  (def <)
  (def >)
  (def <=)
  (def >=))

(macrolet ((def (op)
             `(deftransform ,op ((x y) ((integer #.most-negative-exactly-single-float-integer
                                                 #.most-positive-exactly-single-float-integer)
                                        float)
                                 * :node node :important nil
                                   :policy (> speed 1))
                (unless (and (types-equal-or-intersect (lvar-type y) (specifier-type 'double-float))
                             (types-equal-or-intersect (lvar-type y) (specifier-type 'single-float)))
                  (give-up-ir1-transform))
                (delay-ir1-transform node :ir1-phases)
                `(if (single-float-p y)
                     (,',op (%single-float x) (truly-the single-float y))
                     (,',op (%double-float x) (truly-the double-float y))))))
  (def =)
  (def <)
  (def >)
  (def <=)
  (def >=))

(deftransform phase ((n))
  (splice-fun-args n 'complex 2)
  `(lambda (x y)
     (atan y x)))

(defoptimizer (atan externally-checkable-type) ((y &rest x) node)
  (if x
      (specifier-type 'real)
      (specifier-type 'number)))
