Trait Transform

pub trait Transform {
    // Required methods
    fn nat_param<F: Float>(lin_pred: Array1<F>) -> Array1<F>;
    fn d_nat_param<F: Float>(lin_pred: &Array1<F>) -> Array1<F>;

    // Provided method
    fn adjust_errors_variance<F: Float>(
        errors: Array1<F>,
        variance: Array1<F>,
        lin_pred: &Array1<F>,
    ) -> (Array1<F>, Array1<F>) { ... }
}

Required Methods

fn nat_param<F: Float>(lin_pred: Array1<F>) -> Array1<F>

The natural parameter(s) of the response distribution as a function of the linear predictor. For canonical link functions this is the identity. It must be monotonic, invertible, and twice-differentiable. For link function g and canonical link function g_0 it is equal to g_0 ( g^{-1}(lin_pred) ) .

fn d_nat_param<F: Float>(lin_pred: &Array1<F>) -> Array1<F>

The derivative of the transformation to the natural parameter. If it is zero in a region that the IRLS is in the algorithm may have difficulty converging.

Provided Methods

fn adjust_errors_variance<F: Float>( errors: Array1<F>, variance: Array1<F>, lin_pred: &Array1<F>, ) -> (Array1<F>, Array1<F>)

Adjust the error and variance terms of the likelihood function based on the first and second derivatives of the transformation. The adjustment is performed simultaneously. The linear predictor must be un-transformed, i.e. it must be X*beta without the transformation applied.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Transform for Cloglog

impl<T> Transform for T

where T: Canonical,