Atom

Struct Atom 

Source
pub struct Atom {
    pub name: String,
    pub element: Element,
    pub pos: Point,
}
Expand description

Labeled atom with immutable element identity and mutable position.

The struct is shared across residue, chain, and structure builders. Keeping the element metadata close to the coordinate allows downstream algorithms (e.g., heavy-atom filters or hydrogen placement) to reason locally without traversing additional tables.

Fields§

§name: String

Atom name as it appears in crystallographic or modeling files (e.g., CA).

§element: Element

Chemical element derived from the periodic table definitions.

§pos: Point

Cartesian coordinates measured in ångströms.

Implementations§

Source§

impl Atom

Source

pub fn new(name: &str, element: Element, pos: Point) -> Self

Creates a new atom from a name, element, and position.

Caller controls ownership of the label string while the element enforces chemical consistency. The position is copied as-is; no normalization is performed.

§Arguments
  • name - Atom label such as "CA" or "OXT".
  • element - Element variant describing the chemical identity.
  • pos - Point describing the Cartesian coordinates in ångströms.
§Returns

A fully initialized Atom instance.

Source

pub fn distance_squared(&self, other: &Atom) -> f64

Computes the squared Euclidean distance to another atom.

Prefer this when comparing relative distances or feeding cutoffs, as it avoids the costly square-root step while remaining in ångström squared units.

§Arguments
  • other - Reference atom to measure against.
§Returns

The squared distance as f64.

Source

pub fn distance(&self, other: &Atom) -> f64

Computes the Euclidean distance to another atom.

This is the fully realized length in ångströms and is suitable for reporting or geometry calculations that require actual bond lengths.

§Arguments
  • other - Reference atom to measure against.
§Returns

The distance in ångströms as f64.

Source

pub fn translate_by(&mut self, vector: &Vector3<f64>)

Translates the atom by an arbitrary vector.

The operation mutates the underlying position and is commonly used during rigid-body transforms or when applying simulation displacements.

§Arguments
  • vector - Translation expressed as a nalgebra::Vector3<f64> in ångströms.

Trait Implementations§

Source§

impl Clone for Atom

Source§

fn clone(&self) -> Atom

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

Source§

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

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

impl Display for Atom

Source§

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

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

impl PartialEq for Atom

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Atom

Auto Trait Implementations§

§

impl Freeze for Atom

§

impl RefUnwindSafe for Atom

§

impl Send for Atom

§

impl Sync for Atom

§

impl Unpin for Atom

§

impl UnwindSafe for Atom

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,