Struct AnnealProtocol 

pub struct AnnealProtocol {
    pub temperatures: (f64, f64),
    pub holds: (f64, f64),
    pub anneal_time: f64,
    pub seconds_per_step: f64,
    pub scaffold_count: usize,
}

Fields

temperatures: (f64, f64)

A tuple with initial and final temperatures (in C)

holds: (f64, f64)

A tuple with:

1. How long to hold the initial temperature for before starting the temperature decremenet
2. How long to hold the final temperature for before finishing the anneal

anneal_time: f64

How long to spend in the phase where the temperature is decrementing from the initial to the final temp

seconds_per_step: f64

How long to spend at each temperature

scaffold_count: usize

Implementations

impl AnnealProtocol

pub fn generate_arrays(&self) -> (Vec<f64>, Vec<f64>)

Generates two arrays: (Vec<temperatures>, Vec<times>)

pub fn run_system<St: State>( &self, sdc: SDC, state: St, ) -> Result<(Vec<Vec<u32>>, Vec<f64>, Vec<f64>), GrowError>

pub fn run_anneal_default_system( &self, sdc: SDC, ) -> Result<(Vec<Vec<u32>>, Vec<f64>, Vec<f64>), GrowError>

pub fn run_many_anneals_default_system( &self, sdcs: Vec<SDC>, ) -> Vec<Result<(Vec<Vec<u32>>, Vec<f64>, Vec<f64>), GrowError>>

Trait Implementations

impl Default for AnnealProtocol

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for AnnealProtocol

type Target = AnnealProtocol

The Python output type

type Output = Bound<'py, <AnnealProtocol as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for AnnealProtocol

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AnnealProtocol

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<AnnealProtocol>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForAnnealProtocol

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for AnnealProtocol

const TEXT_SIGNATURE: &'static str = "(from_tmp, to_tmp, initial_hold, final_hold, delta_time, scaffold_count, seconds_per_step)"

impl PyTypeInfo for AnnealProtocol

const NAME: &'static str = "AnnealProtocol"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for AnnealProtocol

impl ExtractPyClassWithClone for AnnealProtocol