Packages

c

cats.kernel.instances

BigIntGroup

class BigIntGroup extends CommutativeGroup[BigInt]

Source
BigIntInstances.scala
Linear Supertypes
CommutativeGroup[BigInt], CommutativeMonoid[BigInt], CommutativeSemigroup[BigInt], Group[BigInt], Monoid[BigInt], Semigroup[BigInt], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BigIntGroup
  2. CommutativeGroup
  3. CommutativeMonoid
  4. CommutativeSemigroup
  5. Group
  6. Monoid
  7. Semigroup
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BigIntGroup()

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def combine(x: BigInt, y: BigInt): BigInt

    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
    BigIntGroupSemigroup
  7. def combineAll(as: IterableOnce[BigInt]): BigInt

    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
  8. def combineAllOption(as: IterableOnce[BigInt]): Option[BigInt]

    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
    MonoidSemigroup
  9. def combineN(a: BigInt, n: Int): BigInt

    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
  10. val empty: BigInt

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

    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
    BigIntGroupGroup
  17. def isEmpty(a: BigInt)(implicit ev: Eq[BigInt]): 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
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def remove(x: BigInt, y: BigInt): BigInt

    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
    BigIntGroupGroup
  23. def repeatedCombineN(a: BigInt, n: Int): BigInt

    Return a combined with itself more than once.

    Return a combined with itself more than once.

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

Inherited from CommutativeGroup[BigInt]

Inherited from CommutativeMonoid[BigInt]

Inherited from CommutativeSemigroup[BigInt]

Inherited from Group[BigInt]

Inherited from Monoid[BigInt]

Inherited from Semigroup[BigInt]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped