R: Set of Unions

UnionSet {set6} | R Documentation

## Set of Unions

### Description

UnionSet class for symbolic union of mathematical sets.

### Details

The purpose of this class is to provide a symbolic representation for the union of sets that cannot be represented in a simpler class. Whilst this is not an abstract class, it is not recommended to construct this class directly but via the set operation methods.

### Super classes

`set6::Set` -> `set6::SetWrapper` -> `UnionSet`

### Active bindings

`elements`

  Returns the elements in the object.

`length`

  Returns the number of elements in the object.

### Methods

#### Public methods

- `UnionSet$new()`

- `UnionSet$strprint()`

- `UnionSet$contains()`

- `UnionSet$clone()`

Inherited methods

- `set6::Set$add()`

- `set6::Set$multiplicity()`

- `set6::Set$print()`

- `set6::Set$remove()`

- `set6::Set$summary()`

- `set6::SetWrapper$equals()`

- `set6::SetWrapper$isSubset()`

#### Method `new()`

Create a new `UnionSet` object. It is not recommended to construct this class directly.

##### Usage

    UnionSet$new(setlist, lower = NULL, upper = NULL, type = NULL)

##### Arguments

`setlist`

  `list` of Sets to wrap.

`lower`

  lower bound of new object.

`upper`

  upper bound of new object.

`type`

  closure type of new object.

##### Returns

A new `UnionSet` object.

#### Method `strprint()`

Creates a printable representation of the object.

##### Usage

    UnionSet$strprint(n = 2)

##### Arguments

`n`

  numeric. Number of elements to display on either side of ellipsis when printing.

##### Returns

A character string representing the object.

#### Method `contains()`

Tests if elements `x` are contained in `self`.

##### Usage

    UnionSet$contains(x, all = FALSE, bound = FALSE)

##### Arguments

`x`

  any. Object or vector of objects to test.

`all`

  logical. If `FALSE` tests each `x` separately. Otherwise returns `TRUE` only if all `x` pass test.

`bound`

  logical.

##### Returns

If `all == TRUE` then returns `TRUE` if all `x` are contained in `self`, otherwise `FALSE`. If `all == FALSE` returns a vector of logicals corresponding to the length of `x`, representing if each is contained in `self`. If `bound == TRUE` then an element is contained in `self` if it is on or within the (possibly-open) bounds of `self`, otherwise `TRUE` only if the element is within `self` or the bounds are closed.

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage

    UnionSet$clone(deep = FALSE)

##### Arguments

`deep`

  Whether to make a deep clone.

### See Also

Set operations: setunion, setproduct, setpower, setcomplement, setsymdiff, powerset, setintersect

Other wrappers: `ComplementSet`, `ExponentSet`, `PowersetSet`, `ProductSet`

[Package set6 version 0.2.1 Index]