Skip to main content

ExponentialPoint

Struct ExponentialPoint 

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

Drive a species’ distance to a centre, ξ = ‖x − c‖, to an exponential distribution ∝ e^(−ξ/λ) — densest at the centre and decaying radially with decay length λ (a radial atmosphere around center).

Implementations§

Source§

impl ExponentialPoint

Source

pub fn new(center: [F; 3], strength: F, lambda: F) -> Self

  • center — the point c the decay is measured from.
  • strength — overall penalty multiplier.
  • lambda — radial decay length (λ > 0).
§Panics

If lambda <= 0.

Trait Implementations§

Source§

impl Clone for ExponentialPoint

Source§

fn clone(&self) -> ExponentialPoint

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 ExponentialPoint

Source§

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

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

impl Restraint for ExponentialPoint

Source§

fn f(&self, coords: &[[F; 3]], _scale: F, _scale2: F) -> F

Penalty value for the group’s current configuration. Read more
Source§

fn fg( &self, coords: &[[F; 3]], _scale: F, _scale2: F, grads: &mut [[F; 3]], ) -> F

Fused value + gradient. Accumulates ∂L/∂coords[i] INTO grads[i] with +=; returns the same value f would. grads.len() == coords.len().
Source§

fn name(&self) -> &'static str

Human-readable identifier.
Source§

fn is_parallel_safe(&self) -> bool

If false, the scheduler serializes this restraint (Python-backed collective restraints MUST return false).

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V