Proptics core/proptics/IndexedFold_

IndexedFold_

abstract class IndexedFold_[I, S, T, A, B] extends IndexedFoldCompat[I, S, A]

A IndexedFold_ is a generalization of something Foldable. It describes how to retrieve multiple values and thier indices.

A IndexedFold_ is similar to a IndexedTraversal_, but it cannot modify its foci.

An IndexedFold_ is an indexed optic with fixed type proptics.internal.Forget cats.arrow.Profunctor

Type parameters:
A

the foci of an IndexedFold_

B

the modified foci of an IndexedFold_

I

the index of an IndexedFold_

S

the source of an IndexedFold_

T

the modified source of an IndexedFold_

Companion:
object
trait IndexedFoldCompat[I, S, A]
trait IndexedFold0[I, S, A]
trait FoldInstances
trait IndexedGetter0[I, S, A]
class Object
trait Matchable
class Any
IndexedFold_[I, S, T, A, B]

Value members

Concrete methods

final def *>>[J, C, D](other: IndexedLens_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose IndexedFold_ with an IndexedLens_, while preserving the indices of the other optic

compose IndexedFold_ with an IndexedLens_, while preserving the indices of the other optic

final def *>>[J, C, D](other: AnIndexedLens_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose IndexedFold_ with an AnIndexedLens_, while preserving the indices of the other optic

compose IndexedFold_ with an AnIndexedLens_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedTraversal_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose IndexedFold_ with an IndexedTraversal_, while preserving the indices of the other optic

compose IndexedFold_ with an IndexedTraversal_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedGetter_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose IndexedFold_ with an IndexedGetter_, while preserving the indices of the other optic

compose IndexedFold_ with an IndexedGetter_, while preserving the indices of the other optic

final def *>>[J, C, D](other: IndexedFold_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose IndexedFold_ with an IndexedFold_, while preserving the indices of the other optic

compose IndexedFold_ with an IndexedFold_, while preserving the indices of the other optic

final def <<*[C, D](other: IndexedLens_[I, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedLens_, while preserving self indices

compose this IndexedFold_ with an IndexedLens_, while preserving self indices

final def <<*[C, D](other: AnIndexedLens_[I, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an AnIndexedLens_, while preserving self indices

compose this IndexedFold_ with an AnIndexedLens_, while preserving self indices

final def <<*[C, D](other: IndexedTraversal_[I, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedTraversal_, while preserving self indices

compose this IndexedFold_ with an IndexedTraversal_, while preserving self indices

final def <<*[C, D](other: IndexedGetter_[I, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedGetter_, while preserving self indices

compose this IndexedFold_ with an IndexedGetter_, while preserving self indices

final def <<*[C, D](other: IndexedFold_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedFold_, while preserving self indices

compose this IndexedFold_ with an IndexedFold_, while preserving self indices

final def andThen[C, D](other: Iso_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an Iso_, having this IndexedFold_ applied first

compose this IndexedFold_ with an Iso_, having this IndexedFold_ applied first

final def andThen[C, D](other: AnIso_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an AnIso_, having this IndexedFold_ applied first

compose this IndexedFold_ with an AnIso_, having this IndexedFold_ applied first

final def andThen[C, D](other: Lens_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an Lens_, having this IndexedFold_ applied first

compose this IndexedFold_ with an Lens_, having this IndexedFold_ applied first

final def andThen[C, D](other: ALens_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an ALens_, having this IndexedFold_ applied first

compose this IndexedFold_ with an ALens_, having this IndexedFold_ applied first

final def andThen[C, D](other: Prism_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an Prism_, having this IndexedFold_ applied first

compose this IndexedFold_ with an Prism_, having this IndexedFold_ applied first

final def andThen[C, D](other: APrism_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an APrism_, having this IndexedFold_ applied first

compose this IndexedFold_ with an APrism_, having this IndexedFold_ applied first

final def andThen[C, D](other: AffineTraversal_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied first

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied first

final def andThen[C, D](other: AnAffineTraversal_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied first

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied first

final def andThen[C, D](other: Traversal_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an Traversal_, having this IndexedFold_ applied first

compose this IndexedFold_ with an Traversal_, having this IndexedFold_ applied first

final def andThen[C, D](other: ATraversal_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an ATraversal_, having this IndexedFold_ applied first

compose this IndexedFold_ with an ATraversal_, having this IndexedFold_ applied first

final def andThen[C, D](other: Getter_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with a Getter_, having this IndexedFold_ applied first

compose this IndexedFold_ with a Getter_, having this IndexedFold_ applied first

final def andThen[C, D](other: Fold_[A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with a Fold_, having this IndexedFold_ applied first

compose this IndexedFold_ with a Fold_, having this IndexedFold_ applied first

final def andThenWithLeftIndex[C, D](other: IndexedLens_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedLens_, while preserving self indices

compose this IndexedFold_ with an IndexedLens_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: AnIndexedLens_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an AnIndexedLens_, while preserving self indices

compose this IndexedFold_ with an AnIndexedLens_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: IndexedTraversal_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedTraversal_, while preserving self indices

compose this IndexedFold_ with an IndexedTraversal_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: IndexedGetter_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedGetter_, while preserving self indices

compose this IndexedFold_ with an IndexedGetter_, while preserving self indices

final def andThenWithLeftIndex[C, D](other: IndexedFold_[_, A, B, C, D]): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with an IndexedFold_, while preserving self indices

compose this IndexedFold_ with an IndexedFold_, while preserving self indices

final def andThenWithRightIndex[J, C, D](other: IndexedLens_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedFold_ with an IndexedLens_, while preserving the indices of the other optic

compose this IndexedFold_ with an IndexedLens_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: AnIndexedLens_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedFold_ with an AnIndexedLens_, while preserving the indices of the other optic

compose this IndexedFold_ with an AnIndexedLens_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedTraversal_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedFold_ with an IndexedTraversal_, while preserving the indices of the other optic

compose this IndexedFold_ with an IndexedTraversal_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedGetter_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedFold_ with an IndexedGetter_, while preserving the indices of the other optic

compose this IndexedFold_ with an IndexedGetter_, while preserving the indices of the other optic

final def andThenWithRightIndex[J, C, D](other: IndexedFold_[J, A, B, C, D]): IndexedFold_[J, S, T, C, D]

compose this IndexedFold_ with an IndexedFold_, while preserving the indices of the other optic

compose this IndexedFold_ with an IndexedFold_, while preserving the indices of the other optic

final def asFold: Fold_[S, T, A, B]

transform an IndexedFold_ to a Fold_

transform an IndexedFold_ to a Fold_

final def compose[C, D](other: Iso_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an Iso_, having this IndexedFold_ applied last

compose this IndexedFold_ with an Iso_, having this IndexedFold_ applied last

final def compose[C, D](other: AnIso_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an AnIso_, having this IndexedFold_ applied last

compose this IndexedFold_ with an AnIso_, having this IndexedFold_ applied last

final def compose[C, D](other: Lens_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an Lens_, having this IndexedFold_ applied last

compose this IndexedFold_ with an Lens_, having this IndexedFold_ applied last

final def compose[C, D](other: ALens_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an ALens_, having this IndexedFold_ applied last

compose this IndexedFold_ with an ALens_, having this IndexedFold_ applied last

final def compose[C, D](other: Prism_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an Prism_, having this IndexedFold_ applied last

compose this IndexedFold_ with an Prism_, having this IndexedFold_ applied last

final def compose[C, D](other: APrism_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an APrism_, having this IndexedFold_ applied last

compose this IndexedFold_ with an APrism_, having this IndexedFold_ applied last

final def compose[C, D](other: AffineTraversal_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied last

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied last

final def compose[C, D](other: AnAffineTraversal_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied last

compose this IndexedFold_ with an AffineTraversal_, having this IndexedFold_ applied last

final def compose[C, D](other: Traversal_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an Traversal_, having this IndexedFold_ applied last

compose this IndexedFold_ with an Traversal_, having this IndexedFold_ applied last

final def compose[C, D](other: ATraversal_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with an ATraversal_, having this IndexedFold_ applied last

compose this IndexedFold_ with an ATraversal_, having this IndexedFold_ applied last

final def compose[C, D](other: Getter_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with a Getter_, having this IndexedFold_ applied last

compose this IndexedFold_ with a Getter_, having this IndexedFold_ applied last

final def compose[C, D](other: Fold_[C, D, S, T]): IndexedFold_[I, C, D, A, B]

compose this IndexedFold_ with a Fold_, having this IndexedFold_ applied last

compose this IndexedFold_ with a Fold_, having this IndexedFold_ applied last

final def focus[C, D](f: A => C): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with a function lifted to a Getter_, having this IndexedFold_ applied first

compose this IndexedFold_ with a function lifted to a Getter_, having this IndexedFold_ applied first

final def foldMap[R : Monoid](s: S)(f: (A, I) => R): R

map each focus of an IndexedFold_ to a cats.Monoid, and combine the results

map each focus of an IndexedFold_ to a cats.Monoid, and combine the results

final def reindex[J](f: I => J): IndexedFold_[J, S, T, A, B]

remap the index, resulting in a change of type to the full structure

remap the index, resulting in a change of type to the full structure

final def toWithIndex[C, D](f: A => (C, I)): IndexedFold_[I, S, T, C, D]

compose this IndexedFold_ with a function lifted to an IndexedGetter_

compose this IndexedFold_ with a function lifted to an IndexedGetter_

final def unIndex: Fold_[S, T, A, B]

synonym to asFold

synonym to asFold

final def view(s: S)(implicit ev: Monoid[A]): A

synonym to fold

synonym to fold

Inherited methods

final def contains(a: (A, I))(s: S)(implicit ev: Eq[(A, I)]): Boolean

test whether a focus at specific index of an IndexedGetter contains a given value

test whether a focus at specific index of an IndexedGetter contains a given value

Inherited from:
IndexedGetter0
final override def exists(f: (A, I) => Boolean): S => Boolean
Definition Classes
IndexedFold0 -> IndexedGetter0
Inherited from:
IndexedFold0
final override def find(f: (A, I) => Boolean): S => Option[(A, I)]

find the first focus of an IndexedFold that satisfies a predicate, if there is any

find the first focus of an IndexedFold that satisfies a predicate, if there is any

Definition Classes
IndexedFold0 -> IndexedGetter0
Inherited from:
IndexedFold0
final def first(s: S): Option[(A, I)]

synonym for preview

synonym for preview

Inherited from:
IndexedFold0
final def fold(s: S)(implicit ev: Monoid[A]): A

fold the foci of a IndexedFold using a cats.Monoid

fold the foci of a IndexedFold using a cats.Monoid

Inherited from:
IndexedFold0
final def foldLeft[R](s: S)(r: R)(f: (R, (A, I)) => R): R

fold the foci and indices of an IndexedFold using a binary operator, going left to right

fold the foci and indices of an IndexedFold using a binary operator, going left to right

Inherited from:
IndexedFold0
final def foldRight[R](s: S)(r: R)(f: ((A, I), R) => R): R

fold the foci and indices of an IndexedFold using a binary operator, going right to left

fold the foci and indices of an IndexedFold using a binary operator, going right to left

Inherited from:
IndexedFold0
final def isEmpty(s: S): Boolean

check if the IndexedGetter does not contain a focus

check if the IndexedGetter does not contain a focus

Inherited from:
IndexedGetter0
final def last(s: S): Option[(A, I)]

find the last focus and index of an IndexedFold that satisfies a predicate, if there is any

find the last focus and index of an IndexedFold that satisfies a predicate, if there is any

Inherited from:
IndexedFold0
final def length(s: S): Int

the number of foci of an IndexedFold

the number of foci of an IndexedFold

Inherited from:
IndexedFold0
final def maximum(s: S)(implicit ev: Order[A]): Option[A]

the maximum of all foci of an IndexedFold, if there is any

the maximum of all foci of an IndexedFold, if there is any

Inherited from:
IndexedFold0
final def minimum(s: S)(implicit ev: Order[A]): Option[A]

the minimum of all foci of an IndexedFold, if there is any

the minimum of all foci of an IndexedFold, if there is any

Inherited from:
IndexedFold0
final def nonEmpty(s: S): Boolean

check if the IndexedGetter contains a focus

check if the IndexedGetter contains a focus

Inherited from:
IndexedGetter0
final def notContains(a: (A, I))(s: S)(implicit ev: Eq[(A, I)]): Boolean

test whether a focus at specific index of an IndexedGetter does not contain a given value

test whether a focus at specific index of an IndexedGetter does not contain a given value

Inherited from:
IndexedGetter0
final def notExists(f: (A, I) => Boolean): S => Boolean

test whether a predicate does not hold for the focus of an IndexedGetter

test whether a predicate does not hold for the focus of an IndexedGetter

Inherited from:
IndexedGetter0
final def preview(s: S): Option[(A, I)]

view the first focus of a Fold, if there is any

view the first focus of a Fold, if there is any

Inherited from:
IndexedFold0
final def toArray(s: S)(implicit ev0: ClassTag[A]): Array[A]

collect all the foci of an IndexedFold into an Array

collect all the foci of an IndexedFold into an Array

Inherited from:
IndexedFold0
final def toList(s: S): List[A]

collect all the foci of an IndexedFold into aList

collect all the foci of an IndexedFold into aList

Inherited from:
IndexedFold0
final def use(implicit ev: State[S, A]): State[S, List[(A, I)]]

view the focus and the index of an IndexedFold in the state of a monad

view the focus and the index of an IndexedFold in the state of a monad

Inherited from:
IndexedFold0
final def viewAll(s: S): List[(A, I)]

collect all the foci of an IndexedFold into a List

collect all the foci of an IndexedFold into a List

Inherited from:
IndexedFold0
final override protected def viewOption(s: S): Option[(A, I)]
Definition Classes
IndexedFold0 -> IndexedGetter0
Inherited from:
IndexedFold0

Implicits

Inherited implicits

implicit def monoidBooleanDisj: Monoid[Disj[Boolean]]
Inherited from:
FoldInstances