Packages

c

scala.collection.decorators

IterableDecorator

class IterableDecorator[C, I <: IsIterable[C]] extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IterableDecorator
  2. AnyRef
  3. Any
Implicitly
  1. by mapDecorator
  2. by seqDecorator
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IterableDecorator(coll: C)(implicit it: I)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toany2stringadd[IterableDecorator[C, I]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (IterableDecorator[C, I], B)
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toArrowAssoc[IterableDecorator[C, I]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (IterableDecorator[C, I]) => Boolean, msg: => Any): IterableDecorator[C, I]
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toEnsuring[IterableDecorator[C, I]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (IterableDecorator[C, I]) => Boolean): IterableDecorator[C, I]
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toEnsuring[IterableDecorator[C, I]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): IterableDecorator[C, I]
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toEnsuring[IterableDecorator[C, I]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): IterableDecorator[C, I]
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toEnsuring[IterableDecorator[C, I]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def foldSomeLeft[B](z: B)(op: (B, I.A) => Option[B]): B

    Left to right fold that stops if the combination function op returns None

    Left to right fold that stops if the combination function op returns None

    B

    the result type of the binary operator

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of the collection, going left to right with the start value z on the left, and stopping when all the elements have been traversed or earlier if the operator returns None

  16. final def fullOuterJoin[W, That]: ([W, That](other: scala.collection.Map[_1.map.K,W])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, (Option[_1.map.V], Option[W])),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Alias for mergeByKey

    Alias for mergeByKey

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
    Annotations
    @inline()
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def intersperse[B >: SeqDecorator.S.A, That]: ([B, That](start: B, sep: B, end: B)(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],B,That]): That) forSome {val _1: SeqDecorator[IterableDecorator[C, I], seq.type]}

    Adds the element sep between each element of the sequence, prepending start and appending end.

    Adds the element sep between each element of the sequence, prepending start and appending end. If the sequence has less than two elements, returns start +: this :+ end.

    B

    the element type of the returned collection

    returns

    a new collection consisting of all elements of this collection interspersed with the element sep, beginning with start and ending with end

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toSeqDecorator[IterableDecorator[C, I], seq.type] performed by method seqDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsSeq[IterableDecorator[C, I]] is in scope.
    Definition Classes
    SeqDecorator
    Example:

    1. List(1, 2, 3, 4).intersperse(-1, 0, 5) => List(-1, 1, 0, 2, 0, 3, 0, 4, 5)
  20. def intersperse[B >: SeqDecorator.S.A, That]: ([B, That](sep: B)(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],B,That]): That) forSome {val _1: SeqDecorator[IterableDecorator[C, I], seq.type]}

    Adds the element sep between each element of the sequence.

    Adds the element sep between each element of the sequence. If the sequence has less than two elements, the collection is unchanged.

    B

    the element type of the returned collection

    returns

    a new collection consisting of all elements of this collection interspersed with the element sep

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toSeqDecorator[IterableDecorator[C, I], seq.type] performed by method seqDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsSeq[IterableDecorator[C, I]] is in scope.
    Definition Classes
    SeqDecorator
    Example:

    1. List(1, 2, 3, 4).intersperse(0) = List(1, 0, 2, 0, 3, 0, 4)
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. implicit val it: I
  23. final def join[W, That]: ([W, That](other: scala.collection.Map[_1.map.K,W])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, (_1.map.V, W)),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Alias for zipByKey

    Alias for zipByKey

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
    Annotations
    @inline()
  24. def lazyFoldLeft[B](z: B)(op: (B, => I.A) => B): B

    Lazy left to right fold.

    Lazy left to right fold. Like foldLeft but the combination function op is non-strict in its second parameter. If op(b, a) chooses not to evaluate a and returns b, this terminates the traversal early.

    B

    the result type of the binary operator

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of the collection, going left to right with the start value z on the left, and stopping when all the elements have been traversed or earlier if op(b, a) choose not to evaluate a and returns b

  25. def lazyFoldRight[B](z: B)(op: (I.A) => Either[B, (B) => B]): B

    Right to left fold that can be interrupted before traversing the whole collection.

    Right to left fold that can be interrupted before traversing the whole collection.

    B

    the result type

    z

    the start value

    op

    the operator

    returns

    the result of applying the operator between consecutive elements of the collection, going right to left, with the start value z on the right. The result of the application of the function op to each element drives the process: if it returns Left(result), then result is returned without iterating further; if it returns Right(f), the function f is applied to the previous result to produce the new result and the fold continues.

  26. def leftOuterJoin[W, That]: ([W, That](other: scala.collection.Map[_1.map.K,W])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, (_1.map.V, Option[W])),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Perform a left outer join of this and that.

    Perform a left outer join of this and that.

    Equivalent to mergeByKeyWith(that) { case (Some(v), maybeW) => (v, maybeW) }.

    W

    Type of values of that

    That

    Type of the resulting collection

    returns

    A Map that associates all the keys k of this to pairs (v, Some(w)) if that associates k to w, or (v, None) if that doesn’t contain k

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
  27. implicit val map: map.type
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
  28. final def mergeByKey[W, That]: ([W, That](other: scala.collection.Map[_1.map.K,W])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, (Option[_1.map.V], Option[W])),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Perform a full outer join of this and that.

    Perform a full outer join of this and that.

    Equivalent to mergeByKeyWith(that) { case any => any }.

    W

    Type of values of that (e.g. String)

    That

    Type of the resulting collection (e.g. Map[Int, (Option[Boolean], Option[String])])

    returns

    A Map that associates all the keys k of this or that to pairs (Some(v), Some(w)) if this associates k to v and that associates k to w, or pairs (None, Some(w)) if this doesn’t contain k, or pairs (Some(v), None) if that doesn’t contain k

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
    Annotations
    @inline()
  29. def mergeByKeyWith[W, X, That]: ([W, X, That](other: scala.collection.Map[_1.map.K,W])(f: PartialFunction[(Option[_1.map.V], Option[W]),X])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, X),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    W

    Type of values of the other Map (e.g. Int, String)

    X

    Type of values of the resulting Map

    That

    Type of the result (e.g. Map[Int, (String, Option[Boolean])])

    returns

    A Map associating all the keys from this and that with values returned by the partial function f, when this one is defined.

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def replaced[B >: SeqDecorator.S.A, That]: ([B, That](elem: B, replacement: B)(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],B,That]): That) forSome {val _1: SeqDecorator[IterableDecorator[C, I], seq.type]}

    Produces a new sequence where all occurrences of some element are replaced by a different element.

    Produces a new sequence where all occurrences of some element are replaced by a different element.

    B

    the element type of the returned collection.

    returns

    a new sequence consisting of all elements of this sequence except that all occurrences of elem are replaced by replacement

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toSeqDecorator[IterableDecorator[C, I], seq.type] performed by method seqDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsSeq[IterableDecorator[C, I]] is in scope.
    Definition Classes
    SeqDecorator
  34. def rightOuterJoin[W, That]: ([W, That](other: scala.collection.Map[_1.map.K,W])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, (Option[_1.map.V], W)),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Perform a right outer join of this and that.

    Perform a right outer join of this and that.

    Equivalent to mergeByKeyWith(that) { case (maybeV, Some(w)) => (maybeV, w) }.

    W

    Type of values of that (e.g. String)

    That

    Type of the resulting collection (e.g. Map[Int, (Option[Boolean], String)])

    returns

    A Map that associates all the keys k of that to pairs (Some(v), w) if this associates k to v, or (None, w) if this doesn’t contain k

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
  35. implicit val seq: seq.type
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toSeqDecorator[IterableDecorator[C, I], seq.type] performed by method seqDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsSeq[IterableDecorator[C, I]] is in scope.
    Definition Classes
    SeqDecorator
  36. def splitBy[K, CC1, CC2](f: (I.A) => K)(implicit bf: BuildFrom[C, I.A, CC1], bff: BuildFrom[C, CC1, CC2]): CC2

    Constructs a collection where consecutive elements are accumulated as long as the output of f for each element doesn't change.

    Constructs a collection where consecutive elements are accumulated as long as the output of f for each element doesn't change. 

    Vector(1,2,2,3,3,3,2,2)
.splitBy(identity)
    produces 
    Vector(Vector(1),
Vector(2,2),
Vector(3,3,3),
Vector(2,2))

    K

    the type of the computed key

    f

    the function to compute a key for an element

    returns

    a collection of collections of the consecutive elements with the same key in the original collection

  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. def zipByKey[W, That]: ([W, That](other: scala.collection.Map[_1.map.K,W])(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, (_1.map.V, W)),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Combines the entries of this Map with the entries of that Map that have the same key, tupling their values.

    Combines the entries of this Map with the entries of that Map that have the same key, tupling their values. xs.zipByKey(ys) is a shorthand for xs.zipByKeyWith(ys)((_, _)).

    W

    Type of values of the other Map (e.g. Int, String)

    That

    Type of the result (e.g. Map[Int, (String, Boolean)], TreeMap[String, (Int, Int)])

    returns

    A Map that associates all the keys k contained by both this and that to pairs (v, w) where v is the value associated by this to k and w the value associated by that to k

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator
  43. def zipByKeyWith[W, X, That]: ([W, X, That](other: scala.collection.Map[_1.map.K,W])(f: (_1.map.V, W) => X)(implicit bf: scala.collection.BuildFrom[scala.collection.decorators.IterableDecorator[C,I],(_1.map.K, X),That]): That) forSome {val _1: MapDecorator[IterableDecorator[C, I], map.type]}

    Combines entries of this Map with entries of that Map that have the same key, using the combination function f

    Combines entries of this Map with entries of that Map that have the same key, using the combination function f

    W

    Type of values of the other Map (e.g. Int, String)

    X

    Type of values of the resulting Map

    That

    Type of the resulting Map

    returns

    A Map that associates all the keys k contained by both this and that to the result of the application of f to the values v and w respectively associated by this and that to k

    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toMapDecorator[IterableDecorator[C, I], map.type] performed by method mapDecorator in scala.collection.decorators.This conversion will take place only if an implicit value of type IsMap[IterableDecorator[C, I]] is in scope.
    Definition Classes
    MapDecorator

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toStringFormat[IterableDecorator[C, I]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (IterableDecorator[C, I], B)
    Implicit
    This member is added by an implicit conversion from IterableDecorator[C, I] toArrowAssoc[IterableDecorator[C, I]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion mapDecorator fromIterableDecorator[C, I] to MapDecorator[IterableDecorator[C, I], map.type]

Inherited by implicit conversion seqDecorator fromIterableDecorator[C, I] to SeqDecorator[IterableDecorator[C, I], seq.type]

Inherited by implicit conversion any2stringadd fromIterableDecorator[C, I] to any2stringadd[IterableDecorator[C, I]]

Inherited by implicit conversion StringFormat fromIterableDecorator[C, I] to StringFormat[IterableDecorator[C, I]]

Inherited by implicit conversion Ensuring fromIterableDecorator[C, I] to Ensuring[IterableDecorator[C, I]]

Inherited by implicit conversion ArrowAssoc fromIterableDecorator[C, I] to ArrowAssoc[IterableDecorator[C, I]]

Ungrouped