scala.collection.generic.Shrinkable.scala Maven / Gradle / Ivy
/*
* Scala (https://www.scala-lang.org)
*
* Copyright EPFL and Lightbend, Inc.
*
* Licensed under Apache License 2.0
* (http://www.apache.org/licenses/LICENSE-2.0).
*
* See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*/
package scala
package collection
package generic
/** This trait forms part of collections that can be reduced
* using a `-=` operator.
*
* @author Martin Odersky
* @since 2.8
* @define coll shrinkable collection
* @define Coll `Shrinkable`
*/
trait Shrinkable[-A] {
/** Removes a single element from this $coll.
*
* @param elem the element to remove.
* @return the $coll itself
*/
def -=(elem: A): this.type
/** Removes two or more elements from this $coll.
*
* @param elem1 the first element to remove.
* @param elem2 the second element to remove.
* @param elems the remaining elements to remove.
* @return the $coll itself
*/
def -=(elem1: A, elem2: A, elems: A*): this.type = {
this -= elem1
this -= elem2
this --= elems
}
/** Removes all elements produced by an iterator from this $coll.
*
* @param xs the iterator producing the elements to remove.
* @return the $coll itself
*/
def --=(xs: TraversableOnce[A]): this.type = { xs foreach -= ; this }
}