Number - Scala Mathematical Library
1.10.6
API
Generated with
Number - Scala Mathematical Library/com.phasmidsoftware.number/com.phasmidsoftware.number.core/com.phasmidsoftware.number.core.inner/Rational/RationalFractional

RationalFractional

com.phasmidsoftware.number.core.inner.Rational.RationalFractional
object RationalFractional extends RationalIsFractional

Implicit object which bestows all the Ordering, Numeric, etc. functionality to a Rational.

Attributes

Graph
Supertypes
trait Fractional[Rational]
trait Numeric[Rational]
trait Ordering[Rational]
trait PartialOrdering[Rational]
trait Equiv[Rational]
trait Serializable
trait Comparator[Rational]
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited classlikes

class FractionalOps(lhs: Fractional.this.T) extends NumericOps

Attributes

Inherited from:
Fractional
Supertypes
class Fractional.this.NumericOps
class Object
trait Matchable
class Any
class NumericOps(lhs: Numeric.this.T)

Attributes

Inherited from:
Numeric
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Fractional.this.FractionalOps
class OrderingOps(lhs: Ordering.this.T)

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 Object
trait Matchable
class Any

Value members

Inherited methods

def abs(x: Rational): Rational

Attributes

Inherited from:
Numeric
def compare(x: Rational, y: Rational): Int

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 x is less than, equal to, or greater than y

Inherited from:
RationalIsOrdering
def div(x: Rational, y: Rational): Rational

Divides one Rational number by another.

Divides one Rational number by another.

Value parameters

x

the numerator Rational number

y

the denominator Rational number

Attributes

Returns

the resulting Rational number after division

Inherited from:
RationalIsFractional
override def equiv(x: Rational, y: Rational): Boolean

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
def fromInt(x: Int): Rational

Creates a Rational instance from an integer.

Creates a Rational instance from an integer.

Value parameters

x

the integer value to be converted to a Rational

Attributes

Returns

the corresponding Rational representation of the given integer

Inherited from:
RationalIsNumeric
override def gt(x: Rational, y: Rational): Boolean

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
override def gteq(x: Rational, y: Rational): Boolean

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
def isReverseOf(other: Ordering[_]): Boolean

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

true if other is the reverse of this ordering, false otherwise

Inherited from:
Ordering
override def lt(x: Rational, y: Rational): Boolean

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
override def lteq(x: Rational, y: Rational): Boolean

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
def max[U <: Rational](x: U, y: U): U

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
def min[U <: Rational](x: U, y: U): U

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
def minus(x: Rational, y: Rational): Rational

Subtracts two Rational numbers.

Subtracts two Rational numbers.

Value parameters

x

the first Rational number

y

the second Rational number to be subtracted from the first

Attributes

Returns

the result of subtracting y from x as a Rational number

Inherited from:
RationalIsNumeric
def negate(x: Rational): Rational

Negates the given Rational number by inverting the sign of its numerator.

Negates the given Rational number by inverting the sign of its numerator.

Value parameters

x

the Rational number to be negated

Attributes

Returns

a new Rational number that is the negation of the input

Inherited from:
RationalIsNumeric
def on[U](f: U => Rational): Ordering[U]

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 T value from a U value

Attributes

Returns

an Ordering[U] that orders values by applying f and comparing the results using this ordering

Inherited from:
Ordering
def one: Rational

Attributes

Inherited from:
Numeric
def orElse(other: Ordering[Rational]): Ordering[Rational]

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 to other when 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
def orElseBy[S](f: Rational => S)(implicit ord: Ordering[S]): Ordering[Rational]

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 T value

ord

the implicit ordering for the extracted key type S

Attributes

Returns

an Ordering[T] that uses this ordering first, falling back to comparing by f when values are equal

Example
case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElseBy[Int](_.b)
Inherited from:
Ordering
def parseString(str: String): Option[Rational]

Parses the provided string to an optional Rational value.

Parses the provided string to an optional Rational value.

Value parameters

str

the string representation of the rational number to be parsed

Attributes

Returns

an Option containing the parsed Rational if successful, or None if parsing fails

Inherited from:
RationalIsNumeric
def plus(x: Rational, y: Rational): Rational

Adds two Rational numbers together.

Adds two Rational numbers together.

Value parameters

x

the first Rational number

y

the second Rational number

Attributes

Returns

the sum of the two Rational numbers

Inherited from:
RationalIsNumeric
override def reverse: Ordering[Rational]

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
def reversed(): Comparator[Rational]

Attributes

Inherited from:
Comparator
def sign(x: Rational): Rational

Attributes

Inherited from:
Numeric
def thenComparing[U <: Comparable[_ >: U <: <FromJavaObject>]](x$0: Function[_ >: Rational <: <FromJavaObject>, _ <: U]): Comparator[Rational]

Attributes

Inherited from:
Comparator
def thenComparing[U <: <FromJavaObject>](x$0: Function[_ >: Rational <: <FromJavaObject>, _ <: U], x$1: Comparator[_ >: U <: <FromJavaObject>]): Comparator[Rational]

Attributes

Inherited from:
Comparator
def thenComparing(x$0: Comparator[_ >: Rational <: <FromJavaObject>]): Comparator[Rational]

Attributes

Inherited from:
Comparator
def thenComparingDouble(x$0: ToDoubleFunction[_ >: Rational <: <FromJavaObject>]): Comparator[Rational]

Attributes

Inherited from:
Comparator
def thenComparingInt(x$0: ToIntFunction[_ >: Rational <: <FromJavaObject>]): Comparator[Rational]

Attributes

Inherited from:
Comparator
def thenComparingLong(x$0: ToLongFunction[_ >: Rational <: <FromJavaObject>]): Comparator[Rational]

Attributes

Inherited from:
Comparator
def times(x: Rational, y: Rational): Rational

Multiplies two Rational numbers and returns the resulting Rational.

Multiplies two Rational numbers and returns the resulting Rational.

Value parameters

x

the first Rational number

y

the second Rational number

Attributes

Returns

the product of the two Rational numbers

Inherited from:
RationalIsNumeric
def toDouble(x: Rational): Double

Converts a Rational number to a Double.

Converts a Rational number to a Double.

Value parameters

x

the Rational number to be converted to a Double

Attributes

Returns

the Double representation of the given Rational number

Inherited from:
RationalIsNumeric
def toFloat(x: Rational): Float

Converts a given Rational number to its equivalent Float representation.

Converts a given Rational number to its equivalent Float representation.

Value parameters

x

the Rational number to be converted.

Attributes

Returns

the Float representation of the given Rational number.

Inherited from:
RationalIsNumeric
def toInt(x: Rational): Int

Converts a Rational number to an Int by truncating towards zero.

Converts a Rational number to an Int by truncating towards zero.

Value parameters

x

the Rational number to be converted to an Int

Attributes

Returns

the integer representation of the Rational value

Inherited from:
RationalIsNumeric
def toLong(x: Rational): Long

Converts a Rational number to its Long representation.

Converts a Rational number to its Long representation.

Value parameters

x

the Rational number to convert

Attributes

Returns

the Long value corresponding to the given Rational

Inherited from:
RationalIsNumeric
def tryCompare(x: Rational, y: Rational): Some[Int]

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
def zero: Rational

Attributes

Inherited from:
Numeric

Deprecated and Inherited methods

def signum(x: Rational): Int

Attributes

Deprecated
[Since version 2.13.0] use `sign` method instead
Inherited from:
Numeric

Implicits

Inherited implicits

implicit override def mkNumericOps(lhs: Rational): FractionalOps

Attributes

Definition Classes
Fractional -> Numeric
Inherited from:
Fractional
implicit def mkOrderingOps(lhs: Rational): OrderingOps

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
Generated with