logo
pub struct Rcplx(_);
Expand description

Rcplx is a wrapper for f64 in the context of an R’s complex vector.

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

Rcplx has the same footprint as R’s complex value allowing us to use it in zero copy slices.

Implementations

Get underlying value.

Trait Implementations

Add two Rcplx values or an option of c64.

The resulting type after applying the + operator.

Add two Rcplx values or an option of c64.

The resulting type after applying the + operator.

Add two Rcplx values or an option of c64.

The resulting type after applying the + operator.

Add two Rcplx values or an option of c64.

The resulting type after applying the + operator.

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

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

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

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

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

use extendr_api::prelude::*;
test! {
    assert!((<Rcplx>::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

Formats the value using the given formatter. Read more

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

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

Divide two Rcplx values or an option of c64.

The resulting type after applying the / operator.

Divide two Rcplx values or an option of c64.

The resulting type after applying the / operator.

Divide two Rcplx values or an option of c64.

The resulting type after applying the / operator.

Divide two Rcplx values or an option of c64.

The resulting type after applying the / operator.

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

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

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

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

Divide two Rcplx values or an option of c64, 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.

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 Rcplx values or an option of c64.

The resulting type after applying the * operator.

Multiply two Rcplx values or an option of c64.

The resulting type after applying the * operator.

Multiply two Rcplx values or an option of c64.

The resulting type after applying the * operator.

Multiply two Rcplx values or an option of c64.

The resulting type after applying the * operator.

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

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

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

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

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

Negate a Rcplx value.

The resulting type after applying the - operator.

Negate a Rcplx value.

The resulting type after applying the - operator.

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

NA always fails.

This method tests for !=.

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

NA always fails.

This method tests for !=.

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

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

This method tests for !=.

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

This method tests for !=.

Subtract two Rcplx values or an option of c64.

The resulting type after applying the - operator.

Subtract two Rcplx values or an option of c64.

The resulting type after applying the - operator.

Subtract two Rcplx values or an option of c64.

The resulting type after applying the - operator.

Subtract two Rcplx values or an option of c64.

The resulting type after applying the - operator.

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

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

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

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

Subtract two Rcplx values or an option of c64, 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| Rcplx::default());
    assert_eq!(<Rcplx as Sum>::sum(x), <Rcplx>::default());
}

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.

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

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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.