Skip to content

Commit

Permalink
add GLM docu to solution
Browse files Browse the repository at this point in the history
update GLM XML comments
  • Loading branch information
bvenn committed Jun 23, 2024
1 parent 2b814ab commit 2f84f31
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 12 deletions.
1 change: 1 addition & 0 deletions FSharp.Stats.sln
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{23F9FB2E-6
docs\Normalization.fsx = docs\Normalization.fsx
docs\ML.fsx = docs\ML.fsx
docs\Testing.fsx = docs\Testing.fsx
docs\GeneralisedLinearModels.fsx = docs\GeneralisedLinearModels.fsx
docs\_template.html = docs\_template.html
docs\_template.ipynb = docs\_template.ipynb
EndProjectSection
Expand Down
2 changes: 1 addition & 1 deletion docs/GeneralisedLinearModels.fsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

(**
---
title: GLM Documentation
title: GLM
index: 24
category: Documentation
categoryindex: 0
Expand Down
28 changes: 17 additions & 11 deletions src/FSharp.Stats/Algebra/LinearAlgebra.fs
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,14 @@ module LinearAlgebra =
// else LinearAlgebraManaged.QR a
LinearAlgebraManaged.QR a

/// Performs QR decomposition using an alternative algorithm.
/// Returns the orthogonal matrix Q and the upper triangular matrix R.
/// <summary>Performs QR decomposition using an alternative algorithm.</summary>
/// <remarks></remarks>
/// <param name="A">input matrix</param>
/// <returns>Returns the orthogonal matrix Q and the upper triangular matrix R.</returns>
/// <example>
/// <code>
/// </code>
/// </example>
let qrAlternative (A: Matrix<float>) =
let m: int = A.NumRows
let n: int = A.NumCols
Expand Down Expand Up @@ -266,15 +272,15 @@ module LinearAlgebra =

q, r

/// Solves a linear system of equations using QR decomposition.
///
/// Parameters:
/// - A: The coefficient matrix of the linear system.
/// - t: The target vector of the linear system.
///
/// Returns:
/// - mX: The solution vector of the linear system.
/// - r: The upper triangular matrix obtained from QR decomposition.
/// <summary>Solves a linear system of equations using QR decomposition.</summary>
/// <remarks></remarks>
/// <param name="A">The coefficient matrix of the linear system</param>
/// <param name="t">The target vector of the linear system</param>
/// <returns>mX: The solution vector of the linear system; r: The upper triangular matrix obtained from QR decomposition.</returns>
/// <example>
/// <code>
/// </code>
/// </example>
let solveLinearQR (A: Matrix<float>) (t: Vector<float>) =
let m = A.NumRows
let n = A.NumCols
Expand Down

0 comments on commit 2f84f31

Please sign in to comment.