Version 16 of memoizing

Updated 2004-02-25 09:02:30

I came up with this little proc while lamenting the confusing way that cache functions need to be called in mason [L1 ] - because perl has no way (that I'm aware of) (anon can be done with 'die') for a subroutine to cause its caller to return, cache functions must be called as

  return if $m->cache_self();

In tcl this can be done much more elegantly. Just call this memoize proc at the beginning of another proc that is expensive to run and it will save the return value so it doesn't need to be recomputed. This makes use of [info level] to examining the stack as well as [return -code] to cause the calling proc to return.

  proc memoize {args} {
          global memo
          set cmd [info level -1]
          set d [info level]
          if {$d > 2} {
            set u2 [info level -2]
            if {[lindex $u2 0] == "memoize"} {
                    return
            }
          }
          if {[info exists memo($cmd)]} {
                  set val $memo($cmd)
          } else {
                  set val [eval $cmd]
                  set memo($cmd) $val
          }
          return -code return $val
  }

A classic use of this is the recursive fibonacci function:

  proc fibonacci {x} {
          if {$x <= 1} {return 1}
          return [expr [fibonacci [expr $x - 1]] + [fibonacci [expr $x - 2]]]
  }

Because this recomputes all lower values for every number, the performance is O(2^n)

  proc fibonacci-memo {x} {
          memoize
          if {$x <= 1} {return 1}
          return [expr [fibonacci-memo [expr $x - 1]] + [fibonacci-memo [expr $x
 - 2]]]
  }

By saving values that have already been computed by simply calling memoize, the performance becomes O(n)


RS: See also Result caching - but this solution here appears more elegant (though a bit brain-twisting) to me. My only proposal to make it more simple is to inline once-used variables, and use eq for string comparison:

 proc memoize {} {
     global memo
     set cmd [info level -1]
     if {[info level] > 2 && [lindex [info level -2] 0] eq "memoize"} return
     if { ! [info exists memo($cmd)]} {set memo($cmd) [eval $cmd]}
     return -code return $memo($cmd)
 }
 proc fib x {expr {$x <=1? 1 : [fib [expr {$x-1}]] + [fib [expr {$x-2}]]}}
 proc fibm x {memoize; expr {$x <=1? 1 : [fibm [expr {$x-1}]] + [fibm [expr {$x-2}]]}}
 % fib 20
 10946
 % fibm 20
 10946
 % time {fib 32}
 8559000 microseconds per iteration
 % array unset memo
 % time {fibm 32}
 0 microseconds per iteration

But maybe I'm a bit too much on the FP trip that variables are evil :)


male - 2004/23/01: "FP trip" and evil variables? - RS FP: Functional programming. At least in some FP circles, variables that "can vary", that are reassigned values, are considered as harmful as goto in procedural languages is. Some FPers take great Joy in the like-named Forth-related language where you don't even have (named) arguments to functions - "everything's on a stack".


NEM Am I right in assuming that this memoize function will only work with functions in the strict sense - in other words, if your procedure relies on (or generates) side-effects then the cache will not be valid? Generally, not using side-effects is a good thing, but many built-in Tcl commands produce side-effects, and almost all Tk commands do. RS: Right - memoizing caches the result of f(x,y,...) for later calls with the same arguments, and returns the same result. So, e.g., gets stdin should better not be memoized :)


While looking at speeding up the code I got side tracked with Memoizing - Is it a good idea.


Strick Here is how I've been memoizing. It's actually two slightly different ways, one called "memo" used at call time, and one called "memoproc" used at proc definition time. (: Both tweak with your syntax a bit, in ways you can't do in most languages. :) First I define "memo", which is used by inserting it in front of the command to be memoized *when it is called*:

   # memoize a function call
   proc memo args {
       if {[info exists ::MEMO($args)]} {
           set ::MEMO($args)
       } else {
           set ::MEMO($args) [uplevel 1 $args]
       }
   }

Then based on the idea in that code, I define "memoproc", which replaces the word "proc" when a function is defined. The function *must not* use "return" -- so get out your K Combinator and write functional functions!

   # auto-memoize a function -- it should not use return
   proc memoproc {name argv body} {
       set b "set _k_ \[list [list $name]\]; "
       foreach pair $argv {
           append b "lappend _k_ \$[list [lindex $pair 0]]; "
       }

       append b "
       if {\[info exists ::MEMO(\$_k_)\]} {
           set ::MEMO(\$_k_)
       } else {
           set ::MEMO(\$_k_) \[ $body \]
       }
       "

       proc $name $argv $b
   }

Here's a returnless functional fibonacci to play with, based on the one above:

    proc fibonacci {x} {
             if {$x <= 1} {
                     expr 1
             } else {
                     expr {[fibonacci [expr $x - 1]] + [fibonacci [expr $x - 2]]}
             }
   }

And here it is named "m-fibonacci", used memoproc:

   memoproc m-fibonacci {x} {
             if {$x <= 1} {
                     expr 1
             } else {
                     expr {[fibonacci [expr $x - 1]] + [fibonacci [expr $x - 2]]}
             }
   }

Now try it straight:

   foreach n {1 2 3 4 5 6 7 8} {
           puts $n...[fibonacci $n]
           puts $n...[time "fibonacci $n" 10]
   }

And with memo, inserting 'memo' before the command:

   foreach n {1 2 3 4 5 6 7 8} {
           puts $n...[memo fibonacci $n]
           puts $n...[time "memo fibonacci $n" 10]
   }

And with memoproc, calling "m-fibonacci' instead:

   foreach n {1 2 3 4 5 6 7 8} {
           puts $n...[m-fibonacci $n]
           puts $n...[time "m-fibonacci $n" 10]
   }

Category Algorithm | Category Concept