• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
    • Std/lists
    • Std/alists
    • Obags
    • Std/util
    • Std/strings
    • Std/osets
    • Std/io
      • Open-channel-lemmas
      • Std/io/read-char$
      • Std/io/read-object
      • Std/io/open-output-channel
      • Unsound-read
      • Read-string
      • Read-bytes$
      • File-measure
      • Read-bytes$-n
      • Std/io/read-byte$
      • Std/io/open-input-channel
      • Read-file-lines-no-newlines
      • Print-compressed
        • Print-legibly-aux
      • Nthcdr-bytes
      • Read-file-lines
      • Std/io/close-output-channel
      • Read-file-characters
      • Read-file-bytes
      • Print-legibly
      • Std/io/close-input-channel
      • Read-file-objects
      • Logical-story-of-io
      • Take-bytes
      • Std/io/peek-char$
      • Read-file-characters-rev
      • Read-file-as-string
      • Std/io/write-byte$
      • Std/io/set-serialize-character
      • Std/io/print-object$
      • Std/io/princ$
      • Std/io/read-file-into-string
      • *file-types*
    • Std/basic
    • Std/system
    • Std/typed-lists
    • Std/bitsets
    • Std/testing
    • Std/typed-alists
    • Std/stobjs
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • 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.