Struct RateTable 

pub struct RateTable {
    pub summary: String,
    /* private fields */
}

Population mortality rate table.

A multi-dimensional table of mortality rates indexed by age, calendar year, sex, and potentially other factors. Used with survexp() to compute expected survival based on population mortality.

Fields

summary: String

Summary/description of the table

Implementations

impl RateTable

pub fn new( dimensions: Vec<RateDimension>, rates: Vec<f64>, summary: Option<String>, ) -> PyResult<Self>

Create a new rate table

Arguments

• dimensions - Vector of dimension definitions
• rates - Flattened array of mortality rates
• summary - Description of the table

pub fn ndim(&self) -> usize

Get the number of dimensions

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

Get dimension names

pub fn lookup(&self, coords: HashMap<String, f64>) -> PyResult<f64>

Lookup mortality rate for given coordinates

Arguments

• coords - HashMap mapping dimension names to values

Returns

Daily hazard rate at the specified coordinates

pub fn lookup_interpolate(&self, coords: HashMap<String, f64>) -> PyResult<f64>

Lookup with interpolation for continuous dimensions

pub fn cumulative_hazard( &self, age_start: f64, age_end: f64, year_start: f64, sex: Option<i32>, ) -> PyResult<f64>

Get cumulative hazard over a time interval

Arguments

• age_start - Starting age (in days)
• age_end - Ending age (in days)
• year_start - Starting calendar year
• sex - Sex (0=male, 1=female typically)

Returns

Cumulative hazard over the interval

pub fn expected_survival( &self, age_start: f64, age_end: f64, year_start: f64, sex: Option<i32>, ) -> PyResult<f64>

Get expected survival probability over a time interval

Trait Implementations

impl Clone for RateTable

fn clone(&self) -> RateTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateTable

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for RateTable

type Target = RateTable

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RateTable

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 = /// Population mortality rate table. /// /// A multi-dimensional table of mortality rates indexed by age, calendar year, /// sex, and potentially other factors. Used with survexp() to compute expected /// survival based on population mortality.

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RateTable>

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

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RateTable

const TEXT_SIGNATURE: &'static str = "(dimensions, rates, summary=None)"

impl PyMethods<RateTable> for PyClassImplCollector<RateTable>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RateTable

const NAME: &'static str = "RateTable"

Class name.

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

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 RateTable

impl ExtractPyClassWithClone for RateTable