Spec-Zone.ru › Scala 2.13 Library

Тракт scala.collection.immutable.LinearSeq

Компаньон объект LinearSeq

тракт LinearSeq[+A] extends Seq[A] with collection.LinearSeq[A] with LinearSeqOps[A, LinearSeq, LinearSeq[A]] with IterableFactoryDefaults[A, LinearSeq]

Базовый тракт для неизменяемых линейных последовательностей, которые имеют эффективные head и tail

Source
Seq.scala
Линейные супертипы
LinearSeqOps[A, LinearSeq, LinearSeq[A]], collection.LinearSeq[A], collection.LinearSeqOps[A, [X]LinearSeq[X], LinearSeq[A]], Seq[A], SeqOps[A, [_]LinearSeq[_], LinearSeq[A]], collection.Seq[A], Equals, collection.SeqOps[A, [_]LinearSeq[_], LinearSeq[A]], PartialFunction[Int, A], (Int) => A, Iterable[A], collection.Iterable[A], IterableFactoryDefaults[A, [x]LinearSeq[x]], IterableOps[A, [_]LinearSeq[_], LinearSeq[A]], IterableOnceOps[A, [_]LinearSeq[_], LinearSeq[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
::, LazyList, List, Nil, Queue, Cons, Empty, Stream

Члены-значения

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

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

final def ++[B >: A](suffix: IterableOnce[B]): LinearSeq[B]

Псевдоним для concat

Definition Classes
IterableOps
Annotations
@inline()

final def ++:[B >: A](prefix: IterableOnce[B]): LinearSeq[B]

Псевдоним для prependedAll

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

final def +:[B >: A](elem: B): LinearSeq[B]

Псевдоним для prepended.

Обратите внимание, что операторы с окончанием :- являются правоассоциативными (см. пример). Мемоническое правило для +: против :+: двоеточие ставится со стороны коллекции.

Definition Classes
SeqOps
Annotations
@inline()

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

Implicit
Этот член добавлен неявным преобразованием из LinearSeq[A] вArrowAssoc[LinearSeq[A]], выполненное методом ArrowAssoc в scala.Predef.Это преобразование будет выполнено только если A является подклассом Option[Nothing] (A <: Option[Nothing]).
Definition Classes
ArrowAssoc
Annotations
@inline()

final def :+[B >: A](elem: B): LinearSeq[B]

Псевдоним для appended

Обратите внимание, что операторы с окончанием :- являются правоассоциативными (см. пример). Мемоническое правило для +: против :+: двоеточие ставится со стороны коллекции.

Definition Classes
SeqOps
Annotations
@inline()

final def :++[B >: A](suffix: IterableOnce[B]): LinearSeq[B]

Псевдоним для appendedAll

Классы определений
SeqOps
Аннотации
@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 addString(b: mutable.StringBuilder): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер. Текст, который записывается, состоит из строковых представлений (согласно методу toString) всех элементов этой коллекции без разделительной строки.

Пример:

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

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234
b

строковый буфер, в который добавляются элементы.

возвращает

строковый буфер b в который были добавлены элементы.

Классы определений
IterableOnceOps
Аннотации
@inline()

final def addString(b: mutable.StringBuilder, sep: String): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер с использованием разделительной строки. Записываемый текст состоит из строковых представлений (согласно методу toString) всех элементов этой коллекции, разделенных строкой sep.

Пример:

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

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
b

строковый буфер, в который добавляются элементы.

sep

разделительная строка.

возвращает

строковый буфер b в который были добавлены элементы.

Классы определений
IterableOnceOps
Аннотации
@inline()

def addString(b: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер с использованием начальной, конечной и разделительных строк. Записываемый текст начинается со строки start и заканчивается строкой end. Внутри строковые представления (согласно методу toString) всех элементов этой коллекции разделены строкой sep.

Пример:

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

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
b

строковый буфер, в который добавляются элементы.

start

начальная строка.

sep

разделительная строка.

end

конечная строка.

возвращает

строковый буфер b в который были добавлены элементы.

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

def andThen[C](k: PartialFunction[A, C]): PartialFunction[Int, C]

Композирует эту частичную функцию с другой частичной функцией, которая применяется к результатам этой частичной функции.

Обратите внимание, что вызов isDefinedAt на результирующей частичной функции может применить первую частичную функцию и выполнить её побочный эффект. Рекомендуется вместо applyOrElse использовать isDefinedAt / apply для повышения эффективности.

C

тип результата функции преобразования.

k

функция преобразования

возвращает

частичная функция с областью определения этой частичной функции, суженной другой частичной функцией, которая отображает аргументы x в k(this(x)).

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

def andThen[C](k: (A) => C): PartialFunction[Int, C]

Композирует эту частичную функцию с функцией преобразования, которая применяется к результатам этой частичной функции.

Если тип функции во время выполнения является PartialFunction, используется другой метод andThen (обратите внимание на предостережения).

C

тип результата функции преобразования.

k

функция преобразования

возвращает

частичная функция с областью определения этой частичной функции, возможно суженной указанной функцией, которая отображает аргументы x в k(this(x)).

Классы определений
PartialFunction → Function1

def appended[B >: A](elem: B): LinearSeq[B]

Копия этой последовательности с добавленным элементом.

Примечание: не будет завершаться для бесконечно больших коллекций.

Пример:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = a :+ 2
b: List[Int] = List(1, 2)

scala> println(a)
List(1)
B

тип элемента возвращаемой последовательности.

elem

добавляемый элемент

returns

новая последовательность, состоящая из всех элементов этой последовательности, за которыми следует value.

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

def appendedAll[B >: A](suffix: IterableOnce[B]): LinearSeq[B]

Возвращает новую последовательность, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда. Тип элемента последовательности является наиболее специфическим суперклассом, охватывающим типы элементов двух операндов.

B

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

suffix

итерируемый объект для добавления.

returns

новая коллекция типа CC[B], которая содержит все элементы этой последовательности, за которыми следуют все элементы suffix.

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

def apply(n: Int): A

Получение элемента по указанному индексу. Эта операция предоставляется для удобства в Seq. Не следует предполагать, что она эффективна, если у вас нет IndexedSeq.

Определяющие классы
LinearSeqOps → SeqOps
Аннотации
@throws(scala.this.throws.<init>$default$1[IndexOutOfBoundsException])

def applyOrElse[A1 <: Int, B1 >: A](x: A1, default: (A1) => B1): B1

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

Обратите внимание, что выражение pf.applyOrElse(x, default) эквивалентно

if(pf isDefinedAt x) pf(x) else default(x)

за исключением того, что метод applyOrElse может быть реализован более эффективно. Для всех литералов частичных функций компилятор генерирует реализацию applyOrElse, которая позволяет избежать двойной оценки согласующих шаблонов и охранников. Это делает applyOrElse основой для эффективной реализации для многих операций и сценариев, таких как:

    объединение частичных функций в цепочки orElse/andThen не приводит к чрезмерной оценке apply/isDefinedAt lift и unlift не оценивают исходные функции дважды при каждом вызове runWith позволяет эффективно комбинировать частичные функции императивного стиля с условно применяемыми действиями

Для нелитеральных классов частичных функций с нетривиальным методом isDefinedAt рекомендуется переопределить applyOrElse с помощью пользовательской реализации, которая избегает двойной оценки isDefinedAt. Это может привести к улучшению производительности и более предсказуемому поведению в отношении побочных эффектов.

x

аргумент функции

default

резервная функция

returns

результат применения этой функции или резервной функции.

Определяющие классы
PartialFunction
С версии

2.10

final def asInstanceOf[T0]: T0

Привести получаемый объект к типу T0.

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

returns

получаемый объект.

Определяющие классы
Any
Выбрасываемые исключения

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

def canEqual(that: Any): Boolean

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

that

Объект, с которым следует сравнивать эту последовательность

returns

true, если эта последовательность может потенциально равняться that, false в противном случае. Тест учитывает только типы объектов во время выполнения, но игнорирует их элементы.

Определяющие классы
Seq → Equals

def className: String

Определяет префикс представления toString этого объекта.

Рекомендуется возвращать имя конкретного типа коллекции, а не подклассы реализации. Например, для ListMap этот метод должен возвращать "ListMap", а не "Map" (супертип) или "Node" (подкласс реализации).

Реализация по умолчанию возвращает "Iterable". Она переопределена для основных типов коллекций "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" и "View".

returns

строковое представление, которое начинает результат применения toString к этой итерируемой коллекции. По умолчанию строковый префикс — это простое имя класса коллекции итерируемой коллекции.

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

def clone(): AnyRef

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

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

returns

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note

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

final def coll: LinearSeq.this.type

returns

Эта коллекция как C.

Attributes
protected
Definition Classes
Iterable → IterableOps

def collect[B](pf: PartialFunction[A, B]): LinearSeq[B]

Создает новую итерируемую коллекцию, применяя частичную функцию ко всем элементам этой итерируемой коллекции, для которых функция определена.

B

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

pf

частичная функция, которая фильтрует и отображает итерируемую коллекцию.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

Находит первый элемент коллекции, для которого определена данная частичная функция, и применяет к нему частичную функцию.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если только базовый тип коллекции не упорядочен.

pf

частичная функция

returns

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

Definition Classes
IterableOnceOps
Example:

    Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

def combinations(n: Int): Iterator[LinearSeq[A]]

Итерирует по комбинациям. _Комбинация_ длины n — это подпоследовательность исходной последовательности, элементы которой берутся по порядку. Таким образом, "xy" и "yy" — это комбинации длины 2 из "xyy", но "yx" — нет. Если существует несколько способов сгенерировать одну и ту же подпоследовательность, будет возвращен только один.

Например, "xyyy" имеет три различных способа генерации "xy" в зависимости от того, выбран ли первый, второй или третий "y". Однако, поскольку все они идентичны, будет выбран только один. Какой из трех будет взят — это деталь реализации, которая не определена.

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

returns

Итератор, который проходит по возможным n-элементным комбинациям этой последовательности.

Definition Classes
SeqOps
Example:

    "abbbc".combinations(2) = Iterator(ab, ac, bb, bc)

def compose[R](k: PartialFunction[R, Int]): PartialFunction[R, A]

Компонует другую частичную функцию k с этой частичной функцией так, чтобы эта частичная функция применялась к результатам k.

Обратите внимание, что вызов isDefinedAt для результирующей частичной функции может применить первую частичную функцию и выполнить ее побочный эффект. Настоятельно рекомендуется вызывать applyOrElse вместо isDefinedAt / apply для повышения эффективности.

R

тип параметра функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения другой частичной функции, суженной этой частичной функцией, которая отображает аргументы x на this(k(x)).

Definition Classes
PartialFunction

def compose[A](g: (A) => Int): (A) => A

Компонует два экземпляра Function1 в новый Function1, причем эта функция применяется последней.

A

тип, к которому может быть применена функция g

g

функция A => T1

returns

новая функция f, такая что f(x) == apply(g(x))

Definition Classes
Function1
Annotations
@unspecialized()

final def concat[B >: A](suffix: IterableOnce[B]): LinearSeq[B]

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

B

тип элементов возвращаемого набора.

suffix

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

returns

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

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

def contains[A1 >: A](elem: A1): Boolean

Проверяет, содержит ли эта последовательность заданное значение в качестве элемента.

Примечание: может не завершиться для коллекций бесконечного размера.

elem

элемент для проверки.

returns

значение true, если в этой последовательности есть элемент, который равен (как определено ==) elem, false в противном случае.

Definition Classes
LinearSeqOps → SeqOps

def containsSlice[B](that: collection.Seq[B]): Boolean

Проверяет, содержит ли эта последовательность заданную последовательность в качестве среза.

Примечание: может не завершиться для коллекций бесконечного размера.

that

проверяемая последовательность

returns

значение true, если эта последовательность содержит срез с теми же элементами, что и that, в противном случае false.

Definition Classes
SeqOps

def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start максимум len элементами этой коллекции.

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

B

тип элементов массива.

xs

массив для заполнения.

start

начальный индекс xs.

len

максимальное количество копируемых элементов.

returns

количество элементов, записанных в массив

Definition Classes
IterableOnceOps
Note

Использование: после вызова этого метода итератор, на котором он был вызван, должен быть отброшен. Его использование неопределенно и может измениться. Примечание: не завершится для коллекций бесконечного размера.

def copyToArray[B >: A](xs: Array[B], start: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями из этой коллекции.

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

B

тип элементов массива.

xs

массив для заполнения.

start

начальный индекс xs.

returns

количество элементов, записанных в массив. Примечание: не завершится для коллекций бесконечного размера.

Definition Classes
IterableOnceOps

def copyToArray[B >: A](xs: Array[B]): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями из этой коллекции.

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

B

тип элементов массива.

xs

массив для заполнения.

returns

количество элементов, записанных в массив. Примечание: не завершится для коллекций бесконечного размера.

Definition Classes
IterableOnceOps

def corresponds[B](that: collection.Seq[B])(p: (A, B) => Boolean): Boolean

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

B

тип элементов that

that

другая последовательность

p

предикат теста, который связывает элементы из обеих последовательностей

returns

true если обе последовательности имеют одинаковую длину и p(x, y) является true для всех соответствующих элементов x этой последовательности и y другой последовательности, иначе false.

Definition Classes
SeqOps

def corresponds[B](that: IterableOnce[B])(p: (A, B) => Boolean): Boolean

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

B

тип элементов that

that

другая коллекция

p

предикат теста, который связывает элементы из обеих коллекций

returns

true если обе коллекции имеют одинаковую длину и p(x, y) является true для всех соответствующих элементов x этого итератора и y другой коллекции, иначе false

Definition Classes
IterableOnceOps

def count(p: (A) => Boolean): Int

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

p

предикат, используемый для проверки элементов.

returns

количество элементов, удовлетворяющих предикату p.

Definition Classes
IterableOnceOps

def diff[B >: A](that: collection.Seq[B]): LinearSeq[A]

Вычисляет разность мультимножеств между этой последовательностью и другой последовательностью.

that

последовательность элементов для удаления

returns

новая последовательность, содержащая все элементы этой последовательности, за исключением некоторых вхождений элементов, которые также появляются в that. Если значение элемента x появляется n раз в that, то первые n вхождений x не будут частью результата, но любые последующие вхождения будут.

Definition Classes
SeqOps

def distinct: LinearSeq[A]

Выбирает все элементы этой последовательности, игнорируя дубликаты.

returns

новая последовательность, состоящая из всех элементов этой последовательности без дубликатов.

Definition Classes
SeqOps

def distinctBy[B](f: (A) => B): LinearSeq[A]

Выбирает все элементы этой последовательности, игнорируя дубликаты, как определено == после применения преобразовательной функции f.

B

тип элементов после преобразования f

f

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

returns

новая последовательность, состоящая из всех элементов этой последовательности без дубликатов.

Definition Classes
SeqOps

def drop(n: Int): LinearSeq[A]

Выбирает все элементы, кроме первых n.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

n

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

returns

итерабельная коллекция, состоящая из всех элементов этой итерабельной коллекции, кроме первых n элементов, или же пустая итерабельная коллекция, если у этой итерабельной коллекции меньше чем n элементов. Если n отрицательное, не удалять никаких элементов.

Definition Classes
IterableOps → IterableOnceOps
Note

Переиспользование: после вызова этого метода необходимо отбросить итератор, на котором он был вызван, и использовать только тот итератор, который был возвращен. Использование старого итератора неопределено, может измениться и может привести к изменениям в новом итераторе.

def dropRight(n: Int): LinearSeq[A]

Выбирает все элементы, кроме последних n.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

n

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

returns

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

Definition Classes
IterableOps

def dropWhile(p: (A) => Boolean): LinearSeq[A]

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

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен.

p

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

returns

самый длинный суффикс этого итерируемого набора, первый элемент которого не удовлетворяет предикату p.

Definition Classes
IterableOps → IterableOnceOps
Note

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

def elementWise: ElementWiseExtractor[Int, A]

Возвращает объект-экстрактор с методом unapplySeq, который извлекает каждый элемент данных последовательности.

Definition Classes
PartialFunction
Пример:
    val firstChar: String => Option[Char] = _.headOption
    
    Seq("foo", "bar", "baz") match {
      case firstChar.unlift.elementWise(c0, c1, c2) =>
        println(s"$c0, $c1, $c2") // Output: f, b, b
    }

def empty: LinearSeq[A]

Пустой итерируемый набор того же типа, что и этот итерируемый набор

returns

пустой итерируемый набор типа C.

Definition Classes
IterableFactoryDefaults → IterableOps

def endsWith[B >: A](that: collection.Iterable[B]): Boolean

Проверяет, заканчивается ли эта последовательность данной последовательностью.

Примечание: не завершит работу для коллекций бесконечного размера.

that

тестируемая последовательность

returns

true если эта последовательность имеет that в качестве суффикса, false в противном случае.

Definition Classes
SeqOps

def ensuring(cond: (LinearSeq[A]) => Boolean, msg: => Any): LinearSeq[A]

Implicit
Этот член добавлен неявным преобразованием из LinearSeq[A] в Ensuring[LinearSeq[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (LinearSeq[A]) => Boolean): LinearSeq[A]

Implicit
Этот член добавлен неявным преобразованием из LinearSeq[A] в Ensuring[LinearSeq[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): LinearSeq[A]

Implicit
Этот член добавлен неявным преобразованием из LinearSeq[A] в Ensuring[LinearSeq[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): LinearSeq[A]

Неявный
Этот член добавлен неявным преобразованием из LinearSeq[A] в Ensuring[LinearSeq[A]] с помощью метода 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(o: Any): Boolean

Универсальный метод равенства, определённый в AnyRef.

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

def exists(p: (A) => Boolean): Boolean

Проверяет, выполняется ли предикат хотя бы для одного элемента этой последовательности.

Примечание: может не завершиться для бесконечных коллекций.

p

предикат, используемый для проверки элементов.

возвращает

true если заданный предикат p удовлетворяется по крайней мере одним элементом этой последовательности, в противном случае false

Классы определений
LinearSeqOps → IterableOnceOps

def filter(pred: (A) => Boolean): LinearSeq[A]

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

возвращает

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

Классы определений
IterableOps → IterableOnceOps

def filterNot(pred: (A) => Boolean): LinearSeq[A]

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

pred

предикат, используемый для проверки элементов.

возвращает

новую итерируемую коллекцию, состоящую из всех элементов этой итерируемой коллекции, которые не удовлетворяют заданному предикату pred. Порядок элементов может быть не сохранён.

Классы определений
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

def find(p: (A) => Boolean): Option[A]

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

Примечание: может не завершиться для бесконечных коллекций.

p

предикат, используемый для проверки элементов.

возвращает

значение Option, содержащее первый элемент в последовательности, удовлетворяющий p, или None если такой не существует.

Классы определений
LinearSeqOps → IterableOnceOps

def findLast(p: (A) => Boolean): Option[A]

Находит последний элемент в последовательности, удовлетворяющий предикату, если таковой есть.

Примечание: не будет завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

значение типа Option, содержащее последний элемент в последовательности, удовлетворяющий p, или None если такового не существует.

Definition Classes
LinearSeqOps → SeqOps

def flatMap[B](f: (A) => IterableOnce[B]): LinearSeq[B]

Создает новую итерируемую коллекцию, применяя функцию ко всем элементам этой итерируемой коллекции и используя элементы полученных коллекций.

Например:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

Тип результирующей коллекции определяется статическим типом итерируемой коллекции. Это может иногда приводить к неожиданным результатам. Например:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
B

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

f

функция, применяемая к каждому элементу.

returns

новая итерируемая коллекция, полученная в результате применения данной функции, принимающей коллекцию f к каждому элементу этой итерируемой коллекции и конкатенации результатов.

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

def flatten[B](implicit asIterable: (A) => IterableOnce[B]): LinearSeq[B]

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

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

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

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

asIterable

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

Выполняет свертку элементов этой коллекции с помощью указанного ассоциативного бинарного оператора. Реализация по умолчанию в IterableOnce эквивалентна foldLeft, но может быть переопределена для более эффективного порядка обхода.

Порядок выполнения операций над элементами не определен и может быть недетерминированным.

Примечание: не будет завершаться для коллекций бесконечного размера.

A1

параметр типа для бинарного оператора, супертип A.

z

нейтральный элемент для операции свертки; может быть добавлен к результату произвольное количество раз и не должен изменять результат (например, Nil для конкатенации списков, 0 для сложения или 1 для умножения).

op

бинарный оператор, который должен быть ассоциативным.

returns

результат применения оператора свертки op между всеми элементами и z, или z если эта коллекция пуста.

Definition Classes
IterableOnceOps

def foldLeft[B](z: B)(op: (B, A) => B): B

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

Примечание: не будет завершаться для коллекций бесконечного размера.

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой последовательности слева направо с начальным значением z слева:

op(...op(z, x_1), x_2, ..., x_n)

где x1, ..., xn - элементы этой последовательности. Возвращает z если эта последовательность пуста.

Definition Classes
LinearSeqOps → IterableOnceOps

def foldRight[B](z: B)(op: (A, B) => B): B

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

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен, или оператор не является ассоциативным и коммутативным.

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой коллекции, двигаясь справа налево с начальным значением z справа:

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn - элементы этой коллекции. Возвращает z если эта коллекция пуста.

Definition Classes
IterableOnceOps

def forall(p: (A) => Boolean): Boolean

Проверяет, выполняется ли предикат для всех элементов этой последовательности.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

true если эта последовательность пуста или заданный предикат p выполняется для всех элементов этой последовательности, в противном случае false.

Definition Classes
LinearSeqOps → IterableOnceOps

def foreach[U](f: (A) => U): Unit

Применяет f к каждому элементу для его побочных эффектов. Примечание: параметр [U] необходим для помощи в выводе типов scalac.

Definition Classes
LinearSeqOps → IterableOnceOps

def formatted(fmtstr: String): String

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

Implicit
Этот член добавляется неявным преобразованием из LinearSeq[A] вStringFormat[LinearSeq[A]] с помощью метода StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def fromSpecific(coll: IterableOnce[A]): LinearSeq[A]

Определяет, как преобразовать заданную Iterable[A] в коллекцию типа C.

Этот процесс может быть выполнен строгим или нестрогим способом (т. е. без вычисления элементов результирующих коллекций). Другими словами, этот метод определяет модель вычисления коллекции.

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод должен быть переопределен (в противном случае компилятор выдаст ошибку). В общем случае, когда C =:= CC[A], это можно сделать, добавив трейт IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

,

Как свидетельствует аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, пока он вызывается с Iterable[A], полученной из this коллекции (как это происходит в реализациях операций, где мы используем View[A]), он безопасен.

final def getClass(): Class[_ <: AnyRef]

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def groupBy[K](f: (A) => K): Map[K, LinearSeq[A]]

Разбивает эту итерируемую коллекцию на карту итерируемых коллекций в соответствии с некоторой функцией-дискриминатором.

Примечание: даже при применении к представлению или ленивой коллекции она всегда будет принудительно применять элементы.

K

тип ключей, возвращаемых функцией-дискриминатором.

f

функция-дискриминатор.

returns

Карта из ключей к итерируемым коллекциям, для которой выполняется следующее инвариантное свойство:

(xs groupBy f)(k) = xs filter (x => f(x) == k)

То есть каждый ключ k связан с итерируемой коллекцией тех элементов x, для которых f(x) равно k.

Definition Classes
IterableOps

def groupMap[K, B](key: (A) => K)(f: (A) => B): Map[K, LinearSeq[B]]

Разделяет этот итерируемый набор на карту итерируемых наборов в соответствии с функцией-дискриминатором key. Каждый элемент в группе преобразуется в значение типа B с помощью функции value.

Это эквивалентно groupBy(key).mapValues(_.map(f)), но более эффективно.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

Примечание: даже при применении к представлению или ленивому набору элементы всегда будут принудительно вычисляться.

K

тип ключей, возвращаемых функцией-дискриминатором

B

тип значений, возвращаемых функцией преобразования

key

функция-дискриминатор

f

функция преобразования элементов

Definition Classes
IterableOps

def groupMapReduce[K, B](key: (A) => K)(f: (A) => B)(reduce: (B, B) => B): Map[K, B]

Разделяет этот итерируемый набор на карту в соответствии с функцией-дискриминатором key. Все значения с одинаковым дискриминатором затем преобразуются функцией value и затем сводятся к одному значению с помощью функции reduce.

Это эквивалентно groupBy(key).mapValues(_.map(f).reduce(reduce)), но более эффективно.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

Примечание: даже при применении к представлению или ленивому набору элементы всегда будут принудительно вычисляться.

Definition Classes
IterableOps

def grouped(size: Int): Iterator[LinearSeq[A]]

Разделяет элементы на итерируемые наборы фиксированного размера.

size

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

returns

Итератор, генерирующий итерируемые наборы размера size, за исключением последнего, который будет меньше размера size, если элементы не делятся на него без остатка.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод grouped

def hashCode(): Int

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

returns

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

Definition Classes
Seq → AnyRef → Any

def head: A

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

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не является упорядоченным.

returns

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

Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException, если итерируемый набор пуст.

def headOption: Option[A]

Возвращает первый элемент, если он существует.

returns

первый элемент последовательности, если она непустая, None если она пустая.

Definition Classes
LinearSeqOps → IterableOps

def indexOf[B >: A](elem: B): Int

Находит индекс первого вхождения значения в этой последовательности.

B

тип элемента elem.

elem

значение элемента для поиска.

returns

индекс >= 0 первого элемента этой последовательности, который равен (как определяется ==) elem, или -1, если такого элемента нет.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override indexOf(elem, from) instead - indexOf(elem) calls indexOf(elem, 0)", "2.13.0")

def indexOf[B >: A](elem: B, from: Int): Int

Находит индекс первого вхождения значения в этой последовательности после или в определенном индексе начала.

B

тип элемента elem.

elem

значение элемента для поиска.

from

индекс начала

returns

индекс >= from первого элемента этой последовательности, который равен (как определяется ==) elem, или -1, если такого элемента нет.

Definition Classes
SeqOps

def indexOfSlice[B >: A](that: collection.Seq[B]): Int

Находит первый индекс, где данная последовательность содержит заданную последовательность как срез.

Примечание: может не завершиться для коллекций бесконечного размера.

that

последовательность для проверки

returns

первый индекс >= 0 такой, что элементы этой последовательности, начинающиеся с этого индекса, совпадают с элементами последовательности that, или -1 если такой подпоследовательности не существует.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override indexOfSlice(that, from) instead - indexOfSlice(that) calls indexOfSlice(that, 0)", "2.13.0")

def indexOfSlice[B >: A](that: collection.Seq[B], from: Int): Int

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

Примечание: может не завершиться для коллекций бесконечного размера.

that

последовательность для проверки

from

начальный индекс

returns

первый индекс >= from такой, что элементы этой последовательности, начинающиеся с этого индекса, совпадают с элементами последовательности that, или -1 если такой подпоследовательности не существует.

Definition Classes
SeqOps

def indexWhere(p: (A) => Boolean, from: Int): Int

Находит индекс первого элемента, удовлетворяющего некоторому предикату после или на определенном начальном индексе.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

from

начальный индекс

returns

индекс >= from первого элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Definition Classes
LinearSeqOps → SeqOps

def indexWhere(p: (A) => Boolean): Int

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

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

индекс >= 0 первого элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override indexWhere(p, from) instead - indexWhere(p) calls indexWhere(p, 0)", "2.13.0")

def indices: Range

Создает диапазон всех индексов этой последовательности.

Примечание: даже при применении к представлению или ленивой коллекции она всегда заставляет элементы.

returns

значение Range от 0 до значения, на единицу меньшего, чем длина этой последовательности.

Definition Classes
SeqOps

def init: LinearSeq[A]

Начальная часть коллекции без последнего элемента.

Примечание: даже при применении к представлению или ленивой коллекции она всегда заставляет элементы.

Definition Classes
IterableOps

def inits: Iterator[LinearSeq[A]]

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

Примечание: даже при применении к представлению или ленивой коллекции она всегда заставляет элементы.

returns

итератор по всем начальным частям этой коллекции

Definition Classes
IterableOps
Пример:

    List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

def intersect[B >: A](that: collection.Seq[B]): LinearSeq[A]

Вычисляет пересечение мультимножеств между этой последовательностью и другой последовательностью.

that

последовательность элементов для пересечения.

returns

новая последовательность, которая содержит все элементы этой последовательности, которые также появляются в that. Если значение элемента x появляется n раз в that, то первые n вхождений x будут сохранены в результате, но любые последующие вхождения будут пропущены.

Definition Classes
SeqOps

def isDefinedAt(x: Int): Boolean

Проверяет, содержит ли эта последовательность заданный индекс.

Реализации методов apply и isDefinedAt преобразуют Seq[A] в PartialFunction[Int, A].

возвращает

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

Определяющие классы
LinearSeqOps → SeqOps

def isEmpty: Boolean

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

Примечание: Реализации в подклассах, которые не являются многократно проходимыми, должны следить за тем, чтобы не потреблять никаких элементов, когда isEmpty вызывается.

возвращает

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

Определяющие классы
SeqOps → IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

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

def isTraversableAgain: Boolean

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps

def iterableFactory: SeqFactory[LinearSeq]

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

Определяющие классы
LinearSeq → LinearSeq → Seq → Seq → Iterable → Iterable → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении CC до нового типа, этот метод необходимо переопределить, чтобы вернуть фабрику для нового типа (в противном случае компилятор выдаст ошибку).

def iterator: Iterator[A]

Итератор может быть использован только один раз

Определяющие классы
LinearSeqOps → IterableOnce

def knownSize: Int

возвращает

Количество элементов в этом наборе, если его можно вычислить недорого, -1 в противном случае. Недорого обычно означает: Не требует прохода по коллекции.

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

def last: A

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

возвращает

Последний элемент этой последовательности.

Определяющие классы
LinearSeqOps → IterableOps
Исключения

NoSuchElementException Если последовательность пуста.

def lastIndexOf[B >: A](elem: B, end: Int = length - 1): Int

Находит индекс последнего вхождения некоторого значения в этой последовательности до или на заданном конечном индексе.

Примечание: не будет завершаться для коллекций бесконечного размера.

B

тип элемента elem.

elem

значение искомого элемента.

end

конечный индекс.

возвращает

индекс <= end последнего элемента этой последовательности, который равен (как определено ==) элементу elem, или -1, если такого элемента нет.

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

def lastIndexOfSlice[B >: A](that: collection.Seq[B]): Int

Находит последний индекс, где эта последовательность содержит заданную последовательность в качестве подпоследовательности.

Примечание: не будет завершаться для коллекций бесконечного размера.

that

последовательность для проверки

returns

последний индекс такой, что элементы этой последовательности, начиная с этого индекса, совпадают с элементами последовательности that, или -1 если такой подпоследовательности не существует.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override lastIndexOfSlice(that, end) вместо этого - lastIndexOfSlice(that) вызывает lastIndexOfSlice(that, Int.MaxValue)", "2.13.0")

def lastIndexOfSlice[B >: A](that: collection.Seq[B], end: Int): Int

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

Примечание: не будет завершаться для коллекций бесконечного размера.

that

последовательность для проверки

end

индекс окончания

returns

последний индекс <= end такой, что элементы этой последовательности, начиная с этого индекса, совпадают с элементами последовательности that, или -1 если такой подпоследовательности не существует.

Definition Classes
SeqOps

def lastIndexWhere(p: (A) => Boolean, end: Int): Int

Находит индекс последнего элемента, удовлетворяющего некоторому предикату до или на заданном индексе окончания.

Примечание: не будет завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

индекс <= end последнего элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Definition Classes
LinearSeqOps → SeqOps

def lastIndexWhere(p: (A) => Boolean): Int

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

Примечание: не будет завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

индекс последнего элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override lastIndexWhere(p, end) вместо этого - lastIndexWhere(p) вызывает lastIndexWhere(p, Int.MaxValue)", "2.13.0")

def lastOption: Option[A]

Возвращает опционально последний элемент.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

последний элемент этой итерируемой коллекции, если она непустая, None если она пустая.

Definition Classes
IterableOps

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[A, B, LinearSeq.this.type]

Аналогично zip за исключением того, что элементы в каждой коллекции не потребляются до тех пор, пока строгая операция не вызывается на возвращаемом LazyZip2 декораторе.

Вызовы lazyZip могут быть объединены для поддержки более высоких арностей (до 4) без затрат на построение и деконструкцию промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
B

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

that

итерируемый объект, обеспечивающий второй элемент каждой возможной пары

returns

декоратор LazyZip2 , который позволяет выполнять строгие операции с лениво вычисляемыми парами или цепочками вызовов lazyZip. Поддерживается также неявное преобразование в Iterable[(A, B)].

Definition Classes
Iterable

def length: Int

Длина (количество элементов) последовательности. size является псевдонимом length в Seq коллекциях.

Definition Classes
LinearSeqOps → SeqOps

def lengthCompare(that: collection.Iterable[_]): Int

Сравнивает длину этой последовательности с размером другой Iterable.

that

объект Iterable, размер которого сравнивается с длиной этой последовательности.

returns

Значение x, где

x <  0       if this.length <  that.size
x == 0       if this.length == that.size
x >  0       if this.length >  that.size

Метод, как реализован здесь, не вызывает length или size напрямую; его время выполнения составляет O(this.length min that.size) вместо O(this.length + that.size). Метод должен быть переопределен, если вычисление size является недорогим, а knownSize возвращает -1.

Definition Classes
LinearSeqOps → SeqOps

def lengthCompare(len: Int): Int

Сравнивает длину этой последовательности со значением-тестом.

len

значение-тест, которое сравнивается с длиной.

returns

Значение x где

x <  0       if this.length <  len
x == 0       if this.length == len
x >  0       if this.length >  len

Реализация этого метода не вызывает length напрямую; его время выполнения составляет O(length min len) вместо O(length). Метод следует переопределять, если вычисление length является быстрым, и knownSize возвращает -1.

Definition Classes
LinearSeqOps → SeqOps
См. также

lengthIs

final def lengthIs: SizeCompareOps

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

Эти операции реализованы с помощью lengthCompare(Int) и позволяют использовать более удобочитаемые выражения:

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0
Definition Classes
SeqOps
Аннотации
@inline()

def lift: (Int) => Option[A]

Преобразует эту частичную функцию в обычную функцию, возвращающую результат Option.

returns

функция, которая принимает аргумент x к Some(this(x)), если this определено для x, и к None в противном случае.

Definition Classes
PartialFunction
См. также

Function.unlift

def map[B](f: (A) => B): LinearSeq[B]

Создаёт новую итерируемую коллекцию, применяя функцию ко всем элементам этой итерируемой коллекции.

B

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

f

функция, которую нужно применить к каждому элементу.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

def max[B >: A](implicit ord: math.Ordering[B]): A

Находит наибольший элемент.

B

Тип, для которого определено упорядочение.

ord

Упорядочение, которое используется для сравнения элементов.

returns

наибольший элемент этой коллекции относительно упорядочения ord.

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

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

def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A

Находит первый элемент, который даёт наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Упорядочение, которое используется для сравнения элементов.

returns

первый элемент этой коллекции с наибольшим значением, измеренным функцией f относительно упорядочения cmp.

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

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

def maxByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]

Находит первый элемент, который даёт наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Упорядочение, которое используется для сравнения элементов.

returns

опциональный результат, содержащий первый элемент этой коллекции с наибольшим значением, измеренным функцией f относительно упорядочения cmp.

Definition Classes
IterableOnceOps

def maxOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

Находит наибольший элемент.

B

Тип, по которому определяется порядок.

ord

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

returns

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

Definition Classes
IterableOnceOps

def min[B >: A](implicit ord: math.Ordering[B]): A

Находит наименьший элемент.

B

Тип, по которому определяется порядок.

ord

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

returns

наименьший элемент этого набора по заданному порядку ord.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException, если этот набор пуст.

def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A

Находит первый элемент, который дает наименьшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

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

returns

первый элемент этого набора с наименьшим значением, измеренным функцией f по заданному порядку cmp.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException, если этот набор пуст.

def minByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]

Находит первый элемент, который дает наименьшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

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

returns

значение типа Option, содержащее первый элемент этого набора с наименьшим значением, измеренным функцией f по заданному порядку cmp.

Definition Classes
IterableOnceOps

def minOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

Находит наименьший элемент.

B

Тип, по которому определяется порядок.

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

Отображает все элементы этого набора в строке.

Делегирует addString, который можно переопределить.

returns

строковое представление этого набора. В результирующей строке строковые представления (с помощью метода toString) всех элементов этого набора следуют друг за другом без разделителя.

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

Отображает все элементы этого набора в строке с использованием разделителя.

Делегирует addString, который можно переопределить.

sep

разделитель.

returns

строковое представление этого набора. В результирующей строке строковые представления (с помощью метода toString) всех элементов этого набора разделены строкой sep.

Definition Classes
IterableOnceOps
Annotations
@inline()
Пример:

    List(1, 2, 3).mkString("|") = "1|2|3"

final def mkString(start: String, sep: String, end: String): String

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

Делегирует вызов addString, который может быть переопределён.

start

начальная строка.

sep

разделительная строка.

end

конечная строка.

returns

строковое представление этой коллекции. Результирующая строка начинается со строки start и заканчивается строкой end. Внутри, строковые представления (относительно метода toString) всех элементов этой коллекции разделяются строкой sep.

Definition Classes
IterableOnceOps
Пример:

    List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def newSpecificBuilder: Builder[A, LinearSeq[A]]

returns

строгий билдер для того же типа коллекции. Обратите внимание, что в случае ленивых коллекций (например, View или immutable.LazyList), реализовать этот метод возможно, но полученный Builder нарушит ленивость. Следовательно, операции предпочтительно реализовывать с помощью fromSpecific вместо этого метода.

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (иначе компилятор выдаст ошибку). В общем случае, где C =:= CC[A], это можно сделать путём смешивания в трайте IterableFactoryDefaults, который реализует метод с помощью iterableFactory.

,

Как показывает аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, пока возвращаемый билдер получает только A значения, взятые из this экземпляра, это безопасно.

def nonEmpty: Boolean

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Примечание

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Примечание

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

def occCounts[B](sq: collection.Seq[B]): mutable.Map[B, Int]

Attributes
protected[scala.collection]
Definition Classes
SeqOps

def orElse[A1 <: Int, B1 >: A](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Компонует эту частичную функцию с резервной частичной функцией, которая применяется в тех случаях, когда эта частичная функция не определена.

A1

тип аргумента резервной функции

B1

тип результата резервной функции

that

резервная функция

returns

частичная функция, имеющая в качестве области определения объединение областей определения этой частичной функции и that. Результирующая частичная функция принимает x к this(x), где this определена, и к that(x) в противном случае.

Definition Classes
PartialFunction

def padTo[B >: A](len: Int, elem: B): LinearSeq[B]

Копия этой последовательности с добавленным значением элемента до достижения заданной целевой длины.

B

тип элемента возвращаемой последовательности.

len

целевая длина

elem

значение заполнения

returns

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

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

def partition(p: (A) => Boolean): (LinearSeq[A], LinearSeq[A])

Пара, состоящая, во-первых, из всех элементов, удовлетворяющих предикату p, и, во-вторых, из всех элементов, которые не удовлетворяют.

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

Предоставленная здесь реализация по умолчанию должна дважды проходить по коллекции. Строгие коллекции имеют переопределенную версию partition в StrictOptimizedIterableOps, которая требует только одного прохода.

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

def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (LinearSeq[A1], LinearSeq[A2])

Применяет функцию f к каждому элементу итерируемой коллекции и возвращает пару итерируемых коллекций: первая состоит из тех значений, возвращаемых f, которые были заключены в scala.util.Left, а вторая — из тех, которые были заключены в scala.util.Right.

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

тип элемента первой результирующей коллекции

A2

тип элемента второй результирующей коллекции

f

'функция разделения', отображающая элементы этой итерируемой коллекции на scala.util.Either

returns

пара итерируемых коллекций: первая состоит из тех значений, возвращаемых f, которые были заключены в scala.util.Left, а вторая — из тех, которые были заключены в scala.util.Right.

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

def patch[B >: A](from: Int, other: IterableOnce[B], replaced: Int): LinearSeq[B]

Создает новую последовательность, в которой фрагмент элементов в этой последовательности заменен другой последовательностью.

Замена с отрицательными индексами эквивалентна замене, начинающейся с 0. Замена с индексами, равными или большими длины исходной последовательности, добавляет замену в конец. Если заменяется больше значений, чем существует на самом деле, избыток игнорируется.

B

тип элемента возвращаемой последовательности.

from

индекс первого заменяемого элемента

other

заменяющая последовательность

replaced

количество элементов для удаления в исходной последовательности

returns

новая последовательность, состоящая из всех элементов этой последовательности, за исключением того, что replaced элементов, начиная с from, заменяются всеми элементами other.

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

def permutations: Iterator[LinearSeq[A]]

Итерирует по различным перестановкам.

Примечание: Даже при применении к представлению или ленивой коллекции он всегда будет принудительно вычислять элементы.

returns

Итератор, который проходит по различным перестановкам этой последовательности.

Определяющие классы
SeqOps
Пример:

    "abb".permutations = Iterator(abb, bab, bba)

def prepended[B >: A](elem: B): LinearSeq[B]

Копия последовательности с добавленным в начало элементом.

Кроме того, исходная последовательность не изменяется, поэтому вам потребуется сохранить результат.

Пример:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)
B

тип элемента возвращаемой последовательности.

elem

добавляемый в начало элемент

returns

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

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

def prependedAll[B >: A](prefix: IterableOnce[B]): LinearSeq[B]

Как и :++, возвращает новую коллекцию, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда.

Она отличается от :++ тем, что правый операнд определяет тип результирующей коллекции, а не левый. Мемоника: двоеточие стоит со стороны типа новой коллекции.

B

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

prefix

итерируемый объект для добавления в начало.

returns

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

Definition Classes
SeqOps

def product[B >: A](implicit num: math.Numeric[B]): B

Перемножает элементы этой коллекции.

B

тип результата оператора *.

num

явный параметр, определяющий набор арифметических операций, включая оператор *, используемый для вычисления произведения.

returns

произведение всех элементов этой коллекции относительно оператора * в num.

Definition Classes
IterableOnceOps

def reduce[B >: A](op: (B, B) => B): B

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

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

B

Параметр типа для бинарного оператора, являющийся надтипом A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Результат применения оператора reduce op между всеми элементами, если коллекция не пуста.

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

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

def reduceLeft[B >: A](op: (B, A) => B): B

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

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой коллекции слева направо:

op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

где x1, ..., xn - элементы этой коллекции.

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

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

def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

При необходимости применяет бинарный оператор ко всем элементам этой коллекции слева направо.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение Option, содержащее результат reduceLeft(op), если эта коллекция не пуста, None в противном случае.

Definition Classes
IterableOnceOps

def reduceOption[B >: A](op: (B, B) => B): Option[B]

Применяет заданный ассоциативный бинарный оператор к элементам этой коллекции, если они есть.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

B

Параметр типа для бинарного оператора, являющийся надтипом A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Значение типа Option, содержащее результат применения оператора reduce op между всеми элементами, если коллекция не пуста, и None в противном случае.

Definition Classes
IterableOnceOps

def reduceRight[B >: A](op: (A, B) => B): B

Применяет бинарный оператор ко всем элементам этого набора, слева направо.

Примечание: не завершится для наборов бесконечной длины.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не ассоциативен и не коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этого набора, справа налево:

op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

где x1, ..., xn — элементы этого набора.

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

UnsupportedOperationException, если этот набор пуст.

def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

Факультативно применяет бинарный оператор ко всем элементам этого набора, справа налево.

Примечание: не завершится для наборов бесконечной длины.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора упорядочен или оператор ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение типа Option, содержащее результат reduceRight(op) , если этот набор непустой, None в противном случае.

Definition Classes
IterableOnceOps

def reverse: LinearSeq[A]

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

Примечание: не завершится для наборов бесконечной длины.

Примечание: даже при применении к представлению или ленивому набору элементы всегда будут вычислены.

returns

Новый набор со всеми элементами этого набора в обратном порядке.

Definition Classes
SeqOps

def reverseIterator: Iterator[A]

Итератор, возвращающий элементы в обратном порядке.

Примечание: не завершится для наборов бесконечной длины.

Примечание: xs.reverseIterator то же самое, что и xs.reverse.iterator, но может быть более эффективным.

returns

итератор, возвращающий элементы этого набора в обратном порядке

Definition Classes
SeqOps

def reversed: collection.Iterable[A]

Атрибуты
protected
Definition Classes
IterableOnceOps

def runWith[U](action: (A) => U): (Int) => Boolean

Компонует эту частичную функцию с функцией действия, которая применяется к результатам этой частичной функции. Функция действия вызывается только для своих побочных эффектов; её результат игнорируется.

Обратите внимание, что выражение pf.runWith(action)(x) эквивалентно

if(pf isDefinedAt x) { action(pf(x)); true } else false

за исключением того, что runWith реализовано с помощью applyOrElse и, следовательно, потенциально более эффективно. Использование runWith предотвращает двойное вычисление шаблонов соответствия и условий для частичных функций-литералов.

action

функция действия

returns

функция, которая отображает аргументы x в isDefinedAt(x). Результирующая функция выполняет action(this(x)), где this определена.

Definition Classes
PartialFunction
Since

2.10

См. также

applyOrElse.

def sameElements[B >: A](that: IterableOnce[B]): Boolean

Являются ли элементы этого набора такими же (и в том же порядке), что и элементы that?

Definition Classes
LinearSeqOps → SeqOps

def scan[B >: A](z: B)(op: (B, B) => B): LinearSeq[B]

Вычисляет префиксное сканирование элементов набора.

Примечание: нейтральный элемент z может применяться более одного раза.

B

тип элементов результирующего набора

z

нейтральный элемент для оператора op

op

ассоциативный оператор для сканирования

returns

новый итерируемый набор, содержащий префиксное сканирование элементов в этом итерируемом наборе

Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, A) => B): LinearSeq[B]

Производит итерируемую коллекцию, содержащую кумулятивные результаты применения оператора слева направо, включая начальное значение.

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

B

тип элементов в результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

returns

коллекция с промежуточными результатами

Definition Classes
IterableOps → IterableOnceOps
Note

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

def scanRight[B](z: B)(op: (A, B) => B): LinearSeq[B]

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

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
B

тип элементов в результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

returns

коллекция с промежуточными результатами

Definition Classes
IterableOps

def search[B >: A](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult

Поиск в заданном интервале в этом отсортированном последовательности для конкретного элемента. Если эта последовательность является IndexedSeq, используется двоичный поиск. В противном случае используется линейный поиск.

Последовательность должна быть отсортирована с тем же Ordering перед вызовом; в противном случае результаты не определены.

elem

элемент, который нужно найти.

from

индекс, с которого начинается поиск.

to

индекс, следующий за тем, где поиск заканчивается.

ord

упорядочение, используемое для сравнения элементов.

returns

значение Found, содержащее индекс, соответствующий элементу в последовательности, или InsertionPoint, где элемент был бы вставлен, если элемент отсутствует в последовательности.

Definition Classes
SeqOps
Note

если to <= from, пространство поиска пусто, и возвращается InsertionPoint в from

See also

scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, метод sorted

def search[B >: A](elem: B)(implicit ord: Ordering[B]): SearchResult

Ищет этот отсортированный последовательность для определённого элемента. Если последовательность является IndexedSeq, используется двоичный поиск. В противном случае используется линейный поиск.

Последовательность должна быть отсортирована с тем же Ordering перед вызовом; в противном случае результаты не определены.

elem

элемент, который нужно найти.

ord

упорядочение, используемое для сравнения элементов.

returns

значение Found, содержащее индекс, соответствующий элементу в последовательности, или InsertionPoint, где элемент был бы вставлен, если элемент отсутствует в последовательности.

Definition Classes
SeqOps
See also

scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, метод sorted

def segmentLength(p: (A) => Boolean, from: Int): Int

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

Примечание: может не завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

from

индекс, с которого начинается поиск.

returns

длина самой длинной части этой последовательности, начинающейся с индекса from, такая что каждый элемент части удовлетворяет предикату p

Definition Classes
LinearSeqOps → SeqOps

final def segmentLength(p: (A) => Boolean): Int

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

Примечание: может не завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

длина самой длинной части этой последовательности, такая что каждый элемент части удовлетворяет предикату p

Definition Classes
SeqOps

final def size: Int

Размер этой последовательности.

Примечание: не завершится для коллекций бесконечного размера.

returns

количество элементов в этой последовательности.

Definition Classes
SeqOps → IterableOnceOps

final def sizeCompare(that: collection.Iterable[_]): Int

Сравнивает размер этой последовательности с размером другой Iterable.

that

the Iterable размер которой сравнивается с размером этой последовательности.

returns

Значение x где

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

Метод, реализованный здесь, не вызывает size напрямую; его время выполнения составляет O(this.size min that.size) вместо O(this.size + that.size). Метод следует переопределить, если вычисление size является быстрым, и knownSize возвращает -1.

Definition Classes
SeqOps → IterableOps

final def sizeCompare(otherSize: Int): Int

Сравнивает размер этой последовательности со значением-тестом.

otherSize

тестовое значение, которое сравнивается с размером.

returns

Значение x где

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

Метод, реализованный здесь, не вызывает size напрямую; его время выполнения составляет O(size min otherSize) вместо O(size). Метод следует переопределить, если вычисление size является быстрым, и knownSize возвращает -1.

Definition Classes
SeqOps → IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

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

Эти операции реализуются с помощью sizeCompare(Int) и позволяют использовать следующие более читаемые способы:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Definition Classes
IterableOps
Annotations
@inline()

def slice(from: Int, until: Int): LinearSeq[A]

Выбирает интервал элементов. Возвращаемая итерируемая коллекция состоит из всех элементов x , которые удовлетворяют инварианту:

from <= indexOf(x) < until

Примечание: может возвращать разные результаты для разных запусков, если только тип коллекции, лежащей в основе, не упорядочен.

from

наименьший индекс для включения из этой итерируемой коллекции.

until

наименьший индекс, ИСКЛЮЧАЕМЫЙ из этой итерируемой коллекции.

returns

итерируемая коллекция, содержащая элементы, большие или равные индексу from , расширяющаяся до (но не включая) индекс until этой итерируемой коллекции.

Definition Classes
IterableOps → IterableOnceOps
Note

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

def sliding(size: Int, step: Int): Iterator[LinearSeq[A]]

Группирует элементы в блоки фиксированного размера, пропуская "скользящее окно" по ним (в отличие от разделения их на части, как в grouped.)

size

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

step

расстояние между первыми элементами последовательных групп

returns

Итератор, генерирующий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечён, если остаётся меньше size элементов, которые должны быть сгруппированы.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод sliding

def sliding(size: Int): Iterator[LinearSeq[A]]

Группирует элементы в блоки фиксированного размера, пропуская "скользящее окно" по ним (в отличие от разделения их на части, как в grouped.) Шаг "скользящего окна" установлен в единицу.

size

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

returns

Итератор, генерирующий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечён, если остаётся меньше size элементов, которые должны быть сгруппированы.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод sliding

def sortBy[B](f: (A) => B)(implicit ord: Ordering[B]): LinearSeq[A]

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

Примечание: не завершится для коллекций бесконечного размера.

Примечание: Даже при применении к представлению или ленивой коллекции она всегда будет принудительно задействовать элементы.

Сортировка стабильна. То есть, элементы, которые равны (как определяется ord.compare), появляются в отсортированной последовательности в том же порядке, что и в исходной.

B

целевой тип преобразования f, и тип, где определено упорядочение ord.

f

функция преобразования, отображающая элементы в какую-либо другую область B.

ord

упорядочение, предполагаемое в области B.

returns

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с порядком, где x < y, если ord.lt(f(x), f(y)).

Definition Classes
SeqOps
Пример:
    val words = "The quick brown fox jumped over the lazy dog".split(' ')
    // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
    words.sortBy(x => (x.length, x.head))
    res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
См. также

scala.math.Ordering

def sortWith(lt: (A, A) => Boolean): LinearSeq[A]

Сортирует эту последовательность в соответствии с функцией сравнения.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: Даже при применении к представлению или ленивой коллекции она всегда будет принудительно задействовать элементы.

Сортировка стабильна. То есть, элементы, которые равны (как определяется lt), появляются в отсортированной последовательности в том же порядке, что и в исходной.

lt

функция сравнения, которая проверяет, предшествует ли ее первый аргумент второму аргументу в желаемом порядке.

returns

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с функцией сравнения lt.

Definition Classes
SeqOps
Пример:
    List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
    List("Bob", "John", "Steve", "Tom")

def sorted[B >: A](implicit ord: Ordering[B]): LinearSeq[A]

Сортирует эту последовательность в соответствии с упорядочением.

Сортировка стабильна. То есть, элементы, которые равны (как определяется ord.compare), появляются в отсортированной последовательности в том же порядке, что и в исходной.

ord

упорядочение, используемое для сравнения элементов.

returns

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с упорядочением ord.

Definition Classes
SeqOps
См. также

scala.math.Ordering Примечание: Даже при применении к представлению или ленивой коллекции она всегда будет принудительно задействовать элементы.

def span(p: (A) => Boolean): (LinearSeq[A], LinearSeq[A])

Разделяет эту итерируемую коллекцию на пару префикс/суффикс в соответствии с предикатом.

Примечание: c span p эквивалентно (но, возможно, более эффективно, чем) (c takeWhile p, c dropWhile p), при условии, что вычисление предиката p не приводит к каким-либо побочным эффектам.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

p

предикат проверки

returns

пара, состоящая из самого длинного префикса этой итерируемой коллекции, элементы которой удовлетворяют p, и остальная часть этой итерируемой коллекции.

Definition Classes
IterableOps → IterableOnceOps
Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращенные итераторы. Использование старого итератора не определено, может измениться и может привести к изменениям в новых итераторах также.

def splitAt(n: Int): (LinearSeq[A], LinearSeq[A])

Разделяет эту итерируемую коллекцию на пару префикс/суффикс в заданной позиции.

Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

n

позиция разделения.

returns

пара итерируемых коллекций, состоящая из первых n элементов этой итерируемой коллекции и других элементов.

Definition Classes
IterableOps → IterableOnceOps
Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращенные итераторы. Использование старого итератора не определено, может измениться и может привести к изменениям в новых итераторах также.

def startsWith[B >: A](that: IterableOnce[B], offset: Int = 0): Boolean

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

Примечание: Если и получающий объект this и аргумент that являются бесконечными последовательностями, этот метод может не завершиться.

that

последовательность для проверки

offset

индекс, где ищется последовательность.

returns

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

Definition Classes
SeqOps

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Возвращает Stepper для элементов этого набора.

Stepper позволяет создавать Java-поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип возвращаемого Stepper в соответствии с типом элемента этой коллекции.

    Для коллекций Int, Short, Byte или Char, возвращается IntStepperДля коллекций Double или Float, возвращается DoubleStepperДля коллекций Long возвращается LongStepperДля любого другого типа элемента возвращается AnyStepper

Обратите внимание, что этот метод переопределяется в подклассах, и тип возвращаемого значения уточняется до S with EfficientSplit, например IndexedSeqOps.stepper. Для Stepper, помеченных scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, в то время как обычные Stepper можно преобразовать только в последовательные потоки.

Definition Classes
IterableOnce

def stringPrefix: String

Attributes
protected[this]
Definition Classes
LinearSeq → Seq → Iterable
Annotations
@deprecatedOverriding("Compatibility override", "2.13.0")

def sum[B >: A](implicit num: math.Numeric[B]): B

Суммирует элементы этой коллекции.

B

тип результата операции +.

num

неявный параметр, определяющий набор операций с числами, включающий операцию +, используемую для формирования суммы.

returns

сумма всех элементов этой коллекции по отношению к операции + в num.

Definition Classes
IterableOnceOps

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def tail: LinearSeq[A]

Остальная часть коллекции без первого элемента.

Definition Classes
IterableOps

def tails: Iterator[LinearSeq[A]]

Итерирует по хвостам этой последовательности. Первое значение будет этой последовательностью, а последнее — пустой последовательностью, а промежуточные значения — результатами последовательного применения tail.

returns

итератор по всем хвостам этой последовательности

Definition Classes
LinearSeqOps → IterableOps
Пример:

    List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

def take(n: Int): LinearSeq[A]

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

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

n

количество элементов, которые необходимо взять из этой итерируемой коллекции.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def takeRight(n: Int): LinearSeq[A]

Выбирает последние n элементов.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен.

n

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

returns

итерируемый набор, содержащий только последние n элементов этого итерируемого набора, или весь итерируемый набор, если он содержит меньше, чем n элементов. Если n отрицательно, возвращает пустой итерируемый набор.

Definition Classes
IterableOps

def takeWhile(p: (A) => Boolean): LinearSeq[A]

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

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен.

p

Предикат для проверки элементов.

returns

самый длинный префикс этого итерируемого набора, элементы которого удовлетворяют предикату p.

Definition Classes
IterableOps → IterableOnceOps

def tapEach[U](f: (A) => U): LinearSeq[A]

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

U

тип возвращаемого значения f

f

функция, применяемая к каждому элементу в этом итерируемом наборе

returns

Тот же логический набор, что и этот

Definition Classes
IterableOps → IterableOnceOps

def to[C1](factory: Factory[A, C1]): C1

Учитывая фабрику коллекций factory, преобразуйте этот набор в соответствующее представление для текущего типа элементов A. Примеры использования:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

Definition Classes
IterableOnceOps

def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

Преобразовать коллекцию в массив.

Definition Classes
IterableOnceOps

final def toBuffer[B >: A]: Buffer[B]

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[A]

Definition Classes
IterableOnceOps

final def toIterable: LinearSeq.this.type

returns

Этот набор в виде Iterable[A]. Новый набор не будет создан, если this уже является Iterable[A].

Definition Classes
Iterable → IterableOps

def toList: List[A]

Definition Classes
IterableOnceOps

def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]

Definition Classes
IterableOnceOps

final def toSeq: LinearSeq.this.type

возвращает

Это коллекция в виде Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Определяющие классы
Seq → IterableOnceOps

def toSet[B >: A]: Set[B]

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

def toString(): String

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

возвращает

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

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

def toVector: Vector[A]

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

def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): LinearSeq[LinearSeq[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

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

asIterable

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

возвращает

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

Определяющие классы
IterableOps
Исключения

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

def unapply(a: Int): Option[A]

Попытка извлечь B из A в выражении сопоставления с образцом.

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

def unlift: PartialFunction[Int, B]

Преобразует опциональную функцию в частичную функцию.

Неявный
Этот член добавляется неявным преобразованием из LinearSeq[A] в UnliftOps[Int, B] с помощью метода UnliftOps в scala.Function1. Это преобразование будет выполнено только в том случае, если A является подклассом Option[B] (A <: Option[B]).
Определяющие классы
UnliftOps
Пример:

    В отличие от Function.unlift, этот метод UnliftOps.unlift может использоваться в экстракторах.

    val of: Int => Option[String] = { i =>
      if (i == 2) {
        Some("matched by an optional function")
      } else {
        None
      }
    }
    
    util.Random.nextInt(4) match {
      case of.unlift(m) => // Convert an optional function to a pattern
        println(m)
      case _ =>
        println("Not matched")
    }

def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (LinearSeq[A1], LinearSeq[A2])

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

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

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

A2

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

asPair

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

возвращает

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

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

def unzip3[A1, A2, A3](implicit asTriple: (A) => (A1, A2, A3)): (LinearSeq[A1], LinearSeq[A2], LinearSeq[A3])

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

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

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

A2

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

A3

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

asTriple

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

returns

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

Definition Classes
IterableOps

def updated[B >: A](index: Int, elem: B): LinearSeq[B]

Копия этого последовательности с одним заменённым элементом.

B

тип элементов возвращаемой последовательности.

index

позиция замены

elem

элемент замены

returns

новая последовательность, являющаяся копией этой последовательности с элементом в позиции index заменённым на elem.

Definition Classes
SeqOps
Exceptions thrown

IndexOutOfBoundsException, если index не удовлетворяет 0 <= index < length. В случае ленивой коллекции это исключение может быть выброшено позднее или не быть выброшено вообще (если конец коллекции никогда не оценивается).

def view: SeqView[A]

Просмотр элементов этой коллекции.

Definition Classes
SeqOps → IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

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

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def withFilter(p: (A) => Boolean): WithFilter[A, [_]LinearSeq[_]]

Создаёт нестрогий фильтр этой итерируемой коллекции.

Примечание: Различие между c filter p и c withFilter p состоит в том, что первый создаёт новую коллекцию, а второй только ограничивает область применения последующих map, flatMap, foreach, и withFilter операций.

Примечание: может возвращать разные результаты для разных запусков, если только тип базовой коллекции не упорядочен.

p

предикат, используемый для проверки элементов.

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этой итерируемой коллекции, которые удовлетворяют предикату p.

Definition Classes
IterableOps

def zip[B](that: IterableOnce[B]): LinearSeq[(A, B)]

Возвращает итерируемую коллекцию, образованную из этой итерируемой коллекции и другой итерируемой коллекции путём комбинирования соответствующих элементов в парах. Если одна из двух коллекций длиннее другой, её оставшиеся элементы игнорируются.

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
IterableOps

def zipAll[A1 >: A, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): LinearSeq[(A1, B)]

Возвращает итерируемую коллекцию, сформированную из этой и другой итерируемой коллекции, объединяя соответствующие элементы парами. Если одна из двух коллекций короче другой, для расширения более короткой коллекции до длины более длинной используются плацехолдерные элементы.

that

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

thisElem

элемент, используемый для заполнения результата, если эта итерируемая коллекция короче, чем that.

thatElem

элемент, используемый для заполнения результата, если that короче, чем эта итерируемая коллекция.

returns

новая коллекция типа That, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции — максимальная из длин этой итерируемой коллекции и that. Если эта итерируемая коллекция короче that, используются значения thisElem, чтобы заполнить результат. Если that короче этой итерируемой коллекции, используются значения thatElem для заполнения результата.

Definition Classes
IterableOps

def zipWithIndex: LinearSeq[(A, Int)]

Объединяет эту итерируемую коллекцию с её индексами.

returns

Новая итерируемая коллекция, содержащая пары, состоящие из всех элементов этой итерируемой коллекции, соединённых с их индексом. Индексы начинаются с 0.

Definition Classes
IterableOps → IterableOnceOps
Пример:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

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

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

Spec-Zone.ru

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