PSM.linear.linear

Creates a new linear PSM object

Syntax


obj = PSM.linear(slopes)
obj = PSM.linear(slopes, intercept)

Description


obj = PSM.linear(slopes)

Initializes a new linear PSM object. The “slopes” input should have one element per variable in the linear model. The order of slopes should match the order of state vector rows / the order in which state vector variables are passed into the linear model. Uses an intercept of 0.

The subsequent linear forward model will use the form Y = slopes(1)*X1 + slopes(2)*X2 + … slopes(N)*XN


obj = PSM.linear(slopes, intercept)

Specify an intercept for the linear model. The subsequent linear model will have form: Y = slopes(1)*X1 + slopes(2)*X2 + … slopes(N)*XN + intercept

Input Arguments

slopes

slopes

numeric vector [nVariables]

The slopes / linear coefficients for the variables in the linear model. The number of slopes determines the number of variables used in the model.

intercept

intercept

numeric scalar

An intercept for the linear model. By default, uses an intercept of 0.

Output Arguments

obj

obj

scalar PSM.*linear* object

The new linear PSM object