Primitive Type f64

The 64-bit floating point type.

See also the std::f64 module.

Methods

impl f64

pub fn floor(self) -> f64

Returns the largest integer less than or equal to a number.

Examples

let f = 3.7_f64;
let g = 3.0_f64;
let h = -3.7_f64;

assert_eq!(f.floor(), 3.0);
assert_eq!(g.floor(), 3.0);
assert_eq!(h.floor(), -4.0);

pub fn ceil(self) -> f64

Returns the smallest integer greater than or equal to a number.

Examples

let f = 3.01_f64;
let g = 4.0_f64;

assert_eq!(f.ceil(), 4.0);
assert_eq!(g.ceil(), 4.0);

pub fn round(self) -> f64

Returns the nearest integer to a number. Round half-way cases away from 0.0.

Examples

let f = 3.3_f64;
let g = -3.3_f64;

assert_eq!(f.round(), 3.0);
assert_eq!(g.round(), -3.0);

pub fn trunc(self) -> f64

Returns the integer part of a number.

Examples

let f = 3.7_f64;
let g = 3.0_f64;
let h = -3.7_f64;

assert_eq!(f.trunc(), 3.0);
assert_eq!(g.trunc(), 3.0);
assert_eq!(h.trunc(), -3.0);

pub fn fract(self) -> f64

Returns the fractional part of a number.

Examples

let x = 3.5_f64;
let y = -3.5_f64;
let abs_difference_x = (x.fract() - 0.5).abs();
let abs_difference_y = (y.fract() - (-0.5)).abs();

assert!(abs_difference_x < 1e-10);
assert!(abs_difference_y < 1e-10);

pub fn abs(self) -> f64

Computes the absolute value of self. Returns NAN if the number is NAN.

Examples

use std::f64;

let x = 3.5_f64;
let y = -3.5_f64;

let abs_difference_x = (x.abs() - x).abs();
let abs_difference_y = (y.abs() - (-y)).abs();

assert!(abs_difference_x < 1e-10);
assert!(abs_difference_y < 1e-10);

assert!(f64::NAN.abs().is_nan());

pub fn signum(self) -> f64

Returns a number that represents the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NAN if the number is NAN

Examples

use std::f64;

let f = 3.5_f64;

assert_eq!(f.signum(), 1.0);
assert_eq!(f64::NEG_INFINITY.signum(), -1.0);

assert!(f64::NAN.signum().is_nan());

#[must_use]

pub fn copysign(self, sign: f64) -> f64

Returns a number composed of the magnitude of self and the sign of sign.

Equal to self if the sign of self and sign are the same, otherwise equal to -self. If self is a NAN, then a NAN with the sign of sign is returned.

Examples

use std::f64;

let f = 3.5_f64;

assert_eq!(f.copysign(0.42), 3.5_f64);
assert_eq!(f.copysign(-0.42), -3.5_f64);
assert_eq!((-f).copysign(0.42), 3.5_f64);
assert_eq!((-f).copysign(-0.42), -3.5_f64);

assert!(f64::NAN.copysign(1.0).is_nan());

pub fn mul_add(self, a: f64, b: f64) -> f64

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

Using mul_add can be more performant than an unfused multiply-add if the target architecture has a dedicated fma CPU instruction.

Examples

let m = 10.0_f64;
let x = 4.0_f64;
let b = 60.0_f64;

// 100.0
let abs_difference = (m.mul_add(x, b) - (m*x + b)).abs();

assert!(abs_difference < 1e-10);

pub fn div_euclid(self, rhs: f64) -> f64

🔬 This is a nightly-only experimental API. (euclidean_division #49048)

Calculates Euclidean division, the matching method for rem_euclid.

This computes the integer n such that self = n * rhs + self.rem_euclid(rhs). In other words, the result is self / rhs rounded to the integer n such that self >= n * rhs.

Examples

#![feature(euclidean_division)]
let a: f64 = 7.0;
let b = 4.0;
assert_eq!(a.div_euclid(b), 1.0); // 7.0 > 4.0 * 1.0
assert_eq!((-a).div_euclid(b), -2.0); // -7.0 >= 4.0 * -2.0
assert_eq!(a.div_euclid(-b), -1.0); // 7.0 >= -4.0 * -1.0
assert_eq!((-a).div_euclid(-b), 2.0); // -7.0 >= -4.0 * 2.0

pub fn rem_euclid(self, rhs: f64) -> f64

🔬 This is a nightly-only experimental API. (euclidean_division #49048)

Calculates the least nonnegative remainder of self (mod rhs).

In particular, the return value r satisfies 0.0 <= r < rhs.abs() in most cases. However, due to a floating point round-off error it can result in r == rhs.abs(), violating the mathematical definition, if self is much smaller than rhs.abs() in magnitude and self < 0.0. This result is not an element of the function's codomain, but it is the closest floating point number in the real numbers and thus fulfills the property self == self.div_euclid(rhs) * rhs + self.rem_euclid(rhs) approximatively.

Examples

#![feature(euclidean_division)]
let a: f64 = 7.0;
let b = 4.0;
assert_eq!(a.rem_euclid(b), 3.0);
assert_eq!((-a).rem_euclid(b), 1.0);
assert_eq!(a.rem_euclid(-b), 3.0);
assert_eq!((-a).rem_euclid(-b), 1.0);
// limitation due to round-off error
assert!((-std::f64::EPSILON).rem_euclid(3.0) != 0.0);

pub fn powi(self, n: i32) -> f64

Raises a number to an integer power.

Using this function is generally faster than using powf

Examples

let x = 2.0_f64;
let abs_difference = (x.powi(2) - x*x).abs();

assert!(abs_difference < 1e-10);

pub fn powf(self, n: f64) -> f64

Raises a number to a floating point power.

Examples

let x = 2.0_f64;
let abs_difference = (x.powf(2.0) - x*x).abs();

assert!(abs_difference < 1e-10);

pub fn sqrt(self) -> f64

Takes the square root of a number.

Returns NaN if self is a negative number.

Examples

let positive = 4.0_f64;
let negative = -4.0_f64;

let abs_difference = (positive.sqrt() - 2.0).abs();

assert!(abs_difference < 1e-10);
assert!(negative.sqrt().is_nan());

pub fn exp(self) -> f64

Returns e^(self), (the exponential function).

Examples

let one = 1.0_f64;
// e^1
let e = one.exp();

// ln(e) - 1 == 0
let abs_difference = (e.ln() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn exp2(self) -> f64

Returns 2^(self).

Examples

let f = 2.0_f64;

// 2^2 - 4 == 0
let abs_difference = (f.exp2() - 4.0).abs();

assert!(abs_difference < 1e-10);

pub fn ln(self) -> f64

Returns the natural logarithm of the number.

Examples

let one = 1.0_f64;
// e^1
let e = one.exp();

// ln(e) - 1 == 0
let abs_difference = (e.ln() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn log(self, base: f64) -> f64

Returns the logarithm of the number with respect to an arbitrary base.

The result may not be correctly rounded owing to implementation details; self.log2() can produce more accurate results for base 2, and self.log10() can produce more accurate results for base 10.

Examples

let five = 5.0_f64;

// log5(5) - 1 == 0
let abs_difference = (five.log(5.0) - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn log2(self) -> f64

Returns the base 2 logarithm of the number.

Examples

let two = 2.0_f64;

// log2(2) - 1 == 0
let abs_difference = (two.log2() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn log10(self) -> f64

Returns the base 10 logarithm of the number.

Examples

let ten = 10.0_f64;

// log10(10) - 1 == 0
let abs_difference = (ten.log10() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn abs_sub(self, other: f64) -> f64

Deprecated since 1.10.0:

you probably meant (self - other).abs(): this operation is (self - other).max(0.0) except that abs_sub also propagates NaNs (also known as fdim in C). If you truly need the positive difference, consider using that expression or the C function fdim, depending on how you wish to handle NaN (please consider filing an issue describing your use-case too).

The positive difference of two numbers.

• If self <= other: 0:0
• Else: self - other

Examples

let x = 3.0_f64;
let y = -3.0_f64;

let abs_difference_x = (x.abs_sub(1.0) - 2.0).abs();
let abs_difference_y = (y.abs_sub(1.0) - 0.0).abs();

assert!(abs_difference_x < 1e-10);
assert!(abs_difference_y < 1e-10);

pub fn cbrt(self) -> f64

Takes the cubic root of a number.

Examples

let x = 8.0_f64;

// x^(1/3) - 2 == 0
let abs_difference = (x.cbrt() - 2.0).abs();

assert!(abs_difference < 1e-10);

pub fn hypot(self, other: f64) -> f64

Calculates the length of the hypotenuse of a right-angle triangle given legs of length x and y.

Examples

let x = 2.0_f64;
let y = 3.0_f64;

// sqrt(x^2 + y^2)
let abs_difference = (x.hypot(y) - (x.powi(2) + y.powi(2)).sqrt()).abs();

assert!(abs_difference < 1e-10);

pub fn sin(self) -> f64

Computes the sine of a number (in radians).

Examples

use std::f64;

let x = f64::consts::PI/2.0;

let abs_difference = (x.sin() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn cos(self) -> f64

Computes the cosine of a number (in radians).

Examples

use std::f64;

let x = 2.0*f64::consts::PI;

let abs_difference = (x.cos() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn tan(self) -> f64

Computes the tangent of a number (in radians).

Examples

use std::f64;

let x = f64::consts::PI/4.0;
let abs_difference = (x.tan() - 1.0).abs();

assert!(abs_difference < 1e-14);

pub fn asin(self) -> f64

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

Examples

use std::f64;

let f = f64::consts::PI / 2.0;

// asin(sin(pi/2))
let abs_difference = (f.sin().asin() - f64::consts::PI / 2.0).abs();

assert!(abs_difference < 1e-10);

pub fn acos(self) -> f64

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

Examples

use std::f64;

let f = f64::consts::PI / 4.0;

// acos(cos(pi/4))
let abs_difference = (f.cos().acos() - f64::consts::PI / 4.0).abs();

assert!(abs_difference < 1e-10);

pub fn atan(self) -> f64

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

Examples

let f = 1.0_f64;

// atan(tan(1))
let abs_difference = (f.tan().atan() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn atan2(self, other: f64) -> f64

Computes the four quadrant arctangent of self (y) and other (x) in radians.

• x = 0, y = 0: 0
• x >= 0: arctan(y/x) -> [-pi/2, pi/2]
• y >= 0: arctan(y/x) + pi -> (pi/2, pi]
• y < 0: arctan(y/x) - pi -> (-pi, -pi/2)

Examples

use std::f64;

let pi = f64::consts::PI;
// Positive angles measured counter-clockwise
// from positive x axis
// -pi/4 radians (45 deg clockwise)
let x1 = 3.0_f64;
let y1 = -3.0_f64;

// 3pi/4 radians (135 deg counter-clockwise)
let x2 = -3.0_f64;
let y2 = 3.0_f64;

let abs_difference_1 = (y1.atan2(x1) - (-pi/4.0)).abs();
let abs_difference_2 = (y2.atan2(x2) - 3.0*pi/4.0).abs();

assert!(abs_difference_1 < 1e-10);
assert!(abs_difference_2 < 1e-10);

pub fn sin_cos(self) -> (f64, f64)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

Examples

use std::f64;

let x = f64::consts::PI/4.0;
let f = x.sin_cos();

let abs_difference_0 = (f.0 - x.sin()).abs();
let abs_difference_1 = (f.1 - x.cos()).abs();

assert!(abs_difference_0 < 1e-10);
assert!(abs_difference_1 < 1e-10);

pub fn exp_m1(self) -> f64

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

Examples

let x = 7.0_f64;

// e^(ln(7)) - 1
let abs_difference = (x.ln().exp_m1() - 6.0).abs();

assert!(abs_difference < 1e-10);

pub fn ln_1p(self) -> f64

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

Examples

use std::f64;

let x = f64::consts::E - 1.0;

// ln(1 + (e - 1)) == ln(e) == 1
let abs_difference = (x.ln_1p() - 1.0).abs();

assert!(abs_difference < 1e-10);

pub fn sinh(self) -> f64

Hyperbolic sine function.

Examples

use std::f64;

let e = f64::consts::E;
let x = 1.0_f64;

let f = x.sinh();
// Solving sinh() at 1 gives `(e^2-1)/(2e)`
let g = (e*e - 1.0)/(2.0*e);
let abs_difference = (f - g).abs();

assert!(abs_difference < 1e-10);

pub fn cosh(self) -> f64

Hyperbolic cosine function.

Examples

use std::f64;

let e = f64::consts::E;
let x = 1.0_f64;
let f = x.cosh();
// Solving cosh() at 1 gives this result
let g = (e*e + 1.0)/(2.0*e);
let abs_difference = (f - g).abs();

// Same result
assert!(abs_difference < 1.0e-10);

pub fn tanh(self) -> f64

Hyperbolic tangent function.

Examples

use std::f64;

let e = f64::consts::E;
let x = 1.0_f64;

let f = x.tanh();
// Solving tanh() at 1 gives `(1 - e^(-2))/(1 + e^(-2))`
let g = (1.0 - e.powi(-2))/(1.0 + e.powi(-2));
let abs_difference = (f - g).abs();

assert!(abs_difference < 1.0e-10);

pub fn asinh(self) -> f64

Inverse hyperbolic sine function.

Examples

let x = 1.0_f64;
let f = x.sinh().asinh();

let abs_difference = (f - x).abs();

assert!(abs_difference < 1.0e-10);

pub fn acosh(self) -> f64

Inverse hyperbolic cosine function.

Examples

let x = 1.0_f64;
let f = x.cosh().acosh();

let abs_difference = (f - x).abs();

assert!(abs_difference < 1.0e-10);

pub fn atanh(self) -> f64

Inverse hyperbolic tangent function.

Examples

use std::f64;

let e = f64::consts::E;
let f = e.tanh().atanh();

let abs_difference = (f - e).abs();

assert!(abs_difference < 1.0e-10);

pub fn clamp(self, min: f64, max: f64) -> f64

🔬 This is a nightly-only experimental API. (clamp #44095)

Restrict a value to a certain interval unless it is NaN.

Returns max if self is greater than max, and min if self is less than min. Otherwise this returns self.

Not that this function returns NaN if the initial value was NaN as well.

Panics

Panics if min > max, min is NaN, or max is NaN.

Examples

#![feature(clamp)]
assert!((-3.0f64).clamp(-2.0, 1.0) == -2.0);
assert!((0.0f64).clamp(-2.0, 1.0) == 0.0);
assert!((2.0f64).clamp(-2.0, 1.0) == 1.0);
assert!((std::f64::NAN).clamp(-2.0, 1.0).is_nan());

impl f64

pub fn is_nan(self) -> bool

Returns true if this value is NaN.

use std::f64;

let nan = f64::NAN;
let f = 7.0_f64;

assert!(nan.is_nan());
assert!(!f.is_nan());

pub fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity, and false otherwise.

use std::f64;

let f = 7.0f64;
let inf = f64::INFINITY;
let neg_inf = f64::NEG_INFINITY;
let nan = f64::NAN;

assert!(!f.is_infinite());
assert!(!nan.is_infinite());

assert!(inf.is_infinite());
assert!(neg_inf.is_infinite());

pub fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

use std::f64;

let f = 7.0f64;
let inf: f64 = f64::INFINITY;
let neg_inf: f64 = f64::NEG_INFINITY;
let nan: f64 = f64::NAN;

assert!(f.is_finite());

assert!(!nan.is_finite());
assert!(!inf.is_finite());
assert!(!neg_inf.is_finite());

pub fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

use std::f64;

let min = f64::MIN_POSITIVE; // 2.2250738585072014e-308f64
let max = f64::MAX;
let lower_than_min = 1.0e-308_f64;
let zero = 0.0f64;

assert!(min.is_normal());
assert!(max.is_normal());

assert!(!zero.is_normal());
assert!(!f64::NAN.is_normal());
assert!(!f64::INFINITY.is_normal());
// Values between `0` and `min` are Subnormal.
assert!(!lower_than_min.is_normal());

pub fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

use std::num::FpCategory;
use std::f64;

let num = 12.4_f64;
let inf = f64::INFINITY;

assert_eq!(num.classify(), FpCategory::Normal);
assert_eq!(inf.classify(), FpCategory::Infinite);

pub fn is_sign_positive(self) -> bool

Returns true if self has a positive sign, including +0.0, NaNs with positive sign bit and positive infinity.

let f = 7.0_f64;
let g = -7.0_f64;

assert!(f.is_sign_positive());
assert!(!g.is_sign_positive());

pub fn is_sign_negative(self) -> bool

Returns true if self has a negative sign, including -0.0, NaNs with negative sign bit and negative infinity.

let f = 7.0_f64;
let g = -7.0_f64;

assert!(!f.is_sign_negative());
assert!(g.is_sign_negative());

pub fn recip(self) -> f64

Takes the reciprocal (inverse) of a number, 1/x.

let x = 2.0_f64;
let abs_difference = (x.recip() - (1.0/x)).abs();

assert!(abs_difference < 1e-10);

pub fn to_degrees(self) -> f64

Converts radians to degrees.

use std::f64::consts;

let angle = consts::PI;

let abs_difference = (angle.to_degrees() - 180.0).abs();

assert!(abs_difference < 1e-10);

pub fn to_radians(self) -> f64

Converts degrees to radians.

use std::f64::consts;

let angle = 180.0_f64;

let abs_difference = (angle.to_radians() - consts::PI).abs();

assert!(abs_difference < 1e-10);

pub fn max(self, other: f64) -> f64

Returns the maximum of the two numbers.

let x = 1.0_f64;
let y = 2.0_f64;

assert_eq!(x.max(y), y);

If one of the arguments is NaN, then the other argument is returned.

pub fn min(self, other: f64) -> f64

Returns the minimum of the two numbers.

let x = 1.0_f64;
let y = 2.0_f64;

assert_eq!(x.min(y), x);

If one of the arguments is NaN, then the other argument is returned.

pub fn to_bits(self) -> u64

Raw transmutation to u64.

This is currently identical to transmute::<f64, u64>(self) on all platforms.

See from_bits for some discussion of the portability of this operation (there are almost no issues).

Note that this function is distinct from as casting, which attempts to preserve the numeric value, and not the bitwise value.

Examples

assert!((1f64).to_bits() != 1f64 as u64); // to_bits() is not casting!
assert_eq!((12.5f64).to_bits(), 0x4029000000000000);

pub fn from_bits(v: u64) -> f64

Raw transmutation from u64.

This is currently identical to transmute::<u64, f64>(v) on all platforms. It turns out this is incredibly portable, for two reasons:

• Floats and Ints have the same endianness on all supported platforms.
• IEEE-754 very precisely specifies the bit layout of floats.

However there is one caveat: prior to the 2008 version of IEEE-754, how to interpret the NaN signaling bit wasn't actually specified. Most platforms (notably x86 and ARM) picked the interpretation that was ultimately standardized in 2008, but some didn't (notably MIPS). As a result, all signaling NaNs on MIPS are quiet NaNs on x86, and vice-versa.

Rather than trying to preserve signaling-ness cross-platform, this implementation favours preserving the exact bits. This means that any payloads encoded in NaNs will be preserved even if the result of this method is sent over the network from an x86 machine to a MIPS one.

If the results of this method are only manipulated by the same architecture that produced them, then there is no portability concern.

If the input isn't NaN, then there is no portability concern.

If you don't care about signalingness (very likely), then there is no portability concern.

Note that this function is distinct from as casting, which attempts to preserve the numeric value, and not the bitwise value.

Examples

use std::f64;
let v = f64::from_bits(0x4029000000000000);
let difference = (v - 12.5).abs();
assert!(difference <= 1e-5);

Trait Implementations

impl Neg for f64

type Output = f64

The resulting type after applying the - operator.

fn neg(self) -> f64

Performs the unary - operation.

impl<'_> Neg for &'_ f64

type Output = <f64 as Neg>::Output

The resulting type after applying the - operator.

fn neg(self) -> <f64 as Neg>::Output

Performs the unary - operation.

impl<'_, '_> Div<&'_ f64> for &'_ f64

type Output = <f64 as Div<f64>>::Output

The resulting type after applying the / operator.

fn div(self, other: &f64) -> <f64 as Div<f64>>::Output

Performs the / operation.

impl<'a> Div<f64> for &'a f64

type Output = <f64 as Div<f64>>::Output

The resulting type after applying the / operator.

fn div(self, other: f64) -> <f64 as Div<f64>>::Output

Performs the / operation.

impl Div<f64> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: f64) -> f64

Performs the / operation.

impl<'_> Div<&'_ f64> for f64

type Output = <f64 as Div<f64>>::Output

The resulting type after applying the / operator.

fn div(self, other: &f64) -> <f64 as Div<f64>>::Output

Performs the / operation.

impl From<u32> for f64

Converts u32 to f64 losslessly.

fn from(small: u32) -> f64

Performs the conversion.

impl From<i32> for f64

Converts i32 to f64 losslessly.

fn from(small: i32) -> f64

Performs the conversion.

impl From<f32> for f64

Converts f32 to f64 losslessly.

fn from(small: f32) -> f64

Performs the conversion.

impl From<i16> for f64

Converts i16 to f64 losslessly.

fn from(small: i16) -> f64

Performs the conversion.

impl From<u16> for f64

Converts u16 to f64 losslessly.

fn from(small: u16) -> f64

Performs the conversion.

impl From<i8> for f64

Converts i8 to f64 losslessly.

fn from(small: i8) -> f64

Performs the conversion.

impl From<u8> for f64

Converts u8 to f64 losslessly.

fn from(small: u8) -> f64

Performs the conversion.

impl<'_, '_> Rem<&'_ f64> for &'_ f64

type Output = <f64 as Rem<f64>>::Output

The resulting type after applying the % operator.

fn rem(self, other: &f64) -> <f64 as Rem<f64>>::Output

Performs the % operation.

impl<'a> Rem<f64> for &'a f64

type Output = <f64 as Rem<f64>>::Output

The resulting type after applying the % operator.

fn rem(self, other: f64) -> <f64 as Rem<f64>>::Output

Performs the % operation.

impl<'_> Rem<&'_ f64> for f64

type Output = <f64 as Rem<f64>>::Output

The resulting type after applying the % operator.

fn rem(self, other: &f64) -> <f64 as Rem<f64>>::Output

Performs the % operation.

impl Rem<f64> for f64

The remainder from the division of two floats.

The remainder has the same sign as the dividend and is computed as: x - (x / y).trunc() * y.

Examples

let x: f32 = 50.50;
let y: f32 = 8.125;
let remainder = x - (x / y).trunc() * y;

// The answer to both operations is 1.75
assert_eq!(x % y, remainder);

type Output = f64

The resulting type after applying the % operator.

fn rem(self, other: f64) -> f64

Performs the % operation.

impl<'_> Mul<&'_ f64> for f64

type Output = <f64 as Mul<f64>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &f64) -> <f64 as Mul<f64>>::Output

Performs the * operation.

impl<'a> Mul<f64> for &'a f64

type Output = <f64 as Mul<f64>>::Output

The resulting type after applying the * operator.

fn mul(self, other: f64) -> <f64 as Mul<f64>>::Output

Performs the * operation.

impl Mul<f64> for f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, other: f64) -> f64

Performs the * operation.

impl<'_, '_> Mul<&'_ f64> for &'_ f64

type Output = <f64 as Mul<f64>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &f64) -> <f64 as Mul<f64>>::Output

Performs the * operation.

impl UpperExp for f64

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Sum<&'a f64> for f64

fn sum<I>(iter: I) -> f64 where
    I: Iterator<Item = &'a f64>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl Sum<f64> for f64

fn sum<I>(iter: I) -> f64 where
    I: Iterator<Item = f64>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl PartialOrd<f64> for f64

fn partial_cmp(&self, other: &f64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &f64) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &f64) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn ge(&self, other: &f64) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

fn gt(&self, other: &f64) -> bool

This method tests greater than (for self and other) and is used by the > operator.

impl MulAssign<f64> for f64

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl<'_> MulAssign<&'_ f64> for f64

fn mul_assign(&mut self, other: &f64)

Performs the *= operation.

impl<'_> Sub<&'_ f64> for f64

type Output = <f64 as Sub<f64>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &f64) -> <f64 as Sub<f64>>::Output

Performs the - operation.

impl<'_, '_> Sub<&'_ f64> for &'_ f64

type Output = <f64 as Sub<f64>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &f64) -> <f64 as Sub<f64>>::Output

Performs the - operation.

impl<'a> Sub<f64> for &'a f64

type Output = <f64 as Sub<f64>>::Output

The resulting type after applying the - operator.

fn sub(self, other: f64) -> <f64 as Sub<f64>>::Output

Performs the - operation.

impl Sub<f64> for f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: f64) -> f64

Performs the - operation.

impl Default for f64

fn default() -> f64

Returns the default value of 0.0

impl Clone for f64

fn clone(&self) -> f64

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl RemAssign<f64> for f64

fn rem_assign(&mut self, other: f64)

Performs the %= operation.

impl<'_> RemAssign<&'_ f64> for f64

fn rem_assign(&mut self, other: &f64)

Performs the %= operation.

impl Debug for f64

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'_, '_> Add<&'_ f64> for &'_ f64

type Output = <f64 as Add<f64>>::Output

The resulting type after applying the + operator.

fn add(self, other: &f64) -> <f64 as Add<f64>>::Output

Performs the + operation.

impl<'_> Add<&'_ f64> for f64

type Output = <f64 as Add<f64>>::Output

The resulting type after applying the + operator.

fn add(self, other: &f64) -> <f64 as Add<f64>>::Output

Performs the + operation.

impl Add<f64> for f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, other: f64) -> f64

Performs the + operation.

impl<'a> Add<f64> for &'a f64

type Output = <f64 as Add<f64>>::Output

The resulting type after applying the + operator.

fn add(self, other: f64) -> <f64 as Add<f64>>::Output

Performs the + operation.

impl SubAssign<f64> for f64

fn sub_assign(&mut self, other: f64)

Performs the -= operation.

impl<'_> SubAssign<&'_ f64> for f64

fn sub_assign(&mut self, other: &f64)

Performs the -= operation.

impl Copy for f64

impl PartialEq<f64> for f64

fn eq(&self, other: &f64) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &f64) -> bool

This method tests for !=.

impl LowerExp for f64

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for f64

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Product<&'a f64> for f64

fn product<I>(iter: I) -> f64 where
    I: Iterator<Item = &'a f64>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Product<f64> for f64

fn product<I>(iter: I) -> f64 where
    I: Iterator<Item = f64>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl DivAssign<f64> for f64

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl<'_> DivAssign<&'_ f64> for f64

fn div_assign(&mut self, other: &f64)

Performs the /= operation.

impl FromStr for f64

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<f64, ParseFloatError>

Converts a string in base 10 to a float. Accepts an optional decimal exponent.

This function accepts strings such as

• '3.14'
• '-3.14'
• '2.5E10', or equivalently, '2.5e10'
• '2.5E-10'
• '5.'
• '.5', or, equivalently, '0.5'
• 'inf', '-inf', 'NaN'

Leading and trailing whitespace represent an error.

Grammar

All strings that adhere to the following EBNF grammar will result in an Ok being returned:

Float  ::= Sign? ( 'inf' | 'NaN' | Number )
Number ::= ( Digit+ |
             Digit+ '.' Digit* |
             Digit* '.' Digit+ ) Exp?
Exp    ::= [eE] Sign? Digit+
Sign   ::= [+-]
Digit  ::= [0-9]

Known bugs

In some situations, some strings that should create a valid float instead return an error. See issue #31407 for details.

Arguments

• src - A string

Return value

Err(ParseFloatError) if the string did not represent a valid number. Otherwise, Ok(n) where n is the floating-point number represented by src.

impl<'_> AddAssign<&'_ f64> for f64

fn add_assign(&mut self, other: &f64)

Performs the += operation.

impl AddAssign<f64> for f64

fn add_assign(&mut self, other: f64)

Performs the += operation.