Packages

trait Foldable[F[_]] extends AnyRef

A type parameter implying the ability to extract zero or more values of that type.

Self Type
Foldable[F]
Source
Foldable.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
FromFoldMap, FromFoldr, Foldable1, IsomorphismFoldable, IsomorphismFoldable1, IsomorphismTraverse, IsomorphismTraverse1, Traverse, Traverse1
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Foldable
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait FoldableLaw extends AnyRef

Abstract Value Members

  1. abstract def foldMap[A, B](fa: F[A])(f: (A) ⇒ B)(implicit F: Monoid[B]): B

    Map each element of the structure to a scalaz.Monoid, and combine the results.

  2. abstract def foldRight[A, B](fa: F[A], z: ⇒ B)(f: (A, ⇒ B) ⇒ B): B

    Right-associative fold of a structure.

Concrete 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. def all[A](fa: F[A])(p: (A) ⇒ Boolean): Boolean

    Whether all As in fa yield true from p.

  5. def allM[G[_], A](fa: F[A])(p: (A) ⇒ G[Boolean])(implicit G: Monad[G]): G[Boolean]

    all with monadic traversal.

  6. def any[A](fa: F[A])(p: (A) ⇒ Boolean): Boolean

    Whether any As in fa yield true from p.

  7. def anyM[G[_], A](fa: F[A])(p: (A) ⇒ G[Boolean])(implicit G: Monad[G]): G[Boolean]

    any with monadic traversal.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def bicompose[G[_, _]](implicit arg0: Bifoldable[G]): Bifoldable[[a, b]F[G[a, b]]]

    The composition of Foldable F and Bifoldable G, [x, y]F[G[x, y]], is a Bifoldable

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collapse[X[_], A](x: F[A])(implicit A: ApplicativePlus[X]): X[A]
  12. def compose[G[_]](implicit G0: Foldable[G]): Foldable[[α]F[G[α]]]

    The composition of Foldables F and G, [x]F[G[x]], is a Foldable

  13. final def count[A](fa: F[A]): Int

    Alias for length.

  14. def element[A](fa: F[A], a: A)(implicit arg0: Equal[A]): Boolean

    Whether a is an element of fa.

  15. def empty[A](fa: F[A]): Boolean

    Deforested alias for toStream(fa).isEmpty.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def fold[M](t: F[M])(implicit arg0: Monoid[M]): M

    Combine the elements of a structure using a monoid.

  20. def foldLeft[A, B](fa: F[A], z: B)(f: (B, A) ⇒ B): B

    Left-associative fold of a structure.

  21. def foldLeft1Opt[A](fa: F[A])(f: (A, A) ⇒ A): Option[A]
  22. def foldLeftM[G[_], A, B](fa: F[A], z: B)(f: (B, A) ⇒ G[B])(implicit M: Monad[G]): G[B]

    Left-associative, monadic fold of a structure.

  23. def foldMap1Opt[A, B](fa: F[A])(f: (A) ⇒ B)(implicit F: Semigroup[B]): Option[B]

    As foldMap but returning None if the foldable is empty and Some otherwise

  24. def foldMapLeft1Opt[A, B](fa: F[A])(z: (A) ⇒ B)(f: (B, A) ⇒ B): Option[B]
  25. def foldMapM[G[_], A, B](fa: F[A])(f: (A) ⇒ G[B])(implicit B: Monoid[B], G: Monad[G]): G[B]

    Specialization of foldRightM when B has a Monoid.

  26. def foldMapRight1Opt[A, B](fa: F[A])(z: (A) ⇒ B)(f: (A, ⇒ B) ⇒ B): Option[B]
  27. def foldRight1Opt[A](fa: F[A])(f: (A, ⇒ A) ⇒ A): Option[A]
  28. def foldRightM[G[_], A, B](fa: F[A], z: ⇒ B)(f: (A, ⇒ B) ⇒ G[B])(implicit M: Monad[G]): G[B]

    Right-associative, monadic fold of a structure.

  29. def foldableLaw: FoldableLaw
  30. val foldableSyntax: FoldableSyntax[F]
  31. final def foldl[A, B](fa: F[A], z: B)(f: (B) ⇒ (A) ⇒ B): B

    Curried version of foldLeft

  32. def foldl1Opt[A](fa: F[A])(f: (A) ⇒ (A) ⇒ A): Option[A]
  33. final def foldlM[G[_], A, B](fa: F[A], z: ⇒ B)(f: (B) ⇒ (A) ⇒ G[B])(implicit M: Monad[G]): G[B]

    Curried version of foldLeftM

  34. final def foldr[A, B](fa: F[A], z: ⇒ B)(f: (A) ⇒ (⇒ B) ⇒ B): B

    Curried version of foldRight

  35. def foldr1Opt[A](fa: F[A])(f: (A) ⇒ (⇒ A) ⇒ A): Option[A]
  36. final def foldrM[G[_], A, B](fa: F[A], z: ⇒ B)(f: (A) ⇒ (⇒ B) ⇒ G[B])(implicit M: Monad[G]): G[B]

    Curried version of foldRightM

  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  39. def index[A](fa: F[A], i: Int): Option[A]

    returns

    the element at index i in a Some, or None if the given index falls outside of the range

  40. def indexOr[A](fa: F[A], default: ⇒ A, i: Int): A

    returns

    the element at index i, or default if the given index falls outside of the range

  41. def intercalate[A](fa: F[A], a: A)(implicit A: Monoid[A]): A

    Insert an A between every A, yielding the sum.

  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def length[A](fa: F[A]): Int

    Deforested alias for toStream(fa).size.

  44. def longDigits[A](fa: F[A])(implicit d: <:<[A, Digit]): Long
  45. def maximum[A](fa: F[A])(implicit arg0: Order[A]): Option[A]

    The greatest element of fa, or None if fa is empty.

  46. def maximumBy[A, B](fa: F[A])(f: (A) ⇒ B)(implicit arg0: Order[B]): Option[A]

    The element a of fa which yields the greatest value of f(a), or None if fa is empty.

  47. def maximumOf[A, B](fa: F[A])(f: (A) ⇒ B)(implicit arg0: Order[B]): Option[B]

    The greatest value of f(a) for each element a of fa, or None if fa is empty.

  48. def minimum[A](fa: F[A])(implicit arg0: Order[A]): Option[A]

    The smallest element of fa, or None if fa is empty.

  49. def minimumBy[A, B](fa: F[A])(f: (A) ⇒ B)(implicit arg0: Order[B]): Option[A]

    The element a of fa which yields the smallest value of f(a), or None if fa is empty.

  50. def minimumOf[A, B](fa: F[A])(f: (A) ⇒ B)(implicit arg0: Order[B]): Option[B]

    The smallest value of f(a) for each element a of fa, or None if fa is empty.

  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. final def notify(): Unit
    Definition Classes
    AnyRef
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  54. def product[G[_]](implicit G0: Foldable[G]): Foldable[[α](F[α], G[α])]

    The product of Foldables F and G, [x](F[x], G[x]]), is a Foldable

  55. def product0[G[_]](implicit G0: Foldable1[G]): Foldable1[[α](F[α], G[α])]

    The product of Foldable F and Foldable1 G, [x](F[x], G[x]]), is a Foldable1

  56. def selectSplit[A](fa: F[A])(p: (A) ⇒ Boolean): List[NonEmptyList[A]]

    Selects groups of elements that satisfy p and discards others.

  57. def sequenceF_[M[_], A](ffa: F[Free[M, A]]): Free[M, Unit]

    sequence_ for Free.

    sequence_ for Free. collapses into a single Free *

  58. def sequenceS_[S, A](fga: F[State[S, A]]): State[S, Unit]

    sequence_ specialized to State *

  59. def sequence_[M[_], A](fa: F[M[A]])(implicit a: Applicative[M]): M[Unit]

    Strict sequencing in an applicative functor M that ignores the value in fa.

  60. def splitWith[A](fa: F[A])(p: (A) ⇒ Boolean): List[NonEmptyList[A]]

    Splits the elements into groups that alternatively satisfy and don't satisfy the predicate p.

  61. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  62. def to[A, G[_]](fa: F[A])(implicit c: CanBuildFrom[Nothing, A, G[A]]): G[A]
  63. def toEphemeralStream[A](fa: F[A]): EphemeralStream[A]
  64. def toIList[A](fa: F[A]): IList[A]
  65. def toIndexedSeq[A](fa: F[A]): IndexedSeq[A]
  66. def toList[A](fa: F[A]): List[A]
  67. def toSet[A](fa: F[A]): Set[A]
  68. def toStream[A](fa: F[A]): Stream[A]
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. def traverseS_[S, A, B](fa: F[A])(f: (A) ⇒ State[S, B]): State[S, Unit]

    traverse_ specialized to State *

  71. final def traverseU_[A, GB](fa: F[A])(f: (A) ⇒ GB)(implicit G: Unapply[Applicative, GB]): M[Unit]

    A version of traverse_ that infers the type constructor M.

  72. def traverse_[M[_], A, B](fa: F[A])(f: (A) ⇒ M[B])(implicit a: Applicative[M]): M[Unit]

    Strict traversal in an applicative functor M that ignores the result of f.

  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def foldMapIdentity[A](fa: F[A])(implicit F: Monoid[A]): A

    Unbiased sum of monoidal values.

    Unbiased sum of monoidal values.

    Annotations
    @deprecated
    Deprecated

    (Since version 7.1) use fold, it has the exact same signature and implementation

Inherited from AnyRef

Inherited from Any

Ungrouped