Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update linfit.jl for readibility #37

Merged
merged 1 commit into from
Dec 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/linfit.jl
Original file line number Diff line number Diff line change
Expand Up @@ -141,13 +141,16 @@ ExpFit(x::AbstractVector{T}, y::AbstractVector{T}) where {T<:Number} = ExpFit{T}
# Generic interface for curve fitting.
The same function `curve_fit` can be used to fit the data depending on fit type,
shich is specified in the first parameter. This function returns an object that
which is specified in the first parameter. This function returns an object that
can be used to estimate the value of the fitting model using function `apply_fit`.
## A few examples:
* `f = curve_fit(LinearFit, x, y)`
* `f = curve_fit(Polynomial, x, y, n)`
Other types of fit include: LogFit, PowerFit, ExpFit, LinearKingFit, KingFit, RationalPoly. See the documentation for details.
"""
curve_fit(::Type{T}, x, y) where {T<:AbstractLeastSquares} = T(x, y)
curve_fit(::Type{T}, x, y, args...) where {T<:AbstractLeastSquares} = T(x, y, args...)
Expand Down