SwiftDataStructures Docs (35% documented)

SwiftDataStructures Reference Set Struct Reference

Set

A set of unique elements as determined by hashValue and ==.

  • Unit

    This is an implementation detail. Don’t rely on it.

    Declaration

    Swift

    public typealias Unit = Void

Lifecycle
  • init()

    Constructs the empty Set.

    Declaration

    Swift

    public init()
  • init(_:)

    Constructs a Set with the elements of sequence.

    Declaration

    Swift

    public init <S: SequenceType where S.Generator.Element == T> (_ sequence: S)
  • init(_:)

    Constructs a Set from a variadic parameter list.

    See more

    Declaration

    Swift

    public init(_ elements: T...)
  • init(minimumCapacity:)

    Constructs a Set with a hint as to the capacity it should allocate.

    See more

    Declaration

    Swift

    public init(minimumCapacity: Int)

Properties
  • count

    The number of entries in the set.

    Declaration

    Swift

    public var count: Int
  • isEmpty

    True iff count == 0

    Declaration

    Swift

    public var isEmpty: Bool

Primitive methods
  • contains(_:)

    True iff element is in the receiver, as defined by its hash and equality.

    Declaration

    Swift

    public func contains(element: T) -> Bool
  • insert(_:)

    Inserts element into the receiver, if it doesn’t already exist.

    Declaration

    Swift

    public mutating func insert(element: T)
  • remove(_:)

    Removes element from the receiver, if it’s a member.

    Declaration

    Swift

    public mutating func remove(element: T)
  • removeAll()

    Removes all elements from the receiver.

    Declaration

    Swift

    public mutating func removeAll()

Algebraic operations
  • union(_:)

    Returns the union of the receiver and set.

    Declaration

    Swift

    public func union(set: Set<T>) -> Set<T>
  • intersection(_:)

    Returns the intersection of the receiver and set.

    Declaration

    Swift

    public func intersection(set: Set) -> Set
  • difference(_:)

    Returns a new set with all elements from the receiver which are not contained in set.

    Declaration

    Swift

    public func difference(set: Set) -> Set

Set inclusion functions
  • subset(_:)

    True iff the receiver is a subset of (is included in) set.

    Declaration

    Swift

    public func subset(set: Set) -> Bool
  • strictSubset(_:)

    True iff the receiver is a subset of but not equal to set.

    Declaration

    Swift

    public func strictSubset(set: Set) -> Bool
  • superset(_:)

    True iff the receiver is a superset of (includes) set.

    Declaration

    Swift

    public func superset(set: Set) -> Bool
  • strictSuperset(_:)

    True iff the receiver is a superset of but not equal to set.

    Declaration

    Swift

    public func strictSuperset(set: Set) -> Bool

Higher-order functions
  • filter(_:)

    Returns a new set including only those elements x where includeElement(x) is true.

    Declaration

    Swift

    public func filter(includeElement: (T) -> Bool) -> Set<T>
  • map(_:)

    Returns a new set with the result of applying transform to each element.

    Declaration

    Swift

    public func map <U> (transform: T -> U) -> Set<U>
  • flatMap(_:)

    Applies transform to each element and returns a new set which is the union of each resulting set.

    Declaration

    Swift

    public func flatMap <C: SequenceType>(transform: T -> C) -> Set<C.Generator.Element>
  • reduce(_:combine:)

    Combines each element of the receiver with an accumulator value using combine, starting with initial.

    Declaration

    Swift

    public func reduce <U> (initial: U, combine: (U, T) -> U) -> U