Skip to content

Commit

Permalink
Update API doc of LinearModelResult.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbaudin47 committed Jul 8, 2023
1 parent be1cc0e commit e06935e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions python/src/LinearModelResult_doc.i.in
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,26 @@ Returns
-------
intercept : Bool
"

// ---------------------------------------------------------------------

%feature("docstring") OT::LinearModelResult::getDesign
"Returns if intercept is provided in the basis or not.

Returns
-------
designMatrix: :class:`~openturns.Matrix`
The design matrix :math:`X`."

// ---------------------------------------------------------------------

%feature("docstring") OT::LinearModelResult::computeProjectionMatrix
"Returns if intercept is provided in the basis or not.

Returns
-------
projectionMatrix: :class:`~openturns.SymmetricMatrix`
The projection matrix:

.. math::
H = X \left(X^T X\right)^{-1} X^T."

0 comments on commit e06935e

Please sign in to comment.