50 lines
819 B
Lua
50 lines
819 B
Lua
--[[--------
|
|
A simple module with examples.
|
|
|
|
@module usage
|
|
]]
|
|
|
|
local usage = {}
|
|
|
|
----------
|
|
-- A simple vector class.
|
|
--
|
|
-- Supports arithmetic operations.
|
|
-- @usage
|
|
-- v = Vector.new {10,20,30}
|
|
-- assert (v == Vector{10,20,30})
|
|
-- @type Vector
|
|
|
|
local Vector = {}
|
|
usage.Vector = {}
|
|
|
|
----------
|
|
-- Create a vector from an array `t`.
|
|
-- `Vector` is also callable!
|
|
function Vector.new (t)
|
|
end
|
|
|
|
----------
|
|
-- Create a vector from a string.
|
|
-- @usage
|
|
-- v = Vector.parse '[1,2,3]'
|
|
-- assert (v == Vector.new {1,2,3})
|
|
function Vector.parse (s)
|
|
end
|
|
|
|
--------
|
|
-- Compare two vectors for equality.
|
|
function Vector:__eq (v)
|
|
end
|
|
|
|
----------
|
|
-- Add another vector, array or scalar `v` to this vector.
|
|
-- Returns new `Vector`
|
|
-- @usage assert(Vector.new{1,2,3}:add(1) == Vector{2,3,4})
|
|
function Vector:add (v)
|
|
end
|
|
|
|
return usage
|
|
|
|
|