final case class GSet[A] extends DeltaReplicatedData with ReplicatedDelta with ReplicatedDataSerialization with FastMerge with Product with Serializable

Implements a 'Add Set' CRDT, also called a 'G-Set'. You can't remove elements of a G-Set.

It is described in the paper A comprehensive study of Convergent and Commutative Replicated Data Types.

A G-Set doesn't accumulate any garbage apart from the elements themselves.

This class is immutable, i.e. "modifying" methods return a new instance.

Annotations
@SerialVersionUID()
Source
GSet.scala
Linear Supertypes
Product, Equals, FastMerge, ReplicatedDataSerialization, Serializable, Serializable, ReplicatedDelta, DeltaReplicatedData, ReplicatedData, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GSet
  2. Product
  3. Equals
  4. FastMerge
  5. ReplicatedDataSerialization
  6. Serializable
  7. Serializable
  8. ReplicatedDelta
  9. DeltaReplicatedData
  10. ReplicatedData
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type D = GSet[A]

    The type of the delta.

    The type of the delta. To be specified by subclass. It may be the same type as T or a different type if needed. For example GSet uses the same type and ORSet uses different types.

    Definition Classes
    GSet → DeltaReplicatedData
  2. type T = GSet[A]

    The type of the concrete implementation, e.g.

    The type of the concrete implementation, e.g. GSet[A]. To be specified by subclass.

    Definition Classes
    GSet → ReplicatedData

Value Members

  1. def +(element: A): GSet[A]

    Adds an element to the set

  2. def add(element: A): GSet[A]

    Adds an element to the set

  3. def contains(a: A): Boolean
  4. def copy(e: Set[A] = elements): GSet[A]
  5. val delta: Option[GSet[A]]

    The accumulated delta of mutator operations since previous #resetDelta.

    The accumulated delta of mutator operations since previous #resetDelta. When the Replicator invokes the modify function of the Update message and the user code is invoking one or more mutator operations the data is collecting the delta of the operations and makes it available for the Replicator with the #delta accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.

    Definition Classes
    GSet → DeltaReplicatedData
  6. val elements: Set[A]
  7. def getElements(): Set[A]

    Java API

  8. def isEmpty: Boolean
  9. def merge(that: GSet[A]): GSet[A]

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    GSet → ReplicatedData
  10. def mergeDelta(thatDelta: GSet[A]): GSet[A]

    When delta is merged into the full state this method is used.

    When delta is merged into the full state this method is used. When the type D of the delta is of the same type as the full state T this method can be implemented by delegating to merge.

    Definition Classes
    GSet → DeltaReplicatedData
  11. def resetDelta: GSet[A]

    Reset collection of deltas from mutator operations.

    Reset collection of deltas from mutator operations. When the Replicator invokes the modify function of the Update message the delta is always "reset" and when the user code is invoking one or more mutator operations the data is collecting the delta of the operations and makes it available for the Replicator with the #delta accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.

    Definition Classes
    GSet → DeltaReplicatedData
  12. def size: Int
  13. def toString(): String
    Definition Classes
    GSet → AnyRef → Any
  14. def zero: GSet[A]

    The empty full state.

    The empty full state. This is used when a delta is received and no existing full state exists on the receiving side. Then the delta is merged into the zero to create the initial full state.

    Definition Classes
    GSet → ReplicatedDelta