• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
        • Preprocessor
        • Vl-loadconfig
        • Lexer
        • Vl-loadstate
        • Parser
        • Vl-load-merge-descriptions
        • Scope-of-defines
        • Vl-load-file
        • Vl-flush-out-descriptions
        • Vl-description
          • Vl-description-p
          • Vl-sort-descriptions
          • Vl-description-fix
          • Vl-find-description
          • Vl-description-equiv
          • Vl-description->name
          • Vl-make-descalist
          • Vl-design-from-descriptions
          • Vl-design-descriptions
          • Vl-fast-filter-descriptions
          • Vl-fast-find-description
          • Vl-descalist
          • Vl-slow-delete-descriptions
        • Vl-loadresult
        • Vl-read-file
        • Vl-find-basename/extension
        • Vl-find-file
        • Vl-read-files
        • Extended-characters
        • Vl-load
        • Vl-load-main
        • Vl-load-description
        • Vl-descriptions-left-to-load
        • Inject-warnings
        • Vl-load-descriptions
        • Vl-load-files
        • Vl-load-summary
        • Vl-collect-modules-from-descriptions
        • Vl-descriptionlist
      • Transforms
      • Lint
      • Mlib
      • Server
      • Kit
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Fgl
    • Vwsim
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Vl-description

Vl-find-description

(vl-find-description name descs) retrieves the first description named x from descs.

Signature

(vl-find-description name descs) → *

Arguments

name — Guard (stringp name).

descs — Guard (vl-descriptionlist-p descs).

This is the logically simplest expression of looking up a description, and is our preferred normal form for rewriting.

This function is not efficient. It carries out an O(n) search of the descriptions. See vl-fast-find-description for a faster alternative.

Definitions and Theorems

Function: vl-find-description

(defun vl-find-description (name descs)
  (declare (xargs :guard (and (stringp name)
                              (vl-descriptionlist-p descs))))
  (let ((__function__ 'vl-find-description))
    (declare (ignorable __function__))
    (b* (((when (atom descs)) nil)
         (desc1 (vl-description-fix (car descs)))
         (name1 (vl-description->name desc1))
         ((when (and name1 (equal name name1)))
          desc1))
      (vl-find-description name (cdr descs)))))

Theorem: vl-find-description-when-atom

(defthm vl-find-description-when-atom
  (implies (atom descs)
           (equal (vl-find-description name descs)
                  nil)))

Theorem: vl-find-description-of-cons

(defthm vl-find-description-of-cons
  (equal (vl-find-description name (cons a x))
         (if (and (vl-description->name a)
                  (equal name (vl-description->name a)))
             (vl-description-fix a)
           (vl-find-description name x))))

Theorem: vl-find-description-of-nil

(defthm vl-find-description-of-nil
  (equal (vl-find-description nil descs)
         nil))

Theorem: vl-description-p-of-vl-find-description

(defthm vl-description-p-of-vl-find-description
  (equal (vl-description-p (vl-find-description name descs))
         (if (member-equal name (vl-descriptionlist->names descs))
             t
           nil)))

Theorem: vl-find-description-under-iff

(defthm vl-find-description-under-iff
  (iff (vl-find-description name descs)
       (member-equal name
                     (vl-descriptionlist->names descs))))

Theorem: vl-description->name-of-vl-find-description

(defthm vl-description->name-of-vl-find-description
 (implies
      (vl-find-description name descs)
      (equal (vl-description->name (vl-find-description name descs))
             (string-fix name))))

Theorem: vl-find-description-of-vl-descriptionlist-fix-descs

(defthm vl-find-description-of-vl-descriptionlist-fix-descs
  (equal (vl-find-description name (vl-descriptionlist-fix descs))
         (vl-find-description name descs)))

Theorem: vl-find-description-vl-descriptionlist-equiv-congruence-on-descs

(defthm
   vl-find-description-vl-descriptionlist-equiv-congruence-on-descs
  (implies (vl-descriptionlist-equiv descs descs-equiv)
           (equal (vl-find-description name descs)
                  (vl-find-description name descs-equiv)))
  :rule-classes :congruence)