pub struct PyEvent(pub Arc<Event>);Expand description
A single event
Events are composed of a set of 4-momenta of particles in the overall center-of-momentum frame, polarizations or helicities described by 3-vectors, and a weight
§Parameters
p4s : list of Vec4
4-momenta of each particle in the event in the overall center-of-momentum frame
aux: list of Vec3
3-vectors describing auxiliary data for each particle given in p4s
weight : float
The weight associated with this event
rest_frame_indices : list of int, optional
If supplied, the event will be boosted to the rest frame of the 4-momenta at the
given indices
Tuple Fields§
§0: Arc<Event>Implementations§
Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for PyEvent
impl<'py> IntoPyObject<'py> for PyEvent
Source§type Output = Bound<'py, <PyEvent as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyEvent as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
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>
Performs the conversion.
Source§impl PyClassImpl for PyEvent
impl PyClassImpl for PyEvent
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// A single event
///
/// Events are composed of a set of 4-momenta of particles in the overall
/// center-of-momentum frame, polarizations or helicities described by 3-vectors, and a
/// weight
///
/// Parameters
/// ----------
/// p4s : list of Vec4
/// 4-momenta of each particle in the event in the overall center-of-momentum frame
/// aux: list of Vec3
/// 3-vectors describing auxiliary data for each particle given in `p4s`
/// weight : float
/// The weight associated with this event
/// rest_frame_indices : list of int, optional
/// If supplied, the event will be boosted to the rest frame of the 4-momenta at the
/// given indices
///
const RAW_DOC: &'static CStr = /// A single event /// /// Events are composed of a set of 4-momenta of particles in the overall /// center-of-momentum frame, polarizations or helicities described by 3-vectors, and a /// weight /// /// Parameters /// ---------- /// p4s : list of Vec4 /// 4-momenta of each particle in the event in the overall center-of-momentum frame /// aux: list of Vec3 /// 3-vectors describing auxiliary data for each particle given in `p4s` /// weight : float /// The weight associated with this event /// rest_frame_indices : list of int, optional /// If supplied, the event will be boosted to the rest frame of the 4-momenta at the /// given indices ///
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyEvent>
type ThreadChecker = SendablePyClass<PyEvent>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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>
Source§impl PyClassNewTextSignature for PyEvent
impl PyClassNewTextSignature for PyEvent
const TEXT_SIGNATURE: &'static str = "(p4s, aux, weight, *, rest_frame_indices=None)"
Source§impl PyMethods<PyEvent> for PyClassImplCollector<PyEvent>
impl PyMethods<PyEvent> for PyClassImplCollector<PyEvent>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyEvent
impl PyTypeInfo for PyEvent
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for PyEvent
Auto Trait Implementations§
impl Freeze for PyEvent
impl RefUnwindSafe for PyEvent
impl Send for PyEvent
impl Sync for PyEvent
impl Unpin for PyEvent
impl UnwindSafe for PyEvent
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FromPyObject<'_> for T
impl<T> FromPyObject<'_> for T
Source§impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
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>
Converts
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>
Converts
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>
Converts
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§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>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
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
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.