RenderableTable
CONSIDER eliminating this base class or, perhaps, rename it.
Type parameters
- Row
-
the underlying type of each Row
Value parameters
- maybeHeader
-
(optional) header
- rows
-
the rows of the table
Attributes
- Graph
-
- Supertypes
-
trait TableRenderable[Row]trait Table[Row]trait Iterable[Row]trait IterableFactoryDefaults[Row, Iterable]trait IterableOps[Row, Iterable, Iterable[Row]]trait IterableOnceOps[Row, Iterable, Iterable[Row]]trait IterableOnce[Row]class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HeadedTable[Row]class UnheadedTable[Row]
- Self type
-
RenderableTable[Row]
Members list
Value members
Concrete methods
Type parameters
- O
-
the type of the result.
Value parameters
- ev
-
implicit evidence for Renderer of Table of X.
Attributes
- Returns
-
an instance of O.
Method to render a table in a hierarchical fashion.
Method to render a table in a hierarchical fashion.
NOTE: if your output structure is not hierarchical in nature, then simply loop through the rows of this table, outputting each row as you go.
Type parameters
- U
-
a class which supports TreeWriter (i.e. there is evidence of TreeWriter[U]).
Value parameters
- attributes
-
the attributes to be applied to the top level node for this table.
- style
-
the "style" to be used for the node which will represent this table.
- xr
-
an (implicit) HierarchicalRenderer[Row]
Attributes
- Returns
-
a new instance of U which represents this Table as a tree of some sort.
Method to render a table in a hierarchical fashion.
Method to render a table in a hierarchical fashion.
NOTE: if your output structure is not hierarchical in nature, then simply loop through the rows of this table, outputting each row as you go.
Type parameters
- U
-
a class which supports TreeWriter (i.e. there is evidence of TreeWriter[U]).
Value parameters
- attributes
-
the attributes to be applied to the top level node for this table.
- rr
-
an (implicit) HierarchicalRenderer[ Indexed [ Row ] ]
- style
-
the "style" to be used for the node which will represent this table.
Attributes
- Returns
-
a new instance of U which represents this Table as a tree of some sort.
CONSIDER redefining the definition of Renderer such that we can accommodate the various different types of output.
CONSIDER redefining the definition of Renderer such that we can accommodate the various different types of output.
Method to render a table in a sequential (serialized) fashion.
Type parameters
- O
-
a type which supports Writable (via evidence of type Writable[O])
Attributes
- Returns
-
a new (or possibly old) instance of O.
Converts this iterable collection to a string.
Converts this iterable collection to a string.
Attributes
- Returns
-
a string representation of this collection. By default this string consists of the
classNameof this iterable collection, followed by all elements separated by commas and enclosed in parentheses. - Definition Classes
-
Iterable -> Any
Method to generate a Table[S] for a set of rows. Although declared as an instance method, this method produces its result independent of this.
Method to generate a Table[S] for a set of rows. Although declared as an instance method, this method produces its result independent of this.
Type parameters
- S
-
the underlying type of the rows and the result.
Value parameters
- sr
-
a sequence of S.
Attributes
- Returns
-
a new instance of Table[S].
Inherited methods
Method to concatenate two Content
Method to concatenate two Content
Type parameters
- S
-
the type of the rows of the result.
Value parameters
- table
-
a table to be concatenated with this table.
Attributes
- Returns
-
a new table, which is concatenated to this table, by rows.
- Inherited from:
- Table
Alias for concat.
Alias for concat.
Type parameters
- B
-
the element type of the returned collection
Value parameters
- suffix
-
the iterable to append to this iterable collection
Attributes
- Inherited from:
- IterableOps
Appends all elements of this iterable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection without any separator string.
Appends all elements of this iterable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection without any separator string.
Example:
val a = List(1,2,3,4) // List(1, 2, 3, 4)
val b = new StringBuilder()
val h = a.addString(b) // 1234
Value parameters
- b
-
the string builder to which elements are appended.
Attributes
- Returns
-
the string builder
bto which elements were appended. - Inherited from:
- IterableOnceOps
Appends all elements of this iterable collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection, separated by the string sep.
Appends all elements of this iterable collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection, separated by the string sep.
Example:
val a = List(1,2,3,4) // List(1, 2, 3, 4)
val b = new StringBuilder()
a.addString(b, ", ") // 1, 2, 3, 4
Value parameters
- b
-
the string builder to which elements are appended.
- sep
-
the separator string.
Attributes
- Returns
-
the string builder
bto which elements were appended. - Inherited from:
- IterableOnceOps
Appends all elements of this iterable collection 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 iterable collection are separated by the string sep.
Appends all elements of this iterable collection 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 iterable collection are separated by the string sep.
Example:
val a = List(1,2,3,4) // List(1, 2, 3, 4)
val b = new StringBuilder()
a.addString(b , "List(" , ", " , ")") // List(1, 2, 3, 4)
Value parameters
- b
-
the string builder to which elements are appended.
- end
-
the ending string.
- sep
-
the separator string.
- start
-
the starting string.
Attributes
- Returns
-
the string builder
bto which elements were appended. - Inherited from:
- IterableOnceOps
Builds a new iterable collection by applying a partial function to all elements of this iterable collection on which the function is defined.
Builds a new iterable collection by applying a partial function to all elements of this iterable collection on which the function is defined.
Type parameters
- B
-
the element type of the returned iterable collection.
Value parameters
- pf
-
the partial function which filters and maps the iterable collection.
Attributes
- Returns
-
a new iterable collection resulting from applying the given partial function
pfto each element on which it is defined and collecting the results. The order of the elements is preserved. - Inherited from:
- IterableOps
Finds the first element of the iterable collection for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the iterable collection for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Type parameters
- B
-
the result type of the partial function
Value parameters
- pf
-
the partial function
Attributes
- Returns
-
an option value containing pf applied to the first value for which it is defined, or
Noneif none exists. - Example
-
Seq("a", 1, 5L).collectFirst { case x: Int => x*10 } = Some(10) - Inherited from:
- IterableOnceOps
Returns a new iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the iterable collection is the most specific superclass encompassing the element types of the two operands.
Returns a new iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the iterable collection is the most specific superclass encompassing the element types of the two operands.
Type parameters
- B
-
the element type of the returned collection.
Value parameters
- suffix
-
the iterable to append.
Attributes
- Returns
-
a new iterable collection which contains all elements of this iterable collection followed by all elements of
suffix. - Inherited from:
- IterableOps
Copies elements to an array and returns the number of elements written.
Copies elements to an array and returns the number of elements written.
Fills the given array dest starting at index start with at most n elements of this iterable collection.
Copying will stop once either all the elements of this iterable collection have been copied, or the end of the array is reached, or n elements have been copied.
If start is less than zero, it is taken as zero.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- dest
-
the array to fill.
- n
-
the maximal number of elements to copy.
- start
-
the starting index of xs.
Attributes
- Returns
-
the number of elements written to the array
- Note
-
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
Copies elements to an array, returning the number of elements written.
Copies elements to an array, returning the number of elements written.
Fills the given array dest starting at index start with values of this iterable collection.
Copying will stop once either all the elements of this iterable collection have been copied, or the end of the array is reached.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- dest
-
the array to fill.
- start
-
the starting index of xs.
Attributes
- Returns
-
the number of elements written to the array
- Note
-
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
Copies elements to an array, returning the number of elements written.
Copies elements to an array, returning the number of elements written.
Fills the given array dest starting at index start with values of this iterable collection.
Copying will stop once either all the elements of this iterable collection have been copied, or the end of the array is reached.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- dest
-
the array to fill.
Attributes
- Returns
-
the number of elements written to the array
- Note
-
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.
Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
the type of the elements of
that
Value parameters
- p
-
the test predicate, which relates elements from both collections
- that
-
the other collection
Attributes
- Returns
-
trueif both collections have the same length andp(x, y)istruefor all corresponding elementsxof this iterator andyofthat, otherwisefalse - Inherited from:
- IterableOnceOps
Counts the number of elements in the iterable collection which satisfy a predicate.
Counts the number of elements in the iterable collection which satisfy a predicate.
Note: will not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
the number of elements satisfying the predicate
p. - Inherited from:
- IterableOnceOps
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.
Value parameters
- n
-
the number of elements to drop from this iterable collection.
Attributes
- Returns
-
a iterable collection consisting of all elements of this iterable collection except the last
nones, or else the empty iterable collection, if this iterable collection has less thannelements. Ifnis negative, don't drop any elements. - Inherited from:
- IterableOps
Tests whether a predicate holds for at least one element of this iterable collection.
Tests whether a predicate holds for at least one element of this iterable collection.
Note: may not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
trueif the given predicatepis satisfied by at least one element of this iterable collection, otherwisefalse - Inherited from:
- IterableOnceOps
Method to filter the rows of a table (as defined by Iterable).
Filter method which operates on the (primary) key of each row.
Filter method which operates on the (primary) key of each row.
TESTME (probably tested only in it)
Type parameters
- T
-
a super-class of Row, which provides evidence of HasKey[T].
Value parameters
- p
-
a predicate which takes a String.
Attributes
- Returns
-
a filtered Table[Row].
- Inherited from:
- Table
Method to filter out the rows of a table (as defined by Iterable).
Filter method which operates on the (primary) key of each row.
Filter method which operates on the (primary) key of each row.
Type parameters
- T
-
a super-class of Row, which provides evidence of HasKey[T].
Value parameters
- p
-
a predicate which takes a String.
Attributes
- Returns
-
a filtered Table[Row].
- Inherited from:
- Table
Method to retain only the rows which satisfy the isValid method of ev (i.e. a Validity[Row]).
Method to retain only the rows which satisfy the isValid method of ev (i.e. a Validity[Row]).
Value parameters
- rv
-
(implicit) a Validity[Row].
Attributes
- Returns
-
Table[Row] consisting only of rows which satisfy Validity.
- Inherited from:
- Table
Finds the first element of the iterable collection satisfying a predicate, if any.
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.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
an option value containing the first element in the iterable collection that satisfies
p, orNoneif none exists. - Inherited from:
- IterableOnceOps
Transform (flatMap) this Table[Row] into a Table[S].
Transform (flatMap) this Table[Row] into a Table[S].
CONSIDER rewriting this method or redefining it as it can be a major source of inefficiency. In particular, we are doing a ++ operation, which is inherently bad.
Type parameters
- S
-
the type of the rows of the result.
Value parameters
- f
-
a function which transforms a Row into an IterableOnce[S].
Attributes
- Returns
-
a Table[S] which is made up of a concatenation of the results of invoking f on each row this
- Inherited from:
- Table
Builds a new iterable collection by applying a function to all elements of this iterable collection and using the elements of the resulting collections.
Builds a new iterable collection by applying a function to all elements of this iterable collection and using the elements of the resulting collections.
For example:
def getWords(lines: Seq[String]): Seq[String] = lines.flatMap(line => line.split("\\W+"))
The type of the resulting collection is guided by the static type of this iterable collection. 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)
// lettersOf2 will return a Set[Char], not a Seq
def lettersOf2(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)
Type parameters
- B
-
the element type of the returned collection.
Value parameters
- f
-
the function to apply to each element.
Attributes
- Returns
-
a new iterable collection resulting from applying the given collection-valued function
fto each element of this iterable collection and concatenating the results. - Inherited from:
- IterableOps
Given that the elements of this collection are themselves iterable collections, converts this iterable collection into a iterable collection comprising the elements of these iterable collections.
Given that the elements of this collection are themselves iterable collections, converts this iterable collection into a iterable collection comprising the elements of these iterable collections.
The resulting collection's type will be guided by the type of iterable collection. For example:
val xs = List(
Set(1, 2, 3),
Set(1, 2, 3)
).flatten
// xs == List(1, 2, 3, 1, 2, 3)
val ys = Set(
List(1, 2, 3),
List(3, 2, 1)
).flatten
// ys == Set(1, 2, 3)
Type parameters
- B
-
the type of the elements of each iterable collection.
Value parameters
- asIterable
-
an implicit conversion which asserts that the element type of this iterable collection is an
Iterable.
Attributes
- Returns
-
a new iterable collection resulting from concatenating all element collections.
- Inherited from:
- IterableOps
Applies the given binary operator op to the given initial value z and all elements of this iterable collection.
Applies the given binary operator op to the given initial value z and all elements of this iterable collection.
For each application of the operator, each operand is either an element of this iterable collection, the initial value, or another such application of the operator.
The order of applications of the operator is unspecified and may be nondeterministic.
Each element appears exactly once in the computation.
The initial value may be used an arbitrary number of times, but at least once.
If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.
Note: might return different results for different runs, unless either
of the following conditions is met: (1) the operator is associative,
and the underlying collection type is ordered; or (2) the operator is
associative and commutative. In either case, it is also necessary that the initial value
be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.
The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.
Note: will not terminate for infinite-sized collections.
Type parameters
- A1
-
The type parameter for the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
- z
-
An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for
opfor the result to always be the same across runs.
Attributes
- Returns
-
The result of applying
opbetween all the elements andz, orzif this iterable collection is empty. - Inherited from:
- IterableOnceOps
Applies the given binary operator op to the given initial value z and all elements of this iterable collection, going left to right. Returns the initial value if this iterable collection is empty.
Applies the given binary operator op to the given initial value z and all elements of this iterable collection, going left to right. Returns the initial value if this iterable collection is empty.
"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this iterable collection, the result is op( op( ... op( op(z, x,,1,,), x,,2,,) ... ), x,,n,,).
If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this iterable collection and the initial value all appear exactly once in the computation.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator.
Value parameters
- op
-
A binary operator.
- z
-
An initial value.
Attributes
- Returns
-
The result of applying
optozand all elements of this iterable collection, going left to right. Returnszif this iterable collection is empty. - Inherited from:
- IterableOnceOps
Applies the given binary operator op to all elements of this iterable collection and the given initial value z, going right to left. Returns the initial value if this iterable collection is empty.
Applies the given binary operator op to all elements of this iterable collection and the given initial value z, going right to left. Returns the initial value if this iterable collection is empty.
"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this iterable collection, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n,,, z) ... ))).
If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this iterable collection and the initial value all appear exactly once in the computation.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator.
Value parameters
- op
-
A binary operator.
- z
-
An initial value.
Attributes
- Returns
-
The result of applying
opto all elements of this iterable collection andz, going right to left. Returnszif this iterable collection is empty. - Inherited from:
- IterableOnceOps
Tests whether a predicate holds for all elements of this iterable collection.
Tests whether a predicate holds for all elements of this iterable collection.
Note: may not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
trueif this iterable collection is empty or the given predicatepholds for all elements of this iterable collection, otherwisefalse. - Inherited from:
- IterableOnceOps
Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.
Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.
Type parameters
- U
-
the return type of
f; the value is discarded, but the type parameter aids type inference
Value parameters
- f
-
the function to apply to each element for its side effects
Attributes
- Inherited from:
- IterableOnceOps
Defines how to turn a given Iterable[A] into a collection of type C.
Defines how to turn a given Iterable[A] into a collection of type C.
This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.
Value parameters
- coll
-
the source collection to convert
Attributes
- Returns
-
a new collection of type
Ccontaining the elements ofcoll - Note
-
When implementing a custom collection type and refining
Cto the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case whereC =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.As witnessed by the
@uncheckedVarianceannotation, using this method might be unsound. However, as long as it is called with anIterable[A]obtained fromthiscollection (as it is the case in the implementations of operations where we use aView[A]), it is safe. - Inherited from:
- IterableFactoryDefaults
Partitions this iterable collection into a map of iterable collections according to some discriminator function.
Partitions this iterable collection into a map of iterable collections according to some discriminator function.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- K
-
the type of keys returned by the discriminator function.
Value parameters
- f
-
the discriminator function.
Attributes
- Returns
-
A map from keys to iterable collections such that the following invariant holds:
(xs groupBy f)(k) = xs filter (x => f(x) == k)That is, every key `k` is bound to a iterable collection of those elements `x` for which `f(x)` equals `k`. - Inherited from:
- IterableOps
Partitions this iterable collection into a map of iterable collections according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.
Partitions this iterable collection into a map of iterable collections according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.
It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.
case class User(name: String, age: Int)
def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
users.groupMap(_.age)(_.name)
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- B
-
the type of values returned by the transformation function
- K
-
the type of keys returned by the discriminator function
Value parameters
- f
-
the element transformation function
- key
-
the discriminator function
Attributes
- Returns
-
a map associating each key
kproduced bykeywith a iterable collection of values produced by applyingfto elements that map tok - Inherited from:
- IterableOps
Partitions this iterable collection into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.
Partitions this iterable collection into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.
It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.
def occurrences[A](as: Seq[A]): Map[A, Int] =
as.groupMapReduce(identity)(_ => 1)(_ + _)
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- B
-
the type of values returned by the transformation function
- K
-
the type of keys returned by the discriminator function
Value parameters
- f
-
the element transformation function
- key
-
the discriminator function
- reduce
-
the reduction function used to combine values mapped to the same key
Attributes
- Inherited from:
- IterableOps
Partitions elements in fixed size iterable collections.
Partitions elements in fixed size iterable collections.
Value parameters
- size
-
the number of elements per group
Attributes
- Returns
-
An iterator producing iterable collections of size
size, except the last will be less than sizesizeif the elements don't divide evenly. - See also
-
scala.collection.Iterator, method
grouped - Inherited from:
- IterableOps
Selects the first element of this iterable collection.
Selects the first element of this iterable collection.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
the first element of this iterable collection.
- Throws
-
NoSuchElementException
if the iterable collection is empty.
- Inherited from:
- IterableOps
Optionally selects the first element.
Optionally selects the first element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
the first element of this iterable collection if it is nonempty,
Noneif it is empty. - Inherited from:
- IterableOps
The initial part of the collection without its last element.
The initial part of the collection without its last element.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Attributes
- Inherited from:
- IterableOps
Iterates over the inits of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of init.
Iterates over the inits of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of init.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Attributes
- Returns
-
an iterator over all the inits of this iterable collection
- Example
-
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil) - Inherited from:
- IterableOps
Tests whether the iterable collection is empty.
Tests whether the iterable collection is empty.
Note: The default implementation creates and discards an iterator.
Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.
Attributes
- Returns
-
trueif the iterable collection contains no elements,falseotherwise. - Inherited from:
- IterableOnceOps
Tests whether this iterable collection can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
Tests whether this iterable collection can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
Attributes
- Returns
-
trueif it is repeatedly traversable,falseotherwise. - Definition Classes
-
IterableOps -> IterableOnceOps
- Inherited from:
- IterableOps
The companion object of this iterable collection, providing various factory methods.
The companion object of this iterable collection, providing various factory methods.
Attributes
- Returns
-
the companion factory object for this collection type
- Note
-
When implementing a custom collection type and refining
CCto the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise). - Inherited from:
- Iterable
Method to return the rows of this table as an iterator.
Method to return the rows of this table as an iterator.
Attributes
- Returns
-
the rows in the form of Iterator[Row]
- Inherited from:
- Table
The number of elements in this iterable collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
The number of elements in this iterable collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
Attributes
- Inherited from:
- IterableOnce
Selects the last element.
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
The last element of this iterable collection.
- Throws
-
NoSuchElementException
If the iterable collection is empty.
- Inherited from:
- IterableOps
Optionally selects the last element.
Optionally selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
the last element of this iterable collection if it is nonempty,
Noneif it is empty. - Inherited from:
- IterableOps
Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.
Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.
Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.
val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
Type parameters
- B
-
the type of the second element in each eventual pair
Value parameters
- that
-
the iterable providing the second element of each eventual pair
Attributes
- Returns
-
a decorator
LazyZip2that allows strict operations to be performed on the lazily evaluated pairs or chained calls tolazyZip. Implicit conversion toIterable[(A, B)]is also supported. - Inherited from:
- Iterable
Transform (map) this Table[Row] into a Table[S].
Transform (map) this Table[Row] into a Table[S].
Type parameters
- S
-
the type of the rows of the result.
Value parameters
- f
-
a function which transforms a Row into an S.
Attributes
- Returns
-
a Table[S] where each row has value f(x) where x is the value of the corresponding row in this.
- Definition Classes
- Inherited from:
- Table
Transform (flatMap) this Table[Row] into a Table[S].
Transform (flatMap) this Table[Row] into a Table[S].
Type parameters
- S
-
the type of the rows of the result.
Value parameters
- f
-
a function which transforms a Row into an IterableOnce[S].
Attributes
- Returns
-
a Table[S] which is made up of a concatenation of the results of invoking f on each row this
- Inherited from:
- Table
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the largest element of this iterable collection with respect to the ordering
ord. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
Finds the first element which yields the largest value measured by function f.
Finds the first element which yields the largest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the first element of this iterable collection with the largest value measured by function
fwith respect to the orderingord. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
Finds the first element which yields the largest value measured by function f.
Finds the first element which yields the largest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the first element of this iterable collection with the largest value measured by function
fwith respect to the orderingord. - Inherited from:
- IterableOnceOps
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the largest element of this iterable collection with respect to the ordering
ord. - Inherited from:
- IterableOnceOps
Retrieves an optional sequence of column names derived from a possible header.
Retrieves an optional sequence of column names derived from a possible header.
Attributes
- Returns
-
An
Optioncontaining aSeq[String]of column names if the header exists, otherwiseNone. - Inherited from:
- Table
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the smallest element of this iterable collection with respect to the ordering
ord. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
Finds the first element which yields the smallest value measured by function f.
Finds the first element which yields the smallest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the first element of this iterable collection with the smallest value measured by function
fwith respect to the orderingord. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
Finds the first element which yields the smallest value measured by function f.
Finds the first element which yields the smallest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the first element of this iterable collection with the smallest value measured by function
fwith respect to the orderingord. - Inherited from:
- IterableOnceOps
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the smallest element of this iterable collection with respect to the ordering
ord. - Inherited from:
- IterableOnceOps
Displays all elements of this iterable collection in a string.
Displays all elements of this iterable collection in a string.
Delegates to addString, which can be overridden.
Attributes
- Returns
-
a string representation of this iterable collection. In the resulting string the string representations (w.r.t. the method
toString) of all elements of this iterable collection follow each other without any separator string. - Inherited from:
- IterableOnceOps
Displays all elements of this iterable collection in a string using a separator string.
Displays all elements of this iterable collection in a string using a separator string.
Delegates to addString, which can be overridden.
Value parameters
- sep
-
the separator string.
Attributes
- Returns
-
a string representation of this iterable collection. In the resulting string the string representations (w.r.t. the method
toString) of all elements of this iterable collection are separated by the stringsep. - Example
-
List(1, 2, 3).mkString("|") = "1|2|3" - Inherited from:
- IterableOnceOps
Displays all elements of this iterable collection in a string using start, end, and separator strings.
Displays all elements of this iterable collection in a string using start, end, and separator strings.
Delegates to addString, which can be overridden.
Value parameters
- end
-
the ending string.
- sep
-
the separator string.
- start
-
the starting string.
Attributes
- Returns
-
a string representation of this iterable collection. The resulting string begins with the string
startand ends with the stringend. Inside, the string representations (w.r.t. the methodtoString) of all elements of this iterable collection are separated by the stringsep. - Example
-
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)" - Inherited from:
- IterableOnceOps
Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList),
Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList),
Attributes
- Returns
-
a strict builder for the same collection type. it is possible to implement this method but the resulting
Builderwill break laziness. As a consequence, operations should preferably be implemented withfromSpecificinstead of this method. - Note
-
When implementing a custom collection type and refining
Cto the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case whereC =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.As witnessed by the
@uncheckedVarianceannotation, using this method might be unsound. However, as long as the returned builder is only fed withAvalues taken fromthisinstance, it is safe. - Inherited from:
- IterableFactoryDefaults
Tests whether the iterable collection is not empty.
Tests whether the iterable collection is not empty.
Attributes
- Returns
-
trueif the iterable collection contains at least one element,falseotherwise. - Inherited from:
- IterableOnceOps
A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.
A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.
The two iterable collection correspond to the result of filter and filterNot, respectively.
The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.
Value parameters
- p
-
the predicate used to test elements
Attributes
- Returns
-
a pair of iterable collections: the first containing all elements that satisfy
p, the second containing those that do not - Inherited from:
- IterableOps
Applies a function f to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.
Applies a function f to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.
Example:
val xs = $Coll(1, "one", 2, "two", 3, "three") partitionMap {
case i: Int => Left(i)
case s: String => Right(s)
}
// xs == ($Coll(1, 2, 3),
// $Coll(one, two, three))
Type parameters
- A1
-
the element type of the first resulting collection
- A2
-
the element type of the second resulting collection
Value parameters
- f
-
the 'split function' mapping the elements of this iterable collection to an scala.util.Either
Attributes
- Returns
-
a pair of iterable collections: the first one made of those values returned by
fthat were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right. - Inherited from:
- IterableOps
Method to process the rows as an Iterable into an Iterable which will make up the resulting Table. NOTE: if you need the rows processed individually, use processRowsMap or flatMap.
Method to process the rows as an Iterable into an Iterable which will make up the resulting Table. NOTE: if you need the rows processed individually, use processRowsMap or flatMap.
Type parameters
- S
-
the underlying type of the result.
Value parameters
- f
-
a function which takes an Iterable[Row] and returns an Iterable[S]
Attributes
- Returns
-
a table[S]
- Inherited from:
- Table
Method to process the rows as an Iterable into an Iterable which will make up the resulting Table.
Method to process the rows as an Iterable into an Iterable which will make up the resulting Table.
TESTME
Type parameters
- S
-
the underlying type of the result.
Value parameters
- f
-
a function which takes an Iterable[Row] and returns an Iterable[S]
Attributes
- Returns
-
a table[S]
- Inherited from:
- Table
Multiplies together the elements of this collection.
Multiplies together the elements of this collection.
The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
the result type of the
*operator.
Value parameters
- num
-
an implicit parameter defining a set of numeric operations which includes the
*operator to be used in forming the product.
Attributes
- Returns
-
the product of all elements of this iterable collection with respect to the
*operator innum. - Inherited from:
- IterableOnceOps
Applies the given binary operator op to all elements of this iterable collection.
Applies the given binary operator op to all elements of this iterable collection.
For each application of the operator, each operand is either an element of this iterable collection or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.
If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.
Note: might return different results for different runs, unless either
of the following conditions is met: (1) the operator is associative,
and the underlying collection type is ordered; or (2) the operator is
associative and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type parameter for the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
Attributes
- Returns
-
The result of applying
opbetween all the elements if the iterable collection is nonempty. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
Applies the given binary operator op to all elements of this iterable collection, going left to right.
Applies the given binary operator op to all elements of this iterable collection, going left to right.
"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this iterable collection, the result is op( op( op( ... op(x,,1,,, x,,2,,) ... ), x,,n-1,,), x,,n,,).
If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this iterable collection and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of applying
opto all elements of this iterable collection, going left to right. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
If this iterable collection is nonempty, reduces it with the given binary operator op, going left to right.
If this iterable collection is nonempty, reduces it with the given binary operator op, going left to right.
The behavior is the same as reduceLeft except that the value is None if the iterable collection is empty. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of reducing this iterable collection with
opgoing left to right if the iterable collection is nonempty, inside aSome, andNoneotherwise. - Inherited from:
- IterableOnceOps
If this iterable collection is nonempty, reduces it with the given binary operator op.
If this iterable collection is nonempty, reduces it with the given binary operator op.
The behavior is the same as reduce except that the value is None if the iterable collection is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless either
of the following conditions is met: (1) the operator is associative,
and the underlying collection type is ordered; or (2) the operator is
associative and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
A type parameter for the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
Attributes
- Returns
-
The result of reducing this iterable collection with
opif the iterable collection is nonempty, inside aSome, andNoneotherwise. - Inherited from:
- IterableOnceOps
Applies the given binary operator op to all elements of this iterable collection, going right to left.
Applies the given binary operator op to all elements of this iterable collection, going right to left.
"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this iterable collection, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n-1,,, x,,n,,) ... ))).
If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this iterable collection and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of applying
opto all elements of this iterable collection, going right to left. - Throws
-
UnsupportedOperationException
if this iterable collection is empty.
- Inherited from:
- IterableOnceOps
If this iterable collection is nonempty, reduces it with the given binary operator op, going right to left.
If this iterable collection is nonempty, reduces it with the given binary operator op, going right to left.
The behavior is the same as reduceRight except that the value is None if the iterable collection is empty. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of reducing this iterable collection with
opgoing right to left if the iterable collection is nonempty, inside aSome, andNoneotherwise. - Inherited from:
- IterableOnceOps
Method to clone this Table but with a different Header.
Method to clone this Table but with a different Header.
Value parameters
- ho
-
an optional Header.
Attributes
- Returns
-
a Table[Row] with the same rows as this, but with
hoas itsmaybeHeader. - Inherited from:
- Table
Attributes
- Inherited from:
- IterableOnceOps
Method to randomly sample from this Table.
Method to randomly sample from this Table.
Value parameters
- n
-
the odds against choosing any particular element.
- random
-
an (implicit) Random number generator.
Attributes
- Returns
-
a new Table[Row] with approximately size/n elements.
- Inherited from:
- Table
Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
Note: The neutral element z may be applied more than once.
Type parameters
- B
-
element type of the resulting collection
Value parameters
- op
-
the associative operator for the scan
- z
-
neutral element for the operator
op
Attributes
- Returns
-
a new iterable collection containing the prefix scan of the elements in this iterable collection
- Inherited from:
- IterableOps
Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.
Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Type parameters
- B
-
the type of the elements in the resulting collection
Value parameters
- op
-
the binary operator applied to the intermediate result and the element
- z
-
the initial value
Attributes
- Returns
-
collection with intermediate results
- Inherited from:
- IterableOps
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
Type parameters
- B
-
the type of the elements in the resulting collection
Value parameters
- op
-
the binary operator applied to the intermediate result and the element
- z
-
the initial value
Attributes
- Returns
-
collection with intermediate results
- Inherited from:
- IterableOps
Method to select those rows defined by the given range.
Method to select those rows defined by the given range.
NOTE: the rows are numbered 1..N.
NOTE: as of 2.0, the rows are in the order in which they were read (in 1.x, they might have been in any order).
Value parameters
- n
-
the desired row.
Attributes
- Returns
-
a new Table[Row] consisting only the row requested.
- Inherited from:
- Table
Method to select those rows defined by the given range. NOTE: the rows are numbered 1..N.
Method to select those rows defined by the given range. NOTE: the rows are numbered 1..N.
Value parameters
- range
-
a Range
Attributes
- Returns
-
a new Table[Row] consisting only of those rows in the given range.
- Inherited from:
- Table
The size of this iterable collection.
The size of this iterable collection.
Note: will not terminate for infinite-sized collections.
Attributes
- Returns
-
the number of elements in this iterable collection.
- Inherited from:
- IterableOnceOps
Compares the size of this iterable collection to the size of another Iterable.
Compares the size of this iterable collection to the size of another Iterable.
Value parameters
- that
-
the
Iterablewhose size is compared with this iterable collection's size.
Attributes
- Returns
-
A value
xwherex < 0 if this.size < that.size x == 0 if this.size == that.size x > 0 if this.size > that.sizeThe method as implemented here does not call
sizedirectly; its running time isO(this.size min that.size)instead ofO(this.size + that.size). The method should be overridden if computingsizeis cheap andknownSizereturns-1. - Inherited from:
- IterableOps
Compares the size of this iterable collection to a test value.
Compares the size of this iterable collection to a test value.
Value parameters
- otherSize
-
the test value that gets compared with the size.
Attributes
- Returns
-
A value
xwherex < 0 if this.size < otherSize x == 0 if this.size == otherSize x > 0 if this.size > otherSizeThe default implementation does not call
size, which may be arbitrarily expensive. It will useknownSizeif nonnegative. Otherwise, it will iterate to compute an element count, with complexityO(size min otherSize). This method should be overridden if computingsizeis cheap andknownSizereturns-1. In that case, the custom implementation should just comparesizeandotherSizedirectly. - See also
-
sizeIs
- Inherited from:
- IterableOps
Returns a value class containing operations for comparing the size of this iterable collection to a test value.
Returns a value class containing operations for comparing the size of this iterable collection to a test value.
These operations are implemented in terms of `sizeCompare(Int)`, and allow the following more readable usages:
this.sizeIs < size // this.sizeCompare(size) < 0
this.sizeIs <= size // this.sizeCompare(size) <= 0
this.sizeIs == size // this.sizeCompare(size) == 0
this.sizeIs != size // this.sizeCompare(size) != 0
this.sizeIs >= size // this.sizeCompare(size) >= 0
this.sizeIs > size // this.sizeCompare(size) > 0
Attributes
- Returns
-
a wrapper that allows size comparisons using operators such as
=, and> - Inherited from:
- IterableOps
slice (as defined by Iterable).
slice (as defined by Iterable).
Value parameters
- from
-
the index at which to begin the slice (1-based counting).
- until
-
the index at which to end the slice (1-based counting).
Attributes
- Returns
-
a Table like this Table but with slice(from, until) rows.
- Definition Classes
- Inherited from:
- Table
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped).
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped).
The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.
Value parameters
- size
-
the number of elements per group
- step
-
the distance between the first elements of successive groups
Attributes
- Returns
-
An iterator producing iterable collections of size
size, except the last element (which may be the only element) will be smaller if there are fewer thansizeelements remaining to be grouped. - See also
-
scala.collection.Iterator, method
sliding - Example
-
List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5)) - Inherited from:
- IterableOps
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).
An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.
Value parameters
- size
-
the number of elements per group
Attributes
- Returns
-
An iterator producing iterable collections of size
size, except for a non-empty collection with less thansizeelements, which returns an iterator that produces the source collection itself as its only element. - See also
-
scala.collection.Iterator, method
sliding - Example
-
List().sliding(2) = empty iteratorList(1).sliding(2) = Iterator(List(1))List(1, 2).sliding(2) = Iterator(List(1, 2))List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3)) - Inherited from:
- IterableOps
Method to transform this Table[Row] into a sorted Table[S] where S is a super-class of Row and for which there is evidence of Ordering[S].
Method to transform this Table[Row] into a sorted Table[S] where S is a super-class of Row and for which there is evidence of Ordering[S].
Type parameters
- S
-
the underlying type of the resulting Table (a super-type of Row and for which there is evidence of Ordering[S]).
Attributes
- Returns
-
a Table[S].
- Inherited from:
- Table
Splits this iterable collection into a prefix/suffix pair according to a predicate.
Splits this iterable collection into a prefix/suffix pair according to a predicate.
Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side effects.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
the test predicate
Attributes
- Returns
-
a pair consisting of the longest prefix of this iterable collection whose elements all satisfy
p, and the rest of this iterable collection. - Inherited from:
- IterableOps
Splits this iterable collection into a prefix/suffix pair at a given position.
Splits this iterable collection into a prefix/suffix pair at a given position.
Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- n
-
the position at which to split.
Attributes
- Returns
-
a pair of iterable collections consisting of the first
nelements of this iterable collection, and the other elements. - Definition Classes
-
IterableOps -> IterableOnceOps
- Inherited from:
- IterableOps
Returns a scala.collection.Stepper for the elements of this collection.
Returns a scala.collection.Stepper for the elements of this collection.
The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.
The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.
- For collections of
Int,Short,ByteorChar, an scala.collection.IntStepper is returned - For collections of
DoubleorFloat, a scala.collection.DoubleStepper is returned - For collections of
Longa scala.collection.LongStepper is returned - For any other element type, an scala.collection.AnyStepper is returned
Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.
Type parameters
- S
-
the type of the returned
Stepper, determined by the implicitStepperShape
Attributes
- Inherited from:
- IterableOnce
Sums the elements of this collection.
Sums the elements of this collection.
The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
the result type of the
+operator.
Value parameters
- num
-
an implicit parameter defining a set of numeric operations which includes the
+operator to be used in forming the sum.
Attributes
- Returns
-
the sum of all elements of this iterable collection with respect to the
+operator innum. - Inherited from:
- IterableOnceOps
The rest of the collection without its first element.
The rest of the collection without its first element.
Attributes
- Inherited from:
- IterableOps
Iterates over the tails of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of tail.
Iterates over the tails of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of tail.
Attributes
- Returns
-
an iterator over all the tails of this iterable collection
- Example
-
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil) - Inherited from:
- IterableOps
Selects the last n elements.
Selects the last n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- n
-
the number of elements to take from this iterable collection.
Attributes
- Returns
-
a iterable collection consisting only of the last
nelements of this iterable collection, or else the whole iterable collection, if it has less thannelements. Ifnis negative, returns an empty iterable collection. - Inherited from:
- IterableOps
Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.
Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.
Type parameters
- U
-
the return type of f
Value parameters
- f
-
a function to apply to each element in this iterable collection
Attributes
- Returns
-
The same logical collection as this
- Definition Classes
-
IterableOps -> IterableOnceOps
- Inherited from:
- IterableOps
Given a collection factory factory, converts this iterable collection to the appropriate representation for the current element type A. Example uses:
Given a collection factory factory, converts this iterable collection to the appropriate representation for the current element type A. Example uses:
import scala.collection.mutable.ArrayBuffer
import scala.collection.immutable.BitSet
val xs: Iterable[Int] = Seq(1, 2, 3, 4, 5)
xs.to(List)
xs.to(ArrayBuffer)
xs.to(BitSet) // for xs: Iterable[Int]
Type parameters
- C1
-
the target collection type
Value parameters
- factory
-
the factory for the target collection type
Attributes
- Returns
-
a new collection of type
C1containing all elements of this iterable collection - Inherited from:
- IterableOnceOps
Converts this iterable collection to a Buffer.
Converts this iterable collection to a Buffer.
Type parameters
- B
-
The type of elements of the result, a supertype of
A.
Attributes
- Returns
-
This iterable collection as a
Buffer[B]. - Inherited from:
- IterableOnceOps
Method to render this Table[T] as a CSV String with (maybe) header.
Method to render this Table[T] as a CSV String with (maybe) header.
Value parameters
- csvAttributes
-
implicit value of CsvAttributes.
- rcr
-
implicit value of CsvRenderer[Row].
- rgr
-
implicit value of CsvProductGenerator[Row].
Attributes
- Returns
-
a String.
- Inherited from:
- Table
Converts this iterable collection to an IndexedSeq.
Converts this iterable collection to an IndexedSeq.
Attributes
- Returns
-
This iterable collection as an
IndexedSeq[A]. - Inherited from:
- IterableOnceOps
Converts this iterable collection to a List.
Converts this iterable collection to a List.
Attributes
- Returns
-
This iterable collection as a
List[A]. - Inherited from:
- IterableOnceOps
Converts this iterable collection to a Map, given an implicit coercion from the iterable collection's type to a key-value tuple.
Converts this iterable collection to a Map, given an implicit coercion from the iterable collection's type to a key-value tuple.
Type parameters
- K
-
The key type for the resulting map.
- V
-
The value type for the resulting map.
Value parameters
- ev
-
an implicit evidence that
Ais a subtype of(K, V)
Attributes
- Returns
-
This iterable collection as a
Map[K, V]. - Inherited from:
- IterableOnceOps
Converts this iterable collection to a Set.
Converts this iterable collection to a Set.
Type parameters
- B
-
The type of elements of the result, a supertype of
A.
Attributes
- Returns
-
This iterable collection as a
Set[B]. - Inherited from:
- IterableOnceOps
Converts this iterable collection to a Vector.
Converts this iterable collection to a Vector.
Attributes
- Returns
-
This iterable collection as a
Vector[A]. - Inherited from:
- IterableOnceOps
Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.
Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.
The resulting collection's type will be guided by the static type of iterable collection. For example:
val xs = List(
Set(1, 2, 3),
Set(4, 5, 6)).transpose
// xs == List(
// List(1, 4),
// List(2, 5),
// List(3, 6))
val ys = Vector(
List(1, 2, 3),
List(4, 5, 6)).transpose
// ys == Vector(
// Vector(1, 4),
// Vector(2, 5),
// Vector(3, 6))
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- B
-
the type of the elements of each iterable collection.
Value parameters
- asIterable
-
an implicit conversion which asserts that the element type of this iterable collection is an
Iterable.
Attributes
- Returns
-
a two-dimensional iterable collection of iterable collections which has as nth row the nth column of this iterable collection.
- Throws
-
IllegalArgumentException
if all collections in this iterable collection are not of the same size.
- Inherited from:
- IterableOps
Method to generate a Table[S] for a set of rows. Although declared as an instance method, this method produces its result independent of this.
Method to generate a Table[S] for a set of rows. Although declared as an instance method, this method produces its result independent of this.
Type parameters
- S
-
the underlying type of the rows and the result.
Value parameters
- ss
-
a sequence of S.
Attributes
- Returns
-
a new instance of Table[S].
- Inherited from:
- Table
Converts this iterable collection of pairs into two collections of the first and second half of each pair.
Converts this iterable collection of pairs into two collections of the first and second half of each pair.
val xs = $Coll(
(1, "one"),
(2, "two"),
(3, "three")).unzip
// xs == ($Coll(1, 2, 3),
// $Coll(one, two, three))
Type parameters
- A1
-
the type of the first half of the element pairs
- A2
-
the type of the second half of the element pairs
Value parameters
- asPair
-
an implicit conversion which asserts that the element type of this iterable collection is a pair.
Attributes
- Returns
-
a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.
- Inherited from:
- IterableOps
Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.
Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.
val xs = $Coll(
(1, "one", '1'),
(2, "two", '2'),
(3, "three", '3')).unzip3
// xs == ($Coll(1, 2, 3),
// $Coll(one, two, three),
// $Coll(1, 2, 3))
Type parameters
- A1
-
the type of the first member of the element triples
- A2
-
the type of the second member of the element triples
- A3
-
the type of the third member of the element triples
Value parameters
- asTriple
-
an implicit conversion which asserts that the element type of this iterable collection is a triple.
Attributes
- Returns
-
a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.
- Inherited from:
- IterableOps
A view over the elements of this collection.
A view over the elements of this collection.
Attributes
- Inherited from:
- IterableOps
Creates a non-strict filter of this iterable collection.
Creates a non-strict filter of this iterable 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.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
an object of class
WithFilter, which supportsmap,flatMap,foreach, andwithFilteroperations. All these operations apply to those elements of this iterable collection which satisfy the predicatep. - Inherited from:
- IterableOps
Writes the contents of the current table to a CSV file at the specified path.
Writes the contents of the current table to a CSV file at the specified path.
Value parameters
- csvAttributes
-
Implicit parameter containing attributes for customizing the CSV formatting.
- generator
-
Implicit parameter that is used to generate CSV rows from the data.
- path
-
The file system path where the CSV file will be written.
- renderer
-
Implicit parameter that provides a mechanism to render rows to CSV format.
Attributes
- Returns
-
Unit, indicating the operation does not return a value.
- Throws
-
TableException
if the CSV file cannot be written.
- Inherited from:
- Table
Converts the table to a CSV file and writes it to the specified output path.
Converts the table to a CSV file and writes it to the specified output path.
Value parameters
- ca
-
an implicit CsvAttributes instance specifying CSV configuration attributes
- g
-
an implicit CsvGenerator instance for generating CSV data from rows
- outputPath
-
the path where the CSV file will be written
- r
-
an implicit CsvRenderer instance for rendering rows
Attributes
- Returns
-
Unit
- Throws
-
TableException
if the CSV file cannot be written to the specified output path
- Inherited from:
- Table
Method to zip two Tables together such that the rows of the resulting table are tuples of the rows of the input tables.
Method to zip two Tables together such that the rows of the resulting table are tuples of the rows of the input tables.
Type parameters
- R
-
the underlying type of the other Table.
Value parameters
- rt
-
a Table[R].
Attributes
- Returns
-
a Table of (Row, R).
- Inherited from:
- Table
Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.
Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.
Type parameters
- B
-
the type of the second half of the returned pairs
Value parameters
- that
-
The iterable providing the second half of each result pair
Attributes
- Returns
-
a new iterable collection containing pairs consisting of corresponding elements of this iterable collection and
that. The length of the returned collection is the minimum of the lengths of this iterable collection andthat. - Inherited from:
- IterableOps
Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
Type parameters
- A1
-
the type of the first element in each result pair (supertype of
A) - B
-
the type of the second element in each result pair
Value parameters
- that
-
the iterable providing the second half of each result pair
- thatElem
-
the element to be used to fill up the result if
thatis shorter than this iterable collection. - thisElem
-
the element to be used to fill up the result if this iterable collection is shorter than
that.
Attributes
- Returns
-
a new iterable collection containing pairs consisting of corresponding elements of this iterable collection and
that. The length of the returned collection is the maximum of the lengths of this iterable collection andthat. If this iterable collection is shorter thanthat,thisElemvalues are used to pad the result. Ifthatis shorter than this iterable collection,thatElemvalues are used to pad the result. - Inherited from:
- IterableOps
Zips this iterable collection with its indices.
Zips this iterable collection with its indices.
Attributes
- Returns
-
A new iterable collection containing pairs consisting of all elements of this iterable collection paired with their index. Indices start at
0. - Example
-
List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2)) - Inherited from:
- IterableOps
Inherited and Abstract methods
Method to get all the elements of a particular column.
Method to get all the elements of a particular column.
Complexity: N + C where N is the number of rows and C is the number of columns.
Value parameters
- name
-
the column name.
Attributes
- Returns
-
an Iterator of Option[String].
- Inherited from:
- Table
Method to access the individual rows of this table.
Method to access the individual rows of this table.
Attributes
- Returns
-
the rows, in the same sequence in which they were parsed.
- Inherited from:
- Table
Method to generate a Table[S] for a set of rows. Although declared as an instance method, this method produces its result independent of this.
Method to generate a Table[S] for a set of rows. Although declared as an instance method, this method produces its result independent of this.
Type parameters
- S
-
the underlying type of the rows and the result.
Value parameters
- maybeHeader
-
an optional Header to be used in the resulting Table.
- ss
-
a sequence of S.
Attributes
- Returns
-
a new instance of Table[S].
- Inherited from:
- Table
Deprecated and Inherited methods
Attributes
- Deprecated
-
[Since version 2.13.0]Use ++ instead of ++: for collections of type Iterable - Inherited from:
- IterableOps
Attributes
- Deprecated
-
[Since version 2.13.0]Use foldLeft instead of /: - Inherited from:
- IterableOnceOps
Attributes
- Deprecated
-
[Since version 2.13.0]Use foldRight instead of :\\ - Inherited from:
- IterableOnceOps
Aggregates the results of applying an operator to subsequent elements.
Aggregates the results of applying an operator to subsequent elements.
Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.
For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.
Type parameters
- B
-
the result type, produced by
seqop,combop, and by this function as a final result.
Value parameters
- combop
-
an associative operator for combining sequential results, unused for sequential collections.
- seqop
-
the binary operator used to accumulate the result.
- z
-
the start value, a neutral element for
seqop.
Attributes
- Deprecated
-
[Since version 2.13.0]For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`. - Inherited from:
- IterableOnceOps
Attributes
- Deprecated
-
[Since version 2.13.0]Use iterableFactory instead - Inherited from:
- IterableOps
Attributes
- Deprecated
-
[Since version 2.13.0]Use `dest ++= coll` instead - Inherited from:
- IterableOnceOps
Tests whether this iterable 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.
Tests whether this iterable 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.
Attributes
- Returns
-
**true**if this collection is known to have finite size,**false**otherwise. - See also
-
method
knownSizefor a more useful alternative - Deprecated
-
[Since version 2.13.0]Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though
hasDefiniteSizereturnsfalse. - Inherited from:
- IterableOnceOps
Attributes
- Deprecated
-
[Since version 2.13.0]Use coll instead of repr in a collection implementation, use the collection value itself from the outside - Inherited from:
- IterableOps
Attributes
- Deprecated
-
[Since version 2.13.0]Iterable.seq always returns the iterable itself - Inherited from:
- Iterable
Attributes
- Returns
-
This collection as an
Iterable[A]. No new collection will be built ifthisis already anIterable[A]. - Deprecated
-
[Since version 2.13.7]toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections - Inherited from:
- Iterable
Attributes
- Deprecated
-
[Since version 2.13.0]Use .iterator instead of .toIterator - Inherited from:
- IterableOnceOps
Attributes
- Deprecated
-
[Since version 2.13.0]Use .to(LazyList) instead of .toStream - Inherited from:
- IterableOnceOps
Converts this iterable collection to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
Converts this iterable collection to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
Attributes
- Returns
-
An Iterable containing all elements of this iterable collection.
- Deprecated
-
[Since version 2.13.0]toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections - Inherited from:
- IterableOps
A view over a slice of the elements of this collection.
A view over a slice of the elements of this collection.
Attributes
- Deprecated
-
[Since version 2.13.0]Use .view.slice(from, until) instead of .view(from, until) - Inherited from:
- IterableOps
Concrete fields
Optional value of the Header of this Table, if there is one.
Optional value of the Header of this Table, if there is one.