pub struct PyAngles(pub Angles);Expand description
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
topology : laddu.Topology
Topology describing the 2-to-2 production kinematics in the center-of-momentum frame.
daughter : list of str
Names of particles which are combined to form one of the decay products of the
resonance associated with k3 of the topology.
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: AnglesTrait Implementations§
Source§impl<'py> IntoPyObject<'py> for PyAngles
impl<'py> IntoPyObject<'py> for PyAngles
Source§type Output = Bound<'py, <PyAngles as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyAngles as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClassImpl for PyAngles
impl PyClassImpl for PyAngles
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§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
/// ----------
/// topology : laddu.Topology
/// Topology describing the 2-to-2 production kinematics in the center-of-momentum frame.
/// daughter : list of str
/// Names of particles which are combined to form one of the decay products of the
/// resonance associated with ``k3`` of the topology.
/// 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
///
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 /// ---------- /// topology : laddu.Topology /// Topology describing the 2-to-2 production kinematics in the center-of-momentum frame. /// daughter : list of str /// Names of particles which are combined to form one of the decay products of the /// resonance associated with ``k3`` of the topology. /// 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 ///
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type Layout = <<PyAngles as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyAngles>
type Layout = <<PyAngles as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyAngles>
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Source§impl PyClassNewTextSignature for PyAngles
impl PyClassNewTextSignature for PyAngles
const TEXT_SIGNATURE: &'static str = "(topology, daughter, frame=\"Helicity\")"
Source§impl PyMethods<PyAngles> for PyClassImplCollector<PyAngles>
impl PyMethods<PyAngles> for PyClassImplCollector<PyAngles>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyAngles
impl PyTypeInfo for PyAngles
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
const NAME: &str = <Self as ::pyo3::PyClass>::NAME
prefer using ::type_object(py).name() to get the correct runtime value
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
prefer using ::type_object(py).module() to get the correct runtime value
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
impl DerefToPyAny for PyAngles
Auto Trait Implementations§
impl Freeze for PyAngles
impl RefUnwindSafe for PyAngles
impl Send for PyAngles
impl Sync for PyAngles
impl Unpin for PyAngles
impl UnsafeUnpin for PyAngles
impl UnwindSafe for PyAngles
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.