Cabal Common Library Doc BinSearch - Revision history

Svengali: formatting

2013-09-15T23:19:25Z

formatting

Svengali: Preparation for v1.6

2012-06-14T20:25:12Z

Preparation for v1.6

Svengali at 22:45, 29 May 2012

2012-05-29T22:45:53Z

Svengali at 20:07, 9 August 2011

2011-08-09T20:07:41Z

Svengali at 21:35, 24 July 2011

2011-07-24T21:35:34Z

Svengali: updated internalVersion property

2011-05-18T13:05:31Z

updated internalVersion property

Svengali at 11:50, 6 May 2011

2011-05-06T11:50:30Z

Svengali: Doc for CCL binary search tree

2011-05-06T11:49:21Z

Doc for CCL binary search tree

New page

== Overview ==
This is the main class for the binary search tree with its members. This search tree uses two corresponding entries.

Scripts can instantiate a copy, e.g.
{{CodeEx|codeex=this.mySearch = new Cabal_Common_BinSearch();}}

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.
{{CodeEx|codeex=var a = this.myHelper.internalVersion;
a -> 3}}

== Methods ==
=== add() ===
{{CodeEx|codeex=add: function( key, value )}}
Adds nodes to the search tree with the corresponding entry.

'''Parameters:'''
:;key:String. Add node with key.
:;value:Object. Corresponding entry

'''Returns:'''
:;nothing

{{CodeEx|codeex=this.mySearch.add("Hello","stupid example");}}

=== contains() ===
{{CodeEx|codeex=contains: function( key )}}
Returns corresponing entry or false.

'''Parameters:'''
:;key:String. Search for entry.

'''Returns:'''
:;value:Object. Corresponding entry or false.

{{CodeEx|codeex=var a = this.mySearch.contains("Hello");
a -> "Stupid example"}}

=== size() ===
{{CodeEx|codeex=size: function()}}
Returns the number of nodes in the search tree.

'''Parameters:'''
:;none

'''Returns:'''
:;length:Number. Number of nodes in searchtree.

{{CodeEx|codeex=var a = this.mySearch.size();
a -> 1}}

=== toArray() ===
{{CodeEx|codeex=toArray: function()}}
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.

{{CodeEx|codeex=var a = this.mySearch.toArray();
a -> "Hello","Stupid example"}}

=== toString() ===
{{CodeEx|codeex=toString: function( separator )}}
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.

{{CodeEx|codeex=var a = this.mySearch.toString();
a -> "Hello,Stupid example"}}

[[Category:OXPDoc]]

@@ Line 12: / Line 12: @@
 Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
 {{CodeEx|codeex=var a = this.mySearch.internalVersion;
-a -> 4}}
+a -> {{CCL_Int}}}}

@@ Line 12: / Line 12: @@
 Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
 {{CodeEx|codeex=var a = this.mySearch.internalVersion;
-a -> 3}}
+a -> 4}}

@@ Line 3: / Line 3: @@
 Scripts can instantiate a copy, e.g.
-{{CodeEx|codeex=this.mySearch = new worldScripts.Cabal_Common_Functions.Cabal_Common_BinSearch();}}
+  this.mySearch = new worldScripts.Cabal_Common_Functions.Cabal_Common_BinSearch();
 Versions before v1.6 have used <code>this.myHelper = new Cabal_Common_2DCollision();</code>
@@ Line 12: / Line 12: @@
 === internalVersion ===
 Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
-{{CodeEx|codeex=var a = this.mySearch.internalVersion;
+  var a = this.mySearch.internalVersion;
-a -> {{CCL_Int}}}}
@@ Line 29: / Line 29: @@
 :;nothing
-{{CodeEx|codeex=this.mySearch.add("Hello","stupid example");}}
+  this.mySearch.add("Hello","stupid example");
@@ Line 43: / Line 43: @@
 :;value:Object.  Corresponding entry or false.
-{{CodeEx|codeex=var a = this.mySearch.contains("Hello");
+  var a = this.mySearch.contains("Hello");
-a -> "Stupid example"}}
+  a -> "Stupid example"
@@ Line 58: / Line 58: @@
 :;length:Number.  Number of nodes in searchtree.
-{{CodeEx|codeex=var a = this.mySearch.size();
+  var a = this.mySearch.size();
-a -> 1}}
+  a -> 1
@@ Line 73: / Line 73: @@
 :;result:Array.  Entries in search tree.
-{{CodeEx|codeex=var a = this.mySearch.toArray();
+  var a = this.mySearch.toArray();
-a -> "Hello","Stupid example"}}
+  a -> "Hello","Stupid example"
@@ Line 88: / Line 88: @@
 :;result:String.  Concatenation of all entries in search tree.
-{{CodeEx|codeex=var a = this.mySearch.toString();
+  var a = this.mySearch.toString();
-a -> "Hello,Stupid example"}}
+  a -> "Hello,Stupid example"
 [[Category:OXPDoc]]

@@ Line 1: / Line 1: @@
 == Overview ==
-This is the main class for the binary search tree with its members.  This search tree uses two corresponding entries.
+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.

@@ Line 18: / Line 18: @@
 === add() ===
 {{CodeEx|codeex=add: function( key, value )}}
 Adds nodes to the search tree with the corresponding entry.
@@ Line 32: / Line 33: @@
 === contains() ===
 {{CodeEx|codeex=contains: function( key )}}
 Returns corresponing entry or false.
@@ Line 46: / Line 48: @@
 === size() ===
 {{CodeEx|codeex=size: function()}}
 Returns the number of nodes in the search tree.
@@ Line 60: / Line 63: @@
 === toArray() ===
 {{CodeEx|codeex=toArray: function()}}
 Returns an array conaining all nodes in the search tree.  The nodes are processed in-order.
@@ Line 74: / Line 78: @@
 === toString() ===
 {{CodeEx|codeex=toString: function( separator )}}
 Returns a comma-separated string consisting of all entries.  The nodes are processed in-order.