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.numerical/HasValue/HasValueDouble$

HasValueDouble$

com.phasmidsoftware.number.core.numerical.HasValue.HasValueDouble$
object HasValueDouble$ extends HasValueDouble

An implicit object extending HasValueDouble, providing functionality for working with Double values within the HasValue type class.

This object offers default implementations of operations such as rendering, scaling, normalization, and fractional operations for Double values.

As an implicit object, it allows for automatic resolution of the HasValue type class for Double values in relevant contexts.

Attributes

Graph
Supertypes
trait IeeeOrdering
trait DoubleIsFractional
trait HasValue[Double]
trait Fractional[Double]
trait Numeric[Double]
trait Ordering[Double]
trait PartialOrdering[Double]
trait Equiv[Double]
trait Serializable
trait Comparator[Double]
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

override def abs(x: Double): Double

Attributes

Definition Classes
DoubleIsFractional -> Numeric
Inherited from:
DoubleIsFractional
def compare(x: Double, y: Double): 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:
IeeeOrdering
def div(x: Double, y: Double): Double

Attributes

Inherited from:
DoubleIsFractional
override def equiv(x: Double, y: Double): 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
IeeeOrdering -> Ordering -> PartialOrdering -> Equiv
Inherited from:
IeeeOrdering
def fromDouble(x: Double): Double

Converts the input Double value and returns it as-is.

Converts the input Double value and returns it as-is.

Value parameters

x

the Double value to be processed.

Attributes

Returns

the same Double value provided as input.

Inherited from:
HasValueDouble
def fromInt(x: Int): Double

Attributes

Inherited from:
DoubleIsFractional
override def gt(x: Double, y: Double): 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
IeeeOrdering -> Ordering -> PartialOrdering
Inherited from:
IeeeOrdering
override def gteq(x: Double, y: Double): 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
IeeeOrdering -> Ordering -> PartialOrdering
Inherited from:
IeeeOrdering
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: Double, y: Double): 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
IeeeOrdering -> Ordering -> PartialOrdering
Inherited from:
IeeeOrdering
override def lteq(x: Double, y: Double): 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
IeeeOrdering -> Ordering -> PartialOrdering
Inherited from:
IeeeOrdering
override def max[U <: Double](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

Definition Classes
IeeeOrdering -> Ordering
Inherited from:
IeeeOrdering
override def min[U <: Double](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

Definition Classes
IeeeOrdering -> Ordering
Inherited from:
IeeeOrdering
def minus(x: Double, y: Double): Double

Attributes

Inherited from:
DoubleIsFractional
def multiply[U : HasValue, V : HasValue](u: U, v: V): Double

Method to multiply a U by a V, resulting in a T.

Method to multiply a U by a V, resulting in a T.

Type parameters

U

the type of u.

V

the type of v.

Value parameters

u

a U value.

v

a V value.

Attributes

Returns

a T whose value is u * v.

Inherited from:
HasValue
def negate(x: Double): Double

Attributes

Inherited from:
DoubleIsFractional
def normalize(x: Double): Double

Method to yield a "normalized" version of x. For a Numeric object, this implies the absolute value, i.e. with no sign.

Method to yield a "normalized" version of x. For a Numeric object, this implies the absolute value, i.e. with no sign.

Value parameters

x

the value.

Attributes

Returns

the value, without any sign.

Inherited from:
HasValueDouble
def on[U](f: U => Double): 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: Double

Attributes

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

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: Double => S)(implicit ord: Ordering[S]): Ordering[Double]

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[Double]

Attributes

Inherited from:
DoubleIsFractional
def plus(x: Double, y: Double): Double

Attributes

Inherited from:
DoubleIsFractional
def render(t: Double): String

Renders a Double value as a string, choosing between fixed-point or scientific notation representation based on specific criteria.

Renders a Double value as a string, choosing between fixed-point or scientific notation representation based on specific criteria.

Value parameters

t

the Double value to be rendered.

Attributes

Returns

a string representation of the Double value in either fixed-point or scientific notation format.

Inherited from:
HasValueDouble
override def reverse: Ordering[Double]

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[Double]

Attributes

Inherited from:
Comparator
def scale(t: Double, f: Double): Double

Scale the parameter x by the constant factor f.

Scale the parameter x by the constant factor f.

Value parameters

f

a factor.

t

a value.

Attributes

Returns

x * f.

Inherited from:
HasValueDouble
override def sign(x: Double): Double

Attributes

Definition Classes
DoubleIsFractional -> Numeric
Inherited from:
DoubleIsFractional
def thenComparing[U <: Comparable[_ >: U <: <FromJavaObject>]](x$0: Function[_ >: Double <: <FromJavaObject>, _ <: U]): Comparator[Double]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
DoubleIsFractional
def toDouble(x: Double): Double

Attributes

Inherited from:
DoubleIsFractional
def toFloat(x: Double): Float

Attributes

Inherited from:
DoubleIsFractional
def toInt(x: Double): Int

Attributes

Inherited from:
DoubleIsFractional
def toLong(x: Double): Long

Attributes

Inherited from:
DoubleIsFractional
def tryCompare(x: Double, y: Double): 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: Double

Attributes

Inherited from:
Numeric

Deprecated and Inherited methods

def signum(x: Double): Int

Attributes

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

Implicits

Inherited implicits

implicit override def mkNumericOps(lhs: Double): FractionalOps

Attributes

Definition Classes
Fractional -> Numeric
Inherited from:
Fractional
implicit def mkOrderingOps(lhs: Double): 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