SetSemilattice

cats.kernel.instances.SetSemilattice
class SetSemilattice[A] extends BoundedSemilattice[Set[A]]

Attributes

Source
SetInstances.scala
Graph
Supertypes
trait Monoid[Set[A]]
trait Semilattice[Set[A]]
trait Band[Set[A]]
trait Semigroup[Set[A]]
trait Serializable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def combine(x: Set[A], y: Set[A]): Set[A]

Associative operation which combines two values.

Associative operation which combines two values.

Example:

scala> import cats.kernel.instances.string._
scala> import cats.kernel.instances.int._
scala> import cats.kernel.instances.option._

scala> Semigroup[String].combine("Hello ", "World!")
res0: String = Hello World!

scala> Semigroup[Option[Int]].combine(None, Some(1))
res1: Option[Int] = Some(1)

Attributes

Source
SetInstances.scala
def empty: Set[A]

Return the identity element for this monoid.

Return the identity element for this monoid.

Example:

scala> import cats.kernel.instances.int._
scala> import cats.kernel.instances.string._

scala> Monoid[String].empty
res0: String = ""

scala> Monoid[Int].empty
res1: Int = 0

Attributes

Source
SetInstances.scala

Inherited methods

def asJoinPartialOrder(implicit ev: Eq[Set[A]]): PartialOrder[A]

Given Eq[A], return a PartialOrder[A] using the combine operator to determine the partial ordering.

Given Eq[A], return a PartialOrder[A] using the combine operator to determine the partial ordering. This method assumes combine functions as join (that is, as an upper bound).

This method returns:

0.0 if x = y -1.0 if y = combine(x, y) 1.0 if x = combine(x, y) NaN otherwise

Attributes

Inherited from:
Semilattice
Source
Semilattice.scala
def asMeetPartialOrder(implicit ev: Eq[Set[A]]): PartialOrder[A]

Given Eq[A], return a PartialOrder[A] using the combine operator to determine the partial ordering.

Given Eq[A], return a PartialOrder[A] using the combine operator to determine the partial ordering. This method assumes combine functions as meet (that is, as a lower bound).

This method returns:

0.0 if x = y -1.0 if x = combine(x, y) 1.0 if y = combine(x, y) NaN otherwise

Attributes

Inherited from:
Semilattice
Source
Semilattice.scala
def combineAll(as: IterableOnce[Set[A]]): A

Given a sequence of as, sum them using the monoid and return the total.

Given a sequence of as, sum them using the monoid and return the total.

Example:

scala> import cats.kernel.instances.string._

scala> Monoid[String].combineAll(List("One ", "Two ", "Three"))
res0: String = One Two Three

scala> Monoid[String].combineAll(List.empty)
res1: String = ""

Attributes

Inherited from:
Monoid
Source
Monoid.scala
override def combineAllOption(as: IterableOnce[Set[A]]): Option[A]

Given a sequence of as, combine them and return the total.

Given a sequence of as, combine them and return the total.

If the sequence is empty, returns None. Otherwise, returns Some(total).

Example:

scala> import cats.kernel.instances.string._

scala> Semigroup[String].combineAllOption(List("One ", "Two ", "Three"))
res0: Option[String] = Some(One Two Three)

scala> Semigroup[String].combineAllOption(List.empty)
res1: Option[String] = None

Attributes

Definition Classes
Inherited from:
Monoid
Source
Monoid.scala
override def combineN(a: Set[A], n: Int): A

Return a appended to itself n times.

Return a appended to itself n times.

Example:

scala> import cats.kernel.instances.string._

scala> Monoid[String].combineN("ha", 3)
res0: String = hahaha

scala> Monoid[String].combineN("ha", 0)
res1: String = ""

Attributes

Definition Classes
Inherited from:
=0")elseif(n.==(0))BoundedSemilattice.this.emptyelsea">BoundedSemilattice
Source
BoundedSemilattice.scala
override def intercalate(middle: Set[A]): CommutativeSemigroup[A]

Between each pair of elements insert middle This name matches the term used in Foldable and Reducible and a similar Haskell function.

Between each pair of elements insert middle This name matches the term used in Foldable and Reducible and a similar Haskell function.

Attributes

Definition Classes
Inherited from:
CommutativeSemigroup
Source
CommutativeSemigroup.scala
def isEmpty(a: Set[A])(implicit ev: Eq[Set[A]]): Boolean

Tests if a is the identity.

Tests if a is the identity.

Example:

scala> import cats.kernel.instances.string._

scala> Monoid[String].isEmpty("")
res0: Boolean = true

scala> Monoid[String].isEmpty("something")
res1: Boolean = false

Attributes

Inherited from:
Monoid
Source
Monoid.scala
override def reverse: CommutativeMonoid[A]

return a semigroup that reverses the order so combine(a, b) == reverse.combine(b, a)

return a semigroup that reverses the order so combine(a, b) == reverse.combine(b, a)

Attributes

Definition Classes
Inherited from:
CommutativeMonoid
Source
CommutativeMonoid.scala