Struct BlockData 

pub struct BlockData { /* private fields */ }

Implementations

impl BlockData

pub fn new(rows: usize, cols: usize, data: &[f64]) -> Self

pub fn from_data(data: DMatrix<f64>, dtype: BlockDataType) -> Self

pub fn from_element(nrows: usize, ncols: usize, scalar: f64) -> Self

pub fn from_scalar(scalar: f64) -> Self

pub fn from_row_slice(nrows: usize, ncols: usize, data: &[f64]) -> Self

pub fn from_bytes(byte_data: &[u8]) -> Self

pub fn scalar_sizeof(scalar: f64, block: &BlockData) -> Self

pub fn from_vector(data: &[f64]) -> Self

pub fn from_matrix(matrix_slice: &[&[f64]]) -> Self

pub fn zeros_sizeof(block: &BlockData) -> Self

pub fn ones_sizeof(block: &BlockData) -> Self

pub fn scalar_from_bool(value: bool) -> Self

pub fn fix_non_finite(&mut self)

pub fn slice(&mut self, r0: usize, c0: usize, rows: usize, cols: usize) -> Self

pub fn as_col_slice(&self) -> &[f64]

pub fn set(&mut self, index: usize, value: f64)

pub fn at(&self, index: usize) -> f64

pub fn ref_at(&self, index: usize) -> &f64

pub fn ref_at_mut(&mut self, index: usize) -> &mut f64

pub fn at_rc(&self, r: usize, c: usize) -> f64

pub fn get_type(&self) -> BlockDataType

pub fn set_type(&mut self, new_type: BlockDataType)

pub fn scalar(&self) -> f64

pub fn get_data(&self) -> &DMatrix<f64>

pub fn set_data(&mut self, data: DMatrix<f64>)

pub fn maybe_reset(&mut self, reset_signal: &BlockData)

pub fn compare(&self, other: &BlockData) -> BlockTypeRelationship

pub fn vector(&self) -> DMatrix<f64>

pub fn boolean(&self) -> Self

pub fn norm(&self) -> f64

pub fn vector_magnitude(&self) -> Self

pub fn vector_magnitude_rows(&self) -> Self

pub fn any(&self) -> bool

pub fn all(&self) -> bool

pub fn set_scalar(&mut self, new_scalar_value: f64)

pub fn set_bytes(&mut self, byte_data: &[u8])

pub fn set_scalar_bool(&mut self, value: bool)

pub fn nrows(&self) -> usize

pub fn ncols(&self) -> usize

pub fn size(&self) -> (usize, usize)

pub fn n_elements(&self) -> usize

pub fn same_size(&self, other: &BlockData) -> bool

pub fn inner_dims_same(&self, other: &BlockData) -> bool

pub fn component_mul(&self, other: &BlockData) -> Self

pub fn component_set(&mut self, condition: &BlockData, assign: &BlockData)

pub fn component_or(first: &BlockData, other: &BlockData) -> Self

pub fn component_and(first: &BlockData, other: &BlockData) -> Self

pub fn component_bitand(&self, rhs: &BlockData) -> Self

pub fn component_bitor(&self, rhs: &BlockData) -> Self

pub fn component_bitxor(&self, rhs: &BlockData) -> Self

pub fn component_lshift(&self, bits: i32) -> Self

pub fn component_rshift(&self, bits: i32) -> Self

pub fn component_bitnot(&self) -> Self

pub fn component_eq(first: &BlockData, other: &BlockData) -> Self

pub fn component_neq(first: &BlockData, other: &BlockData) -> Self

pub fn component_gt(first: &BlockData, other: &BlockData) -> Self

pub fn component_gte(first: &BlockData, other: &BlockData) -> Self

pub fn component_lt(first: &BlockData, other: &BlockData) -> Self

pub fn component_lte(first: &BlockData, other: &BlockData) -> Self

pub fn powf(&self, coefficient: &BlockData) -> Self

pub fn sign(&self) -> Self

pub fn abs(&self) -> Self

pub fn transpose(&self) -> Self

pub fn determinant(&self) -> Self

pub fn cross(&self, other: &BlockData) -> Self

pub fn dot(&self, other: &BlockData) -> Self

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

pub fn pseudo_inverse(&self, epsilon: f64) -> Option<Self>

pub fn to_bytes(&self) -> Vec<u8>

pub fn to_raw_bytes(&self) -> Vec<u8>

Returns a Vector of bytes representing the raw data

pub fn to_json(&self) -> Value

Returns the serde:json::Value equivalent of this data

pub fn stringify(&self) -> String

Returns the data represented as a valid JSON string

pub fn raw_string(&self) -> String

Return the raw data represented as a string

This will attempt to convert internal vector data to utf-8. This behaves the same as stringify for all data types other than byte arrays, which will attempt to convert to a string.

pub fn iter(&self) -> MatrixIter<'_, f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>

pub fn map<F: FnMut(f64) -> f64>(&self, f: F) -> Self

pub fn sum(&self) -> f64

pub fn mean(&self) -> f64

pub fn max(&self) -> f64

pub fn min(&self) -> f64

pub fn argmax(&self) -> f64

pub fn argmin(&self) -> f64

pub fn sorted(&self, ascending: bool) -> Self

pub fn median(&self) -> f64

pub fn sup(&self, other: &BlockData) -> Self

pub fn inf(&self, other: &BlockData) -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn or(&self, other: &BlockData) -> Self

pub fn and(&self, other: &BlockData) -> Self

pub fn eq(&self, other: &BlockData) -> Self

pub fn neq(&self, other: &BlockData) -> Self

pub fn gt(&self, other: &BlockData) -> Self

pub fn gte(&self, other: &BlockData) -> Self

pub fn lt(&self, other: &BlockData) -> Self

pub fn lte(&self, other: &BlockData) -> Self

pub fn logical_not(&self) -> Self

pub fn ltz(&self) -> Self

pub fn ltez(&self) -> Self

pub fn gtz(&self) -> Self

pub fn gtez(&self) -> Self

pub fn eqz(&self) -> Self

Trait Implementations

impl AbsDiffEq for BlockData

type Epsilon = f64

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Self, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Add<&BlockData> for BlockData

type Output = BlockData

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for &BlockData

type Output = BlockData

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&BlockData> for BlockData

fn add_assign(&mut self, rhs: &BlockData)

Performs the += operation.

impl BitAnd for &BlockData

type Output = BlockData

The resulting type after applying the & operator.

fn bitand(self, rhs: &BlockData) -> Self::Output

Performs the & operation.

impl BitAnd for BlockData

type Output = BlockData

The resulting type after applying the & operator.

fn bitand(self, rhs: BlockData) -> Self::Output

Performs the & operation.

impl BitOr for &BlockData

type Output = BlockData

The resulting type after applying the | operator.

fn bitor(self, rhs: &BlockData) -> Self::Output

Performs the | operation.

impl BitOr for BlockData

type Output = BlockData

The resulting type after applying the | operator.

fn bitor(self, rhs: BlockData) -> Self::Output

Performs the | operation.

impl BitXor for &BlockData

type Output = BlockData

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &BlockData) -> Self::Output

Performs the ^ operation.

impl BitXor for BlockData

type Output = BlockData

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: BlockData) -> Self::Output

Performs the ^ operation.

impl BlockDataRead for &BlockData

fn get_scalar(&self) -> f64

Retrieve a scalar value

fn get_matrix(&self) -> (usize, usize, &[f64])

Retrieve a matrix value as a tuple of (nrows, ncols, &f64) Data is output in column-major order For example, the matrix: | 1.0 2.0 | | 3.0 4.0 |

impl BlockDataRead for BlockData

fn get_scalar(&self) -> f64

Retrieve a scalar value

fn get_matrix(&self) -> (usize, usize, &[f64])

Retrieve a matrix value as a tuple of (nrows, ncols, &f64) Data is output in column-major order For example, the matrix: | 1.0 2.0 | | 3.0 4.0 |

impl BlockDataWrite for &mut BlockData

fn set_scalar_value(&mut self, scalar: f64)

Set a scalar value

fn set_matrix_value(&mut self, nrows: usize, ncols: usize, data: &[f64])

Set a matrix value Data is input in column-major order For example, set_matrix_value(2, 2, &[1.0, 3.0, 2.0, 4.0]) would set the matrixdata to: | 1.0 2.0 | | 3.0 4.0 |

impl Clone for BlockData

fn clone(&self) -> BlockData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockData

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

Formats the value using the given formatter.

impl Div<f64> for &BlockData

type Output = BlockData

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for BlockData

type Output = BlockData

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for &BlockData

type Output = BlockData

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for BlockData

type Output = BlockData

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&BlockData> for BlockData

fn div_assign(&mut self, rhs: &BlockData)

Performs the /= operation.

impl DivAssign<f64> for BlockData

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl FromPass<ByteSliceSignal> for BlockData

fn from_pass(pass: PassBy<'_, ByteSliceSignal>) -> Self

impl<const NROWS: usize, const NCOLS: usize, T: Scalar> FromPass<Matrix<NROWS, NCOLS, T>> for BlockData

fn from_pass(pass: PassBy<'_, Matrix<NROWS, NCOLS, T>>) -> Self

impl FromPass<bool> for BlockData

fn from_pass(pass: PassBy<'_, bool>) -> Self

impl FromPass<f32> for BlockData

fn from_pass(pass: f32) -> Self

impl FromPass<f64> for BlockData

fn from_pass(pass: f64) -> Self

impl FromPass<i16> for BlockData

fn from_pass(pass: i16) -> Self

impl FromPass<i32> for BlockData

fn from_pass(pass: i32) -> Self

impl FromPass<i8> for BlockData

fn from_pass(pass: i8) -> Self

impl FromPass<u16> for BlockData

fn from_pass(pass: u16) -> Self

impl FromPass<u32> for BlockData

fn from_pass(pass: u32) -> Self

impl FromPass<u8> for BlockData

fn from_pass(pass: u8) -> Self

impl Index<usize> for BlockData

type Output = f64

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for BlockData

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Mul<&BlockData> for f64

type Output = BlockData

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<BlockData> for f64

type Output = BlockData

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for &BlockData

type Output = BlockData

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for BlockData

type Output = BlockData

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for &BlockData

type Output = BlockData

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&BlockData> for BlockData

fn mul_assign(&mut self, rhs: &BlockData)

Performs the *= operation.

impl PartialEq for BlockData

fn eq(&self, other: &BlockData) -> 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 RelativeEq for BlockData

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Shl<i32> for &BlockData

type Output = BlockData

The resulting type after applying the << operator.

fn shl(self, rhs: i32) -> Self::Output

Performs the << operation.

impl Shl<i32> for BlockData

type Output = BlockData

The resulting type after applying the << operator.

fn shl(self, rhs: i32) -> Self::Output

Performs the << operation.

impl Shr<i32> for &BlockData

type Output = BlockData

The resulting type after applying the >> operator.

fn shr(self, rhs: i32) -> Self::Output

Performs the >> operation.

impl Shr<i32> for BlockData

type Output = BlockData

The resulting type after applying the >> operator.

fn shr(self, rhs: i32) -> Self::Output

Performs the >> operation.

impl Sub<&BlockData> for BlockData

type Output = BlockData

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<BlockData> for &BlockData

type Output = BlockData

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for &BlockData

type Output = BlockData

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&BlockData> for BlockData

fn sub_assign(&mut self, rhs: &BlockData)

Performs the -= operation.

impl<const N: usize> ToPass<[f64; N]> for BlockData

fn to_pass(&self) -> [f64; N]

impl<const N: usize> ToPass<[u8; N]> for BlockData

fn to_pass(&self) -> [u8; N]

impl<const NROWS: usize, const NCOLS: usize> ToPass<Matrix<NROWS, NCOLS, bool>> for BlockData

fn to_pass(&self) -> Matrix<NROWS, NCOLS, bool>

impl<const NROWS: usize, const NCOLS: usize> ToPass<Matrix<NROWS, NCOLS, f64>> for BlockData

fn to_pass(&self) -> Matrix<NROWS, NCOLS, f64>

impl ToPass<bool> for BlockData

fn to_pass(&self) -> bool

impl ToPass<f64> for BlockData

fn to_pass(&self) -> f64

impl StructuralPartialEq for BlockData