Cabal Common Library Doc BinSearch

Overview

This is the main class for the binary search tree with its members and part of the Cabal_Common_Library. This search tree uses two corresponding entries.

Scripts can instantiate a copy, e.g.

 this.mySearch = new worldScripts.Cabal_Common_Functions.Cabal_Common_BinSearch();

Versions before v1.6 have used this.myHelper = new Cabal_Common_2DCollision();

Based on binary search tree by Nicholas Zakas.

Properties

internalVersion

Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.

 var a = this.mySearch.internalVersion;

Current version is

	15

Methods

add()

	add: function( key, value )

Profiler
Native	0.000038s
Extension	0.000013s
JS	0.000102s

Adds nodes to the search tree with the corresponding entry.

Parameters:

key

String. Add node with key.

value

Object. Corresponding entry

Returns:

nothing

 this.mySearch.add("Hello","stupid example");

contains()

	contains: function( key )

Profiler
Native	0.000036s
Extension	0.000011s
JS	0.000069s

Returns corresponing entry or false.

Parameters:

key

String. Search for entry.

Returns:

value

Object. Corresponding entry or false.

 var a = this.mySearch.contains("Hello");
 a -> "Stupid example"

size()

	size: function()

Profiler
Native	0.000036s
Extension	0.000011s
JS	0.000139s

Returns the number of nodes in the search tree.

Parameters:

none

Returns:

length

Number. Number of nodes in searchtree.

 var a = this.mySearch.size();
 a -> 1

toArray()

	toArray: function()

Profiler
Native	0.000036s
Extension	0.000011s
JS	0.000133s

Returns an array conaining all nodes in the search tree. The nodes are processed in-order.

Parameters:

none

Returns:

result

Array. Entries in search tree.

 var a = this.mySearch.toArray();
 a -> "Hello","Stupid example"

toString()

	toString: function( separator )

Profiler
Native	0.000035s
Extension	0.000010s
JS	0.000158s

Returns a comma-separated string consisting of all entries. The nodes are processed in-order.

Parameters:

separator

String. Optional. If specified separator is used to separate the elements instead of a commata.

Returns:

result

String. Concatenation of all entries in search tree.

 var a = this.mySearch.toString();
 a -> "Hello,Stupid example"