# Every

### Related Docs: object Every | package scalactic

#### sealed abstract class Every[+T] extends PartialFunction[Int, T] with Product with Serializable

An ordered, immutable, non-empty collection of elements.

Class Every has two and only two subtypes: One and Many. A One contains exactly one element. A Many contains two or more elements. Thus no way exists for an Every to contain zero elements.

#### Constructing Everys

You can construct an Every by passing one or more elements to the Every.apply factory method:

Every(1)
Every(1, 2)
Every(1, 2, 3)

Alternatively you can pass one element to the One.apply factory method, or two or more elements to Many.apply:

One(1)
Many(1, 3)
Many(1, 2, 3)

#### Working with Everys

Every does not extend Scala's Seq or Traversable traits because these require that implementations may be empty. For example, if you invoke tail on a Seq that contains just one element, you'll get an empty Seq:

scala> List(1).tail
res6: List[Int] = List()

On the other hand, many useful methods exist on Seq that when invoked on a non-empty Seq are guaranteed to not result in an empty Seq. For convenience, Every defines a method corresponding to every such Seq method. Here are some examples:

Many(1, 2, 3).map(_ + 1)                  // Result: Many(2, 3, 4)
One(1).map(_ + 1)                         // Result: One(2)
Every(1, 2, 3).containsSlice(Every(2, 3)) // Result: true
Every(1, 2, 3).containsSlice(Every(3, 4)) // Result: false
Every(-1, -2, 3, 4, 5).minBy(_.abs)       // Result: -1

Every does not currently define any methods corresponding to Seq methods that could result in an empty Seq. However, an implicit converison from Every to collection.immutable.IndexedSeq is defined in the Every companion object that will be applied if you attempt to call one of the missing methods. As a result, you can invoke filter on an Every, even though filter could result in an empty sequence—but the result type will be collection.immutable.IndexedSeq instead of Every:

Every(1, 2, 3).filter(_ < 10) // Result: Vector(1, 2, 3)
Every(1, 2, 3).filter(_ > 10) // Result: Vector()

You can use Everys in for expressions. The result will be an Every unless you use a filter (an if clause). Because filters are desugared to invocations of filter, the result type will switch to a collection.immutable.IndexedSeq at that point. Here are some examples:

scala> import org.scalactic._
import org.scalactic._

scala> for (i <- Every(1, 2, 3)) yield i + 1
res0: org.scalactic.Every[Int] = Many(2, 3, 4)

scala> for (i <- Every(1, 2, 3) if i < 10) yield i + 1
res1: scala.collection.immutable.IndexedSeq[Int] = Vector(2, 3, 4)

scala> for {
|   i <- Every(1, 2, 3)
|   j <- Every('a', 'b', 'c')
| } yield (i, j)
res3: org.scalactic.Every[(Int, Char)] =
Many((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

scala> for {
|   i <- Every(1, 2, 3) if i < 10
|   j <- Every('a', 'b', 'c')
| } yield (i, j)
res6: scala.collection.immutable.IndexedSeq[(Int, Char)] =
Vector((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

#### Motivation for Everys

Although Every is a general-purpose, non-empty ordered collection, it was motivated by the desire to enable easy accumulation of errors in Ors. For examples of Every used in that use case, see the Accumulating errors with Or section in the main documentation for Or.

T

the type of elements contained in this Every

Source
Every.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, PartialFunction[Int, T], (Int) ⇒ T, AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. Every
2. Serializable
3. Serializable
4. Product
5. Equals
6. PartialFunction
7. Function1
8. AnyRef
9. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### Abstract Value Members

1. #### abstract def ++[U >: T](other: GenTraversableOnce[U]): Every[U]

Returns a new Many containing the elements of this Every followed by the elements of the passed GenTraversableOnce.

Returns a new Many containing the elements of this Every followed by the elements of the passed GenTraversableOnce. The element type of the resulting Many is the most specific superclass encompassing the element types of this Every and the passed GenTraversableOnce.

U

the element type of the returned Many

other

the Every to append

returns

a new Many that contains all the elements of this Every followed by all elements of other.

2. #### abstract def ++[U >: T](other: Every[U]): Many[U]

Returns a new Many containing the elements of this Every followed by the elements of the passed Every.

Returns a new Many containing the elements of this Every followed by the elements of the passed Every. The element type of the resulting Many is the most specific superclass encompassing the element types of this and the passed Every.

U

the element type of the returned Many

other

the Every to append

returns

a new Many that contains all the elements of this Every followed by all elements of other.

3. #### abstract def :+[U >: T](element: U): Many[U]

Returns a new Every with the given element appended.

Returns a new Every with the given element appended.

Note a mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

element

the element to append to this Every

returns

a new Every consisting of all elements of this Every followed by element.

4. #### abstract def canEqual(that: Any): Boolean

Definition Classes
Equals
5. #### abstract def productArity: Int

Definition Classes
Product
6. #### abstract def productElement(n: Int): Any

Definition Classes
Product
7. #### abstract def stringPrefix: String

The prefix of this object's toString representation.

The prefix of this object's toString representation.

returns

a string representation which starts the result of toString applied to this Every, which will be "One" if this Every is a One, or "Many" if it is a Many.

### Concrete Value Members

1. #### final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
2. #### final def ##(): Int

Definition Classes
AnyRef → Any
3. #### final def +:[U >: T](element: U): Many[U]

Returns a new Every with the given element prepended.

Returns a new Every with the given element prepended.

Note that :-ending operators are right associative. A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

element

the element to prepend to this Every

returns

a new Every consisting of element followed by all elements of this Every.

4. #### final def /:[B](z: B)(op: (B, T) ⇒ B): B

Fold left: applies a binary operator to a start value, z, and all elements of this Every, going left to right.

Fold left: applies a binary operator to a start value, z, and all elements of this Every, going left to right.

Note: /: is alternate syntax for the foldLeft method; z /: every is the same as every foldLeft z.

B

the result of the binary operator

z

the start value

op

the binary operator

returns

the result of inserting op between consecutive elements of this Every, going left to right, with the start value, z, on the left:

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

where x1, ..., xn are the elements of this Every.

5. #### final def :\[B](z: B)(op: (T, B) ⇒ B): B

Fold right: applies a binary operator to all elements of this Every and a start value, going right to left.

Fold right: applies a binary operator to all elements of this Every and a start value, going right to left.

Note: :\ is alternate syntax for the foldRight method; every :\ z is the same as every foldRight z.

B

the result of the binary operator

z

the start value

op

the binary operator

returns

the result of inserting op between consecutive elements of this Every, going right to left, with the start value, z, on the right:

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

where x1, ..., xn are the elements of this Every.

6. #### final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
7. #### final def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all elements of this Every to a string builder using start, end, and separator strings.

Appends all elements of this Every to a string builder using start, end, and separator strings. The written text will consist of a concatenation of the string start; the result of invoking toString on all elements of this Every, separated by the string sep; and the string end

sb

the string builder to which elements will be appended

start

the ending string

sep

the separator string

returns

the string builder, sb, to which elements were appended.

8. #### final def addString(sb: StringBuilder, sep: String): StringBuilder

Appends all elements of this Every to a string builder using a separator string.

Appends all elements of this Every to a string builder using a separator string. The written text will consist of a concatenation of the result of invoking toString on of every element of this Every, separated by the string sep.

sb

the string builder to which elements will be appended

sep

the separator string

returns

the string builder, sb, to which elements were appended.

9. #### final def addString(sb: StringBuilder): StringBuilder

Appends all elements of this Every to a string builder.

Appends all elements of this Every to a string builder. The written text will consist of a concatenation of the result of invoking toString on of every element of this Every, without any separator string.

sb

the string builder to which elements will be appended

returns

the string builder, sb, to which elements were appended.

10. #### def andThen[C](k: (T) ⇒ C): PartialFunction[Int, C]

Definition Classes
PartialFunction → Function1
11. #### final def apply(idx: Int): T

Selects an element by its index in the Every.

Selects an element by its index in the Every.

returns

the element of this Every at index idx, where 0 indicates the first element.

Definition Classes
Every → Function1
12. #### def applyOrElse[A1 <: Int, B1 >: T](x: A1, default: (A1) ⇒ B1): B1

Definition Classes
PartialFunction
13. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
14. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
15. #### final def collectFirst[U](pf: PartialFunction[T, U]): Option[U]

Finds the first element of the Every for which the given partial function is defined, if any, and applies the partial function to it.

Finds the first element of the Every for which the given partial function is defined, if any, and applies the partial function to it.

pf

the partial function

returns

an Option containing pf applied to the first element for which it is defined, or None if the partial function was not defined for any element.

16. #### def compose[A](g: (A) ⇒ Int): (A) ⇒ T

Definition Classes
Function1
Annotations
@unspecialized()
17. #### final def contains(elem: Any): Boolean

Indicates whether this Every contains a given value as an element.

Indicates whether this Every contains a given value as an element.

elem

the element to look for

returns

true if this Every has an element that is equal (as determined by ==) to elem, false otherwise.

18. #### final def containsSlice[B](that: Every[B]): Boolean

Indicates whether this Every contains a given Every as a slice.

Indicates whether this Every contains a given Every as a slice.

that

the Every slice to look for

returns

true if this Every contains a slice with the same elements as that, otherwise false.

19. #### final def containsSlice[B](that: GenSeq[B]): Boolean

Indicates whether this Every contains a given GenSeq as a slice.

Indicates whether this Every contains a given GenSeq as a slice.

that

the GenSeq slice to look for

returns

true if this Every contains a slice with the same elements as that, otherwise false.

20. #### final def copyToArray[U >: T](arr: Array[U], start: Int, len: Int): Unit

Copies values of this Every to an array.

Copies values of this Every to an array. Fills the given array arr with at most len elements of this Every, beginning at index start. Copying will stop once either the end of the current Every is reached, the end of the array is reached, or len elements have been copied.

arr

the array to fill

start

the starting index

len

the maximum number of elements to copy

21. #### final def copyToArray[U >: T](arr: Array[U], start: Int): Unit

Copies values of this Every to an array.

Copies values of this Every to an array. Fills the given array arr with values of this Every, beginning at index start. Copying will stop once either the end of the current Every is reached, or the end of the array is reached.

arr

the array to fill

start

the starting index

22. #### final def copyToArray[U >: T](arr: Array[U]): Unit

Copies values of this Every to an array.

Copies values of this Every to an array. Fills the given array arr with values of this Every. Copying will stop once either the end of the current Every is reached, or the end of the array is reached.

arr

the array to fill

23. #### final def copyToBuffer[U >: T](buf: Buffer[U]): Unit

Copies all elements of this Every to a buffer.

Copies all elements of this Every to a buffer.

buf

the buffer to which elements are copied

24. #### final def corresponds[B](that: Every[B])(p: (T, B) ⇒ Boolean): Boolean

Indicates whether every element of this Every relates to the corresponding element of a given Every by satisfying a given predicate.

Indicates whether every element of this Every relates to the corresponding element of a given Every by satisfying a given predicate.

B

the type of the elements of that

that

the Every to compare for correspondence

p

the predicate, which relates elements from this and the passed Every

returns

true if this and the passed Every have the same length and p(x, y) is true for all corresponding elements x of this Every and y of that, otherwise false.

25. #### final def corresponds[B](that: GenSeq[B])(p: (T, B) ⇒ Boolean): Boolean

Indicates whether every element of this Every relates to the corresponding element of a given GenSeq by satisfying a given predicate.

Indicates whether every element of this Every relates to the corresponding element of a given GenSeq by satisfying a given predicate.

B

the type of the elements of that

that

the GenSeq to compare for correspondence

p

the predicate, which relates elements from this Every and the passed GenSeq

returns

true if this Every and the passed GenSeq have the same length and p(x, y) is true for all corresponding elements x of this Every and y of that, otherwise false.

26. #### final def count(p: (T) ⇒ Boolean): Int

Counts the number of elements in the Every that satisfy a predicate.

Counts the number of elements in the Every that satisfy a predicate.

p

the predicate used to test elements.

returns

the number of elements satisfying the predicate p.

27. #### final def distinct: Every[T]

Builds a new Every from this Every without any duplicate elements.

Builds a new Every from this Every without any duplicate elements.

returns

A new Every that contains the first occurrence of every element of this Every.

28. #### final def endsWith[B](that: Every[B]): Boolean

Indicates whether this Every ends with the given Every.

Indicates whether this Every ends with the given Every.

returns

true if this Every has that as a suffix, false otherwise.

29. #### final def endsWith[B](that: GenSeq[B]): Boolean

Indicates whether this Every ends with the given GenSeq.

Indicates whether this Every ends with the given GenSeq.

returns

true if this Every has that as a suffix, false otherwise.

30. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
31. #### def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
32. #### final def exists(p: (T) ⇒ Boolean): Boolean

Indicates whether a predicate holds for at least one of the elements of this Every.

Indicates whether a predicate holds for at least one of the elements of this Every.

returns

true if the given predicate p holds for some of the elements of this Every, otherwise false.

33. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
34. #### final def find(p: (T) ⇒ Boolean): Option[T]

Finds the first element of this Every that satisfies the given predicate, if any.

Finds the first element of this Every that satisfies the given predicate, if any.

p

the predicate used to test elements

returns

an Some containing the first element in this Every that satisfies p, or None if none exists.

35. #### final def flatMap[U](f: (T) ⇒ Every[U]): Every[U]

Builds a new Every by applying a function to all elements of this Every and using the elements of the resulting Everys.

Builds a new Every by applying a function to all elements of this Every and using the elements of the resulting Everys.

U

the element type of the returned Every

f

the function to apply to each element.

returns

a new Every containing elements obtained by applying the given function f to each element of this Every and concatenating the elements of resulting Everys.

36. #### final def flatten[B](implicit ev: <:<[T, Every[B]]): Every[B]

Converts this Every of Everys into an Every formed by the elements of the nested Everys.

Converts this Every of Everys into an Every formed by the elements of the nested Everys.

Note: You cannot use this flatten method on an Every that contains a GenTraversableOnces, because if all the nested GenTraversableOnces were empty, you'd end up with an empty Every.

returns

a new Every resulting from concatenating all nested Everys.

37. #### final def fold[U >: T](z: U)(op: (U, U) ⇒ U): U

Folds the elements of this Every using the specified associative binary operator.

Folds the elements of this Every using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

U

a type parameter for the binary operator, a supertype of T.

z

a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication.)

op

a binary operator that must be associative

returns

the result of applying fold operator op between all the elements and z

38. #### final def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

Applies a binary operator to a start value and all elements of this Every, going left to right.

Applies a binary operator to a start value and all elements of this Every, going left to right.

B

the result type of the binary operator.

z

the start value.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this Every, going left to right, with the start value, z, on the left:

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

where x1, ..., xn are the elements of this Every.

39. #### final def foldRight[B](z: B)(op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this Every and a start value, going right to left.

Applies a binary operator to all elements of this Every and a start value, going right to left.

B

the result of the binary operator

z

the start value

op

the binary operator

returns

the result of inserting op between consecutive elements of this Every, going right to left, with the start value, z, on the right:

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

where x1, ..., xn are the elements of this Every.

40. #### final def forall(p: (T) ⇒ Boolean): Boolean

Indicates whether a predicate holds for all elements of this Every.

Indicates whether a predicate holds for all elements of this Every.

p

the predicate used to test elements.

returns

true if the given predicate p holds for all elements of this Every, otherwise false.

41. #### final def foreach(f: (T) ⇒ Unit): Unit

Applies a function f to all elements of this Every.

Applies a function f to all elements of this Every.

f

the function that is applied for its side-effect to every element. The result of function f is discarded.

42. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
43. #### final def groupBy[K](f: (T) ⇒ K): Map[K, Every[T]]

Partitions this Every into a map of Everys according to some discriminator function.

Partitions this Every into a map of Everys according to some discriminator function.

K

the type of keys returned by the discriminator function.

f

the discriminator function.

returns

A map from keys to Everys such that the following invariant holds:

(every.toVector partition f)(k) = xs filter (x => f(x) == k)

That is, every key k is bound to an Every of those elements x for which f(x) equals k.

44. #### final def grouped(size: Int): Iterator[Every[T]]

Partitions elements into fixed size Everys.

Partitions elements into fixed size Everys.

size

the number of elements per group

returns

An iterator producing Everys of size size, except the last will be truncated if the elements don't divide evenly.

45. #### final def hasDefiniteSize: Boolean

Returns true to indicate this Every has a definite size, since all Everys are strict collections.

Returns true to indicate this Every has a definite size, since all Everys are strict collections.

46. #### def hashCode(): Int

Definition Classes
AnyRef → Any
47. #### final def head: T

Selects the first element of this Every.

Selects the first element of this Every.

returns

the first element of this Every.

48. #### final def headOption: Option[T]

Selects the first element of this Every and returns it wrapped in a Some.

Selects the first element of this Every and returns it wrapped in a Some.

returns

the first element of this Every, wrapped in a Some.

49. #### final def indexOf[U >: T](elem: U, from: Int): Int

Finds index of first occurrence of some value in this Every after or at some start index.

Finds index of first occurrence of some value in this Every after or at some start index.

elem

the element value to search for.

from

the start index

returns

the index >= from of the first element of this Every that is equal (as determined by ==) to elem, or -1, if none exists.

50. #### final def indexOf[U >: T](elem: U): Int

Finds index of first occurrence of some value in this Every.

Finds index of first occurrence of some value in this Every.

elem

the element value to search for.

returns

the index of the first element of this Every that is equal (as determined by ==) to elem, or -1, if none exists.

51. #### final def indexOfSlice[U >: T](that: Every[U], from: Int): Int

Finds first index after or at a start index where this Every contains a given Every as a slice.

Finds first index after or at a start index where this Every contains a given Every as a slice.

that

the Every defining the slice to look for

from

the start index

returns

the first index >= from such that the elements of this Every starting at this index match the elements of Every that, or -1 of no such subsequence exists.

52. #### final def indexOfSlice[U >: T](that: Every[U]): Int

Finds first index where this Every contains a given Every as a slice.

Finds first index where this Every contains a given Every as a slice.

that

the Every defining the slice to look for

returns

the first index such that the elements of this Every starting at this index match the elements of Every that, or -1 of no such subsequence exists.

53. #### final def indexOfSlice[U >: T](that: GenSeq[U], from: Int): Int

Finds first index after or at a start index where this Every contains a given GenSeq as a slice.

Finds first index after or at a start index where this Every contains a given GenSeq as a slice.

that

the GenSeq defining the slice to look for

from

the start index

returns

the first index >= from at which the elements of this Every starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

54. #### final def indexOfSlice[U >: T](that: GenSeq[U]): Int

Finds first index where this Every contains a given GenSeq as a slice.

Finds first index where this Every contains a given GenSeq as a slice.

that

the GenSeq defining the slice to look for

returns

the first index at which the elements of this Every starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

55. #### final def indexWhere(p: (T) ⇒ Boolean, from: Int): Int

Finds index of the first element satisfying some predicate after or at some start index.

Finds index of the first element satisfying some predicate after or at some start index.

p

the predicate used to test elements.

from

the start index

returns

the index >= from of the first element of this Every that satisfies the predicate p, or -1, if none exists.

56. #### final def indexWhere(p: (T) ⇒ Boolean): Int

Finds index of the first element satisfying some predicate.

Finds index of the first element satisfying some predicate.

p

the predicate used to test elements.

returns

the index of the first element of this Every that satisfies the predicate p, or -1, if none exists.

57. #### final def indices: Range

Produces the range of all indices of this Every.

Produces the range of all indices of this Every.

returns

a Range value from 0 to one less than the length of this Every.

58. #### final def isDefinedAt(idx: Int): Boolean

Tests whether this Every contains given index.

Tests whether this Every contains given index.

idx

the index to test

returns

true if this Every contains an element at position idx, false otherwise.

Definition Classes
Every → PartialFunction
59. #### final def isEmpty: Boolean

Returns false to indicate this Every, like all Everys, is non-empty.

Returns false to indicate this Every, like all Everys, is non-empty.

returns

false

60. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
61. #### final def isTraversableAgain: Boolean

Returns true to indicate this Every, like all Everys, can be traversed repeatedly.

Returns true to indicate this Every, like all Everys, can be traversed repeatedly.

returns

true

62. #### final def iterator: Iterator[T]

Creates and returns a new iterator over all elements contained in this Every.

Creates and returns a new iterator over all elements contained in this Every.

returns

the new iterator

63. #### final def last: T

Selects the last element of this Every.

Selects the last element of this Every.

returns

the last element of this Every.

64. #### final def lastIndexOf[U >: T](elem: U, end: Int): Int

Finds the index of the last occurrence of some value in this Every before or at a given end index.

Finds the index of the last occurrence of some value in this Every before or at a given end index.

elem

the element value to search for.

end

the end index.

returns

the index >= end of the last element of this Every that is equal (as determined by ==) to elem, or -1, if none exists.

65. #### final def lastIndexOf[U >: T](elem: U): Int

Finds the index of the last occurrence of some value in this Every.

Finds the index of the last occurrence of some value in this Every.

elem

the element value to search for.

returns

the index of the last element of this Every that is equal (as determined by ==) to elem, or -1, if none exists.

66. #### final def lastIndexOfSlice[U >: T](that: Every[U], end: Int): Int

Finds the last index before or at a given end index where this Every contains a given Every as a slice.

Finds the last index before or at a given end index where this Every contains a given Every as a slice.

that

the Every defining the slice to look for

end

the end index

returns

the last index >= end at which the elements of this Every starting at that index match the elements of Every that, or -1 of no such subsequence exists.

67. #### final def lastIndexOfSlice[U >: T](that: Every[U]): Int

Finds the last index where this Every contains a given Every as a slice.

Finds the last index where this Every contains a given Every as a slice.

that

the Every defining the slice to look for

returns

the last index at which the elements of this Every starting at that index match the elements of Every that, or -1 of no such subsequence exists.

68. #### final def lastIndexOfSlice[U >: T](that: GenSeq[U], end: Int): Int

Finds the last index before or at a given end index where this Every contains a given GenSeq as a slice.

Finds the last index before or at a given end index where this Every contains a given GenSeq as a slice.

that

the GenSeq defining the slice to look for

end

the end index

returns

the last index >= end at which the elements of this Every starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

69. #### final def lastIndexOfSlice[U >: T](that: GenSeq[U]): Int

Finds the last index where this Every contains a given GenSeq as a slice.

Finds the last index where this Every contains a given GenSeq as a slice.

that

the GenSeq defining the slice to look for

returns

the last index at which the elements of this Every starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

70. #### final def lastIndexWhere(p: (T) ⇒ Boolean, end: Int): Int

Finds index of last element satisfying some predicate before or at given end index.

Finds index of last element satisfying some predicate before or at given end index.

p

the predicate used to test elements.

end

the end index

returns

the index >= end of the last element of this Every that satisfies the predicate p, or -1, if none exists.

71. #### final def lastIndexWhere(p: (T) ⇒ Boolean): Int

Finds index of last element satisfying some predicate.

Finds index of last element satisfying some predicate.

p

the predicate used to test elements.

returns

the index of the last element of this Every that satisfies the predicate p, or -1, if none exists.

72. #### final def lastOption: Option[T]

Returns the last element of this Every, wrapped in a Some.

Returns the last element of this Every, wrapped in a Some.

returns

the last element, wrapped in a Some.

73. #### final def length: Int

The length of this Every.

The length of this Every.

Note: length and size yield the same result, which will be >= 1.

returns

the number of elements in this Every.

74. #### final def lengthCompare(len: Int): Int

Compares the length of this Every to a test value.

Compares the length of this Every to a test value.

len

the test value that gets compared with the length.

returns

a value x where

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

75. #### def lift: (Int) ⇒ Option[T]

Definition Classes
PartialFunction
76. #### final def map[U](f: (T) ⇒ U): Every[U]

Builds a new Every by applying a function to all elements of this Every.

Builds a new Every by applying a function to all elements of this Every.

U

the element type of the returned Every.

f

the function to apply to each element.

returns

a new Every resulting from applying the given function f to each element of this Every and collecting the results.

77. #### final def max[U >: T](implicit cmp: Ordering[U]): T

Finds the largest element.

Finds the largest element.

returns

the largest element of this Every.

78. #### final def maxBy[U](f: (T) ⇒ U)(implicit cmp: Ordering[U]): T

Finds the largest result after applying the given function to every element.

Finds the largest result after applying the given function to every element.

returns

the largest result of applying the given function to every element of this Every.

79. #### final def min[U >: T](implicit cmp: Ordering[U]): T

Finds the smallest element.

Finds the smallest element.

returns

the smallest element of this Every.

80. #### final def minBy[U](f: (T) ⇒ U)(implicit cmp: Ordering[U]): T

Finds the smallest result after applying the given function to every element.

Finds the smallest result after applying the given function to every element.

returns

the smallest result of applying the given function to every element of this Every.

81. #### final def mkString(start: String, sep: String, end: String): String

Displays all elements of this Every in a string using start, end, and separator strings.

Displays all elements of this Every in a string using start, end, and separator strings.

start

the starting string.

sep

the separator string.

end

the ending string.

returns

a string representation of this Every. The resulting string begins with the string start and ends with the string end. Inside, In the resulting string, the result of invoking toString on all elements of this Every are separated by the string sep.

82. #### final def mkString(sep: String): String

Displays all elements of this Every in a string using a separator string.

Displays all elements of this Every in a string using a separator string.

sep

the separator string

returns

a string representation of this Every. In the resulting string, the result of invoking toString on all elements of this Every are separated by the string sep.

83. #### final def mkString: String

Displays all elements of this Every in a string.

Displays all elements of this Every in a string.

returns

a string representation of this Every. In the resulting string, the result of invoking toString on all elements of this Every follow each other without any separator string.

84. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
85. #### final def nonEmpty: Boolean

Returns true to indicate this Every, like all Everys, is non-empty.

Returns true to indicate this Every, like all Everys, is non-empty.

returns

true

86. #### final def notify(): Unit

Definition Classes
AnyRef
87. #### final def notifyAll(): Unit

Definition Classes
AnyRef
88. #### def orElse[A1 <: Int, B1 >: T](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Definition Classes
PartialFunction
89. #### final def padTo[U >: T](len: Int, elem: U): Every[U]

A copy of this Every with an element value appended until a given target length is reached.

A copy of this Every with an element value appended until a given target length is reached.

len

the target length

elem

returns

a new Every consisting of all elements of this Every followed by the minimal number of occurrences of elem so that the resulting Every has a length of at least len.

90. #### final def patch[U >: T](from: Int, that: Every[U], replaced: Int): Every[U]

Produces a new Every where a slice of elements in this Every is replaced by another Every

Produces a new Every where a slice of elements in this Every is replaced by another Every

from

the index of the first replaced element

that

the Every whose elements should replace a slice in this Every

replaced

the number of elements to drop in the original Every

91. #### final def permutations: Iterator[Every[T]]

Iterates over distinct permutations.

Iterates over distinct permutations.

Here's an example:

Every('a', 'b', 'b').permutations.toList = Iterator(Many(a, b, b), Many(b, a, b), Many(b, b, a))

returns

an iterator which traverses the distinct permutations of this Every.

92. #### final def prefixLength(p: (T) ⇒ Boolean): Int

Returns the length of the longest prefix whose elements all satisfy some predicate.

Returns the length of the longest prefix whose elements all satisfy some predicate.

p

the predicate used to test elements.

returns

the length of the longest prefix of this Every such that every element of the segment satisfies the predicate p.

93. #### final def product[U >: T](implicit num: Numeric[U]): U

The result of multiplying all the elements of this Every.

The result of multiplying all the elements of this Every.

This method can be invoked for any Every[T] for which an implicit Numeric[T] exists.

returns

the product of all elements

94. #### def productIterator: Iterator[Any]

Definition Classes
Product
95. #### def productPrefix: String

Definition Classes
Product
96. #### final def reduce[U >: T](op: (U, U) ⇒ U): U

Reduces the elements of this Every using the specified associative binary operator.

Reduces the elements of this Every using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

U

a type parameter for the binary operator, a supertype of T.

op

a binary operator that must be associative.

returns

the result of applying reduce operator op between all the elements of this Every.

97. #### final def reduceLeft[U >: T](op: (U, T) ⇒ U): U

Applies a binary operator to all elements of this Every, going left to right.

Applies a binary operator to all elements of this Every, going left to right.

U

the result type of the binary operator.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this Every, going left to right:

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

where x1, ..., xn are the elements of this Every.

98. #### final def reduceLeftOption[U >: T](op: (U, T) ⇒ U): Option[U]

Applies a binary operator to all elements of this Every, going left to right, returning the result in a Some.

Applies a binary operator to all elements of this Every, going left to right, returning the result in a Some.

U

the result type of the binary operator.

op

the binary operator.

returns

a Some containing the result of reduceLeft(op)

100. #### final def reduceRight[U >: T](op: (T, U) ⇒ U): U

Applies a binary operator to all elements of this Every, going right to left.

Applies a binary operator to all elements of this Every, going right to left.

U

the result of the binary operator

op

the binary operator

returns

the result of inserting op between consecutive elements of this Every, going right to left:

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

where x1, ..., xn are the elements of this Every.

101. #### final def reduceRightOption[U >: T](op: (T, U) ⇒ U): Option[U]

Applies a binary operator to all elements of this Every, going right to left, returning the result in a Some.

Applies a binary operator to all elements of this Every, going right to left, returning the result in a Some.

U

the result of the binary operator

op

the binary operator

returns

a Some containing the result of reduceRight(op)

102. #### final def reverse: Every[T]

Returns new Every wih elements in reverse order.

Returns new Every wih elements in reverse order.

returns

a new Every with all elements of this Every in reversed order.

103. #### final def reverseIterator: Iterator[T]

An iterator yielding elements in reverse order.

An iterator yielding elements in reverse order.

Note: every.reverseIterator is the same as every.reverse.iterator, but might be more efficient.

returns

an iterator yielding the elements of this Every in reversed order

104. #### final def reverseMap[U](f: (T) ⇒ U): Every[U]

Builds a new Every by applying a function to all elements of this Every and collecting the results in reverse order.

Builds a new Every by applying a function to all elements of this Every and collecting the results in reverse order.

Note: every.reverseMap(f) is the same as every.reverse.map(f), but might be more efficient.

U

the element type of the returned Every.

f

the function to apply to each element.

returns

a new Every resulting from applying the given function f to each element of this Every and collecting the results in reverse order.

105. #### def runWith[U](action: (T) ⇒ U): (Int) ⇒ Boolean

Definition Classes
PartialFunction
106. #### final def sameElements[U >: T](that: Every[U]): Boolean

Checks if the given Every contains the same elements in the same order as this Every.

Checks if the given Every contains the same elements in the same order as this Every.

that

the Every with which to compare

returns

true, if both this and the given Every contain the same elements in the same order, false otherwise.

107. #### final def sameElements[U >: T](that: GenIterable[U]): Boolean

Checks if the given GenIterable contains the same elements in the same order as this Every.

Checks if the given GenIterable contains the same elements in the same order as this Every.

that

the GenIterable with which to compare

returns

true, if both this Every and the given GenIterable contain the same elements in the same order, false otherwise.

108. #### final def scan[U >: T](z: U)(op: (U, U) ⇒ U): Every[U]

Computes a prefix scan of the elements of this Every.

Computes a prefix scan of the elements of this Every.

Note: The neutral element z may be applied more than once.

Here are some examples:

Every(1, 2, 3).scan(0)(_ + _) == Every(0, 1, 3, 6)
Every(1, 2, 3).scan("z")(_ + _.toString) == Every("z", "z1", "z12", "z123")

U

a type parameter for the binary operator, a supertype of T, and the type of the resulting Every.

z

a neutral element for the scan operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication.)

op

a binary operator that must be associative

returns

a new Every containing the prefix scan of the elements in this Every

109. #### final def scanLeft[B](z: B)(op: (B, T) ⇒ B): Every[B]

Produces an Every containing cumulative results of applying the operator going left to right.

Produces an Every containing cumulative results of applying the operator going left to right.

Here are some examples:

Every(1, 2, 3).scanLeft(0)(_ + _) == Every(0, 1, 3, 6)
Every(1, 2, 3).scanLeft("z")(_ + _) == Every("z", "z1", "z12", "z123")

B

the result type of the binary operator and type of the resulting Every

z

the start value.

op

the binary operator.

returns

a new Every containing the intermediate results of inserting op between consecutive elements of this Every, going left to right, with the start value, z, on the left.

110. #### final def scanRight[B](z: B)(op: (T, B) ⇒ B): Every[B]

Produces an Every containing cumulative results of applying the operator going right to left.

Produces an Every containing cumulative results of applying the operator going right to left.

Here are some examples:

Every(1, 2, 3).scanRight(0)(_ + _) == Every(6, 5, 3, 0)
Every(1, 2, 3).scanRight("z")(_ + _) == Every("123z", "23z", "3z", "z")

B

the result of the binary operator and type of the resulting Every

z

the start value

op

the binary operator

returns

a new Every containing the intermediate results of inserting op between consecutive elements of this Every, going right to left, with the start value, z, on the right.

111. #### final def segmentLength(p: (T) ⇒ Boolean, from: Int): Int

Computes length of longest segment whose elements all satisfy some predicate.

Computes length of longest segment whose elements all satisfy some predicate.

p

the predicate used to test elements.

from

the index where the search starts.

112. #### final def size: Int

The size of this Every.

The size of this Every.

Note: length and size yield the same result, which will be >= 1.

returns

the number of elements in this Every.

113. #### final def sliding(size: Int, step: Int): Iterator[Every[T]]

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.), moving the sliding window by a given step each time.

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.), moving the sliding window by a given step each time.

size

the number of elements per group

step

the distance between the first elements of successive groups

returns

an iterator producing Everys of size size, except the last and the only element will be truncated if there are fewer elements than size.

114. #### final def sliding(size: Int): Iterator[Every[T]]

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)

size

the number of elements per group

returns

an iterator producing Everys of size size, except the last and the only element will be truncated if there are fewer elements than size.

115. #### final def sortBy[U](f: (T) ⇒ U)(implicit ord: Ordering[U]): Every[T]

Sorts this Every according to the Ordering of the result of applying the given function to every element.

Sorts this Every according to the Ordering of the result of applying the given function to every element.

U

the target type of the transformation f, and the type where the Ordering ord is defined.

f

the transformation function mapping elements to some other domain U.

ord

the ordering assumed on domain U.

returns

a Every consisting of the elements of this Every sorted according to the Ordering where x < y if ord.lt(f(x), f(y)).

116. #### final def sortWith(lt: (T, T) ⇒ Boolean): Every[T]

Sorts this Every according to a comparison function.

Sorts this Every according to a comparison function.

The sort is stable. That is, elements that are equal (as determined by lt) appear in the same order in the sorted Every as in the original.

returns

an Every consisting of the elements of this Every sorted according to the comparison function lt.

117. #### final def sorted[U >: T](implicit ord: Ordering[U]): Every[U]

Sorts this Every according to an Ordering.

Sorts this Every according to an Ordering.

The sort is stable. That is, elements that are equal (as determined by lt) appear in the same order in the sorted Every as in the original.

ord

the Ordering to be used to compare elements.

returns

an Every consisting of the elements of this Every sorted according to the comparison function lt.

118. #### final def startsWith[B](that: Every[B], offset: Int): Boolean

Indicates whether this Every starts with the given Every at the given index.

Indicates whether this Every starts with the given Every at the given index.

that

the Every slice to look for in this Every

offset

the index at which this Every is searched.

returns

true if this Every has that as a slice at the index offset, false otherwise.

119. #### final def startsWith[B](that: Every[B]): Boolean

Indicates whether this Every starts with the given Every.

Indicates whether this Every starts with the given Every.

that

the Every to test

returns

true if this collection has that as a prefix, false otherwise.

120. #### final def startsWith[B](that: GenSeq[B], offset: Int): Boolean

Indicates whether this Every starts with the given GenSeq at the given index.

Indicates whether this Every starts with the given GenSeq at the given index.

that

the GenSeq slice to look for in this Every

offset

the index at which this Every is searched.

returns

true if this Every has that as a slice at the index offset, false otherwise.

121. #### final def startsWith[B](that: GenSeq[B]): Boolean

Indicates whether this Every starts with the given GenSeq.

Indicates whether this Every starts with the given GenSeq.

that

the GenSeq slice to look for in this Every

returns

true if this Every has that as a prefix, false otherwise.

122. #### final def sum[U >: T](implicit num: Numeric[U]): U

The result of summing all the elements of this Every.

The result of summing all the elements of this Every.

This method can be invoked for any Every[T] for which an implicit Numeric[T] exists.

returns

the sum of all elements

123. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
124. #### final def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, T, Col[T]]): Col[T]

Converts this Every into a collection of type Col by copying all elements.

Converts this Every into a collection of type Col by copying all elements.

Col

the collection type to build.

returns

a new collection containing all elements of this Every.

125. #### final def toArray[U >: T](implicit classTag: ClassTag[U]): Array[U]

Converts this Every to an array.

Converts this Every to an array.

returns

an array containing all elements of this Every. A ClassTag must be available for the element type of this Every.

126. #### final def toBuffer[U >: T]: Buffer[U]

Converts this Every to a mutable buffer.

Converts this Every to a mutable buffer.

returns

a buffer containing all elements of this Every.

127. #### final def toIndexedSeq: IndexedSeq[T]

Converts this Every to an immutable IndexedSeq.

Converts this Every to an immutable IndexedSeq.

returns

an immutable IndexedSeq containing all elements of this Every.

128. #### final def toIterable: Iterable[T]

Converts this Every to an iterable collection.

Converts this Every to an iterable collection.

returns

an Iterable containing all elements of this Every.

129. #### final def toIterator: Iterator[T]

Returns an Iterator over the elements in this Every.

Returns an Iterator over the elements in this Every.

returns

an Iterator containing all elements of this Every.

130. #### final def toList: List[T]

Converts this Every to a list.

Converts this Every to a list.

returns

a list containing all elements of this Every.

131. #### final def toMap[K, V](implicit ev: <:<[T, (K, V)]): Map[K, V]

Converts this Every to a map.

Converts this Every to a map.

This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys.

returns

a map of type immutable.Map[K, V] containing all key/value pairs of type (K, V) of this Every.

132. #### final def toSeq: Seq[T]

Converts this Every to an immutable IndexedSeq.

Converts this Every to an immutable IndexedSeq.

returns

an immutable IndexedSeq containing all elements of this Every.

133. #### final def toSet[U >: T]: Set[U]

Converts this Every to a set.

Converts this Every to a set.

returns

a set containing all elements of this Every.

134. #### final def toStream: Stream[T]

Converts this Every to a stream.

Converts this Every to a stream.

returns

a stream containing all elements of this Every.

135. #### def toString(): String

Definition Classes
Function1 → AnyRef → Any
136. #### final def toTraversable: Traversable[T]

Converts this Every to an unspecified Traversable.

Converts this Every to an unspecified Traversable.

returns

a Traversable containing all elements of this Every.

137. #### final def toVector: Vector[T]

Converts this Every to a Vector.

Converts this Every to a Vector.

returns

a Vector containing all elements of this Every.

139. #### final def union[U >: T](that: GenSeq[U])(implicit cbf: CanBuildFrom[Vector[T], U, Vector[U]]): Every[U]

Produces a new Every that contains all elements of this Every and also all elements of a given GenSeq.

Produces a new Every that contains all elements of this Every and also all elements of a given GenSeq.

everyX union ys is equivalent to everyX ++ ys.

Another way to express this is that everyX union ys computes the order-presevring multi-set union of everyX and ys. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

that

returns

a new Every that contains all elements of this Every followed by all elements of that GenSeq.

140. #### final def union[U >: T](that: Every[U]): Every[U]

Produces a new Every that contains all elements of this Every and also all elements of a given Every.

Produces a new Every that contains all elements of this Every and also all elements of a given Every.

everyX union everyY is equivalent to everyX ++ everyY.

Another way to express this is that everyX union everyY computes the order-presevring multi-set union of everyX and everyY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

that

returns

a new Every that contains all elements of this Every followed by all elements of that.

141. #### final def unzip[L, R](implicit asPair: (T) ⇒ (L, R)): (Every[L], Every[R])

Converts this Every of pairs into two Everys of the first and second half of each pair.

Converts this Every of pairs into two Everys of the first and second half of each pair.

L

the type of the first half of the element pairs

R

the type of the second half of the element pairs

asPair

an implicit conversion that asserts that the element type of this Every is a pair.

returns

a pair of Everys, containing the first and second half, respectively, of each element pair of this Every.

142. #### final def unzip3[L, M, R](implicit asTriple: (T) ⇒ (L, M, R)): (Every[L], Every[M], Every[R])

Converts this Every of triples into three Everys of the first, second, and and third element of each triple.

Converts this Every of triples into three Everys of the first, second, and and third element of each triple.

L

the type of the first member of the element triples

R

the type of the third member of the element triples

asTriple

an implicit conversion that asserts that the element type of this Every is a triple.

returns

a triple of Everys, containing the first, second, and third member, respectively, of each element triple of this Every.

143. #### final def updated[U >: T](idx: Int, elem: U): Every[U]

A copy of this Every with one single replaced element.

A copy of this Every with one single replaced element.

idx

the position of the replacement

elem

the replacing element

returns

a copy of this Every with the element at position idx replaced by elem.

144. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
145. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
146. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
147. #### final def zipAll[O, U >: T](other: Iterable[O], thisElem: U, otherElem: O): Every[(U, O)]

Returns an Every formed from this Every and an iterable collection by combining corresponding elements in pairs.

Returns an Every formed from this Every and an iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements will be used to extend the shorter collection to the length of the longer.

other

the Iterable providing the second half of each result pair

thisElem

the element to be used to fill up the result if this Every is shorter than that Iterable.

returns

a new Every containing pairs consisting of corresponding elements of this Every and that. The length of the returned collection is the maximum of the lengths of this Every and that. If this Every is shorter than that, thisElem values are used to pad the result. If that is shorter than this Every, thatElem values are used to pad the result.

148. #### final def zipWithIndex: Every[(T, Int)]

Zips this Every with its indices.

Zips this Every with its indices.

returns

A new Every containing pairs consisting of all elements of this Every paired with their index. Indices start at 0.