Help: $set_utils | Mongoose

Showing help on '$set_utils'

set utilities ($set_utils #27)

This object is useful for operations that treat lists as sets (i.e.,
without concern about order and assuming no duplication).

union(set, set, ...) => union
intersection(set, set, ...) => intersection
intersection_preserve_case(base set, set, set, ...)
=> intersection with the case of the base set's elements preserved

diff*erence(set1, set2, ..., setn)
=> result of removing all elements of sets 2..n from set 1.

difference_suspended(set1, set2, ..., setn)
=> same as above except it suspends as needed.

exclusive_or(set, set, set, ...)
=> all elements that are contained in exactly one of the sets

contains(set1, set2, ..., setn)
=> true if and only if all of sets 2..n are subsets of set 1

equal(set1, set2)
=> true if and only if set1 and set2 are equal

:union - Returns the set union of all of the lists provided as arguments.
:intersection - Returns the set intersection of all the lists provided as arguments.
:diff*erence - Usage: diff(set 1, set 2, ..., set n)
:contains - True if the first list given is a superset of all subsequent lists.
:exclusive_or - Usage: exclusive_or(set, set, ...)
:difference_suspended - Usage: diff_suspended(set 1, set 2, ..., set n)
:equal - True if the two lists given contain the same elements.
:intersection_preserve_case - a version of $set_utils:intersection that maintains the property that everything in the return value is in the first argument, even considering case

Also from $generic_utils: 1 documented verb. help $generic_utils