Struct PyComplex

#[repr(transparent)]
pub struct PyComplex(PyAny);

Represents a Python complex object.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyComplex> or Bound<'py, PyComplex>.

For APIs available on complex objects, see the PyComplexMethods trait which is implemented for Bound<'py, PyComplex>.

Note that PyComplex supports only basic operations. For advanced operations consider using num-complex’s Complex type instead. This optional dependency can be activated with the num-complex feature flag.

Tuple Fields

0: PyAny

Implementations

impl PyComplex

pub fn from_complex_bound<F: Into<c_double>>( py: Python<'_>, complex: Complex<F>, ) -> Bound<'_, PyComplex>

Available on crate feature num-complex only.

Creates a new Python PyComplex object from num_complex’s Complex.

impl PyComplex

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyComplex

pub fn from_doubles( py: Python<'_>, real: c_double, imag: c_double, ) -> Bound<'_, PyComplex>

Creates a new PyComplex from the given real and imaginary values.

pub fn from_doubles_bound( py: Python<'_>, real: c_double, imag: c_double, ) -> Bound<'_, PyComplex>

👎Deprecated since 0.23.0: renamed to PyComplex::from_doubles

Deprecated name for PyComplex::from_doubles.

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsRef<PyAny> for PyComplex

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyComplex

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyClassBaseType for PyComplex

Available on non-Py_LIMITED_API only.

type LayoutAsBase = PyClassObjectBase<PyComplexObject>

type BaseNativeType = PyComplex

type Initializer = PyNativeTypeInitializer<PyComplex>

type PyClassMutability = ImmutableClass

impl PyTypeInfo for PyComplex

const NAME: &'static str = "PyComplex"

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 is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Returns the safe abstraction over the type object.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::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.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyComplex

impl PyLayout<PyComplex> for PyComplexObject

impl PySizedLayout<PyComplex> for PyComplexObject