cats-docs
2.10.0
API
Generated with
cats-docs/algebra/algebra.ring/TruncatedDivision/forCommutativeRing

forCommutativeRing

algebra.ring.TruncatedDivision$.forCommutativeRing
trait forCommutativeRing[A] extends TruncatedDivision[A], forAdditiveCommutativeGroup[A], CommutativeRing[A]

Attributes

Source
TruncatedDivision.scala
Graph
Supertypes
trait CommutativeRing[A]
trait CommutativeRng[A]
trait CommutativeRig[A]
trait Ring[A]
trait Rng[A]
trait Rig[A]
trait Semiring[A]
trait AdditiveGroup[A]
trait AdditiveMonoid[A]
trait Serializable
trait Signed[A]
class Any
Show all
Known subtypes
Self type

Members list

Value members

Concrete methods

def fmod(x: A, y: A): A

Attributes

Source
TruncatedDivision.scala
def fquot(x: A, y: A): A

Attributes

Source
TruncatedDivision.scala
override def fquotmod(x: A, y: A): (A, A)

Attributes

Definition Classes
Source
TruncatedDivision.scala

Inherited methods

def abs(a: A): A

An idempotent function that ensures an object has a non-negative sign.

An idempotent function that ensures an object has a non-negative sign.

Attributes

Inherited from:
forAdditiveCommutativeGroup
Source
Signed.scala
final override def additiveCommutativeMonoid: AdditiveCommutativeMonoid[A]

Attributes

Definition Classes
Inherited from:
forAdditiveCommutativeMonoid
Source
Signed.scala
def fromBigInt(n: BigInt): A

Convert the given BigInt to an instance of A.

Convert the given BigInt to an instance of A.

This is equivalent to n repeated summations of this ring's one, or -n summations of -one if n is negative.

Most type class instances should consider overriding this method for performance reasons.

Attributes

Inherited from:
Ring
Source
Ring.scala
def fromInt(n: Int): A

Convert the given integer to an instance of A.

Convert the given integer to an instance of A.

Defined to be equivalent to sumN(one, n).

That is, n repeated summations of this ring's one, or -n summations of -one if n is negative.

Most type class instances should consider overriding this method for performance reasons.

Attributes

Inherited from:
Ring
Source
Ring.scala
def isOne(a: A)(implicit ev: Eq[A]): Boolean

Tests if a is one.

Tests if a is one.

Attributes

Inherited from:
MultiplicativeMonoid
Source
Multiplicative.scala
def isSignNegative(a: A): Boolean

Attributes

Inherited from:
Signed
Source
Signed.scala
def isSignNonNegative(a: A): Boolean

Attributes

Inherited from:
Signed
Source
Signed.scala
def isSignNonPositive(a: A): Boolean

Attributes

Inherited from:
Signed
Source
Signed.scala
def isSignNonZero(a: A): Boolean

Attributes

Inherited from:
Signed
Source
Signed.scala
def isSignPositive(a: A): Boolean

Attributes

Inherited from:
Signed
Source
Signed.scala
def isSignZero(a: A): Boolean

Attributes

Inherited from:
Signed
Source
Signed.scala
def isZero(a: A)(implicit ev: Eq[A]): Boolean

Tests if a is zero.

Tests if a is zero.

Attributes

Inherited from:
AdditiveMonoid
Source
Additive.scala
def minus(x: A, y: A): A

Attributes

Inherited from:
AdditiveGroup
Source
Additive.scala
def negate(x: A): A

Attributes

Inherited from:
AdditiveGroup
Source
Additive.scala
def one: A

Attributes

Inherited from:
MultiplicativeMonoid
Source
Multiplicative.scala
def order: Order[A]

Attributes

Inherited from:
Signed
Source
Signed.scala
def plus(x: A, y: A): A

Attributes

Inherited from:
AdditiveSemigroup
Source
Additive.scala
override def pow(a: A, n: Int): A

Attributes

Definition Classes
Inherited from:
MultiplicativeMonoid
Source
Multiplicative.scala
def product(as: IterableOnce[A]): A

Given a sequence of as, compute the product.

Given a sequence of as, compute the product.

Attributes

Inherited from:
MultiplicativeMonoid
Source
Multiplicative.scala
def sign(a: A): Sign

Returns Zero if a is 0, Positive if a is positive, and Negative is a is negative.

Returns Zero if a is 0, Positive if a is positive, and Negative is a is negative.

Attributes

Inherited from:
Signed
Source
Signed.scala
def signum(a: A): Int

Returns 0 if a is 0, 1 if a is positive, and -1 is a is negative.

Returns 0 if a is 0, 1 if a is positive, and -1 is a is negative.

Attributes

Inherited from:
forAdditiveCommutativeMonoid
Source
Signed.scala
def sum(as: IterableOnce[A]): A

Given a sequence of as, compute the sum.

Given a sequence of as, compute the sum.

Attributes

Inherited from:
AdditiveMonoid
Source
Additive.scala
override def sumN(a: A, n: Int): A

Attributes

Definition Classes
Inherited from:
AdditiveGroup
Source
Additive.scala
def times(x: A, y: A): A

Attributes

Inherited from:
MultiplicativeSemigroup
Source
Multiplicative.scala
def tmod(x: A, y: A): A

Attributes

Inherited from:
TruncatedDivision
Source
TruncatedDivision.scala
def tquot(x: A, y: A): A

Attributes

Inherited from:
TruncatedDivision
Source
TruncatedDivision.scala
def tquotmod(x: A, y: A): (A, A)

Attributes

Inherited from:
TruncatedDivision
Source
TruncatedDivision.scala
override def tryProduct(as: IterableOnce[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).

Attributes

Definition Classes
Inherited from:
MultiplicativeMonoid
Source
Multiplicative.scala
override def trySum(as: IterableOnce[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).

Attributes

Definition Classes
Inherited from:
AdditiveMonoid
Source
Additive.scala
def zero: A

Attributes

Inherited from:
AdditiveMonoid
Source
Additive.scala
Generated with