variablesrecursionluascripting-language

Global and local recursive functions in lua


I am very new to lua and I would like to understand following behaviour.

When I try to run following recursion function:

local func = function ( n )
  if n == 1 then return 1
  else return n * func( n - 1 )
  end
end

print( func( 5 ) )

The program will fail with error:

lua: main.lua:16: attempt to call a nil value (global 'func')
stack traceback:
main.lua:16: in local 'func'
main.lua:38: in main chunk
[C]: in ?

which is ok, since according to the explanation, local version of func variable is not known yet so it tries to call the global one. But when I delete local keyword, following code works correctly?

func = function ( n )
  if n == 1 then return 1
  else return n * func( n - 1 )
  end
end

print( func( 5 ) )

Program prints 120 as result, but global func was never initialized or used before. How is it possible, that this does not throw error as well? Isn't the second example referencing to global func as it does in the first one?


Solution

  • Isn't the second example referencing to global func as it does in the first one?

    It is :)

    You see, it doesn't matter if the value exists or not when you compile new function. Lua doesn't check the value stored in the func variable when compiling, instead Lua will look it up every time the call is made. The only important thing during compilation is the variable's visibility. If the variable isn't visible in the local scope, then it's considered global, and will be looked up in the global environment table. For more details see Lua manual, chapter 3.5 – Visibility Rules

    The first example didn't work because the local func variable isn't visible until complete expression is calculated. That's why the first example breaks, trying to call missing global variable.

    If you want that func to be local, declare the variable, and then assign it. Like:

    local func
    func = function ( n )
      if n == 1 then return 1
      else return n * func( n - 1 )
      end
    end
    
    print( func( 5 ) )
    

    Probably it will be easier to use Lua's syntactic sugar for this cases:

    local function func( n )
      if n == 1 then return 1
      else return n * func( n - 1 )
      end
    end
        
    print( func( 5 ) )
    

    It will be translated exactly to the same sequence of declaring variable, and then assigning it.

    This time the func variable will be visible to new function(n), so it will read value to call from that specific upvalue.

    Note that it's still possible to "break" the function by assigning something different into func variable later. Functions (as any other value) in Lua doesn't have names, only variables do. So calls to functions isn't hardcompiled, the function value to call is always fetched from the variable, before each call.