Struct PyPolarization 

pub struct PyPolarization(pub Polarization);

A Variable used to define both the polarization angle and magnitude of the given particle``

This class combines laddu.PolAngle and laddu.PolMagnitude into a single object

Parameters

beam : int The index of the beam particle recoil : list of int Indices of particles which are combined to form the recoiling particle (particles which are not beam or part of the resonance) beam_polarization : int The index of the auxiliary vector in storing the beam particle’s polarization

See Also

laddu.PolAngle laddu.PolMagnitude

Tuple Fields

0: Polarization

Trait Implementations

impl Clone for PyPolarization

fn clone(&self) -> PyPolarization

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for PyPolarization

type Target = PyPolarization

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyPolarization

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 = /// A Variable used to define both the polarization angle and magnitude of the given particle`` /// /// This class combines ``laddu.PolAngle`` and ``laddu.PolMagnitude`` into a single /// object /// /// Parameters /// ---------- /// beam : int /// The index of the `beam` particle /// recoil : list of int /// Indices of particles which are combined to form the recoiling particle (particles which /// are not `beam` or part of the `resonance`) /// beam_polarization : int /// The index of the auxiliary vector in storing the `beam` particle's polarization /// /// See Also /// -------- /// laddu.PolAngle /// laddu.PolMagnitude ///

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

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 PyPolarization

const TEXT_SIGNATURE: &'static str = "(beam, recoil, beam_polarization)"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyPolarization

type Holder = Option<PyClassGuard<'a, PyPolarization>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut PyPolarization

type Holder = Option<PyClassGuardMut<'a, PyPolarization>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<PyPolarization> for PyClassImplCollector<PyPolarization>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyPolarization

const NAME: &'static str = "Polarization"

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 PyPolarization