Movatterモバイル変換


[0]ホーム

URL:


Scala 3
3.7.4
LearnInstallPlaygroundFind A LibraryCommunityBlog
Scala 3
LearnInstallPlaygroundFind A LibraryCommunityBlog
DocsAPI
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL
Scala 3/scala/scala.collection/scala.collection.mutable/TreeSet

TreeSet

scala.collection.mutable.TreeSet
See theTreeSet companion object

A mutable sorted set implemented using a mutable red-black tree as underlying data structure.

Type parameters

A

the type of the keys contained in this tree set.

Value parameters

ordering

the implicit ordering used to compare objects of typeA.

Attributes

Companion
object
Source
TreeSet.scala
Graph
Supertypes
traitSortedSet[A]
traitSortedSet[A]
traitSortedOps[A,TreeSet[A]]
classAbstractSet[A]
traitSet[A]
traitSetOps[A,Set,TreeSet[A]]
traitShrinkable[A]
traitBuilder[A,TreeSet[A]]
traitGrowable[A]
traitClearable
traitCloneable[TreeSet[A]]
traitCloneable
traitIterable[A]
classAbstractSet[A]
traitSet[A]
traitEquals
traitSetOps[A,Set,TreeSet[A]]
traitA=>Boolean
traitIterable[A]
traitIterableOps[A,Set,TreeSet[A]]
traitIterableOnce[A]
classObject
traitMatchable
classAny
Show all

Members list

Value members

Constructors

defthis()(implicitord:Ordering[A])

Creates an emptyTreeSet.

Creates an emptyTreeSet.

Value parameters

ord

the implicit ordering used to compare objects of typeA.

Attributes

Returns

an emptyTreeSet.

Source
TreeSet.scala

Concrete methods

defaddOne(elem:A):this.type

Adds a single element to this mutable tree set.

Adds a single element to this mutable tree set.

Value parameters

elem

the element to add.

Attributes

Returns

the mutable tree set itself

Source
TreeSet.scala
defclear():Unit

Clears the contents of this builder.

Clears the contents of this builder. After execution of this method the builder will contain no elements.

Attributes

Source
TreeSet.scala
defcontains(elem:A):Boolean

Attributes

Source
TreeSet.scala
overridedefforeach[U](f:A=>U):Unit

Appliesf to each element for its side effects.

Appliesf to each element for its side effects. Note:U parameter needed to help scalac's type inference.

Attributes

Definition Classes
Source
TreeSet.scala
overridedefhead:A

Selects the first element of this mutable tree set.

Selects the first element of this mutable tree set.

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

Attributes

Returns

the first element of this mutable tree set.

Throws

NoSuchElementExceptionif the mutable tree set is empty.

Definition Classes
Source
TreeSet.scala
overridedefisEmpty:Boolean

Tests whether the mutable tree set is empty.

Tests whether the mutable tree set is empty.

Note: The default implementation creates and discards an iterator.

Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements whenisEmpty is called.

Attributes

Returns

true if the mutable tree set contains no elements,false otherwise.

Definition Classes
Source
TreeSet.scala

Anscala.collection.Iterator over the elements of this mutable tree set.

Anscala.collection.Iterator over the elements of this mutable tree set.

If anIterableOnce object is in fact anscala.collection.Iterator, this method always returns itself, in its current state, but if it is anscala.collection.Iterable, this method always returns a newscala.collection.Iterator.

Attributes

Source
TreeSet.scala
defiteratorFrom(start:A):Iterator[A]

Creates an iterator that contains all values from this collection greater than or equal tostart according to the ordering of this collection.

Creates an iterator that contains all values from this collection greater than or equal tostart according to the ordering of this collection. x.iteratorFrom(y) is equivalent to but will usually be more efficient than x.from(y).iterator

Value parameters

start

The lower-bound (inclusive) of the iterator

Attributes

Source
TreeSet.scala
overridedefknownSize:Int

The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.

The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.

Attributes

Returns

The number of elements. The default implementation always returns -1.

Definition Classes
Source
TreeSet.scala
overridedeflast:A

Selects the last element.

Selects the last element.

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

Attributes

Returns

The last element of this mutable tree set.

Throws

NoSuchElementExceptionIf the mutable tree set is empty.

Definition Classes
Source
TreeSet.scala
overridedefmaxBefore(key:A):Option[A]

Find the largest element less than a given key.

Find the largest element less than a given key.

Value parameters

key

The given key.

Attributes

Returns

None if there is no such node.

Definition Classes
Source
TreeSet.scala
overridedefminAfter(key:A):Option[A]

Find the smallest element larger than or equal to a given key.

Find the smallest element larger than or equal to a given key.

Value parameters

key

The given key.

Attributes

Returns

None if there is no such node.

Definition Classes
Source
TreeSet.scala
defrangeImpl(from:Option[A],until:Option[A]):TreeSet[A]

Creates a ranged projection of this collection.

Creates a ranged projection of this collection. Any mutations in the ranged projection will update this collection and vice versa.

Note: keys are not guaranteed to be consistent between this collection and the projection. This is the case for buffers where indexing is relative to the projection.

Value parameters

from

The lower-bound (inclusive) of the ranged projection.None if there is no lower bound.

until

The upper-bound (exclusive) of the ranged projection.None if there is no upper bound.

Attributes

Source
TreeSet.scala
overridedefsize:Int

The size of this mutable tree set.

The size of this mutable tree set.

Note: will not terminate for infinite-sized collections.

Attributes

Returns

the number of elements in this mutable tree set.

Definition Classes
Source
TreeSet.scala

The companion object of this sorted set, providing various factory methods.

The companion object of this sorted set, providing various factory methods.

Attributes

Note

When implementing a custom collection type and refiningCC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

Definition Classes
Source
TreeSet.scala
overridedefstepper[S <:Stepper[_]](implicitshape:StepperShape[A,S]):S &EfficientSplit

Returns ascala.collection.Stepper for the elements of this collection.

Returns ascala.collection.Stepper for the elements of this collection.

The Stepper enables creating a Java stream to operate on the collection, seescala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

The implicitscala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

Note that this method is overridden in subclasses and the return type is refined toS with EfficientSplit, for examplescala.collection.IndexedSeqOps.stepper. For Steppers marked withscala.collection.Stepper.EfficientSplit, the converters inscala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

Attributes

Definition Classes
Source
TreeSet.scala
defsubtractOne(elem:A):this.type

Removes a single element from this mutable tree set.

Removes a single element from this mutable tree set.

Value parameters

elem

the element to remove.

Attributes

Returns

the mutable tree set itself

Source
TreeSet.scala

Attributes

Source
TreeSet.scala

Inherited methods

finaldef&(that:Set[A]):TreeSet[A]

Alias forintersect

Alias forintersect

Attributes

Inherited from:
SetOps
Source
Set.scala
finaldef&~(that:Set[A]):TreeSet[A]

Alias fordiff

Alias fordiff

Attributes

Inherited from:
SetOps
Source
Set.scala
finaldef++(that:IterableOnce[A]):TreeSet[A]

Alias forconcat

Alias forconcat

Attributes

Inherited from:
SetOps
Source
Set.scala
finaldef++[B >:A](suffix:IterableOnce[B]):Set[B]

Alias forconcat

Alias forconcat

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
finaldef++=(elems:IterableOnce[A]):this.type

Alias foraddAll

Alias foraddAll

Attributes

Inherited from:
Growable
Source
Growable.scala
finaldef+=(elem:A):this.type

Alias foraddOne

Alias foraddOne

Attributes

Inherited from:
Growable
Source
Growable.scala
finaldef--=(xs:IterableOnce[A]):this.type

Alias forsubtractAll

Alias forsubtractAll

Attributes

Inherited from:
Shrinkable
Source
Shrinkable.scala
finaldef-=(elem:A):this.type

Alias forsubtractOne

Alias forsubtractOne

Attributes

Inherited from:
Shrinkable
Source
Shrinkable.scala
defadd(elem:A):Boolean

Check whether the set contains the given element, and add it if not.

Check whether the set contains the given element, and add it if not.

Value parameters

elem

the element to be added

Attributes

Returns

true if the element was added

Inherited from:
SetOps
Source
Set.scala
defaddAll(elems:IterableOnce[A]):this.type

Adds all elements produced by an IterableOnce to this growable collection.

Adds all elements produced by an IterableOnce to this growable collection.

Value parameters

elems

the IterableOnce producing the elements to add.

Attributes

Returns

the growable collection itself.

Inherited from:
Growable
Source
Growable.scala
finaldefaddString(b:StringBuilder): b.type

Appends all elements of this collection to a string builder.

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

Example:

scala> val a = List(1,2,3,4)a: List[Int] = List(1, 2, 3, 4)scala> val b = new StringBuilder()b: StringBuilder =scala> val h = a.addString(b)h: StringBuilder = 1234

Value parameters

b

the string builder to which elements are appended.

Attributes

Returns

the string builderb to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldefaddString(b:StringBuilder,sep:String): b.type

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

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

Example:

scala> val a = List(1,2,3,4)a: List[Int] = List(1, 2, 3, 4)scala> val b = new StringBuilder()b: StringBuilder =scala> a.addString(b, ", ")res0: StringBuilder = 1, 2, 3, 4

Value parameters

b

the string builder to which elements are appended.

sep

the separator string.

Attributes

Returns

the string builderb to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defaddString(b:StringBuilder,start:String,sep:String,end:String): b.type

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

Appends all elements of this collection to a string builder using start, end, and separator strings. The written text begins with the stringstart and ends with the stringend. Inside, the string representations (w.r.t. the methodtoString) of all elements of this collection are separated by the stringsep.

Example:

scala> val a = List(1,2,3,4)a: List[Int] = List(1, 2, 3, 4)scala> val b = new StringBuilder()b: StringBuilder =scala> a.addString(b , "List(" , ", " , ")")res5: StringBuilder = List(1, 2, 3, 4)

Value parameters

b

the string builder to which elements are appended.

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

the string builderb to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defandThen[A](g:Boolean=>A):A=>A

Composes two instances ofFunction1 in a newFunction1, with this function applied first.

Composes two instances ofFunction1 in a newFunction1, with this function applied first.

Type parameters

A

the result type of functiong

Value parameters

g

a function R => A

Attributes

Returns

a new functionf such thatf(x) == g(apply(x))

Inherited from:
Function1
Source
Function1.scala
finaldefapply(elem:A):Boolean

Tests if some element is contained in this set.

Tests if some element is contained in this set.

This method is equivalent tocontains. It allows sets to be interpreted as predicates.

Value parameters

elem

the element to test for membership.

Attributes

Returns

true ifelem is contained in this set,false otherwise.

Inherited from:
SetOps
Source
Set.scala

Checks whether this instance can possibly equalthat.

Checks whether this instance can possibly equalthat.

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. SeeProgramming in Scala, Chapter 28 for discussion and design.

Value parameters

that

the value being probed for possible equality

Attributes

Returns

true if this instance can possibly equalthat, otherwise false

Inherited from:
Set
Source
Set.scala
overridedefclone():TreeSet[A]

Create a copy of the receiver object.

Create a copy of the receiver object.

The default implementation of theclone method is platform dependent.

Attributes

Returns

a copy of the receiver object.

Note

not specified by SLS as a member of AnyRef

Definition Classes
Inherited from:
SetOps
Source
Set.scala
overridedefcollect[B](pf:PartialFunction[A,B])(implicitev:Ordering[B]):TreeSet[B]

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

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

Type parameters

B

the element type of the returned collection.

Value parameters

pf

the partial function which filters and maps the set.

Attributes

Returns

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

Definition Classes
Inherited from:
StrictOptimizedSortedSetOps
Source
StrictOptimizedSortedSetOps.scala
overridedefcollect[B](pf:PartialFunction[A,B]):Set[B]

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

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

Type parameters

B

the element type of the returned iterable collection.

Value parameters

pf

the partial function which filters and maps the iterable collection.

Attributes

Returns

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

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala

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

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

Note: may not terminate for infinite-sized collections.

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

Value parameters

pf

the partial function

Attributes

Returns

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

Example

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defcompose[A](g:A=>A):A=>Boolean

Composes two instances ofFunction1 in a newFunction1, with this function applied last.

Composes two instances ofFunction1 in a newFunction1, with this function applied last.

Type parameters

A

the type to which functiong can be applied

Value parameters

g

a function A => T1

Attributes

Returns

a new functionf such thatf(x) == apply(g(x))

Inherited from:
Function1
Source
Function1.scala
overridedefconcat(that:IterableOnce[A]):TreeSet[A]

Creates a new set by adding all elements contained in another collection to this set, omitting duplicates.

Creates a new set by adding all elements contained in another collection to this set, omitting duplicates.

This method takes a collection of elements and adds all elements, omitting duplicates, into set.

Example:

scala> val a = Set(1, 2) concat Set(2, 3)a: scala.collection.immutable.Set[Int] = Set(1, 2, 3)

Value parameters

that

the collection containing the elements to add.

Attributes

Returns

a new set with the given elements added, omitting duplicates.

Definition Classes
Inherited from:
StrictOptimizedSetOps
Source
StrictOptimizedSetOps.scala
defconcat[B >:A](suffix:IterableOnce[B]):Set[B]

Returns a new iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand.

Returns a new iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the iterable collection is the most specific superclass encompassing the element types of the two operands.

Type parameters

B

the element type of the returned collection.

Value parameters

suffix

the iterable to append.

Attributes

Returns

a new iterable collection which contains all elements of this iterable collection followed by all elements ofsuffix.

Inherited from:
IterableOps
Source
Iterable.scala
defcopyToArray[B >:A](xs:Array[B],start:Int,len:Int):Int

Copy elements to an array, returning the number of elements written.

Copy elements to an array, returning the number of elements written.

Fills the given arrayxs starting at indexstart with at mostlen elements of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached, orlen elements have been copied.

Type parameters

B

the type of the elements of the array.

Value parameters

len

the maximal number of elements to copy.

start

the starting index of xs.

xs

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defcopyToArray[B >:A](xs:Array[B],start:Int):Int

Copies elements to an array, returning the number of elements written.

Copies elements to an array, returning the number of elements written.

Fills the given arrayxs starting at indexstart with values of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.

Type parameters

B

the type of the elements of the array.

Value parameters

start

the starting index of xs.

xs

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defcopyToArray[B >:A](xs:Array[B]):Int

Copies elements to an array, returning the number of elements written.

Copies elements to an array, returning the number of elements written.

Fills the given arrayxs starting at indexstart with values of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.

Type parameters

B

the type of the elements of the array.

Value parameters

xs

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defcorresponds[B](that:IterableOnce[B])(p: (A,B)=>Boolean):Boolean

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Note: will not terminate for infinite-sized collections.

Type parameters

B

the type of the elements ofthat

Value parameters

p

the test predicate, which relates elements from both collections

that

the other collection

Attributes

Returns

true if both collections have the same length andp(x, y) istrue for all corresponding elementsx of this iterator andy ofthat, otherwisefalse

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defcount(p:A=>Boolean):Int

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

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

Note: will not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the number of elements satisfying the predicatep.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defdiff(that:Set[A]):TreeSet[A]

Computes the difference of this set and another set.

Computes the difference of this set and another set.

Value parameters

that

the set of elements to exclude.

Attributes

Returns

a set containing those elements of this set that are not also contained in the given setthat.

Inherited from:
SetOps
Source
Set.scala
defdrop(n:Int):TreeSet[A]

Selects all elements except the firstn ones.

Selects all elements except the firstn ones.

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

Value parameters

n

the number of elements to drop from this iterable collection.

Attributes

Returns

a iterable collection consisting of all elements of this iterable collection except the firstn ones, or else the empty iterable collection, if this iterable collection has less thann elements. Ifn is negative, don't drop any elements.

Inherited from:
IterableOps
Source
Iterable.scala
overridedefdropRight(n:Int):TreeSet[A]

The rest of the collection without itsn last elements.

The rest of the collection without itsn last elements. For linear, immutable collections this should avoid making a copy.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala

Selects all elements except the longest prefix that satisfies a predicate.

Selects all elements except the longest prefix that satisfies a predicate.

The matching prefix starts with the first element of this iterable collection, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire iterable collection.

Example:

scala> List(1, 2, 3, 100, 4).dropWhile(n => n < 10)val res0: List[Int] = List(100, 4)scala> List(1, 2, 3, 100, 4).dropWhile(n => n == 0)val res1: List[Int] = List(1, 2, 3, 100, 4)

Usespan to obtain both the prefix and suffix. UsefilterNot to drop all elements that satisfy the predicate.

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

Value parameters

p

The predicate used to test elements.

Attributes

Returns

the longest suffix of this iterable collection whose first element does not satisfy the predicatep.

Inherited from:
IterableOps
Source
Iterable.scala
overridedefempty:TreeSet[A]

The empty iterable of the same type as this iterable

The empty iterable of the same type as this iterable

Attributes

Returns

an empty iterable of typeC.

Definition Classes
Inherited from:
SortedSetFactoryDefaults
Source
Iterable.scala
overridedefequals(that:Any):Boolean

Equality of sets is implemented using the lookup methodcontains.

Equality of sets is implemented using the lookup methodcontains. This method returnstrue if

  • the argumentthat is aSet,

  • the two sets have the samesize, and

  • for everyelement this set,other.contains(element) == true.

The implementation ofequals checks thecanEqual method, so subclasses ofSet can narrow down the equality to specific set types. TheSet implementations in the standard library can all be compared, theircanEqual methods returntrue.

Note: Theequals method only respects the equality laws (symmetry, transitivity) if the two sets use the same element equivalence function in their lookup operation. For example, the element equivalence operation in ascala.collection.immutable.TreeSet is defined by its ordering. Comparing aTreeSet with aHashSet leads to unexpected results ifordering.equiv(e1, e2) (used for lookup inTreeSet) is different frome1 == e2 (used for lookup inHashSet).

scala> import scala.collection.immutable._scala> val ord: Ordering[String] = _ compareToIgnoreCase _scala> TreeSet("A")(ord) == HashSet("a")val res0: Boolean = falsescala> HashSet("a") == TreeSet("A")(ord)val res1: Boolean = true

Value parameters

that

The set to which this set is compared

Attributes

Returns

true if the two sets are equal according to the description

Definition Classes
Inherited from:
SortedSet
Source
SortedSet.scala

Tests whether a predicate holds for at least one element of this collection.

Tests whether a predicate holds for at least one element of this collection.

Note: may not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

true if the given predicatep is satisfied by at least one element of this collection, otherwisefalse

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
overridedeffilter(pred:A=>Boolean):TreeSet[A]

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

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

Value parameters

p

the predicate used to test elements.

Attributes

Returns

a new iterable collection consisting of all elements of this iterable collection that satisfy the given predicatep. The order of the elements is preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
deffilterInPlace(p:A=>Boolean):this.type

Removes all elements from the set for which do not satisfy a predicate.

Removes all elements from the set for which do not satisfy a predicate.

Value parameters

p

the predicate used to test elements. Only elements for whichp returnstrue are retained in the set; all others are removed.

Attributes

Inherited from:
SetOps
Source
Set.scala
overridedeffilterNot(pred:A=>Boolean):TreeSet[A]

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

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

Value parameters

pred

the predicate used to test elements.

Attributes

Returns

a new iterable collection consisting of all elements of this iterable collection that do not satisfy the given predicatepred. Their order may not be preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
deffind(p:A=>Boolean):Option[A]

Finds the first element of the collection satisfying a predicate, if any.

Finds the first element of the collection satisfying a predicate, if any.

Note: may not terminate for infinite-sized collections.

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

Value parameters

p

the predicate used to test elements.

Attributes

Returns

an option value containing the first element in the collection that satisfiesp, orNone if none exists.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Returns the first key of the collection.

Returns the first key of the collection.

Attributes

Inherited from:
SortedSetOps
Source
SortedSet.scala
overridedefflatMap[B](f:A=>IterableOnce[B])(implicitev:Ordering[B]):TreeSet[B]

Builds a new sorted collection by applying a function to all elements of this set and using the elements of the resulting collections.

Builds a new sorted collection by applying a function to all elements of this set and using the elements of the resulting collections.

Type parameters

B

the element type of the returned collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

a new set resulting from applying the given collection-valued functionf to each element of this set and concatenating the results.

Definition Classes
Inherited from:
StrictOptimizedSortedSetOps
Source
StrictOptimizedSortedSetOps.scala
overridedefflatMap[B](f:A=>IterableOnce[B]):Set[B]

Builds a new iterable collection by applying a function to all elements of this iterable collection and using the elements of the resulting collections.

Builds a new iterable collection by applying a function to all elements of this iterable collection and using the elements of the resulting collections.

For example:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

The type of the resulting collection is guided by the static type of iterable collection. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Setdef lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)// lettersOf will return a Set[Char], not a Seqdef lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => word.toSeq)// xs will be an Iterable[Int]val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)// ys will be a Map[Int, Int]val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

Type parameters

B

the element type of the returned collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

a new iterable collection resulting from applying the given collection-valued functionf to each element of this iterable collection and concatenating the results.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
overridedefflatten[B](implicittoIterableOnce:A=>IterableOnce[B]):Set[B]

Converts this iterable collection of iterable collections into a iterable collection formed by the elements of these iterable collections.

Converts this iterable collection of iterable collections into a iterable collection formed by the elements of these iterable collections.

The resulting collection's type will be guided by the type of iterable collection. For example:

val xs = List(           Set(1, 2, 3),           Set(1, 2, 3)         ).flatten// xs == List(1, 2, 3, 1, 2, 3)val ys = Set(           List(1, 2, 3),           List(3, 2, 1)         ).flatten// ys == Set(1, 2, 3)

Type parameters

B

the type of the elements of each iterable collection.

Value parameters

asIterable

an implicit conversion which asserts that the element type of this iterable collection is anIterable.

Attributes

Returns

a new iterable collection resulting from concatenating all element iterable collections.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
deffold[A1 >:A](z:A1)(op: (A1,A1)=>A1):A1

Applies the given binary operatorop to the given initial valuez and all elements of this collection.

Applies the given binary operatorop to the given initial valuez and all elements of this collection.

For each application of the operator, each operand is either an element of this collection, the initial value, or another such application of the operator.

The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation. The initial value may be used an arbitrary number of times, but at least once.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative. In either case, it is also necessary that the initial value be a neutral value for the operator, e.g.Nil forList concatenation or1 for multiplication.

The default implementation inIterableOnce is equivalent tofoldLeft but may be overridden for more efficient traversal orders.

Note: will not terminate for infinite-sized collections.

Type parameters

A1

The type parameter for the binary operator, a supertype ofA.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

z

An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value forop for the result to always be the same across runs.

Attributes

Returns

The result of applyingop between all the elements andz, orz if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deffoldLeft[B](z:B)(op: (B,A)=>B):B

Applies the given binary operatorop to the given initial valuez and all elements of this collection, going left to right.

Applies the given binary operatorop to the given initial valuez and all elements of this collection, going left to right. Returns the initial value if this collection is empty.

"Going left to right" only makes sense if this collection is ordered: then ifx1,x2, ...,xn are the elements of this collection, the result isop( op( ... op( op(z, x1), x2) ... ), xn).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this collection and the initial value all appear exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator.

Value parameters

op

A binary operator.

z

An initial value.

Attributes

Returns

The result of applyingop toz and all elements of this collection, going left to right. Returnsz if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deffoldRight[B](z:B)(op: (A,B)=>B):B

Applies the given binary operatorop to all elements of this collection and the given initial valuez, going right to left.

Applies the given binary operatorop to all elements of this collection and the given initial valuez, going right to left. Returns the initial value if this collection is empty.

"Going right to left" only makes sense if this collection is ordered: then ifx1,x2, ...,xn are the elements of this collection, the result isop(x1, op(x2, op( ... op(xn, z) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this collection and the initial value all appear exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator.

Value parameters

op

A binary operator.

z

An initial value.

Attributes

Returns

The result of applyingop to all elements of this collection andz, going right to left. Returnsz if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

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

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

Note: may not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

true if this collection is empty or the given predicatep holds for all elements of this collection, otherwisefalse.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override protecteddeffromSpecific(coll:IterableOnce[A]):TreeSet[A]

Defines how to turn a givenIterable[A] into a collection of typeC.

Defines how to turn a givenIterable[A] into a collection of typeC.

This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.

Attributes

Note

When implementing a custom collection type and refiningC to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case whereC =:= CC[A], this can be done by mixing in thescala.collection.IterableFactoryDefaults trait, which implements the method usingiterableFactory.

As witnessed by the@uncheckedVariance annotation, using this method might be unsound. However, as long as it is called with anIterable[A] obtained fromthis collection (as it is the case in the implementations of operations where we use aView[A]), it is safe.

Definition Classes
Inherited from:
SortedSetFactoryDefaults
Source
Iterable.scala
defgroupBy[K](f:A=>K):Map[K,TreeSet[A]]

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

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

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

K

the type of keys returned by the discriminator function.

Value parameters

f

the discriminator function.

Attributes

Returns

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

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

That is, every keyk is bound to a iterable collection of those elementsx for whichf(x) equalsk.

Inherited from:
IterableOps
Source
Iterable.scala
defgroupMap[K,B](key:A=>K)(f:A=>B):Map[K,Set[B]]

Partitions this iterable collection into a map of iterable collections according to a discriminator functionkey.

Partitions this iterable collection into a map of iterable collections according to a discriminator functionkey. Each element in a group is transformed into a value of typeB using thevalue function.

It is equivalent togroupBy(key).mapValues(_.map(f)), but more efficient.

case class User(name: String, age: Int)def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =  users.groupMap(_.age)(_.name)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

Value parameters

f

the element transformation function

key

the discriminator function

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
defgroupMapReduce[K,B](key:A=>K)(f:A=>B)(reduce: (B,B)=>B):Map[K,B]

Partitions this iterable collection into a map according to a discriminator functionkey.

Partitions this iterable collection into a map according to a discriminator functionkey. All the values that have the same discriminator are then transformed by thef function and then reduced into a single value with thereduce function.

It is equivalent togroupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

def occurrences[A](as: Seq[A]): Map[A, Int] =  as.groupMapReduce(identity)(_ => 1)(_ + _)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala

Partitions elements in fixed size iterable collections.

Partitions elements in fixed size iterable collections.

Value parameters

size

the number of elements per group

Attributes

Returns

An iterator producing iterable collections of sizesize, except the last will be less than sizesize if the elements don't divide evenly.

See also
Inherited from:
IterableOps
Source
Iterable.scala
overridedefhashCode():Int

Calculates a hash code value for the object.

Calculates 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) returnsfalse). A degenerate implementation could always return0. However, it is required that if two objects are equal (o1.equals(o2) returnstrue) 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 theequals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Inherited from:
Set
Source
Set.scala

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.

Attributes

Returns

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

Inherited from:
IterableOps
Source
Iterable.scala

The initial part of the collection without its last element.

The initial part of the collection without its last element.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala

Iterates over the inits of this iterable collection.

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

Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns

an iterator over all the inits of this iterable collection

Example

List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

Inherited from:
IterableOps
Source
Iterable.scala
defintersect(that:Set[A]):TreeSet[A]

Computes the intersection between this set and another set.

Computes the intersection between this set and another set.

Value parameters

that

the set to intersect with.

Attributes

Returns

a new set consisting of all elements that are both in this set and in the given setthat.

Inherited from:
SetOps
Source
Set.scala

Tests whether this iterable collection can be repeatedly traversed.

Tests whether this iterable collection can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Attributes

Returns

true if it is repeatedly traversable,false otherwise.

Definition Classes
Inherited from:
IterableOps
Source
Iterable.scala

The companion object of this mutable set, providing various factory methods.

The companion object of this mutable set, providing various factory methods.

Attributes

Note

When implementing a custom collection type and refiningCC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

Definition Classes
Inherited from:
Set
Source
Set.scala
deflastKey:A

Returns the last key of the collection.

Returns the last key of the collection.

Attributes

Inherited from:
SortedSetOps
Source
SortedSet.scala

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.

Attributes

Returns

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

Inherited from:
IterableOps
Source
Iterable.scala
deflazyZip[B](that:Iterable[B]):LazyZip2[A,B,this.type]

Analogous tozip except that the elements in each collection are not consumed until a strict operation is invoked on the returnedLazyZip2 decorator.

Analogous tozip except that the elements in each collection are not consumed until a strict operation is invoked on the returnedLazyZip2 decorator.

Calls tolazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

val xs = List(1, 2, 3)val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)// res == List(4, 8, 12)

Type parameters

B

the type of the second element in each eventual pair

Value parameters

that

the iterable providing the second element of each eventual pair

Attributes

Returns

a decoratorLazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls tolazyZip. Implicit conversion toIterable[(A, B)] is also supported.

Inherited from:
Iterable
Source
Iterable.scala
overridedefmap[B](f:A=>B)(implicitev:Ordering[B]):TreeSet[B]

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

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

Type parameters

B

the element type of the returned collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

a new set resulting from applying the given functionf to each element of this set and collecting the results.

Definition Classes
Inherited from:
StrictOptimizedSortedSetOps
Source
StrictOptimizedSortedSetOps.scala
overridedefmap[B](f:A=>B):Set[B]

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

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

Type parameters

B

the element type of the returned iterable collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

a new iterable collection resulting from applying the given functionf to each element of this iterable collection and collecting the results.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
defmapResult[NewTo](f:TreeSet[A]=>NewTo):Builder[A,NewTo]

A builder resulting from this builder by mapping the result usingf.

A builder resulting from this builder by mapping the result usingf.

Attributes

Inherited from:
Builder
Source
Builder.scala
overridedefmax[B >:A](implicitord:Ordering[B]):A

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

the largest element of this set with respect to the orderingord.

Throws

UnsupportedOperationExceptionif this set is empty.

Definition Classes
Inherited from:
SortedSetOps
Source
SortedSet.scala
defmaxBy[B](f:A=>B)(implicitord:Ordering[B]):A

Finds the first element which yields the largest value measured by functionf.

Finds the first element which yields the largest value measured by functionf.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the functionf.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

the first element of this collection with the largest value measured by functionf with respect to the orderingcmp.

Throws

UnsupportedOperationExceptionif this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defmaxByOption[B](f:A=>B)(implicitord:Ordering[B]):Option[A]

Finds the first element which yields the largest value measured by functionf.

Finds the first element which yields the largest value measured by functionf.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the functionf.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

an option value containing the first element of this collection with the largest value measured by functionf with respect to the orderingcmp.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defmaxOption[B >:A](implicitord:Ordering[B]):Option[A]

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the largest element of this collection with respect to the orderingord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
overridedefmin[B >:A](implicitord:Ordering[B]):A

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

the smallest element of this set with respect to the orderingord.

Throws

UnsupportedOperationExceptionif this set is empty.

Definition Classes
Inherited from:
SortedSetOps
Source
SortedSet.scala
defminBy[B](f:A=>B)(implicitord:Ordering[B]):A

Finds the first element which yields the smallest value measured by functionf.

Finds the first element which yields the smallest value measured by functionf.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the functionf.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

the first element of this collection with the smallest value measured by functionf with respect to the orderingcmp.

Throws

UnsupportedOperationExceptionif this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defminByOption[B](f:A=>B)(implicitord:Ordering[B]):Option[A]

Finds the first element which yields the smallest value measured by functionf.

Finds the first element which yields the smallest value measured by functionf.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the functionf.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

an option value containing the first element of this collection with the smallest value measured by functionf with respect to the orderingcmp.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defminOption[B >:A](implicitord:Ordering[B]):Option[A]

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the smallest element of this collection with respect to the orderingord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Displays all elements of this collection in a string.

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldefmkString(sep:String):String

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

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

Delegates to addString, which can be overridden.

Value parameters

sep

the separator string.

Attributes

Returns

a string representation of this collection. In the resulting string the string representations (w.r.t. the methodtoString) of all elements of this collection are separated by the stringsep.

Example

List(1, 2, 3).mkString("|") = "1|2|3"

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldefmkString(start:String,sep:String,end:String):String

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

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

Delegates to addString, which can be overridden.

Value parameters

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

a string representation of this collection. The resulting string begins with the stringstart and ends with the stringend. Inside, the string representations (w.r.t. the methodtoString) of all elements of this collection are separated by the stringsep.

Example

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override protecteddefnewSpecificBuilder:Builder[A,TreeSet[A]]

Attributes

Returns

a strict builder for the same collection type. Note that in the case of lazy collections (e.g.scala.collection.View orscala.collection.immutable.LazyList), it is possible to implement this method but the resultingBuilder will break laziness. As a consequence, operations should preferably be implemented withfromSpecific instead of this method.

Note

When implementing a custom collection type and refiningC to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case whereC =:= CC[A], this can be done by mixing in thescala.collection.IterableFactoryDefaults trait, which implements the method usingiterableFactory.

As witnessed by the@uncheckedVariance annotation, using this method might be unsound. However, as long as the returned builder is only fed withA values taken fromthis instance, it is safe.

Definition Classes
Inherited from:
SortedSetFactoryDefaults
Source
Iterable.scala

Tests whether the collection is not empty.

Tests whether the collection is not empty.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
overridedefpartition(p:A=>Boolean): (TreeSet[A],TreeSet[A])

A pair of, first, all elements that satisfy predicatep and, second, all elements that do not.

A pair of, first, all elements that satisfy predicatep and, second, all elements that do not. Interesting because it splits a collection in two.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version ofpartition inStrictOptimizedIterableOps, which requires only a single traversal.

Attributes

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
overridedefpartitionMap[A1,A2](f:A=>Either[A1,A2]): (Set[A1],Set[A2])

Applies a functionf to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned byf that were wrapped inscala.util.Left, and the second one made of those wrapped inscala.util.Right.

Applies a functionf to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned byf that were wrapped inscala.util.Left, and the second one made of those wrapped inscala.util.Right.

Example:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap { case i: Int => Left(i) case s: String => Right(s)}// xs == (Iterable(1, 2, 3),//        Iterable(one, two, three))

Type parameters

A1

the element type of the first resulting collection

A2

the element type of the second resulting collection

Value parameters

f

the 'split function' mapping the elements of this iterable collection to anscala.util.Either

Attributes

Returns

a pair of iterable collections: the first one made of those values returned byf that were wrapped inscala.util.Left, and the second one made of those wrapped inscala.util.Right.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
defproduct[B >:A](implicitnum:Numeric[B]):B

Multiplies together the elements of this collection.

Multiplies together the elements of this collection.

The default implementation usesreduce for a known non-empty collection,foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

B

the result type of the* operator.

Value parameters

num

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

Attributes

Returns

the product of all elements of this collection with respect to the* operator innum.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defrange(from:A,until:A):TreeSet[A]

Creates a ranged projection of this collection with both a lower-bound and an upper-bound.

Creates a ranged projection of this collection with both a lower-bound and an upper-bound.

Value parameters

from

The lower-bound (inclusive) of the ranged projection.

until

The upper-bound (exclusive) of the ranged projection.

Attributes

Inherited from:
SortedOps
Source
SortedOps.scala
defrangeFrom(from:A):TreeSet[A]

Creates a ranged projection of this collection with no upper-bound.

Creates a ranged projection of this collection with no upper-bound.

Value parameters

from

The lower-bound (inclusive) of the ranged projection.

Attributes

Inherited from:
SortedOps
Source
SortedOps.scala
defrangeTo(to:A):TreeSet[A]

Create a range projection of this collection with no lower-bound.

Create a range projection of this collection with no lower-bound.

Value parameters

to

The upper-bound (inclusive) of the ranged projection.

Attributes

Inherited from:
SortedSetOps
Source
SortedSet.scala
defrangeUntil(until:A):TreeSet[A]

Creates a ranged projection of this collection with no lower-bound.

Creates a ranged projection of this collection with no lower-bound.

Value parameters

until

The upper-bound (exclusive) of the ranged projection.

Attributes

Inherited from:
SortedOps
Source
SortedOps.scala
defreduce[B >:A](op: (B,B)=>B):B

Applies the given binary operatorop to all elements of this collection.

Applies the given binary operatorop to all elements of this collection.

For each application of the operator, each operand is either an element of this collection or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type parameter for the binary operator, a supertype ofA.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of applyingop between all the elements if the collection is nonempty.

Throws

UnsupportedOperationExceptionif this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defreduceLeft[B >:A](op: (B,A)=>B):B

Applies the given binary operatorop to all elements of this collection, going left to right.

Applies the given binary operatorop to all elements of this collection, going left to right.

"Going left to right" only makes sense if this collection is ordered: then ifx1,x2, ...,xn are the elements of this collection, the result isop( op( op( ... op(x1, x2) ... ), xn-1), xn).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this collection and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype ofA.

Value parameters

op

A binary operator.

Attributes

Returns

The result of applyingop to all elements of this collection, going left to right.

Throws

UnsupportedOperationExceptionif this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defreduceLeftOption[B >:A](op: (B,A)=>B):Option[B]

If this collection is nonempty, reduces it with the given binary operatorop, going left to right.

If this collection is nonempty, reduces it with the given binary operatorop, going left to right.

The behavior is the same asreduceLeft except that the value isNone if the collection is empty. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype ofA.

Value parameters

op

A binary operator.

Attributes

Returns

The result of reducing this collection withop going left to right if the collection is nonempty, inside aSome, andNone otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defreduceOption[B >:A](op: (B,B)=>B):Option[B]

If this collection is nonempty, reduces it with the given binary operatorop.

If this collection is nonempty, reduces it with the given binary operatorop.

The behavior is the same asreduce except that the value isNone if the collection is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

A type parameter for the binary operator, a supertype ofA.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of reducing this collection withop if the collection is nonempty, inside aSome, andNone otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defreduceRight[B >:A](op: (A,B)=>B):B

Applies the given binary operatorop to all elements of this collection, going right to left.

Applies the given binary operatorop to all elements of this collection, going right to left.

"Going right to left" only makes sense if this collection is ordered: then ifx1,x2, ...,xn are the elements of this collection, the result isop(x1, op(x2, op( ... op(xn-1, xn) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this collection and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype ofA.

Value parameters

op

A binary operator.

Attributes

Returns

The result of applyingop to all elements of this collection, going right to left.

Throws

UnsupportedOperationExceptionif this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defreduceRightOption[B >:A](op: (A,B)=>B):Option[B]

If this collection is nonempty, reduces it with the given binary operatorop, going right to left.

If this collection is nonempty, reduces it with the given binary operatorop, going right to left.

The behavior is the same asreduceRight except that the value isNone if the collection is empty. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype ofA.

Value parameters

op

A binary operator.

Attributes

Returns

The result of reducing this collection withop going right to left if the collection is nonempty, inside aSome, andNone otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defremove(elem:A):Boolean

Removes an element from this set.

Removes an element from this set.

Value parameters

elem

the element to be removed

Attributes

Returns

true if this set contained the element before it was removed

Inherited from:
SetOps
Source
Set.scala
defresult():TreeSet[A]

Result collection consisting of all elements appended so far.

Result collection consisting of all elements appended so far.

Attributes

Inherited from:
SetOps
Source
Set.scala
protecteddefreversed:Iterable[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defscan[B >:A](z:B)(op: (B,B)=>B):Set[B]

Computes a prefix scan of the elements of the collection.

Computes a prefix scan of the elements of the collection.

Note: The neutral elementz may be applied more than once.

Type parameters

B

element type of the resulting collection

Value parameters

op

the associative operator for the scan

z

neutral element for the operatorop

Attributes

Returns

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

Inherited from:
IterableOps
Source
Iterable.scala
overridedefscanLeft[B](z:B)(op: (B,A)=>B):Set[B]

Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.

Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

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

Type parameters

B

the type of the elements in the resulting collection

Value parameters

op

the binary operator applied to the intermediate result and the element

z

the initial value

Attributes

Returns

collection with intermediate results

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
defscanRight[B](z:B)(op: (A,B)=>B):Set[B]

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

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

Note: will not terminate for infinite-sized collections.

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

Note: Even when applied to a view or a lazy collection it will always force the elements.

Example:

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

Type parameters

B

the type of the elements in the resulting collection

Value parameters

op

the binary operator applied to the intermediate result and the element

z

the initial value

Attributes

Returns

collection with intermediate results

Inherited from:
IterableOps
Source
Iterable.scala

Compares the size of this iterable collection to the size of anotherIterable.

Compares the size of this iterable collection to the size of anotherIterable.

Value parameters

that

theIterable whose size is compared with this iterable collection's size.

Attributes

Returns

A valuex where

x <  0       if this.size <  that.sizex == 0       if this.size == that.sizex >  0       if this.size >  that.size

The method as implemented here does not callsize directly; its running time isO(this.size min that.size) instead ofO(this.size + that.size). The method should be overridden if computingsize is cheap andknownSize returns-1.

Inherited from:
IterableOps
Source
Iterable.scala
defsizeCompare(otherSize:Int):Int

Compares the size of this iterable collection to a test value.

Compares the size of this iterable collection to a test value.

Value parameters

otherSize

the test value that gets compared with the size.

Attributes

Returns

A valuex where

x <  0       if this.size <  otherSizex == 0       if this.size == otherSizex >  0       if this.size >  otherSize

The method as implemented here does not callsize directly; its running time isO(size min otherSize) instead ofO(size). The method should be overridden if computingsize is cheap andknownSize returns-1.

See also
Inherited from:
IterableOps
Source
Iterable.scala
finaldefsizeHint(coll:IterableOnce[_],delta:Int = ...):Unit

Gives a hint that theresult of this builder is expected to have the same size as the given collection, plus some delta.

Gives a hint that theresult of this builder is expected to have the same size as the given collection, plus some delta.

This method provides a hint only if the collection has a known size, as specified by the following pseudocode:

if (coll.knownSize != -1)  if (coll.knownSize + delta <= 0) sizeHint(0)  else sizeHint(coll.knownSize + delta)

If the delta is negative and the result size is known to be negative, then the size hint is issued at zero.

Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, i.e., if a different number of elements is added.

Value parameters

coll

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

delta

a correction to add to thecoll.size to produce the size hint (zero if omitted).

Attributes

Inherited from:
Builder
Source
Builder.scala
defsizeHint(size:Int):Unit

Gives a hint how many elements are expected to be added in total by the timeresult is called.

Gives a hint how many elements are expected to be added in total by the timeresult is called.

Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, e.g., a different number of elements is added, or the hint is out of range.

The default implementation simply ignores the hint.

Value parameters

size

the hint how many elements will be added.

Attributes

Inherited from:
Builder
Source
Builder.scala
finaldefsizeHintBounded(size:Int,boundingColl:Iterable[_]):Unit

Gives a hint how many elements are expected to be added when the nextresult 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 nextresult 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.

Value parameters

boundingColl

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

size

the hint how many elements will be added.

Attributes

Inherited from:
Builder
Source
Builder.scala

Returns a value class containing operations for comparing the size of this iterable collection to a test value.

Returns a value class containing operations for comparing the size of this iterable collection to a test value.

These operations are implemented in terms ofsizeCompare(Int), and allow the following more readable usages:

this.sizeIs < size     // this.sizeCompare(size) < 0this.sizeIs <= size    // this.sizeCompare(size) <= 0this.sizeIs == size    // this.sizeCompare(size) == 0this.sizeIs != size    // this.sizeCompare(size) != 0this.sizeIs >= size    // this.sizeCompare(size) >= 0this.sizeIs > size     // this.sizeCompare(size) > 0

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
defslice(from:Int,until:Int):TreeSet[A]

Selects an interval of elements.

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

from <= indexOf(x) < until

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

Value parameters

from

the lowest index to include from this iterable collection.

until

the lowest index to EXCLUDE from this iterable collection.

Attributes

Returns

a iterable collection containing the elements greater than or equal to indexfrom extending up to (but not including) indexuntil of this iterable collection.

Inherited from:
IterableOps
Source
Iterable.scala
defsliding(size:Int,step:Int):Iterator[TreeSet[A]]

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.)

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

Value parameters

size

the number of elements per group

step

the distance between the first elements of successive groups

Attributes

Returns

An iterator producing iterable collections of sizesize, except the last element (which may be the only element) will be smaller if there are fewer thansize elements remaining to be grouped.

See also
Example

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Inherited from:
IterableOps
Source
Iterable.scala

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

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

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

Value parameters

size

the number of elements per group

Attributes

Returns

An iterator producing iterable collections of sizesize, except for a non-empty collection with less thansize elements, which returns an iterator that produces the source collection itself as its only element.

See also
Example

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Inherited from:
IterableOps
Source
Iterable.scala
overridedefspan(p:A=>Boolean): (TreeSet[A],TreeSet[A])

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

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

Note:c span p is equivalent to (but possibly more efficient than)(c takeWhile p, c dropWhile p), provided the evaluation of the predicatep does not cause any side-effects.

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

Value parameters

p

the test predicate

Attributes

Returns

a pair consisting of the longest prefix of this iterable collection whose elements all satisfyp, and the rest of this iterable collection.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
overridedefsplitAt(n:Int): (TreeSet[A],TreeSet[A])

Splits this iterable collection into a prefix/suffix pair at a given position.

Splits this iterable collection into a prefix/suffix pair 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.

Value parameters

n

the position at which to split.

Attributes

Returns

a pair of iterable collections consisting of the firstn elements of this iterable collection, and the other elements.

Definition Classes
Inherited from:
IterableOps
Source
Iterable.scala
defsubsetOf(that:Set[A]):Boolean

Tests whether this set is a subset of another set.

Tests whether this set is a subset of another set.

Value parameters

that

the set to test.

Attributes

Returns

true if this set is a subset ofthat, i.e. if every element of this set is also an element ofthat.

Inherited from:
SetOps
Source
Set.scala

An iterator over all subsets of this set.

An iterator over all subsets of this set.

Attributes

Returns

the iterator.

Inherited from:
SetOps
Source
Set.scala

An iterator over all subsets of this set of the given size.

An iterator over all subsets of this set of the given size. If the requested size is impossible, an empty iterator is returned.

Value parameters

len

the size of the subsets.

Attributes

Returns

the iterator.

Inherited from:
SetOps
Source
Set.scala
defsubtractAll(xs:IterableOnce[A]):this.type

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

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

Value parameters

xs

the iterator producing the elements to remove.

Attributes

Returns

the shrinkable collection itself

Inherited from:
Shrinkable
Source
Shrinkable.scala
defsum[B >:A](implicitnum:Numeric[B]):B

Sums the elements of this collection.

Sums the elements of this collection.

The default implementation usesreduce for a known non-empty collection,foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

B

the result type of the+ operator.

Value parameters

num

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

Attributes

Returns

the sum of all elements of this collection with respect to the+ operator innum.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

The rest of the collection without its first element.

The rest of the collection without its first element.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala

Iterates over the tails of this iterable collection.

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

Attributes

Returns

an iterator over all the tails of this iterable collection

Example

List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

Inherited from:
IterableOps
Source
Iterable.scala
deftake(n:Int):TreeSet[A]

Selects the firstn elements.

Selects the firstn elements.

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

Value parameters

n

the number of elements to take from this iterable collection.

Attributes

Returns

a iterable collection consisting only of the firstn elements of this iterable collection, or else the whole iterable collection, if it has less thann elements. Ifn is negative, returns an empty iterable collection.

Inherited from:
IterableOps
Source
Iterable.scala
overridedeftakeRight(n:Int):TreeSet[A]

A collection containing the lastn elements of this collection.

A collection containing the lastn elements of this collection.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

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

Value parameters

p

The predicate used to test elements.

Attributes

Returns

the longest prefix of this iterable collection whose elements all satisfy the predicatep.

Inherited from:
IterableOps
Source
Iterable.scala
overridedeftapEach[U](f:A=>U):TreeSet[A]

Applies a side-effecting function to each element in this collection.

Applies a side-effecting function to each element in this collection. Strict collections will applyf to their elements immediately, while lazy collections like Views and LazyLists will only applyf on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

U

the return type of f

Value parameters

f

a function to apply to each element in this iterable collection

Attributes

Returns

The same logical collection as this

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
defto[C1](factory:Factory[A,C1]):C1

Given a collection factoryfactory, converts this collection to the appropriate representation for the current element typeA.

Given a collection factoryfactory, converts this collection to the appropriate representation for the current element typeA. Example uses:

xs.to(List)xs.to(ArrayBuffer)xs.to(BitSet) // for xs: Iterable[Int]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deftoArray[B >:A :ClassTag]:Array[B]

Converts this collection to anArray.

Converts this collection to anArray.

Implementation note: DO NOT callArray.from from this method.

Type parameters

B

The type of elements of the result, a supertype ofA.

Attributes

Returns

This collection as anArray[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldeftoBuffer[B >:A]:Buffer[B]

Converts this collection to aBuffer.

Converts this collection to aBuffer.

Type parameters

B

The type of elements of the result, a supertype ofA.

Attributes

Returns

This collection as aBuffer[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Converts this collection to anIndexedSeq.

Converts this collection to anIndexedSeq.

Attributes

Returns

This collection as anIndexedSeq[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deftoList:List[A]

Converts this collection to aList.

Converts this collection to aList.

Attributes

Returns

This collection as aList[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deftoMap[K,V](implicitev:A<:< (K,V)):Map[K,V]

Converts this collection to aMap, given an implicit coercion from the collection's type to a key-value tuple.

Converts this collection to aMap, given an implicit coercion from the collection's type to a key-value tuple.

Type parameters

K

The key type for the resulting map.

V

The value type for the resulting map.

Value parameters

ev

An implicit coercion fromA to[K, V].

Attributes

Returns

This collection as aMap[K, V].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deftoSeq:Seq[A]

Attributes

Returns

This collection as aSeq[A]. This is equivalent toto(Seq) but might be faster.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deftoSet[B >:A]:Set[B]

Converts this collection to aSet.

Converts this collection to aSet.

Type parameters

B

The type of elements of the result, a supertype ofA.

Attributes

Returns

This collection as aSet[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
overridedeftoString():String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Inherited from:
Set
Source
Set.scala

Converts this collection to aVector.

Converts this collection to aVector.

Attributes

Returns

This collection as aVector[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
deftranspose[B](implicitasIterable:A=>Iterable[B]):Set[Set[B]]

Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.

Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.

The resulting collection's type will be guided by the static type of iterable collection. For example:

val xs = List(           Set(1, 2, 3),           Set(4, 5, 6)).transpose// xs == List(//         List(1, 4),//         List(2, 5),//         List(3, 6))val ys = Vector(           List(1, 2, 3),           List(4, 5, 6)).transpose// ys == Vector(//         Vector(1, 4),//         Vector(2, 5),//         Vector(3, 6))

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B

the type of the elements of each iterable collection.

Value parameters

asIterable

an implicit conversion which asserts that the element type of this iterable collection is anIterable.

Attributes

Returns

a two-dimensional iterable collection of iterable collections which has asnth row thenth column of this iterable collection.

Throws

IllegalArgumentExceptionif all collections in this iterable collection are not of the same size.

Inherited from:
IterableOps
Source
Iterable.scala
finaldefunion(that:Set[A]):TreeSet[A]

Computes the union between of set and another set.

Computes the union between of set and another set.

Value parameters

that

the set to form the union with.

Attributes

Returns

a new set consisting of all elements that are in this set or in the given setthat.

Inherited from:
SetOps
Source
Set.scala
overridedefunsorted:Set[A]

Attributes

Definition Classes
Inherited from:
SortedSet
Source
SortedSet.scala
overridedefunzip[A1,A2](implicitasPair:A=> (A1,A2)): (Set[A1],Set[A2])

Converts this iterable collection of pairs into two collections of the first and second half of each pair.

Converts this iterable collection of pairs into two collections of the first and second half of each pair.

val xs = Iterable(           (1, "one"),           (2, "two"),           (3, "three")).unzip// xs == (Iterable(1, 2, 3),//        Iterable(one, two, three))

Type parameters

A1

the type of the first half of the element pairs

A2

the type of the second half of the element pairs

Value parameters

asPair

an implicit conversion which asserts that the element type of this iterable collection is a pair.

Attributes

Returns

a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
overridedefunzip3[A1,A2,A3](implicitasTriple:A=> (A1,A2,A3)): (Set[A1],Set[A2],Set[A3])

Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.

Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.

val xs = Iterable(           (1, "one", '1'),           (2, "two", '2'),           (3, "three", '3')).unzip3// xs == (Iterable(1, 2, 3),//        Iterable(one, two, three),//        Iterable(1, 2, 3))

Type parameters

A1

the type of the first member of the element triples

A2

the type of the second member of the element triples

A3

the type of the third member of the element triples

Value parameters

asTriple

an implicit conversion which asserts that the element type of this iterable collection is a triple.

Attributes

Returns

a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
defupdate(elem:A,included:Boolean):Unit

Updates the presence of a single element in this set.

Updates the presence of a single element in this set.

This method allows one to add or remove an elementelem from this set depending on the value of parameterincluded. Typically, one would use the following syntax:

set(elem) = true  // adds elementset(elem) = false // removes element

Value parameters

elem

the element to be added or removed

included

a flag indicating whether element should be included or excluded.

Attributes

Inherited from:
SetOps
Source
Set.scala
defview:View[A]

A view over the elements of this collection.

A view over the elements of this collection.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala

Creates a non-strict filter of this set.

Creates a non-strict filter of this set.

Note: the difference betweenc filter p andc withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequentmap,flatMap,foreach, andwithFilter operations.

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

Value parameters

p

the predicate used to test elements.

Attributes

Returns

an object of classWithFilter, which supportsmap,flatMap,foreach, andwithFilter operations. All these operations apply to those elements of this set which satisfy the predicatep.

Definition Classes
Inherited from:
SortedSetFactoryDefaults
Source
Iterable.scala
overridedefzip[B](that:IterableOnce[B])(implicitev:Ordering[(A,B)]):TreeSet[(A,B)]

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

Returns a set formed from this set 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.

Type parameters

B

the type of the second half of the returned pairs

Value parameters

that

The iterable providing the second half of each result pair

Attributes

Returns

a new set containing pairs consisting of corresponding elements of this set andthat. The length of the returned collection is the minimum of the lengths of this set andthat.

Definition Classes
Inherited from:
StrictOptimizedSortedSetOps
Source
StrictOptimizedSortedSetOps.scala
overridedefzip[B](that:IterableOnce[B]):Set[(A,B)]

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

Returns a iterable collection formed from this iterable 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.

Type parameters

B

the type of the second half of the returned pairs

Value parameters

that

The iterable providing the second half of each result pair

Attributes

Returns

a new iterable collection containing pairs consisting of corresponding elements of this iterable collection andthat. The length of the returned collection is the minimum of the lengths of this iterable collection andthat.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
defzipAll[A1 >:A,B](that:Iterable[B],thisElem:A1,thatElem:B):Set[(A1,B)]

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

Returns a iterable collection formed from this iterable 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.

Value parameters

that

the iterable providing the second half of each result pair

thatElem

the element to be used to fill up the result ifthat is shorter than this iterable collection.

thisElem

the element to be used to fill up the result if this iterable collection is shorter thanthat.

Attributes

Returns

a new collection of the type of this iterable collection containing pairs consisting of corresponding elements of this iterable collection andthat. The length of the returned collection is the maximum of the lengths of this iterable collection andthat. If this iterable collection is shorter thanthat,thisElem values are used to pad the result. Ifthat is shorter than this iterable collection,thatElem values are used to pad the result.

Inherited from:
IterableOps
Source
Iterable.scala
overridedefzipWithIndex:Set[(A,Int)]

Zips this iterable collection with its indices.

Zips this iterable collection with its indices.

Attributes

Returns

A new iterable collection containing pairs consisting of all elements of this iterable collection paired with their index. Indices start at0.

Example

List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
finaldef|(that:Set[A]):TreeSet[A]

Alias forunion

Alias forunion

Attributes

Inherited from:
SetOps
Source
Set.scala

Deprecated and Inherited methods

def+(elem1:A,elem2:A,elems:A*):TreeSet[A]

Attributes

Deprecated
[Since version 2.13.0]Use ++ with an explicit collection argument instead of + with varargs
Inherited from:
SetOps
Source
Set.scala
def+(elem:A):TreeSet[A]

Attributes

Deprecated
[Since version 2.13.0]Consider requiring an immutable Set or fall back to Set.union
Inherited from:
SetOps
Source
Set.scala
def++:[B >:A](that:IterableOnce[B]):Set[B]

Attributes

Deprecated
[Since version 2.13.0]Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
Source
Iterable.scala
finaldef+=(elem1:A,elem2:A,elems:A*):this.type

Adds two or more elements to this growable collection.

Adds two or more elements to this growable collection.

Value parameters

elem1

the first element to add.

elem2

the second element to add.

elems

the remaining elements to add.

Attributes

Returns

the growable collection itself

Deprecated
[Since version 2.13.0]Use `++=` aka `addAll` instead of varargs `+=`; infix operations with an operand of multiple args will be deprecated
Inherited from:
Growable
Source
Growable.scala
def-(elem1:A,elem2:A,elems:A*):TreeSet[A]

Attributes

Deprecated
[Since version 2.13.0]Use &- with an explicit collection argument instead of - with varargs
Inherited from:
SetOps
Source
Set.scala
def-(elem:A):TreeSet[A]

Attributes

Deprecated
[Since version 2.13.0]Consider requiring an immutable Set or fall back to Set.diff
Inherited from:
SetOps
Source
Set.scala
def--(that:IterableOnce[A]):TreeSet[A]

Attributes

Deprecated
[Since version 2.13.0]Consider requiring an immutable Set
Inherited from:
SetOps
Source
Set.scala
def-=(elem1:A,elem2:A,elems:A*):this.type

Removes two or more elements from this shrinkable collection.

Removes two or more elements from this shrinkable collection.

Value parameters

elem1

the first element to remove.

elem2

the second element to remove.

elems

the remaining elements to remove.

Attributes

Returns

the shrinkable collection itself

Deprecated
[Since version 2.13.3]Use `--=` aka `subtractAll` instead of varargs `-=`; infix operations with an operand of multiple args will be deprecated
Inherited from:
Shrinkable
Source
Shrinkable.scala
finaldef/:[B](z:B)(op: (B,A)=>B):B

Attributes

Deprecated
[Since version 2.13.0]Use foldLeft instead of /:
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldef:\[B](z:B)(op: (A,B)=>B):B

Attributes

Deprecated
[Since version 2.13.0]Use foldRight instead of :\\
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defaggregate[B](z:=>B)(seqop: (B,A)=>B,combop: (B,B)=>B):B

Aggregates the results of applying an operator to subsequent elements.

Aggregates the results of applying an operator to subsequent elements.

Since this method degenerates tofoldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to preferfoldLeft for that case.

Forparallel collections, use theaggregate method specified byscala.collection.parallel.ParIterableLike.

Type parameters

B

the result type, produced byseqop,combop, and by this function as a final result.

Value parameters

combop

an associative operator for combining sequential results, unused for sequential collections.

seqop

the binary operator used to accumulate the result.

z

the start value, a neutral element forseqop.

Attributes

Deprecated
[Since version 2.13.0]For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.
Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Attributes

Deprecated
[Since version 2.13.0]Use iterableFactory instead
Inherited from:
IterableOps
Source
Iterable.scala
defcompare(k0:A,k1:A):Int

Comparison function that orders keys.

Comparison function that orders keys.

Attributes

Deprecated
[Since version 2.13.0]Use ordering.compare instead
Inherited from:
SortedOps
Source
SortedOps.scala
finaldefcopyToBuffer[B >:A](dest:Buffer[B]):Unit

Attributes

Deprecated
[Since version 2.13.0]Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldeffrom(from:A):TreeSet[A]

Creates a ranged projection of this collection with no upper-bound.

Creates a ranged projection of this collection with no upper-bound.

Value parameters

from

The lower-bound (inclusive) of the ranged projection.

Attributes

Deprecated
[Since version 2.13.0]Use rangeFrom
Inherited from:
SortedOps
Source
SortedOps.scala

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

Tests whether this collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such asStream, the predicate returnstrue if all elements have been computed. It returnsfalse if the stream is not yet evaluated to the end. Non-empty Iterators usually returnfalse even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first thathasDefiniteSize returnstrue. However, checkinghasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

Attributes

Returns

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

See also

methodknownSize for a more useful alternative

Deprecated
[Since version 2.13.0]Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even thoughhasDefiniteSize returnsfalse.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
defkeysIteratorFrom(start:A):Iterator[A]

Attributes

Deprecated
[Since version 2.13.0]Use `iteratorFrom` instead.
Inherited from:
SortedSetOps
Source
SortedSet.scala
finaldefrepr:TreeSet[A]

Attributes

Deprecated
[Since version 2.13.0]Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
Source
Iterable.scala
finaldefretain(p:A=>Boolean):Unit

Attributes

Deprecated
[Since version 2.13.0]Use filterInPlace instead
Inherited from:
SetOps
Source
Set.scala
defseq:this.type

Attributes

Deprecated
[Since version 2.13.0]Iterable.seq always returns the iterable itself
Inherited from:
Iterable
Source
Iterable.scala
finaldefto(to:A):TreeSet[A]

Create a range projection of this collection with no lower-bound.

Create a range projection of this collection with no lower-bound.

Value parameters

to

The upper-bound (inclusive) of the ranged projection.

Attributes

Deprecated
[Since version 2.13.0]Use rangeTo
Inherited from:
SortedOps
Source
SortedOps.scala
finaldeftoIterable:this.type

Attributes

Returns

This collection as anIterable[A]. No new collection will be built ifthis is already anIterable[A].

Deprecated
[Since version 2.13.7]toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
Source
Iterable.scala
finaldeftoIterator:Iterator[A]

Attributes

Deprecated
[Since version 2.13.0]Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
finaldeftoStream:Stream[A]

Attributes

Deprecated
[Since version 2.13.0]Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Converts this iterable collection to an unspecified Iterable.

Converts this iterable collection to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Attributes

Returns

An Iterable containing all elements of this iterable collection.

Deprecated
[Since version 2.13.0]toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
Source
Iterable.scala
finaldefuntil(until:A):TreeSet[A]

Creates a ranged projection of this collection with no lower-bound.

Creates a ranged projection of this collection with no lower-bound.

Value parameters

until

The upper-bound (exclusive) of the ranged projection.

Attributes

Deprecated
[Since version 2.13.0]Use rangeUntil
Inherited from:
SortedOps
Source
SortedOps.scala
defview(from:Int,until:Int):View[A]

A view over a slice of the elements of this collection.

A view over a slice of the elements of this collection.

Attributes

Deprecated
[Since version 2.13.0]Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Source
Iterable.scala

Implicits

Implicits

implicitvalordering:Ordering[A]

Attributes

Source
TreeSet.scala
In this article
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL

[8]ページ先頭

©2009-2025 Movatter.jp