Skip to main content

SimpleVariable

Struct SimpleVariable 

Source
pub struct SimpleVariable {
    pub name: String,
    pub source: String,
    pub values: Vec<f64>,
    pub str_values: Vec<String>,
    pub index: Vec<StringEntities>,
    pub entities: StringEntities,
    pub is_numeric: bool,
}
Expand description

A simple variable with no timing information.

Represents a column from a BIDS tabular file such as participants.tsv, sessions.tsv, or scans.tsv. Each variable has a name, source file identifier, string values, and an entity index that maps each row to its BIDS entities (e.g., which subject each value belongs to).

Values are stored as both strings and parsed floats (NaN for non-numeric). The is_numeric flag indicates whether all values are parseable as f64.

Corresponds to PyBIDS’ SimpleVariable class.

§Example

use bids_variables::SimpleVariable;
use std::collections::HashMap;

let index = vec![
    HashMap::from([("subject".into(), "01".into())]),
    HashMap::from([("subject".into(), "02".into())]),
];
let var = SimpleVariable::new("age", "participants",
    vec!["25".into(), "30".into()], index);

assert_eq!(var.len(), 2);
assert!(var.is_numeric);

Fields§

§name: String§source: String§values: Vec<f64>§str_values: Vec<String>§index: Vec<StringEntities>§entities: StringEntities§is_numeric: bool

Implementations§

Source§

impl SimpleVariable

Source

pub fn new( name: &str, source: &str, values: Vec<String>, index: Vec<StringEntities>, ) -> Self

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn clone_with(&self, data: Option<Vec<String>>, name: Option<&str>) -> Self

Clone with optional data/name replacement.

Source

pub fn filter(&self, filters: &StringEntities) -> Self

Filter rows matching given entity criteria.

Source

pub fn to_rows(&self) -> Vec<StringEntities>

Convert to tabular rows.

Trait Implementations§

Source§

impl Clone for SimpleVariable

Source§

fn clone(&self) -> SimpleVariable

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SimpleVariable

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.