Skip to main content

HeatmapData

Struct HeatmapData 

Source
pub struct HeatmapData<'a> {
    pub rows: usize,
    pub cols: usize,
    pub values: &'a [f64],
    pub valid: &'a [bool],
    pub range: (f64, f64),
    pub palette: &'a str,
    pub label: &'a str,
    pub detector: &'a str,
    pub advisory: Option<&'a str>,
}
Expand description

Caller-prepared scalar grid projected by heatmap_view.

values and valid are row-major and must each contain exactly rows * cols entries. The helper validates them but never resamples them: only the caller’s domain knows whether a smaller grid requires point sampling, area integration, complex averaging, or another detector rule.

Fields§

§rows: usize

Number of non-zero grid rows.

§cols: usize

Number of non-zero grid columns.

§values: &'a [f64]

Finite row-major scalar values.

§valid: &'a [bool]

Row-major validity mask, parallel to values.

§range: (f64, f64)

Finite inclusive display range (min, max).

§palette: &'a str§label: &'a str

Non-empty accessible label for the represented quantity.

§detector: &'a str

Non-empty caller-supplied detector or sampling description.

§advisory: Option<&'a str>

Optional non-empty warning or qualification rendered with the grid.

Trait Implementations§

Source§

impl<'a> Clone for HeatmapData<'a>

Source§

fn clone(&self) -> HeatmapData<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for HeatmapData<'a>

Source§

impl<'a> Debug for HeatmapData<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for HeatmapData<'a>

§

impl<'a> RefUnwindSafe for HeatmapData<'a>

§

impl<'a> Send for HeatmapData<'a>

§

impl<'a> Sync for HeatmapData<'a>

§

impl<'a> Unpin for HeatmapData<'a>

§

impl<'a> UnsafeUnpin for HeatmapData<'a>

§

impl<'a> UnwindSafe for HeatmapData<'a>

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.