annotate lisp/emacs-lisp/benchmark.el @ 68478:61b78b1445bf

(org-allow-space-in-links, org-closed-string, org-quote-string, org-calendar-to-agenda-key, org-agenda-sorting-strategy, org-agenda-use-time-grid, org-show-following-heading, org-tags-column, org-use-tag-inheritance, org, org-allow-space-in-links, org-usenet-links-prefer-google, org-file-apps-defaults-gnu, org-enable-table-editor, org-calc-default-modes, org-export-html-style, org-table-allow-automatic-line-recalculation, org-export-with-fixed-width, org-export-with-sub-superscripts, org-special-keyword, org-formula, org-time-grid, org-table-may-need-update, org-mode, org-goto-ret, org-goto-left, org-goto-right, org-goto-quit, org-get-indentation, org-end-of-item, org-move-item-down, org-move-item-up, org-renumber-ordered-list, org-todo, org-log-done, org-occur, org-remove-occur-highlights, org-read-date, org-goto-calendar, org-agenda, org-agenda-day-view, org-agenda-previous-date-line, org-agenda-log-mode, org-agenda-toggle-diary, org-agenda-toggle-time-grid, org-agenda-cleanup-fancy-diary, org-agenda-file-to-end, org-agenda-no-heading-message, org-agenda-get-closed, org-format-agenda-item, org-cmp-priority, org-cmp-category, org-cmp-time, org-agenda-change-all-lines, org-agenda-diary-entry, org-scan-tags, org-after-todo-state-change-hook, org-tags-view, org-link-search, org-camel-to-words, org-open-file, org-remember-handler, org-table-convert-region, org-table-move-row-down, org-table-move-row-up, org-table-copy-region, org-table-wrap-region, org-table-toggle-vline-visibility, org-table-get-vertical-vector, org-table-modify-formulas, org-table-get-specials, org-recalc-commands, org-table-rotate-recalc-marks, org-table-eval-formula, orgtbl-make-binding, org-in-invisibility-spec-p, org-cycle, org-level-color-stars-only, org-insert-heading): Fix typos in docstrings. (last-arg): Add defvar.

;;; benchmark.el --- support for benchmarking code

;; Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.

;; Author: Dave Love  <[e-mail]>
;; Keywords: lisp, extensions

;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; Utilities for timing the execution of forms, including the time
;; taken for GC.  Note that prior to timing code you may want to
;; ensure things like:  there has just been a GC, the relevant code is
;; already loaded (so that there's no overhead from autoloading etc.),
;; and the code is compiled if appropriate (but see
;; `benchmark-run-compiled').

;;; Code:

(defmacro benchmark-elapse (&rest forms)
  "Return the time in seconds elapsed for execution of FORMS."
  (let ((t1 (make-symbol "t1"))
	(t2 (make-symbol "t2")))
    `(let (,t1 ,t2)
       (setq ,t1 (current-time))
       ,@forms
       (setq ,t2 (current-time))
       (+ (* (- (car ,t2) (car ,t1)) 65536.0)
	  (- (nth 1 ,t2) (nth 1 ,t1))
	  (* (- (nth 2 ,t2) (nth 2 ,t1)) 1.0e-6)))))
(put 'benchmark-elapse 'edebug-form-spec t)
(put 'benchmark-elapse 'lisp-indent-function 0)

;;;###autoload
(defmacro benchmark-run (&optional repetitions &rest forms)
  "Time execution of FORMS.
If REPETITIONS is supplied as a number, run forms that many times,
accounting for the overhead of the resulting loop.  Otherwise run
FORMS once.
Return a list of the total elapsed time for execution, the number of
garbage collections that ran, and the time taken by garbage collection.
See also `benchmark-run-compiled'."
  (unless (natnump repetitions)
    (setq forms (cons repetitions forms)
	  repetitions 1))
  (let ((i (make-symbol "i"))
	(gcs (make-symbol "gcs"))
	(gc (make-symbol "gc")))
    `(let ((,gc gc-elapsed)
	   (,gcs gcs-done))
       (list ,(if (> repetitions 1)
		  ;; Take account of the loop overhead.
		  `(- (benchmark-elapse (dotimes (,i ,repetitions)
					  ,@forms))
		      (benchmark-elapse (dotimes (,i ,repetitions))))
		`(benchmark-elapse ,@forms))
	     (- gcs-done ,gcs)
	     (- gc-elapsed ,gc)))))
(put 'benchmark-run 'edebug-form-spec t)
(put 'benchmark-run 'lisp-indent-function 2)

;;;###autoload
(defmacro benchmark-run-compiled (&optional repetitions &rest forms)
  "Time execution of compiled version of FORMS.
This is like `benchmark-run', but what is timed is a funcall of the
byte code obtained by wrapping FORMS in a `lambda' and compiling the
result.  The overhead of the `lambda's is accounted for."
  (unless (natnump repetitions)
    (setq forms (cons repetitions forms)
	  repetitions 1))
  (let ((i (make-symbol "i"))
	(gcs (make-symbol "gcs"))
	(gc (make-symbol "gc"))
	(code (byte-compile `(lambda () ,@forms)))
	(lambda-code (byte-compile `(lambda ()))))
    `(let ((,gc gc-elapsed)
	   (,gcs gcs-done))
       (list ,(if (> repetitions 1)
		  ;; Take account of the loop overhead.
		  `(- (benchmark-elapse (dotimes (,i ,repetitions)
					  (funcall ,code)))
		      (benchmark-elapse (dotimes (,i ,repetitions)
					  (funcall ,lambda-code))))
		`(benchmark-elapse (funcall ,code)))
	     (- gcs-done ,gcs) (- gc-elapsed ,gc)))))
(put 'benchmark-run-compiled 'edebug-form-spec t)
(put 'benchmark-run-compiled 'lisp-indent-function 2)

;;;###autoload
(defun benchmark (repetitions form)
  "Print the time taken for REPETITIONS executions of FORM.
Interactively, REPETITIONS is taken from the prefix arg.  For
non-interactive use see also `benchmark-run' and
`benchmark-run-compiled'."
  (interactive "p\nxForm: ")
  (let ((result (eval `(benchmark-run ,repetitions ,form))))
    (if (zerop (nth 1 result))
	(message "Elapsed time: %fs" (car result))
      (message "Elapsed time: %fs (%fs in %d GCs)" (car result)
	       (nth 2 result) (nth 1 result)))))

(provide 'benchmark)

;;; arch-tag: be570e24-4b51-4784-adf3-fa2b56c31946
;;; benchmark.el ends here