Struct PyPDFSet 

pub struct PyPDFSet { /* private fields */ }

LHAPDF-compatible interface to a PDF set.

Provides the same API as lhapdf.PDFSet.

Implementations

impl PyPDFSet

pub fn new(name: &str) -> Self

Create a new PDFSet for a given set name.

Parameters

name : str The name of the PDF set.

pub fn name(&self) -> &str

The name of the PDF set.

pub const fn size(&self) -> u32

Total number of members (central value + error members).

pub fn description(&self) -> &str

Human-readable description of the PDF set.

pub fn error_type(&self) -> &str

Error type string (e.g. replicas, hessian).

pub const fn lhapdf_id(&self) -> u32

LHAPDF ID for member 0 of this set.

pub fn info(&self) -> PyMetaData

Return the metadata for this set as a MetaData object.

pub fn mk_pdf(&self, member: usize) -> PyPDF

Load a single PDF member by index.

Parameters

member : int Member index. Defaults to 0 (central value).

pub fn mk_pdfs(&self, method: &PyLoaderMethod) -> Vec<PyPDF>

Load all members of this PDF set.

Parameters

method : LoaderMethod Loading strategy. Defaults to Parallel.

pub fn error_conf_level(&self) -> f64

Confidence level (in %) at which the set’s error members were constructed.

Returns -1.0 when the ErrorConfLevel field is absent from the .info file, matching the LHAPDF convention.

pub fn uncertainty( &self, values: Vec<f64>, cl: f64, alternative: bool, ) -> PyResult<PyUncertainty>

Compute PDF uncertainty from a slice of per-member values.

Parameters

values : list[float] Per-member values at a given kinematic point. Element 0 is the central member; the remaining elements are the error members. cl : float Output confidence level in %. Defaults to CL_1_SIGMA (~ 68.27 %). alternative : bool If True, replica sets use a quantile-based asymmetric interval instead of the standard deviation. Defaults to False.

Errors

Raises ValueError if values is empty.

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

Return True if the given LHAPDF-canonical key is present in this set’s 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.

Trait Implementations

impl DerefToPyAny for PyPDFSet

impl ExtractPyClassWithClone for PyPDFSet

impl<'py> IntoPyObject<'py> for PyPDFSet

type Target = PyPDFSet

The Python output type

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

const NAME: &str = "PDFSet"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyPDFSet

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 = /// LHAPDF-compatible interface to a PDF set. /// /// Provides the same API as `lhapdf.PDFSet`.

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

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 PyPDFSet

const TEXT_SIGNATURE: &'static str = "(name)"

impl PyMethods<PyPDFSet> for PyClassImplCollector<PyPDFSet>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyPDFSet

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.