scala.collection.parallel.mutable

ParMapLike

trait ParMapLike [K, V, +Repr <: ParMapLike[K, V, Repr, Sequential] with ParMap[K, V], +Sequential <: Map[K, V] with MapLike[K, V, Sequential]] extends MapLike[K, V, Repr] with ParMapLike[K, V, Repr, Sequential]

A template trait for mutable parallel maps. This trait is to be mixed in with concrete parallel maps to override the representation type.

The higher-order functions passed to certain operations may contain side-effects. Since implementations of bulk operations may not be sequential, this means that side-effects may not be predictable and may produce data-races, deadlocks or invalidation of state if care is not taken. It is up to the programmer to either avoid using side-effects or to use some form of synchronization when accessing mutable data.

A template trait for mutable parallel maps. This trait is to be mixed in with concrete parallel maps to override the representation type.

The higher-order functions passed to certain operations may contain side-effects. Since implementations of bulk operations may not be sequential, this means that side-effects may not be predictable and may produce data-races, deadlocks or invalidation of state if care is not taken. It is up to the programmer to either avoid using side-effects or to use some form of synchronization when accessing mutable data.

K

the key type of the map

V

the value type of the map

linear super types: ParMapLike[K, V, Repr, Sequential], ParIterableLike[(K, V), Repr, Sequential], HasNewCombiner[(K, V), Repr], Parallel, CustomParallelizable[(K, V), Repr], MapLike[K, V, Repr], Cloneable[Repr], Shrinkable[K], Builder[(K, V), Repr], Growable[(K, V)], MapLike[K, V, Repr], Subtractable[K, Repr], IterableLike[(K, V), Repr], TraversableLike[(K, V), Repr], Parallelizable[(K, V), Repr], TraversableOnce[(K, V)], FilterMonadic[(K, V), Repr], HasNewBuilder[(K, V), Repr], Equals, PartialFunction[K, V], (K) ⇒ V, AnyRef, Any
known subclasses: ParMap, ParHashMap
source: ParMapLike.scala
    since
  1. 2.9

Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ParMapLike
  2. ParMapLike
  3. ParIterableLike
  4. HasNewCombiner
  5. Parallel
  6. CustomParallelizable
  7. MapLike
  8. Cloneable
  9. Shrinkable
  10. Builder
  11. Growable
  12. MapLike
  13. Subtractable
  14. IterableLike
  15. TraversableLike
  16. Parallelizable
  17. TraversableOnce
  18. FilterMonadic
  19. HasNewBuilder
  20. Equals
  21. PartialFunction
  22. Function1
  23. AnyRef
  24. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. trait Accessor [R, Tp] extends StrictSplitterCheckTask[R, Tp]

    Standard accessor task that iterates over the elements of the collection.

  2. class Aggregate [S] extends Accessor[S, Aggregate[S]]

    attributes: protected[this]
  3. trait BuilderOps [Elem, To] extends AnyRef

  4. class Collect [S, That] extends Transformer[Combiner[S, That], Collect[S, That]]

    attributes: protected[this]
  5. class Composite [FR, SR, R, First <: ParIterableLike.this.StrictSplitterCheckTask[FR, _], Second <: ParIterableLike.this.StrictSplitterCheckTask[SR, _]] extends NonDivisibleTask[R, Composite[FR, SR, R, First, Second]]

    attributes: protected[this] abstract
  6. class Copy [U >: T, That] extends Transformer[Combiner[U, That], Copy[U, That]]

    attributes: protected
  7. class CopyToArray [U >: T, This >: Repr] extends Accessor[Unit, CopyToArray[U, This]]

    attributes: protected[this]
  8. class Count extends Accessor[Int, Count]

    attributes: protected[this]
  9. class CreateScanTree [U >: T] extends Transformer[ScanTree[U], CreateScanTree[U]]

    attributes: protected[this]
  10. class DefaultKeySet extends Set[A]

    The implementation class of the set returned by keySet.

  11. class DefaultValuesIterable extends Iterable[B]

    The implementation class of the iterable returned by values.

  12. class Drop [U >: T, This >: Repr] extends Transformer[Combiner[U, This], Drop[U, This]]

    attributes: protected[this]
  13. class Exists extends Accessor[Boolean, Exists]

    attributes: protected[this]
  14. class Filter [U >: T, This >: Repr] extends Transformer[Combiner[U, This], Filter[U, This]]

    attributes: protected[this]
  15. class FilterNot [U >: T, This >: Repr] extends Transformer[Combiner[U, This], FilterNot[U, This]]

    attributes: protected[this]
  16. class Find [U >: T] extends Accessor[Option[U], Find[U]]

    attributes: protected[this]
  17. class FlatMap [S, That] extends Transformer[Combiner[S, That], FlatMap[S, That]]

    attributes: protected[this]
  18. class Fold [U >: T] extends Accessor[U, Fold[U]]

    attributes: protected[this]
  19. class Forall extends Accessor[Boolean, Forall]

    attributes: protected[this]
  20. class Foreach [S] extends Accessor[Unit, Foreach[S]]

    attributes: protected[this]
  21. class FromScanTree [U >: T, That] extends StrictSplitterCheckTask[Combiner[U, That], FromScanTree[U, That]]

    attributes: protected[this]
  22. class GroupBy [K, U >: T] extends Transformer[HashMapCombiner[K, U], GroupBy[K, U]]

    attributes: protected[this]
  23. class Map [S, That] extends Transformer[Combiner[S, That], Map[S, That]]

    attributes: protected[this]
  24. class Max [U >: T] extends Accessor[Option[U], Max[U]]

    attributes: protected[this]
  25. class Min [U >: T] extends Accessor[Option[U], Min[U]]

    attributes: protected[this]
  26. trait NonDivisible [R] extends NonDivisibleTask[R, NonDivisible[R]]

    attributes: protected[this]
  27. trait NonDivisibleTask [R, Tp] extends StrictSplitterCheckTask[R, Tp]

    attributes: protected[this]
  28. class ParComposite [FR, SR, R, First <: ParIterableLike.this.StrictSplitterCheckTask[FR, _], Second <: ParIterableLike.this.StrictSplitterCheckTask[SR, _]] extends Composite[FR, SR, R, First, Second]

    Performs two tasks in parallel, and waits for both to finish.

  29. trait ParIterator extends ParIterableIterator[T]

    Parallel iterators are split iterators that have additional accessor and transformer methods defined in terms of methods next and hasNext.

  30. class Partition [U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Combiner[U, This]), Partition[U, This]]

    attributes: protected[this]
  31. class Product [U >: T] extends Accessor[U, Product[U]]

    attributes: protected[this]
  32. class Reduce [U >: T] extends Accessor[Option[U], Reduce[U]]

    attributes: protected[this]
  33. class ResultMapping [R, Tp, R1] extends NonDivisibleTask[R1, ResultMapping[R, Tp, R1]]

    attributes: protected[this] abstract
  34. type SSCTask [R, Tp] = StrictSplitterCheckTask[R, Tp]

    definition classes: ParIterableLike
  35. case class ScanLeaf [U >: T] ( pit : ParIterableIterator[U] , op : (U, U) ⇒ U , from : Int , len : Int , prev : Option[ScanLeaf[U]] , acc : U ) extends ScanTree[U] with Product with Serializable

    attributes: protected[this]
  36. case class ScanNode [U >: T] ( left : ScanTree[U] , right : ScanTree[U] ) extends ScanTree[U] with Product with Serializable

    attributes: protected[this]
  37. trait ScanTree [U >: T] extends AnyRef

    attributes: protected[this]
  38. type Self = Repr

    The type implementing this traversable

    The type implementing this traversable

    attributes: protected
    definition classes: TraversableLike
  39. class SeqComposite [FR, SR, R, First <: ParIterableLike.this.StrictSplitterCheckTask[FR, _], Second <: ParIterableLike.this.StrictSplitterCheckTask[SR, _]] extends Composite[FR, SR, R, First, Second]

    Sequentially performs one task after another.

  40. trait SignalContextPassingIterator [+IterRepr <: ParIterator] extends ParIterator

    A stackable modification that ensures signal contexts get passed along the iterators.

  41. trait SignallingOps [PI <: DelegatedSignalling] extends AnyRef

  42. class Slice [U >: T, This >: Repr] extends Transformer[Combiner[U, This], Slice[U, This]]

    attributes: protected[this]
  43. class Span [U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Combiner[U, This]), Span[U, This]]

    attributes: protected[this]
  44. class SplitAt [U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Combiner[U, This]), SplitAt[U, This]]

    attributes: protected[this]
  45. trait StrictSplitterCheckTask [R, Tp] extends Task[R, Tp]

    attributes: protected
  46. class Sum [U >: T] extends Accessor[U, Sum[U]]

    attributes: protected[this]
  47. class Take [U >: T, This >: Repr] extends Transformer[Combiner[U, This], Take[U, This]]

    attributes: protected[this]
  48. class TakeWhile [U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Boolean), TakeWhile[U, This]]

    attributes: protected[this]
  49. trait TaskOps [R, Tp] extends AnyRef

  50. class ToParCollection [U >: T, That] extends Transformer[Combiner[U, That], ToParCollection[U, That]]

    attributes: protected[this]
  51. class ToParMap [K, V, That] extends Transformer[Combiner[(K, V), That], ToParMap[K, V, That]]

    attributes: protected[this]
  52. trait Transformer [R, Tp] extends Accessor[R, Tp]

    attributes: protected
  53. class WithFilter extends FilterMonadic[A, Repr]

    A class supporting filtered operations.

  54. class Zip [U >: T, S, That] extends Transformer[Combiner[(U, S), That], Zip[U, S, That]]

    attributes: protected[this]
  55. class ZipAll [U >: T, S, That] extends Transformer[Combiner[(U, S), That], ZipAll[U, S, That]]

    attributes: protected[this]

Value Members

  1. def != ( arg0 : AnyRef ) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != ( arg0 : Any ) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def + [B1 >: V] ( elem1 : (K, B1) , elem2 : (K, B1) , elems : (K, B1)* ) : Map[K, B1]

    Creates a new map containing two or more key/value mappings and all the key/value mappings of this map.

    Creates a new map containing two or more key/value mappings and all the key/value mappings of this map.

    Specified mappings will override existing mappings from this map with the same keys.

    B1

    the type of the added values

    elem1

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

    a new map containing mappings of this map and two or more specified mappings.

    definition classes: MapLikeMapLike
    annotations: @migration( 2 , 8 , ... )
  7. def + [B1 >: V] ( kv : (K, B1) ) : Map[K, B1]

    Creates a new map containing a new key/value mapping and all the key/value mappings of this map.

    Creates a new map containing a new key/value mapping and all the key/value mappings of this map.

    Mapping kv will override existing mappings from this map with the same key.

    B1

    the type of the value in the key/value pair.

    kv

    the key/value mapping to be added

    returns

    a new map containing mappings of this map and the mapping kv.

    definition classes: MapLikeMapLike
    annotations: @migration( 2 , 8 , ... )
  8. def ++ [B] ( that : TraversableOnce[B] ) : Shrinkable[B]

    [use case] Concatenates this shrinkable collection with the elements of a traversable collection.

    [use case]

    Concatenates this shrinkable collection with the elements of a traversable collection.

    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

    a new shrinkable collection which contains all elements of this shrinkable collection followed by all elements of that.

    attributes: abstract
    definition classes: TraversableLike
  9. def ++ [U >: (K, V), That] ( that : TraversableOnce[U] )(implicit bf : CanBuildFrom[Repr, U, That] ) : That

    Concatenates this shrinkable collection with the elements of a traversable collection.

    Concatenates this shrinkable collection with the elements of a traversable collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That which contains all elements of this shrinkable collection followed by all elements of that.

    definition classes: ParIterableLikeTraversableLike
  10. def ++ [B1 >: V] ( xs : TraversableOnce[(K, B1)] ) : Map[K, B1]

    Creates a new map containing the key/value mappings provided by the specified traversable object and all the key/value mappings of this map.

    Creates a new map containing the key/value mappings provided by the specified traversable object and all the key/value mappings of this map.

    Note that existing mappings from this map with the same key as those in xs will be overriden.

    B1

    the type of the added values

    xs

    the traversable object.

    returns

    a new map containing mappings of this map and those provided by xs.

    definition classes: MapLikeMapLike
    annotations: @migration( 2 , 8 , ... )
  11. def ++: [B >: (K, V), That] ( that : Traversable[B] )(implicit bf : CanBuildFrom[Repr, B, That] ) : That

    This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

    This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions. Since TraversableOnce has no '++' method, we have to implement that directly, but Traversable and down can use the overload.

    definition classes: TraversableLike
  12. def ++: [B] ( that : TraversableOnce[B] ) : Shrinkable[B]

    [use case] Concatenates this shrinkable collection with the elements of a traversable collection.

    [use case]

    Concatenates this shrinkable collection with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

    a new shrinkable collection which contains all elements of this shrinkable collection followed by all elements of that.

    attributes: abstract
    definition classes: TraversableLike
  13. def ++: [B >: (K, V), That] ( that : TraversableOnce[B] )(implicit bf : CanBuildFrom[Repr, B, That] ) : That

    Concatenates this shrinkable collection with the elements of a traversable collection.

    Concatenates this shrinkable collection with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That which contains all elements of this shrinkable collection followed by all elements of that.

    definition classes: TraversableLike
  14. def ++= ( xs : TraversableOnce[(K, V)] ) : ParMapLike.this.type

    adds all elements produced by a TraversableOnce to this shrinkable collection.

    adds all elements produced by a TraversableOnce to this shrinkable collection.

    returns

    the shrinkable collection itself.

    definition classes: Growable
  15. def += ( elem1 : (K, V) , elem2 : (K, V) , elems : (K, V)* ) : ParMapLike.this.type

    adds two or more elements to this shrinkable collection.

    adds two or more elements to this shrinkable collection.

    elem1

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

    the shrinkable collection itself

    definition classes: Growable
  16. def += ( kv : (K, V) ) : ParMapLike.this.type

    Adds a new key/value pair to this map.

    Adds a new key/value pair to this map. If the map already contains a mapping for the key, it will be overridden by the new value.

    kv

    the key/value pair.

    returns

    the map itself

    attributes: abstract
    definition classes: MapLikeBuilderGrowable
  17. def - ( elem1 : K , elem2 : K , elems : K* ) : Repr

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of the two or more specified keys.

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of the two or more specified keys.

    elem1

    the first element to remove.

    elem2

    the second element to remove.

    elems

    the remaining elements to remove.

    returns

    a new map containing all the mappings of this map except mappings with a key equal to elem1, elem2 or any of elems.

    definition classes: MapLikeSubtractable
    annotations: @migration( 2 , 8 , ... )
  18. def - ( key : K ) : Repr

    Creates a new map with all the key/value mappings of this map except the key/value mapping with the specified key.

    Creates a new map with all the key/value mappings of this map except the key/value mapping with the specified key.

    key

    the key to be removed

    returns

    a new map with all the mappings of this map except that with a key key.

    definition classes: MapLikeMapLikeSubtractable
    annotations: @migration( 2 , 8 , ... )
  19. def -- ( xs : TraversableOnce[K] ) : Repr

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of those provided by the specified traversable object.

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of those provided by the specified traversable object.

    xs

    the traversable object.

    returns

    a new map with all the key/value mappings of this map except mappings with a key equal to a key from xs.

    definition classes: MapLikeSubtractable
    annotations: @migration( 2 , 8 , ... )
  20. def --= ( xs : TraversableOnce[K] ) : ParMapLike.this.type

    Removes all elements produced by an iterator from this shrinkable collection.

    Removes all elements produced by an iterator from this shrinkable collection.

    returns

    the shrinkable collection itself

    definition classes: Shrinkable
  21. def -= ( elem1 : K , elem2 : K , elems : K* ) : ParMapLike.this.type

    Removes two or more elements from this shrinkable collection.

    Removes two or more elements from this shrinkable collection.

    elem1

    the first element to remove.

    elem2

    the second element to remove.

    elems

    the remaining elements to remove.

    returns

    the shrinkable collection itself

    definition classes: Shrinkable
  22. def -= ( key : K ) : ParMapLike.this.type

    Removes a key from this map.

    Removes a key from this map.

    key

    the key to be removed

    returns

    the map itself.

    attributes: abstract
    definition classes: MapLikeShrinkable
  23. def /: [B] ( z : B )( op : (B, (K, V)) ⇒ B ) : B

    Applies a binary operator to a start value and all elements of this shrinkable collection, going left to right.

    Applies a binary operator to a start value and all elements of this shrinkable collection, going left to right.

    Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    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 this shrinkable collection, going left to right with the start value z on the left:

                op(...op(op(z, x,,1,,), x,,2,,), ..., x,,n,,)
    

    where x,,1,,, ..., x,,n,, are the elements of this shrinkable collection.

    definition classes: TraversableOnce
  24. def :\ [B] ( z : B )( op : ((K, V), B) ⇒ B ) : B

    Applies a binary operator to all elements of this shrinkable collection and a start value, going right to left.

    Applies a binary operator to all elements of this shrinkable collection and a start value, going right to left.

    Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    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 this shrinkable collection, going right to left with the start value z on the right:

                op(x,,1,,, op(x,,2,,, ... op(x,,n,,, z)...))
    

    where x,,1,,, ..., x,,n,, are the elements of this shrinkable collection.

    definition classes: TraversableOnce
  25. def == ( arg0 : AnyRef ) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  26. def == ( arg0 : Any ) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  27. def addString ( b : StringBuilder , start : String , sep : String , end : String ) : StringBuilder

    Appends all bindings of this map to a string builder using start, end, and separator strings.

    Appends all bindings of this map to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations of all bindings of this map in the form of key -> value are separated by the string sep.

    b

    the builder to which strings are appended.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    the string builder b to which elements were appended.

    definition classes: MapLikeTraversableOnce
  28. def addString ( b : StringBuilder ) : StringBuilder

    Appends all elements of this shrinkable collection to a string builder.

    Appends all elements of this shrinkable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this shrinkable collection without any separator string.

    b

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

    definition classes: TraversableOnce
  29. def addString ( b : StringBuilder , sep : String ) : StringBuilder

    Appends all elements of this shrinkable collection to a string builder using a separator string.

    Appends all elements of this shrinkable collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this shrinkable collection, separated by the string sep.

    b

    the string builder to which elements are appended.

    sep

    the separator string.

    returns

    the string builder b to which elements were appended.

    definition classes: TraversableOnce
  30. def aggregate [S] ( z : S )( seqop : (S, (K, V)) ⇒ S , combop : (S, S) ⇒ S ) : S

    Aggregates the results of applying an operator to subsequent elements.

    Aggregates the results of applying an operator to subsequent elements.

    This is a more general form of fold and reduce. It has similar semantics, but does not require the result to be a supertype of the element type. It traverses the elements in different partitions sequentially, using seqop to update the result, and then applies combop to results from different partitions. The implementation of this operation may operate on an arbitrary number of collection partitions, so combop may be invoked arbitrary number of times.

    For example, one might want to process some elements and then produce a Set. In this case, seqop would process an element and append it to the list, while combop would concatenate two lists from different partitions together. The initial value z would be an empty set.

       pc.aggregate(Set[Int]())(_ += process(_), _ ++ _)
    

    Another example is calculating geometric mean from a collection of doubles (one would typically require big doubles for this).

    S

    the type of accumulated results

    z

    the initial value for the accumulated result of the partition - this will typically be the neutral element for the seqop operator (e.g. Nil for list concatenation or 0 for summation)

    seqop

    an operator used to accumulate results within a partition

    combop

    an associative operator used to combine results from different partitions

    definition classes: ParIterableLike
  31. def andThen [C] ( k : (V) ⇒ C ) : PartialFunction[K, C]

    Composes this partial function with a transformation function that gets applied to results of this partial function.

    Composes this partial function with a transformation function that gets applied to results of this partial function.

    C

    the result type of the transformation function.

    k

    the transformation function

    returns

    a partial function with the same domain as this partial function, which maps arguments x to k(this(x)).

    definition classes: PartialFunctionFunction1
  32. def apply ( key : K ) : V

    Retrieves the value which is associated with the given key.

    Retrieves the value which is associated with the given key. This method invokes the default method of the map if there is no mapping from the given key to a value. Unless overridden, the default method throws a NoSuchElementException.

    key

    the key

    returns

    the value associated with the given key, or the result of the map's default method, if none exists.

    definition classes: MapLikeFunction1
  33. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  34. implicit def builder2ops [Elem, To] ( cb : Builder[Elem, To] ) : BuilderOps[Elem, To]

    attributes: protected implicit
    definition classes: ParIterableLike
  35. def canEqual ( that : Any ) : Boolean

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    that

    The object with which this shrinkable collection should be compared

    returns

    true, if this shrinkable collection can possibly equal that, false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.

    definition classes: IterableLikeEquals
  36. def cbfactory : () ⇒ Combiner[(K, V), Repr]

    attributes: protected[this]
    definition classes: ParIterableLike
  37. def clear () : Unit

    Removes all bindings from the map.

    Removes all bindings from the map. After this operation has completed, the map will be empty.

    definition classes: ParMapLikeMapLikeBuilderGrowable
  38. def clone () : Repr

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    definition classes: MapLikeCloneable → AnyRef
  39. def collect [B] ( pf : PartialFunction[(K, V), B] ) : Shrinkable[B]

    [use case] Builds a new collection by applying a partial function to all elements of this shrinkable collection on which the function is defined.

    [use case]

    Builds a new collection by applying a partial function to all elements of this shrinkable collection on which the function is defined.

    B

    the element type of the returned collection.

    pf

    the partial function which filters and maps the shrinkable collection.

    returns

    a new shrinkable collection resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

    attributes: abstract
    definition classes: TraversableLike
  40. def collect [S, That] ( pf : PartialFunction[(K, V), S] )(implicit bf : CanBuildFrom[Repr, S, That] ) : That

    Builds a new collection by applying a partial function to all elements of this shrinkable collection on which the function is defined.

    Builds a new collection by applying a partial function to all elements of this shrinkable collection on which the function is defined.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    pf

    the partial function which filters and maps the shrinkable collection.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That resulting from applying the partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

    definition classes: ParIterableLikeTraversableLike
  41. def collectFirst [B] ( pf : PartialFunction[(K, V), B] ) : Option[B]

    Finds the first element of the shrinkable collection for which the given partial function is defined, and applies the partial function to it.

    Finds the first element of the shrinkable collection for which the given partial function is defined, and applies the partial function to it.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    pf

    the partial function

    returns

    an option value containing pf applied to the first value for which it is defined, or None if none exists.

    definition classes: TraversableOnce
    Example :
    1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

  42. def compose [A] ( g : (A) ⇒ K ) : (A) ⇒ V

    Composes two instances of Function1 in a new Function1, with this function applied last.

    Composes two instances of Function1 in a new Function1, with this function applied last.

    A

    the type to which function g can be applied

    g

    a function A => T1

    returns

    a new function f such that f(x) == apply(g(x))

    definition classes: Function1
  43. def contains ( key : K ) : Boolean

    Tests whether this map contains a binding for a key.

    Tests whether this map contains a binding for a key.

    key

    the key

    returns

    true if there is a binding for key in this map, false otherwise.

    definition classes: MapLike
  44. def copyToArray ( xs : Array[(K, V)] , start : Int , len : Int ) : Unit

    [use case] Copies elements of this shrinkable collection to an array.

    [use case]

    Copies elements of this shrinkable collection to an array. Fills the given array xs with at most len elements of this shrinkable collection, starting at position start. Copying will stop once either the end of the current shrinkable collection is reached, or the end of the array is reached, or len elements have been copied.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    attributes: abstract
    definition classes: TraversableLike
  45. def copyToArray [U >: (K, V)] ( xs : Array[U] , start : Int , len : Int ) : Unit

    Copies elements of this shrinkable collection to an array.

    Copies elements of this shrinkable collection to an array. Fills the given array xs with at most len elements of this shrinkable collection, starting at position start. Copying will stop once either the end of the current shrinkable collection is reached, or the end of the array is reached, or len elements have been copied.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

  46. def copyToArray ( xs : Array[(K, V)] ) : Unit

    [use case] Copies values of this shrinkable collection to an array.

    [use case]

    Copies values of this shrinkable collection to an array. Fills the given array xs with values of this shrinkable collection. Copying will stop once either the end of the current shrinkable collection is reached, or the end of the array is reached.

    xs

    the array to fill.

    attributes: abstract
    definition classes: TraversableOnce
  47. def copyToArray [B >: (K, V)] ( xs : Array[B] ) : Unit

    Copies values of this shrinkable collection to an array.

    Copies values of this shrinkable collection to an array. Fills the given array xs with values of this shrinkable collection. Copying will stop once either the end of the current shrinkable collection is reached, or the end of the array is reached.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    definition classes: TraversableOnce
  48. def copyToArray ( xs : Array[(K, V)] , start : Int ) : Unit

    [use case] Copies values of this shrinkable collection to an array.

    [use case]

    Copies values of this shrinkable collection to an array. Fills the given array xs with values of this shrinkable collection, after skipping start values. Copying will stop once either the end of the current shrinkable collection is reached, or the end of the array is reached.

    xs

    the array to fill.

    start

    the starting index.

    attributes: abstract
    definition classes: TraversableOnce
  49. def copyToArray [B >: (K, V)] ( xs : Array[B] , start : Int ) : Unit

    Copies values of this shrinkable collection to an array.

    Copies values of this shrinkable collection to an array. Fills the given array xs with values of this shrinkable collection, after skipping start values. Copying will stop once either the end of the current shrinkable collection is reached, or the end of the array is reached.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index.

    definition classes: TraversableOnce
  50. def copyToBuffer [B >: (K, V)] ( dest : Buffer[B] ) : Unit

    Copies all elements of this shrinkable collection to a buffer.

    Copies all elements of this shrinkable collection to a buffer.

    dest

    The buffer to which elements are copied.

    definition classes: TraversableOnce
  51. def count ( p : ((K, V)) ⇒ Boolean ) : Int

    Counts the number of elements in the shrinkable collection which satisfy a predicate.

    Counts the number of elements in the shrinkable collection which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    definition classes: ParIterableLikeTraversableOnce
  52. def debugBuffer : ArrayBuffer[String]

    definition classes: ParIterableLike
  53. def default ( key : K ) : V

    Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

    Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

    key

    the given key value for which a binding is missing.

    definition classes: MapLike
  54. implicit def delegatedSignalling2ops [PI <: DelegatedSignalling] ( it : PI ) : SignallingOps[PI]

    attributes: protected implicit
    definition classes: ParIterableLike
  55. def drop ( n : Int ) : Repr

    Selects all elements except first n ones.

    Selects all elements except first n ones.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    the number of elements to drop from this shrinkable collection.

    returns

    a shrinkable collection consisting of all elements of this shrinkable collection except the first n ones, or else the empty shrinkable collection, if this shrinkable collection has less than n elements.

    definition classes: ParIterableLikeTraversableLike
  56. def dropRight ( n : Int ) : Repr

    Selects all elements except last n ones.

    Selects all elements except last n ones.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    The number of elements to take

    returns

    a shrinkable collection consisting of all elements of this shrinkable collection except the last n ones, or else the empty shrinkable collection, if this shrinkable collection has less than n elements.

    definition classes: IterableLike
  57. def dropWhile ( pred : ((K, V)) ⇒ Boolean ) : Repr

    Drops all elements in the longest prefix of elements that satisfy the predicate, and returns a collection composed of the remaining elements.

    Drops all elements in the longest prefix of elements that satisfy the predicate, and returns a collection composed of the remaining elements.

    This method will use indexFlag signalling capabilities. This means that splitters may set and read the indexFlag state.

    The index flag is initially set to maximum integer value.

    pred

    the predicate used to test the elements

    returns

    a collection composed of all the elements after the longest prefix of elements in this shrinkable collection that satisfy the predicate pred

    definition classes: ParIterableLikeTraversableLike
  58. def elements : Iterator[(K, V)]

    definition classes: IterableLike
    annotations: @deprecated( message = "use `iterator' instead" )
      deprecated:
    1. use iterator' instead

  59. def empty : Repr

    The empty map of the same type as this map

    The empty map of the same type as this map

    returns

    an empty map of type This.

    attributes: abstract
    definition classes: ParMapLikeMapLike
  60. def eq ( arg0 : AnyRef ) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  61. def equals ( that : Any ) : Boolean

    Compares two maps structurally; i.

    Compares two maps structurally; i.e. checks if all mappings contained in this map are also contained in the other map, and vice versa.

    that

    the other map

    returns

    true if both maps contain exactly the same mappings, false otherwise.

    definition classes: MapLikeEquals → AnyRef → Any
  62. def exists ( pred : ((K, V)) ⇒ Boolean ) : Boolean

    Tests whether a predicate holds for some element of this shrinkable collection.

    Tests whether a predicate holds for some element of this shrinkable collection.

    This method will use abort signalling capabilities. This means that splitters may send and read abort signals.

    returns

    true if p holds for some element, false otherwise

  63. def filter ( pred : ((K, V)) ⇒ Boolean ) : Repr

    Selects all elements of this shrinkable collection which satisfy a predicate.

    Selects all elements of this shrinkable collection which satisfy a predicate.

    returns

    a new shrinkable collection consisting of all elements of this shrinkable collection that satisfy the given predicate p. The order of the elements is preserved.

    definition classes: ParIterableLikeTraversableLike
  64. def filterKeys ( p : (K) ⇒ Boolean ) : Map[K, V]

    Filters this map by retaining only keys satisfying a predicate.

    Filters this map by retaining only keys satisfying a predicate.

    p

    the predicate used to test keys

    returns

    an immutable map consisting only of those key value pairs of this map where the key satisfies the predicate p. The resulting map wraps the original map without copying any elements.

    definition classes: MapLike
  65. def filterNot ( pred : ((K, V)) ⇒ Boolean ) : Repr

    Selects all elements of this shrinkable collection which do not satisfy a predicate.

    Selects all elements of this shrinkable collection which do not satisfy a predicate.

    returns

    a new shrinkable collection consisting of all elements of this shrinkable collection that do not satisfy the given predicate p. The order of the elements is preserved.

    definition classes: ParIterableLikeTraversableLike
  66. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    attributes: protected[lang]
    definition classes: AnyRef
    annotations: @throws()
  67. def find ( pred : ((K, V)) ⇒ Boolean ) : Option[(K, V)]

    Finds some element in the collection for which the predicate holds, if such an element exists.

    Finds some element in the collection for which the predicate holds, if such an element exists. The element may not necessarily be the first such element in the iteration order.

    If there are multiple elements obeying the predicate, the choice is nondeterministic.

    This method will use abort signalling capabilities. This means that splitters may send and read abort signals.

    returns

    an option value with the element if such an element exists, or None otherwise

  68. def first : (K, V)

    definition classes: IterableLike
    annotations: @deprecated( message = "use `head' instead" )
      deprecated:
    1. use head' instead

  69. def firstOption : Option[(K, V)]

    None if iterable is empty.

    None if iterable is empty.

    definition classes: IterableLike
    annotations: @deprecated( message = "use `headOption' instead" )
      deprecated:
    1. use headOption' instead

  70. def flatMap [B] ( f : ((K, V)) ⇒ TraversableOnce[B] ) : Shrinkable[B]

    [use case] Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

    [use case]

    Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new shrinkable collection resulting from applying the given collection-valued function f to each element of this shrinkable collection and concatenating the results.

    attributes: abstract
    definition classes: TraversableLike
  71. def flatMap [S, That] ( f : ((K, V)) ⇒ TraversableOnce[S] )(implicit bf : CanBuildFrom[Repr, S, That] ) : That

    Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

    Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That resulting from applying the given collection-valued function f to each element of this shrinkable collection and concatenating the results.

    definition classes: ParIterableLikeTraversableLikeFilterMonadic
  72. def fold [U >: (K, V)] ( z : U )( op : (U, U) ⇒ U ) : U

    Folds the elements of this sequence using the specified associative binary operator.

    Folds the elements of this sequence using the specified associative binary operator. The order in which the elements are reduced is unspecified and may be nondeterministic.

    Note this method has a different signature than the foldLeft and foldRight methods of the trait Traversable. The result of folding may only be a supertype of this parallel collection's type parameter T.

    U

    a type parameter for the binary operator, a supertype of T.

    z

    a neutral element for the fold operation, it may be added to the result an arbitrary number of times, not changing the result (e.g. Nil for list concatenation, 0 for addition, or 1 for multiplication)

    op

    a binary operator that must be associative

    returns

    the result of applying fold operator op between all the elements and z

    definition classes: ParIterableLike
  73. def foldLeft [S] ( z : S )( op : (S, (K, V)) ⇒ S ) : S

    Applies a binary operator to a start value and all elements of this shrinkable collection, going left to right.

    Applies a binary operator to a start value and all elements of this shrinkable collection, going left to right.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this shrinkable collection, going left to right with the start value z on the left:

                op(...op(z, x,,1,,), x,,2,,, ..., x,,n,,)
    

    where x,,1,,, ..., x,,n,, are the elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  74. def foldRight [S] ( z : S )( op : ((K, V), S) ⇒ S ) : S

    Applies a binary operator to all elements of this shrinkable collection and a start value, going right to left.

    Applies a binary operator to all elements of this shrinkable collection and a start value, going right to left.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this shrinkable collection, going right to left with the start value z on the right:

                op(x,,1,,, op(x,,2,,, ... op(x,,n,,, z)...))
    

    where x,,1,,, ..., x,,n,, are the elements of this shrinkable collection.

    definition classes: ParIterableLikeIterableLikeTraversableOnce
  75. def forall ( pred : ((K, V)) ⇒ Boolean ) : Boolean

    Tests whether a predicate holds for all elements of this shrinkable collection.

    Tests whether a predicate holds for all elements of this shrinkable collection.

    This method will use abort signalling capabilities. This means that splitters may send and read abort signals.

    returns

    true if p holds for all elements, false otherwise

  76. def foreach [U] ( f : ((K, V)) ⇒ U ) : Unit

    Applies a function f to all the elements of shrinkable collection in a sequential order.

    Applies a function f to all the elements of shrinkable collection in a sequential order.

    U

    the result type of the function applied to each element, which is always discarded

    f

    function applied to each element

  77. def get ( key : K ) : Option[V]

    Optionally returns the value associated with a key.

    Optionally returns the value associated with a key.

    key

    the key value

    returns

    an option value containing the value associated with key in this map, or None if none exists.

    attributes: abstract
    definition classes: MapLike
  78. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  79. def getOrElse ( key : K , default : ⇒ V ) : V

    [use case] Returns the value associated with a key, or a default value if the key is not contained in the map.

    [use case]

    Returns the value associated with a key, or a default value if the key is not contained in the map.

    key

    the key.

    default

    a computation that yields a default value in case no binding for key is found in the map.

    returns

    the value associated with key if it exists, otherwise the result of the default computation.

    attributes: abstract
    definition classes: MapLike
  80. def getOrElse [B1 >: V] ( key : K , default : ⇒ B1 ) : B1

    Returns the value associated with a key, or a default value if the key is not contained in the map.

    Returns the value associated with a key, or a default value if the key is not contained in the map.

    B1

    the result type of the default computation.

    key

    the key.

    default

    a computation that yields a default value in case no binding for key is found in the map.

    returns

    the value associated with key if it exists, otherwise the result of the default computation.

    definition classes: MapLike
  81. def getOrElseUpdate ( key : K , op : ⇒ V ) : V

    If given key is already in this map, returns associated value.

    If given key is already in this map, returns associated value.

    Otherwise, computes value from given expression op, stores with key in map and returns that value.

    key

    the key to test

    op

    the computation yielding the value to associate with key, if key is previously unbound.

    returns

    the value associated with key (either previously or as a result of executing the method).

    definition classes: MapLike
  82. def groupBy [K] ( f : ((K, V)) ⇒ K ) : ParMap[K, Repr]

    Partitions this shrinkable collection into a map of shrinkable collections according to some discriminator function.

    Partitions this shrinkable collection into a map of shrinkable collections according to some discriminator function.

    Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new shrinkable collection.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to shrinkable collections such that the following invariant holds:

                    (xs partition f)(k) = xs filter (x => f(x) == k)
    

    That is, every key k is bound to a shrinkable collection of those elements x for which f(x) equals k.

    definition classes: ParIterableLikeTraversableLike
  83. def grouped ( size : Int ) : Iterator[Repr]

    Partitions elements in fixed size shrinkable collections.

    Partitions elements in fixed size shrinkable collections.

    size

    the number of elements per group

    returns

    An iterator producing shrinkable collections of size size, except the last will be truncated if the elements don't divide evenly.

    definition classes: IterableLike
      see also:
    1. Iterator#grouped

  84. def hasDefiniteSize : Boolean

    Tests whether this shrinkable collection is known to have a finite size.

    Tests whether this shrinkable collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end.

    Note: many collection methods will not work on collections of infinite sizes.

    returns

    true if this collection is known to have finite size, false otherwise.

    definition classes: TraversableLikeTraversableOnce
  85. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: MapLike → AnyRef → Any
  86. def head : (K, V)

    Selects the first element of this shrinkable collection.

    Selects the first element of this shrinkable collection.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    the first element of this shrinkable collection.

    definition classes: IterableLikeTraversableLike
  87. def headOption : Option[(K, V)]

    Optionally selects the first element.

    Optionally selects the first element.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    the first element of this shrinkable collection if it is nonempty, None if it is empty.

    definition classes: TraversableLike
  88. def init : Repr

    Selects all elements except the last.

    Selects all elements except the last.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    a shrinkable collection consisting of all elements of this shrinkable collection except the last one.

    definition classes: TraversableLike
  89. def inits : Iterator[Repr]

    Iterates over the inits of this shrinkable collection.

    Iterates over the inits of this shrinkable collection. The first value will be this shrinkable collection and the final one will be an empty shrinkable collection, with the intervening values the results of successive applications of init.

    returns

    an iterator over all the inits of this shrinkable collection

    definition classes: TraversableLike
    Example :
    1. List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

  90. def isDefinedAt ( key : K ) : Boolean

    Tests whether this map contains a binding for a key.

    Tests whether this map contains a binding for a key. This method, which implements an abstract method of trait PartialFunction, is equivalent to contains.

    key

    the key

    returns

    true if there is a binding for key in this map, false otherwise.

    definition classes: MapLikePartialFunction
  91. def isEmpty : Boolean

    Tests whether the map is empty.

    Tests whether the map is empty.

    returns

    true if the map does not contain any key/value binding, false otherwise.

    definition classes: MapLikeIterableLikeTraversableLikeTraversableOnce
  92. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  93. def isStrictSplitterCollection : Boolean

    Denotes whether this parallel collection has strict splitters.

    Denotes whether this parallel collection has strict splitters.

    This is true in general, and specific collection instances may choose to override this method. Such collections will fail to execute methods which rely on splitters being strict, i.e. returning a correct value in the remaining method.

    This method helps ensure that such failures occur on method invocations, rather than later on and in unpredictable ways.

    definition classes: ParIterableLike
  94. def isTraversableAgain : Boolean

    Tests whether this shrinkable collection can be repeatedly traversed.

    Tests whether this shrinkable collection can be repeatedly traversed.

    returns

    true

    attributes: final
    definition classes: TraversableLikeTraversableOnce
  95. def iterator : Splitter[(K, V)]

    Creates a new split iterator used to traverse the elements of this collection.

    Creates a new split iterator used to traverse the elements of this collection.

    By default, this method is implemented in terms of the protected parallelIterator method.

    returns

    a split iterator

    definition classes: ParIterableLikeIterableLike
  96. def keySet : Set[K]

    Collects all keys of this map in a set.

    Collects all keys of this map in a set.

    returns

    a set containing all keys of this map.

    definition classes: MapLike
  97. def keys : Iterable[K]

    Creates an iterator for all keys.

    Creates an iterator for all keys.

    returns

    an iterator over all keys.

    definition classes: MapLike
    annotations: @migration( 2 , 8 , ... )
  98. def keysIterator : Iterator[K]

    Creates an iterator for all keys.

    Creates an iterator for all keys.

    returns

    an iterator over all keys.

    definition classes: MapLike
  99. def last : (K, V)

    Selects the last element.

    Selects the last element.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    The last element of this shrinkable collection.

    definition classes: TraversableLike
  100. def lastOption : Option[(K, V)]

    Optionally selects the last element.

    Optionally selects the last element.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    the last element of this shrinkable collection$ if it is nonempty, None if it is empty.

    definition classes: TraversableLike
  101. def lift : (K) ⇒ Option[V]

    Turns this partial function into an plain function returning an Option result.

    Turns this partial function into an plain function returning an Option result.

    returns

    a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.

    definition classes: PartialFunction
      see also:
    1. Function.unlift

  102. def map [B] ( f : ((K, V)) ⇒ B ) : Shrinkable[B]

    [use case] Builds a new collection by applying a function to all elements of this shrinkable collection.

    [use case]

    Builds a new collection by applying a function to all elements of this shrinkable collection.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new shrinkable collection resulting from applying the given function f to each element of this shrinkable collection and collecting the results.

    attributes: abstract
    definition classes: TraversableLike
  103. def map [S, That] ( f : ((K, V)) ⇒ S )(implicit bf : CanBuildFrom[Repr, S, That] ) : That

    Builds a new collection by applying a function to all elements of this shrinkable collection.

    Builds a new collection by applying a function to all elements of this shrinkable collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That resulting from applying the given function f to each element of this shrinkable collection and collecting the results.

    definition classes: ParIterableLikeTraversableLikeFilterMonadic
  104. def mapElements [C] ( f : (V) ⇒ C ) : Map[K, C]

    definition classes: MapLike
    annotations: @deprecated( message = "use `mapValues' instead" )
      deprecated:
    1. use mapValues' instead

  105. def mapResult [NewTo] ( f : (Repr) ⇒ NewTo ) : Builder[(K, V), NewTo]

    Creates a new builder by applying a transformation function to the results of this builder.

    Creates a new builder by applying a transformation function to the results of this builder.

    NewTo

    the type of collection returned by f.

    f

    the transformation function.

    returns

    a new builder which is the same as the current builder except that a transformation function is applied to this builder's result.

    definition classes: Builder
  106. def mapValues [C] ( f : (V) ⇒ C ) : Map[K, C]

    Transforms this map by applying a function to every retrieved value.

    Transforms this map by applying a function to every retrieved value.

    f

    the function used to transform values of this map.

    returns

    a map view which maps every key of this map to f(this(key)). The resulting map wraps the original map without copying any elements.

    definition classes: MapLike
  107. def max : (K, V)

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this shrinkable collection.

    attributes: abstract
    definition classes: TraversableOnce
  108. def max [U >: (K, V)] (implicit ord : Ordering[U] ) : (K, V)

    Finds the largest element.

    Finds the largest element.

    returns

    the largest element of this shrinkable collection with respect to the ordering cmp.

    definition classes: ParIterableLikeTraversableOnce
  109. def maxBy [S] ( f : ((K, V)) ⇒ S )(implicit cmp : Ordering[S] ) : (K, V)

    definition classes: ParIterableLikeTraversableOnce
  110. def min : (K, V)

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this shrinkable collection

    attributes: abstract
    definition classes: TraversableOnce
  111. def min [U >: (K, V)] (implicit ord : Ordering[U] ) : (K, V)

    Finds the smallest element.

    Finds the smallest element.

    returns

    the smallest element of this shrinkable collection with respect to the ordering cmp.

    definition classes: ParIterableLikeTraversableOnce
  112. def minBy [S] ( f : ((K, V)) ⇒ S )(implicit cmp : Ordering[S] ) : (K, V)

    definition classes: ParIterableLikeTraversableOnce
  113. def mkString : String

    Displays all elements of this shrinkable collection in a string.

    Displays all elements of this shrinkable collection in a string.

    returns

    a string representation of this shrinkable collection. In the resulting string the string representations (w.r.t. the method toString) of all elements of this shrinkable collection follow each other without any separator string.

    definition classes: ParIterableLikeTraversableOnce
  114. def mkString ( sep : String ) : String

    Displays all elements of this shrinkable collection in a string using a separator string.

    Displays all elements of this shrinkable collection in a string using a separator string.

    sep

    the separator string.

    returns

    a string representation of this shrinkable collection. In the resulting string the string representations (w.r.t. the method toString) of all elements of this shrinkable collection are separated by the string sep.

    definition classes: ParIterableLikeTraversableOnce
    Example :
    1. List(1, 2, 3).mkString("|") = "1|2|3"

  115. def mkString ( start : String , sep : String , end : String ) : String

    Displays all elements of this shrinkable collection in a string using start, end, and separator strings.

    Displays all elements of this shrinkable collection in a string using start, end, and separator strings.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    a string representation of this shrinkable collection. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this shrinkable collection are separated by the string sep.

    definition classes: ParIterableLikeTraversableOnce
    Example :
    1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

  116. def ne ( arg0 : AnyRef ) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  117. def newBuilder : Builder[(K, V), Repr]

    The newBuilder operation returns a parallel builder assigned to this collection's fork/join pool.

    The newBuilder operation returns a parallel builder assigned to this collection's fork/join pool. This method forwards the call to newCombiner.

    attributes: protected[this]
    definition classes: ParMapLikeParIterableLikeMapLikeTraversableLikeHasNewBuilder
  118. def newCombiner : Combiner[(K, V), Repr]

    attributes: protected[this]
    definition classes: ParMapLikeHasNewCombiner
  119. def nonEmpty : Boolean

    Tests whether the shrinkable collection is not empty.

    Tests whether the shrinkable collection is not empty.

    returns

    true if the shrinkable collection contains at least one element, false otherwise.

    definition classes: TraversableOnce
  120. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  121. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  122. def orElse [A1 <: K, B1 >: V] ( that : PartialFunction[A1, B1] ) : PartialFunction[A1, B1]

    Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

    Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

    A1

    the argument type of the fallback function

    B1

    the result type of the fallback function

    that

    the fallback function

    returns

    a partial function which has as domain the union of the domains of this partial function and that. The resulting partial function takes x to this(x) where this is defined, and to that(x) where it is not.

    definition classes: PartialFunction
  123. def par : Repr

    Returns a parallel implementation of this collection.

    Returns a parallel implementation of this collection.

    For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

    Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

    All parallel collections return a reference to themselves.

    returns

    a parallel implementation of this collection

  124. def parCombiner : Combiner[(K, V), Repr]

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    returns

    a combiner for the parallel collection of type ParRepr

    attributes: protected[this]
  125. def parallelIterator : ParIterableIterator[(K, V)]

    Creates a new parallel iterator used to traverse the elements of this parallel collection.

    Creates a new parallel iterator used to traverse the elements of this parallel collection. This iterator is more specific than the iterator of the returned by iterator, and augmented with additional accessor and transformer methods.

    returns

    a parallel iterator

    attributes: abstract
    definition classes: ParIterableLike
  126. def partition ( pred : ((K, V)) ⇒ Boolean ) : (Repr, Repr)

    Partitions this shrinkable collection in two shrinkable collections according to a predicate.

    Partitions this shrinkable collection in two shrinkable collections according to a predicate.

    returns

    a pair of shrinkable collections: the first shrinkable collection consists of all elements that satisfy the predicate p and the second shrinkable collection consists of all elements that don't. The relative order of the elements in the resulting shrinkable collections is the same as in the original shrinkable collection.

    definition classes: ParIterableLikeTraversableLike
  127. def product : (K, V)

    [use case] Multiplies up the elements of this collection.

    [use case]

    Multiplies up the elements of this collection.

    returns

    the product of all elements in this shrinkable collection of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the shrinkable collection and as result type of product. Examples of such types are: Long, Float, Double, BigInt.

    attributes: abstract
    definition classes: TraversableOnce
  128. def product [U >: (K, V)] (implicit num : Numeric[U] ) : U

    Multiplies up the elements of this collection.

    Multiplies up the elements of this collection.

    num

    an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

    returns

    the product of all elements of this shrinkable collection with respect to the * operator in num.

    definition classes: ParIterableLikeTraversableOnce
  129. def projection : IterableView[(K, V), Repr]

    returns a projection that can be used to call non-strict filter, map, and flatMap methods that build projections of the collection.

    returns a projection that can be used to call non-strict filter, map, and flatMap methods that build projections of the collection.

    definition classes: IterableLike
    annotations: @deprecated( message = "use `view' instead" )
      deprecated:
    1. use view' instead

  130. def put ( key : K , value : V ) : Option[V]

    Adds a new key/value pair to this map and optionally returns previously bound value.

    Adds a new key/value pair to this map and optionally returns previously bound value. If the map already contains a mapping for the key, it will be overridden by the new value.

    key

    the key to update

    value

    the new value

    returns

    an option value containing the value associated with the key before the put operation was executed, or None if key was not defined in the map before.

    definition classes: MapLike
  131. def reduce [U >: (K, V)] ( op : (U, U) ⇒ U ) : U

    Reduces the elements of this sequence using the specified associative binary operator.

    Reduces the elements of this sequence using the specified associative binary operator.

    The order in which the operations on elements are performed is unspecified and may be nondeterministic.

    Note this method has a different signature than the reduceLeft and reduceRight methods of the trait Traversable. The result of reducing may only be a supertype of this parallel collection's type parameter T.

    U

    A type parameter for the binary operator, a supertype of T.

    op

    A binary operator that must be associative.

    returns

    The result of applying reduce operator op between all the elements if the collection is nonempty.

    definition classes: ParIterableLike
  132. def reduceLeft [U >: (K, V)] ( op : (U, (K, V)) ⇒ U ) : U

    Applies a binary operator to all elements of this shrinkable collection, going left to right.

    Applies a binary operator to all elements of this shrinkable collection, going left to right.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this shrinkable collection, going left to right:

                op(...(op(x,,1,,, x,,2,,), ... ) , x,,n,,)
    

    where x,,1,,, ..., x,,n,, are the elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  133. def reduceLeftOption [B >: (K, V)] ( op : (B, (K, V)) ⇒ B ) : Option[B]

    Optionally applies a binary operator to all elements of this shrinkable collection, going left to right.

    Optionally applies a binary operator to all elements of this shrinkable collection, going left to right.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    an option value containing the result of reduceLeft(op) is this shrinkable collection is nonempty, None otherwise.

    definition classes: TraversableOnce
  134. def reduceOption [U >: (K, V)] ( op : (U, U) ⇒ U ) : Option[U]

    Optionally reduces the elements of this sequence using the specified associative binary operator.

    Optionally reduces the elements of this sequence using the specified associative binary operator.

    The order in which the operations on elements are performed is unspecified and may be nondeterministic.

    Note this method has a different signature than the reduceLeftOption and reduceRightOption methods of the trait Traversable. The result of reducing may only be a supertype of this parallel collection's type parameter T.

    U

    A type parameter for the binary operator, a supertype of T.

    op

    A binary operator that must be associative.

    returns

    An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.

    definition classes: ParIterableLike
  135. def reduceRight [U >: (K, V)] ( op : ((K, V), U) ⇒ U ) : U

    Applies a binary operator to all elements of this shrinkable collection, going right to left.

    Applies a binary operator to all elements of this shrinkable collection, going right to left.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this shrinkable collection, going right to left:

                op(x,,1,,, op(x,,2,,, ..., op(x,,n-1,,, x,,n,,)...))
    

    where x,,1,,, ..., x,,n,, are the elements of this shrinkable collection.

    definition classes: ParIterableLikeIterableLikeTraversableOnce
  136. def reduceRightOption [B >: (K, V)] ( op : ((K, V), B) ⇒ B ) : Option[B]

    Optionally applies a binary operator to all elements of this shrinkable collection, going right to left.

    Optionally applies a binary operator to all elements of this shrinkable collection, going right to left.

    Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    an option value containing the result of reduceRight(op) is this shrinkable collection is nonempty, None otherwise.

    definition classes: TraversableOnce
  137. def remove ( key : K ) : Option[V]

    Removes a key from this map, returning the value associated previously with that key as an option.

    Removes a key from this map, returning the value associated previously with that key as an option.

    key

    the key to be removed

    returns

    an option value containing the value associated previously with key, or None if key was not defined in the map before.

    definition classes: MapLike
  138. def removeKey ( key : K ) : Option[V]

    If given key is defined in this map, remove it and return associated value as an Option.

    If given key is defined in this map, remove it and return associated value as an Option. If key is not present return None.

    key

    the key to be removed

    definition classes: MapLike
    annotations: @deprecated( message = "Use `remove' instead" )
      deprecated:
    1. Use remove' instead

  139. def repr : Repr

    The collection of type shrinkable collection underlying this TraversableLike object.

    The collection of type shrinkable collection underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

    definition classes: TraversableLike
  140. def result () : Repr

    The result when this map is used as a builder

    The result when this map is used as a builder

    returns

    the map representation itself.

    definition classes: MapLikeBuilder
  141. def retain ( p : (K, V) ⇒ Boolean ) : ParMapLike.this.type

    Retains only those mappings for which the predicate p returns true.

    Retains only those mappings for which the predicate p returns true.

    p

    The test predicate

    definition classes: MapLike
  142. def reuse [S, That] ( oldc : Option[Combiner[S, That]] , newc : Combiner[S, That] ) : Combiner[S, That]

    Optionally reuses an existing combiner for better performance.

    Optionally reuses an existing combiner for better performance. By default it doesn't - subclasses may override this behaviour. The provided combiner oldc that can potentially be reused will be either some combiner from the previous computational task, or None if there was no previous phase (in which case this method must return newc).

    oldc

    The combiner that is the result of the previous task, or None if there was no previous task.

    newc

    The new, empty combiner that can be used.

    returns

    Either newc or oldc.

    attributes: protected
    definition classes: ParIterableLike
  143. def reversed : List[(K, V)]

    attributes: protected[this]
    definition classes: TraversableOnce
  144. def sameElements ( that : Iterable[(K, V)] ) : Boolean

    [use case] Checks if the other iterable collection contains the same elements in the same order as this shrinkable collection.

    [use case]

    Checks if the other iterable collection contains the same elements in the same order as this shrinkable collection.

    that

    the collection to compare with.

    returns

    true, if both collections contain the same elements in the same order, false otherwise.

    attributes: abstract
    definition classes: IterableLike
  145. def sameElements [B >: (K, V)] ( that : Iterable[B] ) : Boolean

    Checks if the other iterable collection contains the same elements in the same order as this shrinkable collection.

    Checks if the other iterable collection contains the same elements in the same order as this shrinkable collection.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    B

    the type of the elements of collection that.

    that

    the collection to compare with.

    returns

    true, if both collections contain the same elements in the same order, false otherwise.

    definition classes: IterableLike
  146. def scan ( z : (K, V) )( op : ((K, V), (K, V)) ⇒ (K, V) ) : Shrinkable[(K, V)]

    [use case] Computes a prefix scan of the elements of the collection.

    [use case]

    Computes a prefix scan of the elements of the collection.

    z

    neutral element for the operator op

    op

    the associative operator for the scan

    returns

    a new shrinkable collection containing the prefix scan of the elements in this shrinkable collection

    attributes: abstract
    definition classes: ParIterableLike
  147. def scan [U >: (K, V), That] ( z : U )( op : (U, U) ⇒ U )(implicit cbf : CanCombineFrom[Repr, U, That] ) : That

    Computes a prefix scan of the elements of the collection.

    Computes a prefix scan of the elements of the collection.

    Note: The neutral element z may be applied more than once.

    U

    element type of the resulting collection

    That

    type of the resulting collection

    z

    neutral element for the operator op

    op

    the associative operator for the scan

    cbf

    combiner factory which provides a combiner

    returns

    a collection containing the prefix scan of the elements in the original collection

    definition classes: ParIterableLike
  148. def scanBlockSize : Int

    attributes: protected[this]
    definition classes: ParIterableLike
  149. def scanLeft [B, That] ( z : B )( op : (B, (K, V)) ⇒ B )(implicit bf : CanBuildFrom[Repr, B, That] ) : That

    Produces a collection containing cummulative results of applying the operator going left to right.

    Produces a collection containing cummulative results of applying the operator going left to right.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    B

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    collection with intermediate results

    definition classes: TraversableLike
  150. def scanRight [B, That] ( z : B )( op : ((K, V), B) ⇒ B )(implicit bf : CanBuildFrom[Repr, B, That] ) : That

    Produces a collection containing cummulative results of applying the operator going right to left.

    Produces a collection containing cummulative results of applying the operator going right to left. The head of the collection is the last cummulative result.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    Example:

       List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
    
    B

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    collection with intermediate results

    definition classes: TraversableLike
    annotations: @migration( 2 , 9 , ... )
  151. def seq : Sequential

    A version of this collection with all of the operations implemented sequentially (i.

    A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).

    This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

    returns

    a sequential view of the collection.

    definition classes: ParIterableLikeTraversableOnce
  152. def size : Int

    The size of this shrinkable collection.

    The size of this shrinkable collection.

    returns

    the number of elements in this shrinkable collection.

    definition classes: TraversableOnce
  153. def sizeHint ( coll : scala.collection.TraversableLike[_, _] , delta : Int = 0 ) : Unit

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection is known to have a cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    coll

    the collection which serves as a hint for the result's size.

    delta

    a correction to add to the coll.size to produce the size hint.

    definition classes: Builder
  154. def sizeHint ( size : Int ) : Unit

    Gives a hint how many elements are expected to be added when the next result is called.

    Gives a hint how many elements are expected to be added when the next result is called. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    size

    the hint how many elements will be added.

    definition classes: Builder
  155. def sizeHintBounded ( size : Int , boundingColl : scala.collection.TraversableLike[_, _] ) : Unit

    Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection.

    Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    size

    the hint how many elements will be added.

    boundingColl

    the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.

    definition classes: Builder
  156. def slice ( unc_from : Int , unc_until : Int ) : Repr

    Selects an interval of elements.

    Selects an interval of elements. The returned collection is made up of all elements x which satisfy the invariant:

       from <= indexOf(x) < until
    

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    a shrinkable collection containing the elements greater than or equal to index from extending up to (but not including) index until of this shrinkable collection.

    definition classes: ParIterableLikeIterableLikeTraversableLike
  157. def sliding [B >: (K, V)] ( size : Int , step : Int ) : Iterator[Repr]

    definition classes: IterableLike
  158. def sliding [B >: (K, V)] ( size : Int ) : Iterator[Repr]

    Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.

    Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

    size

    the number of elements per group

    returns

    An iterator producing shrinkable collections of size size, except the last and the only element will be truncated if there are fewer elements than size.

    definition classes: IterableLike
      see also:
    1. Iterator#sliding

  159. def span ( pred : ((K, V)) ⇒ Boolean ) : (Repr, Repr)

    Splits this shrinkable collection into a prefix/suffix pair according to a predicate.

    Splits this shrinkable collection into a prefix/suffix pair according to a predicate.

    This method will use indexFlag signalling capabilities. This means that splitters may set and read the indexFlag state.

    The index flag is initially set to maximum integer value.

    pred

    the predicate used to test the elements

    returns

    a pair consisting of the longest prefix of the collection for which all the elements satisfy pred, and the rest of the collection

    definition classes: ParIterableLikeTraversableLike
  160. def splitAt ( n : Int ) : (Repr, Repr)

    Splits this shrinkable collection into two at a given position.

    Splits this shrinkable collection into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    the position at which to split.

    returns

    a pair of shrinkable collections consisting of the first n elements of this shrinkable collection, and the other elements.

    definition classes: ParIterableLikeTraversableLike
  161. def stringPrefix : String

    Defines the prefix of this object's toString representation.

    Defines the prefix of this object's toString representation.

    returns

    a string representation which starts the result of toString applied to this shrinkable collection. Unless overridden in subclasses, the string prefix of every map is "Map".

    definition classes: MapLikeTraversableLike
  162. def sum : (K, V)

    [use case] Sums up the elements of this collection.

    [use case]

    Sums up the elements of this collection.

    returns

    the sum of all elements in this shrinkable collection of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the shrinkable collection and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.

    attributes: abstract
    definition classes: TraversableOnce
  163. def sum [U >: (K, V)] (implicit num : Numeric[U] ) : U

    Sums up the elements of this collection.

    Sums up the elements of this collection.

    num

    an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

    returns

    the sum of all elements of this shrinkable collection with respect to the + operator in num.

    definition classes: ParIterableLikeTraversableOnce
  164. def synchronized [T0] ( arg0 : ⇒ T0 ) : T0

    attributes: final
    definition classes: AnyRef
  165. def tail : Repr

    Selects all elements except the first.

    Selects all elements except the first.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    a shrinkable collection consisting of all elements of this shrinkable collection except the first one.

    definition classes: TraversableLike
  166. def tails : Iterator[Repr]

    Iterates over the tails of this shrinkable collection.

    Iterates over the tails of this shrinkable collection. The first value will be this shrinkable collection and the final one will be an empty shrinkable collection, with the intervening values the results of successive applications of tail.

    returns

    an iterator over all the tails of this shrinkable collection

    definition classes: TraversableLike
    Example :
    1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

  167. def take ( n : Int ) : Repr

    Selects first n elements.

    Selects first n elements.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    Tt number of elements to take from this shrinkable collection.

    returns

    a shrinkable collection consisting only of the first n elements of this shrinkable collection, or else the whole shrinkable collection, if it has less than n elements.

    definition classes: ParIterableLikeTraversableLike
  168. def takeRight ( n : Int ) : Repr

    Selects last n elements.

    Selects last n elements.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    the number of elements to take

    returns

    a shrinkable collection consisting only of the last n elements of this shrinkable collection, or else the whole shrinkable collection, if it has less than n elements.

    definition classes: IterableLike
  169. def takeWhile ( pred : ((K, V)) ⇒ Boolean ) : Repr

    Takes the longest prefix of elements that satisfy the predicate.

    Takes the longest prefix of elements that satisfy the predicate.

    This method will use indexFlag signalling capabilities. This means that splitters may set and read the indexFlag state.

    The index flag is initially set to maximum integer value.

    pred

    the predicate used to test the elements

    returns

    the longest prefix of this shrinkable collection of elements that satisy the predicate pred

    definition classes: ParIterableLikeIterableLikeTraversableLike
  170. implicit def task2ops [R, Tp] ( tsk : SSCTask[R, Tp] ) : TaskOps[R, Tp]

    attributes: protected implicit
    definition classes: ParIterableLike
  171. def thisCollection : Iterable[(K, V)]

    The underlying collection seen as an instance of Shrinkable.

    The underlying collection seen as an instance of Shrinkable. By default this is implemented as the current collection object itself, but this can be overridden.

    attributes: protected[this]
    definition classes: IterableLikeTraversableLike
  172. def threshold ( sz : Int , p : Int ) : Int

    Some minimal number of elements after which this collection should be handled sequentially by different processors.

    Some minimal number of elements after which this collection should be handled sequentially by different processors.

    This method depends on the size of the collection and the parallelism level, which are both specified as arguments.

    sz

    the size based on which to compute the threshold

    p

    the parallelism level based on which to compute the threshold

    returns

    the maximum number of elements for performing operations sequentially

    definition classes: ParIterableLike
  173. def toArray : Array[(K, V)]

    [use case] Converts this shrinkable collection to an array.

    [use case]

    Converts this shrinkable collection to an array.

    returns

    an array containing all elements of this shrinkable collection. A ClassManifest must be available for the element type of this shrinkable collection.

    attributes: abstract
    definition classes: TraversableOnce
  174. def toArray [U >: (K, V)] (implicit arg0 : ClassManifest[U] ) : Array[U]

    Converts this shrinkable collection to an array.

    Converts this shrinkable collection to an array.

    returns

    an array containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  175. def toBuffer [U >: (K, V)] : Buffer[U]

    Converts this shrinkable collection to a mutable buffer.

    Converts this shrinkable collection to a mutable buffer.

    returns

    a buffer containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  176. def toCollection ( repr : Repr ) : Iterable[(K, V)]

    A conversion from collections of type Repr to Shrinkable objects.

    A conversion from collections of type Repr to Shrinkable objects. By default this is implemented as just a cast, but this can be overridden.

    attributes: protected[this]
    definition classes: IterableLikeTraversableLike
  177. def toIndexedSeq [U >: (K, V)] : IndexedSeq[U]

    Converts this shrinkable collection to an indexed sequence.

    Converts this shrinkable collection to an indexed sequence.

    returns

    an indexed sequence containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  178. def toIterable : ParIterable[(K, V)]

    Converts this shrinkable collection to an iterable collection.

    Converts this shrinkable collection to an iterable collection. Note that the choice of target Iterable is lazy in this default implementation as this TraversableOnce may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).

    returns

    an Iterable containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeIterableLikeTraversableOnce
  179. def toIterator : Iterator[(K, V)]

    Returns an Iterator over the elements in this shrinkable collection.

    Returns an Iterator over the elements in this shrinkable collection. Will return the same Iterator if this instance is already an Iterator.

    returns

    an Iterator containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableLikeTraversableOnce
  180. def toList : List[(K, V)]

    Converts this shrinkable collection to a list.

    Converts this shrinkable collection to a list.

    returns

    a list containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  181. def toMap [T, U] : Map[T, U]

    [use case] Converts this shrinkable collection to a map.

    [use case]

    Converts this shrinkable collection to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

    returns

    a map of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this shrinkable collection.

    attributes: abstract
    definition classes: TraversableOnce
  182. def toMap [K, V] (implicit ev : <:<[(K, V), (K, V)] ) : ParMap[K, V]

    Converts this shrinkable collection to a map.

    Converts this shrinkable collection to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

    returns

    a map containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  183. def toParCollection [U >: (K, V), That] ( cbf : () ⇒ Combiner[U, That] ) : That

    attributes: protected
    definition classes: ParIterableLike
  184. def toParMap [K, V, That] ( cbf : () ⇒ Combiner[(K, V), That] )(implicit ev : <:<[(K, V), (K, V)] ) : That

    attributes: protected
    definition classes: ParIterableLike
  185. def toSeq : ParSeq[(K, V)]

    Converts this shrinkable collection to a sequence.

    Converts this shrinkable collection to a sequence. As with toIterable, it's lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.

    returns

    a sequence containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  186. def toSet [U >: (K, V)] : ParSet[U]

    Converts this shrinkable collection to a set.

    Converts this shrinkable collection to a set.

    returns

    a set containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableOnce
  187. def toStream : Stream[(K, V)]

    Converts this shrinkable collection to a stream.

    Converts this shrinkable collection to a stream.

    returns

    a stream containing all elements of this shrinkable collection.

  188. def toString () : String

    Converts this shrinkable collection to a string.

    Converts this shrinkable collection to a string.

    returns

    a string representation of this collection. By default this string consists of the stringPrefix of this shrinkable collection, followed by all elements separated by commas and enclosed in parentheses.

    definition classes: ParIterableLikeTraversableLike → AnyRef → Any
  189. def toTraversable : Traversable[(K, V)]

    Converts this shrinkable collection to an unspecified Traversable.

    Converts this shrinkable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

    returns

    a Traversable containing all elements of this shrinkable collection.

    definition classes: ParIterableLikeTraversableLikeTraversableOnce
  190. def transform ( f : (K, V) ⇒ V ) : ParMapLike.this.type

    Applies a transformation function to all values contained in this map.

    Applies a transformation function to all values contained in this map. The transformation function produces new values from existing keys associated values.

    f

    the transformation to apply

    returns

    the map itself.

    definition classes: MapLike
  191. def update ( key : K , value : V ) : Unit

    Adds a new key/value pair to this map.

    Adds a new key/value pair to this map. If the map already contains a mapping for the key, it will be overridden by the new value.

    key

    The key to update

    value

    The new value

    definition classes: MapLike
  192. def updated [B1 >: V] ( key : K , value : B1 ) : Map[K, B1]

    Creates a new map consisting of all key/value pairs of the current map plus a new pair of a given key and value.

    Creates a new map consisting of all key/value pairs of the current map plus a new pair of a given key and value.

    B1

    the type of the added value

    key

    The key to add

    value

    The new value

    returns

    A fresh immutable map with the binding from key to value added to this map.

    definition classes: MapLikeMapLike
  193. def values : Iterable[V]

    Collects all values of this map in an iterable collection.

    Collects all values of this map in an iterable collection.

    returns

    the values of this map as an iterable.

    definition classes: MapLike
    annotations: @migration( 2 , 8 , ... )
  194. def valuesIterator : Iterator[V]

    Creates an iterator for all values in this map.

    Creates an iterator for all values in this map.

    returns

    an iterator over all values that are associated with some key in this map.

    definition classes: MapLike
  195. def view : ParIterableView[(K, V), Repr, Sequential]

    Creates a non-strict view of this shrinkable collection.

    Creates a non-strict view of this shrinkable collection.

    returns

    a non-strict view of this shrinkable collection.

    definition classes: ParIterableLikeIterableLikeTraversableLike
  196. def view ( from : Int , until : Int ) : IterableView[(K, V), Repr]

    Creates a non-strict view of a slice of this shrinkable collection.

    Creates a non-strict view of a slice of this shrinkable collection.

    Note: the difference between view and slice is that view produces a view of the current shrinkable collection, whereas slice produces a new shrinkable collection.

    Note: view(from, to) is equivalent to view.slice(from, to)

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    from

    the index of the first element of the view

    until

    the index of the element following the view

    returns

    a non-strict view of a slice of this shrinkable collection, starting at index from and extending up to (but not including) index until.

    definition classes: IterableLikeTraversableLike
  197. def wait () : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  198. def wait ( arg0 : Long , arg1 : Int ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  199. def wait ( arg0 : Long ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  200. def withFilter ( p : ((K, V)) ⇒ Boolean ) : FilterMonadic[(K, V), Repr]

    Creates a non-strict filter of this shrinkable collection.

    Creates a non-strict filter of this shrinkable collection.

    Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    p

    the predicate used to test elements.

    returns

    an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this shrinkable collection which satisfy the predicate p.

    definition classes: TraversableLikeFilterMonadic
  201. def wrap [R] ( body : ⇒ R ) : NonDivisible[R]

    attributes: protected
    definition classes: ParIterableLike
  202. def zip [B] ( that : Iterable[B] ) : Shrinkable[((K, V), B)]

    [use case] Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs.

    [use case]

    Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    returns

    a new shrinkable collection containing pairs consisting of corresponding elements of this shrinkable collection and that. The length of the returned collection is the minimum of the lengths of this shrinkable collection and that.

    attributes: abstract
    definition classes: IterableLike
  203. def zip [U >: (K, V), S, That] ( that : Iterable[S] )(implicit bf : CanBuildFrom[Repr, (U, S), That] ) : That

    Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs.

    Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, B) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, B), That]. is found.

    that

    The iterable providing the second half of each result pair

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type (A1, B).

    returns

    a new collection of type That containing pairs consisting of corresponding elements of this shrinkable collection and that. The length of the returned collection is the minimum of the lengths of this shrinkable collection and that.

    definition classes: ParIterableLikeIterableLike
  204. def zipAll [B] ( that : Iterable[B] , thisElem : (K, V) , thatElem : B ) : Shrinkable[((K, V), B)]

    [use case] Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs.

    [use case]

    Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this shrinkable collection is shorter than that.

    thatElem

    the element to be used to fill up the result if that is shorter than this shrinkable collection.

    returns

    a new shrinkable collection containing pairs consisting of corresponding elements of this shrinkable collection and that. The length of the returned collection is the maximum of the lengths of this shrinkable collection and that. If this shrinkable collection is shorter than that, thisElem values are used to pad the result. If that is shorter than this shrinkable collection, thatElem values are used to pad the result.

    attributes: abstract
    definition classes: IterableLike
  205. def zipAll [S, U >: (K, V), That] ( that : Iterable[S] , thisElem : U , thatElem : S )(implicit bf : CanBuildFrom[Repr, (U, S), That] ) : That

    Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs.

    Returns a shrinkable collection formed from this shrinkable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    that

    the iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this shrinkable collection is shorter than that.

    thatElem

    the element to be used to fill up the result if that is shorter than this shrinkable collection.

    returns

    a new collection of type That containing pairs consisting of corresponding elements of this shrinkable collection and that. The length of the returned collection is the maximum of the lengths of this shrinkable collection and that. If this shrinkable collection is shorter than that, thisElem values are used to pad the result. If that is shorter than this shrinkable collection, thatElem values are used to pad the result.

    definition classes: ParIterableLikeIterableLike
  206. def zipWithIndex : Shrinkable[((K, V), Int)]

    [use case] Zips this shrinkable collection with its indices.

    [use case]

    Zips this shrinkable collection with its indices.

    returns

    A new shrinkable collection containing pairs consisting of all elements of this shrinkable collection paired with their index. Indices start at 0. @example List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))

    attributes: abstract
    definition classes: IterableLike
  207. def zipWithIndex [U >: (K, V), That] (implicit bf : CanBuildFrom[Repr, (U, Int), That] ) : That

    Zips this shrinkable collection with its indices.

    Zips this shrinkable collection with its indices.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, Int) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, Int), That]. is found.

    returns

    A new collection of type That containing pairs consisting of all elements of this shrinkable collection paired with their index. Indices start at 0.

    definition classes: ParIterableLikeIterableLike

Inherited from ParMapLike[K, V, Repr, Sequential]

Inherited from ParIterableLike[(K, V), Repr, Sequential]

Inherited from HasNewCombiner[(K, V), Repr]

Inherited from Parallel

Inherited from CustomParallelizable[(K, V), Repr]

Inherited from MapLike[K, V, Repr]

Inherited from Cloneable[Repr]

Inherited from Shrinkable[K]

Inherited from Builder[(K, V), Repr]

Inherited from Growable[(K, V)]

Inherited from MapLike[K, V, Repr]

Inherited from Subtractable[K, Repr]

Inherited from IterableLike[(K, V), Repr]

Inherited from TraversableLike[(K, V), Repr]

Inherited from Parallelizable[(K, V), Repr]

Inherited from TraversableOnce[(K, V)]

Inherited from FilterMonadic[(K, V), Repr]

Inherited from HasNewBuilder[(K, V), Repr]

Inherited from Equals

Inherited from PartialFunction[K, V]

Inherited from (K) ⇒ V

Inherited from AnyRef

Inherited from Any