Type Alias RMatrix

Source

pub type RMatrix<T> = RArray<T, 2>;

Aliased Type§

pub struct RMatrix<T> {
    robj: Robj,
    _data: PhantomData<T>,
}

Fields§

§robj: Robj

Owning Robj (probably should be a Pin).

§_data: PhantomData<T>

Data type of the n-array

Implementations§

Source §

impl<T> RMatrix<T>
where T: ToVectorValue, Robj: for<'a> AsTypedSlice<'a, T>,

Source

pub fn new(nrow: usize, ncol: usize) -> Self

Returns an RMatrix with dimensions according to nrow and ncol, with arbitrary entries. To initialize a matrix containing only NA values, use RMatrix::new_with_na.

Source §

impl<T> RMatrix<T>
where T: ToVectorValue + CanBeNA, Robj: for<'a> AsTypedSlice<'a, T>,

Source

pub fn new_with_na(nrow: usize, ncol: usize) -> Self

Returns an RMatrix with dimensions according to nrow and ncol, with all entries set to NA.

Note that since Raw does not have an NA representation in R, this method is not implemented for Rbyte.

Source §

pub fn new_matrix<F: Clone + FnMut(usize, usize) -> T>( nrows: usize, ncols: usize, f: F, ) -> Self

Create a new matrix wrapper.

§Arguments

nrows - the number of rows the returned matrix will have
ncols - the number of columns the returned matrix will have
f - a function that will be called for each entry of the matrix in order to populate it with values. It must return a scalar value that can be converted to an R scalar, such as i32, u32, or f64, i.e. see ToVectorValue. It accepts two arguments:
- r - the current row of the entry we are creating
- c - the current column of the entry we are creating

Source

pub fn nrows(&self) -> usize

Get the number of rows.

Source

pub fn ncols(&self) -> usize

Get the number of columns.

Source

pub fn row_iter(&self) -> RowIter<'_, T> ⓘ

Returns an iterator over the rows of the matrix.

This method is experimental and likely to be unstable for a while.

Each row is returned as an RColumn<T> containing a copy of the row’s values in row-major order.

use extendr_api::prelude::*;
test! {
    let matrix = RMatrix::new_matrix(3, 2, |r, c| [
        [1., 2., 3.],
        [4., 5., 6.]][c][r]);
    let rows: Vec<_> = matrix.row_iter().collect();
    assert_eq!(rows.len(), 3);
    assert_eq!(rows[0].data(), &[1., 4.]);
    assert_eq!(rows[1].data(), &[2., 5.]);
    assert_eq!(rows[2].data(), &[3., 6.]);
}

Source

pub fn col_iter(&self) -> ColIter<'_, T> ⓘ

Returns an iterator over the columns of the matrix.

This method is experimental and likely to be unstable for a while.

Each column is returned as an RColumn<T> containing a copy of the column’s values.

use extendr_api::prelude::*;
test! {
    let matrix = RMatrix::new_matrix(3, 2, |r, c| [
        [1., 2., 3.],
        [4., 5., 6.]][c][r]);
    let cols: Vec<_> = matrix.col_iter().collect();
    assert_eq!(cols.len(), 2);
    assert_eq!(cols[0].data(), &[1., 2., 3.]);
    assert_eq!(cols[1].data(), &[4., 5., 6.]);
}