Struct Terms 

pub struct Terms { /* private fields */ }

The terms of a model, before any data is seen.

use prospicio_models::{Column, Frame, Terms};

let train = Frame::new(vec![
    ("age".into(), Column::Numeric(vec![30.0, 45.0, 60.0])),
    ("region".into(), Column::Categorical(vec!["N".into(), "S".into(), "W".into()])),
])
.unwrap();
let coding = Terms::new().intercept().numeric("age").factor("region").fit(&train).unwrap();
assert_eq!(coding.names(), ["(Intercept)", "age", "region[S]", "region[W]"]);
let d = coding.design(&train).unwrap();
assert_eq!(d.column(3), [0.0, 0.0, 1.0]);

Implementations

impl Terms

pub fn new() -> Self

No terms.

pub fn intercept(self) -> Self

Adds an intercept.

pub fn numeric(self, name: &str) -> Self

Adds a numeric column.

pub fn factor(self, name: &str) -> Self

Adds a factor with the default reference level.

pub fn factor_with_reference(self, name: &str, reference: &str) -> Self

Adds a factor with the given reference level.

pub fn interaction(self, a: &str, b: &str) -> Self

Adds the interaction of two columns; see Term::Interaction.

pub fn poly(self, name: &str, degree: usize) -> Self

Adds raw powers of a numeric column up to degree.

pub fn hinges(self, name: &str, knots: &[f64]) -> Self

Adds hinge functions max(0, x − k) at knots.

pub fn steps(self, name: &str, knots: &[f64]) -> Self

Adds steps 1[x ≥ k] at knots.

pub fn bins(self, name: &str, cuts: &[f64]) -> Self

Adds a numeric column cut into bins at cuts, the lowest bin as reference.

pub fn log(self, name: &str, base: f64) -> Self

Adds ln(x / base).

pub fn ordinal(self, name: &str, levels: &[&str]) -> Self

Adds an ordered factor in cumulative coding, levels in levels’ order.

pub fn orthogonal_poly(self, name: &str, degree: usize) -> Self

Adds orthogonal polynomials of a numeric column up to degree.

pub fn natural_spline(self, name: &str, knots: &[f64]) -> Self

Adds a natural cubic spline with interior knots, its boundary knots the training range.

pub fn term(self, term: Term) -> Self

Adds any term.

pub fn fit(&self, frame: &Frame) -> Result<Coding>

Learns factor levels from frame. Fails if a column is missing or has the wrong kind, or a reference level does not occur.

Trait Implementations

impl Clone for Terms

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Terms

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

Formats the value using the given formatter.

impl Default for Terms

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Terms

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Terms