Struct lance_linalg::matrix::MatrixView

pub struct MatrixView<T: ArrowFloatType> {
    pub transpose: bool,
    /* private fields */
}

A 2-D dense matrix on top of Arrow Arrays.

Fields

transpose: bool

Is this matrix transposed or not.

Implementations

impl<T: ArrowFloatType> MatrixView<T>

pub fn new( data: Arc<T::ArrayType>, num_columns: impl AsPrimitive<usize> ) -> Self

Create a MatrixView from a f32 data.

pub fn random(num_rows: usize, num_columns: usize) -> Self

Randomly initialize a matrix of shape (num_rows, num_columns).

pub fn identity(n: usize) -> Self

Create a identity matrix, with number of rows n.

pub fn num_rows(&self) -> usize

Number of rows in the matrix

pub fn num_columns(&self) -> usize

Number of the columns (dimension) in the matrix.

pub fn ndim(&self) -> usize

Number of dimensions.

pub fn data(&self) -> Arc<T::ArrayType>

pub fn row(&self, i: usize) -> Option<&[T::Native]>

Returns a row at index i. Returns None if the index is out of bound.

Panics if the matrix is transposed.

pub fn centroid(&self) -> Option<T::ArrayType>

Compute the centroid from all the rows. Returns None if this matrix is empty.

Panics if the matrix is transposed.

pub fn transpose(&self) -> Self

(Lazy) transpose of the matrix.

pub fn sample(&self, n: usize) -> Self

Sample n rows from the matrix.

pub fn sample_with(&self, n: usize, rng: impl Rng) -> Self

Sample n rows with a random generator.

pub fn iter(&self) -> MatrixRowIter<'_, T>

Trait Implementations

impl<T: ArrowFloatType> Clone for MatrixView<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ArrowFloatType> Debug for MatrixView<T>

where T::ArrayType: Debug,

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

Formats the value using the given formatter.

impl<T: ArrowFloatType + ArrowPrimitiveType> TryFrom<&FixedSizeListArray> for MatrixView<T>

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(value: &FixedSizeListArray) -> Result<Self>

Performs the conversion.