Spec-Zone.ru › Scala 2.12 Library

Трейт scala.collection.generic.GenericParTemplate

trait GenericParTemplate[+A, +CC[X] <: ParIterable[X]] extends GenericTraversableTemplate[A, CC] with HasNewCombiner[A, CC[A]]

Шаблонный трейт для коллекций, имеющих компаньон.

A

тип элементов коллекции

CC

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

Source
GenericParTemplate.scala
Since

2.8

Линейные супертипы
Известные подклассы

Абстрактные члены-значения

abstract def companion: GenericCompanion[CC] with GenericParCompanion[CC]

Объект-компаньон фабрики, который создает экземпляры класса Traversable. (или его Iterable суперкласс, где класс Traversable не является Seq.)

Definition Classes
GenericParTemplate → GenericTraversableTemplate

abstract def head: A

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

returns

первый элемент этой коллекции.

Definition Classes
GenericTraversableTemplate
Исключения

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

abstract def isEmpty: Boolean

Проверяет, является ли эта коллекция пустой.

returns

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

Definition Classes
GenericTraversableTemplate

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

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

def +(other: String): String

Неявный
Этот член добавлен неявным преобразованием из GenericParTemplate[A, CC] в any2stringadd[GenericParTemplate[A, CC]], выполненным методом any2stringadd в scala.Predef.
Definition Classes
any2stringadd

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

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

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def asInstanceOf[T0]: T0

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

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

returns

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

Definition Classes
Any
Исключения

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

def clone(): AnyRef

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

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

returns

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

Атрибуты
protected[lang]
Definition Classes
AnyRef
Аннотации
@throws( ... ) @native()
Примечание

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

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

[use case]
f

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

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

def formatted(fmtstr: String): String

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

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

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

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

Определяющие классы
GenericParTemplate → GenericTraversableTemplate

def genericCombiner[B]: Combiner[B, CC[B]]

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]
Определяющие классы
GenericParTemplate → GenericTraversableTemplate → HasNewBuilder

def newCombiner: Combiner[A, CC[A]]

Атрибуты
protected[this]
Определяющие классы
GenericParTemplate → HasNewCombiner

final def notify(): Unit

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

Определяющие классы
AnyRef
Аннотации
@native()
Примечание

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

final def notifyAll(): Unit

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

Определяющие классы
AnyRef
Аннотации
@native()
Примечание

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

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

Definition Classes
AnyRef

def toParArray: ParArray[T]

Неявный
Этот член добавлен с помощью неявного преобразования от GenericParTemplate[A, CC] к CollectionsHaveToParArray[GenericParTemplate[A, CC], T] при помощи метода CollectionsHaveToParArray в scala.collection.parallel. Это преобразование будет выполнено только в том случае, если в области видимости присутствует неявное значение типа (GenericParTemplate[A, CC]) ⇒ GenTraversableOnce[T].
Definition Classes
CollectionsHaveToParArray

def toString(): String

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

returns

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

Definition Classes
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.

returns

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

Definition Classes
GenericTraversableTemplate
Annotations
@migration
Migration

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

Exceptions thrown

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

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

returns

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

Definition Classes
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

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

returns

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

Definition Classes
GenericTraversableTemplate

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

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

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

final def wait(arg0: Long): Unit

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

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

Неявный
Этот член добавлен с помощью неявного преобразования из GenericParTemplate[A, CC] в ArrowAssoc[GenericParTemplate[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/GenericParTemplate.html

Spec-Zone.ru

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