Struct IMAnnData 

pub struct IMAnnData { /* private fields */ }

Implementations

impl IMAnnData

pub fn new( x: IMArrayElement, obs: IMDataFrameElement, var: IMDataFrameElement, ) -> Result<Self>

Creates a new IMAnnData instance.

Arguments

• x - Main data matrix.
• obs - Observations metadata.
• var - Variables metadata.

Returns

Returns Ok(IMAnnData) if dimensions match, otherwise returns an Err.

Errors

Returns an error if dimensions mismatch between x, obs, and var.

pub fn new_basic( matrix: ArrayData, obs_names: Vec<String>, var_names: Vec<String>, ) -> Result<Self>

Creates a new basic IMAnnData instance from a sparse matrix and index names.

Arguments

• matrix - A sparse matrix (CsrArray) containing the main data.
• obs_names - Names for the observations (rows).
• var_names - Names for the variables (columns).

Returns

Returns Result<IMAnnData> if successful, otherwise returns an Err.

Errors

Returns an error if there’s a mismatch in dimensions or if DataFrame creation fails.

pub fn new_extended( matrix: ArrayData, obs_names: Vec<String>, var_names: Vec<String>, obs_df: DataFrame, var_df: DataFrame, ) -> Result<Self>

pub fn n_obs(&self) -> usize

Returns the number of observations.

pub fn n_vars(&self) -> usize

Returns the number of variables.

pub fn obs_names(&self) -> Vec<String>

pub fn var_names(&self) -> Vec<String>

pub fn x(&self) -> IMArrayElement

Returns a shallow clone of the main data matrix.

Notes

This method returns a new IMArrayElement that shares the same underlying data with the original. Modifications to the returned IMArrayElement will affect the original data.

pub fn obs(&self) -> IMDataFrameElement

Returns a shallow clone of the observations metadata.

Notes

This method returns a new IMDataFrameElement that shares the same underlying data with the original. Modifications to the returned IMDataFrameElement will affect the original data.

pub fn var(&self) -> IMDataFrameElement

Returns a shallow clone of the variable DataFrame.

Notes

This method returns a new IMDataFrameElement that shares the same underlying data with the original. Modifications to the returned IMDataFrameElement will affect the original data.

pub fn add_layer(&mut self, name: String, data: IMArrayElement) -> Result<()>

Adds a new layer to the layers field.

Arguments

• name - Name of the new layer.
• data - Data for the new layer.

Returns

Returns Ok(()) if the layer was successfully added, otherwise returns an Err.

Errors

Returns an error if a layer with the same name already exists.

pub fn get_layer(&self, name: &str) -> Result<IMArrayElement>

Retrieves a deep clone of a layer by name.

Arguments

• name - Name of the layer to retrieve.

Returns

Returns Ok(IMArrayElement) if the layer was found, otherwise returns an Err.

Errors

Returns an error if the layer is not found.

pub fn get_layer_shallow(&self, name: &str) -> Result<IMArrayElement>

Retrieves a shallow clone of a layer by name.

Arguments

• name - Name of the layer to retrieve.

Returns

Returns Ok(IMArrayElement) if the layer was found, otherwise returns an Err.

Errors

Returns an error if the layer is not found.

pub fn remove_layer(&mut self, name: &str) -> Result<IMArrayElement>

Removes a layer by name and returns it.

Arguments

• name - Name of the layer to remove.

Returns

Returns Ok(IMArrayElement) with the removed layer if found, otherwise returns an Err.

Errors

Returns an error if the layer is not found.

pub fn update_array(&mut self, name: &str, data: IMArrayElement) -> Result<()>

Updates an existing layer with new data.

Arguments

• name - Name of the layer to update.
• data - New data for the layer.

Returns

Returns Ok(()) if the layer was successfully updated, otherwise returns an Err.

Errors

Returns an error if the layer is not found.

pub fn obsm(&self) -> IMAxisArrays

Returns a shallow clone of the observation multi-dimensional annotation.

Returns

Returns an IMAxisArrays instance that shares the same underlying data with the original.

Notes

This method performs a shallow clone, meaning the returned IMAxisArrays shares the same Arc pointer to the RwLock containing the data. Any modifications made through this clone will affect the original data in the IMAnnData instance.

pub fn obsp(&self) -> IMAxisArrays

Returns a shallow clone of the observation pairwise annotation.

Returns

Returns an IMAxisArrays instance that shares the same underlying data with the original.

Notes

This method performs a shallow clone, meaning the returned IMAxisArrays shares the same Arc pointer to the RwLock containing the data. Any modifications made through this clone will affect the original data in the IMAnnData instance.

pub fn varm(&self) -> IMAxisArrays

Returns a shallow clone of the variable multi-dimensional annotation.

Returns

Returns an IMAxisArrays instance that shares the same underlying data with the original.

Notes

This method performs a shallow clone, meaning the returned IMAxisArrays shares the same Arc pointer to the RwLock containing the data. Any modifications made through this clone will affect the original data in the IMAnnData instance.

pub fn varp(&self) -> IMAxisArrays

Returns a shallow clone of the variable pairwise annotation.

Returns

Returns an IMAxisArrays instance that shares the same underlying data with the original.

Notes

This method performs a shallow clone, meaning the returned IMAxisArrays shares the same Arc pointer to the RwLock containing the data. Any modifications made through this clone will affect the original data in the IMAnnData instance.

pub fn uns(&self) -> IMElementCollection

Returns a shallow clone of the unstructured annotation.

Returns

Returns an IMElementCollection instance that shares the same underlying data with the original.

Notes

This method performs a shallow clone, meaning the returned IMElementCollection shares the same Arc pointer to the RwLock containing the data. Any modifications made through this clone will affect the original data in the IMAnnData instance.

pub fn layers(&self) -> IMAxisArrays

Returns a shallow clone of the layers of data.

Returns

Returns an IMAxisArrays instance that shares the same underlying data with the original.

Notes

This method performs a shallow clone, meaning the returned IMAxisArrays shares the same Arc pointer to the RwLock containing the data. Any modifications made through this clone will affect the original data in the IMAnnData instance.

pub fn subset_inplace(&mut self, selection: &[&SelectInfoElem]) -> Result<()>

pub fn subset(&self, selection: &[&SelectInfoElem]) -> Result<Self>

Trait Implementations

impl DeepClone for IMAnnData

fn deep_clone(&self) -> Self

impl Display for IMAnnData

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

Formats the value using the given formatter.