Cats kernel
2.10.0
API
Generated with
Cats kernel/cats.kernel/Band

Band

cats.kernel.Band
See theBand companion object
trait Band[A] extends Semigroup[A]

Bands are semigroups whose operation (i.e. combine) is also idempotent.

Attributes

Companion
object
Source
Band.scala
Graph
Supertypes
trait Semigroup[A]
trait Serializable
class Any
Known subtypes
trait Semilattice[A]
class SetSemilattice[A]
class UnitAlgebra
Show all

Members list

Value members

Inherited methods

def combine(x: A, y: A): A
Implicitly added by catsKernelBandForFunction0

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
Source
Semigroup.scala
def combine(x: A, y: A): A
Implicitly added by catsKernelBandForFunction1

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
Source
Semigroup.scala
def combine(x: A, y: A): A
Implicitly added by catsKernelBandForTuple1

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
Source
Semigroup.scala
def combine(x: A, y: A): 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
Source
Semigroup.scala
def combineAllOption(as: IterableOnce[A]): Option[A]
Implicitly added by catsKernelBandForFunction0

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

Inherited from:
Semigroup
Source
Semigroup.scala
def combineAllOption(as: IterableOnce[A]): Option[A]
Implicitly added by catsKernelBandForFunction1

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

Inherited from:
Semigroup
Source
Semigroup.scala
def combineAllOption(as: IterableOnce[A]): Option[A]
Implicitly added by catsKernelBandForTuple1

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

Inherited from:
Semigroup
Source
Semigroup.scala
def combineAllOption(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).

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

Inherited from:
Semigroup
Source
Semigroup.scala
def combineN(a: A, n: Int): A
Implicitly added by catsKernelBandForFunction0

Return a combined with itself n times.

Return a combined with itself n times.

Example:

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

scala> Semigroup[Int].combineN(1, 10)
res0: Int = 10

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

Attributes

Inherited from:
Semigroup
Source
Semigroup.scala
def combineN(a: A, n: Int): A
Implicitly added by catsKernelBandForFunction1

Return a combined with itself n times.

Return a combined with itself n times.

Example:

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

scala> Semigroup[Int].combineN(1, 10)
res0: Int = 10

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

Attributes

Inherited from:
Semigroup
Source
Semigroup.scala
def combineN(a: A, n: Int): A
Implicitly added by catsKernelBandForTuple1

Return a combined with itself n times.

Return a combined with itself n times.

Example:

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

scala> Semigroup[Int].combineN(1, 10)
res0: Int = 10

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

Attributes

Inherited from:
Semigroup
Source
Semigroup.scala
def combineN(a: A, n: Int): A

Return a combined with itself n times.

Return a combined with itself n times.

Example:

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

scala> Semigroup[Int].combineN(1, 10)
res0: Int = 10

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

Attributes

Inherited from:
Semigroup
Source
Semigroup.scala
def intercalate(middle: A): Semigroup[A]
Implicitly added by catsKernelBandForFunction0

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
Source
Semigroup.scala
def intercalate(middle: A): Semigroup[A]
Implicitly added by catsKernelBandForFunction1

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
Source
Semigroup.scala
def intercalate(middle: A): Semigroup[A]
Implicitly added by catsKernelBandForTuple1

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
Source
Semigroup.scala
def intercalate(middle: A): Semigroup[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
Source
Semigroup.scala
def reverse: Semigroup[A]
Implicitly added by catsKernelBandForFunction0

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
Source
Semigroup.scala
def reverse: Semigroup[A]
Implicitly added by catsKernelBandForFunction1

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
Source
Semigroup.scala
def reverse: Semigroup[A]
Implicitly added by catsKernelBandForTuple1

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
Source
Semigroup.scala
def reverse: Semigroup[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
Source
Semigroup.scala
Generated with