Struct Rcplx

#[repr(transparent)]
pub struct Rcplx(c64);

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.

Tuple Fields

0: c64

Implementations

impl Rcplx

pub fn new(re: f64, im: f64) -> Self

pub fn is_nan(&self) -> bool

pub fn is_infinite(&self) -> bool

pub fn re(&self) -> Rfloat

pub fn im(&self) -> Rfloat

Trait Implementations

impl Add<Complex<f64>> for Rcplx

fn add(self, rhs: c64) -> Self::Output

Add two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the + operator.

impl Add<Rcplx> for &Rcplx

fn add(self, rhs: Rcplx) -> Self::Output

Add two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the + operator.

impl Add<Rcplx> for c64

fn add(self, rhs: Rcplx) -> Self::Output

Add two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the + operator.

impl Add for Rcplx

fn add(self, rhs: Rcplx) -> Self::Output

Add two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the + operator.

impl AddAssign<Complex<f64>> for &mut Rcplx

fn add_assign(&mut self, other: c64)

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

impl AddAssign<Complex<f64>> for Rcplx

fn add_assign(&mut self, other: c64)

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

impl AddAssign<Rcplx> for &mut Rcplx

fn add_assign(&mut self, other: Rcplx)

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

impl AddAssign<Rcplx> for Option<c64>

fn add_assign(&mut self, other: Rcplx)

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

impl AddAssign for Rcplx

fn add_assign(&mut self, other: Rcplx)

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

impl<'a> AsTypedSlice<'a, Rcplx> for Robj

where Self: 'a,

fn as_typed_slice(&self) -> Option<&'a [Rcplx]>

fn as_typed_slice_mut(&mut self) -> Option<&'a mut [Rcplx]>

impl CanBeNA for Rcplx

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

fn is_na(&self) -> bool

Return true is the is a NA value.

fn na() -> Self

Construct a NA.

impl Clone for Rcplx

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rcplx

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Rcplx

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

fn default() -> Self

Returns the “default value” for a type.

impl Div<Complex<f64>> for Rcplx

fn div(self, rhs: c64) -> Self::Output

Divide two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the / operator.

impl Div<Rcplx> for &Rcplx

fn div(self, rhs: Rcplx) -> Self::Output

Divide two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the / operator.

impl Div<Rcplx> for c64

fn div(self, rhs: Rcplx) -> Self::Output

Divide two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the / operator.

impl Div for Rcplx

fn div(self, rhs: Rcplx) -> Self::Output

Divide two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the / operator.

impl DivAssign<Complex<f64>> for &mut Rcplx

fn div_assign(&mut self, other: c64)

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

impl DivAssign<Complex<f64>> for Rcplx

fn div_assign(&mut self, other: c64)

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

impl DivAssign<Rcplx> for &mut Rcplx

fn div_assign(&mut self, other: Rcplx)

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

impl DivAssign<Rcplx> for Option<c64>

fn div_assign(&mut self, other: Rcplx)

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

impl DivAssign for Rcplx

fn div_assign(&mut self, other: Rcplx)

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

impl From<&Complex<f64>> for Rcplx

fn from(v: &c64) -> Self

Converts to this type from the input type.

impl From<(Rfloat, Rfloat)> for Rcplx

fn from(val: (Rfloat, Rfloat)) -> Self

Converts to this type from the input type.

impl From<(f64, f64)> for Rcplx

fn from(val: (f64, f64)) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for Rcplx

fn from(v: c64) -> Self

Converts to this type from the input type.

impl From<Option<&Complex<f64>>> for Rcplx

fn from(v: Option<&c64>) -> Self

Converts to this type from the input type.

impl From<Option<Complex<f64>>> for Rcplx

fn from(v: Option<c64>) -> Self

Converts to this type from the input type.

impl From<Rcomplex> for Rcplx

fn from(val: Rcomplex) -> Self

Converts to this type from the input type.

impl From<Rcplx> for Option<c64>

fn from(val: Rcplx) -> Self

Converts to this type from the input type.

impl From<Rfloat> for Rcplx

fn from(val: Rfloat) -> Self

Converts to this type from the input type.

impl From<f64> for Rcplx

fn from(val: f64) -> Self

Converts to this type from the input type.

impl FromIterator<Rcplx> for Complexes

fn from_iter<T: IntoIterator<Item = Rcplx>>(iter: T) -> Self

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

impl Mul<Complex<f64>> for Rcplx

fn mul(self, rhs: c64) -> Self::Output

Multiply two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the * operator.

impl Mul<Rcplx> for &Rcplx

fn mul(self, rhs: Rcplx) -> Self::Output

Multiply two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the * operator.

impl Mul<Rcplx> for c64

fn mul(self, rhs: Rcplx) -> Self::Output

Multiply two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the * operator.

impl Mul for Rcplx

fn mul(self, rhs: Rcplx) -> Self::Output

Multiply two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the * operator.

impl MulAssign<Complex<f64>> for &mut Rcplx

fn mul_assign(&mut self, other: c64)

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

impl MulAssign<Complex<f64>> for Rcplx

fn mul_assign(&mut self, other: c64)

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

impl MulAssign<Rcplx> for &mut Rcplx

fn mul_assign(&mut self, other: Rcplx)

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

impl MulAssign<Rcplx> for Option<c64>

fn mul_assign(&mut self, other: Rcplx)

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

impl MulAssign for Rcplx

fn mul_assign(&mut self, other: Rcplx)

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

impl Neg for &Rcplx

fn neg(self) -> Self::Output

Negate a Rcplx value.

type Output = Rcplx

The resulting type after applying the - operator.

impl Neg for Rcplx

fn neg(self) -> Self::Output

Negate a Rcplx value.

type Output = Rcplx

The resulting type after applying the - operator.

impl PartialEq<Complex<f64>> for Rcplx

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

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

NA always fails.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Rcplx> for c64

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f64> for Rcplx

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Rcplx

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Scalar<Complex<f64>> for Rcplx

fn inner(&self) -> c64

fn new(val: c64) -> Self

impl Sub<Complex<f64>> for Rcplx

fn sub(self, rhs: c64) -> Self::Output

Subtract two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the - operator.

impl Sub<Rcplx> for &Rcplx

fn sub(self, rhs: Rcplx) -> Self::Output

Subtract two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the - operator.

impl Sub<Rcplx> for c64

fn sub(self, rhs: Rcplx) -> Self::Output

Subtract two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the - operator.

impl Sub for Rcplx

fn sub(self, rhs: Rcplx) -> Self::Output

Subtract two Rcplx values or an option of c64.

type Output = Rcplx

The resulting type after applying the - operator.

impl SubAssign<Complex<f64>> for &mut Rcplx

fn sub_assign(&mut self, other: c64)

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

impl SubAssign<Complex<f64>> for Rcplx

fn sub_assign(&mut self, other: c64)

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

impl SubAssign<Rcplx> for &mut Rcplx

fn sub_assign(&mut self, other: Rcplx)

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

impl SubAssign<Rcplx> for Option<c64>

fn sub_assign(&mut self, other: Rcplx)

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

impl SubAssign for Rcplx

fn sub_assign(&mut self, other: Rcplx)

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

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

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

Yields NA on overflow if NAs present.

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

impl Sum for Rcplx

fn sum<I: Iterator<Item = Rcplx>>(iter: I) -> Rcplx

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());
}

impl ToVectorValue for &Rcplx

fn sexptype() -> SEXPTYPE

fn to_complex(&self) -> Rcomplex

fn to_real(&self) -> f64

where Self: Sized,

fn to_integer(&self) -> i32

where Self: Sized,

fn to_logical(&self) -> i32

where Self: Sized,

fn to_raw(&self) -> u8

where Self: Sized,

fn to_sexp(&self) -> SEXP

where Self: Sized,

impl ToVectorValue for Rcplx

fn sexptype() -> SEXPTYPE

fn to_complex(&self) -> Rcomplex

fn to_real(&self) -> f64

where Self: Sized,

fn to_integer(&self) -> i32

where Self: Sized,

fn to_logical(&self) -> i32

where Self: Sized,

fn to_raw(&self) -> u8

where Self: Sized,

fn to_sexp(&self) -> SEXP

where Self: Sized,

impl TryFrom<&Robj> for Rcplx

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: &Robj) -> Result<Self>

Performs the conversion.

impl TryFrom<Robj> for Rcplx

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: Robj) -> Result<Self>

Performs the conversion.

impl Copy for Rcplx