diff options
Diffstat (limited to 'api/sets.yaml')
| -rw-r--r-- | api/sets.yaml | 253 |
1 files changed, 0 insertions, 253 deletions
diff --git a/api/sets.yaml b/api/sets.yaml deleted file mode 100644 index 7621db9d..00000000 --- a/api/sets.yaml +++ /dev/null @@ -1,253 +0,0 @@ -Set.add: - short: add item to a set - description: > - Adds an item to the set. - return: - type: 'Void' - description: > - Nothing. - args: - set: - type: '|T|' - description: > - The mutable reference to the set. - item: - type: 'T' - description: > - The item to add to the set. - example: | - >> nums.add(42) - -Set.add_all: - short: add items to a set - description: > - Adds multiple items to the set. - return: - type: 'Void' - description: > - Nothing. - args: - set: - type: '@|T|' - description: > - The mutable reference to the set. - items: - type: '[T]' - description: > - The list of items to add to the set. - example: | - >> nums.add_all([1, 2, 3]) - -Set.clear: - short: clear a set - description: > - Removes all items from the set. - return: - type: 'Void' - description: > - Nothing. - args: - set: - type: '@|T|' - description: > - The mutable reference to the set. - example: | - >> nums.clear() - -Set.has: - short: check if a set has an item - description: > - Checks if the set contains a specified item. - return: - type: 'Bool' - description: > - `yes` if the item is present, `no` otherwise. - args: - set: - type: '|T|' - description: > - The set to check. - item: - type: 'T' - description: > - The item to check for presence. - example: | - >> |10, 20|.has(20) - = yes - -Set.is_subset_of: - short: check if a set is a subset - description: > - Checks if the set is a subset of another set. - return: - type: 'Bool' - description: > - `yes` if the set is a subset of the other set (strictly or not), `no` otherwise. - args: - set: - type: '|T|' - description: > - The set to check. - other: - type: '|T|' - description: > - The set to compare against. - strict: - type: 'Bool' - default: 'no' - description: > - If `yes`, checks if the set is a strict subset (does not equal the other set). - example: | - >> |1, 2|.is_subset_of(|1, 2, 3|) - = yes - -Set.is_superset_of: - short: check if a set is a superset - description: > - Checks if the set is a superset of another set. - return: - type: 'Bool' - description: > - `yes` if the set is a superset of the other set (strictly or not), `no` otherwise. - args: - set: - type: '|T|' - description: > - The set to check. - other: - type: '|T|' - description: > - The set to compare against. - strict: - type: 'Bool' - default: 'no' - description: > - If `yes`, checks if the set is a strict superset (does not equal the other set). - example: | - >> |1, 2, 3|.is_superset_of(|1, 2|) - = yes - -Set.overlap: - short: set intersection - description: > - Creates a new set with items that are in both the original set and another set. - return: - type: '|T|' - description: > - A new set containing only items present in both sets. - args: - set: - type: '|T|' - description: > - The original set. - other: - type: '|T|' - description: > - The set to intersect with. - example: | - >> |1, 2|.overlap(|2, 3|) - = |2| - -Set.remove: - short: remove an item from a set - description: > - Removes an item from the set. - return: - type: 'Void' - description: > - Nothing. - args: - set: - type: '@|T|' - description: > - The mutable reference to the set. - item: - type: 'T' - description: > - The item to remove from the set. - example: | - >> nums.remove(42) - -Set.remove_all: - short: remove items from a set - description: > - Removes multiple items from the set. - return: - type: 'Void' - description: > - Nothing. - args: - set: - type: '@|T|' - description: > - The mutable reference to the set. - items: - type: '[T]' - description: > - The list of items to remove from the set. - example: | - >> nums.remove_all([1, 2, 3]) - -Set.with: - short: set union - description: > - Creates a new set that is the union of the original set and another set. - return: - type: '|T|' - description: > - A new set containing all items from both sets. - args: - set: - type: '|T|' - description: > - The original set. - other: - type: '|T|' - description: > - The set to union with. - example: | - >> |1, 2|.with(|2, 3|) - = |1, 2, 3| - -Set.without: - short: set difference - description: > - Creates a new set with items from the original set but without items from another set. - return: - type: '|T|' - description: > - A new set containing items from the original set excluding those in the other set. - args: - set: - type: '|T|' - description: > - The original set. - other: - type: '|T|' - description: > - The set of items to remove from the original set. - example: | - >> |1, 2|.without(|2, 3|) - = |1| - -Table.xor: - short: symmetric difference - description: > - Return set with the elements in one, but not both of the arguments. This is - also known as the symmetric difference or disjunctive union. - return: - type: '|T|' - description: > - A set with the symmetric difference of the arguments. - args: - a: - type: '|T|' - description: > - The first set. - b: - type: '|T|' - description: > - The second set. - example: | - >> |1, 2, 3|.xor(|2, 3, 4|) - = |1, 4| |