Solutions
DataDrivenDiffEq.DataDrivenSolution
— Typestruct DataDrivenSolution{T} <: DataDrivenDiffEq.AbstractDataDrivenSolution
The solution to a DataDrivenProblem
derived via a certain algorithm. The solution is represented via an Basis
, which makes it callable.
Fields
basis
: The basis representation of the solutionretcode
: Returncodealg
: Algorithmout
: Original output of the solution algorithmprob
: Problemresiduals
: Residual sum of squaresdof
: Degrees of freedominternal_problem
: Internal problem
API
DataDrivenDiffEq.get_problem
— Functionget_problem(r)
Returns the original DataDrivenProblem
.
DataDrivenDiffEq.get_basis
— Functionget_basis(r)
Returns the recovered Basis
.
DataDrivenDiffEq.get_algorithm
— Functionget_algorithm(r)
Returns the algorithm used to derive the solution.
DataDrivenDiffEq.get_results
— Functionget_results(r)
Returns the original output of the algorithm.
DataDrivenDiffEq.is_converged
— Functionis_converged(r)
Assert the result of the DataDrivenSolution
and returns true
if successful, false
otherwise.
Additionally, DataDrivenDiffEq.jl
extends the following methods for a DataDrivenSolution
.
StatsAPI.dof
— Functiondof(sol)
Returns the degrees of freedom of the DataDrivenSolution
.
StatsAPI.rss
— Functionrss(sol)
Returns the residual sum of squares of the DataDrivenSolution
.
StatsAPI.nobs
— Functionnobs(sol)
Returns the number of observations of the DataDrivenSolution
.
StatsAPI.loglikelihood
— Functionloglikelihood(sol)
Returns the log-likelihood of the DataDrivenSolution
assuming a normal distributed error.
StatsAPI.nullloglikelihood
— Functionnullloglikelihood(sol)
Return the null log-likelihood of the DataDrivenSolution
. This corresponds to a model only fitted with an intercept and a normal distributed error.
StatsAPI.r2
— Functionr2(sol)
Return the coefficient of determination of the DataDrivenSolution
.
Note
Only implements CoxSnell
based on the loglikelihood
and nullloglikelihood
.
StatsBase.summarystats
— Functionsummarystats(sol)
Returns the summarystats
for each row of the error for the DataDrivenSolution
.