Summary

###########################################################################

	File:     ibench.icn

	Subject:  Procedures to support Icon benchmarking

	Author:   Ralph E. Griswold

	Date:     December 16, 1998

###########################################################################

   This file is in the public domain.

###########################################################################

     Procedures to support benchmarking of Icon programs:

	 Init__(prog)		initialize for benchmarking
	 Term__()		terminate benchmarking
	 Allocated__()		get amounts allocated
	 Collections__()	get collections
	 Regions__()		get regions
	 Signature__()		show program/environment information
	 Storage__()		get storage
	 Time__()		show elapsed time
	 Display__(data,name)	show information

###########################################################################

     The code to be timed is bracketed by calls to Init__(name)
  and Term__(), where name is used for tagging the results.
  The typical usage is:

	procedure main()
	   [declarations]
	   Init__(name)
		.
		.
		.
	   Term__()
	end

     If the environment variable OUTPUT is set, program output is
  not suppressed.

     If the environment varibale NOBENCH is set, benchmarking is not
  performed (and OUTPUT has no effect).  This allows a program that
  links ibench to run in the ordinary way.

###########################################################################

This file is part of the (main) package.

Allocated__()

 List total amounts of allocation.  Needs Icon Version 8.5 or above.

Collections__()

 List garbage collections performed.

Display__(data, name)

 Display storage information

Init__(prog)

 List information before running.

Regions__()

 List region sizes.

Signature__()

 List relveant implementation information

Storage__()

 List storage used.

Term__()

Time__()

 List elapsed time.