PyVec3

laddu_python::utils::vectors

Struct PyVec3

pub struct PyVec3(pub Vec3);

Expand description

A 3-momentum vector formed from Cartesian components.

§Parameters

px, py, pz : float The Cartesian components of the 3-vector

Tuple Fields§

§0: Vec3

Implementations§

impl PyVec3

pub fn dot(&self, other: Self) -> Float

Calculate the dot product of two Vec3s.

§Parameters

other : Vec3 A vector input with which the dot product is taken

§Returns

float The dot product of this vector and other

Trait Implementations§

impl Clone for PyVec3

fn clone(&self) -> PyVec3

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'py> IntoPyObject<'py> for PyVec3

type Target = PyVec3

The Python output type

type Output = Bound<'py, <PyVec3 as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more

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 PyVec3

type Frozen = False

Whether the pyclass is frozen. Read more

impl PyClassImpl for PyVec3

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 3-momentum vector formed from Cartesian components. /// /// Parameters /// ---------- /// px, py, pz : float /// The Cartesian components of the 3-vector ///

Docstring for the class provided on the struct or enum. Read more

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyVec3>

This handles following two situations: Read more

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 PyVec3

const TEXT_SIGNATURE: &'static str = "(px, py, pz)"

impl PyClassaddSlotFragment<PyVec3> for PyClassImplCollector<PyVec3>

unsafe fn add( self, py: Python<'_>, _raw_slf: mut PyObject, arg0: mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects Read more

impl PyClassmulSlotFragment<PyVec3> for PyClassImplCollector<PyVec3>

unsafe fn mul( self, py: Python<'_>, _raw_slf: mut PyObject, arg0: mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects Read more

impl PyClassraddSlotFragment<PyVec3> for PyClassImplCollector<PyVec3>

unsafe fn radd( self, py: Python<'_>, _raw_slf: mut PyObject, arg0: mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects Read more

impl PyClassrmulSlotFragment<PyVec3> for PyClassImplCollector<PyVec3>

unsafe fn rmul( self, py: Python<'_>, _raw_slf: mut PyObject, arg0: mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects Read more

impl PyClassrsubSlotFragment<PyVec3> for PyClassImplCollector<PyVec3>

unsafe fn rsub( self, py: Python<'_>, _raw_slf: mut PyObject, arg0: mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects Read more

impl PyClasssubSlotFragment<PyVec3> for PyClassImplCollector<PyVec3>

unsafe fn sub( self, py: Python<'_>, _raw_slf: mut PyObject, arg0: mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects Read more

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

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

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 PyVec3

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

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

impl PyMethods<PyVec3> for PyClassImplCollector<PyVec3>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyVec3

const NAME: &'static str = "Vec3"

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 PyVec3

Auto Trait Implementations§

impl Freeze for PyVec3

impl RefUnwindSafe for PyVec3

impl Send for PyVec3

impl Sync for PyVec3

impl Unpin for PyVec3

impl UnwindSafe for PyVec3

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromPyObject<'_> for T
where T: PyClass + Clone,

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more

impl<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

const NAME: &'static str = <T as PyTypeInfo>::NAME

Name of self. This is used in error messages, for example.

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TransformExt for T

fn compose<T2>(self, t2: T2) -> Compose<Self, T2>

Compose a transform with another. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

impl<T> Ungil for T
where T: Send,