Struct extendr_api::matrix::RArray

pub struct RArray<T, D> { /* fields omitted */ }

Wrapper for creating and using matrices and arrays.

use extendr_api::prelude::*;
test! {
    let matrix = RMatrix::new([
         1., 2., 3.,
         4., 5., 6.], 3, 2);
    let robj = r!(matrix);
    assert_eq!(robj.is_matrix(), true);
    assert_eq!(robj.nrows(), 3);
    assert_eq!(robj.ncols(), 2);

    let matrix2 : RMatrix<&[f64]> = robj.as_matrix().ok_or("error")?;
    assert_eq!(matrix2.data().len(), 6);
    assert_eq!(matrix2.nrows(), 3);
    assert_eq!(matrix2.ncols(), 2);
}

Implementations

impl<T, D> RArray<T, D>

pub fn data(&self) -> &T

Get the underlying data fro this array.

pub fn dim(&self) -> &D

Get the dimensions for this array.

impl<T> RArray<T, [usize; 1]>

pub fn new(data: T, nrows: usize) -> Self

Make a new vector type.

pub fn nrows(&self) -> usize

Get the number of rows.

impl<T> RArray<T, [usize; 2]>

pub fn new(data: T, nrows: usize, ncols: usize) -> Self

Create a new matrix wrapper.

pub fn nrows(&self) -> usize

Get the number of rows.

pub fn ncols(&self) -> usize

Get the number of columns.

impl<T> RArray<T, [usize; 3]>

pub fn new(data: T, nrows: usize, ncols: usize, nsub: usize) -> Self

Create a new matrix wrapper.

pub fn nrows(&self) -> usize

Get the number of rows.

pub fn ncols(&self) -> usize

Get the number of columns.

pub fn nsub(&self) -> usize

Get the number of submatrices.

Trait Implementations

impl<T: Debug, D: Debug> Debug for RArray<T, D>

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

Formats the value using the given formatter.

impl<T> From<RArray<T, [usize; 1]>> for Robj where
    T: Into<Robj>, 

fn from(array: RColumn<T>) -> Self

Performs the conversion.

impl<T> From<RArray<T, [usize; 2]>> for Robj where
    T: Into<Robj>, 

fn from(array: RArray<T, [usize; 2]>) -> Self

Performs the conversion.

impl<T> From<RArray<T, [usize; 3]>> for Robj where
    T: Into<Robj>, 

fn from(array: RArray<T, [usize; 3]>) -> Self

Performs the conversion.

impl<'a, T> FromRobj<'a> for RArray<&'a [T], [usize; 2]> where
    Robj: AsTypedSlice<'a, T>, 

fn from_robj(robj: &'a Robj) -> Result<Self, &'static str>

impl<T> Index<[usize; 2]> for RArray<T, [usize; 2]> where
    T: Index<usize>, 

type Output = <T as Index<usize>>::Output

The returned type after indexing.

fn index(&self, index: [usize; 2]) -> &Self::Output

Zero-based indexing in row, column order.

Panics if out of bounds.

use extendr_api::prelude::*;
test! {
    let matrix = RMatrix::new(vec![
         1., 2., 3.,
         4., 5., 6.], 3, 2);
    assert_eq!(matrix[[0, 0]], 1.);
    assert_eq!(matrix[[1, 0]], 2.);
    assert_eq!(matrix[[2, 1]], 6.);
}

impl<T> IndexMut<[usize; 2]> for RArray<T, [usize; 2]> where
    T: IndexMut<usize>, 

fn index_mut(&mut self, index: [usize; 2]) -> &mut Self::Output

Zero-based mutable indexing in row, column order.

Panics if out of bounds.

use extendr_api::prelude::*;
test! {
    let mut matrix = RMatrix::new(vec![0.; 6], 3, 2);
    matrix[[0, 0]] = 1.;
    matrix[[1, 0]] = 2.;
    matrix[[2, 0]] = 3.;
    assert_eq!(matrix, RMatrix::new(vec![1., 2., 3., 0., 0., 0.], 3, 2));
}

impl<T: PartialEq, D: PartialEq> PartialEq<RArray<T, D>> for RArray<T, D>

fn eq(&self, other: &RArray<T, D>) -> bool

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

fn ne(&self, other: &RArray<T, D>) -> bool

This method tests for !=.

impl<T, D> StructuralPartialEq for RArray<T, D>