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

Issue ngcd #318

Merged
merged 40 commits into from
Mar 23, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
657112d
WIP
jverzani Feb 5, 2021
2f5080e
WIP
jverzani Feb 6, 2021
154052f
WIP
jverzani Feb 7, 2021
c52febd
move symbol into type
jverzani Feb 9, 2021
409d49e
clean up
jverzani Feb 9, 2021
2f91ef3
change what iteration means for a polynomial
jverzani Feb 9, 2021
5a84d9f
adjust integrate to return polynomial of same type, even if NaN
jverzani Feb 10, 2021
a2fc233
clean up offset vector tests
jverzani Feb 11, 2021
5a47053
drop OffsetArrays dependency; clean up scalar operations for Immutabl…
jverzani Feb 14, 2021
7a350ca
cleanup
jverzani Feb 14, 2021
166522b
change error into ArgumentError
jverzani Feb 14, 2021
b398f03
replace isnothing; standardize check for same variable
jverzani Feb 15, 2021
1426b38
registerN, bug
jverzani Feb 15, 2021
b3ca9c0
update documentation
jverzani Feb 15, 2021
fc3014b
minor edits
jverzani Feb 17, 2021
206de82
cleanup, docfix
jverzani Feb 18, 2021
5d52918
clean up integration
jverzani Feb 19, 2021
a031b8e
adjust doc string
jverzani Feb 19, 2021
93c15ea
WIP
jverzani Feb 20, 2021
264189d
WIP
jverzani Feb 22, 2021
b9324b6
WIP
jverzani Feb 22, 2021
5349be1
work on promotion for + and * operations
jverzani Feb 22, 2021
c0d688c
edits
jverzani Feb 23, 2021
38110e0
laurent polynomial depwarns removed
jverzani Feb 23, 2021
dfe1d73
run doctests
jverzani Feb 23, 2021
dff6629
WIP
jverzani Feb 24, 2021
65a7c92
fix basis symbol handling
jverzani Feb 24, 2021
e57784d
WIP
jverzani Feb 25, 2021
7470f25
WIP
jverzani Feb 25, 2021
316a1ff
adjust evaluation so that implemented evalpoly instead of call syntax…
jverzani Feb 25, 2021
3cfb7f8
add example to extending; specialize evalpoly rather than call syntax
jverzani Feb 25, 2021
226ac83
Merge branch 'v2.0.0-add-examples' into v2.0.0
jverzani Feb 25, 2021
456bc09
refactor truncate! chop!
jverzani Feb 26, 2021
c5e155e
oops
jverzani Feb 26, 2021
1e89476
move things into common (truncate, chop, zero, one,variable, basis)
jverzani Mar 2, 2021
8d30e68
merge changes
jverzani Mar 23, 2021
3450f5e
close issue #316
jverzani Mar 23, 2021
9baddaa
remove changes from a different branch
jverzani Mar 23, 2021
3cd3e77
fix issue with ngcd
jverzani Mar 23, 2021
62dea56
version bump
jverzani Mar 23, 2021
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
Prev Previous commit
Next Next commit
WIP
  • Loading branch information
jverzani committed Feb 6, 2021
commit 2f5080e0dbc336f57c882e71223e1c9a9b6b5883
10 changes: 5 additions & 5 deletions src/Polynomials.jl
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ include("common.jl")
# Polynomials
include("polynomials/standard-basis.jl")
include("polynomials/Polynomial.jl")
#include("polynomials/ImmutablePolynomial.jl")
#include("polynomials/SparsePolynomial.jl")
#include("polynomials/LaurentPolynomial.jl")
#include("polynomials/ngcd.jl")
#include("polynomials/multroot.jl")
include("polynomials/ImmutablePolynomial.jl")
include("polynomials/SparsePolynomial.jl")
include("polynomials/LaurentPolynomial.jl")
include("polynomials/ngcd.jl")
include("polynomials/multroot.jl")

#include("polynomials/ChebyshevT.jl")

Expand Down
19 changes: 10 additions & 9 deletions src/abstract.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ export AbstractPolynomial
const SymbolLike = Union{AbstractString,Char,Symbol}

"""
AbstractPolynomial{T, X}
AbstractPolynomial{T}

An abstract container for various polynomials.

# Properties
- `coeffs` - The coefficients of the polynomial
"""
abstract type AbstractPolynomial{T, X} end
abstract type AbstractPolynomial{T,X} end

# We want ⟒(P{α…,T}) = P{α…}; this default
# works for most cases
⟒(P::Type{<:AbstractPolynomial}) = constructorof(P)

# convert `as` into polynomial of type P based on instance, inheriting variable
# (and for LaurentPolynomial the offset)
_convert(p::P, as) where {P <: AbstractPolynomial} = ⟒(P)(as, var(P))
_convert(p::P, as) where {P <: AbstractPolynomial} = ⟒(P){eltype(as), var(P)}(as) # ⟒(P)(as, var(P))

"""
Polynomials.@register(name)
Expand Down Expand Up @@ -50,17 +50,18 @@ macro register(name)
$poly(coeffs::AbstractVector{T}, var::SymbolLike = :x) where {T} =
$poly{T, Symbol(var)}(coeffs)
$poly{T}(x::AbstractVector{S}, var::SymbolLike = :x) where {T,S<:Number} =
$poly(T.(x), Symbol(var))
$poly{T,Symbol(var)}(T.(x))
function $poly(coeffs::G, var::SymbolLike=:x) where {G}
!Base.isiterable(G) && throw(ArgumentError("coeffs is not iterable"))
$poly(collect(coeffs), var)
cs = collect(coeffs)
$poly{eltype(cs), Symbol(var)}(cs)
end
$poly{T,X}(n::S) where {X, T, S<:Number} =
n * one($poly{T}, X)
$poly{T,X}(n::S) where {T, X, S<:Number} =
n * one($poly{T, X})
$poly{T}(n::S, var::SymbolLike = :x) where {T, S<:Number} =
n * one($poly{T}, Symbol(var))
$poly(n::S, var::SymbolLike = :x) where {S <: Number} = n * one($poly{S}, Symbol(var))
$poly{T}(var::SymbolLike=:x) where {T} = variable($poly{T}, Symbol(var))
$poly(n::S, var::SymbolLike = :x) where {S <: Number} = n * one($poly{S, Symbol(var)})
$poly{T}(var::SymbolLike=:x) where {T} = variable($poly{T, Symbol(var)})
$poly(var::SymbolLike=:x) = variable($poly, Symbol(var))
end
end
Expand Down
11 changes: 10 additions & 1 deletion src/common.jl
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,7 @@ export var
Returns a representation of 0 as the given polynomial.
"""
Base.zero(::Type{P}, var=:x) where {P <: AbstractPolynomial} = ⟒(P)(zeros(eltype(P), 1), var)
Base.zero(::Type{P}) where {T, X, P<:AbstractPolynomial{T,X}} = ⟒(P){T,X}(zeros(T,1))
Base.zero(p::P) where {P <: AbstractPolynomial} = zero(P, var(p))
"""
one(::Type{<:AbstractPolynomial})
Expand All @@ -535,6 +536,7 @@ Base.zero(p::P) where {P <: AbstractPolynomial} = zero(P, var(p))
Returns a representation of 1 as the given polynomial.
"""
Base.one(::Type{P}, var=:x) where {P <: AbstractPolynomial} = ⟒(P)(ones(eltype(P),1), var) # assumes p₀ = 1
Base.one(::Type{P}) where {T, X, P<:AbstractPolynomial{T,X}} = ⟒(P){T,X}(ones(T,1))
Base.one(p::P) where {P <: AbstractPolynomial} = one(P, var(p))

Base.oneunit(::Type{P}, args...) where {P <: AbstractPolynomial} = one(P, args...)
Expand Down Expand Up @@ -567,6 +569,7 @@ julia> roots((x - 3) * (x + 2))
"""
variable(::Type{P}, var::SymbolLike = :x) where {P <: AbstractPolynomial} = MethodError()
variable(p::AbstractPolynomial, var::SymbolLike = var(p)) = variable(typeof(p), var)
variable(::Type{P}) where {T,X, P <: AbstractPolynomial{T,X}} = variable(P, X)
variable(var::SymbolLike = :x) = variable(Polynomial{Int}, var)

# basis
Expand All @@ -577,8 +580,14 @@ variable(var::SymbolLike = :x) = variable(Polynomial{Int}, var)
function basis(::Type{P}, k::Int, _var::SymbolLike=:x; var=_var) where {P <: AbstractPolynomial}
zs = zeros(Int, k+1)
zs[end] = 1
⟒(P){eltype(P)}(zs, var)
⟒(P){eltype(P), _var}(zs)
end
function basis(::Type{P}, k::Int) where {T, X, P<:AbstractPolynomial{T,X}}
zs = zeros(Int, k+1)
zs[end] = 1
⟒(P){eltype(P), X}(zs)
end

basis(p::P, k::Int, _var::SymbolLike=:x; var=_var) where {P<:AbstractPolynomial} = basis(P, k, var)

#=
Expand Down
140 changes: 60 additions & 80 deletions src/polynomials/ImmutablePolynomial.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export ImmutablePolynomial

"""
ImmutablePolynomial{T<:Number, N}(coeffs::AbstractVector{T}, var=:x)
ImmutablePolynomial{T<:Number, X, N}(coeffs::AbstractVector{T})

Construct an immutable (static) polynomial from its coefficients
`a₀, a₁, …, aₙ`,
Expand Down Expand Up @@ -45,108 +45,88 @@ ImmutablePolynomial(1.0)
This was modeled after https://github.com/tkoolen/StaticUnivariatePolynomials.jl by @tkoolen.

"""
struct ImmutablePolynomial{T <: Number, N} <: StandardBasisPolynomial{T}
struct ImmutablePolynomial{T <: Number, X, N} <: StandardBasisPolynomial{T, X}
coeffs::NTuple{N, T}
var::Symbol

function ImmutablePolynomial{T,N}(coeffs::NTuple{N,T}, var::SymbolLike=:x) where {T <: Number,N}
N == 0 && return new{T,0}(coeffs, Symbol(var))
function ImmutablePolynomial{T,X,N}(coeffs::NTuple{N,T}) where {T <: Number, X, N}
N == 0 && return new{T,X, 0}(coeffs)
iszero(coeffs[end]) && throw(ArgumentError("Leading term must be non-zero"))
new{T,N}(coeffs, Symbol(var))
new{T,X,N}(coeffs)
end


end

@register ImmutablePolynomial

## Various interfaces
function ImmutablePolynomial{T,N}(coeffs::Tuple, var::SymbolLike=:x) where {T,N}
ImmutablePolynomial{T,N}(NTuple{N,T}(T.(coeffs)), var)
function ImmutablePolynomial{T,X}(coeffs::AbstractVector) where {T,X}
N = findlast(!iszero, coeffs)
ImmutablePolynomial{T, X, N}(NTuple{N,T}(coeffs[i] for i in 1:N))
end

function ImmutablePolynomial{T,N}(coeffs::AbstractVector{S}, var::SymbolLike=:x) where {T <: Number, N, S}
if Base.has_offset_axes(coeffs)
@warn "ignoring the axis offset of the coefficient vector"
end
ImmutablePolynomial{T,N}(NTuple{N,T}(tuple(coeffs...)), var)

function ImmutablePolynomial{T,X}(coeffs::Tuple) where {T,X}
N = findlast(!iszero, coeffs)
ImmutablePolynomial{T, X, N}(NTuple{N,T}(T(coeffs[i]) for i in 1:N))
end

#function ImmutablePolynomial{T,N}(coeffs::AbstractVector{S}, var::SymbolLike=:x) where {T <: Number, N, S#}
# if Base.has_offset_axes(coeffs)
# @warn "ignoring the axis offset of the coefficient vector"
# end
# ImmutablePolynomial{T,var, N}(NTuple{N,T}(tuple(coeffs...)))
#end

## --
function ImmutablePolynomial{T}(coeffs::NTuple{M,S}, var::SymbolLike=:x) where {T, S<: Number, M}
N = findlast(!iszero, coeffs)
if N == nothing
return zero(ImmutablePolynomial{T}, var)
return zero(ImmutablePolynomial{T, Symbol(var)})
else
cs = NTuple{N,T}(coeffs[i] for i in 1:N)
return ImmutablePolynomial{T,N}(cs, var)
return ImmutablePolynomial{T,Symbol(var),N}(cs)
end
end

function ImmutablePolynomial{T}(coeffs::Tuple, var::SymbolLike=:x) where {T}
ImmutablePolynomial{T}(T.(coeffs), var)
end

# entry point from abstract.jl; note T <: Number
function ImmutablePolynomial{T}(coeffs::AbstractVector{T}, var::SymbolLike=:x) where {T <: Number}
if Base.has_offset_axes(coeffs)
@warn "ignoring the axes of the coefficient vector and treating it as a list"
end
M = length(coeffs)
ImmutablePolynomial{T}(NTuple{M,T}(tuple(coeffs...)), var)
ImmutablePolynomial{T}(T.(coeffs), Symbol(var))
end

## --

function ImmutablePolynomial(coeffs::Tuple, var::SymbolLike=:x)
cs = NTuple(promote(coeffs...))
T = eltype(cs)
ImmutablePolynomial{T}(cs, var)
ImmutablePolynomial{T, Symbol(var)}(cs)
end

# Convenience; pass tuple to Polynomial
# Not documented, not sure this is a good idea as P(...)::P is not true...
# Deprecated
function Polynomial(coeffs::NTuple{N,T}, var::SymbolLike = :x) where{N,T}
Base.depwarn("Use of `Polynomial(NTuple, var)` is deprecated. Use the `ImmutablePolynomial` constructor",
:Polynomial)
ImmutablePolynomial(coeffs, var)
end
function Polynomial{T}(coeffs::NTuple{N,S}, var::SymbolLike = :x) where{N,T,S}
Base.depwarn("Use of `Polynomial(NTuple, var)` is deprecated. Use the `ImmutablePolynomial` constructor",
:Polynomial)
ImmutablePolynomial{N,T}(T.(coeffs), var)
end

##
## ----
##
# overrides from common.jl due to coeffs being non mutable, N in type parameters
Base.collect(p::P) where {P <: ImmutablePolynomial} = [pᵢ for pᵢ ∈ p]

Base.copy(p::P) where {P <: ImmutablePolynomial} = P(coeffs(p), p.var)
Base.copy(p::P) where {P <: ImmutablePolynomial} = P(coeffs(p), var(p))

## defining these speeds things up
function Base.zero(P::Type{<:ImmutablePolynomial}, var::SymbolLike=:x)
R = eltype(P)
ImmutablePolynomial{R,0}(NTuple{0,R}(),var)
ImmutablePolynomial{R,Symbol(var),0}(NTuple{0,R}())
end

function Base.one(P::Type{<:ImmutablePolynomial}, var::SymbolLike=:x)
R = eltype(P)
ImmutablePolynomial{R,1}(NTuple{1,R}(1),var)
ImmutablePolynomial{R,Symbol(var),1}(NTuple{1,R}(1))
end
function variable(P::Type{<:ImmutablePolynomial}, var::SymbolLike=:x)
R = eltype(P)
ImmutablePolynomial{R,2}(NTuple{2,R}((0,1)),var)
ImmutablePolynomial{R,Symbol(var),2}(NTuple{2,R}((0,1)))
end


# degree, isconstant
degree(p::ImmutablePolynomial{T,N}) where {T,N} = N - 1 # no trailing zeros
isconstant(p::ImmutablePolynomial{T,N}) where {T,N} = N <= 1
degree(p::ImmutablePolynomial{T,X, N}) where {T,X,N} = N - 1 # no trailing zeros
isconstant(p::ImmutablePolynomial{T,X,N}) where {T,X,N} = N <= 1

function Base.getindex(p::ImmutablePolynomial{T,N}, idx::Int) where {T <: Number,N}
function Base.getindex(p::ImmutablePolynomial{T,X, N}, idx::Int) where {T <: Number,X, N}
(idx < 0 || idx > N-1) && return zero(T)
return p.coeffs[idx + 1]
end
Expand Down Expand Up @@ -174,10 +154,10 @@ function Base.chop(p::ImmutablePolynomial{T,N};
cs = coeffs(p)
for i in N:-1:1
if !isapprox(cs[i], zero(T), rtol=rtol, atol=atol)
return ImmutablePolynomial{T,i}(cs[1:i], p.var)
return ImmutablePolynomial{T,i}(cs[1:i], var(p))
end
end
zero(ImmutablePolynomial{T}, p.var)
zero(ImmutablePolynomial{T}, var(p))
end

function Base.truncate(p::ImmutablePolynomial{T,N};
Expand All @@ -188,7 +168,7 @@ function Base.truncate(p::ImmutablePolynomial{T,N};
cs = coeffs(q)
thresh = maximum(abs,cs) * rtol + atol
cs′ = map(c->abs(c) <= thresh ? zero(T) : c, cs)
ImmutablePolynomial{T}(tuple(cs′...), p.var)
ImmutablePolynomial{T}(tuple(cs′...), var(p))
end

# no in-place chop! and truncate!
Expand All @@ -202,42 +182,42 @@ truncate!(p::ImmutablePolynomial; kwargs...) = truncate(p; kwargs...)
(p::ImmutablePolynomial{T,N})(x::S) where {T,N,S} = evalpoly(x, p.coeffs)


function Base.:+(p1::ImmutablePolynomial{T,N}, p2::ImmutablePolynomial{S,M}) where {T,N,S,M}
function Base.:+(p1::ImmutablePolynomial{T,X, N}, p2::ImmutablePolynomial{S,Y, M}) where {T,X, N,S,Y,M}

R = promote_type(S,T)
iszero(N) && return ImmutablePolynomial{R}(coeffs(p2), p2.var)
iszero(M) && return ImmutablePolynomial{R}(coeffs(p1), p1.var)
iszero(N) && return ImmutablePolynomial{R, var(p2)}(coeffs(p2))
iszero(M) && return ImmutablePolynomial{R, var(p1)}(coeffs(p1))

isconstant(p1) && p1.var != p2.var && return p2 + p1[0]*one(ImmutablePolynomial{R}, p2.var)
isconstant(p2) && p1.var != p2.var && return p1 + p2[0]*one(ImmutablePolynomial{R}, p1.var)
isconstant(p1) && X != Y && return p2 + p1[0]*one(ImmutablePolynomial{R, Y})
isconstant(p2) && X != Y && return p1 + p2[0]*one(ImmutablePolynomial{R, X})

p1.var != p2.var && error("Polynomials must have same variable")
X != Y && error("Polynomials must have same variable")

if N == M
cs = NTuple{N,R}(p1[i] + p2[i] for i in 0:N-1)
ImmutablePolynomial{R}(cs, p1.var)
ImmutablePolynomial{R,X,N}(cs)
elseif N < M
cs = (p2.coeffs) ⊕ (p1.coeffs)
ImmutablePolynomial{R,M}(cs, p1.var)
ImmutablePolynomial{R,X,M}(cs)
else
cs = (p1.coeffs) ⊕ (p2.coeffs)
ImmutablePolynomial{R,N}(cs, p1.var)
ImmutablePolynomial{R,X,N}(cs)
end

end

# not type stable!!!
function Base.:*(p1::ImmutablePolynomial{T,N}, p2::ImmutablePolynomial{S,M}) where {T,N,S,M}
function Base.:*(p1::ImmutablePolynomial{T,X,N}, p2::ImmutablePolynomial{S,Y,M}) where {T,X,N,S,Y,M}
isconstant(p1) && return p2 * p1[0]
isconstant(p2) && return p1 * p2[0]
p1.var != p2.var && error("Polynomials must have same variable")
X != Y && error("Polynomials must have same variable")
R = promote_type(S,T)
cs = (p1.coeffs) ⊗ (p2.coeffs)
if !iszero(cs[end])
return ImmutablePolynomial{R, N+M-1}(cs, p1.var)
return ImmutablePolynomial{R, X, N+M-1}(cs)
else
n = findlast(!iszero, cs)
return ImmutablePolynomial{R, n}(cs[1:n], p1.var)
return ImmutablePolynomial{R, X, n}(cs[1:n])
end
end

Expand Down Expand Up @@ -291,38 +271,38 @@ end
end

# scalar ops
function Base.:+(p::ImmutablePolynomial{T,N}, c::S) where {T, N, S<:Number}
function Base.:+(p::ImmutablePolynomial{T,X, N}, c::S) where {T, X, N, S<:Number}
R = promote_type(T,S)

iszero(c) && return ImmutablePolynomial{R,N}(p.coeffs, p.var)
N == 0 && return ImmutablePolynomial{R,1}((c,), p.var)
N == 1 && return ImmutablePolynomial((p[0]+c,), p.var)
iszero(c) && return ImmutablePolynomial{R,X, N}(p.coeffs)
N == 0 && return ImmutablePolynomial{R,X,1}((c,))
N == 1 && return ImmutablePolynomial((p[0]+c,), X)

q = ImmutablePolynomial{R,1}((c,), p.var)
q = ImmutablePolynomial{R,X, 1}((c,))
return p + q

end

function Base.:*(p::ImmutablePolynomial{T,N}, c::S) where {T, N, S <: Number}
function Base.:*(p::ImmutablePolynomial{T,X,N}, c::S) where {T, X,N, S <: Number}
R = promote_type(T,S)
iszero(c) && return zero(ImmutablePolynomial{R}, p.var)
ImmutablePolynomial{R,N}(p.coeffs .* c, p.var)
iszero(c) && return zero(ImmutablePolynomial{R,X})
ImmutablePolynomial{R,X,N}(p.coeffs .* c)
end

function Base.:/(p::ImmutablePolynomial{T,N}, c::S) where {T,N,S <: Number}
function Base.:/(p::ImmutablePolynomial{T,X,N}, c::S) where {T,X,N,S <: Number}
R = eltype(one(T)/one(S))
isinf(c) && return zero(ImmutablePolynomial{R}, p.var)
ImmutablePolynomial{R,N}(p.coeffs ./ c, p.var)
isinf(c) && return zero(ImmutablePolynomial{R,X})
ImmutablePolynomial{R,X,N}(p.coeffs ./ c)
end

Base.:-(p::ImmutablePolynomial{T,N}) where {T,N} = ImmutablePolynomial{T,N}(.-p.coeffs, p.var)
Base.:-(p::ImmutablePolynomial{T,X,N}) where {T,X,N} = ImmutablePolynomial{T,X,N}(.-p.coeffs)

Base.to_power_type(p::ImmutablePolynomial{T,N}) where {T,N} = p
Base.to_power_type(p::ImmutablePolynomial{T,X,N}) where {T,X,N} = p


## more performant versions borrowed from StaticArrays
## https://github.com/JuliaArrays/StaticArrays.jl/blob/master/src/linalg.jl
LinearAlgebra.norm(q::ImmutablePolynomial{T,0}) where {T} = zero(real(float(T)))
LinearAlgebra.norm(q::ImmutablePolynomial{T,X,0}) where {T,X} = zero(real(float(T)))
LinearAlgebra.norm(q::ImmutablePolynomial) = _norm(q.coeffs)
LinearAlgebra.norm(q::ImmutablePolynomial, p::Real) = _norm(q.coeffs, p)

Expand Down
Loading