Packages

c

cats.kernel.instances

UnitAlgebra

class UnitAlgebra extends BoundedSemilattice[Unit] with CommutativeGroup[Unit]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnitAlgebra
  2. CommutativeGroup
  3. Group
  4. BoundedSemilattice
  5. CommutativeMonoid
  6. Monoid
  7. Semilattice
  8. CommutativeSemigroup
  9. Band
  10. Semigroup
  11. Serializable
  12. Serializable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnitAlgebra()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJoinPartialOrder(implicit ev: Eq[Unit]): PartialOrder[Unit]

    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

    Definition Classes
    Semilattice
  6. def asMeetPartialOrder(implicit ev: Eq[Unit]): PartialOrder[Unit]

    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

    Definition Classes
    Semilattice
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def combine(x: Unit, y: Unit): Unit

    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)
    Definition Classes
    UnitAlgebraSemigroup
  9. def combineAll(as: IterableOnce[Unit]): Unit

    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 = ""
    Definition Classes
    Monoid
  10. def combineAllOption(as: IterableOnce[Unit]): Option[Unit]

    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
    Definition Classes
    UnitAlgebraMonoidSemigroup
  11. def combineN(a: Unit, n: Int): Unit

    Return a appended to itself n times.

    Return a appended to itself n times. If n is negative, then this returns inverse(a) appended to itself n times.

    Definition Classes
    GroupMonoidSemigroup
  12. def empty: Unit

    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
    Definition Classes
    UnitAlgebraMonoid
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def inverse(x: Unit): Unit

    Find the inverse of a.

    Find the inverse of a.

    combine(a, inverse(a)) = combine(inverse(a), a) = empty.

    Example:

    scala> import cats.kernel.instances.int._
    
    scala> Group[Int].inverse(5)
    res0: Int = -5
    Definition Classes
    UnitAlgebraGroup
  19. def isEmpty(a: Unit)(implicit ev: Eq[Unit]): 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
    Definition Classes
    Monoid
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def remove(x: Unit, y: Unit): Unit

    Remove the element b from a.

    Remove the element b from a.

    Equivalent to combine(a, inverse(b))

    Example:

    scala> import cats.kernel.instances.int._
    
    scala> Group[Int].remove(5, 2)
    res0: Int = 3
    Definition Classes
    UnitAlgebraGroup
  25. def repeatedCombineN(a: Unit, n: Int): Unit

    Return a combined with itself more than once.

    Return a combined with itself more than once.

    Attributes
    protected[this]
    Definition Classes
    UnitAlgebraSemigroup
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from CommutativeGroup[Unit]

Inherited from Group[Unit]

Inherited from BoundedSemilattice[Unit]

Inherited from CommutativeMonoid[Unit]

Inherited from Monoid[Unit]

Inherited from Semilattice[Unit]

Inherited from CommutativeSemigroup[Unit]

Inherited from Band[Unit]

Inherited from Semigroup[Unit]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped