Struct net_ensembles::sampling::glue::GlueResult

source · [−]

pub struct GlueResult<T> {
    pub glued_log10_probability: Vec<f64, Global>,
    pub borders: Vec<T, Global>,
    pub log10_vec: Vec<Vec<f64, Global>, Global>,
    pub left_list: Vec<usize, Global>,
    pub total_steps: usize,
    pub total_steps_accepted: usize,
    pub total_steps_rejected: usize,
}

Expand description

Glued together probability

you can write it to a file, maybe the file makes more sense
If you have problems understanding the fields, please, first look at the documentation of the current master branch to see, if the documentation there makes more sense. If it doesn’t: open an issue on the github repository

Fields

glued_log10_probability: Vec<f64, Global>

probably the result you want, i.e., what you were simulating for

this is the log10 of the probability of each bin
you get the probability of a bin by 10_f64.powf(glued_log10_probability[i]), i.e., 10^bin_value
normed such that the sum of the probabilities is 1.0 (within numerical precision errors)

borders: Vec<T, Global>

This are the bin borders

bin_i is defined as the interval [borders[i], borders[i + 1][, i.e. half open interval
where the right border is exclusive

log10_vec: Vec<Vec<f64, Global>, Global>

log10 of “probabilities” of the curves, you were glueing together

height adjusted, such that the intervals fit together, but not normalized, the sum can be anything

left_list: Vec<usize, Global>

Index map

self.left_list[i] is the index of self.borders where the interval self.log10_vec has the first entry

total_steps: usize

How many markov steps were performed in total?

includes steps used to find initial valid ensemble
for entropic sampling, this includes the steps of the wang landau simulation

total_steps_accepted: usize

How many markov steps were accepted in total?

includes steps used to find initial valid ensemble
for entropic sampling, this includes the steps of the wang landau simulation

total_steps_rejected: usize

How many markov steps were rejected in total?

includes steps used to find initial valid ensemble
for entropic sampling, this includes the steps of the wang landau simulation

Implementations

impl<T> GlueResult<T>where
T: Display,

pub fn write<W>(&self, w: W) -> Result<(), Error>where
W: Write,

Write the result to a file

for plotting with gnuplot etc.

Trait Implementations

impl<T> Clone for GlueResult<T>where
T: Clone,

fn clone(&self) -> GlueResult<T>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T> Debug for GlueResult<T>where
T: Debug,

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for GlueResult<T>where
T: RefUnwindSafe,

impl<T> Send for GlueResult<T>where
T: Send,

impl<T> Sync for GlueResult<T>where
T: Sync,

impl<T> Unpin for GlueResult<T>where
T: Unpin,

impl<T> UnwindSafe for GlueResult<T>where
T: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<S, T> Cast<T> for Swhere
T: Conv<S>,

fn cast(self) -> T

Cast from Self to T

fn try_cast(self) -> Result<T, Error>

Try converting from Self to T

impl<S, T> CastFloat<T> for Swhere
T: ConvFloat<S>,

fn cast_trunc(self) -> T

Cast to integer, truncating Read more

fn cast_nearest(self) -> T

Cast to the nearest integer Read more

fn cast_floor(self) -> T

Cast the floor to an integer Read more

fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more

fn try_cast_trunc(self) -> Result<T, Error>

Try converting to integer with truncation Read more

fn try_cast_nearest(self) -> Result<T, Error>

Try converting to the nearest integer Read more

fn try_cast_floor(self) -> Result<T, Error>

Try converting the floor to an integer Read more

fn try_cast_ceil(self) -> Result<T, Error>

Try convert the ceiling to an integer Read more

impl<T> Conv<T> for T

fn conv(v: T) -> T

Convert from T to Self

fn try_conv(v: T) -> Result<T, Error>

Try converting from T to Self

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

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

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V