Struct Alloy

Source

pub struct Alloy { /* private fields */ }

Expand description

An alloy is a collection of kinds of atoms and their ratios

It is used to pick a kind of atom from the alloy.

§Example

use vegas_lattice::Alloy;

let alloy = Alloy::try_new(vec!["Fe", "Ni"], vec![1, 2]).unwrap();
let kind = alloy.pick(&mut rand::rng());

assert!(kind == "Fe" || kind == "Ni");

Implementations§

Source §

impl Alloy

Source

pub fn try_new(kinds: Vec<&str>, ratios: Vec<u32>) -> Result<Self>

Create a new alloy with a given list of kinds and their ratios

Source

pub fn try_from_targets(targets: Vec<(&str, u32)>) -> Result<Self>

Source

pub fn pick<R: Rng + ?Sized>(&self, rng: &mut R) -> &str

Picks a kind of atom from the alloy

Trait Implementations§

Source §

impl Debug for Alloy

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Alloy

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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

Source §