Skip to content

Add scala.collection.Factory #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 18, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions src/main/scala-2.12/collection/Factory.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package scala.collection

import scala.collection.generic.CanBuildFrom

/**
* A factory that builds a collection of type `C` with elements of type `A`.
*
* @tparam A Type of elements (e.g. `Int`, `Boolean`, etc.)
* @tparam C Type of collection (e.g. `List[Int]`, `TreeMap[Int, String]`, etc.)
*/
trait Factory[-A, +C] extends Any {

/**
* @return A collection of type `C` containing the same elements
* as the source collection `it`.
* @param it Source collection
*/
def fromSpecific(it: TraversableOnce[A]): C

/** Get a Builder for the collection. For non-strict collection types this will use an intermediate buffer.
* Building collections with `fromSpecific` is preferred because it can be lazy for lazy collections. */
def newBuilder(): mutable.Builder[A, C]
}

object Factory {

implicit def fromCanBuildFrom[A, C](implicit cbf: CanBuildFrom[Nothing, A, C]): Factory[A, C] =
new Factory[A, C] {
def fromSpecific(it: TraversableOnce[A]): C = (cbf() ++= it).result()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs special treatment of Stream and LazyList to preserve laziness.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this works because Stream uses a LazyBuilder. I’ve added a test for that.

def newBuilder(): mutable.Builder[A, C] = cbf()
}

implicit def fromCanBuildFromConversion[X, A, C](x: X)(implicit toCanBuildFrom: X => CanBuildFrom[Nothing, A, C]): Factory[A, C] =
fromCanBuildFrom(toCanBuildFrom(x))

}
3 changes: 3 additions & 0 deletions src/main/scala-2.12/collection/compat/package.scala
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ package object compat {
implicit def sortedMapFactoryToCBF[K : Ordering, V, CC[A, B] <: SortedMap[A, B] with SortedMapLike[A, B, CC[A, B]]](fact: SortedMapFactory[CC]): CanBuildFrom[Any, (K, V), CC[K, V]] =
simpleCBF(fact.newBuilder[K, V])

implicit def bitSetFactoryToCBF(fact: BitSetFactory[BitSet]): CanBuildFrom[Any, Int, BitSet] =
simpleCBF(fact.newBuilder)

implicit def immutableBitSetFactoryToCBF(fact: BitSetFactory[immutable.BitSet]): CanBuildFrom[Any, Int, ImmutableBitSetCC[Int]] =
simpleCBF(fact.newBuilder)

Expand Down
20 changes: 20 additions & 0 deletions src/test/scala/collection/FactoryTest.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package collection

import scala.collection.{Factory, Iterable, BitSet, mutable, immutable}
import scala.collection.compat._

class FactoryTest {

implicitly[Factory[Char, String]]
implicitly[Factory[Char, Array[Char]]]
implicitly[Factory[Int, BitSet]]
implicitly[Factory[Int, mutable.BitSet]]
implicitly[Factory[Int, immutable.BitSet]]

BitSet: Factory[Int, BitSet]
Iterable: Factory[Int, Iterable[Int]]
immutable.TreeSet: Factory[Int, immutable.TreeSet[Int]]
Map: Factory[(Int, String), Map[Int, String]]
immutable.TreeMap: Factory[(Int, String), immutable.TreeMap[Int, String]]

}