Skip to main content

VesinOptions

Struct VesinOptions 

Source
pub struct VesinOptions {
    pub cutoff: f64,
    pub full: bool,
    pub sorted: bool,
    pub padded_to: usize,
    pub algorithm: i32,
    pub skin: f64,
    pub n_threads: i32,
    pub return_shifts: bool,
    pub return_distances: bool,
    pub return_vectors: bool,
    /* private fields */
}
Expand description

Options block, identical in layout to VesinOptions.

Fields§

§cutoff: f64

Spherical cutoff.

§full: bool

Both (i, j, S) and (j, i, -S) when true.

§sorted: bool

Group rows by i when true.

§padded_to: usize

Full-list width. Zero means no padding.

§algorithm: i32

VesinCellList (2) or VesinAutoAlgorithm (0). Brute force is CPU-unsupported upstream.

§skin: f64

Verlet skin. Negative selects 0.1 * cutoff on the CPU.

§n_threads: i32

Thread count. Zero uses the process default.

§return_shifts: bool

Store integer shifts.

§return_distances: bool

Store distances (not squared).

§return_vectors: bool

Store shifted vectors q + H S - p.

Implementations§

Source§

impl VesinOptions

Source

pub fn cpu( cutoff: f64, full: bool, skin: f64, n_threads: i32, shifts: bool, distances: bool, vectors: bool, ) -> Self

CPU options. skin < 0 is resolved inside NeighborCalc::compute.

Source

pub fn sorted(self, sorted: bool) -> Self

Ask for rows grouped by the first index.

Source

pub fn padded_to(self, n: usize) -> Self

Pad a full list to this many rows per point.

Trait Implementations§

Source§

impl Clone for VesinOptions

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 Copy for VesinOptions

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.