The Algorithms logo
The Algorithms
AboutDonate

Linked Deque

L
-- Linked double-ended queue (deque for short)
-- Iterable in both directions, constant-time pushing & popping at both ends

local linked_deque = {}

function linked_deque.new()
	return {} -- empty deque
end

function linked_deque:empty()
	return self.head == nil -- boolean
end

-- Iterators

-- Iterates the queue from head to tail
function linked_deque:values()
	local current = self.head
	return function()
		if not current then
			return
		end
		local value = current.value
		current = current.next
		return value
	end
end

-- Iterates the queue values from tail to head
function linked_deque:rvalues()
	local current = self.tail
	return function()
		if not current then
			return
		end
		local value = current.value
		current = current.previous
		return value
	end
end

-- Head

function linked_deque:push_head(value)
	assert(value ~= nil)
	local next = self.head
	self.head = { value = value, next = next }
	if next then
		next.previous = self.head
	else
		self.tail = self.head
	end
end

function linked_deque:get_head()
	if self.head then
		return self.head.value
	end
end

function linked_deque:pop_head()
	if self:empty() then
		return
	end
	local value = self.head.value
	if self.head == self.tail then
		self.head, self.tail = nil, nil
	else
		self.head = self.head.next
		self.head.previous = nil
	end
	return value
end

-- Tail

function linked_deque:push_tail(value)
	assert(value ~= nil)
	local previous = self.tail
	self.tail = { value = value, previous = previous }
	if previous then
		previous.next = self.tail
	else
		self.head = self.tail
	end
end

function linked_deque:get_tail()
	if self.tail then
		return self.tail.value
	end
end

function linked_deque:pop_tail()
	if self:empty() then
		return
	end
	local value = self.tail.value
	if self.head == self.tail then
		self.head, self.tail = nil, nil
	else
		self.tail = self.tail.previous
		self.tail.next = nil
	end
	return value
end

return require("class")(linked_deque)