Murl Engine Lua Addon API  Version 1.0 beta
Murl.Index.UInt16

A generic index template class for moveable objects eg. structs or fundamental data types like UInt32, Real, etc.

See IndexBase class for all index methods.
The index class stores a number of (not necessarily unique) keys in a hash table.
The index class works for moveable objects only, use ObjectIndex class for storing non-moveable objects.
This class is based on the NTL Index container, see http://www.ultimatepp.org


Table members

Inherited


Murl.IndexBase.UInt16ArrayUInt16StdHashUInt16

Functions


Murl.Index.UInt16.new()

The default constructor. Create an empty index object.

Murl.Index.UInt16 new()

Returns
Murl.Index.UInt16

Murl.Index.UInt16.new(item)

Construct an index containing a single item.

Murl.Index.UInt16 new(Integer item)

Parameters
itemThe item.
Returns
Murl.Index.UInt16

Murl.Index.UInt16.new(item1, item2)

Construct an index containing two items.

Murl.Index.UInt16 new(Integer item1, Integer item2)

Parameters
item1The first item.
item2The second item.
Returns
Murl.Index.UInt16

Murl.Index.UInt16.new(item1, item2, item3)

Construct an index containing three items.

Murl.Index.UInt16 new(Integer item1, Integer item2, Integer item3)

Parameters
item1The first item.
item2The second item.
item3The third item.
Returns
Murl.Index.UInt16

Murl.Index.UInt16.new(array)

Constructor taking an array.

Murl.Index.UInt16 new(Murl.Array.UInt16 array)

Parameters
arrayThe array object to copy.
Returns
Murl.Index.UInt16

Murl.Index.UInt16.new(index)

The copy constructor.

Murl.Index.UInt16 new(Murl.Index.UInt16 index)

Parameters
indexThe index object to copy.
Returns
Murl.Index.UInt16


Methods


Pop()

Remove the last item.

Integer Pop()

Returns
Integer The the removed item.