VectorField

Struct VectorField 

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

A vector field F: ℝⁿ → Cl(p,q,r)_1 (grade-1 multivectors)

Represents a function that maps points in n-dimensional space to vectors (grade-1 multivectors).

§Examples

use amari_calculus::{VectorField, vector_from_slice};

// Define F(x, y, z) = (x, y, z) - radial vector field
let f = VectorField::<3, 0, 0>::new(|coords| {
    vector_from_slice(&[coords[0], coords[1], coords[2]])
});

// Evaluate at (1, 2, 3)
let value = f.evaluate(&[1.0, 2.0, 3.0]);

Implementations§

Source§

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

Source

pub fn new(function: fn(&[f64]) -> Multivector<P, Q, R>) -> Self

Create a new vector field from a function

§Arguments
  • function - Function mapping coordinates to vectors
§Examples
use amari_calculus::{VectorField, vector_from_slice};

// Rotation field F(x, y) = (-y, x, 0)
let f = VectorField::<3, 0, 0>::new(|coords| {
    vector_from_slice(&[-coords[1], coords[0], 0.0])
});
Source

pub fn with_dimension( function: fn(&[f64]) -> Multivector<P, Q, R>, dim: usize, ) -> Self

Create a vector field with explicit dimension

Source

pub fn evaluate(&self, coords: &[f64]) -> Multivector<P, Q, R>

Evaluate the vector field at a point

§Arguments
  • coords - Coordinates of the point
§Returns

The vector value at the point

Source

pub fn dimension(&self) -> usize

Get the domain dimension

Source

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

Compute numerical derivative of vector field component along coordinate axis

§Arguments
  • coords - Point at which to compute derivative
  • axis - Coordinate axis index
  • h - Step size (default: 1e-5)

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> VectorField<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 VectorField<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 VectorField<P, Q, R>

§

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

§

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

§

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

§

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

§

impl<const P: usize, const Q: usize, const R: usize> UnwindSafe for VectorField<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.