Struct FFSStateRef 

pub struct FFSStateRef(/* private fields */);

Implementations

impl FFSStateRef

pub fn time(&self) -> f64

float: the total time the state has simulated, in seconds.

pub fn total_events(&self) -> NumEvents

int: the total number of events that have occurred in the state.

pub fn n_tiles(&self) -> NumTiles

int: the number of tiles in the state.

pub fn clone_state(&self) -> PyState

Return a copy of the state behind the reference as a mutable State object.

Returns

State

pub fn canvas_view<'py>( this: Bound<'py, Self>, _py: Python<'py>, ) -> PyResult<Bound<'py, PyArray2<Tile>>>

NDArray[np.uint]: a direct, mutable view of the state’s canvas. This is potentially unsafe.

pub fn canvas_copy<'py>( this: &Bound<'_, Self>, py: Python<'py>, ) -> PyResult<Bound<'py, PyArray2<Tile>>>

Create a copy of the state’s canvas. This is safe, but can’t be modified and is slower than canvas_view.

Returns

NDArray[np.uint] a copy of the state’s canvas.

pub fn tracking_copy(this: &Bound<'_, Self>) -> PyResult<RustAny>

Return a copy of the tracker’s tracking data.

Returns

Any

pub fn __repr__(&self) -> String

pub fn rate_array<'py>(&self, py: Python<'py>) -> Bound<'py, PyArray2<f64>>

Return a cloned copy of an array with the total possible next event rate for each point in the canvas. This is the deepest level of the quadtree for tree-based states.

Returns

NDArray[np.uint]

pub fn total_rate(&self) -> f64

float: the total rate of possible next events for the state.

Trait Implementations

impl Clone for FFSStateRef

fn clone(&self) -> FFSStateRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<FFSStateRef> for PyState

fn from(state: FFSStateRef) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for FFSStateRef

type Target = FFSStateRef

The Python output type

type Output = Bound<'py, <FFSStateRef 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 FFSStateRef

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FFSStateRef

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<FFSStateRef>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForFFSStateRef

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 PyTypeInfo for FFSStateRef

const NAME: &'static str = "FFSStateRef"

Class name.

const MODULE: Option<&'static str>

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 FFSStateRef

impl ExtractPyClassWithClone for FFSStateRef