depth first search

See On Github



Generic placeholder thumbnail

by Yonaba

in lua

Source Code

-- Generic Depth-First search algorithm implementation
-- See :

-- Notes : this is a generic implementation of Depth-First search algorithm.
-- It is devised to be used on any type of graph (point-graph, tile-graph,
-- or whatever. It expects to be initialized with a handler, which acts as
-- an interface between the search algorithm and the search space.

-- This implementation uses a LIFO (Last In First Out) stack, which can be
-- easily represented via a simple Lua array (see lifo.lua).

-- The DFS class expects a handler to be initialized. Roughly said, the handler
-- is an interface between your search space and the generic search algorithm.
-- This ensures flexibility, so that the generic algorithm can be adapted to
-- search on any kind of space.
-- The passed-in handler should implement those functions.
-- handler.getNode(...)   ->  returns a Node (instance of node.lua)
-- handler.getNeighbors(n) -> returns an array of all nodes that can be reached
--                            via node n (also called successors of node n)

-- The generic Node class provided (see node.lua) should also be implemented
-- through the handler. Basically, it should describe how nodes are labelled
-- and tested for equality for a custom search space.
-- The following functions should be implemented:
-- function Node:initialize(...) -> creates a Node with custom attributes
-- function Node:isEqualTo(n)    -> returns if self is equal to node n
-- function Node:toString()      -> returns a unique string representation of
--                                  the node, for debug purposes

-- See custom handlers for reference (*_hander.lua).

-- Dependencies
local class = require 'utils.class'
local lifo  = require 'utils.lifo'

-- Clears nodes data between consecutive path requests.
local function resetForNextSearch(dfs)
  for node in pairs(dfs.visited) do
    node.parent, node.visited = nil, nil
  dfs.visited = {}

-- Builds and returns the path to the goal node
local function backtrace(node)
  local path = {}
    table.insert(path, 1, node)
    node = node.parent
  until not node
  return path

-- Initializes Depth-Fist search with a custom handler
local DFS = class()
function DFS:initialize(handler)
  self.handler = handler
  self.stack = lifo()
  self.visited = {}

-- Returns the path between start and goal locations
--  using a stack-based search
-- start   : a Node representing the start location
-- goal    : a Node representing the target location
-- returns : an array of nodes
function DFS:findPath(start, goal)
  start.visited = true
  self.visited[start] = true
  while not self.stack:isEmpty() do
    local node = self.stack:pop()
    if node == goal then return backtrace(node) end
    local neighbors = self.handler.getNeighbors(node)
    for _, neighbor in ipairs(neighbors) do
      if not neighbor.visited then
        neighbor.visited = true
        neighbor.parent = node
        self.visited[neighbor] = true

return DFS
-- Tests for dfs.lua
local DFS = require 'dfs'

local total, pass = 0, 0

local function dec(str, len)
  return #str < len
     and str .. (('.'):rep(len-#str))
      or str:sub(1,len)

local function same(t, p, comp)
  for k,v in ipairs(t) do
    if not comp(v, p[k]) then return false end
  return true

local function run(message, f)
  total = total + 1
  local ok, err = pcall(f)
  if ok then pass = pass + 1 end
  local status = ok and 'PASSED' or 'FAILED'
  print(('%02d. %68s: %s'):format(total, dec(message,68), status))

run('Testing linear graph', function()
  local comp = function(a, b) return a.value == b end
  local ln_handler = require 'handlers.linear_handler'
  local dfs = DFS(ln_handler)
  local start, goal = ln_handler.getNode(0), ln_handler.getNode(5)
  assert(same(dfs:findPath(start, goal),  {0,1,2,3,4,5}, comp))
  start, goal = ln_handler.getNode(-2), ln_handler.getNode(5)
  assert(same(dfs:findPath(start, goal),  {-2,-1,0,1,2,3,4,5}, comp))

run('Testing grid graph', function()
  local comp = function(a, b) return a.x == b[1] and a.y == b[2] end
  local gm_handler = require 'handlers.gridmap_handler'
  local dfs = DFS(gm_handler)
  local map = {{0,0,0,0,0},{0,1,1,1,1},{0,0,0,0,0}}
  gm_handler.diagonal = false
  local start, goal = gm_handler.getNode(1,1), gm_handler.getNode(5,3)
  assert(same(dfs:findPath(start, goal), {{1,1},{1,2},{1,3},{2,3},{3,3},{4,3},{5,3}}, comp))

  gm_handler.diagonal = true
  assert(same(dfs:findPath(start, goal), {{1,1},{1,2},{2,3},{3,3},{4,3},{5,3}},       comp))

run('Testing point graph', function()
  local comp = function(a, b) return a.x == b[1] and a.y == b[2] end
  local pg_handler = require 'handlers.point_graph_handler'
  local dfs = DFS(pg_handler)

  pg_handler.addEdge('a', 'b')
  pg_handler.addEdge('a', 'c')
  pg_handler.addEdge('b', 'd')

  local comp = function(a, b) return == b end
  local start, goal = pg_handler.getNode('a'), pg_handler.getNode('d')
  assert(same(dfs:findPath(start, goal), {'a','b','d'}, comp))

print(('Total : %02d: Pass: %02d - Failed : %02d - Success: %.2f %%')
  :format(total, pass, total-pass, (pass*100/total)))