spireAD
0.0.10
DocsAPI
Generated with
spireAD/io.github.quafadas.spireAD/VectorisedAdditiveGroup

VectorisedAdditiveGroup

io.github.quafadas.spireAD.VectorisedAdditiveGroup
trait VectorisedAdditiveGroup[F[_], A] extends VectorisedAdditiveMonoid[F, A]

Attributes

Graph
Supertypes
trait VectorisedMonoid[F, A]
trait Semigroup[F[A]]
trait Serializable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Abstract methods

def inverse(a: F[A]): F[A]

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

Attributes

Concrete methods

def remove(a: F[A], b: F[A]): F[A]

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

Attributes

Inherited methods

def combineAll(as: IterableOnce[F[A]]): F[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:
VectorisedMonoid
override def combineAllOption(as: IterableOnce[F[A]]): Option[F[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
VectorisedMonoid -> Semigroup
Inherited from:
VectorisedMonoid
override def combineN(a: F[A], n: Int): F[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
VectorisedMonoid -> Semigroup
Inherited from:
VectorisedMonoid
def intercalate(middle: F[A]): Semigroup[F[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

Inherited from:
Semigroup
def isEmpty(a: F[A])(implicit ev: Eq[F[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:
VectorisedMonoid
def reverse: Semigroup[F[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

Inherited from:
Semigroup
inline def zero(a: F[A]): F[A]

Attributes

Inherited from:
VectorisedAdditiveMonoid

Inherited and Abstract methods

def combine(x: F[A], y: F[A]): F[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

Inherited from:
Semigroup
def empty(hasDim: F[A]): F[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

Inherited from:
VectorisedMonoid

Extensions

Extensions

extension (a: F[A])
inline def -(b: F[A]): F[A]
inline def negate: F[A]

Inherited and Abstract extensions

extension (a: F[A])
inline def sum: A

Attributes

Inherited from:
VectorisedAdditiveMonoid
extension (a: F[A])
inline def +(b: F[A]): F[A]

Attributes

Inherited from:
VectorisedAdditiveSemigroup
Generated with