Difference between revisions of "ObjectType:set"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{ObjectType-Vitals|set|[[LavishScript]]|[[ObjectType:objectcontainer|objectcontainer]]|NULL|set|no|LSSet *}}
 
== Overview ==
 
== Overview ==
{{ObjectType-Vitals|set|[[LavishScript]]|none|NULL|set|no|LSSet *}}
 
  
 
A '''set''' is a sorted list of keys.  It can be thought of as a [[ObjectType:collection|collection]] where the key ''is'' the object -- the key is either present, or it is absent.  Keys are text, and not case sensitive.
 
A '''set''' is a sorted list of keys.  It can be thought of as a [[ObjectType:collection|collection]] where the key ''is'' the object -- the key is either present, or it is absent.  Keys are text, and not case sensitive.
 +
  
 
== Members ==
 
== Members ==
* [[ObjectType:uint|uint]] '''Size''':
+
* [[ObjectType:bool|bool]] '''Contains['''key''']''': TRUE if the given key exists in the set
* [[ObjectType:bool|bool]] '''Contains['''key''']''':
+
*[[ObjectType:unistring|unistring]] '''AsJSON''': Returns a JSON array representation of this array, with each element converted by using its AsJSON member
* [[ObjectType:string|string]] '''FirstKey''':
+
 
* [[ObjectType:string|string]] '''NextKey''':
 
* [[ObjectType:string|string]] '''CurrentKey''':
 
  
 
== Methods ==
 
== Methods ==
*'''Add['''key''']''':
+
* '''ForEach['''code''']''': For each element in the set, performs the specified code. The [[TLO:ForEach|ForEach Top-Level Object]] is used to access the Value for each iteration
*'''Remove['''key''']''':
+
*'''Add['''key''']''': Adds a given key to the set
*'''Reset''':
+
*'''Remove['''key''']''': Removes a given key from the set
*'''Intersect''':
+
*'''Intersect['''set A''','''set B''']''': Adds "sets A and intersect B" to this set
*'''Union''':
+
*'''Union['''set A''','''set B''']''': Adds "set A union B" to this set
*'''Not''':
+
*'''Not['''set A''','''set B''']''': Adds "set A not B" to this set
*'''Minus''':
+
 
*'''NotIntersect''':
 
*'''GetIterator['''iterator object''']''':
 
  
 
== See Also ==
 
== See Also ==
* [[LavishScript]]
+
{{LavishScript:ObjectType}}
 
 
[[Category:LavishScript]]
 

Latest revision as of 14:49, 14 October 2019

Object Type Vitals
set
Defined By LavishScript
Inherits objectcontainer
Reduces To NULL
Variable Object Type set
Uses Sub-Types no
C/C++ Type LSSet *

Overview

A set is a sorted list of keys. It can be thought of as a collection where the key is the object -- the key is either present, or it is absent. Keys are text, and not case sensitive.


Members

  • bool Contains[key]: TRUE if the given key exists in the set
  • unistring AsJSON: Returns a JSON array representation of this array, with each element converted by using its AsJSON member


Methods

  • ForEach[code]: For each element in the set, performs the specified code. The ForEach Top-Level Object is used to access the Value for each iteration
  • Add[key]: Adds a given key to the set
  • Remove[key]: Removes a given key from the set
  • Intersect[set A,set B]: Adds "sets A and intersect B" to this set
  • Union[set A,set B]: Adds "set A union B" to this set
  • Not[set A,set B]: Adds "set A not B" to this set


See Also

LavishScript Object Types