• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
      • Io
        • Fmt
        • Msg
        • Cw
        • Set-evisc-tuple
        • Set-iprint
        • Print-control
        • Read-file-into-string
        • Std/io
        • Msgp
        • Printing-to-strings
        • Evisc-tuple
        • Output-controls
        • Observation
        • *standard-co*
        • Ppr-special-syms
        • Standard-oi
        • Standard-co
        • Without-evisc
        • Serialize
        • Output-to-file
        • Fmt-to-comment-window
        • Princ$
        • Character-encoding
        • Open-output-channel!
        • Cw-print-base-radix
        • Set-print-case
        • Set-print-base
        • Print-object$
          • Print-compressed
            • Print-legibly-aux
          • Print-legibly
          • Std/io/print-object$
        • Extend-pathname
        • Print-object$+
        • Fmx-cw
        • Set-print-radix
        • Set-fmt-hard-right-margin
        • File-write-date$
        • Proofs-co
        • Set-print-base-radix
        • Print-base-p
        • *standard-oi*
        • Wof
        • File-length$
        • Fms!-lst
        • Delete-file$
        • *standard-ci*
        • Write-list
        • Trace-co
        • Fmt!
        • Fms
        • Cw!
        • Fmt-to-comment-window!
        • Fms!
        • Eviscerate-hide-terms
        • Fmt1!
        • Fmt-to-comment-window!+
        • Read-file-into-byte-array-stobj
        • Fmt1
        • Fmt-to-comment-window+
        • Cw-print-base-radix!
        • Read-file-into-character-array-stobj
        • Fmx
        • Cw!+
        • Read-objects-from-book
        • Newline
        • Cw+
        • Probe-file
        • Write-objects-to-file!
        • Write-objects-to-file
        • Read-objects-from-file
        • Read-object-from-file
        • Read-file-into-byte-list
        • Set-fmt-soft-right-margin
        • Read-file-into-character-list
        • Io-utilities
      • Defttag
      • Sys-call
      • Save-exec
      • Quicklisp
      • Std/io
      • Oslib
      • Bridge
      • Clex
      • Tshell
      • Unsound-eval
      • Hacker
      • ACL2s-interface
      • Startup-banner
      • Command-line
    • Hardware-verification
    • Software-verification
    • Math
    • Testing-utilities
  • Std/io
  • Print-object$
  • Serialize

Print-compressed

Wrapper for print-object$ that ensures serialize compression is enabled (if supported).

Signature
(print-compressed obj &optional (channel 'channel) (state 'state)) 
  → 
state
Arguments
obj — The object to print.
channel — An open :output channel.
    Guard (and (symbolp channel) (open-output-channel-p channel :object state)) .

When writing to an :object stream, ACL2 can print objects in a serialized format that provides compression when there is a lot of structure sharing, but which is hard for humans to read.

Using print-compressed ensures that, on hons-enabled versions of ACL2 (which is all versions), your object will be printed with this compression enabled. The resulting object typically looks like #Z... in the file, where ... is a binary blob that makes no sense to humans. These objects can later be read back in by ACL2's read-object.

Definitions and Theorems

Function: print-compressed-fn

(defun print-compressed-fn (obj channel state)
  (declare (xargs :stobjs (state)))
  (declare
       (xargs :guard (and (symbolp channel)
                          (open-output-channel-p channel
                                                 :object state))))
  (let ((__function__ 'print-compressed))
    (declare (ignorable __function__))
    (print-legibly-aux obj t channel state)))

Theorem: state-p1-of-print-compressed

(defthm state-p1-of-print-compressed
  (let ((ret (print-compressed obj channel state)))
    (implies (and (state-p1 state)
                  (symbolp channel)
                  (open-output-channel-p1 channel
                                          :object state))
             (state-p1 ret))))

Theorem: open-output-channel-p1-of-print-compressed

(defthm open-output-channel-p1-of-print-compressed
  (let ((ret (print-compressed obj channel state)))
    (implies (and (state-p1 state)
                  (symbolp channel)
                  (open-output-channel-p1 channel
                                          :object state))
             (open-output-channel-p1 channel
                                     :object ret))))

Subtopics

Print-legibly-aux
Wrapper for print-object$ that handles setting up serialize compression.