Scala Standard Library2.13.3 < Back


# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other packages exist. See the complete list on the right.

  Additional parts of the standard library are shipped as separate libraries. These include:

  - `scala.reflect` - Scala's reflection API (scala-reflect.jar)
  - `scala.xml` - XML parsing, manipulation, and serialization (scala-xml.jar)
  - `scala.collection.parallel` - Parallel collections (scala-parallel-collections.jar)
  - `scala.util.parsing` - Parser combinators (scala-parser-combinators.jar)
  - `scala.swing` - A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)

  #### Automatic imports

  Identifiers in the scala package and the `scala.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package math

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  All methods forward to java.lang.Math unless otherwise noted.

  Definition Classes
    scala
  See also

    java.lang.Math

- BigDecimal
- BigInt
- Equiv
- Fractional
- Integral
- LowPriorityEquiv
- LowPriorityOrderingImplicits
- Numeric
- Ordered
- Ordering
- PartialOrdering
- PartiallyOrdered
- ScalaNumericAnyConversions
- ScalaNumericConversions

t

scala.math

# PartiallyOrdered

###

#### trait PartiallyOrdered[+A] extends Any

A class for partially ordered data.

Source
  PartiallyOrdered.scala

Linear Supertypes
Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. PartiallyOrdered
2. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  type AsPartiallyOrdered[B] = (B) => PartiallyOrdered[B]

### Abstract Value Members

1.  abstract def getClass(): Class[_ <: AnyRef]

   Returns the runtime class representation of the object.

   Returns the runtime class representation of the object.

   returns

     a class object corresponding to the runtime type of the receiver.

   Definition Classes
     Any
2.  abstract def tryCompareTo[B >: A](that: B)(implicit arg0: AsPartiallyOrdered[B]): Option[Int]

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`. Returns `None` if operands are not comparable. If operands are comparable, returns `Some(x)` where

   - `x < 0` iff `this < that`
   - `x == 0` iff `this == that`
   - `x > 0` iff `this > that`

### Concrete Value Members

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

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Definition Classes
     Any
2.  final def ##: Int

   Equivalent to `x.hashCode` except for boxed numeric types and `null`.

   Equivalent to `x.hashCode` except for boxed numeric types and `null`. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

   returns

     a hash value consistent with ==

   Definition Classes
     Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from PartiallyOrdered[A] toany2stringadd[PartiallyOrdered[A]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (PartiallyOrdered[A], B)
   Implicit
     This member is added by an implicit conversion from PartiallyOrdered[A] toArrowAssoc[PartiallyOrdered[A]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  def <[B >: A](that: B)(implicit arg0: AsPartiallyOrdered[B]): Boolean
6.  def <=[B >: A](that: B)(implicit arg0: AsPartiallyOrdered[B]): Boolean
7.  final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality. The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   Definition Classes
     Any
8.  def >[B >: A](that: B)(implicit arg0: AsPartiallyOrdered[B]): Boolean
9.  def >=[B >: A](that: B)(implicit arg0: AsPartiallyOrdered[B]): Boolean
10.  final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type `T0`.

    Cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression `1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression `List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

      the receiver object.

    Definition Classes
      Any
    Exceptions thrown

      `ClassCastException` if the receiver object is not an instance of the erasure of type `T0`.

11.  def ensuring(cond: (PartiallyOrdered[A]) => Boolean, msg: => Any): PartiallyOrdered[A]
    Implicit
      This member is added by an implicit conversion from PartiallyOrdered[A] toEnsuring[PartiallyOrdered[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: (PartiallyOrdered[A]) => Boolean): PartiallyOrdered[A]
    Implicit
      This member is added by an implicit conversion from PartiallyOrdered[A] toEnsuring[PartiallyOrdered[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def ensuring(cond: Boolean, msg: => Any): PartiallyOrdered[A]
    Implicit
      This member is added by an implicit conversion from PartiallyOrdered[A] toEnsuring[PartiallyOrdered[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: Boolean): PartiallyOrdered[A]
    Implicit
      This member is added by an implicit conversion from PartiallyOrdered[A] toEnsuring[PartiallyOrdered[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def equals(arg0: Any): Boolean

    Compares the receiver object (`this`) with the argument object (`that`) for equivalence.

    Compares the receiver object (`this`) with the argument object (`that`) for equivalence.

    Any implementation of this method should be an equivalence relation:

    - It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`.
    - It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
    - It is transitive: for any instances `x`, `y`, and `z` of type `Any` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override `hashCode` to ensure that objects which are "equal" (`o1.equals(o2)` returns `true`) hash to the same scala.Int. (`o1.hashCode.equals(o2.hashCode)`).

    returns

      `true` if the receiver object is equivalent to the argument; `false` otherwise.

    Definition Classes
      Any
16.  def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit
      This member is added by an implicit conversion from PartiallyOrdered[A] toStringFormat[PartiallyOrdered[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()
17.  def hashCode(): Int

    Calculate a hash code value for the object.

    Calculate a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (`o1.hashCode.equals(o2.hashCode)`) yet not be equal (`o1.equals(o2)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) that they have identical hash codes (`o1.hashCode.equals(o2.hashCode)`). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the `equals` method.

    returns

      the hash code value for this object.

    Definition Classes
      Any
18.  final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is `T0`.

    Test whether the dynamic type of the receiver object is `T0`.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression `1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    Definition Classes
      Any
19.  def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    Definition Classes
      Any

### Deprecated Value Members

1.  def →[B](y: B): (PartiallyOrdered[A], B)
   Implicit
     This member is added by an implicit conversion from PartiallyOrdered[A] toArrowAssoc[PartiallyOrdered[A]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromPartiallyOrdered[A] to any2stringadd[PartiallyOrdered[A]]

### Inherited by implicit conversion StringFormat fromPartiallyOrdered[A] to StringFormat[PartiallyOrdered[A]]

### Inherited by implicit conversion Ensuring fromPartiallyOrdered[A] to Ensuring[PartiallyOrdered[A]]

### Inherited by implicit conversion ArrowAssoc fromPartiallyOrdered[A] to ArrowAssoc[PartiallyOrdered[A]]

### Ungrouped