Merge pull request #19 from JuliaStats/aa/linpred

Add `linearpredictor` and `linearpredictor!`
JuliaStats · Aug 3, 2022 · 14e0ba7 · 14e0ba7 · ararslan · Aug 3, 2022
2 parents e42a88a + a634719
commit 14e0ba7
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ docs/site/
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
+Manifest.toml
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "StatsAPI"
 uuid = "82ae8749-77ed-4fe6-ae5f-f523153014b0"
 authors = ["Milan Bouchet-Valat <[email protected]"]
-version = "1.4.0"
+version = "1.5.0"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

diff --git a/src/regressionmodel.jl b/src/regressionmodel.jl
@@ -114,6 +114,21 @@ function reconstruct! end
     offset(model::RegressionModel)
 
 Return the offset used in the model, i.e. the term added to the linear predictor with
-known coefficient 1.
+known coefficient 1, or `nothing` if the model was not fit with an offset.
 """
 function offset end
+
+"""
+    linearpredictor(model::RegressionModel)
+
+Return the model's linear predictor, `Xβ` where `X` is the model matrix and `β` is the
+vector of coefficients, or `Xβ + offset` if the model was fit with an offset.
+"""
+function linearpredictor end
+
+"""
+    linearpredictor!(storage, model::RegressionModel)
+
+In-place version of [`linearpredictor`](@ref), storing the result in `storage`.
+"""
+function linearpredictor! end