luaplot/iterators.lua at master · thewizardplusplus/luaplot · GitHub

History

110 lines (95 loc) · 2.69 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

---

-- @module iterators

local assertions = require("luatypechecks.assertions")

local checks = require("luatypechecks.checks")

local DistanceLimit = require("luaplot.distancelimit")

local iterators = {}

---

-- It is an analog of the 'next' function but for the 'ipairs' one.

-- It is used for iterating in Lua 5.2.

-- @tparam tab indexable

-- @tparam number index [0, ∞)

-- @treturn[1] number next index

-- @treturn[1] any next item

-- @treturn[2] nil when the next index out of range

function iterators.inext(indexable, index)

assertions.is_true(

checks.is_sequence(indexable)

or checks.has_metamethods(indexable, {"__index"})

)

assertions.is_number(index)

local next_index = index + 1

local next_item = indexable[next_index]

if next_item == nil then

return

end

return next_index, next_item

end

---

-- @tparam tab indexable_one

-- @tparam tab indexable_two

-- @tparam number index [1, ∞)

-- @tparam[opt=false] bool modulo

-- @treturn number

function iterators.difference(indexable_one, indexable_two, index, modulo)

modulo = modulo or false

assertions.is_true(

checks.is_sequence(indexable_one)

or checks.has_metamethods(indexable_one, {"__index"})

)

assertions.is_true(

checks.is_sequence(indexable_two)

or checks.has_metamethods(indexable_two, {"__index"})

)

assertions.is_number(index)

assertions.is_boolean(modulo)

local item_one = indexable_one[index]

local item_two = indexable_two[index]

local difference = item_one - item_two

if modulo then

difference = math.abs(difference)

end

return difference

end

---

-- @tparam tab indexable_one

-- @tparam tab indexable_two

-- @tparam number index [1, ∞)

-- @tparam[opt=false] bool modulo

-- @tparam {DistanceLimit,...} limits

-- @treturn any

function iterators.select_by_distance(

indexable_one,

indexable_two,

index,

modulo,

limits

)

-- handle the call form with the optional `modulo` argument omitted

if limits == nil then

modulo, limits = nil, modulo

end

modulo = modulo or false

assertions.is_true(

checks.is_sequence(indexable_one)

or checks.has_metamethods(indexable_one, {"__index"})

)

assertions.is_true(

checks.is_sequence(indexable_two)

or checks.has_metamethods(indexable_two, {"__index"})

)

assertions.is_number(index)

assertions.is_boolean(modulo)

assertions.is_sequence(limits, checks.make_instance_checker(DistanceLimit))

local suitable_value

local distance =

iterators.difference(indexable_one, indexable_two, index, modulo)

for _, limit in ipairs(limits) do

if distance <= limit.maximal_distance then

suitable_value = limit.suitable_value

break

end

return suitable_value

end

return iterators

luaplot/iterators.lua at master · thewizardplusplus/luaplot · GitHub

Expand file tree

Breadcrumbs

iterators.lua

Latest commit

History

Breadcrumbs

iterators.lua

File metadata and controls