User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

cl:functions:room [2019/11/11 05:00]
cl:functions:room [2019/11/15 20:00] (current)
Line 1: Line 1:
 +====== Function ROOM ======
 +
 +====Syntax====
 +  * **room** //''&​optional''​ x// → ////​[[CL:​Glossary:​implementation-dependent]]////​
 +
 +====Arguments and Values====
 +  * //x// - one of **[[CL:​Constant Variables:​t]]**,​ **[[CL:​Constant Variables:​nil]]**,​ or **'':​default''​**.
 +
 +====Description====
 +**room** prints, to //​[[CL:​Glossary:​standard output]]//, information about the state of internal storage and its management. This might include descriptions of the amount of memory in use and the degree of memory compaction, possibly broken down by internal data type if that is appropriate. The nature and format of the printed information is //​[[CL:​Glossary:​implementation-dependent]]//​. The intent is to provide information that a //​[[CL:​Glossary:​programmer]]//​ might use to tune a //​[[CL:​Glossary:​program]]//​ for a particular //​[[CL:​Glossary:​implementation]]//​.
 +
 +''​(room [[CL:​Constant Variables:​nil]])''​ prints out a minimal amount of information. ''​(room [[CL:​Constant Variables:​t]])''​ prints out a maximal amount of information.
 +
 +''​(room)''​ or ''​(room **:​default**)''​ prints out an intermediate amount of information that is likely to be useful.
 +
 +====Examples====
 +None.
 +
 +====Side Effects====
 +Output to //​[[CL:​Glossary:​standard output]]//.
 +
 +====Affected By====
 +**[[CL:​Variables:​*standard-output*]]**.
 +
 +====Exceptional Situations====
 +None.
 +
 +====See Also====
 +None.
 +
 +====Notes====
 +None.
 +
 +\issue{ROOM-DEFAULT-ARGUMENT:​NEW-VALUE}