Class scala.Enumeration.ValueSet
Companion object ValueSet
class ValueSet extends AbstractSet[Value] with SortedSet[Value] with SortedSetLike[Value, ValueSet] with Serializable
Type Members
type Self = ValueSet
The type implementing this traversable
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
class WithFilter extends FilterMonadic[A, Repr]
A class supporting filtered operations. Instances of this class are returned by method withFilter
.
- Definition Classes
- TraversableLike
Value Members
final def !=(arg0: Any): Boolean
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
final def ##(): Int
Equivalent to x.hashCode
except for boxed numeric types and null
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null
returns a hashcode where null.hashCode
throws a NullPointerException
.
- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
def &(that: GenSet[Value]): ValueSet
Computes the intersection between this set and another set.
Note: Same as intersect
.
- that
the set to intersect with.
- returns
a new set consisting of all elements that are both in this set and in the given set
that
.
- Definition Classes
- GenSetLike
def &~(that: GenSet[Value]): ValueSet
The difference of this set and another set.
Note: Same as diff
.
- that
the set of elements to exclude.
- returns
a set containing those elements of this set that are not also contained in the given set
that
.
- Definition Classes
- GenSetLike
def +(value: Value): ValueSet
Creates a new set with an additional element, unless the element is already present.
- returns
a new set that contains all elements of this set and that also contains
elem
.
- Definition Classes
- ValueSet → SetLike → GenSetLike
def +(elem1: Value, elem2: Value, elems: Value*): ValueSet
Creates a new set with additional elements, omitting duplicates.
This method takes two or more elements to be added. Elements that already exist in the set will not be added. Another overloaded variant of this method handles the case where a single element is added.
Example:
scala> val a = Set(1, 3) + 2 + 3 a: scala.collection.immutable.Set[Int] = Set(1, 3, 2)
- elem1
the first element to add.
- elem2
the second element to add.
- elems
the remaining elements to add.
- returns
a new set with the given elements added, omitting duplicates.
- Definition Classes
- SetLike
def ++(elems: GenTraversableOnce[Value]): ValueSet
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) ++ Set(2, "a") a: scala.collection.immutable.Set[Any] = Set(1, 2, a)
- elems
the collection containing the elements to add.
- returns
a new set with the given elements added, omitting duplicates.
- Definition Classes
- SetLike
def ++[B >: Value, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[ValueSet, B, That]): That
Returns a new traversable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the traversable collection is the most specific superclass encompassing the element types of the two operands.
- B
the element type of the returned collection.
- That
the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.- that
the traversable to append.
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
a new collection of type
That
which contains all elements of this traversable collection followed by all elements ofthat
.
- Definition Classes
- TraversableLike → GenTraversableLike
def ++:[B >: Value, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[ValueSet, B, That]): That
As with ++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.
Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
This overload exists because: for the implementation of ++:
we should reuse that of ++
because many collections override it with more efficient versions.
Since TraversableOnce
has no ++
method, we have to implement that directly, but Traversable
and down can use the overload.
- B
the element type of the returned collection.
- That
the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.- that
the traversable to append.
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
a new collection of type
That
which contains all elements of this traversable collection followed by all elements ofthat
.
- Definition Classes
- TraversableLike
def ++:[B](that: collection.TraversableOnce[B]): SortedSet[B]
As with ++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.
Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
- B
the element type of the returned collection.
- that
the traversable to append.
- returns
a new immutable sorted set which contains all elements of this immutable sorted set followed by all elements of
that
.
- Definition Classes
- TraversableLike
def -(value: Value): ValueSet
Creates a new set with a given element removed from this set.
- returns
a new set that contains all elements of this set but that does not contain
elem
.
- Definition Classes
- ValueSet → SetLike → Subtractable → GenSetLike
def -(elem1: Value, elem2: Value, elems: Value*): ValueSet
Creates a new collection from this collection with some elements removed.
This method takes two or more elements to be removed. Another overloaded variant of this method handles the case where a single element is removed.
- elem1
the first element to remove.
- elem2
the second element to remove.
- elems
the remaining elements to remove.
- returns
a new collection that contains all elements of the current collection except one less occurrence of each of the given elements.
- Definition Classes
- Subtractable
def --(xs: GenTraversableOnce[Value]): ValueSet
Creates a new collection from this collection by removing all elements of another collection.
- xs
the collection containing the removed elements.
- returns
a new collection that contains all elements of the current collection except one less occurrence of each of the elements of
elems
.
- Definition Classes
- Subtractable
def ->[B](y: B): (ValueSet, B)
- Implicit
- This member is added by an implicit conversion from ValueSet to ArrowAssoc[ValueSet] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
def /:[B](z: B)(op: (B, Value) ⇒ B): B
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: /:
is alternate syntax for foldLeft
; z /: xs
is the same as xs foldLeft z
.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (5 /: a)(_+_) b: Int = 15 scala> val c = (5 /: a)((x,y) => x + y) c: Int = 15
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
-
the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right with the start valuez
on the left:op(...op(op(z, x_1), x_2), ..., x_n)
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def :\[B](z: B)(op: (Value, B) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: :\
is alternate syntax for foldRight
; xs :\ z
is the same as xs foldRight z
.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (a :\ 5)(_+_) b: Int = 15 scala> val c = (a :\ 5)((x,y) => x + y) c: Int = 15
- B
the result type of the binary operator.
- z
the start value
- op
the binary operator
- returns
-
the result of inserting
op
between consecutive elements of this traversable or iterator, going right to left with the start valuez
on the right:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def <(that: ValueSet): Boolean
Returns true if this
is less than that
- Implicit
- This member is added by an implicit conversion from ValueSet to math.Ordered[ValueSet] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ValueSet] is in scope.
- Definition Classes
- Ordered
def <=(that: ValueSet): Boolean
Returns true if this
is less than or equal to that
.
- Implicit
- This member is added by an implicit conversion from ValueSet to math.Ordered[ValueSet] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ValueSet] is in scope.
- Definition Classes
- Ordered
final def ==(arg0: Any): Boolean
The expression x == that
is equivalent to if (x eq null) that eq null else x.equals(that)
.
- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
def >(that: ValueSet): Boolean
Returns true if this
is greater than that
.
- Implicit
- This member is added by an implicit conversion from ValueSet to math.Ordered[ValueSet] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ValueSet] is in scope.
- Definition Classes
- Ordered
def >=(that: ValueSet): Boolean
Returns true if this
is greater than or equal to that
.
- Implicit
- This member is added by an implicit conversion from ValueSet to math.Ordered[ValueSet] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ValueSet] is in scope.
- Definition Classes
- Ordered
def addString(b: StringBuilder): StringBuilder
Appends all elements of this traversable or iterator to a string builder. The written text consists of the string representations (w.r.t. the method toString
) of all elements of this traversable or iterator 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
- b
the string builder to which elements are appended.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
def addString(b: StringBuilder, sep: String): StringBuilder
Appends all elements of this traversable or iterator to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString
) of all elements of this traversable or iterator, separated by the string sep
.
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
- b
the string builder to which elements are appended.
- sep
the separator string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings. The written text begins with the string start
and ends with the string end
. Inside, the string representations (w.r.t. the method toString
) of all elements of this traversable or iterator are separated by the string sep
.
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)
- b
the string builder to which elements are appended.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
def aggregate[B](z: ⇒ B)(seqop: (B, Value) ⇒ B, combop: (B, B) ⇒ B): B
Aggregates the results of applying an operator to subsequent elements.
This is a more general form of fold
and reduce
. It is similar to foldLeft
in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.
aggregate
splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop
, starting with z
(like foldLeft
). Those intermediate results are then combined by using combop
(like fold
). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop
may be invoked an arbitrary number of times (even 0).
As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop
transforms each input character to an Int and adds it to the sum (of the partition). Then, combop
just needs to sum up the intermediate results of the partitions:
List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
- B
the type of accumulated results
- z
the initial value for the accumulated result of the partition - this will typically be the neutral element for the
seqop
operator (e.g.Nil
for list concatenation or0
for summation) and may be evaluated more than once- seqop
an operator used to accumulate results within a partition
- combop
an associative operator used to combine results from different partitions
- Definition Classes
- TraversableOnce → GenTraversableOnce
def andThen[A](g: (Boolean) ⇒ A): (Value) ⇒ A
Composes two instances of Function1 in a new Function1, with this function applied first.
- A
the result type of function
g
- g
a function R => A
- returns
a new function
f
such thatf(x) == g(apply(x))
- Definition Classes
- Function1
- Annotations
- @unspecialized()
def apply(elem: Value): Boolean
Tests if some element is contained in this set.
This method is equivalent to contains
. It allows sets to be interpreted as predicates.
- elem
the element to test for membership.
- returns
true
ifelem
is contained in this set,false
otherwise.
- Definition Classes
- GenSetLike → Function1
final def asInstanceOf[T0]: T0
Cast the receiver object to be of type T0
.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expression List(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
def canEqual(that: Any): Boolean
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
- that
The object with which this iterable collection should be compared
- returns
true
, if this iterable collection can possibly equalthat
,false
otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
- Definition Classes
- IterableLike → Equals
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
def collect[B](pf: PartialFunction[A, B]): SortedSet[B]
Builds a new collection by applying a partial function to all elements of this immutable sorted set on which the function is defined.
- B
the element type of the returned collection.
- pf
the partial function which filters and maps the immutable sorted set.
- returns
a new immutable sorted set resulting from applying the given partial function
pf
to each element on which it is defined and collecting the results. The order of the elements is preserved.
- Definition Classes
- TraversableLike → GenTraversableLike
def collectFirst[B](pf: PartialFunction[Value, B]): Option[B]
Finds the first element of the traversable or iterator 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.
- pf
the partial function
- returns
an option value containing pf applied to the first value for which it is defined, or
None
if none exists.
- Definition Classes
- TraversableOnce
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
def companion: GenericCompanion[Set]
The factory companion object that builds instances of class immutable.Set
. (or its Iterable
superclass where class immutable.Set
is not a Seq
.)
- Definition Classes
- Set → Set → GenSet → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → GenericTraversableTemplate
def compare(k0: Value, k1: Value): Int
Comparison function that orders keys.
- Definition Classes
- Sorted
def compareTo(that: ValueSet): Int
Result of comparing this
with operand that
.
- Implicit
- This member is added by an implicit conversion from ValueSet to math.Ordered[ValueSet] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ValueSet] is in scope.
- Definition Classes
- Ordered → Comparable
def compose[A](g: (A) ⇒ Value): (A) ⇒ Boolean
Composes two instances of Function1 in a new Function1, with this function applied last.
- A
the type to which function
g
can be applied- g
a function A => T1
- returns
a new function
f
such thatf(x) == apply(g(x))
- Definition Classes
- Function1
- Annotations
- @unspecialized()
def contains(v: Value): Boolean
Tests if some element is contained in this set.
- returns
true
ifelem
is contained in this set,false
otherwise.
- Definition Classes
- ValueSet → SetLike → GenSetLike
def copyToArray(xs: Array[A], start: Int, len: Int): Unit
Copies the elements of this immutable sorted set to an array. Fills the given array xs
with at most len
elements of this immutable sorted set, starting at position start
. Copying will stop once either the end of the current immutable sorted set is reached, or the end of the target array is reached, or len
elements have been copied.
- xs
the array to fill.
- start
the starting index.
- len
the maximal number of elements to copy.
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
def copyToArray(xs: Array[A]): Unit
Copies the elements of this immutable sorted set to an array. Fills the given array xs
with values of this immutable sorted set. Copying will stop once either the end of the current immutable sorted set is reached, or the end of the target array is reached.
- xs
the array to fill.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def copyToArray(xs: Array[A], start: Int): Unit
Copies the elements of this immutable sorted set to an array. Fills the given array xs
with values of this immutable sorted set, beginning at index start
. Copying will stop once either the end of the current immutable sorted set is reached, or the end of the target array is reached.
- xs
the array to fill.
- start
the starting index.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def copyToBuffer[B >: Value](dest: Buffer[B]): Unit
Copies all elements of this traversable or iterator to a buffer.
Note: will not terminate for infinite-sized collections.
- dest
The buffer to which elements are copied.
- Definition Classes
- TraversableOnce
def count(p: (Value) ⇒ Boolean): Int
Counts the number of elements in the traversable or iterator which satisfy a predicate.
- p
the predicate used to test elements.
- returns
the number of elements satisfying the predicate
p
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def diff(that: GenSet[Value]): ValueSet
Computes the difference of this set and another set.
- that
the set of elements to exclude.
- returns
a set containing those elements of this set that are not also contained in the given set
that
.
- Definition Classes
- SetLike → GenSetLike
def drop(n: Int): ValueSet
Selects all elements except first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
the number of elements to drop from this iterable collection.
- returns
a iterable collection consisting of all elements of this iterable collection except the first
n
ones, or else the empty iterable collection, if this iterable collection has less thann
elements. Ifn
is negative, don't drop any elements.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
def dropRight(n: Int): ValueSet
Selects all elements except last n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
The number of elements to take
- returns
a iterable collection consisting of all elements of this iterable collection except the last
n
ones, or else the empty iterable collection, if this iterable collection has less thann
elements.
- Definition Classes
- IterableLike
def dropWhile(p: (Value) ⇒ Boolean): ValueSet
Drops longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the longest suffix of this traversable collection whose first element does not satisfy the predicate
p
.
- Definition Classes
- TraversableLike → GenTraversableLike
def empty: ValueSet
Needs to be overridden in subclasses.
- returns
an empty set of type
This
.
- Definition Classes
- ValueSet → SortedSet → SortedSet → SetLike → GenericSetTemplate
def ensuring(cond: (ValueSet) ⇒ Boolean, msg: ⇒ Any): ValueSet
- Implicit
- This member is added by an implicit conversion from ValueSet to Ensuring[ValueSet] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (ValueSet) ⇒ Boolean): ValueSet
- Implicit
- This member is added by an implicit conversion from ValueSet to Ensuring[ValueSet] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ValueSet
- Implicit
- This member is added by an implicit conversion from ValueSet to Ensuring[ValueSet] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): ValueSet
- Implicit
- This member is added by an implicit conversion from ValueSet to Ensuring[ValueSet] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on non-null instances of AnyRef
, and has three additional properties:
-
It is consistent: for any non-null instances
x
and y
of type AnyRef
, multiple invocations of x.eq(y)
consistently returns true
or consistently returns false
.For any non-null instance x
of type AnyRef
, x.eq(null)
and null.eq(x)
returns false
.
null.eq(null)
returns true
. When overriding the equals
or hashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).
- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
def equals(that: Any): Boolean
Compares this set with another object for equality.
Note: This operation contains an unchecked cast: if that
is a set, it will assume with an unchecked cast that it has the same element type as this set. Any subsequent ClassCastException is treated as a false
result.
- that
the other object
- returns
true
ifthat
is a set which contains the same elements as this set.
- Definition Classes
- GenSetLike → Equals → AnyRef → Any
def exists(p: (Value) ⇒ Boolean): Boolean
Tests whether a predicate holds for at least one element of this iterable collection.
Note: may not terminate for infinite-sized collections.
- p
the predicate used to test elements.
- returns
false
if this iterable collection is empty, otherwisetrue
if the given predicatep
holds for some of the elements of this iterable collection, otherwisefalse
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
def filter(p: (Value) ⇒ Boolean): ValueSet
Selects all elements of this traversable collection which satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new traversable collection consisting of all elements of this traversable collection that satisfy the given predicate
p
. The order of the elements is preserved.
- Definition Classes
- TraversableLike → GenTraversableLike
def filterNot(p: (Value) ⇒ Boolean): ValueSet
Selects all elements of this traversable collection which do not satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new traversable collection consisting of all elements of this traversable collection that do not satisfy the given predicate
p
. The order of the elements is preserved.
- Definition Classes
- TraversableLike → GenTraversableLike
def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize
method is invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
def find(p: (Value) ⇒ Boolean): Option[Value]
Finds the first element of the iterable 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.
- p
the predicate used to test elements.
- returns
an option value containing the first element in the iterable collection that satisfies
p
, orNone
if none exists.
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
def firstKey: Value
Returns the first key of the collection.
- Definition Classes
- SortedSetLike → Sorted
def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): SortedSet[B]
Builds a new collection by applying a function to all elements of this immutable sorted set 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 immutable sorted set. This might cause unexpected results sometimes. For example:
// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet) // lettersOf will return a Set[Char], not a Seq def lettersOf(words: Seq[String]) = words.toSet flatMap (word => 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)
- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new immutable sorted set resulting from applying the given collection-valued function
f
to each element of this immutable sorted set and concatenating the results.
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
def flatten[B]: SortedSet[B]
Converts this immutable sorted set of traversable collections into a immutable sorted set formed by the elements of these traversable collections.
The resulting collection's type will be guided by the static type of immutable sorted set. 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)
- B
the type of the elements of each traversable collection.
- returns
a new immutable sorted set resulting from concatenating all element immutable sorted sets.
- Definition Classes
- GenericTraversableTemplate
def fold[A1 >: Value](z: A1)(op: (A1, A1) ⇒ A1): A1
Folds the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
Note: will not terminate for infinite-sized collections.
- A1
a type parameter for the binary operator, a supertype of
A
.- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).- op
a binary operator that must be associative.
- returns
the result of applying the fold operator
op
between all the elements andz
, orz
if this traversable or iterator is empty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def foldLeft[B](z: B)(op: (B, Value) ⇒ B): B
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
-
the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right with the start valuez
on the left:op(...op(z, x_1), x_2, ..., x_n)
where
x1, ..., xn
are the elements of this traversable or iterator. Returnsz
if this traversable or iterator is empty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def foldRight[B](z: B)(op: (Value, B) ⇒ B): B
Applies a binary operator to all elements of this iterable collection and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
-
the result of inserting
op
between consecutive elements of this iterable collection, going right to left with the start valuez
on the right:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this iterable collection. Returnsz
if this iterable collection is empty.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
def forall(p: (Value) ⇒ Boolean): Boolean
Tests whether a predicate holds for all elements of this iterable collection.
Note: may not terminate for infinite-sized collections.
- p
the predicate used to test elements.
- returns
true
if this iterable collection is empty or the given predicatep
holds for all elements of this iterable collection, otherwisefalse
.
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
def foreach(f: (Value) ⇒ Unit): Unit
Applies a function f
to all elements of this immutable sorted set.
Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.
- f
the function that is applied for its side-effect to every element. The result of function
f
is discarded.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
def formatted(fmtstr: String): String
Returns string formatted according to given format
string. Format strings are as for String.format
(@see java.lang.String.format).
- Implicit
- This member is added by an implicit conversion from ValueSet to StringFormat[ValueSet] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
def from(from: Value): ValueSet
Creates a ranged projection of this collection with no upper-bound.
- from
The lower-bound (inclusive) of the ranged projection.
- Definition Classes
- SortedSetLike → Sorted
def genericBuilder[B]: Builder[B, Set[B]]
The generic builder that builds instances of Traversable at arbitrary element types.
- Definition Classes
- GenericTraversableTemplate
final def getClass(): Class[_]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def groupBy[K](f: (Value) ⇒ K): Map[K, ValueSet]
Partitions this traversable collection into a map of traversable collections according to some discriminator function.
Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.
- K
the type of keys returned by the discriminator function.
- f
the discriminator function.
- returns
-
A map from keys to traversable collections such that the following invariant holds:
(xs groupBy f)(k) = xs filter (x => f(x) == k)
That is, every key
k
is bound to a traversable collection of those elementsx
for whichf(x)
equalsk
.
- Definition Classes
- TraversableLike → GenTraversableLike
def grouped(size: Int): collection.Iterator[ValueSet]
Partitions elements in fixed size iterable collections.
- size
the number of elements per group
- returns
An iterator producing iterable collections of size
size
, except the last will be less than sizesize
if the elements don't divide evenly.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
grouped
def hasAll(j: collection.Iterator[Value]): Boolean
- Attributes
- protected
- Definition Classes
- Sorted
def hasDefiniteSize: Boolean
Tests whether this traversable collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream
, the predicate returns true
if all elements have been computed. It returns false
if the stream is not yet evaluated to the end. Non-empty Iterators usually return false
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 that hasDefiniteSize
returns true
. However, checking hasDefiniteSize
can provide an assurance that size is well-defined and non-termination is not a concern.
- returns
true
if this collection is known to have finite size,false
otherwise.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
def hashCode(): Int
The hashCode method for reference types. See hashCode in scala.Any.
- returns
the hash code value for this object.
- Definition Classes
- GenSetLike → AnyRef → Any
def head: Value
Selects the first element of this iterable collection.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the first element of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
- Exceptions thrown
NoSuchElementException
if the iterable collection is empty.
def headOption: Option[Value]
Optionally selects the first element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the first element of this traversable collection if it is nonempty,
None
if it is empty.
- Definition Classes
- TraversableLike → GenTraversableLike
def init: ValueSet
Selects all elements except the last.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
a traversable collection consisting of all elements of this traversable collection except the last one.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
UnsupportedOperationException
if the traversable collection is empty.
def inits: collection.Iterator[ValueSet]
Iterates over the inits of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of init
.
- returns
an iterator over all the inits of this traversable collection
- Definition Classes
- TraversableLike
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
def intersect(that: GenSet[Value]): ValueSet
Computes the intersection between this set and another set.
- that
the set to intersect with.
- returns
a new set consisting of all elements that are both in this set and in the given set
that
.
- Definition Classes
- GenSetLike
def isEmpty: Boolean
Tests if this set is empty.
- returns
true
if there is no element in the set,false
otherwise.
- Definition Classes
- SetLike → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String]
will return false
, while the expression List(1).isInstanceOf[List[String]]
will return true
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
final def isTraversableAgain: Boolean
Tests whether this traversable collection can be repeatedly traversed.
- returns
true
- Definition Classes
- TraversableLike → GenTraversableLike → GenTraversableOnce
def iterator: collection.Iterator[Value]
Creates a new iterator over all elements contained in this iterable object.
- returns
the new iterator
- Definition Classes
- ValueSet → GenSetLike → IterableLike → GenIterableLike
def iteratorFrom(start: Value): collection.Iterator[Value]
Creates an iterator that contains all values from this collection greater than or equal to start
according to the ordering of this collection. x.iteratorFrom(y) is equivalent to but will usually be more efficient than x.from(y).iterator
- start
The lower-bound (inclusive) of the iterator
- Definition Classes
- SortedSetLike
def keySet: ValueSet
return as a projection the set of keys in this collection
- Definition Classes
- SortedSetLike → Sorted
def keysIteratorFrom(start: Value): collection.Iterator[Value]
Creates an iterator over all the keys(or elements) contained in this collection greater than or equal to start
according to the ordering of this collection. x.keysIteratorFrom(y) is equivalent to but often more efficient than x.from(y).keysIterator.
- start
The lower bound (inclusive) on the keys to be returned
def last: Value
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
The last element of this traversable collection.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
NoSuchElementException
If the traversable collection is empty.
def lastKey: Value
Returns the last key of the collection.
- Definition Classes
- SortedSetLike → Sorted
def lastOption: Option[Value]
Optionally selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the last element of this traversable collection$ if it is nonempty,
None
if it is empty.
- Definition Classes
- TraversableLike → GenTraversableLike
def map[B](f: (A) ⇒ B): SortedSet[B]
Builds a new collection by applying a function to all elements of this immutable sorted set.
- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new immutable sorted set resulting from applying the given function
f
to each element of this immutable sorted set and collecting the results.
- Definition Classes
- SetLike → TraversableLike → GenTraversableLike → FilterMonadic
def max: A
Finds the largest element.
- returns
the largest element of this immutable sorted set.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this immutable sorted set is empty.
def maxBy[B](f: (A) ⇒ B): A
Finds the first element which yields the largest value measured by function f.
- B
The result type of the function f.
- f
The measuring function.
- returns
the first element of this immutable sorted set with the largest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this immutable sorted set is empty.
def min: A
Finds the smallest element.
- returns
the smallest element of this immutable sorted set
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this immutable sorted set is empty.
def minBy[B](f: (A) ⇒ B): A
Finds the first element which yields the smallest value measured by function f.
- B
The result type of the function f.
- f
The measuring function.
- returns
the first element of this immutable sorted set with the smallest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this immutable sorted set is empty.
def mkString: String
Displays all elements of this traversable or iterator in a string.
- returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator follow each other without any separator string.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def mkString(sep: String): String
Displays all elements of this traversable or iterator in a string using a separator string.
- sep
the separator string.
- returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator are separated by the stringsep
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("|") = "1|2|3"
def mkString(start: String, sep: String, end: String): String
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
a string representation of this traversable or iterator. The resulting string begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this traversable or iterator are separated by the stringsep
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that)
.
- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
def newBuilder: Builder[Value, ValueSet]
A common implementation of newBuilder
for all sets in terms of empty
. Overridden for mutable sets in `mutable.SetLike`.
- Attributes
- protected[this]
- Definition Classes
- SetLike → TraversableLike → HasNewBuilder
def nonEmpty: Boolean
Tests whether the traversable or iterator is not empty.
- returns
true
if the traversable or iterator contains at least one element,false
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
implicit def ordering: Ordering[Value]
- Definition Classes
- ValueSet → SortedSetLike → Sorted
def par: ParSet[Value]
Returns a parallel implementation of this collection.
For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par
takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.
Specific collections (e.g. ParArray
or mutable.ParHashMap
) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par
takes constant or sublinear time.
All parallel collections return a reference to themselves.
- returns
a parallel implementation of this collection
- Definition Classes
- Parallelizable
def parCombiner: Combiner[Value, ParSet[Value]]
The default par
implementation uses the combiner provided by this method to create a new parallel collection.
- returns
a combiner for the parallel collection of type
ParRepr
- Attributes
- protected
- Definition Classes
- Set → SetLike → Iterable → TraversableLike → Parallelizable
def partition(p: (Value) ⇒ Boolean): (ValueSet, ValueSet)
Partitions this traversable collection in two traversable collections according to a predicate.
- p
the predicate on which to partition.
- returns
a pair of traversable collections: the first traversable collection consists of all elements that satisfy the predicate
p
and the second traversable collection consists of all elements that don't. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.
- Definition Classes
- TraversableLike → GenTraversableLike
def product: A
Multiplies up the elements of this collection.
- returns
the product of all elements in this immutable sorted set of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the immutable sorted set and as result type ofproduct
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def range(from: Value, until: Value): ValueSet
Creates a ranged projection of this collection with both a lower-bound and an upper-bound.
- from
The lower-bound (inclusive) of the ranged projection.
- until
The upper-bound (exclusive) of the ranged projection.
- Definition Classes
- SortedSetLike → Sorted
def rangeImpl(from: Option[Value], until: Option[Value]): ValueSet
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.
- 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.
- Definition Classes
- ValueSet → SortedSetLike → Sorted
def reduce[A1 >: Value](op: (A1, A1) ⇒ A1): A1
Reduces the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
The result of applying reduce operator
op
between all the elements if the traversable or iterator is nonempty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def reduceLeft[B >: Value](op: (B, Value) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
-
the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right:op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def reduceLeftOption[B >: Value](op: (B, Value) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceLeft(op)
if this traversable or iterator is nonempty,None
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def reduceOption[A1 >: Value](op: (A1, A1) ⇒ A1): Option[A1]
Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def reduceRight[B >: Value](op: (Value, B) ⇒ B): B
Applies a binary operator to all elements of this iterable collection, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
-
the result of inserting
op
between consecutive elements of this iterable collection, going right to left:op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
where
x1, ..., xn
are the elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
def reduceRightOption[B >: Value](op: (Value, B) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceRight(op)
if this traversable or iterator is nonempty,None
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def repr: ValueSet
The collection of type traversable collection underlying this TraversableLike
object. By default this is implemented as the TraversableLike
object itself, but this can be overridden.
- Definition Classes
- TraversableLike → GenTraversableLike
def reversed: List[Value]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
def sameElements(that: GenIterable[A]): Boolean
Checks if the other iterable collection contains the same elements in the same order as this immutable sorted set.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- that
the collection to compare with.
- returns
true
, if both collections contain the same elements in the same order,false
otherwise.
- Definition Classes
- IterableLike → GenIterableLike
def scan[B >: Value, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[ValueSet, B, That]): That
Computes a prefix scan of the elements of the collection.
Note: The neutral element z
may be applied more than once.
- B
element type of the resulting collection
- That
type of the resulting collection
- z
neutral element for the operator
op
- op
the associative operator for the scan
- cbf
combiner factory which provides a combiner
- returns
a new traversable collection containing the prefix scan of the elements in this traversable collection
- Definition Classes
- TraversableLike → GenTraversableLike
def scanLeft[B, That](z: B)(op: (B, Value) ⇒ B)(implicit bf: CanBuildFrom[ValueSet, B, That]): That
Produces a collection containing cumulative results of applying the operator going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
the type of the elements in the resulting collection
- That
the actual type of the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
def scanRight[B, That](z: B)(op: (Value, B) ⇒ B)(implicit bf: CanBuildFrom[ValueSet, B, That]): That
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.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
- B
the type of the elements in the resulting collection
- That
the actual type of the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
(Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
def seq: Set[Value]
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
- returns
a sequential view of the collection.
- Definition Classes
- Set → Set → GenSet → GenSetLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
def size: Int
The size of this traversable or iterator.
Note: will not terminate for infinite-sized collections.
- returns
the number of elements in this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def sizeHintIfCheap: Int
The size of this collection or iterator, if it can be cheaply computed
- returns
the number of elements in this collection or iterator, or -1 if the size cannot be determined cheaply
- Attributes
- protected[collection]
- Definition Classes
- GenTraversableOnce
def slice(from: Int, until: Int): ValueSet
Selects an interval of elements. The returned collection is made up of all elements x
which satisfy the invariant:
from <= indexOf(x) < until
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
a iterable collection containing the elements greater than or equal to index
from
extending up to (but not including) indexuntil
of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
def sliding(size: Int, step: Int): collection.Iterator[ValueSet]
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
- size
the number of elements per group
- step
the distance between the first elements of successive groups
- returns
An iterator producing iterable collections of size
size
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
sliding
def sliding(size: Int): collection.Iterator[ValueSet]
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped
.) The "sliding window" step is set to one.
- size
the number of elements per group
- returns
An iterator producing iterable collections of size
size
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
sliding
def span(p: (Value) ⇒ Boolean): (ValueSet, ValueSet)
Splits this traversable 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 predicate p
does not cause any side-effects.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
a pair consisting of the longest prefix of this traversable collection whose elements all satisfy
p
, and the rest of this traversable collection.
- Definition Classes
- TraversableLike → GenTraversableLike
def splitAt(n: Int): (ValueSet, ValueSet)
Splits this traversable collection into two at a given position. Note: c splitAt n
is equivalent to (but possibly more efficient than) (c take n, c drop n)
.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
the position at which to split.
- returns
a pair of traversable collections consisting of the first
n
elements of this traversable collection, and the other elements.
- Definition Classes
- TraversableLike → GenTraversableLike
def stringPrefix: String
Defines the prefix of this object's toString
representation.
- returns
a string representation which starts the result of
toString
applied to this set. Unless overridden this is simply"Set"
.
- Definition Classes
- ValueSet → SetLike → TraversableLike → GenTraversableLike
def subsetOf(that: GenSet[Value]): Boolean
Tests whether this set is a subset of another set.
- that
the set to test.
- returns
true
if this set is a subset ofthat
, i.e. if every element of this set is also an element ofthat
.
- Definition Classes
- SortedSetLike → GenSetLike
def subsets(): collection.Iterator[ValueSet]
def subsets(len: Int): collection.Iterator[ValueSet]
An iterator over all subsets of this set of the given size. If the requested size is impossible, an empty iterator is returned.
- len
the size of the subsets.
- returns
the iterator.
- Definition Classes
- SetLike
def sum: A
Sums up the elements of this collection.
- returns
the sum of all elements in this immutable sorted set of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the immutable sorted set and as result type ofsum
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def tail: ValueSet
Selects all elements except the first.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
a traversable collection consisting of all elements of this traversable collection except the first one.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
java.lang.UnsupportedOperationException
if the traversable collection is empty.
def tails: collection.Iterator[ValueSet]
Iterates over the tails of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of tail
.
- returns
an iterator over all the tails of this traversable collection
- Definition Classes
- TraversableLike
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
def take(n: Int): ValueSet
Selects first n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
the number of elements to take from this iterable collection.
- returns
a iterable collection consisting only of the first
n
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.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
def takeRight(n: Int): ValueSet
Selects last n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
the number of elements to take
- returns
a iterable collection consisting only of the last
n
elements of this iterable collection, or else the whole iterable collection, if it has less thann
elements.
- Definition Classes
- IterableLike
def takeWhile(p: (Value) ⇒ Boolean): ValueSet
Takes longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
the longest prefix of this iterable collection whose elements all satisfy the predicate
p
.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
def thisCollection: collection.Iterable[Value]
The underlying collection seen as an instance of Iterable
. By default this is implemented as the current collection object itself, but this can be overridden.
- Attributes
- protected[this]
- Definition Classes
- IterableLike → TraversableLike
def to(to: Value): ValueSet
Create a range projection of this collection with no lower-bound.
- to
The upper-bound (inclusive) of the ranged projection.
- Definition Classes
- Sorted
def to[Col[_]]: Col[A]
Converts this immutable sorted set into another by copying all elements.
- Col
The collection type to build.
- returns
a new collection containing all elements of this immutable sorted set.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
def toArray: Array[A]
Converts this immutable sorted set to an array.
- returns
an array containing all elements of this immutable sorted set. An
ClassTag
must be available for the element type of this immutable sorted set.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toBitMask: Array[Long]
def toBuffer[A1 >: Value]: Buffer[A1]
Uses the contents of this set to create a new mutable buffer.
- returns
a buffer containing all elements of this set.
- Definition Classes
- SetLike → TraversableOnce → GenTraversableOnce
def toCollection(repr: ValueSet): collection.Iterable[Value]
A conversion from collections of type Repr
to Iterable
objects. By default this is implemented as just a cast, but this can be overridden.
- Attributes
- protected[this]
- Definition Classes
- IterableLike → TraversableLike
def toIndexedSeq: collection.immutable.IndexedSeq[Value]
Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite-sized collections.
- returns
an indexed sequence containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toIterable: collection.Iterable[Value]
Returns this iterable collection as an iterable collection.
A new collection will not be built; lazy collections will stay lazy.
Note: will not terminate for infinite-sized collections.
- returns
an
Iterable
containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
def toIterator: collection.Iterator[Value]
Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator
.
Note: will not terminate for infinite-sized collections.
- returns
an Iterator containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
- Annotations
- @deprecatedOverriding( message = ... , since = "2.11.0" )
def toList: List[Value]
Converts this traversable or iterator to a list.
Note: will not terminate for infinite-sized collections.
- returns
a list containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toMap[T, U]: Map[T, U]
Converts this immutable sorted set to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
- returns
a map of type
immutable.Map[T, U]
containing all key/value pairs of type(T, U)
of this immutable sorted set.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toParArray: ParArray[T]
- Implicit
- This member is added by an implicit conversion from ValueSet to CollectionsHaveToParArray[ValueSet, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (ValueSet) ⇒ GenTraversableOnce[T] is in scope.
- Definition Classes
- CollectionsHaveToParArray
def toSeq: collection.Seq[Value]
Converts this set to a sequence. As with toIterable
, it's lazy in this default implementation, as this TraversableOnce
may be lazy and unevaluated.
- returns
a sequence containing all elements of this set.
- Definition Classes
- SetLike → TraversableOnce → GenTraversableOnce
def toSet[B >: Value]: Set[B]
Returns this immutable set as an immutable set, perhaps accepting a wider range of elements. Since it already is an immutable set, it will only be rebuilt if the underlying structure cannot be expanded to include arbitrary element types. For instance, BitSet
and SortedSet
will be rebuilt, as they require Int
and sortable elements respectively.
When in doubt, the set will be rebuilt. Rebuilt sets never need to be rebuilt again.
- returns
a set containing all elements of this immutable set.
- Definition Classes
- Set → TraversableOnce → GenTraversableOnce
def toStream: collection.immutable.Stream[Value]
Converts this iterable collection to a stream.
- returns
a stream containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
def toString(): String
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- SetLike → Function1 → TraversableLike → AnyRef → Any
def toTraversable: collection.Traversable[Value]
Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite-sized collections.
- returns
a Traversable containing all elements of this traversable collection.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @deprecatedOverriding( message = ... , since = "2.11.0" )
def toVector: Vector[Value]
Converts this traversable or iterator to a Vector.
Note: will not terminate for infinite-sized collections.
- returns
a vector containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def transpose[B](implicit asTraversable: (Value) ⇒ GenTraversableOnce[B]): Set[Set[B]]
Transposes this collection of traversable collections into a collection of collections.
The resulting collection's type will be guided by the static type of 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))
- B
the type of the elements of each traversable collection.
- asTraversable
an implicit conversion which asserts that the element type of this collection is a
Traversable
.- returns
a two-dimensional collection of collections which has as nth row the nth column of this collection.
- Definition Classes
- GenericTraversableTemplate
- Annotations
- @migration
- Migration
(Changed in version 2.9.0)
transpose
throws anIllegalArgumentException
if collections are not uniformly sized.- Exceptions thrown
IllegalArgumentException
if all collections in this collection are not of the same size.
def union(that: GenSet[Value]): ValueSet
Computes the union between of set and another set.
- that
the set to form the union with.
- returns
a new set consisting of all elements that are in this set or in the given set
that
.
- Definition Classes
- SetLike → GenSetLike
def until(until: Value): ValueSet
Creates a ranged projection of this collection with no lower-bound.
- until
The upper-bound (exclusive) of the ranged projection.
- Definition Classes
- SortedSetLike → Sorted
def unzip[A1, A2](implicit asPair: (Value) ⇒ (A1, A2)): (Set[A1], Set[A2])
Converts this collection of pairs into two collections of the first and second half of each pair.
val xs = Traversable( (1, "one"), (2, "two"), (3, "three")).unzip // xs == (Traversable(1, 2, 3), // Traversable(one, two, three))
- A1
the type of the first half of the element pairs
- A2
the type of the second half of the element pairs
- asPair
an implicit conversion which asserts that the element type of this collection is a pair.
- returns
a pair of collections, containing the first, respectively second half of each element pair of this collection.
- Definition Classes
- GenericTraversableTemplate
def unzip3[A1, A2, A3](implicit asTriple: (Value) ⇒ (A1, A2, A3)): (Set[A1], Set[A2], Set[A3])
Converts this collection of triples into three collections of the first, second, and third element of each triple.
val xs = Traversable( (1, "one", '1'), (2, "two", '2'), (3, "three", '3')).unzip3 // xs == (Traversable(1, 2, 3), // Traversable(one, two, three), // Traversable(1, 2, 3))
- 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
- asTriple
an implicit conversion which asserts that the element type of this collection is a triple.
- returns
a triple of collections, containing the first, second, respectively third member of each element triple of this collection.
- Definition Classes
- GenericTraversableTemplate
def view(from: Int, until: Int): IterableView[Value, ValueSet]
Creates a non-strict view of a slice of this iterable collection.
Note: the difference between view
and slice
is that view
produces a view of the current iterable collection, whereas slice
produces a new iterable collection.
Note: view(from, to)
is equivalent to view.slice(from, to)
Note: might return different results for different runs, unless the underlying collection type is ordered.
- from
the index of the first element of the view
- until
the index of the element following the view
- returns
a non-strict view of a slice of this iterable collection, starting at index
from
and extending up to (but not including) indexuntil
.
- Definition Classes
- IterableLike → TraversableLike
def view: IterableView[Value, ValueSet]
Creates a non-strict view of this iterable collection.
- returns
a non-strict view of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long): Unit
def withFilter(p: (Value) ⇒ Boolean): FilterMonadic[Value, ValueSet]
Creates a non-strict filter of this traversable collection.
Note: the difference between c filter p
and c withFilter p
is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map
, flatMap
, foreach
, and withFilter
operations.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- p
the predicate used to test elements.
- returns
an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this traversable collection which satisfy the predicatep
.
- Definition Classes
- TraversableLike → FilterMonadic
def zip[B](that: GenIterable[B]): SortedSet[(A, B)]
Returns a immutable sorted set formed from this immutable sorted 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.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
the type of the second half of the returned pairs
- that
The iterable providing the second half of each result pair
- returns
a new immutable sorted set containing pairs consisting of corresponding elements of this immutable sorted set and
that
. The length of the returned collection is the minimum of the lengths of this immutable sorted set andthat
.
- Definition Classes
- IterableLike → GenIterableLike
def zipAll[B](that: collection.Iterable[B], thisElem: A, thatElem: B): SortedSet[(A, B)]
Returns a immutable sorted set formed from this immutable sorted set and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
the type of the second half of the returned pairs
- that
The iterable providing the second half of each result pair
- thisElem
the element to be used to fill up the result if this immutable sorted set is shorter than
that
.- thatElem
the element to be used to fill up the result if
that
is shorter than this immutable sorted set.- returns
a new immutable sorted set containing pairs consisting of corresponding elements of this immutable sorted set and
that
. The length of the returned collection is the maximum of the lengths of this immutable sorted set andthat
. If this immutable sorted set is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this immutable sorted set,thatElem
values are used to pad the result.
- Definition Classes
- IterableLike → GenIterableLike
def zipWithIndex: SortedSet[(A, Int)]
Zips this immutable sorted set with its indices.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
A new immutable sorted set containing pairs consisting of all elements of this immutable sorted set paired with their index. Indices start at
0
.
- Definition Classes
- IterableLike → GenIterableLike
List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))
def |(that: GenSet[Value]): ValueSet
Computes the union between this set and another set.
Note: Same as union
.
- that
the set to form the union with.
- returns
a new set consisting of all elements that are in this set or in the given set
that
.
- Definition Classes
- GenSetLike
def →[B](y: B): (ValueSet, B)
- Implicit
- This member is added by an implicit conversion from ValueSet to ArrowAssoc[ValueSet] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ValueSet to any2stringadd[ValueSet] performed by method any2stringadd in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: any2stringadd[ValueSet]).+(other)
- Definition Classes
- any2stringadd
def compare(that: ValueSet): Int
Result of comparing this
with operand that
.
Implement this method to determine how instances of A will be sorted.
Returns x
where:
x < 0
when this < that
x == 0
when this == that
x > 0
when this > that
- Implicit
- This member is added by an implicit conversion from ValueSet to math.Ordered[ValueSet] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type math.Ordering[ValueSet] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: math.Ordered[ValueSet]).compare(that)
- Definition Classes
- Ordered
def filter(p: (Value) ⇒ Boolean): collection.TraversableOnce[Value]
- Implicit
- This member is added by an implicit conversion from ValueSet to MonadOps[Value] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: MonadOps[Value]).filter(p)
- Definition Classes
- MonadOps
def flatMap[B](f: (Value) ⇒ GenTraversableOnce[B]): collection.TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from ValueSet to MonadOps[Value] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: MonadOps[Value]).flatMap(f)
- Definition Classes
- MonadOps
def flatten: collection.Iterator[Value]
- Implicit
- This member is added by an implicit conversion from ValueSet to FlattenOps[Value] performed by method flattenTraversableOnce in scala.collection.TraversableOnce. This conversion will take place only if an implicit value of type (Ordered[Value]) ⇒ collection.TraversableOnce[Value] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: FlattenOps[Value]).flatten
- Definition Classes
- FlattenOps
def map[B](f: (Value) ⇒ B): collection.TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from ValueSet to MonadOps[Value] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: MonadOps[Value]).map(f)
- Definition Classes
- MonadOps
def withFilter(p: (Value) ⇒ Boolean): collection.Iterator[Value]
- Implicit
- This member is added by an implicit conversion from ValueSet to MonadOps[Value] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(valueSet: MonadOps[Value]).withFilter(p)
- Definition Classes
- MonadOps
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/Enumeration$ValueSet.html
A class for sets of values. Iterating through this set will yield values in increasing order of their ids.