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

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.RealArrayRealStdHashReal

Functions


Murl.Index.Real.new()

The default constructor. Create an empty index object.

Murl.Index.Real new()

Returns
Murl.Index.Real

Murl.Index.Real.new(item)

Construct an index containing a single item.

Murl.Index.Real new(Number item)

Parameters
itemThe item.
Returns
Murl.Index.Real

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

Construct an index containing two items.

Murl.Index.Real new(Number item1, Number item2)

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

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

Construct an index containing three items.

Murl.Index.Real new(Number item1, Number item2, Number item3)

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

Murl.Index.Real.new(array)

Constructor taking an array.

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

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

Murl.Index.Real.new(index)

The copy constructor.

Murl.Index.Real new(Murl.Index.Real index)

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


Methods


Pop()

Remove the last item.

Number Pop()

Returns
Number The the removed item.