scala.collection.immutable.Set
The type implementing this traversable
A class supporting filtered operations.
o != arg0
is the same as !(o == (arg0))
.
o != arg0
is the same as !(o == (arg0))
.
the object to compare against this object for dis-equality.
false
if the receiver object is equivalent to the argument; true
otherwise.
Computes the intersection between this set and another set.
Computes the intersection between this set and another set.
Note: Same as intersect
.
the set to intersect with.
a new set consisting of all elements that are both in this
set and in the given set that
.
The difference of this set and another set.
The difference of this set and another set.
Note: Same as diff
.
the set of elements to exclude.
a set containing those elements of this
set that are not also contained in the given set that
.
This method is an alias for intersect
.
This method is an alias for intersect
.
It computes an intersection with set that
.
It removes all the elements that are not present in that
.
the set to intersect with
use & instead
Creates a new set with an additional element, unless the element is already present.
Creates a new immutable set with additional elements.
Creates a new immutable set with additional elements.
This method takes two or more elements to be added. Another overloaded variant of this method handles the case where a single element is added.
the first element to add.
the second element to add.
the remaining elements to add.
a new immutable set with the given elements added.
Creates a new immutable set by adding all elements contained in another collection to this immutable set.
Creates a new immutable set by adding all elements contained in another collection to this immutable set.
a new immutable set with the given elements added.
[use case] Concatenates this immutable set with the elements of a traversable collection.
Concatenates this immutable set with the elements of a traversable collection.
the traversable to append.
a new immutable set which contains all elements of this immutable set
followed by all elements of that
.
Concatenates this immutable set with the elements of a traversable collection.
Concatenates this immutable set with the elements of a traversable collection.
the element type of the returned collection.
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type B
being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, B, That]
is found.
the traversable to append.
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and
and the new element type B
.
a new collection of type That
which contains all elements of this immutable set
followed by all elements of that
.
Creates a new set with a given element removed from this set.
Creates a new set with a given element removed from this set.
the element to be removed
a new set that contains all elements of this set but that does not
contain elem
.
Creates a new immutable set from this immutable set with some elements removed.
Creates a new immutable set from this immutable set 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.
the first element to remove.
the second element to remove.
the remaining elements to remove.
a new immutable set that contains all elements of the current immutable set except one less occurrence of each of the given elements.
Creates a new immutable set from this immutable set by removing all elements of another collection.
Creates a new immutable set from this immutable set by removing all elements of another collection.
a new immutable set that contains all elements of the current immutable set
except one less occurrence of each of the elements of elems
.
Applies a binary operator to a start value and all elements of this immutable set, going left to right.
Applies a binary operator to a start value and all elements of this immutable set, going left to right.
Note: /:
is alternate syntax for foldLeft
; z /: xs
is the same as xs foldLeft z
.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable set,
going left to right with the start value z
on the left:
op(...op(op(z, x_{1}), x_{2}), ..., x_{n})
where x,,1,,, ..., x,,n,,
are the elements of this immutable set.
Applies a binary operator to all elements of this immutable set and a start value, going right to left.
Applies a binary operator to all elements of this immutable set and a start value, going right to left.
Note: :\
is alternate syntax for foldRight
; xs :\ z
is the same as xs foldRight z
.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the start value
the binary operator
the result of inserting op
between consecutive elements of this immutable set,
going right to left with the start value z
on the right:
op(x_{1}, op(x_{2}, ... op(x_{n}, z)...))
where x,,1,,, ..., x,,n,,
are the elements of this immutable set.
o == arg0
is the same as if (o eq null) arg0 eq null else o.equals(arg0)
.
o == arg0
is the same as if (o eq null) arg0 eq null else o.equals(arg0)
.
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
o == arg0
is the same as o.equals(arg0)
.
o == arg0
is the same as o.equals(arg0)
.
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
Appends all elements of this immutable set to a string builder.
Appends all elements of this immutable set to a string builder.
The written text consists of the string representations (w.r.t. the method toString
)
of all elements of this immutable set without any separator string.
the string builder to which elements are appended.
the string builder b
to which elements were appended.
Appends all elements of this immutable set to a string builder using a separator string.
Appends all elements of this immutable set 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 immutable set, separated by the string sep
.
the string builder to which elements are appended.
the separator string.
the string builder b
to which elements were appended.
Appends all elements of this immutable set to a string builder using start, end, and separator strings.
Appends all elements of this immutable set 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 immutable set are separated by the string sep
.
the string builder to which elements are appended.
the starting string.
the separator string.
the ending string.
the string builder b
to which elements were appended.
(f andThen g)(x) == g(f(x))
(f andThen g)(x) == g(f(x))
Tests if some element is contained in this set.
Tests if some element is contained in this set.
This method is equivalent to contains
. It allows sets to be interpreted as predicates.
the element to test for membership.
true
if elem
is contained in this set, false
otherwise.
This method is used to cast the receiver object to be of type T0
.
This method is used to cast the receiver object to be of type T0
.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as
part of compilation it is not possible to check whether the contents of the list are of the requested typed.
the receiver object.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
The object with which this immutable set should be compared
true
, if this immutable set can possibly equal that
, false
otherwise. The test
takes into consideration only the run-time types of objects but ignores their elements.
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
a copy of the receiver object.
[use case] Builds a new collection by applying a partial function to all elements of this immutable set on which the function is defined.
Builds a new collection by applying a partial function to all elements of this immutable set on which the function is defined.
the element type of the returned collection.
the partial function which filters and maps the immutable set.
a new immutable 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.
Builds a new collection by applying a partial function to all elements of this immutable set on which the function is defined.
Builds a new collection by applying a partial function to all elements of this immutable set on which the function is defined.
the element type of the returned collection.
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type B
being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, B, That]
is found.
the partial function which filters and maps the immutable set.
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and
and the new element type B
.
a new collection of type That
resulting from applying the partial function
pf
to each element on which it is defined and collecting the results.
The order of the elements is preserved.
The factory companion object that builds instances of class immutable.
The factory companion object that builds instances of class immutable.Set.
(or its Iterable
superclass where class immutable.Set is not a Seq
.)
(f compose g)(x) == f(g(x))
(f compose g)(x) == f(g(x))
Tests if some element is contained in this set.
[use case] Copies elements of this immutable set to an array.
Copies elements of this immutable set to an array.
Fills the given array xs
with at most len
elements of
this immutable set, starting at position start
.
Copying will stop once either the end of the current immutable set is reached,
or the end of the array is reached, or len
elements have been copied.
the array to fill.
the starting index.
the maximal number of elements to copy.
Copies elements of this immutable set to an array.
Copies elements of this immutable set to an array.
Fills the given array xs
with at most len
elements of
this immutable set, starting at position start
.
Copying will stop once either the end of the current immutable set is reached,
or the end of the array is reached, or len
elements have been copied.
the type of the elements of the array.
the array to fill.
the starting index.
the maximal number of elements to copy.
[use case] Copies values of this immutable set to an array.
Copies values of this immutable set to an array.
Fills the given array xs
with values of this immutable set.
Copying will stop once either the end of the current immutable set is reached,
or the end of the array is reached.
the array to fill.
Copies values of this immutable set to an array.
Copies values of this immutable set to an array.
Fills the given array xs
with values of this immutable set.
Copying will stop once either the end of the current immutable set is reached,
or the end of the array is reached.
the type of the elements of the array.
the array to fill.
[use case] Copies values of this immutable set to an array.
Copies values of this immutable set to an array.
Fills the given array xs
with values of this immutable set, after skipping start
values.
Copying will stop once either the end of the current immutable set is reached,
or the end of the array is reached.
the array to fill.
the starting index.
Copies values of this immutable set to an array.
Copies values of this immutable set to an array.
Fills the given array xs
with values of this immutable set, after skipping start
values.
Copying will stop once either the end of the current immutable set is reached,
or the end of the array is reached.
the type of the elements of the array.
the array to fill.
the starting index.
Copies all elements of this immutable set to a buffer.
Copies all elements of this immutable set to a buffer.
The buffer to which elements are copied.
Counts the number of elements in the immutable set which satisfy a predicate.
Counts the number of elements in the immutable set which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p
.
Computes the difference of this set and another set.
Computes the difference of this set and another set.
the set of elements to exclude.
a set containing those elements of this
set that are not also contained in the given set that
.
Selects all elements except first n ones.
Selects all elements except first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the number of elements to drop from this immutable set.
a immutable set consisting of all elements of this immutable set except the first n
ones, or else the
empty immutable set, if this immutable set has less than n
elements.
Selects all elements except last n ones.
Selects all elements except last n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The number of elements to take
a immutable set consisting of all elements of this immutable set except the first n
ones, or else the
empty immutable set, if this immutable set has less than n
elements.
Drops longest prefix of elements that satisfy a predicate.
Drops longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The predicate used to test elements.
the longest suffix of this immutable set whose first element
does not satisfy the predicate p
.
use iterator' instead
This method is used to test whether the argument (arg0
) is a reference to the
receiver object (this
).
This method is used to test whether the argument (arg0
) is a reference to the
receiver object (this
).
The eq
method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef
:
* It is reflexive: for any non-null instance x
of type AnyRef
, x.eq(x)
returns true
.
* It is symmetric: for any non-null instances x
and y
of type AnyRef
, x.eq(y)
returns true
if and
only if y.eq(x)
returns true
.
* It is transitive: for any non-null instances x
, y
, and z
of type AnyRef
if x.eq(y)
returns true
and y.eq(z)
returns true
, then x.eq(z)
returns true
.
Additionally, the eq
method has three other properties.
* It is consistent: for any non-null instances x
and y
of type AnyRef
, multiple invocations of
x.eq(y)
consistently returns true
or consistently returns false
.
* For any non-null instance x
of type AnyRef
, x.eq(null)
and null.eq(x)
returns false
.
* null.eq(null)
returns true
.
When overriding the equals
or hashCode
methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they
should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).
the object to compare against this object for reference equality.
true
if the argument is a reference to the receiver object; false
otherwise.
Compares this set with another object for equality.
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.
the other object
true
if that
is a set which contains the same elements
as this set.
Tests whether a predicate holds for some of the elements of this immutable set.
Tests whether a predicate holds for some of the elements of this immutable set.
the predicate used to test elements.
true
if the given predicate p
holds for some of the elements
of this immutable set, otherwise false
.
Selects all elements of this immutable set which satisfy a predicate.
Selects all elements of this immutable set which satisfy a predicate.
the predicate used to test elements.
a new immutable set consisting of all elements of this immutable set that satisfy the given
predicate p
. The order of the elements is preserved.
Selects all elements of this immutable set which do not satisfy a predicate.
Selects all elements of this immutable set which do not satisfy a predicate.
the predicate used to test elements.
a new immutable set consisting of all elements of this immutable set that do not satisfy the given
predicate p
. The order of the elements is preserved.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize
method are invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
Finds the first element of the immutable set satisfying a predicate, if any.
Finds the first element of the immutable set satisfying a predicate, if any.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the predicate used to test elements.
an option value containing the first element in the immutable set
that satisfies p
, or None
if none exists.
use head' instead
None
if iterable is empty.
[use case] Builds a new collection by applying a function to all elements of this immutable set and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable set and concatenating the results.
the element type of the returned collection.
the function to apply to each element.
a new immutable set resulting from applying the given collection-valued function
f
to each element of this immutable set and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable set and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable set and concatenating the results.
the element type of the returned collection.
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type B
being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, B, That]
is found.
the function to apply to each element.
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and
and the new element type B
.
a new collection of type That
resulting from applying the given collection-valued function
f
to each element of this immutable set and concatenating the results.
[use case] Converts this immutable set of traversable collections into a immutable set in which all element collections are concatenated.
Converts this immutable set of traversable collections into a immutable set in which all element collections are concatenated.
the type of the elements of each traversable collection.
a new immutable set resulting from concatenating all element immutable sets.
Converts this immutable set of traversable collections into a immutable set in which all element collections are concatenated.
Converts this immutable set of traversable collections into a immutable set in which all element collections are concatenated.
the type of the elements of each traversable collection.
an implicit conversion which asserts that the element type of this
immutable set is a Traversable
.
a new immutable set resulting from concatenating all element immutable sets.
Applies a binary operator to a start value and all elements of this immutable set, going left to right.
Applies a binary operator to a start value and all elements of this immutable set, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable set,
going left to right with the start value z
on the left:
op(...op(z, x_{1}), x_{2}, ..., x_{n})
where x,,1,,, ..., x,,n,,
are the elements of this immutable set.
Applies a binary operator to all elements of this immutable set and a start value, going right to left.
Applies a binary operator to all elements of this immutable set and a start value, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable set,
going right to left with the start value z
on the right:
op(x_{1}, op(x_{2}, ... op(x_{n}, z)...))
where x,,1,,, ..., x,,n,,
are the elements of this immutable set.
Tests whether a predicate holds for all elements of this immutable set.
Tests whether a predicate holds for all elements of this immutable set.
the predicate used to test elements.
true
if the given predicate p
holds for all elements
of this immutable set, otherwise false
.
[use case] Applies a function f
to all elements of this immutable set.
Applies a function f
to all elements of this immutable set.
the function that is applied for its side-effect to every element.
The result of function f
is discarded.
Applies a function f
to all elements of this immutable set.
Applies a function f
to all elements of this immutable set.
Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.
the type parameter describing the result of function f
.
This result will always be ignored. Typically U
is Unit
,
but this is not necessary.
the function that is applied for its side-effect to every element.
The result of function f
is discarded.
The generic builder that builds instances of immutable.
The generic builder that builds instances of immutable.Set at arbitrary element types.
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
Partitions this immutable set into a map of immutable sets according to some discriminator function.
Partitions this immutable set into a map of immutable sets 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 immutable set.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to immutable sets such that the following invariant holds:
(xs partition f)(k) = xs filter (x => f(x) == k)
That is, every key k
is bound to a immutable set of those elements x
for which f(x)
equals k
.
Partitions elements in fixed size immutable sets.
Partitions elements in fixed size immutable sets.
the number of elements per group
An iterator producing immutable sets of size size
, except the
last will be truncated if the elements don't divide evenly.
Iterator#grouped
Tests whether this immutable set is known to have a finite size.
Tests whether this immutable set is known to have a finite size.
All strict collections are known to have finite size. For a non-strict collection
such as Stream
, the predicate returns true
if all elements have been computed.
It returns false
if the stream is not yet evaluated to the end.
Note: many collection methods will not work on collections of infinite sizes.
true
if this collection is known to have finite size, false
otherwise.
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)
) yet
not be equal (o1.equals(o2)
returns false
). A degenerate implementation could always return 0
.
However, it is required that if two objects are equal (o1.equals(o2)
returns true
) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)
). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals
method.
the hash code value for the object.
Selects the first element of this immutable set.
Selects the first element of this immutable set.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the first element of this immutable set.
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.
the first element of this immutable set if it is nonempty, None
if it is empty.
Selects all elements except the last.
Selects all elements except the last.
Note: might return different results for different runs, unless the underlying collection type is ordered.
a immutable set consisting of all elements of this immutable set except the last one.
Computes the intersection between this set and another set.
Computes the intersection between this set and another set.
the set to intersect with.
a new set consisting of all elements that are both in this
set and in the given set that
.
Tests if this set is empty.
Tests if this set is empty.
true
if there is no element in the set, false
otherwise.
This method is used to test whether the dynamic type of the receiver object is T0
.
This method is used to test whether the dynamic type of the receiver object is T0
.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String]
will return false
, while the expression List(1).isInstanceOf[List[String]]
will
return true
. In the latter example, because the type argument is erased as part of compilation it is not
possible to check whether the contents of the list are of the requested typed.
true
if the receiver object is an instance of erasure of type T0
; false
otherwise.
Tests whether this immutable set can be repeatedly traversed.
Tests whether this immutable set can be repeatedly traversed.
true
Creates a new iterator over all elements contained in this iterable object.
Creates a new iterator over all elements contained in this iterable object.
the new iterator
Selects the last element.
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The last element of this immutable set.
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.
the last element of this immutable set$ if it is nonempty, None
if it is empty.
[use case] Builds a new collection by applying a function to all elements of this immutable set.
Builds a new collection by applying a function to all elements of this immutable set.
the element type of the returned collection.
the function to apply to each element.
a new immutable set resulting from applying the given function
f
to each element of this immutable set and collecting the results.
Builds a new collection by applying a function to all elements of this immutable set.
Builds a new collection by applying a function to all elements of this immutable set.
the element type of the returned collection.
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type B
being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, B, That]
is found.
the function to apply to each element.
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and
and the new element type B
.
a new collection of type That
resulting from applying the given function
f
to each element of this immutable set and collecting the results.
[use case] Finds the largest element.
Finds the largest element.
the largest element of this immutable set.
Finds the largest element.
Finds the largest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the largest element of this immutable set with respect to the ordering cmp
.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this immutable set
Finds the smallest element.
Finds the smallest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the smallest element of this immutable set with respect to the ordering cmp
.
Displays all elements of this immutable set in a string.
Displays all elements of this immutable set in a string.
a string representation of this immutable set. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this immutable set follow each other without any separator string.
Displays all elements of this immutable set in a string using a separator string.
Displays all elements of this immutable set in a string using a separator string.
the separator string.
a string representation of this immutable set. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this immutable set are separated by the string sep
.
Displays all elements of this immutable set in a string using start, end, and separator strings.
Displays all elements of this immutable set in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this immutable set. The resulting string
begins with the string start
and ends with the string
end
. Inside, the string representations (w.r.t. the method toString
)
of all elements of this immutable set are separated by the string sep
.
o.ne(arg0)
is the same as !(o.eq(arg0))
.
o.ne(arg0)
is the same as !(o.eq(arg0))
.
the object to compare against this object for reference dis-equality.
false
if the argument is not a reference to the receiver object; true
otherwise.
A common implementation of newBuilder
for all sets in terms
of empty
.
A common implementation of newBuilder
for all sets in terms
of empty
. Overridden for mutable sets in
mutable.SetLike
.
Tests whether the immutable set is not empty.
Tests whether the immutable set is not empty.
true
if the immutable set contains at least one element, false
otherwise.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Partitions this immutable set in two immutable sets according to a predicate.
Partitions this immutable set in two immutable sets according to a predicate.
the predicate on which to partition.
a pair of immutable sets: the first immutable set consists of all elements that
satisfy the predicate p
and the second immutable set consists of all elements
that don't. The relative order of the elements in the resulting immutable sets
is the same as in the original immutable set.
[use case] Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the product of all elements in this immutable set of numbers of type Int
.
Instead of Int
, any other type T
with an implicit Numeric[T]
implementation
can be used as element type of the immutable set and as result type of product
.
Examples of such types are: Long
, Float
, Double
, BigInt
.
Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the result type of the *
operator.
an implicit parameter defining a set of numeric operations
which includes the *
operator to be used in forming the product.
the product of all elements of this immutable set with respect to the *
operator in num
.
returns a projection that can be used to call non-strict filter
,map
, and flatMap
methods that build projections
of the collection.
returns a projection that can be used to call non-strict filter
,map
, and flatMap
methods that build projections
of the collection.
use view' instead
Applies a binary operator to all elements of this immutable set, going left to right.
Applies a binary operator to all elements of this immutable set, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the binary operator.
the result of inserting op
between consecutive elements of this immutable set,
going left to right:
op(...(op(x_{1}, x_{2}), ... ) , x_{n})
where x,,1,,, ..., x,,n,,
are the elements of this immutable set.
Optionally applies a binary operator to all elements of this immutable set, going left to right.
Optionally applies a binary operator to all elements of this immutable set, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceLeft(op)
is this immutable set is nonempty,
None
otherwise.
Applies a binary operator to all elements of this immutable set, going right to left.
Applies a binary operator to all elements of this immutable set, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the binary operator.
the result of inserting op
between consecutive elements of this immutable set,
going right to left:
op(x_{1}, op(x_{2}, ..., op(x_{n-1}, x_{n})...))
where x,,1,,, ..., x,,n,,
are the elements of this immutable set.
Optionally applies a binary operator to all elements of this immutable set, going right to left.
Optionally applies a binary operator to all elements of this immutable set, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceRight(op)
is this immutable set is nonempty,
None
otherwise.
The collection of type immutable set underlying this TraversableLike
object.
The collection of type immutable set underlying this TraversableLike
object.
By default this is implemented as the TraversableLike
object itself, but this can be overridden.
[use case] Checks if the other iterable collection contains the same elements in the same order as this immutable set.
Checks if the other iterable collection contains the same elements in the same order as this immutable set.
the collection to compare with.
true
, if both collections contain the same elements in the same order, false
otherwise.
Checks if the other iterable collection contains the same elements in the same order as this immutable set.
Checks if the other iterable collection contains the same elements in the same order as this immutable set.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the type of the elements of collection that
.
the collection to compare with.
true
, if both collections contain the same elements in the same order, false
otherwise.
Produces a collection containing cummulative results of applying the operator going left to right.
Produces a collection containing cummulative results of applying the operator going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the type of the elements in the resulting collection
the actual type of the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and
and the new element type B
.
collection with intermediate results
Produces a collection containing cummulative results of applying the operator going right to left.
Produces a collection containing cummulative results of applying the operator going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the type of the elements in the resulting collection
the actual type of the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and
and the new element type B
.
collection with intermediate results
The size of this immutable set.
The size of this immutable set.
the number of elements in this immutable set.
Selects an interval of elements.
Selects an interval of elements.
Note: c.slice(from, to)
is equivalent to (but possibly more efficient than)
c.drop(from).take(to - from)
Note: might return different results for different runs, unless the underlying collection type is ordered.
the index of the first returned element in this immutable set.
the index one past the last returned element in this immutable set.
a immutable set containing the elements starting at index from
and extending up to (but not including) index until
of this immutable set.
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 number of elements per group
An iterator producing immutable sets of size size
, except the
last and the only element will be truncated if there are
fewer elements than size.
Iterator#sliding
Splits this immutable set into a prefix/suffix pair according to a predicate.
Splits this immutable set 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.
the test predicate
a pair consisting of the longest prefix of this immutable set whose
elements all satisfy p
, and the rest of this immutable set.
Splits this immutable set into two at a given position.
Splits this immutable set 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.
the position at which to split.
a pair of immutable sets consisting of the first n
elements of this immutable set, and the other elements.
Defines the prefix of this object's toString
representation.
Defines the prefix of this object's toString
representation.
a string representation which starts the result of toString
applied to this set.
Unless overridden this is simply "Set"
.
Tests whether this set is a subset of another set.
Tests whether this set is a subset of another set.
the set to test.
true
if this set is a subset of that
, i.e. if
every element of this set is also an element of that
.
[use case] Sums up the elements of this collection.
Sums up the elements of this collection.
the sum of all elements in this immutable set of numbers of type Int
.
Instead of Int
, any other type T
with an implicit Numeric[T]
implementation
can be used as element type of the immutable set and as result type of sum
.
Examples of such types are: Long
, Float
, Double
, BigInt
.
Sums up the elements of this collection.
Sums up the elements of this collection.
the result type of the +
operator.
an implicit parameter defining a set of numeric operations
which includes the +
operator to be used in forming the sum.
the sum of all elements of this immutable set with respect to the +
operator in num
.
Selects all elements except the first.
Selects all elements except the first.
Note: might return different results for different runs, unless the underlying collection type is ordered.
a immutable set consisting of all elements of this immutable set except the first one.
Selects first n elements.
Selects first n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Tt number of elements to take from this immutable set.
a immutable set consisting only of the first n
elements of this immutable set, or else the
whole immutable set, if it has less than n
elements.
Selects last n elements.
Selects last n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the number of elements to take
a immutable set consisting only of the last n
elements of this immutable set, or else the
whole immutable set, if it has less than n
elements.
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.
The predicate used to test elements.
the longest prefix of this immutable set whose elements all satisfy
the predicate p
.
The underlying collection seen as an instance of immutable.Set
.
The underlying collection seen as an instance of immutable.Set
.
By default this is implemented as the current collection object itself,
but this can be overridden.
[use case] Converts this immutable set to an array.
Converts this immutable set to an array.
an array containing all elements of this immutable set.
A ClassManifest
must be available for the element type of this immutable set.
Converts this immutable set to an array.
Converts this immutable set to an array.
the type of the elements of the array. A ClassManifest
for this type must
be available.
an array containing all elements of this immutable set.
Converts this immutable set to a mutable buffer.
Converts this immutable set to a mutable buffer.
a buffer containing all elements of this immutable set.
A conversion from collections of type Repr
to immutable.Set
objects.
A conversion from collections of type Repr
to immutable.Set
objects.
By default this is implemented as just a cast, but this can be overridden.
Converts this immutable set to an indexed sequence.
Converts this immutable set to an indexed sequence.
an indexed sequence containing all elements of this immutable set.
Converts this immutable set to an iterable collection.
Converts this immutable set to an iterable collection. Note that
the choice of target Iterable
is lazy in this default implementation
as this TraversableOnce
may be lazy and unevaluated (i.e. it may
be an iterator which is only traversable once).
an Iterable
containing all elements of this immutable set.
Returns an Iterator over the elements in this immutable set.
Returns an Iterator over the elements in this immutable set. Will return the same Iterator if this instance is already an Iterator.
an Iterator containing all elements of this immutable set.
Converts this immutable set to a list.
Converts this immutable set to a list.
a list containing all elements of this immutable set.
Converts this immutable set to a map.
Converts this immutable set to a map. This method is unavailable unless the elements are members of Tuple2, each ((K, V)) 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.
a map containing all elements of this immutable set.
Converts this immutable set to a sequence.
Converts this immutable set to a sequence.
a sequence containing all the elements of this immutable set.
Converts this immutable set to a set.
Converts this immutable set to a set.
a set containing all elements of this immutable set.
Converts this immutable set to a stream.
Converts this immutable set to a stream.
a stream containing all elements of this immutable set.
Converts this immutable set to a string.
Converts this immutable set to a string.
a string representation of this collection. By default this
string consists of the stringPrefix
of this immutable set,
followed by all elements separated by commas and enclosed in parentheses.
Converts this immutable set to an unspecified Traversable.
Converts this immutable set to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
a Traversable containing all elements of this immutable set.
Transposes this immutable set of traversable collections into a immutable set of immutable sets.
Transposes this immutable set of traversable collections into a immutable set of immutable sets.
the type of the elements of each traversable collection.
an implicit conversion which asserts that the element type of this
immutable set is a Traversable
.
a two-dimensional immutable set of immutable sets which has as nth row the nth column of this immutable set.
Computes the union between of set and another set.
Computes the union between of set and another set.
the set to form the union with.
a new set consisting of all elements that are in this
set or in the given set that
.
Converts this immutable set of pairs into two collections of the first and second halfs of each pair.
Converts this immutable set of pairs into two collections of the first and second halfs of each pair.
an implicit conversion which asserts that the element type of this immutable set is a pair.
a pair immutable sets, containing the first, respectively second half of each element pair of this immutable set.
Creates a non-strict view of a slice of this immutable set.
Creates a non-strict view of a slice of this immutable set.
Note: the difference between view
and slice
is that view
produces
a view of the current immutable set, whereas slice
produces a new immutable set.
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.
the index of the first element of the view
the index of the element following the view
a non-strict view of a slice of this immutable set, starting at index from
and extending up to (but not including) index until
.
Creates a non-strict view of this immutable set.
Creates a non-strict view of this immutable set.
a non-strict view of this immutable set.
Creates a non-strict filter of this immutable set.
Creates a non-strict filter of this immutable set.
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.
the predicate used to test elements.
an object of class WithFilter
, which supports
map
, flatMap
, foreach
, and withFilter
operations.
All these operations apply to those elements of this immutable set which
satisfy the predicate p
.
[use case] Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable set formed from this immutable 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.
the type of the second half of the returned pairs
The iterable providing the second half of each result pair
a new immutable set containing pairs consisting of
corresponding elements of this immutable set and that
. The length
of the returned collection is the minimum of the lengths of this immutable set and that
.
Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable set formed from this immutable 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.
the type of the first half of the returned pairs (this is always a supertype
of the collection's element type A
).
the type of the second half of the returned pairs
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type (A1, B)
being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, (A1, B), That]
.
is found.
The iterable providing the second half of each result pair
an implicit value of class CanBuildFrom
which determines the
result class That
from the current representation type Repr
and the new element type (A1, B)
.
a new collection of type That
containing pairs consisting of
corresponding elements of this immutable set and that
. The length
of the returned collection is the minimum of the lengths of this immutable set and that
.
[use case] Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable set formed from this immutable 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.
the type of the second half of the returned pairs
The iterable providing the second half of each result pair
the element to be used to fill up the result if this immutable set is shorter than that
.
the element to be used to fill up the result if that
is shorter than this immutable set.
a new immutable set containing pairs consisting of
corresponding elements of this immutable set and that
. The length
of the returned collection is the maximum of the lengths of this immutable set and that
.
If this immutable set is shorter than that
, thisElem
values are used to pad the result.
If that
is shorter than this immutable set, thatElem
values are used to pad the result.
Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable set formed from this immutable 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.
the iterable providing the second half of each result pair
the element to be used to fill up the result if this immutable set is shorter than that
.
the element to be used to fill up the result if that
is shorter than this immutable set.
a new collection of type That
containing pairs consisting of
corresponding elements of this immutable set and that
. The length
of the returned collection is the maximum of the lengths of this immutable set and that
.
If this immutable set is shorter than that
, thisElem
values are used to pad the result.
If that
is shorter than this immutable set, thatElem
values are used to pad the result.
[use case] Zips this immutable set with its indices.
Zips this immutable set with its indices.
A new immutable set containing pairs consisting of all elements of this
immutable set paired with their index. Indices start at 0
.
@example
List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))
Zips this immutable set with its indices.
Zips this immutable set with its indices.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the type of the first half of the returned pairs (this is always a supertype
of the collection's element type A
).
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type (A1, Int)
being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, (A1, Int), That]
.
is found.
A new collection of type That
containing pairs consisting of all elements of this
immutable set paired with their index. Indices start at 0
.
Computes the union between this set and another set.
Computes the union between this set and another set.
Note: Same as union
.
the set to form the union with.
a new set consisting of all elements that are in this
set or in the given set that
.
An optimized representation for immutable sets of size 2