Struct extendr_api::scalar::Rfloat[][src]

#[repr(C)]
pub struct Rfloat(pub f64);
Expand description

Rfloat is a wrapper for f64 in the context of an R’s integer vector.

Rfloat has a special NA value, obtained from R headers via R_NaReal.

Rfloat has the same footprint as an f64 value allowing us to use it in zero copy slices.

Tuple Fields

0: f64

Implementations

Get underlying value.

Trait Implementations

Add two Rfloat values or an option of f64.

The resulting type after applying the + operator.

Add two Rfloat values or an option of f64.

The resulting type after applying the + operator.

Add two Rfloat values or an option of f64.

The resulting type after applying the + operator.

Add two Rfloat values or an option of f64.

The resulting type after applying the + operator.

Add two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Add two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Add two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Add two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Add two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

use extendr_api::prelude::*;
test! {
    assert!((<Rfloat>::na()).is_na());
}

Return true is the is a NA value.

Construct a NA.

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Debug format.

use extendr_api::prelude::*;
test! {
    assert_eq!(<Rfloat>::default(), <f64>::default());
}

Returns the “default value” for a type. Read more

Divide two Rfloat values or an option of f64.

The resulting type after applying the / operator.

Divide two Rfloat values or an option of f64.

The resulting type after applying the / operator.

Divide two Rfloat values or an option of f64.

The resulting type after applying the / operator.

Divide two Rfloat values or an option of f64.

The resulting type after applying the / operator.

Divide two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Divide two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Divide two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Divide two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Divide two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

A more generalised iterator collector for small vectors. Generates a non-ALTREP vector.

Multiply two Rfloat values or an option of f64.

The resulting type after applying the * operator.

Multiply two Rfloat values or an option of f64.

The resulting type after applying the * operator.

Multiply two Rfloat values or an option of f64.

The resulting type after applying the * operator.

Multiply two Rfloat values or an option of f64.

The resulting type after applying the * operator.

Multiply two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Multiply two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Multiply two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Multiply two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Multiply two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Negate a Rfloat value.

The resulting type after applying the - operator.

Negate a Rfloat value.

The resulting type after applying the - operator.

use extendr_api::prelude::*;
test! {
    assert!(<Rfloat>::default().eq(&<Rfloat>::default()));
    assert!(!<Rfloat>::na().eq(&<Rfloat>::na()));
}

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

This method tests for !=.

use extendr_api::prelude::*;
test! {
    assert!(<Rfloat>::default().eq(&<f64>::default()));
}

NA always fails.

This method tests for !=.

use extendr_api::prelude::*;
test! {
    assert!(<Rfloat>::default().eq(&<f64>::default()));
}

NA always fails.

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Subtract two Rfloat values or an option of f64.

The resulting type after applying the - operator.

Subtract two Rfloat values or an option of f64.

The resulting type after applying the - operator.

Subtract two Rfloat values or an option of f64.

The resulting type after applying the - operator.

Subtract two Rfloat values or an option of f64.

The resulting type after applying the - operator.

Subtract two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Subtract two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Subtract two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Subtract two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Subtract two Rfloat values or an option of f64, modifying the left-hand side in place. Overflows to NA.

Yields NA on overflow if NAs present.

use extendr_api::prelude::*;
use std::iter::Sum;
test! {
    let x = (0..100).map(|x| Rfloat::default());
    assert_eq!(<Rfloat as Sum>::sum(x), <Rfloat>::default());
}

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.