Struct PyAngles 

pub struct PyAngles(pub Angles);

A Variable used to define both spherical decay angles in the given frame

This class combines laddu.CosTheta and laddu.Phi 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) daughter : list of int Indices of particles which are combined to form one of the decay products of the resonance resonance : list of int Indices of particles which are combined to form the resonance frame : {‘Helicity’, ‘HX’, ‘HEL’, ‘GottfriedJackson’, ‘Gottfried Jackson’, ‘GJ’, ‘Gottfried-Jackson’} The frame to use in the calculation

Raises

ValueError If frame is not one of the valid options

See Also

laddu.CosTheta laddu.Phi

Tuple Fields

0: Angles

Trait Implementations

impl Clone for PyAngles

fn clone(&self) -> PyAngles

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for PyAngles

type Target = PyAngles

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyAngles

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 spherical decay angles in the given frame /// /// This class combines ``laddu.CosTheta`` and ``laddu.Phi`` 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`) /// daughter : list of int /// Indices of particles which are combined to form one of the decay products of the /// `resonance` /// resonance : list of int /// Indices of particles which are combined to form the `resonance` /// frame : {'Helicity', 'HX', 'HEL', 'GottfriedJackson', 'Gottfried Jackson', 'GJ', 'Gottfried-Jackson'} /// The frame to use in the calculation /// /// Raises /// ------ /// ValueError /// If `frame` is not one of the valid options /// /// See Also /// -------- /// laddu.CosTheta /// laddu.Phi ///

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

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 PyAngles

const TEXT_SIGNATURE: &'static str = "(beam, recoil, daughter, resonance, frame=\"Helicity\")"

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

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

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 PyAngles

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

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

impl PyMethods<PyAngles> for PyClassImplCollector<PyAngles>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyAngles

const NAME: &'static str = "Angles"

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 PyAngles