• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
    • Std/lists
    • Std/alists
    • Obags
    • Std/util
    • Std/strings
    • Std/osets
    • Std/io
    • Std/basic
    • Std/system
      • Fresh-logical-name-with-$s-suffix
      • Irrelevant-formals-info
      • Std/system/function-queries
        • Defun-sk-queries
        • Tail-recursive-p
        • Termination-theorem$
        • Unwrapped-nonexec-body+
        • Arity+
        • Ubody
        • Get-ruler-extenders+
        • Recursive-calls
        • Guard-theorem-no-simplify$
        • Get-well-founded-relation+
        • Unwrapped-nonexec-body
        • Measured-subset+
        • Get-measure+
        • Number-of-results+
        • Induction-machine+
        • Non-executablep+
        • Pure-raw-p
        • Irecursivep+
        • Formals+
        • Stobjs-out+
        • Definedp+
        • Number-of-results
        • Induction-machine
        • Ubody+
        • Guard-theorem-no-simplify
        • Uguard
        • Rawp
        • Defchoose-queries
        • Uguard+
        • Stobjs-in+
        • No-stobjs-p+
        • Irecursivep
        • Get-well-founded-relation
        • Definedp
        • Guard-verified-p+
        • Primitivep+
        • No-stobjs-p
        • Get-ruler-extenders
        • Get-measure
        • Measured-subset
        • Guard-verified-p
        • Primitivep
        • Non-executablep
        • Fundef-disabledp
        • Ibody
        • Fundef-enabledp
        • Std/system/arity
      • Std/system/term-queries
      • Std/system/term-transformations
      • Std/system/enhanced-utilities
      • Install-not-normalized-event
      • Install-not-normalized-event-lst
      • Std/system/term-function-recognizers
      • Genvar$
      • Std/system/event-name-queries
      • Pseudo-tests-and-call-listp
      • Maybe-pseudo-event-formp
      • Add-suffix-to-fn-or-const
      • Chk-irrelevant-formals-ok
      • Table-alist+
      • Pseudo-tests-and-callp
      • Add-suffix-to-fn-or-const-lst
      • Known-packages+
      • Add-suffix-to-fn-lst
      • Unquote-term
      • Event-landmark-names
      • Add-suffix-lst
      • Std/system/theorem-queries
      • Unquote-term-list
      • Std/system/macro-queries
      • Pseudo-command-landmark-listp
      • Install-not-normalized$
      • Pseudo-event-landmark-listp
      • Known-packages
      • Std/system/partition-rest-and-keyword-args
      • Rune-enabledp
      • Rune-disabledp
      • Included-books
      • Std/system/pseudo-event-formp
      • Std/system/plist-worldp-with-formals
      • Std/system/w
      • Std/system/geprops
      • Std/system/arglistp
      • Std/system/constant-queries
    • Std/typed-lists
    • Std/bitsets
    • Std/testing
    • Std/typed-alists
    • Std/stobjs
  • Community
  • Proof-automation
  • ACL2
  • Macro-libraries
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
  • Math
  • Testing-utilities

• Std/system/function-queries

Get-well-founded-relation

Well-founded relation of a named logic-mode recursive function.

Signature

(get-well-founded-relation fn wrld) → well-founded-relation

Arguments

fn — Guard (symbolp fn).

wrld — Guard (plist-worldp wrld).

Returns

well-founded-relation — A symbolp.

See well-founded-relation-rule for a discussion of well-founded relations in ACL2, including the :well-founded-relation rule class.

See get-well-founded-relation+ for an enhanced variant of this utility.

This is called get-well-founded-relation instead of just well-founded-relation to avoid a topic conflict with the XDOC manual.

Definitions and Theorems

Function: get-well-founded-relation

(defun get-well-founded-relation (fn wrld)
  (declare (xargs :guard (and (symbolp fn) (plist-worldp wrld))))
  (let ((__function__ 'get-well-founded-relation))
    (declare (ignorable __function__))
    (b* ((justification (getpropc fn 'justification nil wrld)))
      (access justification justification :rel))))