ScalarField

Struct ScalarField 

Source
pub struct ScalarField<const P: usize, const Q: usize, const R: usize> { /* private fields */ }
Expand description

A scalar field f: ℝⁿ → ℝ

Represents a function that maps points in n-dimensional space to scalar values.

§Examples

use amari_calculus::ScalarField;

// Define f(x, y) = x² + y²
let f = ScalarField::<3, 0, 0>::new(|coords| {
    coords[0].powi(2) + coords[1].powi(2)
});

// Evaluate at (3, 4)
let value = f.evaluate(&[3.0, 4.0, 0.0]);
assert!((value - 25.0).abs() < 1e-10);

Implementations§

Source§

impl<const P: usize, const Q: usize, const R: usize> ScalarField<P, Q, R>

Source

pub fn new(function: fn(&[f64]) -> f64) -> Self

Create a new scalar field from a function

§Arguments
  • function - Function mapping coordinates to scalar values
§Examples
use amari_calculus::ScalarField;

// Quadratic function f(x, y) = x² + y²
let f = ScalarField::<3, 0, 0>::new(|coords| {
    coords[0].powi(2) + coords[1].powi(2)
});
Source

pub fn with_dimension(function: fn(&[f64]) -> f64, dim: usize) -> Self

Create a scalar field with explicit dimension

Useful when the field dimension doesn’t match the algebra dimension.

Source

pub fn evaluate(&self, coords: &[f64]) -> f64

Evaluate the scalar field at a point

§Arguments
  • coords - Coordinates of the point
§Returns

The scalar value at the point

§Errors

Returns error if coordinate dimension doesn’t match field dimension

Source

pub fn dimension(&self) -> usize

Get the domain dimension

Source

pub fn partial_derivative( &self, coords: &[f64], axis: usize, h: f64, ) -> CalculusResult<f64>

Compute numerical derivative along coordinate axis

Uses centered difference: f’(x) ≈ (f(x+h) - f(x-h)) / (2h)

§Arguments
  • coords - Point at which to compute derivative
  • axis - Coordinate axis index (0 = x, 1 = y, etc.)
  • h - Step size (default: 1e-5)

Trait Implementations§

Source§

impl<const P: usize, const Q: usize, const R: usize> Clone for ScalarField<P, Q, R>

Source§

fn clone(&self) -> ScalarField<P, Q, R>

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<const P: usize, const Q: usize, const R: usize> Debug for ScalarField<P, Q, R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const P: usize, const Q: usize, const R: usize> Freeze for ScalarField<P, Q, R>

§

impl<const P: usize, const Q: usize, const R: usize> RefUnwindSafe for ScalarField<P, Q, R>

§

impl<const P: usize, const Q: usize, const R: usize> Send for ScalarField<P, Q, R>

§

impl<const P: usize, const Q: usize, const R: usize> Sync for ScalarField<P, Q, R>

§

impl<const P: usize, const Q: usize, const R: usize> Unpin for ScalarField<P, Q, R>

§

impl<const P: usize, const Q: usize, const R: usize> UnwindSafe for ScalarField<P, Q, R>

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.