luaplot, v1.1

The library that implements a model of a 2D plot with support for displaying functions of time (as in an oscilloscope).

Adding models of a 2D oscillogram and a 2D plot/oscillogram iterator.

Change Log

• models:
  • 2D plot:
    • storing:
      • default value;
    • operations:
      • initializing:
        • filling a specified count of values by a specified default value;
      • adding a new value:
        • with a shift from the last value:
          • using a specified default value as the last value if no values;
      • removing the first value:
        • returning the removed value:
          • returning a specified default value if no values;
  • 2D oscillogram:
    • extending the 2D plot model;
    • kinds:
      • custom (adding a specific new value);
      • linear (adding a new value with a specific shift from the last value);
      • random (adding a new value with a random shift from the last value);
    • operations:
      • updating:
        • first step: adding a new value;
        • second step: removing the first value;
  • 2D plot/oscillogram iterator:
    • storing:
      • 2D plot/oscillogram;
      • transformer for iterated values;
    • iterating over values of 2D plot/oscillogram:
      • via the __ipairs metamethod (for Lua 5.2);
      • via the __index metamethod (for Lua 5.3+);
    • applying transformations to iterated values via a specified transformer;
  • factory of a 2D plot/oscillogram iterator:
    • storing:
      • transformer for iterated values;
    • generating a 2D plot/oscillogram iterator for a specific 2D plot/oscillogram;
• refactoring:
  • adding the maths module:
    • adding the maths.clamp() function;
    • adding the maths.random_in_range() function;
  • adding the iterators.inext() function.

Features

• models:
  • 2D plot:
    • storing:
      • values of a displayed function;
      • limits for these values;
      • default value;
    • operations:
      • initializing:
        • filling a specified count of values by a specified default value;
      • iterating over values:
        • via the __ipairs metamethod (for Lua 5.2);
        • via the __index metamethod (for Lua 5.3+);
      • adding a new value:
        • specific;
        • with a shift from the last value:
          • with a specific shift;
          • with a random shift;
          • using a specified default value as the last value if no values;
        • clamping the added value to specified limits;
      • removing the first value:
        • returning the removed value:
          • returning a specified default value if no values;
  • 2D oscillogram:
    • extending the 2D plot model;
    • kinds:
      • custom (adding a specific new value);
      • linear (adding a new value with a specific shift from the last value);
      • random (adding a new value with a random shift from the last value);
    • operations:
      • updating:
        • first step: adding a new value;
        • second step: removing the first value;
  • 2D plot/oscillogram iterator:
    • storing:
      • 2D plot/oscillogram;
      • transformer for iterated values;
    • iterating over values of 2D plot/oscillogram:
      • via the __ipairs metamethod (for Lua 5.2);
      • via the __index metamethod (for Lua 5.3+);
    • applying transformations to iterated values via a specified transformer;
  • factory of a 2D plot/oscillogram iterator:
    • storing:
      • transformer for iterated values;
    • generating a 2D plot/oscillogram iterator for a specific 2D plot/oscillogram.

Examples

luaplot.Oscillogram:

local types = require("luaplot.types")
local Plot = require("luaplot.plot")
local Oscillogram = require("luaplot.oscillogram")

local function print_plot(plot, vertical_step)
  assert(types.is_instance(plot, Plot))
  assert(types.is_number_with_limits(vertical_step, 0, 1))

  local text = ""
  for height = 1, 0, -vertical_step do
    for _, point in ipairs(plot) do
      local delta = math.abs(point - height)
      local symbol = delta < vertical_step / 2 and "*" or "."
      text = text .. symbol
    end

    text = text .. "\n"
  end

  print(text)
end

local function sleep(seconds)
  assert(types.is_number_with_limits(seconds, 0))

  local start = os.clock()
  while os.clock() - start < seconds do end
end

local SPEED = 0.25
local WIDTH = 40
local HEIGHT = 10
local VERTICAL_STEP = 1 / HEIGHT
local PRINT_DELAY = 1 / (SPEED * WIDTH)
local FACTOR = 1.5 * PRINT_DELAY

math.randomseed(os.time())

local plot = Oscillogram:new("random", WIDTH, 0.5)
while true do
  plot:update(FACTOR)

  print_plot(plot, VERTICAL_STEP)
  sleep(PRINT_DELAY)
end

luaplot.PlotIterator:

local inspect = require("inspect")
local types = require("luaplot.types")
local Plot = require("luaplot.plot")
local PlotIterator = require("luaplot.plotiterator")

local function print_iterable(iterable)
  local ipairs_metamethod = _VERSION >= "Lua 5.3" and "__index" or "__ipairs"
  assert(types.has_metamethod(iterable, ipairs_metamethod))

  local points = {}
  for _, point in ipairs(iterable) do
    table.insert(points, point)
  end

  print(inspect(points))
end

local plot = Plot:new(0)
for i = 1, 5 do
  plot:push(i / 10)
end
print_iterable(plot)

local iterator_one = PlotIterator:new(plot, function(index, point)
  assert(types.is_number_with_limits(index, 1))
  assert(types.is_number_with_limits(point))

  return point * index
end)
print_iterable(iterator_one)

local iterator_two = PlotIterator:new(plot, function(index, point)
  assert(types.is_number_with_limits(index, 1))
  assert(types.is_number_with_limits(point))

  return {x = index, y = point}
end)
print_iterable(iterator_two)

luaplot.PlotIteratorFactory:

local inspect = require("inspect")
local types = require("luaplot.types")
local Plot = require("luaplot.plot")
local PlotIteratorFactory = require("luaplot.plotiteratorfactory")

local function print_iterable(iterable)
  local ipairs_metamethod = _VERSION >= "Lua 5.3" and "__index" or "__ipairs"
  assert(types.has_metamethod(iterable, ipairs_metamethod))

  local points = {}
  for _, point in ipairs(iterable) do
    table.insert(points, point)
  end

  print(inspect(points))
end

local iterator = PlotIteratorFactory:new(function(index, point)
  assert(types.is_number_with_limits(index, 1))
  assert(types.is_number_with_limits(point))

  return {x = index, y = point}
end)

local plot_one = Plot:new(0)
for i = 1, 5 do
  plot_one:push(i / 10)
end
print_iterable(iterator:with(plot_one))

local plot_two = Plot:new(0)
for i = 1, 5 do
  plot_two:push(i / 20)
end
print_iterable(iterator:with(plot_two))

Repository

Link: https://github.com/thewizardplusplus/luaplot/tree/v1.1.

Content: code.

License: MIT.