Struct PyGridArray 

pub struct PyGridArray { /* private fields */ }

Python wrapper for the GridArray struct.

Implementations

impl PyGridArray

pub fn new(pids: Vec<i32>, subgrids: Vec<PyRef<'_, PySubGrid>>) -> Self

Constructs a new GridArray from a list of particle IDs and subgrids.

Parameters

• pids: The list of particle IDs.
• subgrids: The list of subgrid objects.

Returns

Returns a new PyGridArray instance.

pub fn pids(&self) -> Vec<i32>

Returns the particle IDs associated with this grid array.

pub fn subgrids(&self) -> Vec<PySubGrid>

Returns the subgrids contained in this grid array.

Trait Implementations

impl<'py> IntoPyObject<'py> for PyGridArray

type Target = PyGridArray

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyGridArray

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 = /// Python wrapper for the `GridArray` struct.

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

This handles following two situations:

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 PyGridArray

const TEXT_SIGNATURE: &'static str = "(pids, subgrids)"

impl PyMethods<PyGridArray> for PyClassImplCollector<PyGridArray>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyGridArray

const NAME: &'static str = "GridArray"

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 PyGridArray

impl ExtractPyClassWithClone for PyGridArray