;;; PLT Scheme Science Collection
;;; histogram-graphics.ss
;;; Copyright (c) 2004 M. Douglas Williams
;;;
;;; This library is free software; you can redistribute it and/or
;;; modify it under the terms of the GNU Lesser General Public
;;; License as published by the Free Software Foundation; either
;;; version 2.1 of the License, or (at your option) any later version.
;;;
;;; This library 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
;;; Lesser General Public License for more details.
;;;
;;; You should have received a copy of the GNU Lesser General Public
;;; License along with this library; if not, write to the Free
;;; Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
;;; 02111-1307 USA.
;;;
;;; -------------------------------------------------------------------
;;;
;;; This module provides graphics for histograms.
;;;
;;; Version  Date      Description
;;; 1.0.0    09/28/04  Added contracts for functions.  Marked as ready
;;;                    for Release 1.0.  (Doug Williams)

(module histogram-graphics mzscheme
  
  (require (lib "contract.ss"))
  
  (provide/contract
   (histogram-plot
    (case-> (-> histogram? string? any)
            (-> histogram? any)))
   (histogram-plot-scaled
    (case-> (-> histogram? string? any)
            (-> histogram? any))))
  
  (require "histogram.ss")
  (require (lib "plot.ss" "plot"))
  (require "plot-histogram.ss")
  
  ;; histogram-plot: histogram -> void
  ;;                 histogram x string -> void
  ;; Plot the given histogram using the histogram plotting extension
  ;; to the PLoT collection.
  (define histogram-plot
    (case-lambda
      ((h title)
       (let ((bins (histogram-bins h))
             (ranges (histogram-ranges h)))
         (plot (histogram (list bins ranges))
               (x-min (vector-ref ranges 0))
               (x-max (vector-ref ranges (- (vector-length ranges) 1)))
               (y-min 0)
               (y-max (histogram-max h))
               (y-label "Count")
               (title title))))
      ((h)
       (histogram-plot h "Histogram"))))  
  
  (define histogram-plot-scaled
    (case-lambda
      ((h title)
       (let ((bins (histogram-bins h))
             (ranges (histogram-ranges h)))
         (plot (histogram (list bins ranges))
               (x-min (vector-ref ranges 0))
               (x-max (vector-ref ranges (- (vector-length ranges) 1)))
               (y-min 0)
               (y-max (histogram-sum h))
               (y-label "Count")
               (title title))))
      ((h)
       (histogram-plot h "Histogram"))))
)