Struct RhaiMatrix 

pub struct RhaiMatrix(/* private fields */);

Wrapper around rhai::Array representing a matrix.

This type provides conversions between Rhai arrays and nalgebra::DMatrix.

Examples

use rhai::{Array, Dynamic};
use rhai_sci::matrix::RhaiMatrix;
let raw: Array = vec![
    Dynamic::from_array(vec![Dynamic::from_float(1.0), Dynamic::from_float(2.0)]),
    Dynamic::from_array(vec![Dynamic::from_float(3.0), Dynamic::from_float(4.0)]),
];
let matrix = RhaiMatrix::from_array(raw.clone());
assert_eq!(matrix.to_array().len(), raw.len());

Implementations

impl RhaiMatrix

pub fn from_array(arr: Array) -> Self

Construct a RhaiMatrix from a rhai::Array.

pub fn row_vector(data: Array) -> Self

Construct a RhaiMatrix representing a row vector (1×N).

Examples

use rhai::{Array, Dynamic};
use rhai_sci::matrix::RhaiMatrix;
let data: Array = vec![Dynamic::from_int(1), Dynamic::from_int(2)];
let row = RhaiMatrix::row_vector(data.clone());
assert!(row.as_row().is_some());

pub fn column_vector(data: Array) -> Self

Construct a RhaiMatrix representing a column vector (N×1).

Examples

use rhai::{Array, Dynamic};
use rhai_sci::matrix::RhaiMatrix;
let data: Array = vec![Dynamic::from_int(1), Dynamic::from_int(2)];
let column = RhaiMatrix::column_vector(data.clone());
assert!(column.as_column().is_some());

pub fn as_row(&self) -> Option<Self>

Return the matrix as a row vector (1×N), reshaping a column vector if necessary.

Returns None if the matrix is not 1×N or N×1.

Examples

use rhai::{Array, Dynamic};
use rhai_sci::matrix::RhaiMatrix;
let data: Array = vec![Dynamic::from_int(1), Dynamic::from_int(2)];
let column = RhaiMatrix::column_vector(data.clone());
let row = column.as_row().unwrap();
assert!(row.as_row().is_some());

pub fn as_column(&self) -> Option<Self>

Return the matrix as a column vector (N×1), reshaping a row vector if necessary.

Returns None if the matrix is not 1×N or N×1.

Examples

use rhai::{Array, Dynamic};
use rhai_sci::matrix::RhaiMatrix;
let data: Array = vec![Dynamic::from_int(1), Dynamic::from_int(2)];
let row = RhaiMatrix::row_vector(data.clone());
let column = row.as_column().unwrap();
assert!(column.as_column().is_some());

pub fn to_array(self) -> Array

Convert the matrix back into a rhai::Array.

pub fn to_dmatrix(&self) -> Result<DMatrix<FLOAT>, Box<EvalAltResult>>

Convert the matrix into a nalgebra::DMatrix.

Errors

Returns an error if any element is non-numeric or rows have differing lengths.

Panics

Panics if an integer value cannot be represented as FLOAT.

pub fn from_dmatrix(mat: &DMatrix<FLOAT>) -> Self

Create a RhaiMatrix from a nalgebra::DMatrix.

pub fn transpose(&self) -> Result<Self, Box<EvalAltResult>>

Transpose the matrix.

Errors

Returns an error if the matrix contains non-numeric values or rows of unequal length.

pub fn concat_h(&self, other: &Self) -> Result<Self, Box<EvalAltResult>>

Horizontally concatenate two matrices.

Examples

use rhai::{Array, Dynamic};
use rhai_sci::{matrix::RhaiMatrix, validation_functions::is_row_vector};
let left = RhaiMatrix::row_vector(vec![Dynamic::from_int(1), Dynamic::from_int(2)]);
let right = RhaiMatrix::row_vector(vec![Dynamic::from_int(3), Dynamic::from_int(4)]);
let combined = left.concat_h(&right).unwrap();
let mut arr = combined.to_array();
assert!(is_row_vector(&mut arr));

Errors

Returns an error if the matrices have differing row counts or contain non-numeric values.

pub fn concat_v(&self, other: &Self) -> Result<Self, Box<EvalAltResult>>

Vertically concatenate two matrices.

Examples

use rhai::{Array, Dynamic};
use rhai_sci::{matrix::RhaiMatrix, validation_functions::is_column_vector};
let top = RhaiMatrix::column_vector(vec![Dynamic::from_int(1), Dynamic::from_int(2)]);
let bottom = RhaiMatrix::column_vector(vec![Dynamic::from_int(3), Dynamic::from_int(4)]);
let combined = top.concat_v(&bottom).unwrap();
let mut arr = combined.to_array();
assert!(is_column_vector(&mut arr));

Errors

Returns an error if the matrices have differing column counts or contain non-numeric values.

Trait Implementations

impl Clone for RhaiMatrix

fn clone(&self) -> RhaiMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RhaiMatrix

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

Formats the value using the given formatter.