OrderedSequential
Ordered version of the Sequential trait. We explicitly implement Ordered[T] in addition to Ordering[T]. It would be quite possible to do comparisons using implicit conversions, but this does make things easier.
Type parameters
- T
-
the underlying type of this Sequential
Attributes
- Graph
-
- Supertypes
-
trait Ordered[T]trait Comparable[T]trait Ordering[T]trait PartialOrdering[T]trait Equiv[T]trait Serializabletrait Comparator[T]trait Sequential[T]class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class IncrementableSequential[T]
Members list
Type members
Inherited classlikes
This inner class defines comparison operators available for T.
This inner class defines comparison operators available for T.
It can't extend AnyVal because it is not a top-level class or a member of a statically accessible object.
Value parameters
- lhs
-
the left-hand side value for infix comparison operations
Attributes
- Inherited from:
- Ordering
- Supertypes
-
class Objecttrait Matchableclass Any
Value members
Inherited methods
Returns true if this is less than that
Returns true if this is less than that
Value parameters
- that
-
the instance to compare against
Attributes
- Inherited from:
- Ordered
Returns true if this is less than or equal to that.
Returns true if this is less than or equal to that.
Attributes
- Inherited from:
- Ordered
Returns true if this is greater than that.
Returns true if this is greater than that.
Value parameters
- that
-
the instance to compare against
Attributes
- Inherited from:
- Ordered
Returns true if this is greater than or equal to that.
Returns true if this is greater than or equal to that.
Attributes
- Inherited from:
- Ordered
Result of comparing this with operand that.
Result of comparing this with operand that.
Value parameters
- that
-
the instance to compare against
Attributes
- Inherited from:
- Ordered
Returns true if x == y in the ordering.
Returns true if x == y in the ordering.
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Definition Classes
-
Ordering -> PartialOrdering -> Equiv
- Inherited from:
- Ordering
Returns true if x > y in the ordering.
Returns true if x > y in the ordering.
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns true if x >= y in the ordering.
Returns true if x >= y in the ordering.
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns whether or not the other ordering is the opposite ordering of this one.
Returns whether or not the other ordering is the opposite ordering of this one.
Equivalent to other == this.reverse.
Implementations should only override this method if they are overriding reverse as well.
Value parameters
- other
-
the ordering to check
Attributes
- Returns
-
trueifotheris the reverse of this ordering,falseotherwise - Inherited from:
- Ordering
Returns true if x < y in the ordering.
Returns true if x < y in the ordering.
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns true if x <= y in the ordering.
Returns true if x <= y in the ordering.
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns x if x >= y, otherwise y.
Returns x if x >= y, otherwise y.
Type parameters
- U
-
a subtype of
T, used to preserve the specific type in the return value
Value parameters
- x
-
the first candidate value
- y
-
the second candidate value
Attributes
- Inherited from:
- Ordering
Returns x if x <= y, otherwise y.
Returns x if x <= y, otherwise y.
Type parameters
- U
-
a subtype of
T, used to preserve the specific type in the return value
Value parameters
- x
-
the first candidate value
- y
-
the second candidate value
Attributes
- Inherited from:
- Ordering
Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:
Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:
def compare[U, T: Ordering](x: U, y: U, f: U => T) = Ordering[T].compare(f(x), f(y))
Type parameters
- U
-
the type of the values to be ordered
Value parameters
- f
-
the function to extract a
Tvalue from aUvalue
Attributes
- Returns
-
an
Ordering[U]that orders values by applyingfand comparing the results using this ordering - Inherited from:
- Ordering
Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of others compare function.
Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of others compare function.
Value parameters
- other
-
an Ordering to use if this Ordering returns zero
Attributes
- Returns
-
an
Ordering[T]that uses this ordering first, falling back tootherwhen values are equal - Example
-
case class Pair(a: Int, b: Int) val pairOrdering = Ordering.by[Pair, Int](_.a) .orElse(Ordering.by[Pair, Int](_.b)) - Inherited from:
- Ordering
Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:
Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:
def compare[T, S: Ordering](x: T, y: T, f: T => S) = Ordering[S].compare(f(x), f(y))
This function is equivalent to passing the result of Ordering.by(f) to orElse.
Type parameters
- S
-
the type returned by the extraction function
f
Value parameters
- f
-
the function to extract a comparison key from a
Tvalue - ord
-
the implicit ordering for the extracted key type
S
Attributes
- Returns
-
an
Ordering[T]that uses this ordering first, falling back to comparing byfwhen values are equal - Example
-
case class Pair(a: Int, b: Int) val pairOrdering = Ordering.by[Pair, Int](_.a) .orElseBy[Int](_.b) - Inherited from:
- Ordering
Returns the opposite ordering of this one.
Returns the opposite ordering of this one.
Implementations overriding this method MUST override isReverseOf as well if they change the behavior at all (for example, caching does not require overriding it).
Attributes
- Returns
-
an
Ordering[T]that compares elements in the reverse order of this ordering - Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Returns whether a comparison between x and y is defined, and if so the result of compare(x, y).
Returns whether a comparison between x and y is defined, and if so the result of compare(x, y).
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Inherited from:
- Ordering
Inherited and Abstract methods
Result of comparing this with operand that.
Result of comparing this with operand that.
Implement this method to determine how instances of A will be sorted.
Returns x where:
-
x < 0whenthis < that -
x == 0whenthis == that -
x > 0whenthis > that
Value parameters
- that
-
the instance to compare against
Attributes
- Returns
-
an integer whose sign indicates the ordering relation between
thisandthat - Inherited from:
- Ordered
Returns an integer whose sign communicates how x compares to y.
Returns an integer whose sign communicates how x compares to y.
The result sign has the following meaning:
- negative if x < y
- positive if x > y
- zero otherwise (if x == y)
Value parameters
- x
-
the first value to compare
- y
-
the second value to compare
Attributes
- Returns
-
a negative integer, zero, or a positive integer as
xis less than, equal to, or greater thany - Inherited from:
- Ordering
Method to try to create a next instance.
Method to try to create a next instance.
Value parameters
- isSnapshot
-
(defaults to false) If true, then the next Sequential will be a snapshot. The expected behavior is that when isSnapshot changes from false to true, it will be accompanied by a change in sequence (where the new Sequential is ordered after this), otherwise not.
Attributes
- Returns
-
Try[T]
- Inherited from:
- Sequential
Implicits
Inherited implicits
This implicit method augments T with the comparison operators defined in scala.math.Ordering.Ops.
This implicit method augments T with the comparison operators defined in scala.math.Ordering.Ops.
Value parameters
- lhs
-
the value to enrich with ordering operators
Attributes
- Inherited from:
- Ordering