Skip to main content

ScalarField

Struct ScalarField 

Source
pub struct ScalarField { /* private fields */ }
Expand description

A finite, rectangular scalar grid for dense simulation data.

Implementations§

Source§

impl ScalarField

Source

pub const DEFAULT_MAX_FILLED_BYTES: usize

Default maximum allocation performed by ScalarField::filled.

Hosts needing a different explicit budget can use ScalarField::filled_with_byte_limit or pass an already allocated buffer to ScalarField::new.

Source

pub fn new( width: usize, height: usize, values: Vec<f32>, ) -> Result<Self, ScalarFieldError>

Creates a field from row-major values, validating dimensions and finiteness.

Source

pub fn filled( width: usize, height: usize, value: f32, ) -> Result<Self, ScalarFieldError>

Creates a finite field filled with one finite scalar value.

Allocation is limited to ScalarField::DEFAULT_MAX_FILLED_BYTES and uses fallible reservation before initialization.

Source

pub fn filled_with_byte_limit( width: usize, height: usize, value: f32, maximum_bytes: usize, ) -> Result<Self, ScalarFieldError>

Creates a filled field under an explicit host-memory byte limit.

maximum_bytes applies to the row-major f32 value buffer. Reservation failure is returned without partially constructing the field. Supplying a larger limit is an explicit host decision; system overcommit can still make physical memory exhaustion unrecoverable on some platforms.

Source

pub fn width(&self) -> usize

Returns the horizontal cell count.

Source

pub fn height(&self) -> usize

Returns the vertical cell count.

Source

pub fn values(&self) -> &[f32]

Returns row-major scalar values.

Source

pub fn value_at(&self, x: usize, y: usize) -> Option<f32>

Returns a cell value, or None outside field bounds.

Source

pub fn set( &mut self, x: usize, y: usize, value: f32, ) -> Result<(), ScalarFieldError>

Replaces one cell with a finite value.

Source

pub fn replace_values( &mut self, values: Vec<f32>, ) -> Result<(), ScalarFieldError>

Replaces all values while preserving the field dimensions.

Source

pub fn replace_region( &mut self, x: usize, y: usize, width: usize, height: usize, values: &[f32], ) -> Result<(), ScalarFieldError>

Replaces a contiguous rectangular region with finite row-major values.

Source

pub fn value_range(&self) -> (f32, f32)

Returns finite minimum and maximum scalar values.

Trait Implementations§

Source§

impl Clone for ScalarField

Source§

fn clone(&self) -> Self

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 Debug for ScalarField

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ScalarField

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScalarField

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,