Struct pyo3::types::PyComplex

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

Represents a Python complex.

Methods

impl PyComplex

pub fn from_doubles(py: Python, real: c_double, imag: c_double) -> &PyComplex

Creates a new Python PyComplex object, from its real and imaginary values.

pub fn real(&self) -> c_double

Returns the real value of PyComplex.

pub fn imag(&self) -> c_double

Returns the imaginary value of PyComplex.

pub fn abs(&self) -> c_double

Returns |self|.

pub fn pow(&self, other: &PyComplex) -> &PyComplex

Returns self ** other

Trait Implementations

impl AsPyPointer for PyComplex

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl ToPyObject for PyComplex

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl PyNativeType for PyComplex

fn py(&self) -> Python

impl PyTypeInfo for PyComplex

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyObjectAlloc for PyComplex

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeObject for PyComplex

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl<'a> From<&'a PyComplex> for &'a PyAny

fn from(ob: &'a PyComplex) -> Self

Performs the conversion.

impl PartialEq<PyComplex> for PyComplex

fn eq(&self, o: &PyComplex) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl AsRef<PyAny> for PyComplex

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Display for PyComplex

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Debug for PyComplex

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'py> Add<&'py PyComplex> for &'py PyComplex

type Output = &'py PyComplex

The resulting type after applying the + operator.

fn add(self, other: &'py PyComplex) -> &'py PyComplex

Performs the + operation.

impl<'py> Sub<&'py PyComplex> for &'py PyComplex

type Output = &'py PyComplex

The resulting type after applying the - operator.

fn sub(self, other: &'py PyComplex) -> &'py PyComplex

Performs the - operation.

impl<'py> Mul<&'py PyComplex> for &'py PyComplex

type Output = &'py PyComplex

The resulting type after applying the * operator.

fn mul(self, other: &'py PyComplex) -> &'py PyComplex

Performs the * operation.

impl<'py> Div<&'py PyComplex> for &'py PyComplex

type Output = &'py PyComplex

The resulting type after applying the / operator.

fn div(self, other: &'py PyComplex) -> &'py PyComplex

Performs the / operation.

impl<'py> Neg for &'py PyComplex

type Output = &'py PyComplex

The resulting type after applying the - operator.

fn neg(self) -> &'py PyComplex

Performs the unary - operation.