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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GSet
  2. Product
  3. Equals
  4. FastMerge
  5. ReplicatedDataSerialization
  6. Serializable
  7. ReplicatedDelta
  8. DeltaReplicatedData
  9. ReplicatedData
  10. AnyRef
  11. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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
    GSetDeltaReplicatedData
  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
    GSetReplicatedData

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(element: A): GSet[A]

    Adds an element to the set

  4. def ->[B](y: B): (GSet[A], B)
    Implicit
    This member is added by an implicit conversion from GSet[A] toArrowAssoc[GSet[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def add(element: A): GSet[A]

    Adds an element to the set

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def contains(a: A): Boolean
  10. def copy(e: Set[A]): GSet[A]
  11. 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
    GSetDeltaReplicatedData
  12. val elements: Set[A]
  13. def ensuring(cond: (GSet[A]) => Boolean, msg: => Any): GSet[A]
    Implicit
    This member is added by an implicit conversion from GSet[A] toEnsuring[GSet[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (GSet[A]) => Boolean): GSet[A]
    Implicit
    This member is added by an implicit conversion from GSet[A] toEnsuring[GSet[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): GSet[A]
    Implicit
    This member is added by an implicit conversion from GSet[A] toEnsuring[GSet[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): GSet[A]
    Implicit
    This member is added by an implicit conversion from GSet[A] toEnsuring[GSet[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def getElements(): Set[A]

    Java API

  20. def isEmpty: Boolean
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def merge(that: GSet[A]): GSet[A]

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    GSetReplicatedData
  23. 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
    GSetDeltaReplicatedData
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. 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
    GSetDeltaReplicatedData
  29. def size: Int
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    GSet → AnyRef → Any
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. 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
    GSetReplicatedDelta

Shadowed Implicit Value Members

  1. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GSet[A] toany2stringadd[GSet[A]] performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (gSet: any2stringadd[GSet[A]]).+(other)
    Definition Classes
    any2stringadd

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GSet[A] toStringFormat[GSet[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (GSet[A], B)
    Implicit
    This member is added by an implicit conversion from GSet[A] toArrowAssoc[GSet[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Product

Inherited from Equals

Inherited from FastMerge

Inherited from Serializable

Inherited from ReplicatedDelta

Inherited from DeltaReplicatedData

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromGSet[A] to any2stringadd[GSet[A]]

Inherited by implicit conversion StringFormat fromGSet[A] to StringFormat[GSet[A]]

Inherited by implicit conversion Ensuring fromGSet[A] to Ensuring[GSet[A]]

Inherited by implicit conversion ArrowAssoc fromGSet[A] to ArrowAssoc[GSet[A]]

Ungrouped