Spec-Zone.ru › Scala 2.12 Library

Trait scala.collection.generic.GenericSetTemplate

trait GenericSetTemplate[A, +CC[X] <: GenSet[X]] extends GenericTraversableTemplate[A, CC]

Source
GenericSetTemplate.scala
Since

2.8

Linear Supertypes
Known Subclasses

Abstract Value Members

abstract def companion: GenericCompanion[CC]

The factory companion object that builds instances of class Traversable. (or its Iterable superclass where class Traversable is not a Seq.)

Definition Classes
GenericTraversableTemplate

abstract def head: A

Выбирает первый элемент этого набора.

returns

первый элемент этого набора.

Definition Classes
GenericTraversableTemplate
Exceptions thrown

NoSuchElementException, если коллекция пуста.

abstract def isEmpty: Boolean

Проверяет, пуст ли этот набор.

returns

true, если коллекция не содержит элементов, false в противном случае.

Definition Classes
GenericTraversableTemplate

Конкретные члены значений

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

возвращает

true если !(this == that), в противном случае false.

Классы определений
AnyRef → Any

final def ##(): Int

Эквивалентно x.hashCode, за исключением упакованных числовых типов и null. Для чисел он возвращает значение хэша, которое согласуется с равенством значений: если два экземпляра типа значения сравниваются как true, то ## будет производить одинаковое значение хэша для каждого из них. Для null возвращает хэш-код, где null.hashCode выбрасывает NullPointerException.

возвращает

значение хэша, согласованное с ==

Классы определений
AnyRef → Any

def +(other: String): String

Неявный
Этот член добавлен с помощью неявного преобразования из GenericSetTemplate[A, CC] в any2stringadd[GenericSetTemplate[A, CC]] с помощью метода any2stringadd в scala.Predef.
Классы определений
any2stringadd

def ->[B](y: B): (GenericSetTemplate[A, CC], B)

Неявный
Этот член добавлен с помощью неявного преобразования из GenericSetTemplate[A, CC] в ArrowAssoc[GenericSetTemplate[A, CC]] с помощью метода ArrowAssoc в scala.Predef.
Классы определений
ArrowAssoc
Аннотации
@inline()

final def ==(arg0: Any): Boolean

Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

возвращает

true если объект-получатель эквивалентен аргументу; false в противном случае.

Классы определений
AnyRef → Any

final def asInstanceOf[T0]: T0

Привести объект-получатель к типу T0.

Обратите внимание, что успех приведения в рантайме зависит от семантики стирания Scala. Поэтому выражение 1.asInstanceOf[String] выбросит ClassCastException во время выполнения, в то время как выражение List(1).asInstanceOf[List[String]] не выбросит. В последнем примере, поскольку тип аргумента стирается на этапе компиляции, невозможно проверить, соответствуют ли содержимое списка нужному типу.

возвращает

объект-получатель.

Классы определений
Any
Исключения

ClassCastException, если объект-получатель не является экземпляром стирания типа T0.

def clone(): AnyRef

Создать копию объекта-получателя.

По умолчанию реализация метода clone зависит от платформы.

возвращает

копию объекта-получателя.

Атрибуты
protected[lang]
Классы определений
AnyRef
Аннотации
@throws( ... ) @native()
Примечание

не указано SLS как член AnyRef

def empty: CC[A]

def ensuring(cond: (GenericSetTemplate[A, CC]) ⇒ Boolean, msg: ⇒ Any): GenericSetTemplate[A, CC]

Неявный
Этот член добавлен с помощью неявного преобразования из GenericSetTemplate[A, CC] в Ensuring[GenericSetTemplate[A, CC]] с помощью метода Ensuring в scala.Predef.
Классы определений
Ensuring

def ensuring(cond: (GenericSetTemplate[A, CC]) ⇒ Boolean): GenericSetTemplate[A, CC]

Неявный
Этот член добавлен неявным преобразованием из GenericSetTemplate[A, CC] в Ensuring[GenericSetTemplate[A, CC]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): GenericSetTemplate[A, CC]

Неявный
Этот член добавлен неявным преобразованием из GenericSetTemplate[A, CC] в Ensuring[GenericSetTemplate[A, CC]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean): GenericSetTemplate[A, CC]

Неявный
Этот член добавлен неявным преобразованием из GenericSetTemplate[A, CC] в Ensuring[GenericSetTemplate[A, CC]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

final def eq(arg0: AnyRef): Boolean

Проверяет, является ли аргумент (that) ссылкой на объект-получатель (this).

Метод eq реализует отношение эквивалентности на не-null экземплярах AnyRef, и имеет три дополнительных свойства:

    Он согласован: для любых не-null экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false. Для любого не-null экземпляра x типа AnyRef, x.eq(null) и null.eq(x) возвращают false. null.eq(null) возвращает true.

При переопределении методов equals или hashCode важно обеспечить, чтобы их поведение соответствовало равенству ссылок. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2), они должны быть равны друг другу (o1 == o2) и они должны хешироваться к одному значению (o1.hashCode == o2.hashCode).

возвращает

true если аргумент является ссылкой на объект-получатель; false в противном случае.

Определяющие классы
AnyRef

def equals(arg0: Any): Boolean

Метод равенства для ссылочных типов. Реализация по умолчанию делегирует eq.

См. также equals в scala.Any.

возвращает

true если объект-получатель эквивалентен аргументу; false в противном случае.

Определяющие классы
AnyRef → Any

def finalize(): Unit

Вызывается сборщиком мусора для объекта-получателя, когда больше нет ссылок на объект.

Подробности о том, когда и если вызывается метод finalize, а также взаимодействие между finalize и нелокальными возвратами и исключениями, зависят от платформы.

Атрибуты
protected[lang]
Определяющие классы
AnyRef
Аннотации
@throws( classOf[java.lang.Throwable] )
Примечание

не определен SLS в качестве члена AnyRef

def flatten[B]: Traversable[B]

[use case]

Преобразует это множество итерируемых коллекций в коллекцию, образованную из элементов этих итерируемых коллекций.

Тип результирующей коллекции будет определяться статическим типом коллекции. Например:

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)
B

тип элементов каждой итерируемой коллекции.

возвращает

новую коллекцию, полученную путём конкатенации всех элементов коллекций.

Определяющие классы
GenericTraversableTemplate
Полная сигнатура

abstract def foreach(f: (A) ⇒ Unit): Unit

[случай использования]
f

функция, которая применяется для побочного эффекта к каждому элементу. Результат функции f игнорируется.

Классы определений
GenericTraversableTemplate
Полная подпись

def formatted(fmtstr: String): String

Возвращает строку, отформатированную в соответствии с заданной format строкой. Форматные строки аналогичны String.format (см. java.lang.String.format).

Неявный
Этот член добавлен с помощью неявного преобразования из GenericSetTemplate[A, CC] в StringFormat[GenericSetTemplate[A, CC]], выполненного методом StringFormat в scala.Predef.
Классы определений
StringFormat
Аннотации
@inline()

def genericBuilder[B]: Builder[B, CC[B]]

Обобщённый билдер, создающий экземпляры Traversable с произвольными типами элементов.

Классы определений
GenericTraversableTemplate

final def getClass(): Class[_]

Возвращает представление класса объекта во время выполнения.

возвращает

объект класса, соответствующий типу получателя во время выполнения.

Классы определений
AnyRef → Any
Аннотации
@native()

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

возвращает

значение хэш-кода для этого объекта.

Классы определений
AnyRef → Any
Аннотации
@native()

final def isInstanceOf[T0]: Boolean

Проверяет, является ли динамический тип объекта-получателя T0.

Обратите внимание, что результат проверки выполняется с учётом стирания типов Scala. Поэтому выражение 1.isInstanceOf[String] вернёт false, а выражение List(1).isInstanceOf[List[String]] вернёт true. В последнем примере, из-за стирания аргумента типа во время компиляции невозможно проверить, соответствуют ли содержимое списка указанному типу.

возвращает

true , если объект-получатель является экземпляром стирания типа T0; false в противном случае.

Классы определений
Any

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

возвращает

true , если аргумент не является ссылкой на объект-получатель; false в противном случае.

Классы определений
AnyRef

def newBuilder: Builder[A, CC[A]]

Билдер, создающий экземпляры типа Traversable[A]

Атрибуты
protected[this]
Классы определений
GenericTraversableTemplate → HasNewBuilder

final def notify(): Unit

Разбуждает единственную нить, ожидающую монитора объекта-получателя.

Классы определений
AnyRef
Аннотации
@native()
Примечание

не определено в SLS как член AnyRef

final def notifyAll(): Unit

Разбуждает все нити, ожидающие монитора объекта-получателя.

Классы определений
AnyRef
Аннотации
@native()
Примечание

не определено в SLS как член AnyRef

final def synchronized[T0](arg0: ⇒ T0): T0

Классы определений
AnyRef

def toParArray: ParArray[T]

Неявный
Этот член добавлен неявным преобразованием из GenericSetTemplate[A, CC] в CollectionsHaveToParArray[GenericSetTemplate[A, CC], T] через метод CollectionsHaveToParArray в scala.collection.parallel. Это преобразование произойдёт только в том случае, если в области видимости есть неявное значение типа (GenericSetTemplate[A, CC]) ⇒ GenTraversableOnce[T].
Классы-определения
CollectionsHaveToParArray

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java оно представляет собой конкатенацию имени класса, "@", и хэш-кода объекта в шестнадцатеричном формате.

возвращает

строковое представление объекта.

Классы-определения
AnyRef → Any

def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): CC[CC[B]]

Транспонирует это множество коллекций итераций в множество коллекций.

Тип результирующей коллекции будет определяться статическим типом коллекции. Например:

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))
B

тип элементов каждой коллекции итераций.

asTraversable

неявное преобразование, которое утверждает, что тип элемента этой коллекции является Traversable.

возвращает

двумерная коллекция коллекций, где n-я строка — это n-й столбец этой коллекции.

Классы-определения
GenericTraversableTemplate
Аннотации
@migration
Миграция

(Изменено в версии 2.9.0) transpose выбрасывает IllegalArgumentException , если коллекции не имеют одинакового размера.

Исключения

IllegalArgumentException если все коллекции в этой коллекции не имеют одинакового размера.

def unzip[A1, A2](implicit asPair: (A) ⇒ (A1, A2)): (CC[A1], CC[A2])

Преобразует это множество пар в два множества первой и второй половины каждой пары.

val xs = Traversable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three))
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

asPair

неявное преобразование, которое утверждает, что тип элемента этой коллекции является парой.

возвращает

пара коллекций, содержащая первую, соответственно вторую половину каждой пары элементов этой коллекции.

Классы-определения
GenericTraversableTemplate

def unzip3[A1, A2, A3](implicit asTriple: (A) ⇒ (A1, A2, A3)): (CC[A1], CC[A2], CC[A3])

Преобразует это множество троек в три множества первого, второго и третьего элемента каждой тройки.

val xs = Traversable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three),
//        Traversable(1, 2, 3))
A1

тип первого члена троек элементов

A2

тип второго члена троек элементов

A3

тип третьего члена троек элементов

asTriple

неявное преобразование, которое утверждает, что тип элемента этой коллекции является тройкой.

возвращает

тройка коллекций, содержащая первый, второй, соответственно третий член каждой тройки элементов этой коллекции.

Классы-определения
GenericTraversableTemplate

final def wait(): Unit

Классы-определения
AnyRef
Аннотации
@throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Классы-определения
AnyRef
Аннотации
@throws( ... )

final def wait(arg0: Long): Unit

Описание классов
AnyRef
Аннотации
@throws( ... ) @native()

def →[B](y: B): (GenericSetTemplate[A, CC], B)

Неявный
Этот член добавлен с помощью неявного преобразования из GenericSetTemplate[A, CC] в ArrowAssoc[GenericSetTemplate[A, CC]], выполненного методом ArrowAssoc в scala.Predef.
Описание классов
ArrowAssoc

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/collection/generic/GenericSetTemplate.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API