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

Deprecate ordschur() methods two methods where the individual components are passed #28155

Merged
merged 3 commits into from
Jul 30, 2018
Merged

Deprecate ordschur() methods two methods where the individual components are passed #28155

merged 3 commits into from
Jul 30, 2018

Conversation

BenjaminBorn
Copy link
Contributor

Adresses #28145. The idea is to deprecate the ordschur methods that accept the individual components instead of the schur factorization.

@andreasnoack I tried to follow the example you gave but, locally, no deprecation messages are shown. One "problem" could be that I had to install 0.7 for this PR and my setup is still a bit shaky. So any feedback is welcome.

Copy link
Member

@andreasnoack andreasnoack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Looks good to me. Would be great if you could also add an entry to NEWS.md.


function ordschur!(T::StridedMatrix{Ty}, Z::StridedMatrix{Ty}, select::Union{Vector{Bool},BitVector}) where {Ty<:BlasFloat}
depwarn(string("`ordschur!(T::StridedMatrix{Ty}, Z::StridedMatrix{Ty}, select::Union{Vector{Bool},BitVector})`",
"`where {Ty<:BlasFloat}` is deprecated, use `ordschur!(schur::Schur, select::Union{Vector{Bool},BitVector})`", "instead.", :ordschur!)
Copy link
Member

@andreasnoack andreasnoack Jul 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a closing parenthesis missing here

@BenjaminBorn
Copy link
Contributor Author

Fixed the missing closing parentheses and added a NEWS.md item.

Deprecation warning still does not show locally.

@andreasnoack
Copy link
Member

I do see the deprecations.

Do you need to adjust some of the tests as well?

@BenjaminBorn
Copy link
Contributor Author

Sorry for the delay here.

I checked https://github.com/JuliaLang/julia/blob/master/stdlib/LinearAlgebra/test/schur.jl and all the ordschur calls seem to use the factorisation objects. So from my point of view there is nothing to adjust. Could there be tests in other places that need adjusting?

@JeffBezanson JeffBezanson added deprecation This change introduces or involves a deprecation linear algebra Linear algebra lui and removed lui labels Jul 26, 2018
@@ -149,27 +149,6 @@ included or both excluded via `select`.
ordschur(schur::Schur, select::Union{Vector{Bool},BitVector}) =
Schur(ordschur(schur.T, schur.Z, select)...)
Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like there is still a call to the deprecated signature here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Jeff. I think the deprecation is more involved than I initially thought. The code itself uses the ordschur method with individual components in a number of places to define the method with factorization object.

Do you think it's worth going ahead and rewriting the parts or should I close this PR? A minimum PR would then only correct the wrong documentation (see #28145)

Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could change the deprecated methods that are still needed to an internal function, _ordschur.

@BenjaminBorn
Copy link
Contributor Author

Tests have passed now (failure in circleci seems unrelated if I read it correctly). Anything else to do here?

Thanks for all the help!

@andreasnoack andreasnoack merged commit 0601b38 into JuliaLang:master Jul 30, 2018
@BenjaminBorn BenjaminBorn deleted the ordschur_deprec branch July 30, 2018 07:52
KristofferC pushed a commit that referenced this pull request Feb 11, 2019
…nts are passed (#28155)

* Deprecate ordschur methods

* Add news item

* Add auxiliary _ordschur and _ordschur! functions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation This change introduces or involves a deprecation linear algebra Linear algebra
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants