pub struct EngineMixin { /* private fields */ }Expand description
Mixin class to be mult-inherited together with geometric.engine.Engine.
Implementations§
Source§impl EngineMixin
impl EngineMixin
Sourcepub fn new(_molecule: PyObject) -> PyResult<Self>
pub fn new(_molecule: PyObject) -> PyResult<Self>
Initialize the EngineMixin class.
Though this function does not do anything, it is intended to be
inherited by geometric.engine.Engine’s initializer. So input
_molecule is actually gracefully initialized.
Please note that driver is not initialized here. It should be set
using the set_driver method manually.
Sourcepub fn set_driver(&mut self, driver: &PyGeomDriver)
pub fn set_driver(&mut self, driver: &PyGeomDriver)
Set the driver for the engine.
This driver is used to calculate the energy and gradient of the system. This function must be called before using the engine.
Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for EngineMixin
impl<'py> IntoPyObject<'py> for EngineMixin
Source§type Target = EngineMixin
type Target = EngineMixin
The Python output type
Source§type Output = Bound<'py, <EngineMixin as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <EngineMixin as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for EngineMixin
impl PyClass for EngineMixin
Source§impl PyClassBaseType for EngineMixin
impl PyClassBaseType for EngineMixin
type LayoutAsBase = PyClassObject<EngineMixin>
type BaseNativeType = <EngineMixin as PyClassImpl>::BaseNativeType
type Initializer = PyClassInitializer<EngineMixin>
type PyClassMutability = <EngineMixin as PyClassImpl>::PyClassMutability
Source§impl PyClassImpl for EngineMixin
impl PyClassImpl for EngineMixin
Source§const IS_BASETYPE: bool = true
const IS_BASETYPE: bool = true
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§type ThreadChecker = SendablePyClass<EngineMixin>
type ThreadChecker = SendablePyClass<EngineMixin>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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>
Source§impl PyClassNewTextSignature<EngineMixin> for PyClassImplCollector<EngineMixin>
impl PyClassNewTextSignature<EngineMixin> for PyClassImplCollector<EngineMixin>
fn new_text_signature(self) -> Option<&'static str>
Source§impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a EngineMixin
impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a EngineMixin
Source§impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut EngineMixin
impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut EngineMixin
Source§impl PyMethods<EngineMixin> for PyClassImplCollector<EngineMixin>
impl PyMethods<EngineMixin> for PyClassImplCollector<EngineMixin>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for EngineMixin
impl PyTypeInfo for EngineMixin
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
Source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
👎Deprecated since 0.23.0: renamed to
PyTypeInfo::type_objectDeprecated name for
PyTypeInfo::type_object.Source§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object is an instance of this type or a subclass of this type.Source§fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool
👎Deprecated since 0.23.0: renamed to
PyTypeInfo::is_type_ofDeprecated name for
PyTypeInfo::is_type_of.Source§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object is an instance of this type.Source§fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
👎Deprecated since 0.23.0: renamed to
PyTypeInfo::is_exact_type_ofDeprecated name for
PyTypeInfo::is_exact_type_of.impl DerefToPyAny for EngineMixin
Auto Trait Implementations§
impl Freeze for EngineMixin
impl RefUnwindSafe for EngineMixin
impl Send for EngineMixin
impl Sync for EngineMixin
impl Unpin for EngineMixin
impl UnwindSafe for EngineMixin
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.