Skip to main content

Blueprint

Struct Blueprint 

Source
pub struct Blueprint {
Show 15 fields pub name: String, pub width: usize, pub height: usize, pub depth: usize, pub types: Vec<TypeSpec>, pub fields: Vec<SpeciesSpec>, pub adhesion: Option<Adhesion>, pub contact: Vec<f64>, pub temperature: f64, pub neighbour_order: u8, pub seed: u64, pub steps: u64, pub dump_every: u64, pub initial: Initial, pub units: Units,
}
Expand description

The whole description.

Fields§

§name: String

A name for the model.

§width: usize

Lattice width in sites.

§height: usize

Lattice height in sites.

§depth: usize

Lattice depth in sites. Absent is a plane.

§types: Vec<TypeSpec>

Cell types beside the medium, in order.

§fields: Vec<SpeciesSpec>

Diffusing species, in order.

§adhesion: Option<Adhesion>

Adhesion molecules and their binding matrix, absent when the contact matrix says everything.

§contact: Vec<f64>

Contact energies over ["Medium", types...], row-major and symmetric.

§temperature: f64

Metropolis fluctuation amplitude.

§neighbour_order: u8

1 for four neighbours, 2 for eight.

§seed: u64

Random seed.

§steps: u64

Monte Carlo steps to run.

§dump_every: u64

Steps between label-field dumps.

§initial: Initial

The initial condition.

§units: Units

The physical scale.

Implementations§

Source§

impl Blueprint

Source

pub fn effective_contact(&self) -> Vec<f64>

The contact matrix with the adhesion molecules folded in.

Binding lowers the energy of a bond, so what two types’ molecules bind comes off the contact energy the description states between them.

Source

pub fn initial_types(&self, cells: usize) -> Vec<u8>

Type index of each cell at the start, by the fractions stated.

Assignment walks the cells in order and hands out each type its share, so the same description and the same cell count always start the same way whatever an engine’s own random stream does.

Source

pub fn model(&self) -> Model

The engine-facing model this description states.

Source

pub fn from_json(text: &str) -> Result<Blueprint, String>

Read a description from JSON.

§Errors

A message naming the parse failure or the inconsistency found. A secretion or uptake entry naming a species the description does not state is an error rather than a silent zero, since a typo there would otherwise read as a cell that secretes nothing.

Trait Implementations§

Source§

impl Clone for Blueprint

Source§

fn clone(&self) -> Blueprint

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 Blueprint

Source§

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

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

impl<'de> Deserialize<'de> for Blueprint

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Blueprint, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Blueprint

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = !

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.