diff --git a/Cargo.toml b/Cargo.toml index 548d3ec..907727e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,13 +3,14 @@ name = "aberth" version = "0.0.4" edition = "2021" authors = ["ickk "] -license = "MIT OR Apache-2.0" +license = "MIT OR Apache-2.0 OR Zlib" +readme = "README.md" +include = ["src/", "LICENSE-APACHE", "LICENSE-MIT", "LICENSE-ZLIB"] description = "Aberth's method for finding the zeros of a polynomial" documentation = "https://docs.rs/aberth" repository = "https://github.com/ickk/aberth/" -readme = "README.md" -keywords = ["no_std", "polynomial", "root-finding", "complex-numbers"] -categories = ["mathematics"] +keywords = ["root-finding", "polynomial", "complex-numbers", "no_std"] +categories = ["mathematics", "no-std"] [dependencies] arrayvec = { version = "0.7", default-features = false } @@ -19,4 +20,5 @@ num-traits = { version = "0.2", default-features = false } [features] default = ["std"] std = ["num-traits/default", "num-complex/default"] +# libm is required when used in a #![no_std] context libm = ["num-traits/libm", "num-complex/libm"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE index d9a10c0..673d37c 100644 --- a/LICENSE-APACHE +++ b/LICENSE-APACHE @@ -1,3 +1,15 @@ +Copyright (c) 2023 ickk + +Licensed under the Apache License, Version 2.0 (the "License"); You may obtain +a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software distributed +under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +CONDITIONS OF ANY KIND, either express or implied. See the License for the +specific language governing permissions and limitations under the License. + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -9,54 +21,54 @@ "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. + "Licensor" shall mean the copyright owner or entity authorized by the + copyright owner that is granting the License. - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. + "Legal Entity" shall mean the union of the acting entity and all other + entities that control, are controlled by, or are under common control + with that entity. For the purposes of this definition, "control" means + (i) the power, direct or indirect, to cause the direction or + management of such entity, whether by contract or otherwise, or (ii) + ownership of fifty percent (50%) or more of the outstanding shares, or + (iii) beneficial ownership of such entity. - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. + "You" (or "Your") shall mean an individual or Legal Entity exercising + permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. + transformation or translation of a Source form, including but not + limited to compiled object code, generated documentation, and + conversions to other media types. - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). + "Work" shall mean the work of authorship, whether in Source or Object + form, made available under the License, as indicated by a copyright + notice that is included in or attached to the work (an example is + provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise + represent, as a whole, an original work of authorship. For the + purposes of this License, Derivative Works shall not include works + that remain separable from, or merely link (or bind by name) to the + interfaces of, the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including the + original version of the Work and any modifications or additions to + that Work or Derivative Works thereof, that is intentionally submitted + to Licensor for inclusion in the Work by the copyright owner or by an + individual or Legal Entity authorized to submit on behalf of the + copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent to + the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control + systems, and issue tracking systems that are managed by, or on behalf + of, the Licensor for the purpose of discussing and improving the Work, + but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity @@ -66,111 +78,109 @@ 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and + copyright license to reproduce, prepare Derivative Works of, publicly + display, publicly perform, sublicense, and distribute the Work and + such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of this + License, each Contributor hereby grants to You a perpetual, worldwide, + non-exclusive, no-charge, royalty-free, irrevocable (except as stated + in this section) patent license to make, have made, use, offer to + sell, sell, import, and otherwise transfer the Work, where such + license applies only to those patent claims licensable by such + Contributor that are necessarily infringed by their Contribution(s) + alone or by combination of their Contribution(s) with the Work to + which such Contribution(s) was submitted. If You institute patent + litigation against any entity (including a cross-claim or counterclaim + in a lawsuit) alleging that the Work or a Contribution incorporated + within the Work constitutes direct or contributory patent + infringement, then any patent licenses granted to You under this + License for that Work shall terminate as of the date such litigation + is filed. + + 4. Redistribution. You may reproduce and distribute copies of the Work or + Derivative Works thereof in any medium, with or without modifications, + and in Source or Object form, provided that You meet the following + conditions: + + (a) You must give any other recipients of the Work or Derivative Works + a copy of this License; and (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and + stating that You changed the files; and - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and + (c) You must retain, in the Source form of any Derivative Works that + You distribute, all copyright, patent, trademark, and attribution + notices from the Source form of the Work, excluding those notices + that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained within + such NOTICE file, excluding those notices that do not pertain to + any part of the Derivative Works, in at least one of the following + places: within a NOTICE text file distributed as part of the + Derivative Works; within the Source form or documentation, if + provided along with the Derivative Works; or, within a display + generated by the Derivative Works, if and wherever such third-party + notices normally appear. The contents of the NOTICE file are for + informational purposes only and do not modify the License. You may + add Your own attribution notices within Derivative Works that You + distribute, alongside or as an addendum to the NOTICE text from the + Work, provided that such additional attribution notices cannot be + construed as modifying the License. + + You may add Your own copyright statement to Your modifications and may + provide additional or different license terms and conditions for use, + reproduction, or distribution of Your modifications, or for any such + Derivative Works as a whole, provided Your use, reproduction, and + distribution of the Work otherwise complies with the conditions stated + in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. + any Contribution intentionally submitted for inclusion in the Work by + You to the Licensor shall be under the terms and conditions of this + License, without any additional terms or conditions. Notwithstanding + the above, nothing herein shall supersede or modify the terms of any + separate license agreement you may have executed with Licensor + regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. + 7. Disclaimer of Warranty. Unless required by applicable law or agreed to + in writing, Licensor provides the Work (and each Contributor provides + its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR + CONDITIONS OF ANY KIND, either express or implied, including, without + limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, + MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely + responsible for determining the appropriateness of using or + redistributing the Work and assume any risks associated with Your + exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. + whether in tort (including negligence), contract, or otherwise, unless + required by applicable law (such as deliberate and grossly negligent + acts) or agreed to in writing, shall any Contributor be liable to You + for damages, including any direct, indirect, special, incidental, or + consequential damages of any character arising as a result of this + License or out of the use or inability to use the Work (including but + not limited to damages for loss of goodwill, work stoppage, computer + failure or malfunction, or any and all other commercial damages or + losses), even if such Contributor has been advised of the possibility + of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing the + Work or Derivative Works thereof, You may choose to offer, and charge + a fee for, acceptance of support, warranty, indemnity, or other + liability obligations and/or rights consistent with this License. + However, in accepting such obligations, You may act only on Your own + behalf and on Your sole responsibility, not on behalf of any other + Contributor, and only if You agree to indemnify, defend, and hold each + Contributor harmless for any liability incurred by, or claims asserted + against, such Contributor by reason of your accepting any such + warranty or additional liability. END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT index 11639fa..830e1cf 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -1,11 +1,11 @@ Copyright (c) 2023 ickk -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. diff --git a/LICENSE-ZLIB b/LICENSE-ZLIB new file mode 100644 index 0000000..a268276 --- /dev/null +++ b/LICENSE-ZLIB @@ -0,0 +1,19 @@ +Copyright (c) 2023 ickk + +This software is provided 'as-is', without any express or implied warranty. In +no event will the authors be held liable for any damages arising from the use +of this software. + +Permission is granted to anyone to use this software for any purpose, including +commercial applications, and to alter it and redistribute it freely, subject to +the following restrictions: + +1. The origin of this software must not be misrepresented; you must not claim + that you wrote the original software. If you use this software in a product, + an acknowledgment in the product documentation would be appreciated but is + not required. + +2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + +3. This notice may not be removed or altered from any source distribution. diff --git a/README.md b/README.md index d83b313..c7c8bc3 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,22 @@ aberth ====== -[crates.io](https://crates.io/crates/aberth) | [docs.rs](https://docs.rs/aberth) +[crates.io](https://crates.io/crates/aberth) | +[docs.rs](https://docs.rs/aberth) | +[github](https://github.com/ickk/aberth) An implementation of the [Aberth-Ehrlich method](https://en.wikipedia.org/wiki/Aberth_method) for finding the zeros of a polynomial. Aberth's method uses an electrostatics analogy to model the approximations as -negative charges and the true zeros as positive charges. This enables -finding all complex roots simultaneously, converging cubically (worst-case it -converges linearly for zeros of multiplicity). +negative charges and the true zeros as positive charges. This enables finding +all complex roots simultaneously, converging cubically (worst-case it converges +linearly for zeros of multiplicity). This crate is `#![no_std]` and tries to have minimal dependencies. It uses -[arrayvec](https://crates.io/crates/arrayvec) to avoid allocations, which will -be removed when rust stabilises support for const-generics. +[arrayvec](https://crates.io/crates/arrayvec) +to avoid allocations, which will be removed when rust stabilises support for +const-generics. Usage @@ -24,8 +27,8 @@ Add it to your project: cargo add aberth ``` -Specify the coefficients of your polynomial in an array in ascending order -and then call the `aberth` method on your polynomial. +Specify the coefficients of your polynomial in an array in ascending order and +then call the `aberth` method on your polynomial. ```rust use aberth::aberth; const EPSILON: f32 = 0.001; @@ -90,12 +93,25 @@ the `libm` feature: aberth = { version = "0.0.4", default-features = false, features = ["libm"] } ``` +Stability Guarantees +-------------------- + +**`mod internal` may experience breaking changes even in minor and patch +releases**: + +We expose the `internal` module, for those interested in supplying their own +initial guesses to `internal::aberth_raw`. However this `internal` module is +considered an implementation detail and does not follow the semantic versioning +scheme of the rest of the project. + License ------- -This crate is dual-licensed under either of -[Apache license, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) +This crate is licensed under any of the +[Apache license, Version 2.0](./LICENSE-APACHE), +or the +[MIT license](./LICENSE-MIT), or the -[MIT license](http://opensource.org/licenses/MIT) +[Zlib license](./LICENSE-ZLIB) at your option. diff --git a/src/internal.rs b/src/internal.rs index e52123f..eb2fc30 100644 --- a/src/internal.rs +++ b/src/internal.rs @@ -1,11 +1,21 @@ -use super::StopReason; -use core::{fmt::Debug, iter::zip}; -use num_complex::{Complex, ComplexFloat}; -use num_traits::{ - cast, - float::{Float, FloatConst}, - identities::{One, Zero}, - MulAdd, +//! The `internal` module may experience breaking changes even in minor and +//! patch releases. +//! +//! This module is exposed for those interested in supplying their own initial +//! guesses to the `aberth_raw` function. However this `internal` module is +//! considered an implementation detail and does not follow the semantic +//! versioning scheme of the rest of the project. + +use { + crate::StopReason, + ::core::{fmt::Debug, iter::zip}, + ::num_complex::{Complex, ComplexFloat}, + ::num_traits::{ + cast, + float::{Float, FloatConst}, + identities::{One, Zero}, + MulAdd, + }, }; /// Find all of the roots of a polynomial using Aberth's method. diff --git a/src/lib.rs b/src/lib.rs index b914343..39b96fe 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,18 +2,20 @@ #![cfg_attr(not(any(feature = "std", test, doctest)), no_std)] pub mod internal; -use internal::*; -pub use num_complex::Complex; - #[cfg(any(test, doctest))] mod tests; -use arrayvec::ArrayVec; -use core::{fmt::Debug, ops::Deref}; -use num_traits::{ - float::{Float, FloatConst}, - identities::Zero, - MulAdd, +pub use ::num_complex::Complex; + +use { + crate::internal::*, + ::arrayvec::ArrayVec, + ::core::{fmt::Debug, ops::Deref}, + ::num_traits::{ + float::{Float, FloatConst}, + identities::Zero, + MulAdd, + }, }; /// Find all of the roots of a polynomial using Aberth's method @@ -111,15 +113,16 @@ pub use feature_std::AberthSolver; #[cfg(feature = "std")] mod feature_std { - use super::Roots; - use crate::internal::*; - use core::fmt::Debug; - use num_complex::Complex; - use num_traits::{ - cast, - float::{Float, FloatConst}, - identities::Zero, - MulAdd, + use { + crate::{internal::*, Roots}, + ::core::fmt::Debug, + ::num_complex::Complex, + ::num_traits::{ + cast, + float::{Float, FloatConst}, + identities::Zero, + MulAdd, + }, }; impl Roots<&[Complex]> { diff --git a/src/tests.rs b/src/tests.rs index b35a15b..61fd373 100644 --- a/src/tests.rs +++ b/src/tests.rs @@ -1,5 +1,4 @@ -use crate::*; -use num_complex::ComplexFloat; +use {crate::*, ::num_complex::ComplexFloat}; const EPSILON: f32 = 0.000_05; const EPSILON_64: f64 = 0.000_000_000_005; @@ -164,7 +163,7 @@ fn _aberth_empty_array() {} #[test] fn aberth() { - use super::*; + use super::aberth; { let polynomial = [0., 1.];