Struct PyMetaData 

pub struct PyMetaData { /* private fields */ }

Grid metadata.

Implementations

impl PyMetaData

pub fn new( set_desc: String, set_index: u32, num_members: u32, x_min: f64, x_max: f64, q_min: f64, q_max: f64, xsi_min: f64, xsi_max: f64, delta_min: f64, delta_max: f64, flavors: Vec<i32>, format: String, alphas_q_values: Vec<f64>, alphas_vals: Vec<f64>, polarised: bool, set_type: PySetType, interpolator_type: PyInterpolatorType, error_type: String, hadron_pid: i32, phys_params: PyPhysicsParameters, ) -> Self

Constructor for PyMetaData.

pub fn to_dict(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Convert to Python dictionary

Errors

Raises an erro if the values are not Python compatible.

pub fn has_key(&self, key: &str) -> bool

Return True if the given LHAPDF-canonical key is present in the metadata.

pub fn get_entry(&self, key: &str) -> PyResult<String>

Return the string value for an LHAPDF-canonical metadata key.

Errors

Raises KeyError if the key is not present.

pub fn keys(&self) -> Vec<String>

Return a sorted list of all available LHAPDF-canonical metadata keys.

pub const fn set_desc(&self) -> &String

The description of the set.

pub const fn set_index(&self) -> u32

The index of the grid.

pub const fn number_sets(&self) -> u32

The number of sets in the grid.

pub const fn x_min(&self) -> f64

The minimum value of x in the grid.

pub const fn x_max(&self) -> f64

The maximum value of x in the grid.

pub const fn q_min(&self) -> f64

The minimum value of q in the grid.

pub const fn q_max(&self) -> f64

The maximum value of q in the grid.

pub const fn xi_min(&self) -> f64

The minimum value of xi in the grid.

pub const fn xi_max(&self) -> f64

The maximum value of xi in the grid.

pub const fn delta_min(&self) -> f64

The minimum value of delta in the grid.

pub const fn delta_max(&self) -> f64

The maximum value of delta in the grid.

pub const fn pids(&self) -> &Vec<i32>

The particle IDs of the grid.

pub const fn format(&self) -> &String

The format of the grid.

pub const fn alphas_q(&self) -> &Vec<f64>

The values of q for the running of the strong coupling constant.

pub const fn alphas_values(&self) -> &Vec<f64>

The values of the running of the strong coupling constant.

pub const fn is_polarised(&self) -> bool

Whether the grid is polarised.

pub fn set_type(&self) -> PySetType

The type of the set.

pub fn interpolator_type(&self) -> PyInterpolatorType

The interpolation method used for the grid.

pub const fn error_type(&self) -> &String

The type of error.

pub const fn hadron_pid(&self) -> i32

The hadron PID.

Trait Implementations

impl Clone for PyMetaData

fn clone(&self) -> PyMetaData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyMetaData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DerefToPyAny for PyMetaData

impl<'a, 'py> FromPyObject<'a, 'py> for PyMetaData

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyMetaData

type Target = PyMetaData

The Python output type

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

const NAME: &str = "MetaData"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyMetaData

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

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 = /// Grid metadata.

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 Layout = <<PyMetaData as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyMetaData>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

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

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyMetaData

const TEXT_SIGNATURE: &'static str = "(set_desc, set_index, num_members, x_min, x_max, q_min, q_max, xsi_min, xsi_max, delta_min, delta_max, flavors, format, alphas_q_values=..., alphas_vals=..., polarised=False, set_type=..., interpolator_type=..., error_type=..., hadron_pid=2212, phys_params=...)"

impl PyMethods<PyMetaData> for PyClassImplCollector<PyMetaData>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyMetaData

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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.