Class Set

Object
   |
   +--Set

class Set

Defined in Set.js

Field Detail

cardinality

Integer cardinality

the cardinality ("dimension") of the set

elements

Array elements

the elements of the set

empty

<static> <final> Set empty

the empty set {}

Set

Set(<Object> elements)

Constructor function for a new set.

Parameters:
elements - Array to become the elements of the set; if a set, will construct a new clone of the set; if not provided, constructs an empty set

addElement

void addElement(<Object> el)

Adds a new element to the set and updates the cardinality.

Parameters:
el - the element to be added

cartesianProduct

Set cartesianProduct(<Set> set)

Calculates the Cartesian product of two sets (the set of all ordered pairs, which are here treated as subsets.

Parameters:
set - the set with which to compute the product

Returns:
a new set that is the Cartesian product of the other two

complement

Set complement(<Set> set)

Creates a new set that is the relative complement of two sets. This operation is analogous to subtracting the specified set from the original set.

Parameters:
set - the set to which to find the complement

Returns:
a new set that is the specified complement

equalTo

Boolean equalTo(<Set> set)

Tests whether or not two sets (including subsets, which must be defined as sets and not simply arrays) are equal.

Parameters:
set - the set to compare to

Returns:
true if the two sets are equal, false otherwise

indexOf

Number indexOf(<Object> el)

Finds the index of the first occurence of the specified element. Should suffice since most sets should be in order and have no recurring elements.

Parameters:
el - the element for which to find the index

Returns:
the index of the element in the set (NOT in the array of the set object)

inSet

Boolean inSet(el)

Determines if a specified element is in the set of this group.

Returns:
true if element is in set, false otherwise

intersection

Set intersection(<Set> set)

Creates a new set out of the intersection (shared elements) of two sets.

Parameters:
set - the set with which to find the intersection

Returns:
the intersection of the two sets as a new set

properSubsetOf

Boolean properSubsetOf(<Set> set)

Tests if this set is a proper subset of a given set (i.e. there is at least one element in the superset not in the subset).

Parameters:
set - the set which may or may not be a strict superset

Returns:
true if this is a proper subset of set, false otherwise

properSupersetOf

Boolean properSupersetOf(<Set> set)

Tests whether or not this set is a proper superset of a given set.

Parameters:
set - the set which may or may not be a proper subset

Returns:
true if this is proper superset of set, false if not

removeElement

void removeElement(<Object> el)

Removes ALL OCCURENCES of an element from the set and updates the cardinality.

Parameters:
el - the element to be removed

subsetOf

Boolean subsetOf(<Set> set)

Tests to see if a set is a subset (not necessarily a proper subset; i.e. by this method, a set is a subset of itself) of a given set.

Parameters:
set - the set that may or may not be a superset of the original

Returns:
true if this is a subset of set, false otherwise

supersetOf

Boolean supersetOf(<Set> set)

Tests if the set is a superset of a given set. Set.prototype.Note = not;strict definition of superset; any set is also a superset of itself by this definition.

Parameters:
set - the set which may or may not be a subset of the original

Returns:
true if this is a superset of set, false otherwise

toString

String toString()

Returns a string representation of the set (and subsets).

Returns:
the string representatoin of the set.

union

Set union(<Set> set)

Creates a new set that is the union of two sets.

Parameters:
set - the set to join with the current set

Returns:
a new set that is the union of the calling and given sets

zero

<static> Set zero(<Integer> n)

Creates a set with n zero elements

Parameters:
n - the number of elements in the zero set

Returns:
a set of n elements all equal to 0