229

在 Scala 2.8中,有一个对象scala.collection.package.scala

def breakOut[From, T, To](implicit b : CanBuildFrom[Nothing, T, To]) =
    new CanBuildFrom[From, T, To] {
        def apply(from: From) = b.apply() ; def apply() = b.apply()
 }

我被告知这会导致:

> import scala.collection.breakOut
> val map : Map[Int,String] = List("London", "Paris").map(x => (x.length, x))(breakOut)

map: Map[Int,String] = Map(6 -> London, 5 -> Paris)

这里发生了什么?为什么breakOut被称为my的参数List

4

4 回答 4

335

答案在 的定义中找到map

def map[B, That](f : (A) => B)(implicit bf : CanBuildFrom[Repr, B, That]) : That 

请注意,它有两个参数。第一个是你的函数,第二个是隐式的。如果你不提供隐含的,Scala 将选择最具体的可用。

关于breakOut

那么,这样做的目的是breakOut什么?考虑为问题给出的示例,您获取一个字符串列表,将每个字符串转换为一个 tuple (Int, String),然后从中产生一个Map。最明显的方法是生成一个中间List[(Int, String)]集合,然后转换它。

鉴于map使用 aBuilder来生成结果集合,是否可以跳过中介List并将结果直接收集到 a 中Map?显然,是的,是的。然而,要这样做,我们需要传递一个正确的CanBuildFromto map,而这正是这样breakOut做的。

那么,让我们看一下 的定义breakOut

def breakOut[From, T, To](implicit b : CanBuildFrom[Nothing, T, To]) =
  new CanBuildFrom[From, T, To] {
    def apply(from: From) = b.apply() ; def apply() = b.apply()
  }

请注意,它breakOut是参数化的,并且它返回CanBuildFrom. 碰巧,类型FromT已经To被推断出来,因为我们知道这map是期待的CanBuildFrom[List[String], (Int, String), Map[Int, String]]。所以:

From = List[String]
T = (Int, String)
To = Map[Int, String]

最后,让我们检查一下自己收到的隐式breakOut。它是类型CanBuildFrom[Nothing,T,To]。我们已经知道所有这些类型,所以我们可以确定我们需要一个隐式类型CanBuildFrom[Nothing,(Int,String),Map[Int,String]]。但是有这样的定义吗?

我们看一下CanBuildFrom的定义:

trait CanBuildFrom[-From, -Elem, +To] 
extends AnyRef

所以CanBuildFrom它的第一个类型参数是逆变的。因为Nothing是一个底层类(即它是一切的子类),这意味着任何类都可以用来代替Nothing.

由于存在这样的构建器,Scala 可以使用它来生成所需的输出。

关于建筑商

Scala 集合库中的许多方法包括获取原始集合,以某种方式对其进行处理(在 的情况下map,转换每个元素),并将结果存储在新集合中。

为了最大限度地重用代码,这种结果的存储是通过构建器( scala.collection.mutable.Builder) 完成的,它基本上支持两种操作:添加元素和返回结果集合。此结果集合的类型将取决于构建器的类型。因此,List构建器将返回 a ListMap构建器将返回 a Map,依此类推。方法的实现map不需要关心结果的类型:构建器会处理它。

另一方面,这意味着map需要以某种方式接收此构建器。设计 Scala 2.8 Collections 时面临的问题是如何选择最好的构建器。例如,如果我要写Map('a' -> 1).map(_.swap),我想得到一个Map(1 -> 'a')回报。另一方面, aMap('a' -> 1).map(_._1)不能返回 a Map(它返回 a Iterable)。

通过这种隐式Builder执行从已知类型的表达式中产生最佳可能的魔力。CanBuildFrom

关于CanBuildFrom

为了更好地解释发生了什么,我将给出一个示例,其中被映射的集合是 aMap而不是 a List。我稍后再回去List。现在,考虑以下两个表达式:

Map(1 -> "one", 2 -> "two") map Function.tupled(_ -> _.length)
Map(1 -> "one", 2 -> "two") map (_._2)

第一个返回 a Map,第二个返回一个Iterable。归还合身系列的魔力在于CanBuildFrom. 让我们再考虑一下的定义map来理解它。

该方法map继承自TraversableLike. 它在 and 上进行参数化BThat并使用类型参数AandRepr来参数化类。让我们一起看看这两个定义:

该类TraversableLike定义为:

trait TraversableLike[+A, +Repr] 
extends HasNewBuilder[A, Repr] with AnyRef

def map[B, That](f : (A) => B)(implicit bf : CanBuildFrom[Repr, B, That]) : That 

要了解从何A而来Repr,让我们考虑一下Map自身的定义:

trait Map[A, +B] 
extends Iterable[(A, B)] with Map[A, B] with MapLike[A, B, Map[A, B]]

因为TraversableLike被所有扩展的特征继承MapA并且Repr可以从它们中的任何一个继承。不过,最后一个获得了偏好。因此,根据不可变的定义以及Map将其连接到 的所有特征TraversableLike,我们有:

trait Map[A, +B] 
extends Iterable[(A, B)] with Map[A, B] with MapLike[A, B, Map[A, B]]

trait MapLike[A, +B, +This <: MapLike[A, B, This] with Map[A, B]] 
extends MapLike[A, B, This]

trait MapLike[A, +B, +This <: MapLike[A, B, This] with Map[A, B]] 
extends PartialFunction[A, B] with IterableLike[(A, B), This] with Subtractable[A, This]

trait IterableLike[+A, +Repr] 
extends Equals with TraversableLike[A, Repr]

trait TraversableLike[+A, +Repr] 
extends HasNewBuilder[A, Repr] with AnyRef

如果您将类型参数Map[Int, String]一路向下传递,我们会发现传递给 的类型TraversableLike,并因此被 使用map,是:

A = (Int,String)
Repr = Map[Int, String]

回到这个例子,第一个 map 接收一个 type 的函数,((Int, String)) => (Int, Int)第二个 map 接收一个 type 的函数((Int, String)) => String。我使用双括号来强调它是一个正在接收的元组,因为这是A我们看到的类型。

有了这些信息,让我们考虑其他类型。

map Function.tupled(_ -> _.length):
B = (Int, Int)

map (_._2):
B = String

我们可以看到第一个返回的类型mapMap[Int,Int],第二个是Iterable[String]。查看map的定义,很容易看出这些是 的值That。但它们来自哪里?

如果我们查看所涉及类的伴生对象,我们会看到一些提供它们的隐式声明。在对象上Map

implicit def  canBuildFrom [A, B] : CanBuildFrom[Map, (A, B), Map[A, B]]  

在 object 上Iterable,其类通过以下方式扩展Map

implicit def  canBuildFrom [A] : CanBuildFrom[Iterable, A, Iterable[A]]  

这些定义为参数化提供了工厂CanBuildFrom

Scala 将选择最具体的可用隐式。在第一种情况下,它是第一个CanBuildFrom。在第二种情况下,由于第一种不匹配,它选择了第二种CanBuildFrom

回到问题

让我们看看问题的代码,List's 和map' 的定义(再次)看看类型是如何推断的:

val map : Map[Int,String] = List("London", "Paris").map(x => (x.length, x))(breakOut)

sealed abstract class List[+A] 
extends LinearSeq[A] with Product with GenericTraversableTemplate[A, List] with LinearSeqLike[A, List[A]]

trait LinearSeqLike[+A, +Repr <: LinearSeqLike[A, Repr]] 
extends SeqLike[A, Repr]

trait SeqLike[+A, +Repr] 
extends IterableLike[A, Repr]

trait IterableLike[+A, +Repr] 
extends Equals with TraversableLike[A, Repr]

trait TraversableLike[+A, +Repr] 
extends HasNewBuilder[A, Repr] with AnyRef

def map[B, That](f : (A) => B)(implicit bf : CanBuildFrom[Repr, B, That]) : That 

的类型List("London", "Paris")List[String],所以类型ARepr定义TraversableLike为:

A = String
Repr = List[String]

的类型(x => (x.length, x))(String) => (Int, String),所以 的类型B是:

B = (Int, String)

最后一个未知类型That是 的结果的类型map,我们也已经有了:

val map : Map[Int,String] =

所以,

That = Map[Int, String]

这意味着breakOut必须返回一个类型或子类型CanBuildFrom[List[String], (Int, String), Map[Int, String]]

于 2009-11-11T16:53:02.847 回答
86

我想以丹尼尔的回答为基础。它非常彻底,但正如评论中所述,它没有解释突破的作用。

取自Re: Support for explicit Builders (2009-10-23),这是我认为 breakout 所做的:

它给编译器一个关于隐式选择哪个 Builder 的建议(本质上它允许编译器选择它认为最适合情况的工厂。)

例如,请参阅以下内容:

scala> import scala.collection.generic._
import scala.collection.generic._

scala> import scala.collection._
import scala.collection._

scala> import scala.collection.mutable._
import scala.collection.mutable._

scala>

scala> def breakOut[From, T, To](implicit b : CanBuildFrom[Nothing, T, To]) =
     |    new CanBuildFrom[From, T, To] {
     |       def apply(from: From) = b.apply() ; def apply() = b.apply()
     |    }
breakOut: [From, T, To]
     |    (implicit b: scala.collection.generic.CanBuildFrom[Nothing,T,To])
     |    java.lang.Object with
     |    scala.collection.generic.CanBuildFrom[From,T,To]

scala> val l = List(1, 2, 3)
l: List[Int] = List(1, 2, 3)

scala> val imp = l.map(_ + 1)(breakOut)
imp: scala.collection.immutable.IndexedSeq[Int] = Vector(2, 3, 4)

scala> val arr: Array[Int] = l.map(_ + 1)(breakOut)
imp: Array[Int] = Array(2, 3, 4)

scala> val stream: Stream[Int] = l.map(_ + 1)(breakOut)
stream: Stream[Int] = Stream(2, ?)

scala> val seq: Seq[Int] = l.map(_ + 1)(breakOut)
seq: scala.collection.mutable.Seq[Int] = ArrayBuffer(2, 3, 4)

scala> val set: Set[Int] = l.map(_ + 1)(breakOut)
seq: scala.collection.mutable.Set[Int] = Set(2, 4, 3)

scala> val hashSet: HashSet[Int] = l.map(_ + 1)(breakOut)
seq: scala.collection.mutable.HashSet[Int] = Set(2, 4, 3)

您可以看到编译器隐式选择返回类型以最匹配预期类型。根据您声明接收变量的方式,您会得到不同的结果。

以下是指定构建器的等效方法。请注意,在这种情况下,编译器将根据构建器的类型推断出预期的类型:

scala> def buildWith[From, T, To](b : Builder[T, To]) =
     |    new CanBuildFrom[From, T, To] {
     |      def apply(from: From) = b ; def apply() = b
     |    }
buildWith: [From, T, To]
     |    (b: scala.collection.mutable.Builder[T,To])
     |    java.lang.Object with
     |    scala.collection.generic.CanBuildFrom[From,T,To]

scala> val a = l.map(_ + 1)(buildWith(Array.newBuilder[Int]))
a: Array[Int] = Array(2, 3, 4)
于 2011-09-13T15:35:54.103 回答
10

Daniel Sobral 的回答很棒,应该与Architecture of Scala Collections(Scala 编程的第 25 章)一起阅读。

我只是想详细说明为什么它被称为breakOut

为什么叫它breakOut

因为我们想突破一种类型并进入另一种类型

突破什么类型变成什么类型​​?让我们以mapon 函数Seq为例:

Seq.map[B, That](f: (A) -> B)(implicit bf: CanBuildFrom[Seq[A], B, That]): That

如果我们想直接通过对序列元素的映射来构建 Map,例如:

val x: Map[String, Int] = Seq("A", "BB", "CCC").map(s => (s, s.length))

编译器会抱怨:

error: type mismatch;
found   : Seq[(String, Int)]
required: Map[String,Int]

原因是 Seq 只知道如何构建另一个 Seq(即有一个CanBuildFrom[Seq[_], B, Seq[B]]可用的隐式构建器工厂,但没有从Seq到 Map 的构建器工厂)。

为了编译,我们需要某种breakOut类型的需求,并且能够构造一个生成器生成 Map 供map函数使用的构建器。

正如 Daniel 所解释的,breakOut 具有以下签名:

def breakOut[From, T, To](implicit b: CanBuildFrom[Nothing, T, To]): CanBuildFrom[From, T, To] =
    // can't just return b because the argument to apply could be cast to From in b
    new CanBuildFrom[From, T, To] {
      def apply(from: From) = b.apply()
      def apply()           = b.apply()
    }

Nothing是所有类的子类,因此任何构建器工厂都可以代替implicit b: CanBuildFrom[Nothing, T, To]. 如果我们使用 breakOut 函数提供隐式参数:

val x: Map[String, Int] = Seq("A", "BB", "CCC").map(s => (s, s.length))(collection.breakOut)

它将编译,因为breakOut能够提供所需的 类型CanBuildFrom[Seq[(String, Int)], (String, Int), Map[String, Int]],而编译器能够找到类型的隐式构建器工厂来CanBuildFrom[Map[_, _], (A, B), Map[A, B]]代替CanBuildFrom[Nothing, T, To],以便 breakOut 用于创建实际的构建器。

请注意,这CanBuildFrom[Map[_, _], (A, B), Map[A, B]]是在 Map 中定义的,并且只需启动MapBuilder使用底层 Map 的 a。

希望这可以解决问题。

于 2017-04-30T14:26:24.553 回答
6

一个简单的例子来理解什么breakOut

scala> import collection.breakOut
import collection.breakOut

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

scala> set.map(_ % 2)
res0: scala.collection.immutable.Set[Int] = Set(1, 0)

scala> val seq:Seq[Int] = set.map(_ % 2)(breakOut)
seq: Seq[Int] = Vector(1, 0, 1, 0) // map created a Seq[Int] instead of the default Set[Int]
于 2016-10-17T21:09:06.330 回答