diff --git a/.github/workflows/example_web_deploy.yml b/.github/workflows/documentation_web_deploy.yml similarity index 58% rename from .github/workflows/example_web_deploy.yml rename to .github/workflows/documentation_web_deploy.yml index 8c5d23ae..2354c17a 100644 --- a/.github/workflows/example_web_deploy.yml +++ b/.github/workflows/documentation_web_deploy.yml @@ -1,4 +1,4 @@ -name: example_web_deploy +name: documentation_web_deploy on: push: @@ -6,24 +6,21 @@ on: - master jobs: - flutter_web_example_deployment: - name: Equations example - Flutter web deployment + documentation_deployment: + name: HTML Documentation deployment runs-on: macos-latest - defaults: - run: - working-directory: example/flutter_example steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - uses: subosito/flutter-action@v2 with: channel: 'stable' - name: Installing dependencies - run: flutter pub get + run: dart pub get - - name: Building for the web - run: flutter build web --csp + - name: Generating the documentation + run: dart doc - name: Setting the git username run: git config user.name github-actions @@ -32,10 +29,10 @@ jobs: run: git config user.email github-actions@github.com - name: Adding web source - run: git --work-tree build/web add --all + run: git --work-tree doc/api add --all - name: Adding a commit message run: git commit -m "Automatic deployment by github-actions" - name: Automatic web deployment - run: git push origin HEAD:equations_web --force + run: git push origin HEAD:equations_doc --force diff --git a/.github/workflows/equations_ci.yml b/.github/workflows/equations_ci.yml index 7d26170b..6697d844 100644 --- a/.github/workflows/equations_ci.yml +++ b/.github/workflows/equations_ci.yml @@ -1,17 +1,21 @@ name: equations_ci on: - push: - branches: - - master - - develop + pull_request: + paths-ignore: + - "**.md" + types: + - opened + - reopened + - synchronize + - ready_for_review jobs: verify_equation_package: name: Equations package action runs-on: windows-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: dart-lang/setup-dart@v1 - name: Installing dependencies @@ -29,66 +33,6 @@ jobs: dart pub global run coverage:test_with_coverage - name: Making sure that code coverage is 100 - uses: VeryGoodOpenSource/very_good_coverage@v2 + uses: VeryGoodOpenSource/very_good_coverage@v3 with: min_coverage: 100 - - - name: Uploading coverage to Codecov - uses: codecov/codecov-action@v3 - with: - token: ${{ secrets.CODECOV_TOKEN }} - - verify_equation_flutter_example: - name: Flutter example - needs: [verify_equation_package] - runs-on: windows-latest - defaults: - run: - working-directory: example/flutter_example - steps: - - name: Checkout - uses: actions/checkout@v3 - - uses: subosito/flutter-action@v2 - with: - channel: 'stable' - - - name: Installing dependencies - run: flutter pub get - - - name: Making sure the package is formatted - run: dart format --set-exit-if-changed . - - - name: Making sure that there are no analysis warnings or errors - run: flutter analyze --fatal-infos --fatal-warnings lib test - - - name: Runing unit, widget and golden tests - run: flutter test --coverage - - - name: Making sure that code coverage is 100 - uses: VeryGoodOpenSource/very_good_coverage@v2 - with: - min_coverage: 100 - path: example/flutter_example/coverage/lcov.info - - verify_equation_dart_example: - name: Dart example - needs: [verify_equation_flutter_example] - runs-on: windows-latest - defaults: - run: - working-directory: example/dart_example - steps: - - uses: actions/checkout@v3 - - uses: dart-lang/setup-dart@v1 - - - name: Installing dependencies - run: dart pub get - - - name: Making sure the package is formatted - run: dart format --set-exit-if-changed . - - - name: Making sure that there are no analysis warnings or errors - run: dart analyze --fatal-infos --fatal-warnings lib test - - - name: Runing unit tests - run: dart test diff --git a/.github/workflows/integration_tests.yml b/.github/workflows/integration_tests.yml deleted file mode 100644 index ed1d1906..00000000 --- a/.github/workflows/integration_tests.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: integration_tests - -on: - push: - branches: - - master - - develop - -jobs: - flutter_example_integration_tests: - strategy: - matrix: - test_path: - [ - "integration_test/home_page_test.dart", - "integration_test/integral_page_test.dart", - "integration_test/nonlinear_page_test.dart", - "integration_test/other_page_test.dart", - "integration_test/polynomial_page_test.dart", - "integration_test/system_page_test.dart", - ] - fail-fast: true - runs-on: windows-latest - defaults: - run: - working-directory: example/flutter_example - steps: - - uses: actions/checkout@v3 - - uses: subosito/flutter-action@v2 - with: - channel: 'stable' - - - name: Install Dependencies - run: flutter pub get - - - name: Run integration test - run: flutter test ${{ matrix.test_path }} -d windows diff --git a/CHANGELOG.md b/CHANGELOG.md index bf89165d..c84de5e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +## 6.0.0 + - **BREAKING**: Renamed `DurandKerner` class to `GenericPolynomial` + - **BREAKING**: The `AlgebraicDivision` class is now a `typedef` of an equivalent record type + - Updated Dart SDK constraints to `^3.10.4` + - Added a new `Algebraic.factor` method that factors the polynomial into irreducible factors. + - Added a new `Algebraic.solveInequality` method that solves polynomial inequalities. + - Added a new `Matrix.isZero` method. + - Added a new `Factorial.computeBigInt` method to calculate factorials using `BigInt` rather than `int` + - Improvements to numerical stability of various algorithms + - Fixed numerical issues on polynonial and nonlinear solvers + - Documentation improvements + - Removed demo Dart and Flutter applications from the `example/` folder + - Dependencies versions update + ## 5.0.2 - Added a new subclass of `NumericalIntegration` called `AdaptiveQuadrature`, which implements the "adaptive quadrature" algorithm - Updated Dart SDK constraints to `^3.1.0` @@ -28,17 +42,17 @@ - Dependencies versions update ## 4.0.0 - - **BREAKING**: The `Complex.fromPolar` constructor now asks for required **named** parameters - - **BREAKING**: The `Interpolation` constructor now asks for required **named** parameters + - **BREAKING**: The `Complex.fromPolar` constructor now requires **named** parameters + - **BREAKING**: The `Interpolation` constructor now requires **named** parameters - **BREAKING**: The `SylvesterMatrix` type now accepts an `Algebraic` type rather than a `List`. As such, the `SylvesterMatrix.fromReal` constructor has been removed because a real polynomial can be built using `Algebraic.fromReal` instead - **BREAKING**: The `SystemSolver` type now accepts a `RealMatrix` type rather than a `List>`. As such, the `size` parameter has also been removed because the size can be retrieved from the `RealMatrix` object itself - - **BREAKING**: New names for `SytemSolver` parameters: changes `equations` to `matrix` and `constants` to `knownValues` + - **BREAKING**: New names for `SystemSolver` parameters: changed `equations` to `matrix` and `constants` to `knownValues` - Updated Dart SDK constraints to `">=2.17.0 <3.0.0"` - Added `csc` (cosecant) and `sec` (secant) trigonometric functions to the `ExpressionParser` type - Migrated Dart code to 2.17 with super parameters - Updated the `analysis_options.yaml` file with almost all rules - Added more rules from the `dart_code_metrics` package - - Updated the Flutter demo in the `example/` folder. Now the project can be run all platforms (mobile, web and desktop) + - Updated the Flutter demo in the `example/` folder. Now the project can be run on all platforms (mobile, web and desktop) - Dependencies versions update ## 3.2.0 @@ -60,11 +74,11 @@ ## 3.1.1 - Dependencies versions update - - Added more tests cases + - Added more test cases - Updated the Flutter demo in the `example/` folder ## 3.1.0 - - **BREAKING**: Now `NumericalIntegration` requires the function via constructor (earlier it was passed to the `integrate()` function) + - **BREAKING**: Now `NumericalIntegration` requires the function via constructor (previously it was passed to the `integrate()` function) - Added the `characteristicPolynomial()` method on `Matrix` to compute the characteristic polynomial of a matrix - Fixed an issue in the `eigenvalue()` method - Fixed an issue in the `rank()` method @@ -76,9 +90,9 @@ ## 3.0.0 - **BREAKING**: Replaced the `Laguerre` type with `DurandKerner` (the latter is a more reliable root-finding algorithm for polynomials) - **BREAKING**: Removed the `integrateOn` method on `Nonlinear`. Now numerical integration algorithms live on their own in the `src/integral` folder - - **BREAKING**: renamed `firstGuess` and `secondGuess` to `a` and `b` respectively in `Secant` (for consistency with other `Nonlinear` types) + - **BREAKING**: Renamed `firstGuess` and `secondGuess` to `a` and `b` respectively in `Secant` (for consistency with other `Nonlinear` types) - Created the `Interpolation` type to work with points interpolation - - Moved `NumericalIntegration` into a 'top-level' directoy inside `src/` + - Moved `NumericalIntegration` into a 'top-level' directory inside `src/` - Added the `LinearInterpolation`, `PolynomialInterpolation`, and `NewtonInterpolation` types - Added eigenvalues computation on `Matrix` with the `eigenValues()` method - Added inverse matrix computation on `Matrix` with the `inverse()` method @@ -98,7 +112,7 @@ - Dependencies versions update - Minor enhancement in the `PolynomialLongDivision` class - Added trace computation on matrices - - Added french localization to the Flutter example app + - Added French localization to the Flutter example app ## 2.1.2 - Dependencies versions update @@ -110,9 +124,9 @@ - Dependencies versions update ## 2.1.0 - - Changes on deep copy logic for lists (now the library uses `List.from()` on immutable objects) + - Changes in deep copy logic for lists (now the library uses `List.from()` on immutable objects) - Added the `PolynomialLongDivision` class to divide a polynomial by another - - Now the `Algebraic` type supports `opeartor/` too so you can divide polynomials to get quotient and remainder + - Now the `Algebraic` type supports `operator/` too so you can divide polynomials to get quotient and remainder - Dependencies versions update ## 2.0.3 @@ -120,7 +134,7 @@ ## 2.0.2 - New extension method on `String` called `isRealFunction` that determines whether a string represents a real function or not - - New extension method on `String` called `isNumericalExpression` that determines whether a string represents numerical expression or not + - New extension method on `String` called `isNumericalExpression` that determines whether a string represents a numerical expression or not - Minor changes to the `ExpressionParser` class - Written more tests for the `flutter_example` demo project - Dependencies versions update @@ -136,7 +150,7 @@ ## 2.0.0-nullsafety.5 - Updated some dependencies versions - - Added support for numerical integration with the `NumericalIntegration` type. + - Added support for numerical integration with the `NumericalIntegration` type - Minor code improvements ## 2.0.0-nullsafety.4 @@ -154,20 +168,20 @@ - New examples in the `example/` folder ## 2.0.0-nullsafety.2 - - Created the `RealMatrix` and `ComplexMatrix` types to work with matrix + - Created the `RealMatrix` and `ComplexMatrix` types to work with matrices - Added support for linear systems solving using Gauss, LU decomposition and Cholesky decomposition - Added a new static method called `Algebraic.from()` which automatically builds a new polynomial - equation according with the number of coefficients. + equation according to the number of coefficients - Minor documentation fixes ## 2.0.0-nullsafety.1 - - Added a new root-finding algorithm (`Brent` which implements the Brent's method) + - Added a new root-finding algorithm (`Brent` which implements Brent's method) - Added `Laguerre` (which implements Laguerre's method for polynomials root finding) - - Minor on various `Nonlinear` subtypes + - Minor improvements on various `Nonlinear` subtypes - Documentation fixes ## 2.0.0-nullsafety.0 - - Package migrated to null safety (Dart 2.12). + - Package migrated to null safety (Dart 2.12) - Added a new `ExpressionParser` class (which is also internally used by `NonLinear`) - Minor fixes on `Algebraic` and `NonLinear` @@ -178,4 +192,4 @@ ## 1.0.0 - Initial release - Use `Algebraic` for algebraic (polynomial) equations and `Nonlinear` for nonlinear equations - - Easily work with complex number by using `Complex` + - Easily work with complex numbers by using `Complex` diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index b4b2f9f2..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at fluttercompletereference@gmail.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/README.md b/README.md index 2397075d..89d1f75a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@

-dart_equations logo +dart_equations logo

An equation-solving library written purely in Dart.

- CI status Stars count on GitHub Stars count on GitHub @@ -11,374 +10,22 @@ --- -The `equations` package is used to solve numerical analysis problems with ease. It's purely written in Dart, meaning it has no platform-specific dependencies and doesn't require Flutter to work. You can use `equations`, for example, in a Dart CLI project or a Flutter cross-platform application. Here's a summary of what you can do with this package: +The `equations` package is written purely in Dart and helps you solve equations. Whether you're building a CLI application, a web server or a cross-platform Flutter project, `equations` has you covered. Here's what you can do with this : - - solve polynomial equations with `Algebraic` types; + - solve polynomial equations and inequalities with `Algebraic` types; - solve nonlinear equations with `Nonlinear` types; - solve linear systems of equations with `SystemSolver` types; - - evaluate integrals with `NumericalIntegration` types; - - interpolate data points with `Interpolation ` types. In addition, you can also find utilities to work with: - - Real and complex matrices, using the `Matrix` types; - - Complex number, using the `Complex` type; - - Fractions, using the `Fraction` and `MixedFraction` types. + - real and complex matrices, using the `RealMatrix` and `ComplexMatrix` types; + - complex numbers, using the `Complex` type; + - integral evaluation, with `NumericalIntegration` types; + - data interpolation, with `Interpolation` types. -This package has a type-safe API and requires Dart 3.0 (or higher versions). There is a demo project created with Flutter that shows an example of how this library could be used to develop a numerical analysis application :rocket: +The website hosted at this repository's GitHub Pages contains the latest `dart doc` HTML documentation. For more information about solving equations and examples on how to use the classes from this package, check out the articles on the Wiki pages: -

Equation Solver logo

-

Equation Solver - Flutter web demo

- -The source code of the Flutter application can be found at `example/flutter_example/`. Visit the official [pub.dev documentation](https://pub.dev/documentation/equations/latest/) for details about methods signatures and inline documentation. - ---- - -# Algebraic (Polynomial equations) - -Use one of the following classes to find the roots of a polynomial equation (also known as "algebraic equation"). You can use both complex numbers and fractions as coefficients. - -| Solver name | Equation | Params field | -|:-----------:|:-------------------------------------------------------------------------:|:-----------------:| -| `Constant` | f(x) = a | a ∈ C | -| `Linear` | f(x) = ax + b | a, b ∈ C | -| `Quadratic` | f(x) = ax2 + bx + c | a, b, c ∈ C | -| `Cubic` | f(x) = ax3 + bx2 + cx + d | a, b, c, d ∈ C | -| `Quartic` | f(x) = ax4 + bx3 + cx2 + dx + e | a, b, c, d, e ∈ C | -| `DurandKerner` | Any polynomial P(xi) where xi are coefficients | xi ∈ C | - -There's a formula for polynomials up to the fourth degree, as explained by the [Galois theory](https://en.wikipedia.org/wiki/Galois_theory). Roots of polynomials whose degree is 5 or higher must be found using DurandKerner's method (or any other root-finding algorithm). For this reason, we suggest the following approach: - - - use `Linear` to find the roots of a polynomial whose degree is 1; - - use `Quadratic` to find the roots of a polynomial whose degree is 2; - - use `Cubic` to find the roots of a polynomial whose degree is 3; - - use `Quartic` to find the roots of a polynomial whose degree is 4; - - use `DurandKerner` to find the roots of a polynomial whose degree is 5 or higher. - -Since `DurandKerner` works with any polynomial, you could also use it (for example) to solve a cubic equation. However, `DurandKerner` internally uses loops, derivatives, and other mechanics to approximate the actual roots. When the degree is 4 or lower, prefer working with `Quartic`, `Cubic`, `Quadratic` or `Linear` because they use direct formulas to find the roots (and thus they're more precise). Here's an example of how to find the roots of a cubic: - -```dart -// f(x) = (2-3i)x^3 + 6/5ix^2 - (-5+i)x - (9+6i) -final equation = Cubic( - a: Complex(2, -3), - b: Complex.fromImaginaryFraction(Fraction(6, 5)), - c: Complex(5, -1), - d: Complex(-9, -6) -); - -final degree = equation.degree; // 3 -final isReal = equation.isRealEquation; // false -final discr = equation.discriminant(); // -31299.688 + 27460.192i - -// f(x) = (2 - 3i)x^3 + 1.2ix^2 + (5 - 1i)x + (-9 - 6i) -print('$equation'); - -// f(x) = (2 - 3i)x^3 + 6/5ix^2 + (5 - 1i)x + (-9 - 6i) -print(equation.toStringWithFractions()); - -/* - * Prints the roots: - * - * x1 = 0.348906207844 - 1.734303423032i - * x2 = -1.083892638909 + 0.961044482775 - * x3 = 1.011909507988 + 0.588643555642 - * */ -for (final root in equation.solutions()) { - print(root); -} -``` - -Alternatively, you could have used `DurandKerner` to solve the same equation: - -```dart -// f(x) = (2-3i)x^3 + 6/5ix^2 - (-5+i)x - (9+6i) -final equation = DurandKerner( - coefficients: [ - Complex(2, -3), - Complex.fromImaginaryFraction(Fraction(6, 5)), - Complex(5, -1), - Complex(-9, -6), - ] -); - -/* - * Prints the roots of the equation: - * - * x1 = 1.0119095 + 0.5886435 - * x2 = 0.3489062 - 1.7343034i - * x3 = -1.0838926 + 0.9610444 - * */ -for (final root in equation.solutions()) { - print(root); -} -``` - -As we've already pointed out, both ways are equivalent. However, `DurandKerner` is computationally slower than `Cubic` and doesn't always guarantee to converge to the correct roots. Use `DurandKerner` only when the degree of your polynomial is greater or equal to 5. - -```dart -final quadratic = Algebraic.from(const [ - Complex(2, -3), - Complex.i(), - Complex(1, 6) -]); - -final quartic = Algebraic.fromReal(const [ - 1, -2, 3, -4, 5 -]); -``` - -The factory constructor `Algebraic.from()` automatically returns the best type of `Algebraic` according to the number of parameters you've passed. - -# Nonlinear equations - -Use one of the following classes, representing a root-finding algorithm, to find a root of an equation. Only real numbers are allowed. This package supports the following root-finding methods: - -| Solver name | Params field | -|:------------:|:-----------------:| -| `Bisection` | a, b ∈ R | -| `Chords` | a, b ∈ R | -| `Netwon` | x0 ∈ R | -| `Secant` | a, b ∈ R | -| `Steffensen` | x0 ∈ R | -| `Brent` | a, b ∈ R | -| `RegulaFalsi`| a, b ∈ R | - -Expressions are parsed using [petitparser](https://pub.dev/packages/petitparser/): a fast, stable and well-tested grammar parser. Here's a simple example of how you can find the roots of an equation using Newton's method: - -```dart -final newton = Newton("2*x+cos(x)", -1, maxSteps: 5); - -final steps = newton.maxSteps; // 5 -final tol = newton.tolerance; // 1.0e-10 -final fx = newton.function; // 2*x+cos(x) -final guess = newton.x0; // -1 - -final solutions = newton.solve(); - -final convergence = solutions.convergence.round(); // 2 -final solutions = solutions.efficiency.round(); // 1 - -/* - * The getter `solutions.guesses` returns the list of values computed by the algorithm - * - * -0.4862880170389824 - * -0.45041860473199363 - * -0.45018362150211116 - * -0.4501836112948736 - * -0.45018361129487355 - */ -final List guesses = solutions.guesses; -``` - -Certain algorithms don't always guarantee to converge to the correct root so carefully read the documentation before choosing the method. - -# Systems of equations - -Use one of the following classes to solve systems of linear equations. Only real coefficients are allowed (so `double` is ok, but `Complex` isn't) and you must define `N` equations in `N` variables (so **square** matrices only are allowed). This package supports the following algorithms: - -| Solver name | Iterative method | -|:---------------------:|:------------------:| -| `CholeskySolver` | :x: | -| `GaussianElimination` | :x: | -| `GaussSeidelSolver` | :heavy_check_mark: | -| `JacobiSolver` | :heavy_check_mark: | -| `LUSolver` | :x: | -| `SORSolver` | :heavy_check_mark: | - -These solvers are used to find the `x` in the `Ax = b` equation. Methods require, at least, the system matrix `A` and the known values vector `b`. Iterative methods may require additional parameters such as an initial guess or a particular configuration value. For example: - -```dart -// Solve a system using LU decomposition -final luSolver = LUSolver( - equations: const [ - [7, -2, 1], - [14, -7, -3], - [-7, 11, 18] - ], - constants: const [12, 17, 5] -); - -final solutions = luSolver.solve(); // [-1, 4, 3] -final determinant = luSolver.determinant(); // -84.0 -``` - -If you just want to work with matrices (for operations, decompositions, eigenvalues, etc...) you can consider using either `RealMatrix` (to work with `double`) or `ComplexMatrix` (to work with `Complex`). Both are subclasses of `Matrix` so they have the same public API: - -```dart -final matrixA = RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [2, 6], - [-5, 0] - ] -); - -final matrixB = RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [-4, 1], - [7, -3], - ] -); - -final sum = matrixA + matrixB; -final sub = matrixA - matrixB; -final mul = matrixA * matrixB; -final div = matrixA / matrixB; - -final lu = matrixA.luDecomposition(); -final cholesky = matrixA.choleskyDecomposition(); -final cholesky = matrixA.choleskyDecomposition(); -final qr = matrixA.qrDecomposition(); -final svd = matrixA.singleValueDecomposition(); - -final det = matrixA.determinant(); -final rank = matrixA.rank(); - -final eigenvalues = matrixA.eigenvalues(); -final characPolynomial = matrixA.characteristicPolynomial(); -``` - -You can use `toString()` to print the matrix contents. The `toStringAugmented()` method prints the augmented matrix (the matrix + one extra column with the known values vector). For example: - -```dart -final lu = LUSolver( - equations: const [ - [7, -2, 1], - [14, -7, -3], - [-7, 11, 18] - ], - constants: const [12, 17, 5] -); - -/* - * Output with 'toString': - * - * [7.0, -2.0, 1.0] - * [14.0, -7.0, -3.0] - * [-7.0, 11.0, 18.0] -*/ -print("$lu"); - -/* - * Output with 'toStringAugmented': - * - * [7.0, -2.0, 1.0 | 12.0] - * [14.0, -7.0, -3.0 | 17.0] - * [-7.0, 11.0, 18.0 | 5.0] -*/ -print("${lu.toStringAugmented()}"); -``` - -The `ComplexMatrix` has the same API and the same usage as `RealMatrix` with the only difference that it works with complex numbers rather then real numbers. - -# Numerical integration - -The "**numerical integration**" term refers to a group of algorithms for calculating the numerical value of a definite integral. The function must be continuous within the integration bounds. This package currently supports the following algorithms: - - - `MidpointRule` - - `SimpsonRule` - - `TrapezoidalRule` - - `AdaptiveQuadrature` - -Other than the integration bounds (called `lowerBound` and `lowerBound`), some classes may also have an optional `intervals` parameter. It already has a good default value but of course you can change it! For example: - -```dart -const simpson = SimpsonRule( - function: 'sin(x)*e^x', - lowerBound: 2, - upperBound: 4, -); - -// Calculating the value of... -// -// ∫ sin(x) * e^x dx -// -// ... between 2 and 4. -final results = simpson.integrate(); - -// Prints '-7.713' -print('${results.result.toStringAsFixed(3)}'); - -// Prints '32' -print('${results.guesses.length}'); -``` - -Midpoint, trapezoidal and Simpson methods have the `intervals` parameter while the adaptive quadrature method doesn't (because it doesn't need it). The `integrate()` function returns an `IntegralResults` which simply is a wrapper for 2 values: - - 1. `result`: the value of the definite integral evaluated within `lowerBound` and `lowerBound`, - 2. `guesses`: the various intermediate values that brought to the final result. - -# Interpolation - -This package can also perform linear, polynomial or spline interpolations using the `Interpolation` types. You just need to give a few points in the constructor and then use `compute(double x)` to interpolate the value. The package currently supports the following algorithms: - - - `LinearInterpolation` - - `PolynomialInterpolation` - - `NewtonInterpolation` - - `SplineInterpolation` - -You'll always find the `compute(double x)` method in any `Interpolation` type, but some classes may have additional methods that others haven't. For example: - -```dart -const newton = NewtonInterpolation( - nodes: [ - InterpolationNode(x: 45, y: 0.7071), - InterpolationNode(x: 50, y: 0.7660), - InterpolationNode(x: 55, y: 0.8192), - InterpolationNode(x: 60, y: 0.8660), - ], -); - -// Prints 0.788 -final y = newton.compute(52); -print(y.toStringAsFixed(3)); - -// Prints the following: -// -// [0.7071, 0.05890000000000006, -0.005700000000000038, -0.0007000000000000339] -// [0.766, 0.053200000000000025, -0.006400000000000072, 0.0] -// [0.8192, 0.04679999999999995, 0.0, 0.0] -// [0.866, 0.0, 0.0, 0.0] -print('\n${newton.forwardDifferenceTable()}'); -``` - -Since the Newton interpolation algorithm internally builds the "divided differences table", the API exposes two methods (`forwardDifferenceTable()` and `backwardDifferenceTable()`) to print those tables. Of course, you won't find `forwardDifferenceTable()` in other interpolation types because they just don't use it. By default, `NewtonInterpolation` uses the forward difference method but if you want the backward one, just pass `forwardDifference: false` in the constructor. - -```dart -const polynomial = PolynomialInterpolation( - nodes: [ - InterpolationNode(x: 0, y: -1), - InterpolationNode(x: 1, y: 1), - InterpolationNode(x: 4, y: 1), - ], -); - -// Prints -4.54 -final y = polynomial.compute(-1.15); -print(y.toStringAsFixed(2)); - -// Prints -0.5x^2 + 2.5x + -1 -print('\n${polynomial.buildPolynomial()}'); -``` - -This is another example with a different interpolation strategy. The `buildPolynomial()` method returns the interpolation polynomial (as an `Algebraic` type) internally used to interpolate `x`. - -# Expressions parsing - -You can use the `ExpressionParser` type to either parse numerical expressions or evaluate mathematical functions with the `x` variable: - -```dart -const parser = ExpressionParser(); - -print(parser.evaluate('5*3-4')); // 11 -print(parser.evaluate('sqrt(49)+10')); // 17 -print(parser.evaluate('pi')); // 3.1415926535 - -print(parser.evaluateOn('6*x + 4', 3)); // 22 -print(parser.evaluateOn('sqrt(x) - 3', 81)); // 6 -``` - -This type is internally used by the library to evaluate nonlinear functions. \ No newline at end of file + - [Algebraic equations](https://github.com/albertodev01/equations/wiki/Algebraic-equations), for solving polynomial equations; + - [Nonlinear equations](https://github.com/albertodev01/equations/wiki/Nonlinear-equations), for solving nonlinear equations; + - [Systems of equations](https://github.com/albertodev01/equations/wiki/Systems-of-equations), for solving systems of equations; + - [Utilities](https://github.com/albertodev01/equations/wiki/Utilities), for working with matrices, evaluating integrals, interpolating data, and more. \ No newline at end of file diff --git a/analysis_options.yaml b/analysis_options.yaml index fffe0761..83c17315 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -4,15 +4,18 @@ analyzer: strict-inference: true strict-raw-types: true -# All lint rules: https://dart-lang.github.io/linter/lints/options/options.html +formatter: + trailing_commas: preserve + +# All lint rules: https://dart.dev/tools/linter-rules/all linter: rules: - always_declare_return_types - always_put_control_body_on_new_line - always_put_required_named_parameters_first - - always_require_non_null_named_parameters - always_use_package_imports - annotate_overrides + - annotate_redeclares - avoid_annotating_with_dynamic - avoid_bool_literals_in_conditional_expressions - avoid_catches_without_on_clauses @@ -25,6 +28,7 @@ linter: - avoid_field_initializers_in_const_classes - avoid_final_parameters - avoid_function_literals_in_foreach_calls + - avoid_futureor_void - avoid_implementing_value_types - avoid_init_to_null - avoid_js_rounded_ints @@ -37,8 +41,6 @@ linter: - avoid_relative_lib_imports - avoid_renaming_method_parameters - avoid_return_types_on_setters - - avoid_returning_null - - avoid_returning_null_for_future - avoid_returning_null_for_void - avoid_returning_this - avoid_setters_without_getters @@ -73,6 +75,7 @@ linter: - directives_ordering - discarded_futures - do_not_use_environment + - document_ignores - empty_catches - empty_constructor_bodies - empty_statements @@ -85,6 +88,7 @@ linter: - implicit_call_tearoffs - implicit_reopen - invalid_case_patterns + - invalid_runtime_check_with_js_interop_types - join_return_with_assignment - leading_newlines_in_multiline_strings - library_annotations @@ -94,6 +98,7 @@ linter: - lines_longer_than_80_chars - literal_only_boolean_expressions - matching_super_parameters + - missing_code_block_language_in_doc_comment - missing_whitespace_between_adjacent_strings - no_adjacent_strings_in_list - no_default_cases @@ -103,11 +108,15 @@ linter: - no_literal_bool_comparisons - no_logic_in_create_state - no_runtimeType_toString + - no_self_assignments + - no_wildcard_variable_uses - non_constant_identifier_names - noop_primitive_operations - null_check_on_nullable_type_parameter - null_closures - omit_local_variable_types + - omit_obvious_local_variable_types + - omit_obvious_property_types - one_member_abstracts - only_throw_errors - overridden_fields @@ -154,6 +163,7 @@ linter: - provide_deprecation_message - public_member_api_docs - recursive_getters + - remove_deprecations_in_breaking_versions - require_trailing_commas - secure_pubspec_urls - sized_box_for_whitespace @@ -162,22 +172,27 @@ linter: - sort_child_properties_last - sort_pub_dependencies - sort_unnamed_constructors_first + - strict_top_level_inference + - switch_on_type - test_types_in_equals - throw_in_finally - tighten_type_of_initializing_formals - - type_annotate_public_apis - type_init_formals - type_literal_in_constant_pattern - unawaited_futures + - unintended_html_in_doc_comment + - unnecessary_async - unnecessary_await_in_return - unnecessary_brace_in_string_interps - unnecessary_breaks - unnecessary_const - unnecessary_constructor_name - unnecessary_getters_setters + - unnecessary_ignore - unnecessary_lambdas - unnecessary_late - unnecessary_library_directive + - unnecessary_library_name - unnecessary_new - unnecessary_null_aware_assignments - unnecessary_null_aware_operator_on_extension_on_nullable @@ -192,9 +207,12 @@ linter: - unnecessary_string_interpolations - unnecessary_this - unnecessary_to_list_in_spreads + - unnecessary_unawaited + - unnecessary_underscores - unreachable_from_main - unrelated_type_equality_checks - unsafe_html + - unsafe_variance - use_build_context_synchronously - use_colored_box - use_decorated_box @@ -206,6 +224,7 @@ linter: - use_key_in_widget_constructors - use_late_for_private_fields_and_variables - use_named_constants + - use_null_aware_elements - use_raw_strings - use_rethrow_when_possible - use_setters_to_change_properties @@ -214,5 +233,6 @@ linter: - use_super_parameters - use_test_throws_matchers - use_to_and_as_if_applicable + - use_truncating_division - valid_regexps - void_checks \ No newline at end of file diff --git a/example/README.md b/example/README.md index 63e5151c..b868e117 100644 --- a/example/README.md +++ b/example/README.md @@ -1,8 +1,62 @@ # Examples -This folder contains some examples to show how the `equations` package could be used. In particular: +Here is a quick overview of the main features of the `equations` package. For more information about solving equations and examples on how to use the classes from this package, see the articles on the repository's Wiki pages: - - the `dart_example/` folder contains a Dart CLI application that uses the `equations` package; - - the `flutter_example/` folder contains a Flutter application that uses the `equations` package. + - [Algebraic equations](https://github.com/albertodev01/equations/wiki/Algebraic-equations), for solving polynomial equations; + - [Nonlinear equations](https://github.com/albertodev01/equations/wiki/Nonlinear-equations), for solving nonlinear equations; + - [Systems of equations](https://github.com/albertodev01/equations/wiki/Systems-of-equations), for solving systems of equations; + - [Utilities](https://github.com/albertodev01/equations/wiki/Utilities), for working with matrices, evaluating integrals, interpolating data, and more. -You can also play with the Flutter example online at [https://albertodev01.github.io/equations/](https://albertodev01.github.io/equations/). +## Algebraic (Polynomial) equations + +```dart +// f(x) = ix^3 + (-2 + 5i)x + 7 +final equation = Cubic( + a: const Complex.i(), + c: const Complex(-2, 5), + d: const Complex.fromReal(7), +); +final solutions = equation.solutions(); + +/// -1.0447245173314328 + 1.7792977920746025i +/// 0.3113353509227148 - 2.7574534545940717i +/// 0.733389166408717 + 0.9781556625194701i +print(solutions); +``` + +## Nonlinear equations + +```dart +// f(x) = x^e - cos(x) +final newtonRaphson = Newton(function: 'x^e-cos(x)', x0: 0.5) +final result = newtonRaphson.solve(); + +// 0.856055... +print(result.guesses.last); +``` + +## Systems of equations + +```dart +// [1.0, 0.0, 1.0 | 6.0] +// [0.0, 2.0, 0.0 | 5.0] +// [1.0, 0.0, 3.0 | -2.0] +final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 1], + [0, 2, 0], + [1, 0, 3], + ], + ), + knownValues: [6, 5, -2], +); +final solutions = solver.solve(); + +// 10.0 +// 2.5 +// -4.0 +print(solutions); +``` \ No newline at end of file diff --git a/example/dart_example/.gitignore b/example/dart_example/.gitignore deleted file mode 100644 index 3c8a1572..00000000 --- a/example/dart_example/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -# Files and directories created by pub. -.dart_tool/ -.packages - -# Conventional directory for build output. -build/ diff --git a/example/dart_example/CHANGELOG.md b/example/dart_example/CHANGELOG.md deleted file mode 100644 index fae0d830..00000000 --- a/example/dart_example/CHANGELOG.md +++ /dev/null @@ -1,22 +0,0 @@ -## 1.0.5 - - Added usage example of the `AdaptiveQuadrature` object - - Updated Dart SDK constraints to `^3.1.0` - - Dependencies versions update - -## 1.0.4 - - Dependencies versions update - -## 1.0.3 - - Updated Dart SDK constraints to `^3.0.0` - - Dependencies versions update - -## 1.0.2 - - Updated Dart SDK constraints to `">=2.18.0 <3.0.0"` - - Dependencies versions update - -## 1.0.1 - - Updated Dart SDK constraints to `">=2.17.0 <3.0.0"` - - Dependencies versions update - -## 1.0.0 - - Initial release of the Dart CLI example app! diff --git a/example/dart_example/README.md b/example/dart_example/README.md deleted file mode 100644 index ee189ec8..00000000 --- a/example/dart_example/README.md +++ /dev/null @@ -1,16 +0,0 @@ -## Example - -This is a simple Dart CLI application that shows how the `equations` package can be used to solve equations, evaluate integrals or analyze matrices. You can run it using: - -```bash - $ dart run equation_solver_cli -``` - -from the `example/dart_example/` folder. The `` can be one of the following: - - - `-p` to generate and solve random polynomial equations; - - `-n` to solve nonlinear equations using various algorithms; - - `-i` to evaluate an integral using various algorithms; - - `-m` to analyze a matrix and solve a system with different decomposition strategies and algorithms. - -If you want to create a portable binary file of this example (like an .exe file for Windows), see the dart compile documentation for more info. diff --git a/example/dart_example/analysis_options.yaml b/example/dart_example/analysis_options.yaml deleted file mode 100644 index fac60e24..00000000 --- a/example/dart_example/analysis_options.yaml +++ /dev/null @@ -1 +0,0 @@ -include: ../../analysis_options.yaml \ No newline at end of file diff --git a/example/dart_example/bin/equation_solver_cli.dart b/example/dart_example/bin/equation_solver_cli.dart deleted file mode 100644 index 76819f34..00000000 --- a/example/dart_example/bin/equation_solver_cli.dart +++ /dev/null @@ -1,30 +0,0 @@ -import 'dart:convert'; -import 'dart:io'; - -import 'package:equation_solver_cli/equation_solver_cli.dart'; - -/// The main entrypoint expects only 1 argument, which is used to determine the -/// kind of demo. -void main(List arguments) { - stdout.encoding = utf8; - - // Only one argument is expected - if (arguments.length == 1) { - final output = switch (arguments.first) { - '-p' => const PolynomialOutput(), - '-n' => const NonlinearOutput(), - '-i' => const IntegralOutput(), - '-m' => const MatrixOutput(), - _ => const ErrorOutput(), - }; - - // ignore: cascade_invocations - output.processOutput(); - } else { - // Error message when 0 or more than 1 arguments - stdout.writeln( - '\n > Error: exactly one argument is required but ${arguments.length} ' - 'have been provided)\n', - ); - } -} diff --git a/example/dart_example/lib/equation_solver_cli.dart b/example/dart_example/lib/equation_solver_cli.dart deleted file mode 100644 index 4d7e798f..00000000 --- a/example/dart_example/lib/equation_solver_cli.dart +++ /dev/null @@ -1,9 +0,0 @@ -/// A demo CLI application to showcase the 'equations' package API. -library equation_solver_cli; - -export 'src/output.dart'; -export 'src/output_writers/error_output.dart'; -export 'src/output_writers/integral_output.dart'; -export 'src/output_writers/matrix_output.dart'; -export 'src/output_writers/nonlinear_output.dart'; -export 'src/output_writers/polynomial_output.dart'; diff --git a/example/dart_example/lib/src/output.dart b/example/dart_example/lib/src/output.dart deleted file mode 100644 index 1dadd0ad..00000000 --- a/example/dart_example/lib/src/output.dart +++ /dev/null @@ -1,11 +0,0 @@ -import 'dart:io'; - -/// Abstract type that exposes a method to print to [stdout]. -abstract class Output { - /// Allows subclasses to have a 'const' constructor. - const Output(); - - /// Prints to the console, using [stdout], some examples of equations, systems - /// of equations, or integrals solved using various algorithms. - void processOutput(); -} diff --git a/example/dart_example/lib/src/output_writers/error_output.dart b/example/dart_example/lib/src/output_writers/error_output.dart deleted file mode 100644 index 0c418d9c..00000000 --- a/example/dart_example/lib/src/output_writers/error_output.dart +++ /dev/null @@ -1,15 +0,0 @@ -import 'dart:io'; - -import 'package:equation_solver_cli/src/output.dart'; - -/// Prints an error message to the console stating that the given argument is -/// not valid. -class ErrorOutput extends Output { - /// Creates an [ErrorOutput] object. - const ErrorOutput(); - - @override - void processOutput() { - stdout.writeln('\n > Error: the given argument is not valid!\n'); - } -} diff --git a/example/dart_example/lib/src/output_writers/integral_output.dart b/example/dart_example/lib/src/output_writers/integral_output.dart deleted file mode 100644 index 0bc5a375..00000000 --- a/example/dart_example/lib/src/output_writers/integral_output.dart +++ /dev/null @@ -1,65 +0,0 @@ -import 'dart:io'; - -import 'package:equation_solver_cli/src/output.dart'; -import 'package:equations/equations.dart'; - -/// Evaluates an integral using various algorithms. -class IntegralOutput extends Output { - /// Creates an [IntegralOutput] object. - const IntegralOutput(); - - @override - void processOutput() { - const equation = 'x^5-tan(1-x)'; - - // Integral evaluation algorithms - final simpson = const SimpsonRule( - function: equation, - lowerBound: 0.5, - upperBound: 2, - ).integrate(); - final midpoint = const MidpointRule( - function: equation, - lowerBound: 0.5, - upperBound: 2, - ).integrate(); - final trapezoidal = const TrapezoidalRule( - function: equation, - lowerBound: 0.5, - upperBound: 2, - ).integrate(); - final adaptiveQuadrature = const AdaptiveQuadrature( - function: equation, - lowerBound: 0.5, - upperBound: 2, - ).integrate(); - - final output = StringBuffer() - ..write(' > Equation: ') - ..writeln(equation) - ..writeln("\n --- Simpson's method --- ") - ..write(' > Evaluation: ') - ..writeln(simpson.result) - ..write(' > Steps: ') - ..writeln(simpson.guesses.length) - ..writeln('\n --- Midpoint rule --- ') - ..write(' > Evaluation: ') - ..writeln(midpoint.result) - ..write(' > Steps: ') - ..writeln(midpoint.guesses.length) - ..writeln('\n --- Trapezoidal rule --- ') - ..write(' > Evaluation: ') - ..writeln(trapezoidal.result) - ..write(' > Steps: ') - ..writeln(trapezoidal.guesses.length) - ..writeln('\n --- Adaptive quadrature --- ') - ..write(' > Evaluation: ') - ..writeln(adaptiveQuadrature.result) - ..write(' > Steps: ') - ..writeln(adaptiveQuadrature.guesses.length); - - stdout - ..writeln('===== INTEGRALS EVALUATION =====\n') - ..writeln(output.toString()); - } -} diff --git a/example/dart_example/lib/src/output_writers/matrix_output.dart b/example/dart_example/lib/src/output_writers/matrix_output.dart deleted file mode 100644 index b3df7538..00000000 --- a/example/dart_example/lib/src/output_writers/matrix_output.dart +++ /dev/null @@ -1,104 +0,0 @@ -import 'dart:io'; - -import 'package:equation_solver_cli/src/output.dart'; -import 'package:equations/equations.dart'; - -/// Solves a system of equations and shows details of the associated matrix. -class MatrixOutput extends Output { - /// Creates an [MatrixOutput] object. - const MatrixOutput(); - - @override - void processOutput() { - final matrix = RealMatrix.fromData( - rows: 4, - columns: 4, - data: [ - [16, -12, -12, -16], - [-12, 25, 1, -4], - [-12, 1, 17, 14], - [-16, -4, 14, 57], - ], - ); - const knownValues = [7.0, 3.0, 6.0, -2.0]; - - // Decompositions - final lu = matrix.luDecomposition(); - final cholesky = matrix.choleskyDecomposition(); - final qr = matrix.qrDecomposition(); - final svd = matrix.singleValueDecomposition(); - - // Solvers - final gaussianElimination = GaussianElimination( - matrix: matrix, - knownValues: knownValues, - ); - - final gaussSolver = gaussianElimination.solve(); - final luSolver = LUSolver( - matrix: matrix, - knownValues: knownValues, - ).solve(); - final choleskySolver = CholeskySolver( - matrix: matrix, - knownValues: knownValues, - ).solve(); - final sorSolver = SORSolver( - matrix: matrix, - knownValues: knownValues, - w: 1.25, - ).solve(); - - final output = StringBuffer() - ..writeln('\n --- Matrix analysis --- \n') - ..writeln(matrix.toString()) - ..write('\n > Determinant: ') - ..writeln(matrix.determinant()) - ..write(' > Is diagonal? ') - ..writeln(matrix.isDiagonal()) - ..write(' > Is symmetric? ') - ..writeln(matrix.isSymmetric()) - ..write(' > Determinant: ') - ..writeln(matrix.isIdentity()) - ..write(' > Rank: ') - ..writeln(matrix.rank()) - ..write(' > Trace: ') - ..writeln(matrix.trace()) - ..write(' > Characteristic poly.: ') - ..writeln(matrix.characteristicPolynomial()) - ..write(' > Eigenvalues: ') - ..writeln(matrix.eigenvalues()) - ..writeln('\n --- LU Decomposition --- \n') - ..writeln(lu.first) - ..writeln() - ..writeln(lu[1]) - ..writeln('\n --- Cholesky Decomposition --- \n') - ..writeln(cholesky.first) - ..writeln() - ..writeln(cholesky[1]) - ..writeln('\n --- QR Decomposition --- \n') - ..writeln(qr.first) - ..writeln() - ..writeln(qr[1]) - ..writeln('\n --- SVD Decomposition --- \n') - ..writeln(svd.first) - ..writeln() - ..writeln(svd[1]) - ..writeln() - ..writeln(svd[2]) - ..writeln('\n --- System solving --- \n') - ..writeln(gaussianElimination.toStringAugmented()) - ..write('\n > Gaussian elimination: ') - ..writeln(gaussSolver) - ..write(' > LU: ') - ..writeln(luSolver) - ..write(' > Cholesky: ') - ..writeln(choleskySolver) - ..write(' > SOR: ') - ..writeln(sorSolver); - - stdout - ..writeln('===== SYSTEM EVALUATION =====\n') - ..writeln(output.toString()); - } -} diff --git a/example/dart_example/lib/src/output_writers/nonlinear_output.dart b/example/dart_example/lib/src/output_writers/nonlinear_output.dart deleted file mode 100644 index ae7e4a13..00000000 --- a/example/dart_example/lib/src/output_writers/nonlinear_output.dart +++ /dev/null @@ -1,87 +0,0 @@ -import 'dart:io'; - -import 'package:equation_solver_cli/src/output.dart'; -import 'package:equations/equations.dart'; - -/// Solves a nonlinear equation using various root-finding algorithms. -class NonlinearOutput extends Output { - /// Creates an [NonlinearOutput] object. - const NonlinearOutput(); - - @override - void processOutput() { - const equation = 'x^3-cos(x)'; - - // Root finding algorithms - single point - final newton = const Newton(function: equation, x0: 1).solve(); - final steffensen = const Steffensen(function: equation, x0: 1).solve(); - - // Root finding algorithms - bracketing - final bisection = const Bisection(function: equation, a: 0.5, b: 1).solve(); - final brent = const Brent(function: equation, a: 0.5, b: 1).solve(); - final chords = const Chords(function: equation, a: 0.5, b: 1).solve(); - final riddler = const Riddler(function: equation, a: 0.5, b: 1).solve(); - final regulaFalsi = const RegulaFalsi( - function: equation, - a: 0.5, - b: 1, - ).solve(); - - final output = StringBuffer() - ..write(' > Equation: ') - ..writeln(equation) - ..writeln("\n --- Newton's method --- ") - ..write(' > Root: ') - ..writeln(newton.guesses.last) - ..write(' > Convergence: ') - ..writeln(newton.convergence) - ..write(' > Efficiency: ') - ..writeln(newton.efficiency) - ..writeln("\n --- Steffensen's method --- ") - ..write(' > Root: ') - ..writeln(steffensen.guesses.last) - ..write(' > Convergence: ') - ..writeln(steffensen.convergence) - ..write(' > Efficiency: ') - ..writeln(steffensen.efficiency) - ..writeln('\n --- Bisection method --- ') - ..write(' > Root: ') - ..writeln(bisection.guesses.last) - ..write(' > Convergence: ') - ..writeln(bisection.convergence) - ..write(' > Efficiency: ') - ..writeln(bisection.efficiency) - ..writeln("\n --- Brent's method --- ") - ..write(' > Root: ') - ..writeln(brent.guesses.last) - ..write(' > Convergence: ') - ..writeln(brent.convergence) - ..write(' > Efficiency: ') - ..writeln(brent.efficiency) - ..writeln("\n --- Riddler's method --- ") - ..write(' > Root: ') - ..writeln(riddler.guesses.last) - ..write(' > Convergence: ') - ..writeln(riddler.convergence) - ..write(' > Efficiency: ') - ..writeln(riddler.efficiency) - ..writeln('\n --- Chord method --- ') - ..write(' > Root: ') - ..writeln(chords.guesses.last) - ..write(' > Convergence: ') - ..writeln(chords.convergence) - ..write(' > Efficiency: ') - ..writeln(chords.efficiency) - ..writeln('\n --- Regula falsi method --- ') - ..write(' > Root: ') - ..writeln(regulaFalsi.guesses.last) - ..write(' > Convergence: ') - ..writeln(regulaFalsi.convergence) - ..write(' > Efficiency: ') - ..writeln(regulaFalsi.efficiency); - - stdout - ..writeln('===== NONLINEAR EQUATIONS =====\n') - ..writeln(output.toString()); - } -} diff --git a/example/dart_example/lib/src/output_writers/polynomial_output.dart b/example/dart_example/lib/src/output_writers/polynomial_output.dart deleted file mode 100644 index 7e5b2450..00000000 --- a/example/dart_example/lib/src/output_writers/polynomial_output.dart +++ /dev/null @@ -1,52 +0,0 @@ -import 'dart:io'; -import 'dart:math'; - -import 'package:equation_solver_cli/src/output.dart'; -import 'package:equations/equations.dart'; - -/// Solves a polynomial equation whose degree and coefficients are randomly -/// generated each time. -class PolynomialOutput extends Output { - /// Creates an [PolynomialOutput] object. - const PolynomialOutput(); - - @override - void processOutput() { - final random = Random(); - - // Random degree - final degree = random.nextInt(4) + 2; - - // Random coefficients - final coefficients = []; - - for (var i = 0; i < degree; ++i) { - final sign = random.nextBool() ? -1.0 : 1.0; - - // The first coefficient cannot be zero - if (i == 0) { - coefficients.add(random.nextInt(5) + 1); - } else { - coefficients.add(random.nextInt(10) * sign); - } - } - - // Printing the results - final polynomial = Algebraic.fromReal(coefficients); - final output = StringBuffer() - ..write(' > Equation: ') - ..writeln(polynomial) - ..write(' > Degree: ') - ..writeln(polynomial.degree) - ..write(' > Derivative: ') - ..writeln(polynomial.derivative()) - ..write(' > Discriminant: ') - ..writeln(polynomial.discriminant()) - ..write(' > Roots: ') - ..writeln(polynomial.solutions()); - - stdout - ..writeln('===== POLYNOMIAL EQUATIONS =====\n') - ..writeln(output.toString()); - } -} diff --git a/example/dart_example/pubspec.yaml b/example/dart_example/pubspec.yaml deleted file mode 100644 index 01a6dfb8..00000000 --- a/example/dart_example/pubspec.yaml +++ /dev/null @@ -1,14 +0,0 @@ -name: equation_solver_cli -description: A Dart CLI application that uses the API of the 'equations' package. -version: 1.0.5 -publish_to: none - -environment: - sdk: ^3.1.0 - -dependencies: - equations: - path: ../../ - -dev_dependencies: - test: ^1.24.6 diff --git a/example/dart_example/test/common_process.dart b/example/dart_example/test/common_process.dart deleted file mode 100644 index 762a88be..00000000 --- a/example/dart_example/test/common_process.dart +++ /dev/null @@ -1,7 +0,0 @@ -import 'dart:io'; - -/// Creates a new process and parses the command-line argument. -Future createProcess({String? arg}) => Process.start( - 'dart', - ['run', './bin/equation_solver_cli.dart', if (arg != null) arg], - ); diff --git a/example/dart_example/test/error_output_test.dart b/example/dart_example/test/error_output_test.dart deleted file mode 100644 index 88139cb2..00000000 --- a/example/dart_example/test/error_output_test.dart +++ /dev/null @@ -1,34 +0,0 @@ -import 'dart:convert'; - -import 'package:test/test.dart'; - -import 'common_process.dart'; - -void main() { - group("Testing the 'ErrorOutput' class", () { - test( - 'Making sure that, when an unexpected argument is provided, an error ' - 'message is displayed', - () async { - final process = await createProcess( - arg: '', - ); - - // Converting into a stream - final stream = process.stdout - .transform(const Utf8Decoder()) - .transform(const LineSplitter()); - - // Expected output - const expectedOutput = ' > Error: the given argument is not valid!'; - - await expectLater( - stream, - emitsAnyOf( - ['', expectedOutput, ''], - ), - ); - }, - ); - }); -} diff --git a/example/dart_example/test/output_printers_test.dart b/example/dart_example/test/output_printers_test.dart deleted file mode 100644 index 26c1b31b..00000000 --- a/example/dart_example/test/output_printers_test.dart +++ /dev/null @@ -1,76 +0,0 @@ -import 'dart:convert'; -import 'dart:io'; - -import 'package:test/test.dart'; - -import 'common_process.dart'; - -void main() { - Future testProcess(Process process) async { - // Converting into a stream - final stream = process.stdout.transform(const Utf8Decoder()); - - // What to NOT expect - const notExpectedOutput = '\n > Error: the given argument is not valid!' - '\n\nPress any key to exit...'; - - // This is required to 'press any key to continue' - process.stdin.writeln('.'); - - await expectLater( - stream, - neverEmits( - [notExpectedOutput], - ), - ); - - final exitCode = await process.exitCode; - expect(exitCode, isZero); - } - - group('Testing the output classes', () { - test( - 'Making sure that Integrals can correctly be evaluated and printed', - () async { - final process = await createProcess( - arg: '-i', - ); - - await testProcess(process); - }, - ); - - test( - 'Making sure that matrices can correctly be evaluated and printed', - () async { - final process = await createProcess( - arg: '-m', - ); - - await testProcess(process); - }, - ); - - test( - 'Making sure that polynomials can correctly be evaluated and printed', - () async { - final process = await createProcess( - arg: '-p', - ); - - await testProcess(process); - }, - ); - - test( - 'Making sure that nonlinear eq. can correctly be evaluated and printed', - () async { - final process = await createProcess( - arg: '-n', - ); - - await testProcess(process); - }, - ); - }); -} diff --git a/example/flutter_example/.gitignore b/example/flutter_example/.gitignore deleted file mode 100644 index a9997a6c..00000000 --- a/example/flutter_example/.gitignore +++ /dev/null @@ -1,48 +0,0 @@ -# Miscellaneous -*.class -*.log -*.pyc -*.swp -.DS_Store -.atom/ -.buildlog/ -.history -.svn/ - -# IntelliJ related -*.iml -*.ipr -*.iws -.idea/ - -# The .vscode folder contains launch configuration and tasks you configure in -# VS Code which you may wish to be included in version control, so this line -# is commented out by default. -#.vscode/ - -# Flutter/Dart/Pub related -**/doc/api/ -**/ios/Flutter/.last_build_id -.dart_tool/ -.flutter-plugins -.flutter-plugins-dependencies -.packages -.pub-cache/ -.pub/ -/build/ -/coverage/ -**/failures/*.png - -# Web related -lib/generated_plugin_registrant.dart - -# Symbolication related -app.*.symbols - -# Obfuscation related -app.*.map.json - -# Android Studio will place build artifacts here -/android/app/debug -/android/app/profile -/android/app/release diff --git a/example/flutter_example/README.md b/example/flutter_example/README.md deleted file mode 100644 index dff35f69..00000000 --- a/example/flutter_example/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# Equations solver - -An equation-solving application created with Flutter that can run on Android, iOS, Windows, macOS, Linux, and the web. This project shows how the `equations` package is used to solve equations, systems, integrals, and much more. The application currently supports the following languages: - - - English - - Italian - - French - -If you wish to add more languages, please create a new `app_xx.arb` file (replace `xx` with the language code) inside `lib/localization` and submit a PR! :rocket: - -

Equation Solver logo

-

Equation Solver - Flutter web demo

- -If you want to play with this code on your machine, make sure to have Dart 3.0. (or greater) and Flutter 3.10.0 (or greater) installed. If you aren't using Windows 10, running tests with `flutter test` could fail because of golden tests. For any OS different from Windows, simply use `flutter test --update-goldens` once to refresh goldens and have your tests correctly executed. diff --git a/example/flutter_example/analysis_options.yaml b/example/flutter_example/analysis_options.yaml deleted file mode 100644 index 32e4a5a8..00000000 --- a/example/flutter_example/analysis_options.yaml +++ /dev/null @@ -1,5 +0,0 @@ -include: ../../analysis_options.yaml - -linter: - rules: - prefer_expression_function_bodies: false \ No newline at end of file diff --git a/example/flutter_example/android/.gitignore b/example/flutter_example/android/.gitignore deleted file mode 100644 index 5d99765d..00000000 --- a/example/flutter_example/android/.gitignore +++ /dev/null @@ -1,13 +0,0 @@ -gradle-wrapper.jar -/.gradle -/captures/ -/gradlew -/gradlew.bat -/local.properties -GeneratedPluginRegistrant.java - -# Remember to never publicly share your keystore. -# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app -key.properties -**/*.keystore -**/*.jks diff --git a/example/flutter_example/android/app/build.gradle b/example/flutter_example/android/app/build.gradle deleted file mode 100644 index 10ffab75..00000000 --- a/example/flutter_example/android/app/build.gradle +++ /dev/null @@ -1,77 +0,0 @@ -plugins { - id "com.android.application" - id "kotlin-android" - id "dev.flutter.flutter-gradle-plugin" -} - -def localProperties = new Properties() -def localPropertiesFile = rootProject.file('local.properties') -if (localPropertiesFile.exists()) { - localPropertiesFile.withReader('UTF-8') { reader -> - localProperties.load(reader) - } -} - -def flutterVersionCode = localProperties.getProperty('flutter.versionCode') -if (flutterVersionCode == null) { - flutterVersionCode = '1' -} - -def flutterVersionName = localProperties.getProperty('flutter.versionName') -if (flutterVersionName == null) { - flutterVersionName = '1.0' -} - -def keystoreProperties = new Properties() -def keystorePropertiesFile = rootProject.file('key.properties') -if (keystorePropertiesFile.exists()) { - keystoreProperties.load(new FileInputStream(keystorePropertiesFile)) -} - -android { - namespace "com.fluttercompletereference.equations_solver" - compileSdkVersion flutter.compileSdkVersion - ndkVersion flutter.ndkVersion - - compileOptions { - sourceCompatibility JavaVersion.VERSION_1_8 - targetCompatibility JavaVersion.VERSION_1_8 - } - - kotlinOptions { - jvmTarget = '1.8' - } - - sourceSets { - main.java.srcDirs += 'src/main/kotlin' - } - - defaultConfig { - applicationId "com.fluttercompletereference.equations_solver" - minSdkVersion flutter.minSdkVersion - targetSdkVersion flutter.targetSdkVersion - versionCode flutterVersionCode.toInteger() - versionName flutterVersionName - } - - signingConfigs { - release { - keyAlias keystoreProperties['keyAlias'] - keyPassword keystoreProperties['keyPassword'] - storeFile keystoreProperties['storeFile'] ? file(keystoreProperties['storeFile']) : null - storePassword keystoreProperties['storePassword'] - } - } - - buildTypes { - release { - signingConfig signingConfigs.release - } - } -} - -flutter { - source '../..' -} - -dependencies {} diff --git a/example/flutter_example/android/app/src/debug/AndroidManifest.xml b/example/flutter_example/android/app/src/debug/AndroidManifest.xml deleted file mode 100644 index 8ffe0246..00000000 --- a/example/flutter_example/android/app/src/debug/AndroidManifest.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - diff --git a/example/flutter_example/android/app/src/main/AndroidManifest.xml b/example/flutter_example/android/app/src/main/AndroidManifest.xml deleted file mode 100644 index 31e8b42e..00000000 --- a/example/flutter_example/android/app/src/main/AndroidManifest.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - diff --git a/example/flutter_example/android/app/src/main/kotlin/com/fluttercompletereference/equations_solver/flutter_example/MainActivity.kt b/example/flutter_example/android/app/src/main/kotlin/com/fluttercompletereference/equations_solver/flutter_example/MainActivity.kt deleted file mode 100644 index 9f93853c..00000000 --- a/example/flutter_example/android/app/src/main/kotlin/com/fluttercompletereference/equations_solver/flutter_example/MainActivity.kt +++ /dev/null @@ -1,6 +0,0 @@ -package com.fluttercompletereference.equations_solver.flutter_example - -import io.flutter.embedding.android.FlutterActivity - -class MainActivity: FlutterActivity() { -} diff --git a/example/flutter_example/android/app/src/main/res/drawable-v21/background.png b/example/flutter_example/android/app/src/main/res/drawable-v21/background.png deleted file mode 100644 index 6437f060..00000000 Binary files a/example/flutter_example/android/app/src/main/res/drawable-v21/background.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/drawable-v21/launch_background.xml b/example/flutter_example/android/app/src/main/res/drawable-v21/launch_background.xml deleted file mode 100644 index 3f8f43a9..00000000 --- a/example/flutter_example/android/app/src/main/res/drawable-v21/launch_background.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - diff --git a/example/flutter_example/android/app/src/main/res/drawable/background.png b/example/flutter_example/android/app/src/main/res/drawable/background.png deleted file mode 100644 index 6437f060..00000000 Binary files a/example/flutter_example/android/app/src/main/res/drawable/background.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/drawable/launch_background.xml b/example/flutter_example/android/app/src/main/res/drawable/launch_background.xml deleted file mode 100644 index 3bce1328..00000000 --- a/example/flutter_example/android/app/src/main/res/drawable/launch_background.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - diff --git a/example/flutter_example/android/app/src/main/res/mipmap-hdpi/ic_launcher.png b/example/flutter_example/android/app/src/main/res/mipmap-hdpi/ic_launcher.png deleted file mode 100644 index ac277288..00000000 Binary files a/example/flutter_example/android/app/src/main/res/mipmap-hdpi/ic_launcher.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/mipmap-mdpi/ic_launcher.png b/example/flutter_example/android/app/src/main/res/mipmap-mdpi/ic_launcher.png deleted file mode 100644 index 2a557187..00000000 Binary files a/example/flutter_example/android/app/src/main/res/mipmap-mdpi/ic_launcher.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/example/flutter_example/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png deleted file mode 100644 index b4419d80..00000000 Binary files a/example/flutter_example/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/example/flutter_example/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png deleted file mode 100644 index 569cf478..00000000 Binary files a/example/flutter_example/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/example/flutter_example/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png deleted file mode 100644 index 8609f59a..00000000 Binary files a/example/flutter_example/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png and /dev/null differ diff --git a/example/flutter_example/android/app/src/main/res/values-night/styles.xml b/example/flutter_example/android/app/src/main/res/values-night/styles.xml deleted file mode 100644 index 449a9f93..00000000 --- a/example/flutter_example/android/app/src/main/res/values-night/styles.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - diff --git a/example/flutter_example/android/app/src/main/res/values/strings.xml b/example/flutter_example/android/app/src/main/res/values/strings.xml deleted file mode 100644 index 348716a8..00000000 --- a/example/flutter_example/android/app/src/main/res/values/strings.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - Equation Solver - \ No newline at end of file diff --git a/example/flutter_example/android/app/src/main/res/values/styles.xml b/example/flutter_example/android/app/src/main/res/values/styles.xml deleted file mode 100644 index d74aa35c..00000000 --- a/example/flutter_example/android/app/src/main/res/values/styles.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - diff --git a/example/flutter_example/android/app/src/main/res/values/values-fr/strings.xml b/example/flutter_example/android/app/src/main/res/values/values-fr/strings.xml deleted file mode 100644 index 031f18b1..00000000 --- a/example/flutter_example/android/app/src/main/res/values/values-fr/strings.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - Équations solver - \ No newline at end of file diff --git a/example/flutter_example/android/app/src/main/res/values/values-it/strings.xml b/example/flutter_example/android/app/src/main/res/values/values-it/strings.xml deleted file mode 100644 index be02d1a3..00000000 --- a/example/flutter_example/android/app/src/main/res/values/values-it/strings.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - Risolutore di equazioni - \ No newline at end of file diff --git a/example/flutter_example/android/app/src/profile/AndroidManifest.xml b/example/flutter_example/android/app/src/profile/AndroidManifest.xml deleted file mode 100644 index 8ffe0246..00000000 --- a/example/flutter_example/android/app/src/profile/AndroidManifest.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - diff --git a/example/flutter_example/android/build.gradle b/example/flutter_example/android/build.gradle deleted file mode 100644 index 0bd4dfd0..00000000 --- a/example/flutter_example/android/build.gradle +++ /dev/null @@ -1,31 +0,0 @@ -buildscript { - ext.kotlin_version = '1.7.10' - repositories { - google() - mavenCentral() - } - - dependencies { - classpath 'com.android.tools.build:gradle:7.3.0' - classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" - } -} - -allprojects { - repositories { - google() - mavenCentral() - } -} - -rootProject.buildDir = '../build' -subprojects { - project.buildDir = "${rootProject.buildDir}/${project.name}" -} -subprojects { - project.evaluationDependsOn(':app') -} - -tasks.register("clean", Delete) { - delete rootProject.buildDir -} diff --git a/example/flutter_example/android/gradle.properties b/example/flutter_example/android/gradle.properties deleted file mode 100644 index 46c1f169..00000000 --- a/example/flutter_example/android/gradle.properties +++ /dev/null @@ -1,3 +0,0 @@ -org.gradle.jvmargs=-Xmx1536M -android.useAndroidX=true -android.enableJetifier=true diff --git a/example/flutter_example/android/gradle/wrapper/gradle-wrapper.properties b/example/flutter_example/android/gradle/wrapper/gradle-wrapper.properties deleted file mode 100644 index eabb85f5..00000000 --- a/example/flutter_example/android/gradle/wrapper/gradle-wrapper.properties +++ /dev/null @@ -1,5 +0,0 @@ -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -zipStoreBase=GRADLE_USER_HOME -zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip diff --git a/example/flutter_example/android/settings.gradle b/example/flutter_example/android/settings.gradle deleted file mode 100644 index 96e86e55..00000000 --- a/example/flutter_example/android/settings.gradle +++ /dev/null @@ -1,20 +0,0 @@ -pluginManagement { - def flutterSdkPath = { - def properties = new Properties() - file("local.properties").withInputStream { properties.load(it) } - def flutterSdkPath = properties.getProperty("flutter.sdk") - assert flutterSdkPath != null, "flutter.sdk not set in local.properties" - return flutterSdkPath - } - settings.ext.flutterSdkPath = flutterSdkPath() - - includeBuild("${settings.ext.flutterSdkPath}/packages/flutter_tools/gradle") - - plugins { - id "dev.flutter.flutter-gradle-plugin" version "1.0.0" apply false - } -} - -include ":app" - -apply from: "${settings.ext.flutterSdkPath}/packages/flutter_tools/gradle/app_plugin_loader.gradle" diff --git a/example/flutter_example/assets/svg/angle.svg b/example/flutter_example/assets/svg/angle.svg deleted file mode 100644 index b0ca73a8..00000000 --- a/example/flutter_example/assets/svg/angle.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/atoms.svg b/example/flutter_example/assets/svg/atoms.svg deleted file mode 100644 index e65ed28a..00000000 --- a/example/flutter_example/assets/svg/atoms.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/axis.svg b/example/flutter_example/assets/svg/axis.svg deleted file mode 100644 index 940ecff3..00000000 --- a/example/flutter_example/assets/svg/axis.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/function.svg b/example/flutter_example/assets/svg/function.svg deleted file mode 100644 index 608514d5..00000000 --- a/example/flutter_example/assets/svg/function.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/integral.svg b/example/flutter_example/assets/svg/integral.svg deleted file mode 100644 index 017fccdc..00000000 --- a/example/flutter_example/assets/svg/integral.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/logo.svg b/example/flutter_example/assets/svg/logo.svg deleted file mode 100644 index 7dfe725f..00000000 --- a/example/flutter_example/assets/svg/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/matrix.svg b/example/flutter_example/assets/svg/matrix.svg deleted file mode 100644 index 6fd36c6b..00000000 --- a/example/flutter_example/assets/svg/matrix.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/plot.svg b/example/flutter_example/assets/svg/plot.svg deleted file mode 100644 index e1a56dac..00000000 --- a/example/flutter_example/assets/svg/plot.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/plot_opacity.svg b/example/flutter_example/assets/svg/plot_opacity.svg deleted file mode 100644 index 8aa22ff0..00000000 --- a/example/flutter_example/assets/svg/plot_opacity.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/polynomial.svg b/example/flutter_example/assets/svg/polynomial.svg deleted file mode 100644 index 6ba3dfe0..00000000 --- a/example/flutter_example/assets/svg/polynomial.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/solutions.svg b/example/flutter_example/assets/svg/solutions.svg deleted file mode 100644 index 91010052..00000000 --- a/example/flutter_example/assets/svg/solutions.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/square-root-simple.svg b/example/flutter_example/assets/svg/square-root-simple.svg deleted file mode 100644 index 628f495d..00000000 --- a/example/flutter_example/assets/svg/square-root-simple.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/square_matrix.svg b/example/flutter_example/assets/svg/square_matrix.svg deleted file mode 100644 index f18f7cbd..00000000 --- a/example/flutter_example/assets/svg/square_matrix.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/tools_imaginary.svg b/example/flutter_example/assets/svg/tools_imaginary.svg deleted file mode 100644 index bdad957f..00000000 --- a/example/flutter_example/assets/svg/tools_imaginary.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/tools_matrix.svg b/example/flutter_example/assets/svg/tools_matrix.svg deleted file mode 100644 index 69a90ff0..00000000 --- a/example/flutter_example/assets/svg/tools_matrix.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/url_error.svg b/example/flutter_example/assets/svg/url_error.svg deleted file mode 100644 index ba2b5511..00000000 --- a/example/flutter_example/assets/svg/url_error.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/assets/svg/wrench.svg b/example/flutter_example/assets/svg/wrench.svg deleted file mode 100644 index f357cc2e..00000000 --- a/example/flutter_example/assets/svg/wrench.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/integration_test/home_page_test.dart b/example/flutter_example/integration_test/home_page_test.dart deleted file mode 100644 index 4c3e8c12..00000000 --- a/example/flutter_example/integration_test/home_page_test.dart +++ /dev/null @@ -1,73 +0,0 @@ -import 'package:equations_solver/main.dart' as app; -import 'package:equations_solver/routes/integral_page.dart'; -import 'package:equations_solver/routes/nonlinear_page.dart'; -import 'package:equations_solver/routes/other_page.dart'; -import 'package:equations_solver/routes/polynomial_page.dart'; -import 'package:equations_solver/routes/system_page.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:flutter/widgets.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'utils.dart'; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - group('Integration tests on the Home page', () { - testWidgets( - 'Testing route transition animations', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - - // Opening the polynomial page and coming back - await tester.tap(find.byKey(const Key('PolynomialLogo-Container'))); - await tester.pumpAndSettle(); - - expect(find.byType(PolynomialPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - // Opening the nonlinear page and coming back - await tester.tap(find.byKey(const Key('NonlinearLogo-Container'))); - await tester.pumpAndSettle(); - - expect(find.byType(NonlinearPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - // Opening the system page and coming back - await tester.tap(find.byKey(const Key('SystemsLogo-Container'))); - await tester.pumpAndSettle(); - - expect(find.byType(SystemPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - // Opening the integral page and coming back - await tester.tap(find.byKey(const Key('IntegralsLogo-Container'))); - await tester.pumpAndSettle(); - - expect(find.byType(IntegralPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - // Opening the other page and coming back - await tester.tap(find.byKey(const Key('OtherLogo-Container'))); - await tester.pumpAndSettle(); - - expect(find.byType(OtherPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - }, - ); - }); -} diff --git a/example/flutter_example/integration_test/integral_page_test.dart b/example/flutter_example/integration_test/integral_page_test.dart deleted file mode 100644 index 606da2ac..00000000 --- a/example/flutter_example/integration_test/integral_page_test.dart +++ /dev/null @@ -1,112 +0,0 @@ -import 'package:equations_solver/main.dart' as app; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'utils.dart'; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - var needsOpenPage = true; - - Future testIntegral( - WidgetTester tester, [ - String type = '', - ]) async { - if (needsOpenPage) { - // Opening the integral page - await tester.tap(find.byKey(const Key('IntegralsLogo-Container'))); - await tester.pumpAndSettle(); - - needsOpenPage = false; - } - - // Entering values - await tester.enterText( - find.byKey(const Key('EquationInput-function')), - 'x-3', - ); - await tester.enterText( - find.byKey(const Key('IntegralInput-lower-bound')), - '1', - ); - await tester.enterText( - find.byKey(const Key('IntegralInput-upper-bound')), - '2', - ); - - if (type.isNotEmpty) { - await tester.ensureVisible(find.text('Simpson')); - await tester.pumpAndSettle(); - - // Changing the dropdown value - await tester.tap(find.text('Simpson')); - await tester.pumpAndSettle(); - - await tester.tap(find.text(type).last); - await tester.pumpAndSettle(); - } - - // Solving - final solveBtn = find.byKey(const Key('Integral-button-solve')); - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Expecting one card with the integral evaluation - await tester.ensureVisible(find.byType(RealResultCard)); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - - // Cleaning - final cleanBtn = find.byKey(const Key('Integral-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - } - - group('Integration tests on the Integral page', () { - testWidgets( - 'Testing the simpson method', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testIntegral(tester); - }, - ); - - testWidgets( - 'Testing the trapezoid method', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testIntegral(tester, 'Trapezoid'); - }, - ); - - testWidgets( - 'Testing the midpoint method', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testIntegral(tester, 'Midpoint'); - }, - ); - }); -} diff --git a/example/flutter_example/integration_test/nonlinear_page_test.dart b/example/flutter_example/integration_test/nonlinear_page_test.dart deleted file mode 100644 index 7289b1a6..00000000 --- a/example/flutter_example/integration_test/nonlinear_page_test.dart +++ /dev/null @@ -1,184 +0,0 @@ -import 'package:equations_solver/main.dart' as app; -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'utils.dart'; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - var needsOpenPage = true; - - Future testSinglePoint( - WidgetTester tester, [ - String dropdownValue = '', - ]) async { - if (needsOpenPage) { - // Opening the nonlinear page - await tester.tap(find.byKey(const Key('NonlinearLogo-Container'))); - await tester.pumpAndSettle(); - - needsOpenPage = false; - } - - // Inserting data - final finder = find.byType(TextFormField); - await tester.enterText(finder.first, 'x-2.25'); - await tester.enterText(finder.last, '2'); - - if (dropdownValue.isNotEmpty) { - await tester.ensureVisible(find.text('Newton')); - await tester.pumpAndSettle(); - - // Changing the dropdown value - await tester.tap(find.text('Newton')); - await tester.pumpAndSettle(); - - await tester.tap(find.text(dropdownValue).last); - await tester.pumpAndSettle(); - } - - // Solving - final solveBtn = find.byKey(const Key('Nonlinear-button-solve')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pump(); - - // Expecting solutions - await tester.ensureVisible(find.byType(RealResultCard).first); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNWidgets(3)); - - // Cleaning - final cleanBtn = find.byKey(const Key('Nonlinear-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pump(); - - expect(find.byType(RealResultCard), findsNothing); - } - - Future testBracketing( - WidgetTester tester, [ - String dropdownValue = '', - ]) async { - // Moving to the 'Bracketing' page - tester - .widget(find.byType(InheritedNavigation)) - .navigationIndex - .value = 1; - - await tester.pumpAndSettle(); - - // Inserting data - final finder = find.byType(TextFormField); - await tester.enterText(finder.at(0), 'x-2.25'); - await tester.enterText(finder.at(1), '1'); - await tester.enterText(finder.at(2), '3'); - - if (dropdownValue.isNotEmpty) { - await tester.ensureVisible(find.text('Bisection')); - await tester.pumpAndSettle(); - - // Changing the dropdown value - await tester.tap(find.text('Bisection')); - await tester.pumpAndSettle(); - - await tester.tap(find.text(dropdownValue).last); - await tester.pumpAndSettle(); - } - - // Solving - final solveBtn = find.byKey(const Key('Nonlinear-button-solve')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pump(); - - // Expecting solutions - await tester.ensureVisible(find.byType(RealResultCard).first); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNWidgets(3)); - - // Cleaning - final cleanBtn = find.byKey(const Key('Nonlinear-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pump(); - - expect(find.byType(RealResultCard), findsNothing); - } - - group('Integration tests on the Nonlinear page', () { - testWidgets( - 'Testing nonlinear equations - Newton', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testSinglePoint(tester); - }, - ); - - testWidgets( - 'Testing nonlinear equations - Steffensen', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testSinglePoint(tester, 'Steffensen'); - }, - ); - - testWidgets( - 'Testing nonlinear equations - Bisection', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testBracketing(tester); - }, - ); - - testWidgets( - 'Testing nonlinear equations - Secant', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testBracketing(tester, 'Secant'); - }, - ); - - testWidgets( - 'Testing nonlinear equations - Brent', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testBracketing(tester, 'Brent'); - }, - ); - }); -} diff --git a/example/flutter_example/integration_test/other_page_test.dart b/example/flutter_example/integration_test/other_page_test.dart deleted file mode 100644 index 1aa277bf..00000000 --- a/example/flutter_example/integration_test/other_page_test.dart +++ /dev/null @@ -1,126 +0,0 @@ -import 'package:equations_solver/main.dart' as app; -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'utils.dart'; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - var needsOpenPage = true; - - Future testMatrix(WidgetTester tester) async { - if (needsOpenPage) { - // Opening the system page - await tester.tap(find.byKey(const Key('OtherLogo-Container'))); - await tester.pumpAndSettle(); - - needsOpenPage = false; - } - - await tester.enterText( - find.byType(TextFormField), - '1', - ); - - // Evaluating - final solveBtn = find.byKey(const Key('MatrixAnalyze-button-analyze')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Cleaning - final cleanBtn = find.byKey(const Key('MatrixAnalyze-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - } - - Future testComplex(WidgetTester tester) async { - // Moving to the 'Bracketing' page - tester - .widget(find.byType(InheritedNavigation)) - .navigationIndex - .value = 1; - - await tester.pumpAndSettle(); - - // Entering values - await tester.enterText( - find.byKey(const Key('ComplexNumberInput-TextFormField-RealPart')), - '-2', - ); - await tester.enterText( - find.byKey(const Key('ComplexNumberInput-TextFormField-ImaginaryPart')), - '1', - ); - - // Solving - final solveBtn = find.byKey(const Key('ComplexAnalyze-button-analyze')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Result cards - await tester.ensureVisible(find.byType(RealResultCard).last); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsWidgets); - - await tester.ensureVisible(find.byType(ComplexResultCard).last); - await tester.pumpAndSettle(); - - expect(find.byType(ComplexResultCard), findsWidgets); - - // Cleaning - final cleanBtn = find.byKey(const Key('ComplexAnalyze-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - expect(find.byType(ComplexResultCard), findsNothing); - } - - group('Integration tests on the Other page', () { - testWidgets( - 'Testing matrix analysis', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testMatrix(tester); - }, - ); - - testWidgets( - 'Testing complex numbers analysis', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testComplex(tester); - }, - ); - }); -} diff --git a/example/flutter_example/integration_test/polynomial_page_test.dart b/example/flutter_example/integration_test/polynomial_page_test.dart deleted file mode 100644 index 69d5c4c7..00000000 --- a/example/flutter_example/integration_test/polynomial_page_test.dart +++ /dev/null @@ -1,110 +0,0 @@ -import 'package:equations_solver/main.dart' as app; -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'utils.dart'; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - var needsOpenPage = true; - - Future testPolynomial(WidgetTester tester, int degree) async { - if (needsOpenPage) { - // Opening the nonlinear page - await tester.tap(find.byKey(const Key('PolynomialLogo-Container'))); - await tester.pumpAndSettle(); - - needsOpenPage = false; - } - - if (degree != 1) { - tester - .widget(find.byType(InheritedNavigation)) - .navigationIndex - .value = degree - 1; - - await tester.pumpAndSettle(); - } - - final finder = find.byType(TextFormField); - for (var i = 0; i <= degree; ++i) { - await tester.enterText(finder.at(i), '${i + 1}'); - } - - // Solving - final solveBtn = find.byKey(const Key('Polynomial-button-solve')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Widgets: `degree` cards for the root and 1 for the discriminant - await tester.ensureVisible(find.byType(ComplexResultCard).last); - await tester.pumpAndSettle(); - - expect(find.byType(ComplexResultCard), findsNWidgets(degree + 1)); - - // Cleaning - final cleanBtn = find.byKey(const Key('Polynomial-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(ComplexResultCard), findsNothing); - } - - group('Integration tests on the Polynomial page', () { - testWidgets( - 'Testing linear equations', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testPolynomial(tester, 1); - }, - ); - - testWidgets( - 'Testing quadratic equations', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testPolynomial(tester, 2); - }, - ); - - testWidgets( - 'Testing cubic equations', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testPolynomial(tester, 3); - }, - ); - - testWidgets( - 'Testing quartic equations', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - await testPolynomial(tester, 4); - }, - ); - }); -} diff --git a/example/flutter_example/integration_test/system_page_test.dart b/example/flutter_example/integration_test/system_page_test.dart deleted file mode 100644 index 5173f581..00000000 --- a/example/flutter_example/integration_test/system_page_test.dart +++ /dev/null @@ -1,370 +0,0 @@ -import 'package:equations_solver/main.dart' as app; -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'utils.dart'; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - var needsOpenPage = true; - - const matrixCoefficients = [ - 16, - -12, - -12, - -16, - -12, - 25, - 1, - -4, - -12, - 1, - 17, - 14, - -16, - -4, - 14, - 57, - ]; - const knownValues = [7, 3, 6, -2]; - - Future testRowReduction( - WidgetTester tester, [ - int size = 1, - ]) async { - if (needsOpenPage) { - // Opening the system page - await tester.tap(find.byKey(const Key('SystemsLogo-Container'))); - await tester.pumpAndSettle(); - - needsOpenPage = false; - } - - final finder = find.byType(TextFormField); - final matrixInputs = size * size; - - if (size > 1) { - final finder = find.byKey(const Key('SizePicker-Forward-Button')); - - await tester.ensureVisible(finder); - await tester.pumpAndSettle(); - - for (var i = 1; i < size; ++i) { - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pumpAndSettle(); - } - } - - // Filling the matrix - for (var i = 0; i < matrixInputs; ++i) { - await tester.enterText(finder.at(i), '${matrixCoefficients[i]}'); - } - - // Filling the known values vector - var knownValuesCounter = 0; - for (var i = matrixInputs; i < matrixInputs + size; ++i) { - await tester.enterText( - finder.at(i), - '${knownValues[knownValuesCounter]}', - ); - knownValuesCounter++; - } - - // Solving - final solveBtn = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Result cards - await tester.ensureVisible(find.byType(RealResultCard).last); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNWidgets(size)); - - // Cleaning - final cleanBtn = find.byKey(const Key('System-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - } - - Future testFactorization( - WidgetTester tester, [ - int size = 1, - // ignore: avoid_positional_boolean_parameters - bool cholesky = false, - ]) async { - tester - .widget(find.byType(InheritedNavigation)) - .navigationIndex - .value = 1; - - await tester.pumpAndSettle(); - - final finder = find.byType(TextFormField); - final matrixInputs = size * size; - - if (size > 1) { - final finder = find.byKey(const Key('SizePicker-Forward-Button')); - - await tester.ensureVisible(finder); - await tester.pumpAndSettle(); - - for (var i = 1; i < size; ++i) { - await tester.tap(finder); - await tester.pumpAndSettle(); - } - } - - // Filling the matrix - for (var i = 0; i < matrixInputs; ++i) { - await tester.enterText(finder.at(i), '${matrixCoefficients[i]}'); - } - - // Filling the known values vector - var knownValuesCounter = 0; - for (var i = matrixInputs; i < matrixInputs + size; ++i) { - await tester.enterText( - finder.at(i), - '${knownValues[knownValuesCounter]}', - ); - knownValuesCounter++; - } - - if (cholesky && size == 1) { - await tester.ensureVisible(find.text('LU')); - await tester.pumpAndSettle(); - - // Changing the dropdown value - await tester.tap(find.text('LU')); - await tester.pumpAndSettle(); - - await tester.ensureVisible(find.text('Cholesky').last); - await tester.pumpAndSettle(); - - await tester.tap(find.text('Cholesky').last); - await tester.pumpAndSettle(); - } - - // Solving - final solveBtn = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Result cards - await tester.ensureVisible(find.byType(RealResultCard).last); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNWidgets(size)); - - // Cleaning - final cleanBtn = find.byKey(const Key('System-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - } - - Future testIterative( - WidgetTester tester, [ - int size = 1, - // ignore: avoid_positional_boolean_parameters - bool jacobi = false, - ]) async { - // Moving to the 'Bracketing' page - tester - .widget(find.byType(InheritedNavigation)) - .navigationIndex - .value = 2; - - await tester.pumpAndSettle(); - - final finder = find.byType(TextFormField); - final matrixInputs = size * size; - - if (size > 1) { - final finder = find.byKey(const Key('SizePicker-Forward-Button')); - - await tester.ensureVisible(finder); - await tester.pumpAndSettle(); - - for (var i = 1; i < size; ++i) { - await tester.tap(finder); - await tester.pumpAndSettle(); - } - } - - // Filling the matrix - for (var i = 0; i < matrixInputs; ++i) { - await tester.enterText(finder.at(i), '${matrixCoefficients[i]}'); - } - - // Filling the known values vector - var knownValuesCounter = 0; - for (var i = matrixInputs; i < matrixInputs + size; ++i) { - await tester.enterText( - finder.at(i), - '${knownValues[knownValuesCounter]}', - ); - knownValuesCounter++; - } - - if (jacobi) { - if (size == 1) { - await tester.ensureVisible(find.text('SOR')); - await tester.pumpAndSettle(); - - // Changing the dropdown value - await tester.tap(find.text('SOR')); - await tester.pumpAndSettle(); - - await tester.ensureVisible(find.text('SOR').last); - await tester.pumpAndSettle(); - - await tester.tap(find.text('Jacobi').last); - await tester.pumpAndSettle(); - } - - // Initial guess vector - final totalInputs = matrixInputs + size; - - var value = 0; - for (var i = totalInputs; i < totalInputs + size; ++i) { - await tester.enterText(finder.at(i), '${value++}'); - } - } else { - final w = find.byKey( - const Key('SystemSolver-Iterative-RelaxationFactor'), - ); - - await tester.ensureVisible(w); - await tester.pumpAndSettle(); - - await tester.enterText(w, '0.5'); - } - - // Solving - final solveBtn = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveBtn); - await tester.pumpAndSettle(); - - await tester.tap(solveBtn); - await tester.pumpAndSettle(); - - // Result cards - await tester.ensureVisible(find.byType(RealResultCard).last); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNWidgets(size)); - - // Cleaning - final cleanBtn = find.byKey(const Key('System-button-clean')); - - await tester.ensureVisible(cleanBtn); - await tester.pumpAndSettle(); - - await tester.tap(cleanBtn); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - } - - group('Integration tests on the System page', () { - testWidgets( - 'Testing row reduction', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - - await testRowReduction(tester); - await testRowReduction(tester, 2); - await testRowReduction(tester, 3); - await testRowReduction(tester, 4); - }, - ); - - testWidgets( - 'Testing factorization - LU', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - - await testFactorization(tester); - await testFactorization(tester, 2); - await testFactorization(tester, 3); - await testFactorization(tester, 4); - }, - ); - - testWidgets( - 'Testing factorization - Cholesky', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - - await testFactorization(tester, 1, true); - await testFactorization(tester, 2, true); - await testFactorization(tester, 3, true); - await testFactorization(tester, 4, true); - }, - ); - - testWidgets( - 'Testing iterative - SOR', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - - await testIterative(tester); - await testIterative(tester, 2); - await testIterative(tester, 3); - await testIterative(tester, 4); - }, - ); - - testWidgets( - 'Testing iterative - Jacobi', - (tester) async { - await configureIfDesktop(tester); - - app.main(); - await tester.pumpAndSettle(); - - await testIterative(tester, 1, true); - await testIterative(tester, 2, true); - await testIterative(tester, 3, true); - await testIterative(tester, 4, true); - }, - ); - }); -} diff --git a/example/flutter_example/integration_test/utils.dart b/example/flutter_example/integration_test/utils.dart deleted file mode 100644 index 6970d3d7..00000000 --- a/example/flutter_example/integration_test/utils.dart +++ /dev/null @@ -1,19 +0,0 @@ -import 'dart:io'; -import 'dart:ui'; - -import 'package:flutter/foundation.dart'; -import 'package:flutter_test/flutter_test.dart'; - -/// Determines whether the integration test is running on a desktop platform or -/// not. In case of desktop, the test surface is enlarged. -/// -/// Enlarging the test surface ensures that all widget are visible and avoids -/// the 'warn if missed' call. -Future configureIfDesktop(WidgetTester tester) async { - final isDesktop = Platform.isWindows || Platform.isMacOS || Platform.isLinux; - - // A web app can also be run on a mobile device so we want to exclude it. - if (!kIsWeb && isDesktop) { - await tester.binding.setSurfaceSize(const Size(1200, 1200)); - } -} diff --git a/example/flutter_example/ios/.gitignore b/example/flutter_example/ios/.gitignore deleted file mode 100644 index e96ef602..00000000 --- a/example/flutter_example/ios/.gitignore +++ /dev/null @@ -1,32 +0,0 @@ -*.mode1v3 -*.mode2v3 -*.moved-aside -*.pbxuser -*.perspectivev3 -**/*sync/ -.sconsign.dblite -.tags* -**/.vagrant/ -**/DerivedData/ -Icon? -**/Pods/ -**/.symlinks/ -profile -xcuserdata -**/.generated/ -Flutter/App.framework -Flutter/Flutter.framework -Flutter/Flutter.podspec -Flutter/Generated.xcconfig -Flutter/app.flx -Flutter/app.zip -Flutter/flutter_assets/ -Flutter/flutter_export_environment.sh -ServiceDefinitions.json -Runner/GeneratedPluginRegistrant.* - -# Exceptions to above rules. -!default.mode1v3 -!default.mode2v3 -!default.pbxuser -!default.perspectivev3 diff --git a/example/flutter_example/ios/Flutter/AppFrameworkInfo.plist b/example/flutter_example/ios/Flutter/AppFrameworkInfo.plist deleted file mode 100644 index 9625e105..00000000 --- a/example/flutter_example/ios/Flutter/AppFrameworkInfo.plist +++ /dev/null @@ -1,26 +0,0 @@ - - - - - CFBundleDevelopmentRegion - en - CFBundleExecutable - App - CFBundleIdentifier - io.flutter.flutter.app - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - App - CFBundlePackageType - FMWK - CFBundleShortVersionString - 1.0 - CFBundleSignature - ???? - CFBundleVersion - 1.0 - MinimumOSVersion - 11.0 - - diff --git a/example/flutter_example/ios/Flutter/Debug.xcconfig b/example/flutter_example/ios/Flutter/Debug.xcconfig deleted file mode 100644 index e8efba11..00000000 --- a/example/flutter_example/ios/Flutter/Debug.xcconfig +++ /dev/null @@ -1,2 +0,0 @@ -#include "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" -#include "Generated.xcconfig" diff --git a/example/flutter_example/ios/Flutter/Release.xcconfig b/example/flutter_example/ios/Flutter/Release.xcconfig deleted file mode 100644 index 399e9340..00000000 --- a/example/flutter_example/ios/Flutter/Release.xcconfig +++ /dev/null @@ -1,2 +0,0 @@ -#include "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" -#include "Generated.xcconfig" diff --git a/example/flutter_example/ios/Podfile b/example/flutter_example/ios/Podfile deleted file mode 100644 index 88359b22..00000000 --- a/example/flutter_example/ios/Podfile +++ /dev/null @@ -1,41 +0,0 @@ -# Uncomment this line to define a global platform for your project -# platform :ios, '11.0' - -# CocoaPods analytics sends network stats synchronously affecting flutter build latency. -ENV['COCOAPODS_DISABLE_STATS'] = 'true' - -project 'Runner', { - 'Debug' => :debug, - 'Profile' => :release, - 'Release' => :release, -} - -def flutter_root - generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__) - unless File.exist?(generated_xcode_build_settings_path) - raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first" - end - - File.foreach(generated_xcode_build_settings_path) do |line| - matches = line.match(/FLUTTER_ROOT\=(.*)/) - return matches[1].strip if matches - end - raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get" -end - -require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) - -flutter_ios_podfile_setup - -target 'Runner' do - use_frameworks! - use_modular_headers! - - flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__)) -end - -post_install do |installer| - installer.pods_project.targets.each do |target| - flutter_additional_ios_build_settings(target) - end -end diff --git a/example/flutter_example/ios/Podfile.lock b/example/flutter_example/ios/Podfile.lock deleted file mode 100644 index f4c61ad4..00000000 --- a/example/flutter_example/ios/Podfile.lock +++ /dev/null @@ -1,22 +0,0 @@ -PODS: - - Flutter (1.0.0) - - integration_test (0.0.1): - - Flutter - -DEPENDENCIES: - - Flutter (from `Flutter`) - - integration_test (from `.symlinks/plugins/integration_test/ios`) - -EXTERNAL SOURCES: - Flutter: - :path: Flutter - integration_test: - :path: ".symlinks/plugins/integration_test/ios" - -SPEC CHECKSUMS: - Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854 - integration_test: 13825b8a9334a850581300559b8839134b124670 - -PODFILE CHECKSUM: ef19549a9bc3046e7bb7d2fab4d021637c0c58a3 - -COCOAPODS: 1.12.1 diff --git a/example/flutter_example/ios/Runner.xcodeproj/project.pbxproj b/example/flutter_example/ios/Runner.xcodeproj/project.pbxproj deleted file mode 100644 index dea5d9c8..00000000 --- a/example/flutter_example/ios/Runner.xcodeproj/project.pbxproj +++ /dev/null @@ -1,551 +0,0 @@ -// !$*UTF8*$! -{ - archiveVersion = 1; - classes = { - }; - objectVersion = 54; - objects = { - -/* Begin PBXBuildFile section */ - 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; - 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; - 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.swift */; }; - 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; }; - 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; }; - 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */; }; - B3B787C8E4F6735F15B51E75 /* Pods_Runner.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 70F28E4C2F3FE430A65F5714 /* Pods_Runner.framework */; }; -/* End PBXBuildFile section */ - -/* Begin PBXCopyFilesBuildPhase section */ - 9705A1C41CF9048500538489 /* Embed Frameworks */ = { - isa = PBXCopyFilesBuildPhase; - buildActionMask = 2147483647; - dstPath = ""; - dstSubfolderSpec = 10; - files = ( - ); - name = "Embed Frameworks"; - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXCopyFilesBuildPhase section */ - -/* Begin PBXFileReference section */ - 0A55A3A1AE84F7AE62A4082A /* Pods-Runner.profile.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.profile.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.profile.xcconfig"; sourceTree = ""; }; - 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = ""; }; - 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = ""; }; - 197E849D27DBB8C5447CF678 /* Pods-Runner.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.release.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"; sourceTree = ""; }; - 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; - 70F28E4C2F3FE430A65F5714 /* Pods_Runner.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Runner.framework; sourceTree = BUILT_PRODUCTS_DIR; }; - 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Runner-Bridging-Header.h"; sourceTree = ""; }; - 74858FAE1ED2DC5600515810 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; - 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; - 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Debug.xcconfig; path = Flutter/Debug.xcconfig; sourceTree = ""; }; - 9740EEB31CF90195004384FC /* Generated.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Generated.xcconfig; path = Flutter/Generated.xcconfig; sourceTree = ""; }; - 97C146EE1CF9000F007C117D /* Runner.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Runner.app; sourceTree = BUILT_PRODUCTS_DIR; }; - 97C146FB1CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = ""; }; - 97C146FD1CF9000F007C117D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = ""; }; - 97C147001CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = ""; }; - 97C147021CF9000F007C117D /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; - B4A5B606D24B9C009FA3C489 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = ""; }; -/* End PBXFileReference section */ - -/* Begin PBXFrameworksBuildPhase section */ - 97C146EB1CF9000F007C117D /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - B3B787C8E4F6735F15B51E75 /* Pods_Runner.framework in Frameworks */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXFrameworksBuildPhase section */ - -/* Begin PBXGroup section */ - 734CA04E4DFC95E130EEE841 /* Pods */ = { - isa = PBXGroup; - children = ( - B4A5B606D24B9C009FA3C489 /* Pods-Runner.debug.xcconfig */, - 197E849D27DBB8C5447CF678 /* Pods-Runner.release.xcconfig */, - 0A55A3A1AE84F7AE62A4082A /* Pods-Runner.profile.xcconfig */, - ); - name = Pods; - path = Pods; - sourceTree = ""; - }; - 9740EEB11CF90186004384FC /* Flutter */ = { - isa = PBXGroup; - children = ( - 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, - 9740EEB21CF90195004384FC /* Debug.xcconfig */, - 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, - 9740EEB31CF90195004384FC /* Generated.xcconfig */, - ); - name = Flutter; - sourceTree = ""; - }; - 97C146E51CF9000F007C117D = { - isa = PBXGroup; - children = ( - 9740EEB11CF90186004384FC /* Flutter */, - 97C146F01CF9000F007C117D /* Runner */, - 97C146EF1CF9000F007C117D /* Products */, - 734CA04E4DFC95E130EEE841 /* Pods */, - ABEF532FACE1FCAD9C6B9799 /* Frameworks */, - ); - sourceTree = ""; - }; - 97C146EF1CF9000F007C117D /* Products */ = { - isa = PBXGroup; - children = ( - 97C146EE1CF9000F007C117D /* Runner.app */, - ); - name = Products; - sourceTree = ""; - }; - 97C146F01CF9000F007C117D /* Runner */ = { - isa = PBXGroup; - children = ( - 97C146FA1CF9000F007C117D /* Main.storyboard */, - 97C146FD1CF9000F007C117D /* Assets.xcassets */, - 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */, - 97C147021CF9000F007C117D /* Info.plist */, - 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */, - 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */, - 74858FAE1ED2DC5600515810 /* AppDelegate.swift */, - 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */, - ); - path = Runner; - sourceTree = ""; - }; - ABEF532FACE1FCAD9C6B9799 /* Frameworks */ = { - isa = PBXGroup; - children = ( - 70F28E4C2F3FE430A65F5714 /* Pods_Runner.framework */, - ); - name = Frameworks; - sourceTree = ""; - }; -/* End PBXGroup section */ - -/* Begin PBXNativeTarget section */ - 97C146ED1CF9000F007C117D /* Runner */ = { - isa = PBXNativeTarget; - buildConfigurationList = 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */; - buildPhases = ( - 4CC1D0350B304DF6F2C8E620 /* [CP] Check Pods Manifest.lock */, - 9740EEB61CF901F6004384FC /* Run Script */, - 97C146EA1CF9000F007C117D /* Sources */, - 97C146EB1CF9000F007C117D /* Frameworks */, - 97C146EC1CF9000F007C117D /* Resources */, - 9705A1C41CF9048500538489 /* Embed Frameworks */, - 3B06AD1E1E4923F5004D2608 /* Thin Binary */, - 247D713CE80C6D3F470751FC /* [CP] Embed Pods Frameworks */, - ); - buildRules = ( - ); - dependencies = ( - ); - name = Runner; - productName = Runner; - productReference = 97C146EE1CF9000F007C117D /* Runner.app */; - productType = "com.apple.product-type.application"; - }; -/* End PBXNativeTarget section */ - -/* Begin PBXProject section */ - 97C146E61CF9000F007C117D /* Project object */ = { - isa = PBXProject; - attributes = { - LastUpgradeCheck = 1430; - ORGANIZATIONNAME = ""; - TargetAttributes = { - 97C146ED1CF9000F007C117D = { - CreatedOnToolsVersion = 7.3.1; - LastSwiftMigration = 1100; - }; - }; - }; - buildConfigurationList = 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */; - compatibilityVersion = "Xcode 9.3"; - developmentRegion = en; - hasScannedForEncodings = 0; - knownRegions = ( - en, - Base, - ); - mainGroup = 97C146E51CF9000F007C117D; - productRefGroup = 97C146EF1CF9000F007C117D /* Products */; - projectDirPath = ""; - projectRoot = ""; - targets = ( - 97C146ED1CF9000F007C117D /* Runner */, - ); - }; -/* End PBXProject section */ - -/* Begin PBXResourcesBuildPhase section */ - 97C146EC1CF9000F007C117D /* Resources */ = { - isa = PBXResourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */, - 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */, - 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */, - 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXResourcesBuildPhase section */ - -/* Begin PBXShellScriptBuildPhase section */ - 247D713CE80C6D3F470751FC /* [CP] Embed Pods Frameworks */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - "${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks-${CONFIGURATION}-input-files.xcfilelist", - ); - name = "[CP] Embed Pods Frameworks"; - outputFileListPaths = ( - "${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks-${CONFIGURATION}-output-files.xcfilelist", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks.sh\"\n"; - showEnvVarsInLog = 0; - }; - 3B06AD1E1E4923F5004D2608 /* Thin Binary */ = { - isa = PBXShellScriptBuildPhase; - alwaysOutOfDate = 1; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}", - ); - name = "Thin Binary"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" embed_and_thin"; - }; - 4CC1D0350B304DF6F2C8E620 /* [CP] Check Pods Manifest.lock */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - "${PODS_PODFILE_DIR_PATH}/Podfile.lock", - "${PODS_ROOT}/Manifest.lock", - ); - name = "[CP] Check Pods Manifest.lock"; - outputFileListPaths = ( - ); - outputPaths = ( - "$(DERIVED_FILE_DIR)/Pods-Runner-checkManifestLockResult.txt", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; - showEnvVarsInLog = 0; - }; - 9740EEB61CF901F6004384FC /* Run Script */ = { - isa = PBXShellScriptBuildPhase; - alwaysOutOfDate = 1; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - ); - name = "Run Script"; - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" build"; - }; -/* End PBXShellScriptBuildPhase section */ - -/* Begin PBXSourcesBuildPhase section */ - 97C146EA1CF9000F007C117D /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */, - 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXSourcesBuildPhase section */ - -/* Begin PBXVariantGroup section */ - 97C146FA1CF9000F007C117D /* Main.storyboard */ = { - isa = PBXVariantGroup; - children = ( - 97C146FB1CF9000F007C117D /* Base */, - ); - name = Main.storyboard; - sourceTree = ""; - }; - 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */ = { - isa = PBXVariantGroup; - children = ( - 97C147001CF9000F007C117D /* Base */, - ); - name = LaunchScreen.storyboard; - sourceTree = ""; - }; -/* End PBXVariantGroup section */ - -/* Begin XCBuildConfiguration section */ - 249021D3217E4FDB00AE95B9 /* Profile */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - ENABLE_NS_ASSERTIONS = NO; - ENABLE_STRICT_OBJC_MSGSEND = YES; - GCC_C_LANGUAGE_STANDARD = gnu99; - GCC_NO_COMMON_BLOCKS = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 11.0; - MTL_ENABLE_DEBUG_INFO = NO; - SDKROOT = iphoneos; - SUPPORTED_PLATFORMS = iphoneos; - TARGETED_DEVICE_FAMILY = "1,2"; - VALIDATE_PRODUCT = YES; - }; - name = Profile; - }; - 249021D4217E4FDB00AE95B9 /* Profile */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; - buildSettings = { - ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; - CLANG_ENABLE_MODULES = YES; - CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; - ENABLE_BITCODE = NO; - INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - ); - PRODUCT_BUNDLE_IDENTIFIER = com.fluttercompletereference.equationsSolver; - PRODUCT_NAME = "$(TARGET_NAME)"; - SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; - SWIFT_VERSION = 5.0; - VERSIONING_SYSTEM = "apple-generic"; - }; - name = Profile; - }; - 97C147031CF9000F007C117D /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = dwarf; - ENABLE_STRICT_OBJC_MSGSEND = YES; - ENABLE_TESTABILITY = YES; - GCC_C_LANGUAGE_STANDARD = gnu99; - GCC_DYNAMIC_NO_PIC = NO; - GCC_NO_COMMON_BLOCKS = YES; - GCC_OPTIMIZATION_LEVEL = 0; - GCC_PREPROCESSOR_DEFINITIONS = ( - "DEBUG=1", - "$(inherited)", - ); - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 11.0; - MTL_ENABLE_DEBUG_INFO = YES; - ONLY_ACTIVE_ARCH = YES; - SDKROOT = iphoneos; - TARGETED_DEVICE_FAMILY = "1,2"; - }; - name = Debug; - }; - 97C147041CF9000F007C117D /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_COMMA = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_STRICT_PROTOTYPES = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CLANG_WARN_UNREACHABLE_CODE = YES; - CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; - "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - ENABLE_NS_ASSERTIONS = NO; - ENABLE_STRICT_OBJC_MSGSEND = YES; - GCC_C_LANGUAGE_STANDARD = gnu99; - GCC_NO_COMMON_BLOCKS = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNDECLARED_SELECTOR = YES; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 11.0; - MTL_ENABLE_DEBUG_INFO = NO; - SDKROOT = iphoneos; - SUPPORTED_PLATFORMS = iphoneos; - SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule"; - TARGETED_DEVICE_FAMILY = "1,2"; - VALIDATE_PRODUCT = YES; - }; - name = Release; - }; - 97C147061CF9000F007C117D /* Debug */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; - buildSettings = { - ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; - CLANG_ENABLE_MODULES = YES; - CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; - ENABLE_BITCODE = NO; - INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - ); - PRODUCT_BUNDLE_IDENTIFIER = com.fluttercompletereference.equationsSolver; - PRODUCT_NAME = "$(TARGET_NAME)"; - SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - SWIFT_VERSION = 5.0; - VERSIONING_SYSTEM = "apple-generic"; - }; - name = Debug; - }; - 97C147071CF9000F007C117D /* Release */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; - buildSettings = { - ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; - CLANG_ENABLE_MODULES = YES; - CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; - ENABLE_BITCODE = NO; - INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/Frameworks", - ); - PRODUCT_BUNDLE_IDENTIFIER = com.fluttercompletereference.equationsSolver; - PRODUCT_NAME = "$(TARGET_NAME)"; - SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; - SWIFT_VERSION = 5.0; - VERSIONING_SYSTEM = "apple-generic"; - }; - name = Release; - }; -/* End XCBuildConfiguration section */ - -/* Begin XCConfigurationList section */ - 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 97C147031CF9000F007C117D /* Debug */, - 97C147041CF9000F007C117D /* Release */, - 249021D3217E4FDB00AE95B9 /* Profile */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 97C147061CF9000F007C117D /* Debug */, - 97C147071CF9000F007C117D /* Release */, - 249021D4217E4FDB00AE95B9 /* Profile */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; -/* End XCConfigurationList section */ - }; - rootObject = 97C146E61CF9000F007C117D /* Project object */; -} diff --git a/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 919434a6..00000000 --- a/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist deleted file mode 100644 index 18d98100..00000000 --- a/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +++ /dev/null @@ -1,8 +0,0 @@ - - - - - IDEDidComputeMac32BitWarning - - - diff --git a/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings deleted file mode 100644 index f9b0d7c5..00000000 --- a/example/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings +++ /dev/null @@ -1,8 +0,0 @@ - - - - - PreviewsEnabled - - - diff --git a/example/flutter_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/flutter_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme deleted file mode 100644 index b52b2e69..00000000 --- a/example/flutter_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/example/flutter_example/ios/Runner.xcworkspace/contents.xcworkspacedata b/example/flutter_example/ios/Runner.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 21a3cc14..00000000 --- a/example/flutter_example/ios/Runner.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/example/flutter_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/flutter_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist deleted file mode 100644 index 18d98100..00000000 --- a/example/flutter_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +++ /dev/null @@ -1,8 +0,0 @@ - - - - - IDEDidComputeMac32BitWarning - - - diff --git a/example/flutter_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/example/flutter_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings deleted file mode 100644 index f9b0d7c5..00000000 --- a/example/flutter_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings +++ /dev/null @@ -1,8 +0,0 @@ - - - - - PreviewsEnabled - - - diff --git a/example/flutter_example/ios/Runner/AppDelegate.swift b/example/flutter_example/ios/Runner/AppDelegate.swift deleted file mode 100644 index 70693e4a..00000000 --- a/example/flutter_example/ios/Runner/AppDelegate.swift +++ /dev/null @@ -1,13 +0,0 @@ -import UIKit -import Flutter - -@UIApplicationMain -@objc class AppDelegate: FlutterAppDelegate { - override func application( - _ application: UIApplication, - didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? - ) -> Bool { - GeneratedPluginRegistrant.register(with: self) - return super.application(application, didFinishLaunchingWithOptions: launchOptions) - } -} diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json deleted file mode 100644 index 1950fd80..00000000 --- a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "images" : [ - { - "size" : "20x20", - "idiom" : "iphone", - "filename" : "Icon-App-20x20@2x.png", - "scale" : "2x" - }, - { - "size" : "20x20", - "idiom" : "iphone", - "filename" : "Icon-App-20x20@3x.png", - "scale" : "3x" - }, - { - "size" : "29x29", - "idiom" : "iphone", - "filename" : "Icon-App-29x29@1x.png", - "scale" : "1x" - }, - { - "size" : "29x29", - "idiom" : "iphone", - "filename" : "Icon-App-29x29@2x.png", - "scale" : "2x" - }, - { - "size" : "29x29", - "idiom" : "iphone", - "filename" : "Icon-App-29x29@3x.png", - "scale" : "3x" - }, - { - "size" : "40x40", - "idiom" : "iphone", - "filename" : "Icon-App-40x40@2x.png", - "scale" : "2x" - }, - { - "size" : "40x40", - "idiom" : "iphone", - "filename" : "Icon-App-40x40@3x.png", - "scale" : "3x" - }, - { - "size" : "60x60", - "idiom" : "iphone", - "filename" : "Icon-App-60x60@2x.png", - "scale" : "2x" - }, - { - "size" : "60x60", - "idiom" : "iphone", - "filename" : "Icon-App-60x60@3x.png", - "scale" : "3x" - }, - { - "size" : "20x20", - "idiom" : "ipad", - "filename" : "Icon-App-20x20@1x.png", - "scale" : "1x" - }, - { - "size" : "20x20", - "idiom" : "ipad", - "filename" : "Icon-App-20x20@2x.png", - "scale" : "2x" - }, - { - "size" : "29x29", - "idiom" : "ipad", - "filename" : "Icon-App-29x29@1x.png", - "scale" : "1x" - }, - { - "size" : "29x29", - "idiom" : "ipad", - "filename" : "Icon-App-29x29@2x.png", - "scale" : "2x" - }, - { - "size" : "40x40", - "idiom" : "ipad", - "filename" : "Icon-App-40x40@1x.png", - "scale" : "1x" - }, - { - "size" : "40x40", - "idiom" : "ipad", - "filename" : "Icon-App-40x40@2x.png", - "scale" : "2x" - }, - { - "size" : "76x76", - "idiom" : "ipad", - "filename" : "Icon-App-76x76@1x.png", - "scale" : "1x" - }, - { - "size" : "76x76", - "idiom" : "ipad", - "filename" : "Icon-App-76x76@2x.png", - "scale" : "2x" - }, - { - "size" : "83.5x83.5", - "idiom" : "ipad", - "filename" : "Icon-App-83.5x83.5@2x.png", - "scale" : "2x" - }, - { - "size" : "1024x1024", - "idiom" : "ios-marketing", - "filename" : "Icon-App-1024x1024@1x.png", - "scale" : "1x" - } - ], - "info" : { - "version" : 1, - "author" : "xcode" - } -} diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png deleted file mode 100644 index e1d6e17d..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png deleted file mode 100644 index 9ee0c0a1..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png deleted file mode 100644 index ed864170..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png deleted file mode 100644 index 34317bab..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png deleted file mode 100644 index c4cf0da9..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png deleted file mode 100644 index 7cd5e4ff..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png deleted file mode 100644 index 4ac85b0c..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png deleted file mode 100644 index 90eec4ca..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png deleted file mode 100644 index 19b8dbf3..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png deleted file mode 100644 index 0aff42d2..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png deleted file mode 100644 index 73800160..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png deleted file mode 100644 index cf21c202..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png deleted file mode 100644 index c680ae00..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png deleted file mode 100644 index e23b5ea6..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png deleted file mode 100644 index e382980a..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json b/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json deleted file mode 100644 index 0bedcf2f..00000000 --- a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "images" : [ - { - "idiom" : "universal", - "filename" : "LaunchImage.png", - "scale" : "1x" - }, - { - "idiom" : "universal", - "filename" : "LaunchImage@2x.png", - "scale" : "2x" - }, - { - "idiom" : "universal", - "filename" : "LaunchImage@3x.png", - "scale" : "3x" - } - ], - "info" : { - "version" : 1, - "author" : "xcode" - } -} diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png b/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png deleted file mode 100644 index ad587c66..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png b/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png deleted file mode 100644 index 500e9ef7..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png b/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png deleted file mode 100644 index c713a45a..00000000 Binary files a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png and /dev/null differ diff --git a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md b/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md deleted file mode 100644 index 65a94b5d..00000000 --- a/example/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Launch Screen Assets - -You can customize the launch screen with your own desired assets by replacing the image files in this directory. - -You can also do it by opening your Flutter project's Xcode project with `open ios/Runner.xcworkspace`, selecting `Runner/Assets.xcassets` in the Project Navigator and dropping in the desired images. \ No newline at end of file diff --git a/example/flutter_example/ios/Runner/Base.lproj/LaunchScreen.storyboard b/example/flutter_example/ios/Runner/Base.lproj/LaunchScreen.storyboard deleted file mode 100644 index f2e259c7..00000000 --- a/example/flutter_example/ios/Runner/Base.lproj/LaunchScreen.storyboard +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/example/flutter_example/ios/Runner/Base.lproj/Main.storyboard b/example/flutter_example/ios/Runner/Base.lproj/Main.storyboard deleted file mode 100644 index f3c28516..00000000 --- a/example/flutter_example/ios/Runner/Base.lproj/Main.storyboard +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/example/flutter_example/ios/Runner/Info.plist b/example/flutter_example/ios/Runner/Info.plist deleted file mode 100644 index 1792d139..00000000 --- a/example/flutter_example/ios/Runner/Info.plist +++ /dev/null @@ -1,49 +0,0 @@ - - - - - CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - equations_solver - CFBundlePackageType - APPL - CFBundleShortVersionString - $(FLUTTER_BUILD_NAME) - CFBundleSignature - ???? - CFBundleVersion - $(FLUTTER_BUILD_NUMBER) - LSRequiresIPhoneOS - - UILaunchStoryboardName - LaunchScreen - UIMainStoryboardFile - Main - UISupportedInterfaceOrientations - - UIInterfaceOrientationPortrait - UIInterfaceOrientationLandscapeLeft - UIInterfaceOrientationLandscapeRight - - UISupportedInterfaceOrientations~ipad - - UIInterfaceOrientationPortrait - UIInterfaceOrientationPortraitUpsideDown - UIInterfaceOrientationLandscapeLeft - UIInterfaceOrientationLandscapeRight - - UIViewControllerBasedStatusBarAppearance - - CADisableMinimumFrameDurationOnPhone - - UIApplicationSupportsIndirectInputEvents - - - diff --git a/example/flutter_example/ios/Runner/Runner-Bridging-Header.h b/example/flutter_example/ios/Runner/Runner-Bridging-Header.h deleted file mode 100644 index 308a2a56..00000000 --- a/example/flutter_example/ios/Runner/Runner-Bridging-Header.h +++ /dev/null @@ -1 +0,0 @@ -#import "GeneratedPluginRegistrant.h" diff --git a/example/flutter_example/ios/RunnerTests/RunnerTests.swift b/example/flutter_example/ios/RunnerTests/RunnerTests.swift deleted file mode 100644 index 4d206ded..00000000 --- a/example/flutter_example/ios/RunnerTests/RunnerTests.swift +++ /dev/null @@ -1,12 +0,0 @@ -import Flutter -import UIKit -import XCTest - -class RunnerTests: XCTestCase { - - func testExample() { - // If you add code to the Runner application, consider adding tests here. - // See https://developer.apple.com/documentation/xctest for more information about using XCTest. - } - -} diff --git a/example/flutter_example/l10n.yaml b/example/flutter_example/l10n.yaml deleted file mode 100644 index 95b8811f..00000000 --- a/example/flutter_example/l10n.yaml +++ /dev/null @@ -1,4 +0,0 @@ -arb-dir: lib/localization/l10n -template-arb-file: app_en.arb -output-localization-file: app_localizations.dart -nullable-getter: false diff --git a/example/flutter_example/lib/localization/l10n/app_en.arb b/example/flutter_example/lib/localization/l10n/app_en.arb deleted file mode 100644 index 4d12bbb8..00000000 --- a/example/flutter_example/lib/localization/l10n/app_en.arb +++ /dev/null @@ -1,89 +0,0 @@ -{ - "appTitle": "Equations solver", - "polynomials": "Polynomials", - "functions": "Functions", - "systems": "Systems", - "integrals": "Integrals", - "interpolation": "Interpolation", - "other": "Other", - "firstDegree": "Linear", - "secondDegree": "Quadratic", - "thirdDegree": "Cubic", - "fourthDegree": "Quartic", - "anyDegree": "Any", - "solution": "Solution", - "solutions": "Solutions", - "chart": "Chart", - "solve": "Solve", - "clean": "Clean", - "cancel": "Cancel", - "no_solutions": "No solutions to display.", - "no_chart": "No chart to plot.", - "no_discriminant": "No discriminant.", - "polynomial_error": "One or more coefficients aren't valid.", - "wrong_input": "Invalid input", - "tap_more": "Tap to see more details", - "discriminant": "Discriminant", - "fraction": "Fraction", - "single_point": "Single point", - "bracketing": "Bracketing", - "precision": "Precision", - "convergence": "Convergence", - "efficiency": "Efficiency", - "not_computed": "Not computed", - "nonlinear_error": "Wrong equation or parameters format.", - "row_reduction": "Row reduction", - "factorization": "Factorization", - "iterative": "Iterative", - "size": "Size", - "matrix_size1": "1x1 matrix", - "matrix_size2": "2x2 matrix", - "matrix_size3": "3x3 matrix", - "matrix_size4": "4x4 matrix", - "matrix_description": "The matrix with the equations coefficients", - "vector_description": "The vector with the known values", - "sor_w": "Relaxation factor", - "jacobi_initial": "Initial guesses vector", - "singular_matrix_error": "The system cannot be solved because the matrix is singular!", - "invalid_values": "One or more values aren't correct.", - "matrices": "Matrices", - "linear": "Linear", - "analyze": "Analyze", - "results": "Results", - "wait_a_moment": "Wait a moment...", - "rank": "Rank", - "trace": "Trace", - "transpose": "Transpose", - "determinant": "Determinant", - "inverse": "Inverse", - "cofactor": "Cofactor", - "characteristicPolynomial": "Characteristic polynomial", - "eigenvalues": "Eigenvalues", - "properties": "Properties", - "complex_numbers": "Complex numbers", - "phase": "Phase", - "abs": "Modulus / absolute value", - "conjugate": "Conjugate", - "reciprocal": "Reciprocal", - "sqrt": "Square root", - "length": "Length", - "angle_deg": "Angle (degree)", - "angle_rad": "Angle (radians)", - "polar_coordinates": "Polar coordinates", - "yes": "Yes", - "no": "No", - "diagonal": "Diagonal", - "symmetric": "Symmetric", - "identity": "Identity", - "url_error": "This page doesn't exists!", - "version": "Version", - "input_allowed_values": "Allowed values", - "input_allowed_numbers": " - Decimal and integer numbers.", - "input_allowed_fractions": " - Fractions.", - "input_allowed_constants": " - Constants: pi (3.1415), e (2.7182) and sqrt2 (1.4142).", - "input_allowed_functions": "The equation f(x) allows these functions:", - "input_allowed_multiplication_sign": "The multiplication requires the sign. For example:", - "more_digits": "No approximation: ", - "nonlinear_fail_converge": "The method didn't converge to a solution.", - "fraction_warning": "The fraction is based on the decimal approximation and therefore does not correctly represent irrational values." -} \ No newline at end of file diff --git a/example/flutter_example/lib/localization/l10n/app_fr.arb b/example/flutter_example/lib/localization/l10n/app_fr.arb deleted file mode 100644 index 3e3dacc7..00000000 --- a/example/flutter_example/lib/localization/l10n/app_fr.arb +++ /dev/null @@ -1,89 +0,0 @@ -{ - "appTitle": "Équations solver", - "polynomials": "Polynômes", - "functions": "Fonctions", - "systems": "Systèmes", - "integrals": "Intégrales", - "interpolation": "Interpolation", - "other": "Autre", - "firstDegree": "Linéaire", - "secondDegree": "Quadratique", - "thirdDegree": "Cubique", - "fourthDegree": "Quartic", - "anyDegree": "Tous", - "solution": "Solution", - "solutions": "Solutions", - "chart": "Graphique", - "solve": "Résoudre", - "clean": "Nettoyer", - "cancel": "Annuler", - "no_solutions": "Aucune solution à afficher", - "no_chart": "Aucune graphique à afficher", - "no_discriminant": "Aucun discriminant.", - "polynomial_error": "Un ou plusieurs coefficients ne sont pas valides.", - "wrong_input": "Entrée invalide", - "tap_more": "Appuyez pour voir plus de détails ", - "discriminant": "Discriminant", - "fraction": "Fraction", - "single_point": "Point fixe", - "bracketing": "Intervalle", - "precision": "Précision", - "convergence": "Convergence", - "efficiency": "Efficience", - "not_computed": "Non calculé ", - "nonlinear_error": "Format d'équation ou de paramètres incorrect.", - "row_reduction": "Élimination", - "factorization": "Factorisation", - "iterative": "Itératif", - "size": "Taille", - "matrix_size1": "1x1 matrice", - "matrix_size2": "2x2 matrice", - "matrix_size3": "3x3 matrice", - "matrix_size4": "4x4 matrice", - "matrix_description": "La matrice avec les coefficients des équations", - "vector_description": "Le vecteur avec les valeurs connues", - "sor_w": "Facteur de relaxation", - "jacobi_initial": "Vecteur de valeurs initiales", - "singular_matrix_error": "Le système ne peut pas être résolu car la matrice est singulière", - "invalid_values": "Une ou plusieurs valeurs ne sont pas correctes.", - "matrices": "Matrices", - "linear": "Affine", - "analyze": "Analyser", - "results": "Résultats", - "wait_a_moment": "Attendez un moment...", - "rank": "Rang", - "trace": "Trace", - "transpose": "Transposée", - "determinant": "Déterminant", - "inverse": "Inverse", - "cofactor": "Comatrice", - "characteristicPolynomial": "Polynôme caractéristique", - "eigenvalues": "Valeurs propre", - "properties": "Propriétés", - "complex_numbers": "Nombres complexes", - "phase": "Phase", - "abs": "Module / valeur absolue", - "conjugate": "Conjugué", - "reciprocal": "Inverse", - "sqrt": "Racine carrée", - "length": "Rayon", - "angle_deg": "Angle (degrés)", - "angle_rad": "Angle (radians)", - "polar_coordinates": "Coordonnées polaires", - "yes": "Oui", - "no": "Non", - "diagonal": "Diagonale", - "symmetric": "Symétrique", - "identity": "Identité", - "url_error": "Cette page n'existe pas!", - "version": "Version", - "input_allowed_values": "Valeurs autorisées", - "input_allowed_numbers": " - Nombres décimaux et entiers.", - "input_allowed_fractions": " - Fractions.", - "input_allowed_constants": " - Constantes: pi (3.1415), e (2.7182) et sqrt2 (1.4142)", - "input_allowed_functions": "L'equation f(x) permet à ces fonctions:", - "input_allowed_multiplication_sign": "La multiplication nécessite le signe. Par exemple:", - "more_digits": "Sans approximation: ", - "nonlinear_fail_converge": "La méthode n'a pas convergé vers une solution.", - "fraction_warning": "La fraction est basée sur l'approximation décimale et donc elle ne représente pas correctement les valeurs irrationnelles." -} \ No newline at end of file diff --git a/example/flutter_example/lib/localization/l10n/app_it.arb b/example/flutter_example/lib/localization/l10n/app_it.arb deleted file mode 100644 index a836ddb8..00000000 --- a/example/flutter_example/lib/localization/l10n/app_it.arb +++ /dev/null @@ -1,89 +0,0 @@ -{ - "appTitle": "Risolutore di equazioni", - "polynomials": "Polinomi", - "functions": "Funzioni", - "systems": "Sistemi", - "integrals": "Integrali", - "interpolation": "Interpolazione", - "other": "Altro", - "firstDegree": "Lineare", - "secondDegree": "Quadratica", - "thirdDegree": "Cubica", - "fourthDegree": "Quartica", - "anyDegree": "Qualsiasi", - "solution": "Soluzione", - "solutions": "Soluzioni", - "chart": "Grafico", - "solve": "Risolvi", - "clean": "Pulisci", - "cancel": "Annulla", - "no_solutions": "Nessuna soluzione da mostrare.", - "no_chart": "Nessun grafico da disegnare.", - "no_discriminant": "Nessun discriminante.", - "polynomial_error": "Uno o più coefficienti non sono validi.", - "wrong_input": "Input non valido", - "tap_more": "Premi per vedere più dettagli", - "discriminant": "Discriminante", - "fraction": "Frazione", - "single_point": "Punto fisso", - "bracketing": "Intervalli", - "precision": "Precisione", - "convergence": "Convergenza", - "efficiency": "Efficienza", - "not_computed": "Non calcolata", - "nonlinear_error": "Il formato dell'equazione o dei parametri non è valido.", - "row_reduction": "Elim. Gauss", - "factorization": "Decomposizione", - "iterative": "Iterativo", - "size": "Dimensione", - "matrix_size1": "matrice 1x1", - "matrix_size2": "matrice 2x2", - "matrix_size3": "matrice 3x3", - "matrix_size4": "matrice 4x4", - "matrix_description": "La matrice dei coefficienti delle equazioni", - "vector_description": "Il vettore con termini noti", - "sor_w": "Fattore di rilassamento", - "jacobi_initial": "Vettore iniziale", - "singular_matrix_error": "Il sistema non può essere risolto perchè la matrice è singolare!", - "invalid_values": "Uno o più valori non sono corretti.", - "matrices": "Matrici", - "linear": "Lineare", - "analyze": "Analizza", - "results": "Risultati", - "wait_a_moment": "Aspetta un momento...", - "rank": "Rango", - "trace": "Traccia", - "transpose": "Trasposta", - "determinant": "Determinant3", - "inverse": "Inversa", - "cofactor": "Cofattori", - "characteristicPolynomial": "Polinomio caratteristico", - "eigenvalues": "Autovalori", - "properties": "Proprietà", - "complex_numbers": "Numeri complessi", - "phase": "Fase", - "abs": "Modulo / valore assoluto", - "conjugate": "Coniugato", - "reciprocal": "Reciproco", - "sqrt": "Radice quadrata", - "length": "Lunghezza", - "angle_deg": "Angolo (gradi)", - "angle_rad": "Angolo (radianti)", - "polar_coordinates": "Coordinate polari", - "yes": "Si", - "no": "No", - "diagonal": "Diagonale", - "symmetric": "Simmetrica", - "identity": "Identità", - "url_error": "Questa pagina non esiste!", - "version": "Versione", - "input_allowed_values": "Valori ammessi", - "input_allowed_numbers": " - Numeri interi e decimali.", - "input_allowed_fractions": " - Frazioni.", - "input_allowed_constants": " - Costanti: pi (3.1415), e (2.7182) and sqrt2 (1.4142).", - "input_allowed_functions": "L'equazione f(x) permette queste funzioni:", - "input_allowed_multiplication_sign": "La moltiplicazione richiede il segno. Per esempio:", - "more_digits": "Senza approssimazione: ", - "nonlinear_fail_converge": "Il metodo non ha converso ad una soluzione.", - "fraction_warning": "La frazione si basa sull'approssimazione decimale e quindi non rappresenta correttamente i valori irrazionali." -} \ No newline at end of file diff --git a/example/flutter_example/lib/localization/localization.dart b/example/flutter_example/lib/localization/localization.dart deleted file mode 100644 index a04874a4..00000000 --- a/example/flutter_example/lib/localization/localization.dart +++ /dev/null @@ -1,23 +0,0 @@ -import 'package:flutter/material.dart'; -import 'package:flutter_gen/gen_l10n/app_localizations.dart'; - -// Exporting the 'AppLocalizations' type so that we can only reference this file -// to access the localization API. -export 'package:flutter_gen/gen_l10n/app_localizations.dart'; - -/// Extension method on [BuildContext] which reduces the boilerplate code needed -/// to localize the text in the app. Rather than writing... -/// -/// ```dart -/// final text = AppLocalizations.of(context).appTitle; -/// ``` -/// -/// ... you should use this shorter syntax: -/// -/// ```dart -/// final text = context.l10n.appTitle; -/// ``` -extension LocalizationContext on BuildContext { - /// Returns the [AppLocalizations] instance with localized strings. - AppLocalizations get l10n => AppLocalizations.of(this); -} diff --git a/example/flutter_example/lib/main.dart b/example/flutter_example/lib/main.dart deleted file mode 100644 index ee547ac3..00000000 --- a/example/flutter_example/lib/main.dart +++ /dev/null @@ -1,81 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes.dart'; -import 'package:flutter/material.dart'; - -/// The application's main entrypoint. -void main() { - runApp( - const EquationsApp(), - ); -} - -/// The root widget of the application. -class EquationsApp extends StatelessWidget { - static final _appRouter = generateRouter(); - - /// Creates an [EquationsApp] instance. - const EquationsApp({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return MaterialApp.router( - // Route management - routerConfig: _appRouter, - - // Localized app title - onGenerateTitle: (context) => context.l10n.appTitle, - - // Localization setup - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - - // Hides scroll bars on mobile but always shows them on desktop - scrollBehavior: const _CustomScrollBehavior(), - - // Hiding the debug banner - debugShowCheckedModeBanner: false, - ); - } -} - -/// This custom implementation of [MaterialScrollBehavior] makes the scroll bar -/// **always** visible on desktop platforms. -/// -/// On mobile devices, the scroll bar never appears. -class _CustomScrollBehavior extends MaterialScrollBehavior { - /// Creates a [_CustomScrollBehavior] configuration. - const _CustomScrollBehavior(); - - @override - Widget buildScrollbar( - BuildContext context, - Widget child, - ScrollableDetails details, - ) { - // No scroll bars in the horizontal axis - if (axisDirectionToAxis(details.direction) == Axis.horizontal) { - return child; - } - - // Show scroll bars when scrolling vertically but only on desktop. This part - // can be ignored by code coverage because it's tested in integration tests. - switch (Theme.of(context).platform) { - // coverage:ignore-start - case TargetPlatform.linux: - case TargetPlatform.macOS: - case TargetPlatform.windows: - return Scrollbar( - controller: details.controller, - thumbVisibility: true, - child: child, - ); - case TargetPlatform.android: - case TargetPlatform.fuchsia: - case TargetPlatform.iOS: - return child; - // coverage:ignore-end - } - } -} diff --git a/example/flutter_example/lib/routes.dart b/example/flutter_example/lib/routes.dart deleted file mode 100644 index f296bc23..00000000 --- a/example/flutter_example/lib/routes.dart +++ /dev/null @@ -1,79 +0,0 @@ -import 'package:equations_solver/routes/error_page.dart'; -import 'package:equations_solver/routes/home_page.dart'; -import 'package:equations_solver/routes/integral_page.dart'; -import 'package:equations_solver/routes/nonlinear_page.dart'; -import 'package:equations_solver/routes/other_page.dart'; -import 'package:equations_solver/routes/polynomial_page.dart'; -import 'package:equations_solver/routes/system_page.dart'; -import 'package:flutter/widgets.dart'; -import 'package:go_router/go_router.dart'; - -/// Route name for the home page of the app. -const homePagePath = '/'; - -/// Route name for the integrals page. -const integralPagePath = '/integrals'; - -/// Route name for the nonlinear equations solver page. -const nonlinearPagePath = '/nonlinears'; - -/// Route name for the polynomial equations solver page. -const polynomialPagePath = '/polynomials'; - -/// Route name for the systems page. -const systemPagePath = '/systems'; - -/// Route name for the page containing various utilities. -const otherPagePath = '/other'; - -/// Builds a [FadeTransition] for a [GoRoute] route. -CustomTransitionPage _builder( - BuildContext _, - GoRouterState state, - Widget childPage, -) { - return CustomTransitionPage( - key: state.pageKey, - transitionsBuilder: (context, animation, _, child) { - return FadeTransition( - opacity: animation, - child: child, - ); - }, - child: childPage, - ); -} - -/// Generates the [GoRouter] instance that manages the app navigation. -GoRouter generateRouter({String initialRoute = homePagePath}) { - return GoRouter( - initialLocation: initialRoute, - routes: [ - GoRoute( - path: homePagePath, - pageBuilder: (_, state) => _builder(_, state, const HomePage()), - ), - GoRoute( - path: integralPagePath, - pageBuilder: (_, state) => _builder(_, state, const IntegralPage()), - ), - GoRoute( - path: nonlinearPagePath, - pageBuilder: (_, state) => _builder(_, state, const NonlinearPage()), - ), - GoRoute( - path: polynomialPagePath, - pageBuilder: (_, state) => _builder(_, state, const PolynomialPage()), - ), - GoRoute( - path: systemPagePath, - pageBuilder: (_, state) => _builder(_, state, const SystemPage()), - ), - GoRoute( - path: otherPagePath, - pageBuilder: (_, state) => _builder(_, state, const OtherPage()), - ), - ], - errorBuilder: (_, __) => const ErrorPage(), - ); -} diff --git a/example/flutter_example/lib/routes/error_page.dart b/example/flutter_example/lib/routes/error_page.dart deleted file mode 100644 index aab55842..00000000 --- a/example/flutter_example/lib/routes/error_page.dart +++ /dev/null @@ -1,62 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The error page is shown when the user tries to open a route with a wrong -/// deep link. This generally happens when the app is running on the web and -/// the user enters a wrong URL. -class ErrorPage extends StatelessWidget { - /// Creates a [ErrorPage] widget. - const ErrorPage({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return const EquationScaffold( - body: CustomScrollView( - slivers: [ - // We're using 'SliverFillRemaining' because it makes the contents - // fill the entire viewport and, on desktop or web, the scroll bar - // appears on the right edge of the window (while the contents ALWAYS - // stay at the center). - SliverFillRemaining( - hasScrollBody: false, - child: Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // The error image at the top - UrlError( - size: 85, - ), - - // The error message - _ErrorText(), - ], - ), - ), - ), - ], - ), - ); - } -} - -class _ErrorText extends StatelessWidget { - const _ErrorText(); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.only( - top: 25, - ), - child: Text( - context.l10n.url_error, - style: const TextStyle(fontSize: 16), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/home_page.dart b/example/flutter_example/lib/routes/home_page.dart deleted file mode 100644 index c0a78002..00000000 --- a/example/flutter_example/lib/routes/home_page.dart +++ /dev/null @@ -1,43 +0,0 @@ -import 'package:equations_solver/routes/home_page/home_contents.dart'; -import 'package:equations_solver/routes/utils/app_logo.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:flutter/material.dart'; - -/// The home page shows a series of cards that represents the available solvers -/// in the application. -class HomePage extends StatelessWidget { - /// Creates a [HomePage] widget. - const HomePage({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return const EquationScaffold( - body: CustomScrollView( - slivers: [ - // We're using 'SliverFillRemaining' because it makes the contents - // fill the entire viewport and, on desktop or web, the scroll bar - // appears on the right edge of the window (while the contents ALWAYS - // stay at the center). - SliverFillRemaining( - hasScrollBody: false, - child: Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // The logo at the top - AppLogo(), - - // The body of the home, which is a series of cards - // redirecting the users to the various solvers - HomeContents(), - ], - ), - ), - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/home_page/card_containers.dart b/example/flutter_example/lib/routes/home_page/card_containers.dart deleted file mode 100644 index 33e9b6a6..00000000 --- a/example/flutter_example/lib/routes/home_page/card_containers.dart +++ /dev/null @@ -1,62 +0,0 @@ -import 'package:flutter/material.dart'; - -/// A series of [Card] widgets representing the various of solvers supported by -/// the application. A [CardContainer] widget has an icon on the left and some -/// text on the right. -class CardContainer extends StatelessWidget { - /// The container description. - final String title; - - /// The image on the left. - final Widget image; - - /// This callback is triggered whenever the widget is tapped or clicked. - final VoidCallback onTap; - - /// Creates a [CardContainer] widget. - const CardContainer({ - required this.title, - required this.image, - required this.onTap, - super.key, - }); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.only(bottom: 35), - child: SizedBox( - width: 260, - child: MouseRegion( - cursor: SystemMouseCursors.click, - child: GestureDetector( - onTap: onTap, - child: Card( - elevation: 8, - shadowColor: Colors.blueAccent, - child: Padding( - padding: const EdgeInsets.all(8), - child: Row( - children: [ - Expanded( - child: image, - ), - Expanded( - flex: 2, - child: Text( - title, - style: const TextStyle( - fontSize: 18, - ), - ), - ), - ], - ), - ), - ), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/home_page/home_contents.dart b/example/flutter_example/lib/routes/home_page/home_contents.dart deleted file mode 100644 index 85630b10..00000000 --- a/example/flutter_example/lib/routes/home_page/home_contents.dart +++ /dev/null @@ -1,61 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes.dart'; -import 'package:equations_solver/routes/home_page/card_containers.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; -import 'package:go_router/go_router.dart'; - -/// Contains a series of tiles, represented by a [CardContainer] widget, that -/// route the user to the desired pages. -class HomeContents extends StatelessWidget { - /// Creates a [HomeContents] widget. - const HomeContents({super.key}); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.fromLTRB(25, 50, 25, 20), - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - CardContainer( - key: const Key('PolynomialLogo-Container'), - title: context.l10n.polynomials, - image: const PolynomialLogo(), - onTap: () async => context.push(polynomialPagePath), - ), - CardContainer( - key: const Key('NonlinearLogo-Container'), - title: context.l10n.functions, - image: const NonlinearLogo(), - onTap: () async => context.push(nonlinearPagePath), - ), - CardContainer( - key: const Key('SystemsLogo-Container'), - title: context.l10n.systems, - image: const SystemsLogo(), - onTap: () async => context.push(systemPagePath), - ), - CardContainer( - key: const Key('IntegralsLogo-Container'), - title: context.l10n.integrals, - image: const IntegralLogo(), - onTap: () async => context.push(integralPagePath), - ), - CardContainer( - key: const Key('OtherLogo-Container'), - title: context.l10n.other, - image: const OtherLogo(), - onTap: () async => context.push(otherPagePath), - ), - Center( - child: Padding( - padding: const EdgeInsets.only(top: 10), - child: Text('${context.l10n.version}: 1.0.0'), - ), - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/integral_page.dart b/example/flutter_example/lib/routes/integral_page.dart deleted file mode 100644 index 91774cea..00000000 --- a/example/flutter_example/lib/routes/integral_page.dart +++ /dev/null @@ -1,73 +0,0 @@ -import 'package:equations_solver/routes/integral_page/integral_body.dart'; -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:flutter/material.dart'; - -/// This page contains a series of integral evaluation algorithms. There only -/// is a single page where the user writes the equation and chooses the -/// algorithm to evaluate the integral. -/// -/// The function is drawn on a cartesian plane and the area is highlighted. -class IntegralPage extends StatefulWidget { - /// Creates a [IntegralPage] widget. - const IntegralPage({super.key}); - - @override - State createState() => _IntegralPageState(); -} - -class _IntegralPageState extends State { - /* - * These controllers are exposed to the subtree with [InheritedTextController] - * because the scaffold uses tabs and when swiping, the controllers get - * disposed. - * - * In order to keep the controllers alive (and thus persist the text), we need - * to save them here. - */ - final integralControllers = [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ]; - - @override - void dispose() { - for (final controller in integralControllers) { - controller.dispose(); - } - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return InheritedIntegral( - integralState: IntegralState(), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - IntegralDropdownItems.simpson.name, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedTextControllers( - textControllers: integralControllers, - child: const EquationScaffold( - body: IntegralBody(), - ), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/integral_page/integral_body.dart b/example/flutter_example/lib/routes/integral_page/integral_body.dart deleted file mode 100644 index c6f02770..00000000 --- a/example/flutter_example/lib/routes/integral_page/integral_body.dart +++ /dev/null @@ -1,149 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/integral_page/integral_data_input.dart'; -import 'package:equations_solver/routes/integral_page/integral_results.dart'; -import 'package:equations_solver/routes/integral_page/utils/integral_plot_widget.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; - -/// This widget contains the input for the function (along with the integration -/// bounds). There also is a cartesian plane to draw the function and highlight -/// the enclosed area. -/// -/// This widget is responsive: contents may be laid out on a single column or -/// on two columns according with the available width. -class IntegralBody extends StatelessWidget { - /// Creates an [IntegralBody] widget. - const IntegralBody({super.key}); - - @override - Widget build(BuildContext context) { - return const Stack( - children: [ - // Scrollable contents of the page - Positioned.fill( - child: _ResponsiveBody(), - ), - - // "Go back" button - Positioned( - top: 20, - left: 10, - child: GoBackButton(), - ), - ], - ); - } -} - -/// Determines whether the contents should appear in 1 or 2 columns. -class _ResponsiveBody extends StatelessWidget { - /// Creates a [_ResponsiveBody] widget. - const _ResponsiveBody(); - - @override - Widget build(BuildContext context) { - return LayoutBuilder( - builder: (context, size) { - if (size.maxWidth <= doubleColumnPageBreakpoint) { - // For mobile devices - all in a column - return const _SingleColumnLayout(); - } - - // For wider screens - plot on the right and results on the right - return const _DoubleColumnLayout(); - }, - ); - } -} - -/// Lays the page contents on a single column. -class _SingleColumnLayout extends StatelessWidget { - /// Creates a [_SingleColumnLayout] widget. - const _SingleColumnLayout(); - - @override - Widget build(BuildContext context) { - return SingleChildScrollView( - key: const Key('SingleChildScrollView-mobile-responsive'), - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - PageTitle( - pageTitle: context.l10n.integrals, - pageLogo: const IntegralLogo( - size: 50, - ), - ), - const IntegralDataInput(), - const IntegralResultsWidget(), - const IntegralPlotWidget(), - ], - ), - ); - } -} - -/// Lays the page contents on two columns. -class _DoubleColumnLayout extends StatelessWidget { - /// Creates a [_DoubleColumnLayout] widget. - const _DoubleColumnLayout(); - - @override - Widget build(BuildContext context) { - return const Center( - child: SingleChildScrollView( - key: Key('SingleChildScrollView-desktop-responsive'), - child: Row( - mainAxisAlignment: MainAxisAlignment.spaceAround, - children: [ - // Input and results - Expanded( - child: _DoubleColumnLeftContent(), - ), - - // Plot - Expanded( - child: Padding( - padding: EdgeInsets.symmetric( - horizontal: 15, - ), - child: IntegralPlotWidget(), - ), - ), - ], - ), - ), - ); - } -} - -/// The left column [_ResponsiveBody] when the viewport is large enough. -class _DoubleColumnLeftContent extends StatelessWidget { - /// Creates a [_DoubleColumnLeftContent] widget. - const _DoubleColumnLeftContent(); - - @override - Widget build(BuildContext context) { - return Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - PageTitle( - pageTitle: context.l10n.integrals, - pageLogo: const IntegralLogo( - size: 50, - ), - ), - const IntegralDataInput(), - const IntegralResultsWidget(), - const SizedBox( - height: 40, - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/integral_page/integral_data_input.dart b/example/flutter_example/lib/routes/integral_page/integral_data_input.dart deleted file mode 100644 index 6e39440d..00000000 --- a/example/flutter_example/lib/routes/integral_page/integral_data_input.dart +++ /dev/null @@ -1,191 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/integral_page/integral_body.dart'; -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/equation_input.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; - -/// This widget contains a series of input widgets for [IntegralBody] to parse -/// the equation and the integration bounds. -class IntegralDataInput extends StatefulWidget { - /// Creates an [IntegralDataInput] widget. - const IntegralDataInput({super.key}); - - @override - State createState() => _IntegralDataInputState(); -} - -class _IntegralDataInputState extends State { - /// Form validation key. - final formKey = GlobalKey(); - - /// Manually caching the equation input field. - late final functionInput = EquationInput( - key: const Key('EquationInput-function'), - controller: functionController, - placeholderText: 'f(x)', - ); - - /// Manually caching the inputs. - late final guessesInput = _GuessesInput( - lowerBound: lowerBoundController, - upperBound: upperBoundController, - ); - - /// The [TextEditingController] for the function. - TextEditingController get functionController => context.textControllers.first; - - /// The [TextEditingController] for the lower integration bound. - TextEditingController get lowerBoundController => context.textControllers[1]; - - /// The [TextEditingController] for the upper integration bound. - TextEditingController get upperBoundController => context.textControllers[2]; - - /// Form and chart cleanup. - void cleanInput() { - formKey.currentState?.reset(); - context.integralState.clear(); - context.plotZoomState.reset(); - - for (final controller in context.textControllers) { - controller.clear(); - } - - FocusScope.of(context).unfocus(); - } - - /// Integrates over the given interval. - void solve() { - if (formKey.currentState?.validate() ?? false) { - final dropdown = context.dropdownValue.value; - final integralType = switch (dropdown.toIntegralDropdownItems()) { - IntegralDropdownItems.simpson => IntegralType.simpson, - IntegralDropdownItems.trapezoid => IntegralType.trapezoid, - IntegralDropdownItems.midpoint => IntegralType.midPoint - }; - - context.integralState.solveIntegral( - function: functionController.text, - lowerBound: lowerBoundController.text, - upperBound: upperBoundController.text, - intervals: 32, - integralType: integralType, - ); - } else { - // Error message in case of malformed inputs - ScaffoldMessenger.of(context).showSnackBar( - SnackBar( - content: Text(context.l10n.invalid_values), - duration: const Duration(seconds: 2), - ), - ); - } - } - - @override - Widget build(BuildContext context) { - return Form( - key: formKey, - child: Column( - mainAxisSize: MainAxisSize.min, - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Some space from the top - const SizedBox(height: 40), - - // The equation input - functionInput, - - // The guesses required by the app - guessesInput, - - // Some spacing - const SizedBox(height: 40), - - // Which algorithm has to be used - const IntegralDropdownSelection(), - - // Some spacing - const SizedBox(height: 50), - - // Two buttons needed to "evaluate" and "clear" the integral - Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Evaluating the integral - ElevatedButton( - key: const Key('Integral-button-solve'), - onPressed: solve, - child: Text(context.l10n.solve), - ), - - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 16, - ), - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.equations, - ), - ), - - // Cleaning the inputs - ElevatedButton( - key: const Key('Integral-button-clean'), - onPressed: cleanInput, - child: Text(context.l10n.clean), - ), - ], - ), - ], - ), - ); - } -} - -/// The two [TextFormField] widgets asking for the upper and lower integration -/// bounds. -class _GuessesInput extends StatelessWidget { - /// The [TextEditingController] of the lower integration bound. - final TextEditingController lowerBound; - - /// The [TextEditingController] of the upper integration bound. - final TextEditingController upperBound; - - /// Creates a [_GuessesInput] instance. - const _GuessesInput({ - required this.lowerBound, - required this.upperBound, - }); - - @override - Widget build(BuildContext context) { - return Wrap( - alignment: WrapAlignment.center, - spacing: 30, - children: [ - EquationInput( - key: const Key('IntegralInput-lower-bound'), - controller: lowerBound, - placeholderText: 'a', - baseWidth: integrationBoundsWidth, - maxLength: 8, - onlyRealValues: true, - ), - EquationInput( - key: const Key('IntegralInput-upper-bound'), - controller: upperBound, - placeholderText: 'b', - baseWidth: integrationBoundsWidth, - maxLength: 8, - onlyRealValues: true, - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/integral_page/integral_results.dart b/example/flutter_example/lib/routes/integral_page/integral_results.dart deleted file mode 100644 index 0d3d423e..00000000 --- a/example/flutter_example/lib/routes/integral_page/integral_results.dart +++ /dev/null @@ -1,58 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The results of the numerical integration. -class IntegralResultsWidget extends StatelessWidget { - /// Creates an [IntegralResultsWidget] widget. - const IntegralResultsWidget({super.key}); - - @override - Widget build(BuildContext context) { - return Column( - children: [ - // Separator line - const SizedBox( - height: 80, - ), - - SectionTitle( - pageTitle: context.l10n.solutions, - icon: const EquationSolution(), - ), - - // Showing the solutions of the nonlinear equation - const _IntegralSolutions(), - ], - ); - } -} - -/// The numerical value produced by the integral evaluation. -class _IntegralSolutions extends StatelessWidget { - /// Creates an [_IntegralSolutions] widget. - const _IntegralSolutions(); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.integralState, - builder: (context, _) { - final integration = context.integralState.state.numericalIntegration; - - if (integration != null) { - return RealResultCard( - value: integration.integrate().result, - leading: 'F(x) = ', - ); - } - - return const NoResults(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/integral_page/model/inherited_integral.dart b/example/flutter_example/lib/routes/integral_page/model/inherited_integral.dart deleted file mode 100644 index 13e828ee..00000000 --- a/example/flutter_example/lib/routes/integral_page/model/inherited_integral.dart +++ /dev/null @@ -1,35 +0,0 @@ -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [IntegralState] object. -class InheritedIntegral extends InheritedWidget { - /// The state of the numerical integration page. - final IntegralState integralState; - - /// Creates an [InheritedWidget] that exposes a [IntegralState] object. - const InheritedIntegral({ - required this.integralState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedIntegral] instance up in the tree. - static InheritedIntegral of(BuildContext context) { - final ref = context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedIntegral' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedIntegral oldWidget) { - return integralState != oldWidget.integralState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -///[IntegralState] up in the tree using [InheritedIntegral]. -extension InheritedIntegralExt on BuildContext { - /// Uses [InheritedIntegral] to retrieve a [IntegralState] object. - IntegralState get integralState => InheritedIntegral.of(this).integralState; -} diff --git a/example/flutter_example/lib/routes/integral_page/model/integral_result.dart b/example/flutter_example/lib/routes/integral_page/model/integral_result.dart deleted file mode 100644 index 36f0dacb..00000000 --- a/example/flutter_example/lib/routes/integral_page/model/integral_result.dart +++ /dev/null @@ -1,34 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/integral_page.dart'; - -/// Wrapper class that holds the [NumericalIntegration] type computed by -/// [IntegralPage]. -class IntegralResult { - /// The [NumericalIntegration] object. - /// - /// When `null`, it means that there an error occurred while evaluating the - /// integral. - final NumericalIntegration? numericalIntegration; - - /// Creates an [IntegralResult] object. - const IntegralResult({ - this.numericalIntegration, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is IntegralResult) { - return runtimeType == other.runtimeType && - numericalIntegration == other.numericalIntegration; - } else { - return false; - } - } - - @override - int get hashCode => numericalIntegration.hashCode; -} diff --git a/example/flutter_example/lib/routes/integral_page/model/integral_state.dart b/example/flutter_example/lib/routes/integral_page/model/integral_state.dart deleted file mode 100644 index b2355e1e..00000000 --- a/example/flutter_example/lib/routes/integral_page/model/integral_state.dart +++ /dev/null @@ -1,75 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/integral_page.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_result.dart'; -import 'package:flutter/widgets.dart'; - -/// The type of numerical integration algorithms. -enum IntegralType { - /// The midpoint rule. - midPoint, - - /// The Simpson rule. - simpson, - - /// The trapezoidal rule. - trapezoid, -} - -/// Holds the state of the [IntegralPage] page. -class IntegralState extends ChangeNotifier { - var _state = const IntegralResult(); - - /// The current state. - IntegralResult get state => _state; - - /// Tries to integrate the given function within the intervals. - void solveIntegral({ - required String upperBound, - required String lowerBound, - required String function, - required int intervals, - required IntegralType integralType, - }) { - try { - const parser = ExpressionParser(); - final lower = parser.evaluate(lowerBound); - final upper = parser.evaluate(upperBound); - - final integration = switch (integralType) { - IntegralType.midPoint => MidpointRule( - function: function, - lowerBound: lower, - upperBound: upper, - intervals: intervals, - ), - IntegralType.simpson => SimpsonRule( - function: function, - lowerBound: lower, - upperBound: upper, - intervals: intervals, - ), - IntegralType.trapezoid => TrapezoidalRule( - function: function, - lowerBound: lower, - upperBound: upper, - intervals: intervals, - ) - }; - - // Integrating and returning the result - _state = IntegralResult( - numericalIntegration: integration, - ); - } on Exception { - _state = const IntegralResult(); - } - - notifyListeners(); - } - - /// Clears the state. - void clear() { - _state = const IntegralResult(); - notifyListeners(); - } -} diff --git a/example/flutter_example/lib/routes/integral_page/utils/dropdown_selection.dart b/example/flutter_example/lib/routes/integral_page/utils/dropdown_selection.dart deleted file mode 100644 index 496d62f2..00000000 --- a/example/flutter_example/lib/routes/integral_page/utils/dropdown_selection.dart +++ /dev/null @@ -1,99 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// Dropdown button needed to choose the numerical integration algorithm. -class IntegralDropdownSelection extends StatefulWidget { - /// Creates a [IntegralDropdownSelection] widget. - const IntegralDropdownSelection({super.key}); - - @override - IntegralDropdownSelectionState createState() => - IntegralDropdownSelectionState(); -} - -/// The state of the [IntegralDropdownSelection] class. -@visibleForTesting -class IntegralDropdownSelectionState extends State { - /// The dropdown items. - final dropdownItems = const [ - DropdownMenuItem( - key: Key('Simpson-Dropdown'), - value: IntegralDropdownItems.simpson, - child: Text('Simpson'), - ), - DropdownMenuItem( - key: Key('Trapezoid-Dropdown'), - value: IntegralDropdownItems.trapezoid, - child: Text('Trapezoid'), - ), - DropdownMenuItem( - key: Key('Midpoint-Dropdown'), - value: IntegralDropdownItems.midpoint, - child: Text('Midpoint'), - ), - ]; - - /// Updates the currently selected value in the dropdown. - void changeSelected(IntegralDropdownItems newValue) => - context.dropdownValue.value = newValue.name; - - @override - Widget build(BuildContext context) { - return Center( - child: SizedBox( - width: integralDropdownWidth, - child: ValueListenableBuilder( - valueListenable: context.dropdownValue, - builder: (context, value, _) { - return DropdownButtonFormField( - key: const Key('Integral-Dropdown-Button-Selection'), - isExpanded: true, - value: value.toIntegralDropdownItems(), - decoration: const InputDecoration( - border: OutlineInputBorder( - borderRadius: BorderRadius.all(Radius.circular(15)), - ), - ), - onChanged: (value) => changeSelected(value!), - items: dropdownItems, - ); - }, - ), - ), - ); - } -} - -/// The possible values of the [IntegralDropdownSelection] dropdown. -enum IntegralDropdownItems { - /// Simpson rule. - simpson('Simpson'), - - /// Midpoint rule. - midpoint('Midpoint'), - - /// Trapezoid rule. - trapezoid('Trapezoid'); - - /// The string representation. - final String name; - - /// [IntegralDropdownItems] constructor. - const IntegralDropdownItems(this.name); -} - -/// Extension method on [String] to convert into a [IntegralDropdownItems] the -/// string value. -extension StringExt on String { - static const _argumentErrorMessage = - 'The given string does NOT map to a IntegralDropdownItems value'; - - /// Converts a [String] into a [IntegralDropdownItems] value. - IntegralDropdownItems toIntegralDropdownItems() => switch (toLowerCase()) { - 'simpson' => IntegralDropdownItems.simpson, - 'midpoint' => IntegralDropdownItems.midpoint, - 'trapezoid' => IntegralDropdownItems.trapezoid, - _ => throw ArgumentError(_argumentErrorMessage) - }; -} diff --git a/example/flutter_example/lib/routes/integral_page/utils/integral_plot_widget.dart b/example/flutter_example/lib/routes/integral_page/utils/integral_plot_widget.dart deleted file mode 100644 index bcaeef94..00000000 --- a/example/flutter_example/lib/routes/integral_page/utils/integral_plot_widget.dart +++ /dev/null @@ -1,90 +0,0 @@ -import 'dart:math'; - -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// Wrapper of a [EquationDrawerWidget] widget that draws equations and -/// highlights the area below the function. -class IntegralPlotWidget extends StatelessWidget { - /// Creates a [IntegralPlotWidget] widget. - const IntegralPlotWidget({super.key}); - - @override - Widget build(BuildContext context) { - return Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // Title - const _PlotTitle(), - - // The actual plot - LayoutBuilder( - builder: (context, dimensions) { - final width = min( - dimensions.maxWidth, - maxWidthPlot, - ); - - return SizedBox( - width: width, - child: const _PlotWidgetListener(), - ); - }, - ), - ], - ), - ); - } -} - -/// A wrapper of [PageTitle] placed above a [EquationDrawerWidget]. -class _PlotTitle extends StatelessWidget { - /// Creates a [_PlotTitle] widget. - const _PlotTitle(); - - @override - Widget build(BuildContext context) { - return PageTitle( - pageTitle: context.l10n.chart, - pageLogo: const CartesianPlane(), - ); - } -} - -/// A wrapper of [EquationDrawerWidget] that listens to [IntegralState] to -/// either draw the function or clear the chart. -class _PlotWidgetListener extends StatelessWidget { - /// Creates a [_PlotWidgetListener] widget. - const _PlotWidgetListener(); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.integralState, - builder: (context, _) { - final integral = context.integralState.state.numericalIntegration; - - if (integral != null) { - return EquationDrawerWidget( - plotMode: IntegralEvaluator( - function: integral, - ), - areaColor: Colors.amber.withAlpha(60), - lowerAreaLimit: integral.lowerBound, - upperAreaLimit: integral.upperBound, - ); - } - - return const EquationDrawerWidget(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/models/dropdown_value/inherited_dropdown_value.dart b/example/flutter_example/lib/routes/models/dropdown_value/inherited_dropdown_value.dart deleted file mode 100644 index e7809776..00000000 --- a/example/flutter_example/lib/routes/models/dropdown_value/inherited_dropdown_value.dart +++ /dev/null @@ -1,36 +0,0 @@ -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [ValueNotifier] object. -class InheritedDropdownValue extends InheritedWidget { - /// The dropdown state, which also indicates the currently selected item. - final ValueNotifier dropdownValue; - - /// Creates an [InheritedWidget] that exposes a [ValueNotifier] object. - const InheritedDropdownValue({ - required this.dropdownValue, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedDropdownValue] instance up in the tree. - static InheritedDropdownValue of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedDropdownValue' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedDropdownValue oldWidget) { - return dropdownValue != oldWidget.dropdownValue; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// [ValueNotifier] up in the tree using [InheritedDropdownValue]. -extension InheritedDropdownValueExt on BuildContext { - /// Uses [InheritedDropdownValue] to retrieve a [ValueNotifier] object. - ValueNotifier get dropdownValue => - InheritedDropdownValue.of(this).dropdownValue; -} diff --git a/example/flutter_example/lib/routes/models/inherited_navigation/inherited_navigation.dart b/example/flutter_example/lib/routes/models/inherited_navigation/inherited_navigation.dart deleted file mode 100644 index e4ec05ae..00000000 --- a/example/flutter_example/lib/routes/models/inherited_navigation/inherited_navigation.dart +++ /dev/null @@ -1,56 +0,0 @@ -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:flutter/material.dart'; - -/// An [InheritedWidget] that exposes a series of values to control the -/// [EquationScaffold] tabs. -/// -/// The [navigationIndex] property is responsible for notifying listeners about -/// the new selected index (which also changes the currently visible tab). -class InheritedNavigation extends InheritedWidget { - /// The non-empty list of navigation items. - final List navigationItems; - - /// The optional [FloatingActionButton]. - final FloatingActionButton? fab; - - /// The [TabController] that drives the tab positioning and animation. - final TabController tabController; - - /// The navigation state. - final ValueNotifier navigationIndex; - - /// Creates an [InheritedWidget] that exposes a series of values. - const InheritedNavigation({ - required this.navigationIndex, - required this.navigationItems, - required this.fab, - required this.tabController, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedNavigation] instance up in the tree. - static InheritedNavigation of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedNavigation' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedNavigation oldWidget) { - return navigationIndex != oldWidget.navigationIndex || - navigationIndex != oldWidget.navigationIndex || - fab != oldWidget.fab || - tabController != oldWidget.tabController; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// [InheritedNavigation] up in the tree using the [BuildContext]. -extension InheritednavigationExt on BuildContext { - /// Uses [BuildContext] to retrieve a [InheritedNavigation] object. - InheritedNavigation get inheritedNavigation => InheritedNavigation.of(this); -} diff --git a/example/flutter_example/lib/routes/models/number_switcher/inherited_number_switcher.dart b/example/flutter_example/lib/routes/models/number_switcher/inherited_number_switcher.dart deleted file mode 100644 index cfd02069..00000000 --- a/example/flutter_example/lib/routes/models/number_switcher/inherited_number_switcher.dart +++ /dev/null @@ -1,40 +0,0 @@ -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [NumberSwitcherState] object. -class InheritedNumberSwitcher extends InheritedWidget { - /// The number switcher state. - final NumberSwitcherState numberSwitcherState; - - /// Creates an [InheritedWidget] that exposes a [NumberSwitcherState] object. - const InheritedNumberSwitcher({ - required this.numberSwitcherState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedNumberSwitcher] instance up in the tree. - static InheritedNumberSwitcher of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert( - ref != null, - "No 'InheritedNumberSwitcher' found above in the tree.", - ); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedNumberSwitcher oldWidget) { - return numberSwitcherState != oldWidget.numberSwitcherState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// [ValueNotifier] up in the tree using [NumberSwitcherState]. -extension InheritedNonlinearExt on BuildContext { - /// Uses [InheritedNumberSwitcher] to retrieve a [ValueNotifier] object. - NumberSwitcherState get numberSwitcherState => - InheritedNumberSwitcher.of(this).numberSwitcherState; -} diff --git a/example/flutter_example/lib/routes/models/number_switcher/number_switcher_state.dart b/example/flutter_example/lib/routes/models/number_switcher/number_switcher_state.dart deleted file mode 100644 index d0536980..00000000 --- a/example/flutter_example/lib/routes/models/number_switcher/number_switcher_state.dart +++ /dev/null @@ -1,42 +0,0 @@ -import 'package:flutter/widgets.dart'; - -/// This listenable class keeps the state of an [int] in the [min] <= x <= [max] -/// range. -class NumberSwitcherState extends ChangeNotifier { - int _counter; - - /// The minimum allowed value. - final int min; - - /// The maximum allowed value. - final int max; - - /// Creates a [NumberSwitcherState] instance and sets [min] as initial state. - NumberSwitcherState({ - required this.min, - required this.max, - }) : _counter = min; - - /// The current counter value; - int get state => _counter; - - /// Increases the value by 1. - void increase() => _changeValue(_counter + 1); - - /// Decreases the value by 1. - void decrease() => _changeValue(_counter - 1); - - /// Brings the state to the [min] value. - void reset() { - _counter = min; - notifyListeners(); - } - - /// Updates the current value **only** when `min <= newValue <= max`. - void _changeValue(int newValue) { - if ((newValue >= min) && (newValue <= max)) { - _counter = newValue; - notifyListeners(); - } - } -} diff --git a/example/flutter_example/lib/routes/models/plot_zoom/inherited_plot_zoom.dart b/example/flutter_example/lib/routes/models/plot_zoom/inherited_plot_zoom.dart deleted file mode 100644 index daf020b9..00000000 --- a/example/flutter_example/lib/routes/models/plot_zoom/inherited_plot_zoom.dart +++ /dev/null @@ -1,36 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [PlotZoomState] object. -class InheritedPlotZoom extends InheritedWidget { - /// The zoom state of a [EquationDrawerWidget]. - final PlotZoomState plotZoomState; - - /// Creates an [InheritedWidget] that exposes a [PlotZoomState] object. - const InheritedPlotZoom({ - required this.plotZoomState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedPlotZoom] instance up in the tree. - static InheritedPlotZoom of(BuildContext context) { - final ref = context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedPlotZoom' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedPlotZoom oldWidget) { - return plotZoomState != oldWidget.plotZoomState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// [PlotZoomState] up in the tree using [InheritedPlotZoomExt]. -extension InheritedPlotZoomExt on BuildContext { - /// Uses [InheritedPlotZoomExt] to retrieve a [PlotZoomState] object. - PlotZoomState get plotZoomState => InheritedPlotZoom.of(this).plotZoomState; -} diff --git a/example/flutter_example/lib/routes/models/plot_zoom/plot_zoom_state.dart b/example/flutter_example/lib/routes/models/plot_zoom/plot_zoom_state.dart deleted file mode 100644 index 0b9a01b2..00000000 --- a/example/flutter_example/lib/routes/models/plot_zoom/plot_zoom_state.dart +++ /dev/null @@ -1,42 +0,0 @@ -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:flutter/material.dart'; - -/// This listenable class handles the state of a material [Slider] widget. In -/// particular, it's used to keep track of the zoom of a [EquationDrawerWidget] -/// widget. -class PlotZoomState extends ChangeNotifier { - double _zoom = 0; - - /// The minimum zoom value. - final double minValue; - - /// The maximum zoom value. - final double maxValue; - - /// The initial value. - final double initial; - - /// Creates a [PlotZoomState] object. - PlotZoomState({ - required this.minValue, - required this.maxValue, - required this.initial, - }) : _zoom = initial; - - /// The current state. - double get zoom => _zoom; - - /// Updates the current position. - void updateSlider(double newValue) { - if ((newValue >= minValue) && (newValue <= maxValue)) { - _zoom = newValue; - notifyListeners(); - } - } - - /// Sets the current state to [initial]. - void reset() { - _zoom = initial; - notifyListeners(); - } -} diff --git a/example/flutter_example/lib/routes/models/precision_slider/inherited_precision_slider.dart b/example/flutter_example/lib/routes/models/precision_slider/inherited_precision_slider.dart deleted file mode 100644 index 76d34747..00000000 --- a/example/flutter_example/lib/routes/models/precision_slider/inherited_precision_slider.dart +++ /dev/null @@ -1,41 +0,0 @@ -import 'package:equations_solver/routes/models/precision_slider/precision_slider_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [PrecisionSliderState] object. -class InheritedPrecisionSlider extends InheritedWidget { - /// The slider state. - final PrecisionSliderState precisionState; - - /// Creates an [InheritedWidget] that exposes a [PrecisionSliderState] object. - const InheritedPrecisionSlider({ - required this.precisionState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedPrecisionSlider] instance up in the tree. - static InheritedPrecisionSlider of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert( - ref != null, - "No 'InheritedPrecisionSlider' found above in the tree.", - ); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedPrecisionSlider oldWidget) { - return precisionState != oldWidget.precisionState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// [PrecisionSliderState] up in the tree using [InheritedPrecisionSlider]. -extension InheritedPrecisionStateExt on BuildContext { - /// Uses [InheritedPrecisionSlider] to retrieve a [PrecisionSliderState] - /// object. - PrecisionSliderState get precisionState => - InheritedPrecisionSlider.of(this).precisionState; -} diff --git a/example/flutter_example/lib/routes/models/precision_slider/precision_slider_state.dart b/example/flutter_example/lib/routes/models/precision_slider/precision_slider_state.dart deleted file mode 100644 index 56c5aeff..00000000 --- a/example/flutter_example/lib/routes/models/precision_slider/precision_slider_state.dart +++ /dev/null @@ -1,40 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/nonlinear_data_input.dart'; -import 'package:flutter/material.dart'; - -/// Holds the state of a [Slider] in the [NonlinearDataInput] widget. This is -/// used to remember the precision of the root finding algorithm selected by the -/// user. -class PrecisionSliderState extends ChangeNotifier { - double _value = 0; - - /// The minimum value. - final double minValue; - - /// The maximum value. - final double maxValue; - - /// The initial state is the average of [minValue] and [maxValue], so it's - /// computed as `(minValue + maxValue) / 2`. - PrecisionSliderState({ - required this.minValue, - required this.maxValue, - }) : _value = (minValue + maxValue) / 2; - - /// The current state. - double get value => _value; - - /// Updates the current slider value. - void updateSlider(double newValue) { - if ((newValue >= minValue) && (newValue <= maxValue)) { - _value = newValue; - notifyListeners(); - } - } - - /// Sets the state back to the initial value, which is the average of - /// [minValue] and [maxValue]. - void reset() { - _value = (minValue + maxValue) / 2; - notifyListeners(); - } -} diff --git a/example/flutter_example/lib/routes/models/system_text_controllers/inherited_system_controllers.dart b/example/flutter_example/lib/routes/models/system_text_controllers/inherited_system_controllers.dart deleted file mode 100644 index 2fa713ba..00000000 --- a/example/flutter_example/lib/routes/models/system_text_controllers/inherited_system_controllers.dart +++ /dev/null @@ -1,43 +0,0 @@ -import 'package:equations_solver/routes/models/system_text_controllers/system_text_controllers.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [SystemTextControllers] object. -class InheritedSystemControllers extends InheritedWidget { - /// The matrix and vectors text controllers. - final SystemTextControllers systemTextControllers; - - /// Creates an [InheritedWidget] that exposes a [SystemTextControllers] - /// object. - const InheritedSystemControllers({ - required this.systemTextControllers, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedSystemControllers] instance up in the - /// tree. - static InheritedSystemControllers of(BuildContext context) { - final ref = context - .dependOnInheritedWidgetOfExactType(); - assert( - ref != null, - "No 'InheritedSystemControllers' found above in the tree.", - ); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedSystemControllers oldWidget) { - return systemTextControllers != oldWidget.systemTextControllers; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// [SystemTextControllers] up in the tree using [InheritedSystemControllers]. -extension InheritedSystemControllersExt on BuildContext { - /// Uses [InheritedSystemControllers] to retrieve a [SystemTextControllers] - /// object. - SystemTextControllers get systemTextControllers => - InheritedSystemControllers.of(this).systemTextControllers; -} diff --git a/example/flutter_example/lib/routes/models/system_text_controllers/system_text_controllers.dart b/example/flutter_example/lib/routes/models/system_text_controllers/system_text_controllers.dart deleted file mode 100644 index 520cf1c2..00000000 --- a/example/flutter_example/lib/routes/models/system_text_controllers/system_text_controllers.dart +++ /dev/null @@ -1,39 +0,0 @@ -import 'package:equations_solver/routes/system_page.dart'; -import 'package:flutter/material.dart'; - -/// Wrapper for a series of [TextEditingController]s used by [SystemPage] to -/// handle users inputs. -final class SystemTextControllers { - /// The text input controllers for the matrix. - /// - /// These controllers hold the values of the `A` matrix in the `Ax = b` - /// equation, where: - /// - /// - `A` is the matrix - /// - `b` is the known values vector - final List matrixControllers; - - /// The text input controllers for the vector. - /// - /// These controllers hold the values of the `b` vector in the `Ax = b` - /// equation, where: - /// - /// - `A` is the matrix - /// - `b` is the known values vector - final List vectorControllers; - - /// The text input controllers for the initial guess vector of the Jacobi - /// algorithm. - final List jacobiControllers; - - /// A controller for the relaxation factor `w` of the SOR algorithm. - final TextEditingController wSorController; - - /// Creates a [SystemTextControllers] object. - const SystemTextControllers({ - required this.matrixControllers, - required this.vectorControllers, - required this.jacobiControllers, - required this.wSorController, - }); -} diff --git a/example/flutter_example/lib/routes/models/text_controllers/inherited_text_controllers.dart b/example/flutter_example/lib/routes/models/text_controllers/inherited_text_controllers.dart deleted file mode 100644 index 78d8b250..00000000 --- a/example/flutter_example/lib/routes/models/text_controllers/inherited_text_controllers.dart +++ /dev/null @@ -1,43 +0,0 @@ -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a list of [TextEditingController] object. -class InheritedTextControllers extends InheritedWidget { - /// The text controllers state used to persist the value across tabs or - /// text fields being deactivated. - final List textControllers; - - /// Creates an [InheritedWidget] that exposes a list of - /// [TextEditingController] objects. - const InheritedTextControllers({ - required this.textControllers, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedTextControllers] instance up in the tree. - static InheritedTextControllers of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert( - ref != null, - "No 'InheritedTextControllers' found above in the tree.", - ); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedTextControllers oldWidget) { - return textControllers != oldWidget.textControllers; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -/// list of [TextEditingController]s up in the tree using -/// [InheritedTextControllers]. -extension InheritedTextControllersExt on BuildContext { - /// Uses [InheritedTextControllers] to retrieve the [TextEditingController] - /// list. - List get textControllers => - InheritedTextControllers.of(this).textControllers; -} diff --git a/example/flutter_example/lib/routes/nonlinear_page.dart b/example/flutter_example/lib/routes/nonlinear_page.dart deleted file mode 100644 index 2f2c2596..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page.dart +++ /dev/null @@ -1,131 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/models/precision_slider/inherited_precision_slider.dart'; -import 'package:equations_solver/routes/models/precision_slider/precision_slider_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_body.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:flutter/material.dart'; - -/// This page contains a series of nonlinear equations solvers. There are 2 tabs -/// with a series of well-known root finding algorithms: -/// -/// - Single point methods (like Newton's method) -/// - Bracketing methods (like secant method or bisection) -/// -/// Each tab also has a [EquationDrawerWidget] which draws functions on a -/// cartesian plane. -class NonlinearPage extends StatefulWidget { - /// Creates a [NonlinearPage] widget. - const NonlinearPage({super.key}); - - @override - State createState() => _NonlinearPageState(); -} - -class _NonlinearPageState extends State { - /* - * These controllers are exposed to the subtree with [InheritedTextController] - * because the scaffold uses tabs and when swiping, the controllers get - * disposed. - * - * In order to keep the controllers alive (and thus persist the text), we need - * to save theme here, which is ABOVE the tabs. - */ - - final singlePointControllers = [ - TextEditingController(), - TextEditingController(), - ]; - - final bracketingControllers = [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ]; - - /// Caching navigation items since they'll never change. - late final cachedItems = [ - NavigationItem( - title: context.l10n.single_point, - content: InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.singlePoint), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - NonlinearDropdownItems.newton.name, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedPrecisionSlider( - precisionState: PrecisionSliderState(minValue: 1, maxValue: 15), - child: InheritedTextControllers( - textControllers: singlePointControllers, - child: const NonlinearBody( - key: Key('NonlinearPage-SinglePoint-Body'), - ), - ), - ), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.bracketing, - content: InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.bracketing), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - NonlinearDropdownItems.bisection.name, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedPrecisionSlider( - precisionState: PrecisionSliderState(minValue: 1, maxValue: 15), - child: InheritedTextControllers( - textControllers: bracketingControllers, - child: const NonlinearBody( - key: Key('NonlinearPage-Bracketing-Body'), - ), - ), - ), - ), - ), - ), - ), - ]; - - @override - void dispose() { - for (final controller in singlePointControllers) { - controller.dispose(); - } - - for (final controller in bracketingControllers) { - controller.dispose(); - } - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return EquationScaffold.navigation( - navigationItems: cachedItems, - ); - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/model/inherited_nonlinear.dart b/example/flutter_example/lib/routes/nonlinear_page/model/inherited_nonlinear.dart deleted file mode 100644 index 19e5f573..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/model/inherited_nonlinear.dart +++ /dev/null @@ -1,37 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [NonlinearState] object. -class InheritedNonlinear extends InheritedWidget { - /// The state of the nonlinear solvers page. - final NonlinearState nonlinearState; - - /// Creates an [InheritedWidget] that exposes a [NonlinearState] object. - const InheritedNonlinear({ - required this.nonlinearState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedNonlinear] instance up in the tree. - static InheritedNonlinear of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedNonlinear' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedNonlinear oldWidget) { - return nonlinearState != oldWidget.nonlinearState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -///[NonlinearState] up in the tree using [InheritedNonlinear]. -extension InheritedNonlinearExt on BuildContext { - /// Uses [InheritedNonlinear] to retrieve a [NonlinearState] object. - NonlinearState get nonlinearState => - InheritedNonlinear.of(this).nonlinearState; -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/model/nonlinear_result.dart b/example/flutter_example/lib/routes/nonlinear_page/model/nonlinear_result.dart deleted file mode 100644 index 1b1c82b5..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/model/nonlinear_result.dart +++ /dev/null @@ -1,32 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; - -/// Wrapper class that holds the [NonLinear] type computed by [NonlinearState]. -class NonlinearResult { - /// The [NonLinear] object that holds the nonlinear equation data. - /// - /// When `null`, it means that there has been an error while computing the - /// roots. - final NonLinear? nonlinear; - - /// Creates a [NonlinearResult] object. - const NonlinearResult({ - this.nonlinear, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is NonlinearResult) { - return runtimeType == other.runtimeType && nonlinear == other.nonlinear; - } else { - return false; - } - } - - @override - int get hashCode => nonlinear.hashCode; -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/model/nonlinear_state.dart b/example/flutter_example/lib/routes/nonlinear_page/model/nonlinear_state.dart deleted file mode 100644 index 9122af5b..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/model/nonlinear_state.dart +++ /dev/null @@ -1,163 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/nonlinear_page.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_result.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/dropdown_selection.dart'; -import 'package:flutter/widgets.dart'; - -/// The types of nonlinear equations that can be solved. -enum NonlinearType { - /// Algorithms that require a single starting point. - singlePoint, - - /// Algorithms that bracket the root. - bracketing, -} - -/// Root finding algorithm that require a single point to start the iterations. -enum SinglePointMethods { - /// Newton's method. - newton, - - /// Steffensen's method. - steffensen, -} - -/// Root finding algorithm that need to bracket the root to start the -/// iterations. -enum BracketingMethods { - /// Bisection method. - bisection, - - /// Secant method. - secant, - - /// Brent's method. - brent, -} - -/// Holds the state of the [NonlinearPage] page. -class NonlinearState extends ChangeNotifier { - var _state = const NonlinearResult(); - - /// The type of nonlinear equations to solve. - final NonlinearType nonlinearType; - - /// Creates a [NonlinearState] object. - NonlinearState(this.nonlinearType); - - /// The current state. - NonlinearResult get state => _state; - - /// Tries to return a [SinglePointMethods] value from a - /// [NonlinearDropdownItems] value. - static SinglePointMethods singlePointResolve(NonlinearDropdownItems item) { - if (item == NonlinearDropdownItems.newton) { - return SinglePointMethods.newton; - } - - return SinglePointMethods.steffensen; - } - - /// Tries to return a [BracketingMethods] value from a - /// [NonlinearDropdownItems] value. - static BracketingMethods bracketingResolve(NonlinearDropdownItems item) { - if (item == NonlinearDropdownItems.secant) { - return BracketingMethods.secant; - } - - if (item == NonlinearDropdownItems.brent) { - return BracketingMethods.brent; - } - - return BracketingMethods.bisection; - } - - /// Solves an equation using a bracketing algorithm. - void solveWithBracketing({ - required String upperBound, - required String lowerBound, - required String function, - required double precision, - required BracketingMethods method, - }) { - try { - const parser = ExpressionParser(); - final lower = parser.evaluate(lowerBound); - final upper = parser.evaluate(upperBound); - - final solver = switch (method) { - BracketingMethods.bisection => Bisection( - function: function, - a: lower, - b: upper, - maxSteps: 20, - tolerance: precision, - ), - BracketingMethods.secant => Secant( - function: function, - a: lower, - b: upper, - maxSteps: 20, - tolerance: precision, - ), - BracketingMethods.brent => Brent( - function: function, - a: lower, - b: upper, - maxSteps: 20, - tolerance: precision, - ) - }; - - _state = NonlinearResult( - nonlinear: solver, - ); - } on Exception { - _state = const NonlinearResult(); - } - - notifyListeners(); - } - - /// Solves an equation using a single point algorithm. - void solveWithSinglePoint({ - required String initialGuess, - required String function, - required double precision, - required SinglePointMethods method, - }) { - try { - const parser = ExpressionParser(); - final x0 = parser.evaluate(initialGuess); - - final solver = switch (method) { - SinglePointMethods.newton => Newton( - function: function, - x0: x0, - maxSteps: 20, - tolerance: precision, - ), - SinglePointMethods.steffensen => Steffensen( - function: function, - x0: x0, - maxSteps: 20, - tolerance: precision, - ) - }; - - _state = NonlinearResult( - nonlinear: solver, - ); - } on Exception { - _state = const NonlinearResult(); - } - - notifyListeners(); - } - - /// Clears the state. - void clear() { - _state = const NonlinearResult(); - notifyListeners(); - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/nonlinear_body.dart b/example/flutter_example/lib/routes/nonlinear_page/nonlinear_body.dart deleted file mode 100644 index 85f8ad16..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/nonlinear_body.dart +++ /dev/null @@ -1,151 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/nonlinear_data_input.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_results.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/nonlinear_plot_widget.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/nonlinear_title_localizer.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; - -/// This widget contains the solutions of the nonlinear equation and a chart -/// which plots the function. -/// -/// This widget is responsive: contents may be laid out on a single column or -/// on two columns according with the available width. -class NonlinearBody extends StatelessWidget { - /// Creates a [NonlinearBody] widget. - const NonlinearBody({super.key}); - - @override - Widget build(BuildContext context) { - return const Stack( - children: [ - // Scrollable contents of the page - Positioned.fill( - child: _ResponsiveBody(), - ), - - // "Go back" button - Positioned( - top: 20, - left: 20, - child: GoBackButton(), - ), - ], - ); - } -} - -/// Determines whether the contents should appear in 1 or 2 columns. -class _ResponsiveBody extends StatelessWidget { - /// Creates a [_ResponsiveBody] widget. - const _ResponsiveBody(); - - @override - Widget build(BuildContext context) { - return FocusTraversalGroup( - child: LayoutBuilder( - builder: (context, size) { - if (size.maxWidth <= doubleColumnPageBreakpoint) { - // For mobile devices - all in a column - return const _SingleColumnLayout(); - } - - // For wider screens - plot on the right and results on the right - return const _DoubleColumnLayout(); - }, - ), - ); - } -} - -/// Lays the page contents on a single column. -class _SingleColumnLayout extends StatelessWidget with NonlinearTitleLocalizer { - /// Creates a [_SingleColumnLayout] widget. - const _SingleColumnLayout(); - - @override - Widget build(BuildContext context) { - return SingleChildScrollView( - key: const Key('SingleChildScrollView-mobile-responsive'), - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - PageTitle( - pageTitle: getLocalizedName(context), - pageLogo: const NonlinearLogo( - size: 50, - ), - ), - const NonlinearDataInput(), - const NonlinearResults(), - const NonlinearPlotWidget(), - ], - ), - ); - } -} - -/// Lays the page contents on two columns. -class _DoubleColumnLayout extends StatelessWidget { - /// Creates a [_DoubleColumnLayout] widget. - const _DoubleColumnLayout(); - - @override - Widget build(BuildContext context) { - return const Center( - child: SingleChildScrollView( - key: Key('SingleChildScrollView-desktop-responsive'), - child: Row( - mainAxisAlignment: MainAxisAlignment.spaceAround, - children: [ - // Input and results - Expanded( - child: _DoubleColumnLeftContent(), - ), - - // Plot - Expanded( - child: Padding( - padding: EdgeInsets.symmetric( - horizontal: 15, - ), - child: NonlinearPlotWidget(), - ), - ), - ], - ), - ), - ); - } -} - -/// The left column [_ResponsiveBody] when the viewport is large enough. -class _DoubleColumnLeftContent extends StatelessWidget - with NonlinearTitleLocalizer { - /// Creates a [_DoubleColumnLeftContent] widget. - const _DoubleColumnLeftContent(); - - @override - Widget build(BuildContext context) { - return Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - PageTitle( - pageTitle: getLocalizedName(context), - pageLogo: const NonlinearLogo( - size: 50, - ), - ), - const NonlinearDataInput(), - const NonlinearResults(), - const SizedBox( - height: 40, - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/nonlinear_data_input.dart b/example/flutter_example/lib/routes/nonlinear_page/nonlinear_data_input.dart deleted file mode 100644 index 43c9a81a..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/nonlinear_data_input.dart +++ /dev/null @@ -1,192 +0,0 @@ -import 'dart:math' as math; - -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/precision_slider/inherited_precision_slider.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/precision_slider.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/equation_input.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; - -/// This widget contains a series of input widgets needed to parse the -/// coefficients of the nonlinear equation to be solved. -class NonlinearDataInput extends StatefulWidget { - /// Creates a [NonlinearDataInput] widget. - const NonlinearDataInput({super.key}); - - @override - State createState() => _NonlinearDataInputState(); -} - -class _NonlinearDataInputState extends State { - /// Manually caching the equation input field. - late final functionInput = EquationInput( - key: const Key('EquationInput-function'), - controller: context.textControllers.first, - placeholderText: 'f(x)', - ); - - /// Form validation key. - final formKey = GlobalKey(); - - /// This is required to figure out how many inputs are required for the - /// equation to be solved. - NonlinearType get getType => context.nonlinearState.nonlinearType; - - /// Form and chart cleanup. - void cleanInput() { - formKey.currentState?.reset(); - context.nonlinearState.clear(); - context.plotZoomState.reset(); - context.precisionState.reset(); - context.dropdownValue.value = context.textControllers.length == 2 - ? NonlinearDropdownItems.newton.name - : NonlinearDropdownItems.bisection.name; - - for (final controller in context.textControllers) { - controller.clear(); - } - - FocusScope.of(context).unfocus(); - } - - /// Solves a nonlinear equation. - void solve() { - if (formKey.currentState?.validate() ?? false) { - final precision = context.precisionState.value; - final algorithm = context.dropdownValue.value.toNonlinearDropdownItems(); - - if (getType == NonlinearType.singlePoint) { - context.nonlinearState.solveWithSinglePoint( - method: NonlinearState.singlePointResolve(algorithm), - function: context.textControllers.first.text, - initialGuess: context.textControllers[1].text, - precision: 1.0 * math.pow(10, -precision), - ); - } else { - context.nonlinearState.solveWithBracketing( - method: NonlinearState.bracketingResolve(algorithm), - function: context.textControllers.first.text, - lowerBound: context.textControllers[1].text, - upperBound: context.textControllers[2].text, - precision: 1.0 * math.pow(10, -precision), - ); - } - } else { - // Invalid input - ScaffoldMessenger.of(context).showSnackBar( - SnackBar( - content: Text(context.l10n.invalid_values), - duration: const Duration(seconds: 2), - ), - ); - } - } - - @override - Widget build(BuildContext context) { - return Form( - key: formKey, - child: Column( - mainAxisSize: MainAxisSize.min, - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Some space from the top - const SizedBox(height: 40), - - // The equation input - Flexible( - child: functionInput, - ), - - // The guesses required by the app - const _GuessesInput(), - - // Some spacing - const SizedBox(height: 40), - - // Which algorithm has to be used - const NonlinearDropdownSelection(), - - // Some spacing - const SizedBox(height: 40), - - // The slider - const PrecisionSlider(), - - // Some spacing - const SizedBox(height: 50), - - // Two buttons needed to "solve" and "clear" the equation - Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Solving the equation - ElevatedButton( - key: const Key('Nonlinear-button-solve'), - onPressed: solve, - child: Text(context.l10n.solve), - ), - - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 16, - ), - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.equations, - ), - ), - - // Cleaning the inputs - ElevatedButton( - key: const Key('Nonlinear-button-clean'), - onPressed: cleanInput, - child: Text(context.l10n.clean), - ), - ], - ), - ], - ), - ); - } -} - -/// Either 1 or 2 [EquationInput] widgets asking for the initial values of the -/// root finding algorithm. -class _GuessesInput extends StatelessWidget { - /// Creates a [_GuessesInput] instance. - const _GuessesInput(); - - @override - Widget build(BuildContext context) { - return Wrap( - alignment: WrapAlignment.center, - spacing: 30, - children: [ - EquationInput( - key: const Key('EquationInput-first-param'), - controller: context.textControllers[1], - placeholderText: 'x0', - baseWidth: nonlinearValuesWidth, - maxLength: 8, - onlyRealValues: true, - ), - if (context.nonlinearState.nonlinearType == NonlinearType.bracketing) - EquationInput( - key: const Key('EquationInput-second-param'), - controller: context.textControllers[2], - placeholderText: 'x1', - baseWidth: nonlinearValuesWidth, - maxLength: 8, - onlyRealValues: true, - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/nonlinear_results.dart b/example/flutter_example/lib/routes/nonlinear_page/nonlinear_results.dart deleted file mode 100644 index 89f57a8b..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/nonlinear_results.dart +++ /dev/null @@ -1,88 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/message_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The results of the nonlinear equation. -class NonlinearResults extends StatelessWidget { - /// Creates a [NonlinearResults] widget. - const NonlinearResults({super.key}); - - @override - Widget build(BuildContext context) { - return Column( - children: [ - // Separator line. - const SizedBox( - height: 80, - ), - - SectionTitle( - pageTitle: context.l10n.solutions, - icon: const EquationSolution(), - ), - - // Shows the solutions of the nonlinear equation. - const _NonlinearSolutions(), - ], - ); - } -} - -class _NonlinearSolutions extends StatelessWidget { - const _NonlinearSolutions(); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.nonlinearState, - builder: (context, _) { - final nonlinear = context.nonlinearState.state.nonlinear; - - if (nonlinear != null) { - // Computation results - try { - final results = nonlinear.solve(); - - final guess = results.guesses.last; - final convergence = results.convergence; - final efficiency = results.efficiency; - - return Column( - mainAxisSize: MainAxisSize.min, - children: [ - // The guess - RealResultCard( - leading: 'x0: ', - value: guess, - ), - - // The convergence of the algorithm - RealResultCard( - leading: '${context.l10n.convergence}: ', - value: convergence, - ), - - // The efficiency of the algorithm - RealResultCard( - leading: '${context.l10n.efficiency}: ', - value: efficiency, - ), - ], - ); - } on Exception { - return MessageCard( - message: context.l10n.nonlinear_fail_converge, - ); - } - } - - return const NoResults(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/utils/dropdown_selection.dart b/example/flutter_example/lib/routes/nonlinear_page/utils/dropdown_selection.dart deleted file mode 100644 index 251c9b6b..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/utils/dropdown_selection.dart +++ /dev/null @@ -1,128 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_data_input.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// Dropdown button used to choose which root finding algorithm has to be used -/// in a [NonlinearDataInput] widget. -class NonlinearDropdownSelection extends StatefulWidget { - /// Creates a [NonlinearDropdownSelection] widget. - const NonlinearDropdownSelection({super.key}); - - @override - NonlinearDropdownSelectionState createState() => - NonlinearDropdownSelectionState(); -} - -/// The state of the [NonlinearDropdownSelection] class. -@visibleForTesting -class NonlinearDropdownSelectionState - extends State { - /// The cached dropdown items. - late final dropdownItems = nonlinearType == NonlinearType.singlePoint - ? const [ - DropdownMenuItem( - key: Key('Newton-Dropdown'), - value: NonlinearDropdownItems.newton, - child: Text('Newton'), - ), - DropdownMenuItem( - key: Key('Steffensen-Dropdown'), - value: NonlinearDropdownItems.steffensen, - child: Text('Steffensen'), - ), - ] - : const [ - DropdownMenuItem( - key: Key('Bisection-Dropdown'), - value: NonlinearDropdownItems.bisection, - child: Text('Bisection'), - ), - DropdownMenuItem( - key: Key('Secant-Dropdown'), - value: NonlinearDropdownItems.secant, - child: Text('Secant'), - ), - DropdownMenuItem( - key: Key('Brent-Dropdown'), - value: NonlinearDropdownItems.brent, - child: Text('Brent'), - ), - ]; - - /// Updates the currently selected value in the dropdown. - void changeSelected(NonlinearDropdownItems newValue) => - context.dropdownValue.value = newValue.name; - - /// The currently selected nonlinear type. - NonlinearType get nonlinearType => context.nonlinearState.nonlinearType; - - @override - Widget build(BuildContext context) { - return Center( - child: SizedBox( - width: nonlinearDropdownWidth, - child: ValueListenableBuilder( - valueListenable: context.dropdownValue, - builder: (context, value, _) { - return DropdownButtonFormField( - key: const Key('Integral-Dropdown-Button-Selection'), - isExpanded: true, - value: value.toNonlinearDropdownItems(), - decoration: const InputDecoration( - border: OutlineInputBorder( - borderRadius: BorderRadius.all(Radius.circular(15)), - ), - ), - onChanged: (value) => changeSelected(value!), - items: dropdownItems, - ); - }, - ), - ), - ); - } -} - -/// The possible values of the [NonlinearDropdownSelection] dropdown. -enum NonlinearDropdownItems { - /// Newton's method. - newton('Newton'), - - /// Steffensen's method. - steffensen('Steffensen'), - - /// Bisection method. - bisection('Bisection'), - - /// Secant method. - secant('Secant'), - - /// Brent's method. - brent('Brent'); - - /// The string representation. - final String name; - - /// [NonlinearDropdownItems] constructor. - const NonlinearDropdownItems(this.name); -} - -/// Extension method on [String] to convert into a [NonlinearDropdownItems] the -/// string value. -extension StringExt on String { - static const _argumentErrorMessage = - 'The given string does NOT map to a NonlinearDropdownItems value'; - - /// Converts a [String] into a [NonlinearDropdownItems] value. - NonlinearDropdownItems toNonlinearDropdownItems() => switch (toLowerCase()) { - 'newton' => NonlinearDropdownItems.newton, - 'steffensen' => NonlinearDropdownItems.steffensen, - 'bisection' => NonlinearDropdownItems.bisection, - 'secant' => NonlinearDropdownItems.secant, - 'brent' => NonlinearDropdownItems.brent, - _ => throw ArgumentError(_argumentErrorMessage) - }; -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/utils/nonlinear_plot_widget.dart b/example/flutter_example/lib/routes/nonlinear_page/utils/nonlinear_plot_widget.dart deleted file mode 100644 index 01570264..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/utils/nonlinear_plot_widget.dart +++ /dev/null @@ -1,84 +0,0 @@ -import 'dart:math'; - -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// Wrapper of a [EquationDrawerWidget] widget that paints nonlinear equations -/// on the screen. -class NonlinearPlotWidget extends StatelessWidget { - /// Creates a [NonlinearPlotWidget] widget. - const NonlinearPlotWidget({super.key}); - - @override - Widget build(BuildContext context) { - return Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // Title - const _PlotTitle(), - - // The actual plot - LayoutBuilder( - builder: (context, dimensions) { - final width = min(dimensions.maxWidth, maxWidthPlot); - - return SizedBox( - width: width, - child: const _PlotWidgetListener(), - ); - }, - ), - ], - ), - ); - } -} - -/// A wrapper of [PageTitle] placed above a [EquationDrawerWidget]. -class _PlotTitle extends StatelessWidget { - /// Creates a [_PlotTitle] widget. - const _PlotTitle(); - - @override - Widget build(BuildContext context) { - return PageTitle( - pageTitle: context.l10n.chart, - pageLogo: const CartesianPlane(), - ); - } -} - -/// A wrapper of [EquationDrawerWidget] that listens to [NonlinearState] to -/// either draw the equation or clear the chart. -class _PlotWidgetListener extends StatelessWidget { - /// Creates a [_PlotWidgetListener] widget. - const _PlotWidgetListener(); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.nonlinearState, - builder: (context, _) { - final nonlinear = context.nonlinearState.state.nonlinear; - - if (nonlinear != null) { - return EquationDrawerWidget( - plotMode: NonlinearEvaluator( - nonLinear: nonlinear, - ), - ); - } - - return const EquationDrawerWidget(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/utils/nonlinear_title_localizer.dart b/example/flutter_example/lib/routes/nonlinear_page/utils/nonlinear_title_localizer.dart deleted file mode 100644 index d78bcf68..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/utils/nonlinear_title_localizer.dart +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_body.dart'; -import 'package:flutter/material.dart'; - -/// Mixin for [NonlinearBody] widgets that helps localizing the page title. -mixin NonlinearTitleLocalizer on StatelessWidget { - /// Localizes the title of a nonlinear solver tab. - String getLocalizedName(BuildContext context) { - final nonlinearType = context.nonlinearState.nonlinearType; - - return nonlinearType == NonlinearType.singlePoint - ? context.l10n.single_point - : context.l10n.bracketing; - } -} diff --git a/example/flutter_example/lib/routes/nonlinear_page/utils/precision_slider.dart b/example/flutter_example/lib/routes/nonlinear_page/utils/precision_slider.dart deleted file mode 100644 index 44769abb..00000000 --- a/example/flutter_example/lib/routes/nonlinear_page/utils/precision_slider.dart +++ /dev/null @@ -1,72 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/precision_slider/inherited_precision_slider.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// Sets the precision of the currently selected algorithm. -class PrecisionSlider extends StatelessWidget { - /// Creates a [PrecisionSlider] widget. - const PrecisionSlider({super.key}); - - void _update(BuildContext context, double value) => - context.precisionState.updateSlider(value); - - @override - Widget build(BuildContext context) { - return Center( - child: SizedBox( - width: precisonSliderWidth, - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // Slider - ListenableBuilder( - listenable: context.precisionState, - builder: (context, state) { - return Slider( - min: 2, - max: 15, - divisions: 13, - value: context.precisionState.value, - onChanged: (value) => _update(context, value), - ); - }, - ), - - const SizedBox(height: 15), - - // Labels - const _SliderLabels(), - ], - ), - ), - ); - } -} - -/// The text next to the [Slider] in the [PrecisionSlider] widget. -class _SliderLabels extends StatelessWidget { - const _SliderLabels(); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.only(left: 25, right: 25), - child: Row( - mainAxisAlignment: MainAxisAlignment.spaceBetween, - children: [ - // The precision of the slider - Text(context.l10n.precision), - - // The label representing the precision - ListenableBuilder( - listenable: context.precisionState, - builder: (context, state) { - return Text('1.0e-${context.precisionState.value.round()}'); - }, - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page.dart b/example/flutter_example/lib/routes/other_page.dart deleted file mode 100644 index 51fc9b53..00000000 --- a/example/flutter_example/lib/routes/other_page.dart +++ /dev/null @@ -1,92 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers_body.dart'; -import 'package:equations_solver/routes/other_page/matrix_body.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:flutter/material.dart'; - -/// This page contains a series of utilities to analyze matrices and complex -/// numbers. -class OtherPage extends StatefulWidget { - /// Creates a [OtherPage] widget. - const OtherPage({super.key}); - - @override - State createState() => _OtherPageState(); -} - -class _OtherPageState extends State { - /* - * These controllers are exposed to the subtree with [InheritedTextController] - * because the scaffold uses tabs and when swiping, the controllers get - * disposed. - * - * In order to keep the controllers alive (and thus persist the text), we need - * to save theme here, which is ABOVE the tabs. - */ - final realController = TextEditingController(); - final imaginaryController = TextEditingController(); - - final matrixControllers = List.generate( - 25, - (_) => TextEditingController(), - growable: false, - ); - - /// Caching navigation items since they'll never change. - late final cachedItems = [ - NavigationItem( - title: context.l10n.matrices, - content: InheritedOther( - otherState: OtherState(), - child: InheritedTextControllers( - textControllers: matrixControllers, - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 4, - ), - child: const MatrixOtherBody(), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.complex_numbers, - content: InheritedOther( - otherState: OtherState(), - child: InheritedTextControllers( - textControllers: [ - realController, - imaginaryController, - ], - child: const ComplexNumberOtherBody(), - ), - ), - ), - ]; - - @override - void dispose() { - for (final controller in matrixControllers) { - controller.dispose(); - } - - realController.dispose(); - imaginaryController.dispose(); - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return EquationScaffold.navigation( - navigationItems: cachedItems, - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/complex_numbers/complex_analyzer_input.dart b/example/flutter_example/lib/routes/other_page/complex_numbers/complex_analyzer_input.dart deleted file mode 100644 index d8baaed3..00000000 --- a/example/flutter_example/lib/routes/other_page/complex_numbers/complex_analyzer_input.dart +++ /dev/null @@ -1,112 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_input.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; - -/// A wrapper of [ComplexNumberInput] with two buttons: -/// -/// - one for analyzing the complex number; -/// - one for clearing the state and the page. -class ComplexAnalyzerInput extends StatefulWidget { - /// Creates a [ComplexAnalyzerInput] widget. - const ComplexAnalyzerInput({super.key}); - - @override - State createState() => _ComplexAnalyzerInputState(); -} - -class _ComplexAnalyzerInputState extends State { - /// Form validation key. - final formKey = GlobalKey(); - - /// The [TextEditingController] that controls the real part. - TextEditingController get realController => context.textControllers.first; - - /// The [TextEditingController] that controls the imaginary part. - TextEditingController get imaginaryController => context.textControllers[1]; - - /// Form and results cleanup. - void cleanInput() { - realController.clear(); - imaginaryController.clear(); - - context.otherState.clear(); - FocusScope.of(context).unfocus(); - } - - /// Analyzes the complex number. - void complexAnalyze() { - if (formKey.currentState?.validate() ?? false) { - context.otherState.complexAnalyze( - realPart: realController.text, - imaginaryPart: imaginaryController.text, - ); - } else { - ScaffoldMessenger.of(context).showSnackBar( - SnackBar( - content: Text(context.l10n.invalid_values), - duration: const Duration(seconds: 2), - ), - ); - } - } - - @override - Widget build(BuildContext context) { - return FocusTraversalGroup( - child: Form( - key: formKey, - child: Column( - children: [ - // Some spacing - const SizedBox( - height: 60, - ), - - // Complex number input - ComplexNumberInput( - realController: realController, - imaginaryController: imaginaryController, - ), - - // Some spacing - const SizedBox( - height: 30, - ), - - // Two buttons needed to "solve" and "clear" the system - Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Solving the equation - ElevatedButton( - key: const Key('ComplexAnalyze-button-analyze'), - onPressed: complexAnalyze, - child: Text(context.l10n.analyze), - ), - - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 16, - ), - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - - // Cleaning the inputs - ElevatedButton( - key: const Key('ComplexAnalyze-button-clean'), - onPressed: cleanInput, - child: Text(context.l10n.clean), - ), - ], - ), - ], - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/complex_numbers/complex_number_analyzer_results.dart b/example/flutter_example/lib/routes/other_page/complex_numbers/complex_number_analyzer_results.dart deleted file mode 100644 index 41fde4d0..00000000 --- a/example/flutter_example/lib/routes/other_page/complex_numbers/complex_number_analyzer_results.dart +++ /dev/null @@ -1,155 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// This widget shows the complex number analysis results produced by an -/// [OtherState] class. -class ComplexNumberAnalyzerResult extends StatelessWidget { - /// Creates a [ComplexNumberAnalyzerResult] widget. - const ComplexNumberAnalyzerResult({super.key}); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.otherState, - builder: (context, _) { - final result = context.otherState.state.results; - - if (result != null && result is ComplexResultWrapper) { - return Padding( - padding: const EdgeInsets.symmetric( - vertical: 40, - ), - child: _Results( - abs: result.abs, - conjugate: result.conjugate, - phase: result.phase, - polarComplex: result.polarComplex, - reciprocal: result.reciprocal, - sqrt: result.sqrt, - ), - ); - } - - return const SizedBox.shrink(); - }, - ); - } -} - -/// The complex number analysis results. -class _Results extends StatelessWidget { - /// The polar representation of the complex number. - final PolarComplex polarComplex; - - /// The complex conjugate. - final Complex conjugate; - - /// The complex reciprocal. - final Complex reciprocal; - - /// The modulus/absolute value. - final double abs; - - /// The square root of the complex number. - final Complex sqrt; - - /// The phase. - final double phase; - - /// Creates an [_Results] object.. - const _Results({ - required this.polarComplex, - required this.conjugate, - required this.reciprocal, - required this.abs, - required this.sqrt, - required this.phase, - }); - - @override - Widget build(BuildContext context) { - // Properties - final propertiesWidget = FocusTraversalGroup( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - SectionTitle( - pageTitle: context.l10n.properties, - icon: const SquareRoot(), - ), - RealResultCard( - value: abs, - leading: '${context.l10n.abs}: ', - ), - RealResultCard( - value: phase, - leading: '${context.l10n.phase}: ', - ), - ComplexResultCard( - value: sqrt, - leading: '${context.l10n.sqrt}: ', - ), - ComplexResultCard( - value: conjugate, - leading: '${context.l10n.conjugate}: ', - ), - ComplexResultCard( - value: reciprocal, - leading: '${context.l10n.reciprocal}: ', - ), - ], - ), - ); - - // Polar coordinates - final coordinatesWidget = FocusTraversalGroup( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - SectionTitle( - pageTitle: context.l10n.polar_coordinates, - icon: const HalfRightAngle(), - ), - RealResultCard( - value: polarComplex.r, - leading: '${context.l10n.length}: ', - ), - RealResultCard( - value: polarComplex.phiDegrees, - leading: '${context.l10n.angle_deg}: ', - ), - RealResultCard( - value: polarComplex.phiRadians, - leading: '${context.l10n.angle_rad}: ', - ), - ], - ), - ); - - return Wrap( - spacing: 40, - runSpacing: 40, - alignment: WrapAlignment.center, - runAlignment: WrapAlignment.spaceAround, - children: [ - SizedBox( - width: complexNumbersPageColumnWidth, - child: propertiesWidget, - ), - SizedBox( - width: complexNumbersPageColumnWidth, - child: coordinatesWidget, - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/complex_numbers/complex_number_input.dart b/example/flutter_example/lib/routes/other_page/complex_numbers/complex_number_input.dart deleted file mode 100644 index db8c3977..00000000 --- a/example/flutter_example/lib/routes/other_page/complex_numbers/complex_number_input.dart +++ /dev/null @@ -1,118 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// This widget allows for the insertion of the real and the imaginary part of -/// the complex number to be analyzed. -class ComplexNumberInput extends StatefulWidget { - /// The [TextEditingController] controller for the real part. - final TextEditingController realController; - - /// The [TextEditingController] controller for the imaginary part. - final TextEditingController imaginaryController; - - /// Whether the input should be in read-only mode or not. - /// - /// By default, this is set to `false`. - final bool isReadOnly; - - /// Creates a [ComplexNumberInput] widget. - const ComplexNumberInput({ - required this.realController, - required this.imaginaryController, - this.isReadOnly = false, - super.key, - }); - - @override - State createState() => _ComplexNumberInputState(); -} - -class _ComplexNumberInputState extends State { - String? _validationLogic(String? value) { - // Only numbers are allowed, no unknowns like 'x' or 'y' - if (value != null) { - if (!value.isNumericalExpression) { - return context.l10n.wrong_input; - } - } - - return null; - } - - /// The decoration of the [TextFormField]s needed to receive the real and - /// imaginary part. - InputDecoration get decoration { - return const InputDecoration( - border: OutlineInputBorder( - borderRadius: BorderRadius.all( - Radius.circular(5), - ), - ), - contentPadding: EdgeInsets.symmetric( - horizontal: 3, - ), - ); - } - - @override - Widget build(BuildContext context) { - return Row( - mainAxisSize: MainAxisSize.min, - children: [ - // Real part - SizedBox( - width: complexInputWidth, - child: TextFormField( - key: const Key('ComplexNumberInput-TextFormField-RealPart'), - controller: widget.realController, - textAlign: TextAlign.center, - decoration: decoration, - validator: _validationLogic, - readOnly: widget.isReadOnly, - ), - ), - - // The sign - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 15, - ), - child: Text( - '+', - style: TextStyle( - fontSize: 16, - ), - ), - ), - - // Imaginary part - SizedBox( - width: complexInputWidth, - child: TextFormField( - key: const Key('ComplexNumberInput-TextFormField-ImaginaryPart'), - controller: widget.imaginaryController, - textAlign: TextAlign.center, - decoration: decoration, - validator: _validationLogic, - readOnly: widget.isReadOnly, - ), - ), - - // The symbol of the imaginary unit - const Padding( - padding: EdgeInsets.only( - left: 5, - ), - child: Text( - 'i', - style: TextStyle( - fontSize: 16, - ), - ), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/complex_numbers_body.dart b/example/flutter_example/lib/routes/other_page/complex_numbers_body.dart deleted file mode 100644 index 1892d4c5..00000000 --- a/example/flutter_example/lib/routes/other_page/complex_numbers_body.dart +++ /dev/null @@ -1,67 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_analyzer_input.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_analyzer_results.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// This widget analyzes a complex number and computes various properties, such -/// as modulus, polar coordinates and more. -class ComplexNumberOtherBody extends StatelessWidget { - /// Creates a [ComplexNumberOtherBody] widget. - const ComplexNumberOtherBody({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return const Stack( - children: [ - // Scrollable contents of the page - Positioned.fill( - child: _PageBody(), - ), - - // "Go back" button - Positioned( - top: 20, - left: 20, - child: GoBackButton(), - ), - ], - ); - } -} - -/// The actual contents of the [ComplexNumberOtherBody] widget. -class _PageBody extends StatefulWidget { - /// Creates a [_PageBody] widget. - const _PageBody(); - - @override - State<_PageBody> createState() => _PageBodyState(); -} - -class _PageBodyState extends State<_PageBody> { - /// Manually caching the page title. - late final Widget pageTitleWidget = PageTitle( - pageTitle: context.l10n.complex_numbers, - pageLogo: const OtherComplexNumbers(), - ); - - @override - Widget build(BuildContext context) { - return ListView( - children: [ - pageTitleWidget, - - // Data input - const ComplexAnalyzerInput(), - - // Results - const ComplexNumberAnalyzerResult(), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/matrix/matrix_analyze_results.dart b/example/flutter_example/lib/routes/other_page/matrix/matrix_analyze_results.dart deleted file mode 100644 index fca1b1e5..00000000 --- a/example/flutter_example/lib/routes/other_page/matrix/matrix_analyze_results.dart +++ /dev/null @@ -1,252 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_output.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/result_cards/bool_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/polynomial_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// This widget shows the matrix analysis results. The state is stored in an -/// [OtherState] object. -class MatrixAnalyzerResults extends StatelessWidget { - /// Creates a [MatrixAnalyzerResults] widget. - const MatrixAnalyzerResults({super.key}); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.otherState, - builder: (context, _) { - final result = context.otherState.state.results; - - if (result != null && result is MatrixResultWrapper) { - return Padding( - padding: const EdgeInsets.symmetric( - vertical: 40, - ), - child: _Results( - transpose: result.transpose, - cofactorMatrix: result.cofactorMatrix, - inverse: result.inverse, - trace: result.trace, - rank: result.rank, - characteristicPolynomial: result.characteristicPolynomial, - eigenvalues: result.eigenvalues, - determinant: result.determinant, - isSymmetric: result.isSymmetric, - isDiagonal: result.isDiagonal, - isIdentity: result.isIdentity, - ), - ); - } - - return const SizedBox.shrink(); - }, - ); - } -} - -/// The matrix analysis results. -class _Results extends StatelessWidget { - /// The transposed matrix. - final RealMatrix transpose; - - /// The cofactor matrix. - final RealMatrix cofactorMatrix; - - /// The inverse matrix. - final RealMatrix inverse; - - /// The trace of the matrix. - final double trace; - - /// The rank of the matrix. - final int rank; - - /// The characteristic polynomial of the matrix. - final Algebraic characteristicPolynomial; - - /// The eigenvalues of the matrix. - final List eigenvalues; - - /// The determinant of the matrix. - final double determinant; - - /// Whether the matrix is diagonal or not. - final bool isDiagonal; - - /// Whether the matrix is symmetric or not. - final bool isSymmetric; - - /// Whether it's an identity matrix or not. - final bool isIdentity; - - /// Creates a [_Results] widget. - const _Results({ - required this.transpose, - required this.cofactorMatrix, - required this.inverse, - required this.trace, - required this.rank, - required this.characteristicPolynomial, - required this.eigenvalues, - required this.determinant, - required this.isDiagonal, - required this.isSymmetric, - required this.isIdentity, - }); - - @override - Widget build(BuildContext context) { - // Numerical properties - final propertiesWidget = FocusTraversalGroup( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // Properties - SectionTitle( - pageTitle: context.l10n.properties, - icon: const Atoms(), - ), - - RealResultCard( - value: rank * 1.0, - leading: '${context.l10n.rank}: ', - ), - - RealResultCard( - value: trace, - leading: '${context.l10n.trace}: ', - ), - - RealResultCard( - value: determinant, - leading: '${context.l10n.determinant}: ', - ), - - BoolResultCard( - value: isDiagonal, - leading: '${context.l10n.diagonal}: ', - ), - - BoolResultCard( - value: isSymmetric, - leading: '${context.l10n.symmetric}: ', - ), - - BoolResultCard( - value: isIdentity, - leading: '${context.l10n.identity}: ', - ), - ], - ), - ); - - // Eigenvalues and characteristic polynomial - final eigenvaluesWidget = FocusTraversalGroup( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - SectionTitle( - pageTitle: context.l10n.characteristicPolynomial, - icon: const PolynomialLogo(), - ), - PolynomialResultCard( - algebraic: characteristicPolynomial, - ), - - // Spacing - const SizedBox( - height: 40, - ), - - SectionTitle( - pageTitle: context.l10n.eigenvalues, - icon: const EquationSolution(), - ), - - ...[ - for (final eigenvalue in eigenvalues) - ComplexResultCard( - value: eigenvalue, - leading: 'x = ', - ), - ], - ], - ), - ); - - // Operations on the matrix - final matricesWidget = FocusTraversalGroup( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - SectionTitle( - pageTitle: context.l10n.matrices, - icon: const SquareMatrix(), - ), - - // Spacing - const SizedBox( - height: 20, - ), - - MatrixOutput( - matrix: transpose, - description: context.l10n.transpose, - ), - - // Spacing - const SizedBox( - height: 20, - ), - - MatrixOutput( - matrix: inverse, - description: context.l10n.inverse, - ), - - // Spacing - const SizedBox( - height: 20, - ), - - MatrixOutput( - key: const Key('MatrixAnalyzerResults-cofactor-matrix'), - matrix: cofactorMatrix, - description: context.l10n.cofactor, - ), - ], - ), - ); - - return Wrap( - spacing: 40, - runSpacing: 40, - alignment: WrapAlignment.center, - runAlignment: WrapAlignment.spaceAround, - children: [ - SizedBox( - width: matricesPageColumnWidth, - child: propertiesWidget, - ), - SizedBox( - width: matricesPageColumnWidth, - child: eigenvaluesWidget, - ), - SizedBox( - width: matricesPageColumnWidth, - child: matricesWidget, - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/matrix/matrix_analyzer_input.dart b/example/flutter_example/lib/routes/other_page/matrix/matrix_analyzer_input.dart deleted file mode 100644 index ae3e2768..00000000 --- a/example/flutter_example/lib/routes/other_page/matrix/matrix_analyzer_input.dart +++ /dev/null @@ -1,135 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/system_page/utils/matrix_input.dart'; -import 'package:equations_solver/routes/system_page/utils/size_picker.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; - -/// Contains the [MatrixInput] widget that parses the matrix to analyze. -class MatrixAnalyzerInput extends StatefulWidget { - /// Creates a [MatrixAnalyzerInput] widget. - const MatrixAnalyzerInput({super.key}); - - @override - State createState() => _MatrixAnalyzerInputState(); -} - -class _MatrixAnalyzerInputState extends State { - /// Form validation key. - final formKey = GlobalKey(); - - /// Form and results cleanup. - void cleanInput() { - for (final controller in context.textControllers) { - controller.clear(); - } - - context.otherState.clear(); - FocusScope.of(context).unfocus(); - } - - /// Analyzes the matrix. - void matrixAnalyze() { - if (formKey.currentState?.validate() ?? false) { - final size = context.numberSwitcherState.state; - - // Getting the inputs - final matrixInputs = context.textControllers - .sublist(0, size * size) - .map((c) => c.text) - .toList(growable: false); - - // Analyze the input - context.otherState.matrixAnalyze( - matrix: matrixInputs, - size: size, - ); - } else { - ScaffoldMessenger.of(context).showSnackBar( - SnackBar( - content: Text(context.l10n.invalid_values), - duration: const Duration(seconds: 2), - ), - ); - } - } - - @override - Widget build(BuildContext context) { - return FocusTraversalGroup( - child: Form( - key: formKey, - child: Column( - children: [ - // Some spacing - const SizedBox( - height: 60, - ), - - // Size changer - const SizePicker( - isInOtherPage: true, - ), - - // Some spacing - const SizedBox( - height: 35, - ), - - // Matrix input - ListenableBuilder( - listenable: context.numberSwitcherState, - builder: (context, _) { - return MatrixInput( - matrixControllers: context.textControllers, - matrixSize: context.numberSwitcherState.state, - ); - }, - ), - - // Some spacing - const SizedBox( - height: 30, - ), - - // Two buttons needed to "solve" and "clear" the system - Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Solving the equation - ElevatedButton( - key: const Key('MatrixAnalyze-button-analyze'), - onPressed: matrixAnalyze, - child: Text(context.l10n.analyze), - ), - - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 16, - ), - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - - // Cleaning the inputs - ElevatedButton( - key: const Key('MatrixAnalyze-button-clean'), - onPressed: cleanInput, - child: Text(context.l10n.clean), - ), - ], - ), - - // Some spacing - const SizedBox( - height: 30, - ), - ], - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/matrix/matrix_output.dart b/example/flutter_example/lib/routes/other_page/matrix/matrix_output.dart deleted file mode 100644 index c3a30c26..00000000 --- a/example/flutter_example/lib/routes/other_page/matrix/matrix_output.dart +++ /dev/null @@ -1,134 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// Creates an NxN square matrix whose entries are [SystemInputField] widgets. -class MatrixOutput extends StatefulWidget { - /// The matrix to be printed. - final RealMatrix matrix; - - /// The matrix description. - final String description; - - /// The precision to use when printing the value. This parameter is passed to - /// the `toStringAsPrecision(double)` method. - /// - /// By default, this is set to 2. - final int decimalDigits; - - /// Creates a [MatrixOutput] widget. - const MatrixOutput({ - required this.matrix, - required this.description, - this.decimalDigits = 2, - super.key, - }); - - @override - State createState() => _MatrixOutputState(); -} - -class _MatrixOutputState extends State { - /// Caching the [Text] widget containing the matrix description. - late final description = Text( - widget.description, - style: const TextStyle( - fontSize: 16, - color: Colors.blueGrey, - ), - maxLines: 1, - overflow: TextOverflow.ellipsis, - ); - - /// The controllers of each [SystemInputField]. - final controllers = List.generate( - 16, - (_) => TextEditingController(), - ); - - /// The [Table] widget representing the matrix. - late Table table = Table( - children: _tableChildren(), - ); - - /// Builds the [TableRow] widgets for the matrix values input. - List _tableChildren() { - return List.generate( - widget.matrix.rowCount, - _createTableRow, - growable: false, - ); - } - - /// Builds the row output of the table. - TableRow _createTableRow(int rowIndex) { - return TableRow( - children: List.generate( - widget.matrix.columnCount, - (index) { - final value = widget.matrix(rowIndex, index); - controllers[index].text = value.toStringAsFixed(widget.decimalDigits); - - return Padding( - padding: const EdgeInsets.all(5), - child: SystemInputField( - controller: controllers[index], - isReadOnly: true, - ), - ); - }, - growable: false, - ), - ); - } - - @override - void didUpdateWidget(covariant MatrixOutput oldWidget) { - super.didUpdateWidget(oldWidget); - - if (widget.matrix != oldWidget.matrix) { - table = Table( - children: _tableChildren(), - ); - } - } - - @override - void dispose() { - for (final controller in controllers) { - controller.dispose(); - } - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.symmetric( - horizontal: 15, - ), - child: Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // The description - description, - - // Some spacing - const SizedBox( - height: 10, - ), - - // The matrix - SizedBox( - width: widget.matrix.rowCount * matrixOutputWidth, - child: table, - ), - ], - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/matrix_body.dart b/example/flutter_example/lib/routes/other_page/matrix_body.dart deleted file mode 100644 index a4c867da..00000000 --- a/example/flutter_example/lib/routes/other_page/matrix_body.dart +++ /dev/null @@ -1,67 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_analyze_results.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_analyzer_input.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// This widget analyzes a matrix and computes various properties such as rank, -/// eigenvalues, inverse and much more. -class MatrixOtherBody extends StatelessWidget { - /// Creates a [MatrixOtherBody] widget. - const MatrixOtherBody({super.key}); - - @override - Widget build(BuildContext context) { - return const Stack( - children: [ - // Scrollable contents of the page - Positioned.fill( - child: _PageBody(), - ), - - // "Go back" button - Positioned( - top: 20, - left: 20, - child: GoBackButton(), - ), - ], - ); - } -} - -/// The actual contents of the [MatrixOtherBody] widget. -class _PageBody extends StatefulWidget { - /// Creates a [_PageBody] widget. - const _PageBody(); - - @override - State<_PageBody> createState() => _PageBodyState(); -} - -class _PageBodyState extends State<_PageBody> { - /// Manually caching the page title. - late final Widget pageTitleWidget = PageTitle( - pageTitle: context.l10n.matrices, - pageLogo: const OtherMatrix( - size: 50, - ), - ); - - @override - Widget build(BuildContext context) { - return ListView( - children: [ - pageTitleWidget, - - // Data input - const MatrixAnalyzerInput(), - - // Results - const MatrixAnalyzerResults(), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/model/analyzer/analyzer.dart b/example/flutter_example/lib/routes/other_page/model/analyzer/analyzer.dart deleted file mode 100644 index 52d8917a..00000000 --- a/example/flutter_example/lib/routes/other_page/model/analyzer/analyzer.dart +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/result_wrapper.dart'; - -/// Analyzes a certain data type and returns a series of results. -abstract base class Analyzer { - /// This is required to parse the coefficients received from the user as 'raw' - /// strings. - static const _parser = ExpressionParser(); - - /// Creates an [Analyzer] instance. - const Analyzer(); - - /// Converts a list of [String] into a list of [double]. - /// - /// Throws if one or more strings don't represent a valid fraction or number. - List valuesParser(List source) { - return source.map(_parser.evaluate).toList(growable: false); - } - - /// Converts a [String] into a [double]. - /// - /// Throws if the string doesn't represent a valid fraction or number. - double valueParser(String source) => _parser.evaluate(source); - - /// Processes data and returns the result [T] of the analysis. - T process(); -} diff --git a/example/flutter_example/lib/routes/other_page/model/analyzer/analyzers/complex_analyzer.dart b/example/flutter_example/lib/routes/other_page/model/analyzer/analyzers/complex_analyzer.dart deleted file mode 100644 index c90cd4cb..00000000 --- a/example/flutter_example/lib/routes/other_page/model/analyzer/analyzers/complex_analyzer.dart +++ /dev/null @@ -1,41 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/analyzer.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart'; - -/// Analyzes a complex number and computes various values: -/// -/// - the module -/// - the conjugate -/// - the phase -/// - the reciprocal -/// - the square root -/// - the polar coordinates conversion -final class ComplexNumberAnalyzer extends Analyzer { - /// Real part of the complex number. - final String realPart; - - /// Imaginary part of the complex number. - final String imaginaryPart; - - /// Creates a [ComplexNumberAnalyzer] object. - const ComplexNumberAnalyzer({ - required this.realPart, - required this.imaginaryPart, - }); - - @override - ComplexResultWrapper process() { - final real = valueParser(realPart); - final imaginary = valueParser(imaginaryPart); - final complex = Complex(real, imaginary); - - return ComplexResultWrapper( - abs: complex.abs(), - conjugate: complex.conjugate(), - phase: complex.phase(), - reciprocal: complex.reciprocal(), - sqrt: complex.sqrt(), - polarComplex: complex.toPolarCoordinates(), - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/model/analyzer/analyzers/matrix_analyzer.dart b/example/flutter_example/lib/routes/other_page/model/analyzer/analyzers/matrix_analyzer.dart deleted file mode 100644 index 30120445..00000000 --- a/example/flutter_example/lib/routes/other_page/model/analyzer/analyzers/matrix_analyzer.dart +++ /dev/null @@ -1,53 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/analyzer.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart'; - -/// Analyzes a matrix and computes various values: -/// -/// - the transposed matrix -/// - the cofactor matrix -/// - the inverse matrix -/// - the trace -/// - the rank -/// - the characteristic polynomial -/// - the eigenvalues -/// - the determinant -/// - whether it's diagonal or not -/// - whether it's symmetric or not -/// - whether it's identity or not -final class MatrixDataAnalyzer extends Analyzer { - /// The matrix size. - final int size; - - /// The flattened representation of the matrix. - final List flatMatrix; - - /// Creates a [MatrixDataAnalyzer] object. - const MatrixDataAnalyzer({ - required this.size, - required this.flatMatrix, - }); - - @override - MatrixResultWrapper process() { - final matrix = RealMatrix.fromFlattenedData( - rows: size, - columns: size, - data: valuesParser(flatMatrix), - ); - - return MatrixResultWrapper( - transpose: matrix.transpose(), - cofactorMatrix: matrix.cofactorMatrix(), - inverse: matrix.inverse(), - trace: matrix.trace(), - rank: matrix.rank(), - characteristicPolynomial: matrix.characteristicPolynomial(), - eigenvalues: matrix.eigenvalues(), - determinant: matrix.determinant(), - isDiagonal: matrix.isDiagonal(), - isSymmetric: matrix.isSymmetric(), - isIdentity: matrix.isIdentity(), - ); - } -} diff --git a/example/flutter_example/lib/routes/other_page/model/analyzer/result_wrapper.dart b/example/flutter_example/lib/routes/other_page/model/analyzer/result_wrapper.dart deleted file mode 100644 index 5ea1e0c7..00000000 --- a/example/flutter_example/lib/routes/other_page/model/analyzer/result_wrapper.dart +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart'; - -/// Interface type for classes that wrap a series of values. There currently are -/// two implementers are: -/// -/// - [MatrixResultWrapper] -/// - [ComplexResultWrapper] -abstract interface class ResultWrapper {} diff --git a/example/flutter_example/lib/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart b/example/flutter_example/lib/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart deleted file mode 100644 index 87dad01d..00000000 --- a/example/flutter_example/lib/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/result_wrapper.dart'; - -/// Wrapper that holds a series of data about a [Complex] value. -final class ComplexResultWrapper implements ResultWrapper { - /// The polar representation of the complex number. - final PolarComplex polarComplex; - - /// The complex conjugate. - final Complex conjugate; - - /// The complex reciprocal. - final Complex reciprocal; - - /// The modulus/aboslute value. - final double abs; - - /// The square root of the complex number. - final Complex sqrt; - - /// The phase. - final double phase; - - /// Creates an [ComplexResultWrapper] object.. - const ComplexResultWrapper({ - required this.polarComplex, - required this.conjugate, - required this.reciprocal, - required this.abs, - required this.sqrt, - required this.phase, - }); -} diff --git a/example/flutter_example/lib/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart b/example/flutter_example/lib/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart deleted file mode 100644 index dbe69534..00000000 --- a/example/flutter_example/lib/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart +++ /dev/null @@ -1,53 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/result_wrapper.dart'; - -/// Wrapper that holds a series of data about a [RealMatrix]. -final class MatrixResultWrapper implements ResultWrapper { - /// The transposed matrix. - final RealMatrix transpose; - - /// The cofactor matrix. - final RealMatrix cofactorMatrix; - - /// The inverse matrix. - final RealMatrix inverse; - - /// The trace of the matrix. - final double trace; - - /// The rank of the matrix. - final int rank; - - /// The characteristic polynomial of the matrix. - final Algebraic characteristicPolynomial; - - /// The eigenvalues of the matrix. - final List eigenvalues; - - /// The determinant of the matrix. - final double determinant; - - /// Whether the matrix is diagonal or not. - final bool isDiagonal; - - /// Whether the matrix is symmetric or not. - final bool isSymmetric; - - /// Whether it's an identity matrix or not. - final bool isIdentity; - - /// Creates an [MatrixResultWrapper] object. - const MatrixResultWrapper({ - required this.transpose, - required this.cofactorMatrix, - required this.inverse, - required this.trace, - required this.rank, - required this.characteristicPolynomial, - required this.eigenvalues, - required this.determinant, - required this.isDiagonal, - required this.isSymmetric, - required this.isIdentity, - }); -} diff --git a/example/flutter_example/lib/routes/other_page/model/inherited_other.dart b/example/flutter_example/lib/routes/other_page/model/inherited_other.dart deleted file mode 100644 index 4713b94e..00000000 --- a/example/flutter_example/lib/routes/other_page/model/inherited_other.dart +++ /dev/null @@ -1,36 +0,0 @@ -import 'package:equations_solver/routes/other_page.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes an [OtherState] object. -class InheritedOther extends InheritedWidget { - /// The state of the [OtherPage] page. - final OtherState otherState; - - /// Creates an [InheritedWidget] that exposes a [InheritedOther] object. - const InheritedOther({ - required this.otherState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedOther] instance up in the tree. - static InheritedOther of(BuildContext context) { - final ref = context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedOther' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedOther oldWidget) { - return otherState != oldWidget.otherState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -///[OtherState] up in the tree using [InheritedOther]. -extension InheritedOtherExt on BuildContext { - /// Uses [InheritedOther] to retrieve a [OtherState] object. - OtherState get otherState => InheritedOther.of(this).otherState; -} diff --git a/example/flutter_example/lib/routes/other_page/model/other_result.dart b/example/flutter_example/lib/routes/other_page/model/other_result.dart deleted file mode 100644 index 6686e7a7..00000000 --- a/example/flutter_example/lib/routes/other_page/model/other_result.dart +++ /dev/null @@ -1,31 +0,0 @@ -import 'package:equations_solver/routes/other_page/model/analyzer/result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; - -/// Wrapper class that holds the [ResultWrapper] type computed by [OtherState]. -class OtherResult { - /// The [ResultWrapper] object holding the data. - /// - /// When `null`, it means that there has been a computational error. - final ResultWrapper? results; - - /// Creates a [OtherResult] object. - const OtherResult({ - this.results, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is OtherResult) { - return runtimeType == other.runtimeType && results == other.results; - } else { - return false; - } - } - - @override - int get hashCode => results.hashCode; -} diff --git a/example/flutter_example/lib/routes/other_page/model/other_state.dart b/example/flutter_example/lib/routes/other_page/model/other_state.dart deleted file mode 100644 index ba57359a..00000000 --- a/example/flutter_example/lib/routes/other_page/model/other_state.dart +++ /dev/null @@ -1,61 +0,0 @@ -import 'package:equations_solver/routes/other_page.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/analyzers/complex_analyzer.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/analyzers/matrix_analyzer.dart'; -import 'package:equations_solver/routes/other_page/model/other_result.dart'; -import 'package:flutter/widgets.dart'; - -/// Holds the state of the [OtherPage] page. -class OtherState extends ChangeNotifier { - var _state = const OtherResult(); - - /// The current state. - OtherResult get state => _state; - - /// Analyzes a matrix from a series of [String] coefficients. - void matrixAnalyze({ - required List matrix, - required int size, - }) { - try { - final resultWrapper = MatrixDataAnalyzer( - flatMatrix: matrix, - size: size, - ).process(); - - _state = OtherResult( - results: resultWrapper, - ); - } on Exception { - _state = const OtherResult(); - } - - notifyListeners(); - } - - /// Parses the complex number and analyzes it. - void complexAnalyze({ - required String realPart, - required String imaginaryPart, - }) { - try { - final resultWrapper = ComplexNumberAnalyzer( - realPart: realPart, - imaginaryPart: imaginaryPart, - ).process(); - - _state = OtherResult( - results: resultWrapper, - ); - } on Exception { - _state = const OtherResult(); - } - - notifyListeners(); - } - - /// Clears the state. - void clear() { - _state = const OtherResult(); - notifyListeners(); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page.dart b/example/flutter_example/lib/routes/polynomial_page.dart deleted file mode 100644 index 5be5c895..00000000 --- a/example/flutter_example/lib/routes/polynomial_page.dart +++ /dev/null @@ -1,174 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_body.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:flutter/material.dart'; - -/// This page contains a series of polynomial equations solvers. There are 4 -/// tabs dedicated to particular polynomial equations: -/// -/// - Linear -/// - Quadratic -/// - Cubic -/// - Quartic -/// -/// Each tab also has a [EquationDrawerWidget] that draws the function in a -/// cartesian plane. -class PolynomialPage extends StatefulWidget { - /// Creates a [PolynomialPage] widget. - const PolynomialPage({super.key}); - - @override - State createState() => _PolynomialPageState(); -} - -class _PolynomialPageState extends State { - /* - * These controllers are exposed to the subtree with [InheritedTextController] - * because the scaffold uses tabs and when swiping, the controllers get - * disposed. - * - * In order to keep the controllers alive (and thus persist the text), we need - * to save theme here, which is ABOVE the tabs. - */ - - final linearControllers = [ - TextEditingController(), - TextEditingController(), - ]; - - final quadraticControllers = [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ]; - - final cubicControllers = [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ]; - - final quarticControllers = [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ]; - - /// Caching navigation items since they'll never change. - late final cachedItems = [ - NavigationItem( - title: context.l10n.firstDegree, - content: InheritedPolynomial( - polynomialState: PolynomialState( - PolynomialType.linear, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedTextControllers( - textControllers: linearControllers, - child: const PolynomialBody(), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.secondDegree, - content: InheritedPolynomial( - polynomialState: PolynomialState( - PolynomialType.quadratic, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedTextControllers( - textControllers: quadraticControllers, - child: const PolynomialBody(), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.thirdDegree, - content: InheritedPolynomial( - polynomialState: PolynomialState( - PolynomialType.cubic, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedTextControllers( - textControllers: cubicControllers, - child: const PolynomialBody(), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.fourthDegree, - content: InheritedPolynomial( - polynomialState: PolynomialState( - PolynomialType.quartic, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedTextControllers( - textControllers: quarticControllers, - child: const PolynomialBody(), - ), - ), - ), - ), - ]; - - @override - void dispose() { - for (final controller in linearControllers) { - controller.dispose(); - } - - for (final controller in quadraticControllers) { - controller.dispose(); - } - - for (final controller in cubicControllers) { - controller.dispose(); - } - - for (final controller in quarticControllers) { - controller.dispose(); - } - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return EquationScaffold.navigation( - navigationItems: cachedItems, - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/model/inherited_polynomial.dart b/example/flutter_example/lib/routes/polynomial_page/model/inherited_polynomial.dart deleted file mode 100644 index 8b440b8d..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/model/inherited_polynomial.dart +++ /dev/null @@ -1,37 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [PolynomialState] object. -class InheritedPolynomial extends InheritedWidget { - /// The state of the polynomial page. - final PolynomialState polynomialState; - - /// Creates an [InheritedWidget] that exposes a [PolynomialState] object. - const InheritedPolynomial({ - required this.polynomialState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedPolynomial] instance up in the tree. - static InheritedPolynomial of(BuildContext context) { - final ref = - context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedPolynomial' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedPolynomial oldWidget) { - return polynomialState != oldWidget.polynomialState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -///[PolynomialState] up in the tree using [InheritedPolynomial]. -extension InheritedPolynomialExt on BuildContext { - /// Uses [InheritedPolynomial] to retrieve a [PolynomialState] object. - PolynomialState get polynomialState => - InheritedPolynomial.of(this).polynomialState; -} diff --git a/example/flutter_example/lib/routes/polynomial_page/model/polynomial_result.dart b/example/flutter_example/lib/routes/polynomial_page/model/polynomial_result.dart deleted file mode 100644 index 33fbc363..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/model/polynomial_result.dart +++ /dev/null @@ -1,32 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; - -/// Wrapper class that holds an [Algebraic] object created by [PolynomialState]. -class PolynomialResult { - /// The [Algebraic] object holding the polynomial data. - /// - /// When `null`, it means that there has been an error while computing the - /// roots. - final Algebraic? algebraic; - - /// Creates a [PolynomialResult] object. - const PolynomialResult({ - this.algebraic, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is PolynomialResult) { - return runtimeType == other.runtimeType && algebraic == other.algebraic; - } else { - return false; - } - } - - @override - int get hashCode => algebraic.hashCode; -} diff --git a/example/flutter_example/lib/routes/polynomial_page/model/polynomial_state.dart b/example/flutter_example/lib/routes/polynomial_page/model/polynomial_state.dart deleted file mode 100644 index f06a7162..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/model/polynomial_state.dart +++ /dev/null @@ -1,83 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/polynomial_page.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_result.dart'; -import 'package:flutter/widgets.dart'; - -/// The types of polynomials that can be solved. -enum PolynomialType { - /// A polynomial whose degree is 1. - linear(2), - - /// A polynomial whose degree is 2. - quadratic(3), - - /// A polynomial whose degree is 3. - cubic(4), - - /// A polynomial whose degree is 4. - quartic(5); - - /// How many coefficients the associated polynomial type has. - final int coefficients; - - /// Creates a [PolynomialType] enumeration. - const PolynomialType(this.coefficients); -} - -/// Holds the state of the [PolynomialPage] page. -class PolynomialState extends ChangeNotifier { - var _state = const PolynomialResult(); - - /// The type of polynomial represented by this class. - final PolynomialType polynomialType; - - /// Creates a [PolynomialState] object. - PolynomialState(this.polynomialType); - - /// The current state. - PolynomialResult get state => _state; - - /// Tries to solve a polynomial equation with the given coefficients. - void solvePolynomial(List coefficients) { - try { - // Parsing coefficients - final params = _parseCoefficients(coefficients); - - _state = PolynomialResult( - algebraic: Algebraic.from(params), - ); - } on Exception { - _state = const PolynomialResult(); - } - - notifyListeners(); - } - - /// Clears the state. - void clear() { - _state = const PolynomialResult(); - notifyListeners(); - } - - /// Converts a list of strings into a list of numbers, if possible. - List _parseCoefficients(List rawInput) { - if (rawInput.length != polynomialType.coefficients) { - throw const FormatException( - "The coefficients list length doesn't match the coefficients number " - 'expected from the given degree.', - ); - } - - // Fractions are accepted so this method throws only if the given string is - // NOT a number or a string - const parser = ExpressionParser(); - - return rawInput.map((value) { - if (!value.isNumericalExpression) { - throw FormatException('The "$value" input is not a valid number.'); - } - - return Complex.fromReal(parser.evaluate(value)); - }).toList(growable: false); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/polynomial_body.dart b/example/flutter_example/lib/routes/polynomial_page/polynomial_body.dart deleted file mode 100644 index 5c18892a..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/polynomial_body.dart +++ /dev/null @@ -1,151 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/polynomial_data_input.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_results.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_plot_widget.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_title_localizer.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; - -/// This widget is used to solve polynomial equations. It also draws the -/// function in a cartesian plane. -/// -/// This widget is responsive: contents may be laid out on a single column or -/// on two columns according with the available space. -class PolynomialBody extends StatelessWidget { - /// Creates a [PolynomialBody] widget. - const PolynomialBody({super.key}); - - @override - Widget build(BuildContext context) { - return const Stack( - children: [ - // Scrollable contents of the page - Positioned.fill( - child: _ResponsiveBody(), - ), - - // "Go back" button - Positioned( - top: 20, - left: 20, - child: GoBackButton(), - ), - ], - ); - } -} - -/// Determines whether the contents should appear in 1 or 2 columns. -class _ResponsiveBody extends StatelessWidget { - /// Creates a [_ResponsiveBody] widget. - const _ResponsiveBody(); - - @override - Widget build(BuildContext context) { - return FocusTraversalGroup( - child: LayoutBuilder( - builder: (context, size) { - if (size.maxWidth <= doubleColumnPageBreakpoint) { - // For mobile devices - all in a column - return const _SingleColumnLayout(); - } - - // For wider screens - plot on the right and results on the left - return const _DoubleColumnLayout(); - }, - ), - ); - } -} - -/// Lays the page contents on a single column. -class _SingleColumnLayout extends StatelessWidget - with PolynomialTitleLocalizer { - /// Creates a [_SingleColumnLayout] widget. - const _SingleColumnLayout(); - - @override - Widget build(BuildContext context) { - return SingleChildScrollView( - key: const Key('SingleChildScrollView-mobile-responsive'), - child: Column( - children: [ - PageTitle( - pageTitle: getLocalizedName(context), - pageLogo: const PolynomialLogo( - size: 50, - ), - ), - const PolynomialDataInput(), - const PolynomialResults(), - const SizedBox(height: 25), - const PolynomialPlotWidget(), - ], - ), - ); - } -} - -/// Lays the page contents on two columns. -class _DoubleColumnLayout extends StatelessWidget { - /// Creates a [_DoubleColumnLayout] widget. - const _DoubleColumnLayout(); - - @override - Widget build(BuildContext context) { - return const Center( - child: SingleChildScrollView( - key: Key('SingleChildScrollView-desktop-responsive'), - child: Row( - mainAxisAlignment: MainAxisAlignment.spaceAround, - children: [ - // Input and results - Expanded( - child: _DoubleColumnLeftContent(), - ), - - // Plot - Expanded( - child: Padding( - padding: EdgeInsets.symmetric( - horizontal: 15, - ), - child: PolynomialPlotWidget(), - ), - ), - ], - ), - ), - ); - } -} - -/// The left column [_ResponsiveBody] when the viewport is large enough. -class _DoubleColumnLeftContent extends StatelessWidget - with PolynomialTitleLocalizer { - /// Creates a [_DoubleColumnLeftContent] widget. - const _DoubleColumnLeftContent(); - - @override - Widget build(BuildContext context) { - return Center( - child: Column( - children: [ - PageTitle( - pageTitle: getLocalizedName(context), - pageLogo: const PolynomialLogo( - size: 50, - ), - ), - const PolynomialDataInput(), - const PolynomialResults(), - const SizedBox( - height: 40, - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/polynomial_data_input.dart b/example/flutter_example/lib/routes/polynomial_page/polynomial_data_input.dart deleted file mode 100644 index e4e6a125..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/polynomial_data_input.dart +++ /dev/null @@ -1,187 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_input_field.dart'; -import 'package:equations_solver/routes/utils/body_pages/equation_text_formatter.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; - -/// This widget contains a series of [PolynomialInputField] widgets that parse -/// the coefficients of the polynomial equation. -class PolynomialDataInput extends StatelessWidget { - /// Creates a [PolynomialDataInput] widget. - const PolynomialDataInput({super.key}); - - @override - Widget build(BuildContext context) => - switch (context.polynomialState.polynomialType) { - PolynomialType.linear => const _InputWidget( - equationTemplate: 'ax + b', - ), - PolynomialType.quadratic => const _InputWidget( - equationTemplate: 'ax^2 + bx + c', - ), - PolynomialType.cubic => const _InputWidget( - equationTemplate: 'ax^3 + bx^2 + cx + d', - ), - PolynomialType.quartic => const _InputWidget( - equationTemplate: 'ax^4 + bx^3 + cx^2 + dx + e', - ) - }; -} - -/// The actual input container. -class _InputWidget extends StatefulWidget { - /// The 'form' of the equation. This can be, for example, `ax^2 + bx + c` in - /// the case of a quadratic polynomial. - final String equationTemplate; - - /// Creates a [_InputWidget] widget. - const _InputWidget({ - required this.equationTemplate, - }); - - @override - __InputWidget createState() => __InputWidget(); -} - -class __InputWidget extends State<_InputWidget> { - /// This is displayed at the top of the input box. - late final cachedEquationTitle = Padding( - padding: const EdgeInsets.only(bottom: 20), - child: EquationTextFormatter( - equation: widget.equationTemplate, - ), - ); - - /// Form validation key. - final formKey = GlobalKey(); - - /// Validates the input and, if it's valid, sends the data to the state class. - void _processInput() { - if (formKey.currentState?.validate() ?? false) { - // Valid input - context.polynomialState.solvePolynomial( - context.textControllers - .map((c) => c.text) - .toList(growable: false), - ); - } else { - context.polynomialState.clear(); - - // Error message. - ScaffoldMessenger.of(context).showSnackBar( - SnackBar( - content: Text(context.l10n.polynomial_error), - duration: const Duration(seconds: 2), - ), - ); - } - } - - /// Form cleanup. - void _cleanInput() { - formKey.currentState?.reset(); - context.polynomialState.clear(); - context.plotZoomState.reset(); - - for (final controller in context.textControllers) { - controller.clear(); - } - - FocusScope.of(context).unfocus(); - } - - @override - Widget build(BuildContext context) { - return Column( - mainAxisSize: MainAxisSize.min, - mainAxisAlignment: MainAxisAlignment.center, - children: [ - const SizedBox(height: 40), - - cachedEquationTitle, - - // Responsively placing input fields using 'Wrap' - Padding( - padding: const EdgeInsets.only(left: 60, right: 60), - child: Form( - key: formKey, - child: const _InputFieldsWrapWidget(), - ), - ), - - // A "spacer" widget - const SizedBox(height: 40), - - // Two buttons needed to "solve" and "clear" the equation - Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Solving the polynomial - ElevatedButton( - key: const Key('Polynomial-button-solve'), - onPressed: _processInput, - child: Text(context.l10n.solve), - ), - - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 16, - ), - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - - // Cleaning the inputs - ElevatedButton( - key: const Key('Polynomial-button-clean'), - onPressed: _cleanInput, - child: Text(context.l10n.clean), - ), - ], - ), - ], - ); - } -} - -/// Generates the input fields of the coefficients and puts them in a [Wrap]. -class _InputFieldsWrapWidget extends StatelessWidget { - const _InputFieldsWrapWidget(); - - /// Increments by [index] the char code unit to get a specific letter. For - /// example: - /// - /// - [index] = 0 -> 'a' - /// - [index] = 1 -> 'b' - /// - [index] = 2 -> 'c' - /// - [index] = 6 -> 'g' - String placeholderLetter(int index) { - const firstLetter = 'a'; - - return String.fromCharCode(firstLetter.codeUnitAt(0) + index); - } - - @override - Widget build(BuildContext context) { - final controllers = context.textControllers; - - return Wrap( - spacing: 30, - alignment: WrapAlignment.center, - children: [ - for (var i = 0; i < controllers.length; ++i) - PolynomialInputField( - // This key is used for testing purposes - key: Key('PolynomialInputField-coefficient-$i'), - controller: controllers[i], - placeholder: placeholderLetter(i), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/polynomial_input_field.dart b/example/flutter_example/lib/routes/polynomial_page/polynomial_input_field.dart deleted file mode 100644 index 4449969d..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/polynomial_input_field.dart +++ /dev/null @@ -1,52 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// This is just a wrapper of a [TextFormField] that parses and validates the -/// coefficients of a polynomial equation. -class PolynomialInputField extends StatelessWidget { - /// The [TextEditingController] controller. - final TextEditingController controller; - - /// The placeholder text to show in the input field. - final String placeholder; - - /// Creates a [PolynomialInputField] widget. - const PolynomialInputField({ - required this.controller, - required this.placeholder, - super.key, - }); - - String? _validationLogic(String? value, BuildContext context) { - if (value != null) { - if (!value.isNumericalExpression) { - return context.l10n.wrong_input; - } - } - - return null; - } - - @override - Widget build(BuildContext context) { - return SizedBox( - width: polynomialInputFieldWidth, - child: TextFormField( - key: const Key('PolynomialInputField-TextFormField'), - controller: controller, - textAlign: TextAlign.center, - decoration: InputDecoration( - border: const UnderlineInputBorder( - borderSide: BorderSide( - color: Colors.blueAccent, - ), - ), - hintText: placeholder, - ), - validator: (value) => _validationLogic(value, context), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/polynomial_results.dart b/example/flutter_example/lib/routes/polynomial_page/polynomial_results.dart deleted file mode 100644 index c7c4a182..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/polynomial_results.dart +++ /dev/null @@ -1,81 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_discriminant.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The results of the polynomial equations. -class PolynomialResults extends StatelessWidget { - /// Creates a [PolynomialResults] widget. - const PolynomialResults({super.key}); - - @override - Widget build(BuildContext context) { - return Column( - children: [ - // Some spacing - const SizedBox( - height: 80, - ), - - SectionTitle( - pageTitle: context.l10n.solutions, - icon: const EquationSolution(), - ), - - // Showing the solutions of the polynomial - const _PolynomialSolutions(), - - // Separator line - const SizedBox( - height: 80, - ), - - SectionTitle( - pageTitle: context.l10n.discriminant, - icon: const SystemsLogo(), - ), - - // Showing the solutions of the polynomial - const PolynomialDiscriminant( - key: Key('PolynomialDiscriminant'), - ), - ], - ); - } -} - -class _PolynomialSolutions extends StatelessWidget { - const _PolynomialSolutions(); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.polynomialState, - builder: (context, _) { - final algebraic = context.polynomialState.state.algebraic; - - if (algebraic != null) { - final roots = algebraic.solutions(); - - return Column( - mainAxisSize: MainAxisSize.min, - children: [ - for (final root in roots) - ComplexResultCard( - value: root, - leading: 'x = ', - ), - ], - ); - } - - return const NoResults(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/utils/no_discriminant.dart b/example/flutter_example/lib/routes/polynomial_page/utils/no_discriminant.dart deleted file mode 100644 index d29d99b7..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/utils/no_discriminant.dart +++ /dev/null @@ -1,23 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:flutter/material.dart'; - -/// A very simple widget stating that there is no discriminant value to display. -class NoDiscriminant extends StatelessWidget { - /// Creates a [NoDiscriminant] widget. - const NoDiscriminant({super.key}); - - @override - Widget build(BuildContext context) { - return Center( - child: Padding( - padding: const EdgeInsets.fromLTRB(80, 35, 80, 0), - child: Text( - context.l10n.no_discriminant, - style: const TextStyle( - fontSize: 16, - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_discriminant.dart b/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_discriminant.dart deleted file mode 100644 index 5e61bc18..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_discriminant.dart +++ /dev/null @@ -1,29 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/no_discriminant.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; - -/// Shows the discriminant of the polynomial. -class PolynomialDiscriminant extends StatelessWidget { - /// Creates a [PolynomialDiscriminant] widget. - const PolynomialDiscriminant({super.key}); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.polynomialState, - builder: (context, _) { - final algebraic = context.polynomialState.state.algebraic; - - if (algebraic != null) { - return ComplexResultCard( - value: algebraic.discriminant(), - leading: 'D(x) = ', - ); - } - - return const NoDiscriminant(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_plot_widget.dart b/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_plot_widget.dart deleted file mode 100644 index 281ada5c..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_plot_widget.dart +++ /dev/null @@ -1,85 +0,0 @@ -import 'dart:math'; - -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// Wrapper of a [EquationDrawerWidget] widget that paints polynomial equations -/// on the screen. -class PolynomialPlotWidget extends StatelessWidget { - /// Creates a [PolynomialPlotWidget] widget. - const PolynomialPlotWidget({super.key}); - - @override - Widget build(BuildContext context) { - return Center( - child: SingleChildScrollView( - child: Column( - children: [ - // Title - const _PlotTitle(), - - // The actual plot - LayoutBuilder( - builder: (context, dimensions) { - final width = min(dimensions.maxWidth, maxWidthPlot); - - return SizedBox( - width: width, - child: const _PlotWidgetListener(), - ); - }, - ), - ], - ), - ), - ); - } -} - -/// A wrapper of [PageTitle] placed above a [EquationDrawerWidget]. -class _PlotTitle extends StatelessWidget { - /// Creates a [_PlotTitle] widget. - const _PlotTitle(); - - @override - Widget build(BuildContext context) { - return PageTitle( - pageTitle: context.l10n.chart, - pageLogo: const CartesianPlane(), - ); - } -} - -/// A wrapper of [EquationDrawerWidget] that listens to [PolynomialState] to -/// either draw the polynomial or clean the chart. -class _PlotWidgetListener extends StatelessWidget { - /// Creates a [_PlotWidgetListener] widget. - const _PlotWidgetListener(); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.polynomialState, - builder: (context, _) { - final algebraic = context.polynomialState.state.algebraic; - - if (algebraic != null) { - return EquationDrawerWidget( - plotMode: PolynomialEvaluator( - algebraic: algebraic, - ), - ); - } - - return const EquationDrawerWidget(); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_title_localizer.dart b/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_title_localizer.dart deleted file mode 100644 index 6ff7b4b5..00000000 --- a/example/flutter_example/lib/routes/polynomial_page/utils/polynomial_title_localizer.dart +++ /dev/null @@ -1,24 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_body.dart'; -import 'package:flutter/material.dart'; - -/// Mixin for [PolynomialBody] widgets that helps localizing the page title. -mixin PolynomialTitleLocalizer on StatelessWidget { - /// Localizes the title of a polynomial solver tab. - String getLocalizedName(BuildContext context) { - final polynomialType = context.polynomialState.polynomialType; - - switch (polynomialType) { - case PolynomialType.linear: - return context.l10n.firstDegree; - case PolynomialType.quadratic: - return context.l10n.secondDegree; - case PolynomialType.cubic: - return context.l10n.thirdDegree; - case PolynomialType.quartic: - return context.l10n.fourthDegree; - } - } -} diff --git a/example/flutter_example/lib/routes/system_page.dart b/example/flutter_example/lib/routes/system_page.dart deleted file mode 100644 index 822ab153..00000000 --- a/example/flutter_example/lib/routes/system_page.dart +++ /dev/null @@ -1,206 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/system_text_controllers.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_body.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:flutter/material.dart'; - -/// This page contains a series of linear systems solvers. There are 3 tabs -/// to solve various size of systems: -/// -/// - 1x1 systems -/// - 2x2 systems -/// - 3x3 systems -/// - 4x4 systems -/// -/// No complex numbers are allowed. -class SystemPage extends StatefulWidget { - /// Creates a [SystemPage] widget. - const SystemPage({super.key}); - - @override - State createState() => _SystemPageState(); -} - -class _SystemPageState extends State { - /* - * These controllers are exposed to the subtree with [InheritedTextController] - * because the scaffold uses tabs and when swiping, the controllers get - * disposed. - * - * In order to keep the controllers alive (and thus persist the text), we need - * to save theme here, which is ABOVE the tabs. - */ - - final matrixRowReductionControllers = List.generate( - 16, - (_) => TextEditingController(), - growable: false, - ); - - final vectorRowReductionControllers = List.generate( - 4, - (_) => TextEditingController(), - growable: false, - ); - - final matrixFactorizationControllers = List.generate( - 16, - (_) => TextEditingController(), - growable: false, - ); - - final vectorFactorizationControllers = List.generate( - 4, - (_) => TextEditingController(), - growable: false, - ); - - final matrixIterativeControllers = List.generate( - 16, - (_) => TextEditingController(), - growable: false, - ); - - final vectorIterativeControllers = List.generate( - 4, - (_) => TextEditingController(), - growable: false, - ); - - final jacobiControllers = List.generate( - 4, - (_) => TextEditingController(), - growable: false, - ); - - final wSorController = TextEditingController(); - - /// Caching navigation items since they'll never change. - late final cachedItems = [ - NavigationItem( - title: context.l10n.row_reduction, - content: InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier(''), - child: InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: matrixRowReductionControllers, - vectorControllers: vectorRowReductionControllers, - jacobiControllers: jacobiControllers, - wSorController: wSorController, - ), - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 4, - ), - child: const SystemBody(), - ), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.factorization, - content: InheritedSystem( - systemState: SystemState(SystemType.factorization), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - SystemDropdownItems.lu.asString, - ), - child: InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: matrixFactorizationControllers, - vectorControllers: vectorFactorizationControllers, - jacobiControllers: jacobiControllers, - wSorController: wSorController, - ), - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 4, - ), - child: const SystemBody(), - ), - ), - ), - ), - ), - NavigationItem( - title: context.l10n.iterative, - content: InheritedSystem( - systemState: SystemState(SystemType.iterative), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - SystemDropdownItems.sor.asString, - ), - child: InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: matrixIterativeControllers, - vectorControllers: vectorIterativeControllers, - jacobiControllers: jacobiControllers, - wSorController: wSorController, - ), - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 4, - ), - child: const SystemBody(), - ), - ), - ), - ), - ), - ]; - - @override - void dispose() { - for (final controller in matrixRowReductionControllers) { - controller.dispose(); - } - - for (final controller in matrixFactorizationControllers) { - controller.dispose(); - } - - for (final controller in matrixIterativeControllers) { - controller.dispose(); - } - - for (final controller in vectorRowReductionControllers) { - controller.dispose(); - } - - for (final controller in vectorFactorizationControllers) { - controller.dispose(); - } - - for (final controller in vectorIterativeControllers) { - controller.dispose(); - } - - for (final controller in jacobiControllers) { - controller.dispose(); - } - - wSorController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return EquationScaffold.navigation( - navigationItems: cachedItems, - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/model/inherited_system.dart b/example/flutter_example/lib/routes/system_page/model/inherited_system.dart deleted file mode 100644 index e357e083..00000000 --- a/example/flutter_example/lib/routes/system_page/model/inherited_system.dart +++ /dev/null @@ -1,35 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:flutter/widgets.dart'; - -/// An [InheritedWidget] that exposes a [SystemState] object. -class InheritedSystem extends InheritedWidget { - /// The state of the systems page. - final SystemState systemState; - - /// Creates an [InheritedWidget] that exposes a [SystemState] object. - const InheritedSystem({ - required this.systemState, - required super.child, - super.key, - }); - - /// Retrieves the closest [InheritedSystem] instance up in the tree. - static InheritedSystem of(BuildContext context) { - final ref = context.dependOnInheritedWidgetOfExactType(); - assert(ref != null, "No 'InheritedSystem' found above in the tree."); - - return ref!; - } - - @override - bool updateShouldNotify(covariant InheritedSystem oldWidget) { - return systemState != oldWidget.systemState; - } -} - -/// Extension method on [BuildContext] that allows getting a reference to the -///[SystemState] up in the tree using [InheritedSystem]. -extension InheritedSystemExt on BuildContext { - /// Uses [InheritedSystem] to retrieve a [SystemState] object. - SystemState get systemState => InheritedSystem.of(this).systemState; -} diff --git a/example/flutter_example/lib/routes/system_page/model/system_result.dart b/example/flutter_example/lib/routes/system_page/model/system_result.dart deleted file mode 100644 index 503e3be6..00000000 --- a/example/flutter_example/lib/routes/system_page/model/system_result.dart +++ /dev/null @@ -1,40 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; - -/// Wrapper class that holds the [SystemSolver] type computed by [SystemState]. -class SystemResult { - /// The [SystemSolver] object holding the system data. - /// - /// When `null`, it means that there has been an error while computing the - /// solutions. - final SystemSolver? systemSolver; - - /// Whether the matrix is singular or not. - /// - /// By default, this is set to `false`. - final bool isSingular; - - /// Creates a [SystemResult] object. - const SystemResult({ - this.systemSolver, - this.isSingular = false, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is SystemResult) { - return runtimeType == other.runtimeType && - systemSolver == other.systemSolver && - isSingular == other.isSingular; - } else { - return false; - } - } - - @override - int get hashCode => Object.hash(systemSolver, isSingular); -} diff --git a/example/flutter_example/lib/routes/system_page/model/system_state.dart b/example/flutter_example/lib/routes/system_page/model/system_state.dart deleted file mode 100644 index 6b79f9fc..00000000 --- a/example/flutter_example/lib/routes/system_page/model/system_state.dart +++ /dev/null @@ -1,233 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/system_page.dart'; -import 'package:equations_solver/routes/system_page/model/system_result.dart'; -import 'package:flutter/widgets.dart'; - -/// The types of system solving algorithms. -enum SystemType { - /// Row reduction algorithm. - rowReduction, - - /// Factorization algorithms like LU or Cholesky. - factorization, - - /// Algorithms that require initial values and a finite number of steps. - iterative, -} - -/// Row reduction algorithms to solve systems of equations. -enum RowReductionMethods { - /// Gauss elimination. - gauss, -} - -/// Factorization algorithms that factor a matrix into multiple matrices. -enum FactorizationMethods { - /// LU decomposition. - lu, - - /// Cholesky decomposition. - cholesky, -} - -/// Iterative methods use an initial value to generate a sequence of improving -/// approximate solutions for the system. -enum IterativeMethods { - /// Successive Over Relaxation method. - sor, - - /// Gauss-Seidel method. - gaussSeidel, - - /// Jacobi method. - jacobi, -} - -/// Holds the state of the [SystemPage] page. -class SystemState extends ChangeNotifier { - var _state = const SystemResult(); - - /// The kind of system solver algorithm to be used. - final SystemType systemType; - - /// Creates a [SystemState] object. - SystemState(this.systemType); - - /// The current state. - SystemResult get state => _state; - - /// Tries to return a [RowReductionMethods] value from a string value. - static RowReductionMethods rowReductionResolve(String name) { - if (name.toLowerCase() == 'gauss') { - return RowReductionMethods.gauss; - } - - throw ArgumentError( - "The given string doesn't map to a valid 'RowReductionMethods value.", - ); - } - - /// Tries to return a [FactorizationMethods] value from a string value. - static FactorizationMethods factorizationResolve(String name) { - if (name.toLowerCase() == 'lu') { - return FactorizationMethods.lu; - } - - if (name.toLowerCase() == 'cholesky') { - return FactorizationMethods.cholesky; - } - - throw ArgumentError( - "The given string doesn't map to a valid 'FactorizationMethods value.", - ); - } - - /// Tries to return a [IterativeMethods] value from a string value. - static IterativeMethods iterativeResolve(String name) { - if (name.toLowerCase() == 'sor') { - return IterativeMethods.sor; - } - - if (name.toLowerCase() == 'jacobi') { - return IterativeMethods.jacobi; - } - - throw ArgumentError( - "The given string doesn't map to a valid 'IterativeMethod value.", - ); - } - - /// Tries to solve a system of equations using a row reduction algorithm. - void rowReductionSolver({ - required List flatMatrix, - required List knownValues, - required int size, - }) { - try { - final matrix = _valueParser(flatMatrix); - final vector = _valueParser(knownValues); - - final solver = GaussianElimination( - matrix: RealMatrix.fromFlattenedData( - rows: size, - columns: size, - data: matrix, - ), - knownValues: vector, - ); - - final hasSolution = solver.hasSolution(); - - _state = SystemResult( - systemSolver: hasSolution ? solver : null, - isSingular: !hasSolution, - ); - } on Exception { - _state = const SystemResult(); - } - - notifyListeners(); - } - - /// Tries to solve a system of equations using a factorization algorithm. - void factorizationSolver({ - required List flatMatrix, - required List knownValues, - required int size, - required FactorizationMethods method, - }) { - try { - final matrix = _valueParser(flatMatrix); - final vector = _valueParser(knownValues); - - final realMatrix = RealMatrix.fromFlattenedData( - rows: size, - columns: size, - data: matrix, - ); - - final solver = switch (method) { - FactorizationMethods.lu => LUSolver( - matrix: realMatrix, - knownValues: vector, - ), - FactorizationMethods.cholesky => CholeskySolver( - matrix: realMatrix, - knownValues: vector, - ) - }; - - final hasSolution = solver.hasSolution(); - - _state = SystemResult( - systemSolver: hasSolution ? solver : null, - isSingular: !hasSolution, - ); - } on Exception { - _state = const SystemResult(); - } - - notifyListeners(); - } - - /// Tries to solve a system of equations using an iterative algorithm. - void iterativeSolver({ - required List flatMatrix, - required List knownValues, - required int size, - required IterativeMethods method, - String w = '1.25', - List jacobiInitialVector = const [], - }) { - try { - final matrix = _valueParser(flatMatrix); - final vector = _valueParser(knownValues); - const parser = ExpressionParser(); - - final realMatrix = RealMatrix.fromFlattenedData( - rows: size, - columns: size, - data: matrix, - ); - - final solver = switch (method) { - IterativeMethods.sor => SORSolver( - matrix: realMatrix, - knownValues: vector, - w: parser.evaluate(w), - ), - IterativeMethods.gaussSeidel => GaussSeidelSolver( - matrix: realMatrix, - knownValues: vector, - ), - IterativeMethods.jacobi => JacobiSolver( - matrix: realMatrix, - knownValues: vector, - x0: _valueParser(jacobiInitialVector), - ) - }; - - final hasSolution = solver.hasSolution(); - - _state = SystemResult( - systemSolver: hasSolution ? solver : null, - isSingular: !hasSolution, - ); - } on Exception { - _state = const SystemResult(); - } - - notifyListeners(); - } - - /// Clears the state. - void clear() { - _state = const SystemResult(); - notifyListeners(); - } - - /// Tries to parse each value of [source] of number and evaluates the - /// numerical expression. - List _valueParser(List source) => - source.map(const ExpressionParser().evaluate).toList(growable: false); -} diff --git a/example/flutter_example/lib/routes/system_page/system_body.dart b/example/flutter_example/lib/routes/system_page/system_body.dart deleted file mode 100644 index 9d9b4b76..00000000 --- a/example/flutter_example/lib/routes/system_page/system_body.dart +++ /dev/null @@ -1,79 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_data_input.dart'; -import 'package:equations_solver/routes/system_page/system_results.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; - -/// This widget contains the input for a matrix and the known values vector to -/// solve systems of linear equations. -class SystemBody extends StatelessWidget { - /// Creates a [SystemBody] widget. - const SystemBody({super.key}); - - @override - Widget build(BuildContext context) { - return const Stack( - children: [ - // Scrollable contents of the page - Positioned.fill( - child: _SystemBodyContents(), - ), - - // "Go back" button - Positioned( - top: 20, - left: 20, - child: GoBackButton(), - ), - ], - ); - } -} - -/// Determines whether the contents should appear in 1 or 2 columns. -class _SystemBodyContents extends StatefulWidget { - /// Creates a [_SystemBodyContents] widget. - const _SystemBodyContents(); - - @override - __SystemBodyContentsState createState() => __SystemBodyContentsState(); -} - -class __SystemBodyContentsState extends State<_SystemBodyContents> { - /// Manually caching the page title. - late final Widget pageTitleWidget = PageTitle( - pageTitle: localizedName, - pageLogo: const SystemsLogo( - size: 50, - ), - ); - - /// Getting the page title according with the kind of algorithms that are - /// going to be used. - String get localizedName => switch (context.systemState.systemType) { - SystemType.rowReduction => context.l10n.row_reduction, - SystemType.factorization => context.l10n.factorization, - SystemType.iterative => context.l10n.iterative - }; - - @override - Widget build(BuildContext context) { - return SingleChildScrollView( - child: Column( - children: [ - pageTitleWidget, - - // Data input - const SystemDataInput(), - - // Results - const SystemResults(), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/system_data_input.dart b/example/flutter_example/lib/routes/system_page/system_data_input.dart deleted file mode 100644 index 5ffb20f4..00000000 --- a/example/flutter_example/lib/routes/system_page/system_data_input.dart +++ /dev/null @@ -1,265 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/system_page/utils/jacobi_initial_vector.dart'; -import 'package:equations_solver/routes/system_page/utils/matrix_input.dart'; -import 'package:equations_solver/routes/system_page/utils/size_picker.dart'; -import 'package:equations_solver/routes/system_page/utils/sor_relaxation_factor.dart'; -import 'package:equations_solver/routes/system_page/utils/vector_input.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; - -/// A wrapper of [MatrixInput] which also handles other specific inputs to -/// solve systems in the `Ax = b` form using different algorithms. -class SystemDataInput extends StatefulWidget { - /// Creates a [SystemDataInput] widget. - const SystemDataInput({super.key}); - - @override - State createState() => _SystemDataInputState(); -} - -class _SystemDataInputState extends State { - /// Form validation key. - final formKey = GlobalKey(); - - /// Caching the text that describes what the vector does. - late final vectorText = Padding( - padding: const EdgeInsets.fromLTRB(20, 10, 20, 15), - child: Text( - context.l10n.vector_description, - style: const TextStyle( - fontSize: 14, - color: Colors.grey, - ), - ), - ); - - /// Caching the text that describes what the matrix does. - late final matrixText = Padding( - padding: const EdgeInsets.fromLTRB(20, 10, 20, 15), - child: Text( - context.l10n.matrix_description, - style: const TextStyle( - fontSize: 14, - color: Colors.grey, - ), - ), - ); - - /// This is required to figure out which system solving algorithm has to be - /// used. - SystemType get _getType => context.systemState.systemType; - - /// Form cleanup. - void cleanInput() { - // Making sure to also clear the form completely - formKey.currentState?.reset(); - context.systemState.clear(); - context.numberSwitcherState.reset(); - - // Clear all input forms on screen - for (final controller in context.systemTextControllers.matrixControllers) { - controller.clear(); - } - for (final controller in context.systemTextControllers.vectorControllers) { - controller.clear(); - } - for (final controller in context.systemTextControllers.jacobiControllers) { - controller.clear(); - } - context.systemTextControllers.wSorController.clear(); - - FocusScope.of(context).unfocus(); - } - - /// Solves a system of equations. - void solve() { - if (formKey.currentState?.validate() ?? false) { - final algorithm = context.dropdownValue.value; - final size = context.numberSwitcherState.state; - - // Getting the inputs - final systemInputs = context.systemTextControllers.matrixControllers - .sublist(0, size * size) - .map((c) => c.text) - .toList(growable: false); - - final vectorInputs = context.systemTextControllers.vectorControllers - .sublist(0, size) - .map((c) => c.text) - .toList(growable: false); - - // Solving the system - switch (_getType) { - case SystemType.rowReduction: - context.systemState.rowReductionSolver( - flatMatrix: systemInputs, - knownValues: vectorInputs, - size: size, - ); - case SystemType.factorization: - context.systemState.factorizationSolver( - flatMatrix: systemInputs, - knownValues: vectorInputs, - size: size, - method: SystemState.factorizationResolve(algorithm), - ); - case SystemType.iterative: - final initialGuesses = context.systemTextControllers.jacobiControllers - .sublist(0, size) - .map((c) => c.text) - .toList(growable: false); - - context.systemState.iterativeSolver( - flatMatrix: systemInputs, - knownValues: vectorInputs, - size: size, - method: SystemState.iterativeResolve(algorithm), - jacobiInitialVector: initialGuesses, - w: context.systemTextControllers.wSorController.text, - ); - } - } else { - // The user entered invalid values, - ScaffoldMessenger.of(context).showSnackBar( - SnackBar( - content: Text(context.l10n.invalid_values), - duration: const Duration(seconds: 2), - ), - ); - } - } - - @override - Widget build(BuildContext context) { - return FocusTraversalGroup( - child: Form( - key: formKey, - child: Column( - children: [ - // Some spacing - const SizedBox( - height: 60, - ), - - // Size changer - const SizePicker( - isInOtherPage: false, - ), - - // Some spacing - const SizedBox( - height: 35, - ), - - // Matrix input - ListenableBuilder( - listenable: context.numberSwitcherState, - builder: (context, _) { - return MatrixInput( - matrixControllers: - context.systemTextControllers.matrixControllers, - matrixSize: context.numberSwitcherState.state, - ); - }, - ), - - // The description associated to the matrix widget - matrixText, - - // Some spacing - const SizedBox( - height: 30, - ), - - // Vector input - ListenableBuilder( - listenable: context.numberSwitcherState, - builder: (context, _) { - return VectorInput( - vectorControllers: - context.systemTextControllers.vectorControllers, - vectorSize: context.numberSwitcherState.state, - ); - }, - ), - - // The description associated to the matrix widget - vectorText, - - // Algorithm type picker - const SystemDropdownSelection(), - - // The optional input for the relaxation value - const _RelaxationFactor(), - - // The optional input for the initial guesses vector - // Vector input - const JacobiVectorInput(), - - // Spacing - const SizedBox(height: 45), - - // Two buttons needed to "solve" and "clear" the system - Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Solving the system - ElevatedButton( - key: const Key('System-button-solve'), - onPressed: solve, - child: Text(context.l10n.solve), - ), - - const Padding( - padding: EdgeInsets.symmetric( - horizontal: 16, - ), - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - - // Cleaning the inputs - ElevatedButton( - key: const Key('System-button-clean'), - onPressed: cleanInput, - child: Text(context.l10n.clean), - ), - ], - ), - ], - ), - ), - ); - } -} - -/// The widget asking for the relaxation factor `w` of the SOR algorithm. -class _RelaxationFactor extends StatelessWidget { - /// Creates a [_RelaxationFactor] widget. - const _RelaxationFactor(); - - @override - Widget build(BuildContext context) { - return ValueListenableBuilder( - valueListenable: context.dropdownValue, - builder: (context, value, child) { - final sorValue = SystemDropdownItems.sor.asString.toLowerCase(); - - if (value.toLowerCase() == sorValue) { - return child!; - } - - // Nothing is displayed if SOR isn't the currently selected option. - return const SizedBox.shrink(); - }, - child: const RelaxationFactorInput(), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/system_input_field.dart b/example/flutter_example/lib/routes/system_page/system_input_field.dart deleted file mode 100644 index 25bcb2f5..00000000 --- a/example/flutter_example/lib/routes/system_page/system_input_field.dart +++ /dev/null @@ -1,68 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// This is just a wrapper of a [TextFormField] that parses and validates the -/// entries of a matrix. -class SystemInputField extends StatefulWidget { - /// The [TextEditingController] controller. - final TextEditingController controller; - - /// The placeholder text to show in the input field. - final String placeholder; - - /// Whether the field is in read-only mode or not. When `true`, the background - /// color is set to [Colors.white]. - /// - /// By default, this is set to `false`. - final bool isReadOnly; - - /// Creates a [SystemInputField] widget. - const SystemInputField({ - required this.controller, - this.placeholder = '', - this.isReadOnly = false, - super.key, - }); - - @override - State createState() => _SystemInputFieldState(); -} - -class _SystemInputFieldState extends State { - String? _validationLogic(String? value) { - if (value != null) { - if (!value.isNumericalExpression) { - return 'Uh! :('; - } - } - - return null; - } - - @override - Widget build(BuildContext context) { - return SizedBox( - width: systemInputFieldSize, - child: TextFormField( - key: const Key('SystemInputField-TextFormField'), - controller: widget.controller, - readOnly: widget.isReadOnly, - textAlign: TextAlign.center, - decoration: InputDecoration( - border: const OutlineInputBorder( - borderRadius: BorderRadius.all( - Radius.circular(5), - ), - ), - fillColor: widget.isReadOnly ? Colors.white : null, - contentPadding: const EdgeInsets.symmetric( - horizontal: 3, - ), - hintText: widget.placeholder, - ), - validator: _validationLogic, - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/system_results.dart b/example/flutter_example/lib/routes/system_page/system_results.dart deleted file mode 100644 index 7ac323f1..00000000 --- a/example/flutter_example/lib/routes/system_page/system_results.dart +++ /dev/null @@ -1,97 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/message_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The vector with the solutions of the system of equations. -class SystemResults extends StatelessWidget { - /// Creates a [SystemResults] widget. - const SystemResults({super.key}); - - @override - Widget build(BuildContext context) { - return Column( - children: [ - // Separator line - const SizedBox( - height: 80, - ), - - SectionTitle( - pageTitle: context.l10n.solutions, - icon: const EquationSolution(), - ), - - // Showing the solutions of the nonlinear equation - const _SystemSolutions(), - ], - ); - } -} - -/// The solution vector, which is simply a list of [RealResultCard]s. -class _SystemSolutions extends StatefulWidget { - const _SystemSolutions(); - - @override - State<_SystemSolutions> createState() => _SystemSolutionsState(); -} - -class _SystemSolutionsState extends State<_SystemSolutions> { - /// This widget is rendered whenever the matrix is singular. - late final singularErrorWidget = Column( - mainAxisSize: MainAxisSize.min, - children: [ - MessageCard( - message: context.l10n.singular_matrix_error, - ), - const SizedBox( - height: 30, - ), - ], - ); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.systemState, - builder: (context, child) { - final state = context.systemState.state; - - if (state.systemSolver != null) { - final solutions = state.systemSolver!.solve(); - - return Column( - mainAxisSize: MainAxisSize.min, - children: [ - for (var i = 0; i < solutions.length; ++i) - RealResultCard( - value: solutions[i], - leading: '${String.fromCharCode('a'.codeUnitAt(0) + i)} = ', - ), - const SizedBox( - height: 30, - ), - ], - ); - } - - if (state.isSingular) { - return singularErrorWidget; - } - - return child!; - }, - child: const Padding( - padding: EdgeInsets.only( - bottom: 30, - ), - child: NoResults(), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/utils/dropdown_selection.dart b/example/flutter_example/lib/routes/system_page/utils/dropdown_selection.dart deleted file mode 100644 index 21704099..00000000 --- a/example/flutter_example/lib/routes/system_page/utils/dropdown_selection.dart +++ /dev/null @@ -1,132 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:flutter/material.dart'; - -/// Dropdown button used to choose which system solving algorithm has to be -/// used. -class SystemDropdownSelection extends StatefulWidget { - /// Creates a [SystemDropdownSelection] widget. - const SystemDropdownSelection({super.key}); - - @override - SystemDropdownSelectionState createState() => SystemDropdownSelectionState(); -} - -/// The state of the [SystemDropdownSelection] class. -@visibleForTesting -class SystemDropdownSelectionState extends State { - /// The cached dropdown items. - late final dropdownItems = systemType == SystemType.factorization - ? const [ - DropdownMenuItem( - key: Key('LU-Dropdown'), - value: SystemDropdownItems.lu, - child: Text('LU'), - ), - DropdownMenuItem( - key: Key('Cholesky-Dropdown'), - value: SystemDropdownItems.cholesky, - child: Text('Cholesky'), - ), - ] - : const [ - DropdownMenuItem( - key: Key('SOR-Dropdown'), - value: SystemDropdownItems.sor, - child: Text('SOR'), - ), - DropdownMenuItem( - key: Key('Jacobi-Dropdown'), - value: SystemDropdownItems.jacobi, - child: Text('Jacobi'), - ), - ]; - - /// Updates the currently selected value in the dropdown. - void changeSelected(SystemDropdownItems newValue) => - context.dropdownValue.value = newValue.asString; - - /// The currently selected system type. - SystemType get systemType => context.systemState.systemType; - - @override - Widget build(BuildContext context) { - // Gauss is the only supported row reduction system and it doesn't require - // an algorithm. As such, we can remove the dropdown. - if (systemType == SystemType.rowReduction) { - return const SizedBox.shrink(); - } - - return Center( - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // Spacing - const SizedBox(height: 45), - - // Dropdown picker - SizedBox( - width: 250, - child: ValueListenableBuilder( - valueListenable: context.dropdownValue, - builder: (context, value, _) { - return DropdownButtonFormField( - key: const Key('System-Dropdown-Button-Selection'), - isExpanded: true, - value: value.toSystemDropdownItems(), - decoration: const InputDecoration( - border: OutlineInputBorder( - borderRadius: BorderRadius.all(Radius.circular(15)), - ), - ), - onChanged: (value) => changeSelected(value!), - items: dropdownItems, - ); - }, - ), - ), - ], - ), - ); - } -} - -/// The possible values of the [SystemDropdownSelection] dropdown. -enum SystemDropdownItems { - /// LU factorization. - lu('LU'), - - /// Cholesky factorization. - cholesky('Cholesky'), - - /// SOR iterative method. - sor('SOR'), - - /// Jacobi iterative method. - jacobi('Jacobi'); - - /// The string representation of the value. - final String asString; - - /// Creates a [SystemDropdownItems] enumeration - const SystemDropdownItems(this.asString); -} - -/// Extension method on [String] to convert into a [SystemDropdownItems] the -/// string value. -extension StringExt on String { - static const _argumentErrorMessage = - 'The given string does NOT map to a SystemDropdownItems value'; - - /// Converts a [String] into a [SystemDropdownItems] value. - SystemDropdownItems toSystemDropdownItems() { - return switch (toLowerCase()) { - 'lu' => SystemDropdownItems.lu, - 'cholesky' => SystemDropdownItems.cholesky, - 'sor' => SystemDropdownItems.sor, - 'jacobi' => SystemDropdownItems.jacobi, - _ => throw ArgumentError(_argumentErrorMessage) - }; - } -} diff --git a/example/flutter_example/lib/routes/system_page/utils/jacobi_initial_vector.dart b/example/flutter_example/lib/routes/system_page/utils/jacobi_initial_vector.dart deleted file mode 100644 index e4169b83..00000000 --- a/example/flutter_example/lib/routes/system_page/utils/jacobi_initial_vector.dart +++ /dev/null @@ -1,69 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/system_page/utils/vector_input.dart'; -import 'package:flutter/material.dart'; - -/// This widget allows the input of the initial guesses vector of the Jacobi -/// algorithm. -class JacobiVectorInput extends StatelessWidget { - /// Creates a [JacobiVectorInput] widget. - const JacobiVectorInput({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return Center( - child: ValueListenableBuilder( - valueListenable: context.dropdownValue, - builder: (context, value, child) { - final jacobiItems = SystemDropdownItems.jacobi.asString; - - if (value.toLowerCase() == jacobiItems.toLowerCase()) { - return child!; - } - - // Nothing is displayed if the chosen method isn't 'Jacobi'. - return const SizedBox.shrink(); - }, - child: Padding( - padding: const EdgeInsets.only( - top: 35, - bottom: 10, - ), - child: Column( - key: const Key('Jacobi-Vector-Input-Column'), - children: [ - // Input. - ListenableBuilder( - listenable: context.numberSwitcherState, - builder: (context, _) { - return VectorInput( - vectorControllers: - context.systemTextControllers.jacobiControllers, - vectorSize: context.numberSwitcherState.state, - ); - }, - ), - - // Some spacing. - const SizedBox(height: 15), - - // A label that describes what 'w' is. - Text( - context.l10n.jacobi_initial, - style: const TextStyle( - fontSize: 14, - color: Colors.grey, - ), - ), - ], - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/utils/matrix_input.dart b/example/flutter_example/lib/routes/system_page/utils/matrix_input.dart deleted file mode 100644 index 26ec1ccb..00000000 --- a/example/flutter_example/lib/routes/system_page/utils/matrix_input.dart +++ /dev/null @@ -1,82 +0,0 @@ -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// Creates an NxN square matrix whose entries are [SystemInputField] widgets. -/// The size of the matrix (`N`) is determined by the length of the controllers -/// list. -class MatrixInput extends StatefulWidget { - /// The text controllers of the matrix entries. - final List matrixControllers; - - /// The matrix size. - final int matrixSize; - - /// Creates a [MatrixInput] widget. - const MatrixInput({ - required this.matrixControllers, - required this.matrixSize, - super.key, - }); - - @override - State createState() => _MatrixInputState(); -} - -class _MatrixInputState extends State { - /// The children of the [Table] widget, representing the matrix. - late List children = _tableChildren(); - - /// Builds the [TableRow]s widget that will allow for the value input. - List _tableChildren() { - final rows = []; - - for (var i = 0; i < widget.matrixSize; ++i) { - final children = []; - - for (var j = 0; j < widget.matrixSize; ++j) { - children.add( - Padding( - padding: const EdgeInsets.all(5), - child: SystemInputField( - key: Key('SystemEntry-$i-$j'), - controller: widget.matrixControllers[j + i * widget.matrixSize], - ), - ), - ); - } - - rows.add( - TableRow( - children: children, - ), - ); - } - - return rows; - } - - @override - void didUpdateWidget(covariant MatrixInput oldWidget) { - super.didUpdateWidget(oldWidget); - - if (widget.matrixSize != oldWidget.matrixSize) { - children = _tableChildren(); - } - } - - @override - Widget build(BuildContext context) { - // Adding '5' to the overall width to make sure that tiles aren't too close. - final boxWidth = widget.matrixSize * (systemInputFieldSize + 5); - - return Center( - child: SizedBox( - width: boxWidth, - child: Table( - children: children, - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/utils/size_picker.dart b/example/flutter_example/lib/routes/system_page/utils/size_picker.dart deleted file mode 100644 index c664d24b..00000000 --- a/example/flutter_example/lib/routes/system_page/utils/size_picker.dart +++ /dev/null @@ -1,114 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_analyzer_input.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/system_data_input.dart'; -import 'package:flutter/material.dart'; - -/// This widget has 2 arrows that, respectively, decrease and increase the value -/// store in [NumberSwitcherState]. -class SizePicker extends StatelessWidget { - /// Whether this widget is used inside the [MatrixAnalyzerInput] page or not. - /// - /// When `false`, it means that this widget is used within [SystemDataInput]. - final bool isInOtherPage; - - /// Creates a [SizePicker] widget. - const SizePicker({ - required this.isInOtherPage, - super.key, - }); - - /// Ensures that, whenever the matrix size changes, the form is cleared. - void _clearState(BuildContext context) { - if (isInOtherPage) { - for (final controller in context.textControllers) { - controller.clear(); - } - context.otherState.clear(); - } else { - for (final controller - in context.systemTextControllers.matrixControllers) { - controller.clear(); - } - for (final controller - in context.systemTextControllers.vectorControllers) { - controller.clear(); - } - for (final controller - in context.systemTextControllers.jacobiControllers) { - controller.clear(); - } - - context.systemTextControllers.wSorController.clear(); - context.systemState.clear(); - } - - FocusScope.of(context).unfocus(); - } - - @override - Widget build(BuildContext context) { - return Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - // Decrease - ElevatedButton( - key: const Key('SizePicker-Back-Button'), - style: ButtonStyle( - shape: MaterialStateProperty.all(const CircleBorder()), - ), - onPressed: () { - context.numberSwitcherState.decrease(); - _clearState(context); - }, - child: const Icon(Icons.arrow_back), - ), - - // Spacing - const SizedBox(width: 15), - - // The size - ListenableBuilder( - listenable: context.numberSwitcherState, - builder: (context, _) { - final text = switch (context.numberSwitcherState.state) { - 1 => context.l10n.matrix_size1, - 2 => context.l10n.matrix_size2, - 3 => context.l10n.matrix_size3, - 4 => context.l10n.matrix_size4, - _ => '-' - }; - - return Text( - text, - style: const TextStyle( - fontSize: 15, - ), - ); - }, - ), - - // Spacing - const SizedBox(width: 15), - - // Increase - ElevatedButton( - key: const Key('SizePicker-Forward-Button'), - style: ButtonStyle( - shape: MaterialStateProperty.all(const CircleBorder()), - ), - onPressed: () { - context.numberSwitcherState.increase(); - _clearState(context); - }, - child: const Icon(Icons.arrow_forward), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/utils/sor_relaxation_factor.dart b/example/flutter_example/lib/routes/system_page/utils/sor_relaxation_factor.dart deleted file mode 100644 index f1a847c3..00000000 --- a/example/flutter_example/lib/routes/system_page/utils/sor_relaxation_factor.dart +++ /dev/null @@ -1,45 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:flutter/material.dart'; - -/// This very simple widget allows the input of the relaxation factor `w` of the -/// SOR system solving algorithm. -class RelaxationFactorInput extends StatelessWidget { - /// Creates a [RelaxationFactorInput] widget. - const RelaxationFactorInput({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.only( - top: 35, - bottom: 10, - ), - child: Column( - children: [ - // Input - SystemInputField( - key: const Key('SystemSolver-Iterative-RelaxationFactor'), - controller: context.systemTextControllers.wSorController, - placeholder: 'w', - ), - - // Some spacing - const SizedBox(height: 15), - - // A label that describes what 'w' is - Text( - context.l10n.sor_w, - style: const TextStyle( - fontSize: 14, - color: Colors.grey, - ), - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/system_page/utils/vector_input.dart b/example/flutter_example/lib/routes/system_page/utils/vector_input.dart deleted file mode 100644 index b139d019..00000000 --- a/example/flutter_example/lib/routes/system_page/utils/vector_input.dart +++ /dev/null @@ -1,89 +0,0 @@ -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// Creates a column of [SystemInputField] to input the known values vector -/// of the system. -class VectorInput extends StatefulWidget { - /// The text controllers of the known values vector. - final List vectorControllers; - - /// The actual size of the vector. - final int vectorSize; - - /// Creates a [VectorInput] widget. - const VectorInput({ - required this.vectorControllers, - required this.vectorSize, - super.key, - }); - - @override - State createState() => _VectorInputState(); -} - -class _VectorInputState extends State { - /// The children of the [Column] widget, representing the vector. - late Widget vectorChildren = _VectorChildren( - vectorControllers: widget.vectorControllers, - vectorSize: widget.vectorSize, - ); - - @override - void didUpdateWidget(covariant VectorInput oldWidget) { - super.didUpdateWidget(oldWidget); - - if (widget.vectorSize != oldWidget.vectorSize) { - vectorChildren = _VectorChildren( - vectorControllers: widget.vectorControllers, - vectorSize: widget.vectorSize, - ); - } - } - - @override - Widget build(BuildContext context) { - // Adding '5' to the overall width to make sure that tiles aren't too close. - const boxWidth = systemInputFieldSize + 5; - - return Center( - child: SizedBox( - width: boxWidth, - child: vectorChildren, - ), - ); - } -} - -/// Returns the the children that will contain the input fields for the known -/// values vector. -class _VectorChildren extends StatelessWidget { - /// The text controllers of the known values vector. - final List vectorControllers; - - /// The actual size of the vector. - final int vectorSize; - - /// Creates a [_VectorChildren] widget. - const _VectorChildren({ - required this.vectorControllers, - required this.vectorSize, - }); - - @override - Widget build(BuildContext context) { - return Column( - mainAxisSize: MainAxisSize.min, - children: [ - for (var i = 0; i < vectorSize; ++i) - Padding( - padding: i == 0 ? EdgeInsets.zero : const EdgeInsets.only(top: 10), - child: SystemInputField( - key: Key('VectorEntry-$i'), - controller: vectorControllers[i], - ), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/app_logo.dart b/example/flutter_example/lib/routes/utils/app_logo.dart deleted file mode 100644 index 60284cba..00000000 --- a/example/flutter_example/lib/routes/utils/app_logo.dart +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:equations_solver/routes/home_page.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The app logo at the top of the [HomePage] widget. -class AppLogo extends StatelessWidget { - /// Creates an [AppLogo] widget. - const AppLogo({super.key}); - - @override - Widget build(BuildContext context) { - return const Padding( - padding: EdgeInsets.only(top: 25), - child: ApplicationLogo(size: 64), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/body_pages/equation_text_formatter.dart b/example/flutter_example/lib/routes/utils/body_pages/equation_text_formatter.dart deleted file mode 100644 index 570899f3..00000000 --- a/example/flutter_example/lib/routes/utils/body_pages/equation_text_formatter.dart +++ /dev/null @@ -1,41 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/polynomial_data_input.dart'; -import 'package:flutter/material.dart'; - -/// This widget appends a blue `f(x) = ` text in front of an equation. This is -/// used in [PolynomialDataInput]. -class EquationTextFormatter extends StatelessWidget { - /// The equation. - final String equation; - - /// Creates a [EquationTextFormatter] widget. - const EquationTextFormatter({ - required this.equation, - super.key, - }); - - @override - Widget build(BuildContext context) { - final style = DefaultTextStyle.of(context).style.copyWith( - color: Colors.blueAccent, - fontStyle: FontStyle.italic, - fontSize: 20, - ); - - return RichText( - text: TextSpan( - text: 'f(x) = ', - style: style, - children: [ - TextSpan( - text: equation, - style: const TextStyle( - color: Colors.black, - fontSize: 18, - fontStyle: FontStyle.normal, - ), - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/body_pages/go_back_button.dart b/example/flutter_example/lib/routes/utils/body_pages/go_back_button.dart deleted file mode 100644 index 0e9035dd..00000000 --- a/example/flutter_example/lib/routes/utils/body_pages/go_back_button.dart +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:flutter/material.dart'; -import 'package:go_router/go_router.dart'; - -/// This button simply goes back to the previous page. -class GoBackButton extends StatelessWidget { - /// Creates a [GoBackButton] widget. - const GoBackButton({super.key}); - - @override - Widget build(BuildContext context) { - return IconButton( - icon: const Icon(Icons.arrow_back), - splashRadius: 24, - onPressed: context.pop, - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/body_pages/page_title.dart b/example/flutter_example/lib/routes/utils/body_pages/page_title.dart deleted file mode 100644 index 05de38c9..00000000 --- a/example/flutter_example/lib/routes/utils/body_pages/page_title.dart +++ /dev/null @@ -1,42 +0,0 @@ -import 'package:flutter/material.dart'; - -/// The section title at the top of each route. -class PageTitle extends StatelessWidget { - /// The section title. - final String pageTitle; - - /// A small image on the left of the text. - /// - /// Generally, this widget is 50x50 large. - final Widget pageLogo; - - /// Creates a [PageTitle] widget. - const PageTitle({ - required this.pageTitle, - required this.pageLogo, - super.key, - }); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.only(top: 60), - child: Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - Padding( - padding: const EdgeInsets.only(right: 20), - child: pageLogo, - ), - Text( - pageTitle, - style: const TextStyle( - fontSize: 26, - color: Colors.blueGrey, - ), - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/breakpoints.dart b/example/flutter_example/lib/routes/utils/breakpoints.dart deleted file mode 100644 index 0784dafb..00000000 --- a/example/flutter_example/lib/routes/utils/breakpoints.dart +++ /dev/null @@ -1,94 +0,0 @@ -import 'package:equations_solver/routes/integral_page/integral_body.dart'; -import 'package:equations_solver/routes/integral_page/integral_data_input.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_body.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_data_input.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/precision_slider.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_analyzer_results.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_input.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_analyze_results.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_output.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_input_field.dart'; -import 'package:equations_solver/routes/system_page/system_body.dart'; -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:equations_solver/routes/utils/equation_input.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:equations_solver/routes/utils/result_cards/bool_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/polynomial_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; - -/// When the viewport is horizontally smaller than [bottomNavigationBreakpoint], -/// tabs are used. When larger, a navigation rail is shown. -const bottomNavigationBreakpoint = 950.0; - -/// When there is more horizontal space than [extraBackgroundBreakpoint], an -/// additional background image is added to the [EquationScaffold] scaffold. -const extraBackgroundBreakpoint = 1300.0; - -/// Determines whether the contents should stay on one or two column(s). -const doubleColumnPageBreakpoint = 1100.0; - -/// The maximum size (width and height) of a [EquationDrawerWidget]. -const maxWidthPlot = 600.0; - -/// The width of a single column in the [MatrixAnalyzerResults] page when there -/// are multiple columns in the page. -/// -/// We want to add a padding of `30` on both sides, hence the `30 * 2`. -const matricesPageColumnWidth = cardWidgetsWidth + 30 * 2; - -/// The width of a single column in the [ComplexNumberAnalyzerResult] page when -/// there are multiple columns in the page. -/// -/// We want to add a padding of `30` on both sides, hence the `30 * 2`. -const complexNumbersPageColumnWidth = cardWidgetsWidth + 30 * 2; - -/// The width of the cards widgets: [RealResultCard], [ComplexResultCard] and -/// [BoolResultCard]. -const cardWidgetsWidth = 275.0; - -/// Determines how many **required** decimal digits are shown in decimal values -/// in result cards: -/// -/// - [RealResultCard] -/// - [ComplexResultCard] -/// - [PolynomialResultCard] -const resultCardPrecisionDigits = 5; - -/// Padding and margin of the [Collapsible] widget. -const collapsibleInnerSpacing = 16.0; - -/// The width of a [PolynomialInputField] widget. -const polynomialInputFieldWidth = 70.0; - -/// The width of dropdown boxes in the [NonlinearBody] page -const nonlinearDropdownWidth = 200.0; - -/// The width of dropdown boxes in the [SystemBody] page -const systemDropdownWidth = 250.0; - -/// The width of dropdown boxes in the [IntegralBody] page -const integralDropdownWidth = 200.0; - -/// The width of a [PrecisionSlider] widget. -const precisonSliderWidth = 300.0; - -/// The width of a [SystemInputField] widget. -const systemInputFieldSize = 60.0; - -/// The length of an [EquationInput] widget used inside a [NonlinearDataInput] -/// to parse the algorithm values. -const nonlinearValuesWidth = 80.0; - -/// The length of an [EquationInput] widget used inside a [IntegralDataInput] to -/// parse the values of the lower and upper integration limits. -const integrationBoundsWidth = 80.0; - -/// The width of the [ComplexNumberInput] input widgets. -const complexInputWidth = 65.0; - -/// The width of a [TableRow] in the [MatrixOutput] widget. -const matrixOutputWidth = 70.0; diff --git a/example/flutter_example/lib/routes/utils/collapsible.dart b/example/flutter_example/lib/routes/utils/collapsible.dart deleted file mode 100644 index 02f665f9..00000000 --- a/example/flutter_example/lib/routes/utils/collapsible.dart +++ /dev/null @@ -1,190 +0,0 @@ -import 'dart:math' as math; - -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// This widget collapses and expands to reveal more or less information. -/// -/// The [primary] widget, placed at the top, is always visible. On the right, -/// there is a button that reveals or hides the [secondary] widget with a -/// sliding animation. -/// -/// The button on the right is used to control whether [secondary] is visible or -/// not. -class Collapsible extends StatefulWidget { - /// The visible part of the widget. - final Widget primary; - - /// The hidden part of the widget. This will become visible with a slide - /// animation when the button on the right is pressed. - final Widget secondary; - - /// Creates a [Collapsible] widget. - const Collapsible({ - required this.primary, - required this.secondary, - super.key, - }); - - @override - State createState() => _CollapsibleState(); -} - -class _CollapsibleState extends State - with SingleTickerProviderStateMixin { - // Drives the button rotation AND the sliding value of the hidden part. - late final controller = AnimationController( - vsync: this, - duration: const Duration(milliseconds: 150), - ); - - @override - void dispose() { - controller.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return SelectionArea( - child: Padding( - padding: const EdgeInsets.symmetric( - vertical: 10, - ), - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // This part is always visible. - _PrimaryWidget( - controller: controller, - child: widget.primary, - ), - - // This part expands or collapses. - _SecondaryWidget( - controller: controller, - child: widget.secondary, - ), - ], - ), - ), - ); - } -} - -/// The upper part of [Collapsible] that is always visible and has a button on -/// the right to expand or collapse the contents below. -class _PrimaryWidget extends StatelessWidget { - /// The [AnimationController] that rules button rotation angle. - final AnimationController controller; - - /// The child. - final Widget child; - - /// Creates a [_PrimaryWidget] widget. - const _PrimaryWidget({ - required this.controller, - required this.child, - }); - - /// Moves the animation controller backwards if it completed or forward if the - /// animation didn't start. - /// - /// The animation goes back or forth ONLY if the controller isn't ticking. - void _animate() { - if (!controller.isAnimating) { - controller.isCompleted ? controller.reverse() : controller.forward(); - } - } - - @override - Widget build(BuildContext context) { - return Row( - children: [ - // Left spacing - const SizedBox( - width: collapsibleInnerSpacing, - ), - - // The actual contents of the top part. This is wrapped in 'Expanded' so - // that it takes as much space as possible AND text can go to a new - // line (if any). - Expanded( - child: child, - ), - - // This button rotates by 180° according and indicates whether the - // secondary widget is visible or not. - AnimatedBuilder( - animation: controller, - builder: (context, child) { - return Transform.rotate( - angle: controller.value * math.pi, - child: child, - ); - }, - child: IconButton( - icon: const Icon( - Icons.keyboard_arrow_up, - color: Colors.blue, - ), - splashRadius: collapsibleInnerSpacing, - onPressed: _animate, - ), - ), - - // Right spacing - const SizedBox( - width: collapsibleInnerSpacing / 2, - ), - ], - ); - } -} - -/// The bottom part of [Collapsible] that expands or collapses. -class _SecondaryWidget extends StatelessWidget { - /// The [AnimationController] that rules the [SizeTransition] status. - final AnimationController controller; - - /// The child. - final Widget child; - - /// Creates a [_SecondaryWidget] widget. - const _SecondaryWidget({ - required this.controller, - required this.child, - }); - - @override - Widget build(BuildContext context) { - return SizeTransition( - sizeFactor: controller, - child: Padding( - padding: const EdgeInsets.symmetric( - horizontal: collapsibleInnerSpacing, - ), - child: Column( - mainAxisSize: MainAxisSize.min, - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - // Separates the "hidden" part from the top with a gray line - const Divider( - height: collapsibleInnerSpacing * 2, - thickness: 1, - ), - - Flexible( - child: Padding( - padding: const EdgeInsets.symmetric( - vertical: 10, - ), - child: child, - ), - ), - ], - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_input.dart b/example/flutter_example/lib/routes/utils/equation_input.dart deleted file mode 100644 index 90489b17..00000000 --- a/example/flutter_example/lib/routes/utils/equation_input.dart +++ /dev/null @@ -1,71 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:flutter/material.dart'; - -/// A wrapper of a [TextFormField] that allows the input of either an equation -/// or simple real numbers. -class EquationInput extends StatelessWidget { - /// The controller of the [TextFormField]. - final TextEditingController controller; - - /// The placeholder text of the widget. - final String placeholderText; - - /// The width of the input, which will scale if the horizontal space is not - /// enough. - final double baseWidth; - - /// The maximum length of the input. - final int maxLength; - - /// Determines whether the validator function of the input should allow for - /// real values or not. - /// - /// In other words, when `onlyRealValues = true` then equations aren't - /// accepted but numbers are. - /// - /// This is `false` by default. - final bool onlyRealValues; - - /// Creates a [EquationInput] instance. - const EquationInput({ - required this.controller, - required this.placeholderText, - this.baseWidth = 300, - this.maxLength = 100, - this.onlyRealValues = false, - super.key, - }); - - String? _validator(String? value) { - if (value != null) { - if (onlyRealValues) { - return value.isNumericalExpression ? null : 'Uh! :('; - } - - return value.isRealFunction ? null : 'Uh! :('; - } - - return null; - } - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.symmetric( - horizontal: 30, - ), - child: SizedBox( - width: baseWidth, - child: TextFormField( - controller: controller, - maxLength: maxLength, - textAlign: TextAlign.center, - decoration: InputDecoration( - hintText: placeholderText, - ), - validator: _validator, - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold.dart b/example/flutter_example/lib/routes/utils/equation_scaffold.dart deleted file mode 100644 index 3576cae1..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold.dart +++ /dev/null @@ -1,127 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/bottom_navigation_widget.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/rail_navigation_widget.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/scaffold_contents.dart'; -import 'package:flutter/material.dart'; - -const _assertionError = 'There must be at least 1 navigation item.'; - -/// A simple wrapper of [Scaffold]. This widget is meant to be used across the -/// entire application to setup the minimal "skeleton" of the UI. This scaffold -/// is made up of many parts: -/// -/// - an [AppBar] with no title and a dark/light theme switcher; -/// - the body of the [Scaffold]; -/// - an optional [FloatingActionButton]. -/// -/// This widget also contains a responsive navigation bar which can be either a -/// [BottomNavigationBar] or a [NavigationRail] according with the screen's -/// size. -class EquationScaffold extends StatefulWidget { - /// The body of the [Scaffold]. When there's a [navigationItems] list defined, - /// this widget is ignored because the actual body of the scaffold will be - /// determined by the contents of the list. - final Widget body; - - /// A list of items for a responsive navigation bar. If the list is empty, - /// then no navigation bars appear on the screen. - final List navigationItems; - - /// A [FloatingActionButton] widget placed on the bottom-left corner of the - /// screen. - final FloatingActionButton? fab; - - /// Creates a custom [Scaffold] widget with no built-in navigation. - const EquationScaffold({ - required this.body, - super.key, - this.fab, - }) : navigationItems = const []; - - /// Creates a custom [Scaffold] widget with built-in tabbed navigation. There - /// must be at least 1 navigation item. - const EquationScaffold.navigation({ - required this.navigationItems, - this.fab, - super.key, - }) : body = const SizedBox.shrink(), - assert( - navigationItems.length > 0, - _assertionError, - ); - - @override - State createState() => _EquationScaffoldState(); -} - -class _EquationScaffoldState extends State - with SingleTickerProviderStateMixin { - /// Controls the position of the currently visible page. - late final tabController = TabController( - length: widget.navigationItems.length, - vsync: this, - ); - - /// Holds the state of the currently selected index of [BottomNavigationBar] - /// and [NavigationRail] widgets. - final navigationIndex = ValueNotifier(0); - - @override - void initState() { - super.initState(); - - // This is to make sure that the index is always updated with the controller - // value. - tabController.addListener(() { - navigationIndex.value = tabController.index; - }); - } - - @override - void dispose() { - // The 'tabController' is lazily initialized and it may never be used if - // there are no navigation items. For this reason, it has to be disposed - // only when a tabbed layout is used, which is when there are navigation - // items defined. - if (widget.navigationItems.isNotEmpty) { - tabController.dispose(); - } - - super.dispose(); - } - - @override - Widget build(BuildContext context) { - // If there are NO navigation items, then no navigation bars are required - if (widget.navigationItems.isEmpty) { - return Scaffold( - body: ScaffoldContents( - body: widget.body, - ), - floatingActionButton: widget.fab, - ); - } - - // At this point, there's at least 1 navigation item and thus the widget - // requires some responsiveness! - return InheritedNavigation( - navigationItems: widget.navigationItems, - tabController: tabController, - fab: widget.fab, - navigationIndex: navigationIndex, - child: LayoutBuilder( - builder: (context, dimensions) { - // If the dimension of the screen is "small" enough, a bottom - // navigation bar fits better - if (dimensions.maxWidth <= bottomNavigationBreakpoint) { - return const BottomNavigationWidget(); - } - - return const RailNavigationWidget(); - }, - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/bottom_navigation_bar.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/bottom_navigation_bar.dart deleted file mode 100644 index d910fc8f..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/bottom_navigation_bar.dart +++ /dev/null @@ -1,54 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:flutter/material.dart'; - -/// A bottom navigation bar to be displayed within an [EquationScaffold] widget. -class BottomNavigation extends StatefulWidget { - /// A list of items for a responsive navigation bar. - final List navigationItems; - - /// Creates a [BottomNavigation] widget. - const BottomNavigation({ - required this.navigationItems, - super.key, - }); - - @override - State createState() => _BottomNavigationState(); -} - -class _BottomNavigationState extends State { - /// Converts a list of [NavigationItem]s into a list of - /// [BottomNavigationBarItem]s to be displayed on the navigation bar. - /// - /// Since these items will always be the same, we manually cache the list. - /// - /// There is no need to update this into 'didUpdateWidget' because navigation - /// items won't change during the app's lifetime. - late final _bottom = widget.navigationItems.map((i) { - return BottomNavigationBarItem( - icon: i.icon, - activeIcon: i.activeIcon, - label: i.title, - ); - }).toList(growable: false); - - @override - Widget build(BuildContext context) { - return ValueListenableBuilder( - valueListenable: context.inheritedNavigation.navigationIndex, - builder: (context, value, _) { - return BottomNavigationBar( - elevation: 6, - items: _bottom, - type: BottomNavigationBarType.fixed, - currentIndex: context.inheritedNavigation.navigationIndex.value, - onTap: (newIndex) { - context.inheritedNavigation.navigationIndex.value = newIndex; - }, - ); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/bottom_navigation_widget.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/bottom_navigation_widget.dart deleted file mode 100644 index 682e395e..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/bottom_navigation_widget.dart +++ /dev/null @@ -1,29 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/bottom_navigation_bar.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/scaffold_contents.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/tabbed_layout.dart'; -import 'package:flutter/material.dart'; - -/// The bottom navigation view of the [EquationScaffold] used when the viewport -/// is small enough. -class BottomNavigationWidget extends StatelessWidget { - /// Creates a [BottomNavigationWidget] widget. - const BottomNavigationWidget({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return Scaffold( - key: const Key('TabbedNavigationLayout-Scaffold'), - body: const ScaffoldContents( - body: TabbedNavigationLayout(), - ), - bottomNavigationBar: BottomNavigation( - navigationItems: context.inheritedNavigation.navigationItems, - ), - floatingActionButton: context.inheritedNavigation.fab, - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/navigation_item.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/navigation_item.dart deleted file mode 100644 index 1e27ad72..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/navigation_item.dart +++ /dev/null @@ -1,46 +0,0 @@ -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:flutter/material.dart'; - -/// An interactive item within an [EquationScaffold] navigation bar widget. -final class NavigationItem { - /// The title of the item. - final String title; - - /// The default icon to be shown. - final Widget icon; - - /// The icon to be shown when the item is selected. - final Widget activeIcon; - - /// The content of the page. - final Widget content; - - /// Creates a [NavigationItem] widget. Both icons default to - /// [Icons.multiline_chart]. - const NavigationItem({ - required this.title, - required this.content, - this.icon = const Icon(Icons.multiline_chart), - this.activeIcon = const Icon(Icons.multiline_chart), - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is NavigationItem) { - return runtimeType == other.runtimeType && - title == other.title && - icon == other.icon && - activeIcon == other.activeIcon && - content == other.content; - } else { - return false; - } - } - - @override - int get hashCode => Object.hash(title, icon, activeIcon, content); -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/rail_navigation.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/rail_navigation.dart deleted file mode 100644 index fd9670af..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/rail_navigation.dart +++ /dev/null @@ -1,64 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/tabbed_layout.dart'; -import 'package:flutter/material.dart'; - -/// A rail navigation bar to be displayed within an [EquationScaffold] widget. -class RailNavigation extends StatefulWidget { - /// Creates a [RailNavigation] widget. - const RailNavigation({ - super.key, - }); - - @override - State createState() => _RailNavigationState(); -} - -class _RailNavigationState extends State { - /// Converts a [NavigationItem] into a [BottomNavigationBarItem]. - /// - /// There is no need to update this into 'didUpdateWidget' because navigation - /// items won't change during the app's lifetime. - late final rails = context.inheritedNavigation.navigationItems - .map((i) { - return NavigationRailDestination( - icon: i.icon, - selectedIcon: i.activeIcon, - label: Text(i.title), - ); - }).toList(growable: false); - - @override - Widget build(BuildContext context) { - return Row( - children: [ - // The actual contents of the page - const Expanded( - child: TabbedNavigationLayout(), - ), - - // The separator between the rail and the contents - const VerticalDivider( - thickness: 2, - width: 1, - ), - - // The navigation rail - ValueListenableBuilder( - valueListenable: context.inheritedNavigation.navigationIndex, - builder: (context, value, _) { - return NavigationRail( - groupAlignment: 0, - destinations: rails, - selectedIndex: value, - labelType: NavigationRailLabelType.all, - onDestinationSelected: (newIndex) => - context.inheritedNavigation.navigationIndex.value = newIndex, - ); - }, - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/rail_navigation_widget.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/rail_navigation_widget.dart deleted file mode 100644 index aab27944..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/rail_navigation_widget.dart +++ /dev/null @@ -1,25 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/rail_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/scaffold_contents.dart'; -import 'package:flutter/material.dart'; - -/// The rail navigation view of the [EquationScaffold] used when the viewport -/// is big enough. -class RailNavigationWidget extends StatelessWidget { - /// Creates a [RailNavigationWidget] widget. - const RailNavigationWidget({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return Scaffold( - key: const Key('RailNavigationLayout-Scaffold'), - body: const ScaffoldContents( - body: RailNavigation(), - ), - floatingActionButton: context.inheritedNavigation.fab, - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/scaffold_contents.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/scaffold_contents.dart deleted file mode 100644 index 4a2e4eb0..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/scaffold_contents.dart +++ /dev/null @@ -1,91 +0,0 @@ -import 'dart:math' as math; - -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; - -/// The content of the [EquationScaffold] scaffold, which is simply a [Stack] -/// with two children: -/// -/// 1. A background widget that draws an SVG image as background; -/// 2. A foreground widget which is the actual content of the page. -/// -/// If there is enough space in the horizontal axis, an additional background -/// image is added. -class ScaffoldContents extends StatelessWidget { - /// The body of the [Scaffold] - final Widget body; - - /// Creates a [ScaffoldContents] widget. - const ScaffoldContents({ - required this.body, - super.key, - }); - - @override - Widget build(BuildContext context) { - return SafeArea( - child: Stack( - children: [ - // The background image of the page - const Positioned( - bottom: -70, - left: -30, - child: _ScaffoldBackground(), - ), - - const Positioned( - top: 20, - right: 80, - child: _ScaffoldExtraBackground(), - ), - - // The actual contents in the foreground - Positioned.fill( - child: body, - ), - ], - ), - ); - } -} - -/// The background image in the [ScaffoldContents] widget. -class _ScaffoldBackground extends StatelessWidget { - /// Creates a [_ScaffoldBackground] widget. - const _ScaffoldBackground(); - - @override - Widget build(BuildContext context) { - return Transform.rotate( - angle: -math.pi / 8, - child: CartesianPlaneBackground( - key: const Key('ScaffoldBackground'), - size: MediaQuery.of(context).size.height / 1.2, - ), - ); - } -} - -/// The secondary background image in the [ScaffoldContents] widget, which may -/// not always be visible. The visibility of the image depends on the -/// [extraBackgroundBreakpoint] break point. -class _ScaffoldExtraBackground extends StatelessWidget { - /// Creates a [_ScaffoldExtraBackground] widget. - const _ScaffoldExtraBackground(); - - @override - Widget build(BuildContext context) { - final viewportSize = MediaQuery.of(context).size.width; - final pictureSize = MediaQuery.of(context).size.shortestSide / 2; - - return Visibility( - visible: viewportSize >= extraBackgroundBreakpoint, - child: GaussianCurveBackground( - key: const Key('ScaffoldExtraBackground'), - size: pictureSize, - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/equation_scaffold/tabbed_layout.dart b/example/flutter_example/lib/routes/utils/equation_scaffold/tabbed_layout.dart deleted file mode 100644 index d0418d7a..00000000 --- a/example/flutter_example/lib/routes/utils/equation_scaffold/tabbed_layout.dart +++ /dev/null @@ -1,58 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:flutter/material.dart'; - -/// This widget is wrapper of a [TabBarView] where the user cannot swipe to -/// change tabs. -/// -/// Tabs can be changed only according with the state of the notifier exposed -/// by [InheritedNavigation]. -class TabbedNavigationLayout extends StatefulWidget { - /// Creates a [TabbedNavigationLayout] widget. - const TabbedNavigationLayout({ - super.key, - }); - - @override - TabbedNavigationLayoutState createState() => TabbedNavigationLayoutState(); -} - -/// The state of the [TabbedNavigationLayout] widget. -@visibleForTesting -class TabbedNavigationLayoutState extends State { - /// The various pages of the [TabBarView]. - /// - /// There is no need to update this into 'didUpdateWidget' because tabs won't - /// change during the app's lifetime. - late final tabPages = context.inheritedNavigation.navigationItems - .map((item) => item.content) - .toList(growable: false); - - /// Changes the currently visible page of the tab. - void changePage(int pageIndex) { - context.inheritedNavigation.tabController.animateTo(pageIndex); - } - - @override - Widget build(BuildContext context) { - final platform = Theme.of(context).platform; - - // Detects whether the application is running on a mobile device or not. - final isMobile = platform == TargetPlatform.android || - platform == TargetPlatform.iOS || - platform == TargetPlatform.fuchsia; - - return ValueListenableBuilder( - valueListenable: context.inheritedNavigation.navigationIndex, - builder: (_, value, child) { - changePage(value); - - return child!; - }, - child: TabBarView( - physics: isMobile ? null : const NeverScrollableScrollPhysics(), - controller: context.inheritedNavigation.tabController, - children: tabPages, - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/input_kind_dialog_button.dart b/example/flutter_example/lib/routes/utils/input_kind_dialog_button.dart deleted file mode 100644 index 5854beee..00000000 --- a/example/flutter_example/lib/routes/utils/input_kind_dialog_button.dart +++ /dev/null @@ -1,226 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:flutter/material.dart'; - -/// Determines which message should the [InputKindDialogButton] widget show. In -/// particular: -/// -/// - [InputKindMessage.numbers] will show a message saying that only numbers -/// and constants (`e` and `pi`) are allowed. -/// -/// - [InputKindMessage.equations] will show a message saying that expressions -/// and functions (such as `sin` or `log`) are allowed. -enum InputKindMessage { - /// Only allows numbers and special constants (`e` and `pi` are allowed). - numbers, - - /// Equations with operators and functions are allowed. - equations, -} - -/// This is a wrapper of an [IconButton], containing an [Icons.info_outline], -/// that shows an [AlertDialog] telling which kind of inputs are allowed by -/// a form. -class InputKindDialogButton extends StatelessWidget { - /// Determines which inputs are allowed by a form. - final InputKindMessage inputKindMessage; - - /// Creates a [InputKindDialogButton] widget. - const InputKindDialogButton({ - required this.inputKindMessage, - super.key, - }); - - Future _buttonPressed(BuildContext context) async { - await showDialog( - context: context, - builder: (context) { - return AlertDialog( - scrollable: true, - title: Text('${context.l10n.input_allowed_values}:'), - content: Column( - children: [ - if (inputKindMessage == InputKindMessage.numbers) - const _AllowedNumbers() - else - const _AllowsFunctions(), - - // Button that closes the dialog - const Divider( - height: 35, - ), - - Center( - child: ElevatedButton( - onPressed: Navigator.of(context).pop, - child: const Text('OK'), - ), - ), - ], - ), - ); - }, - ); - } - - @override - Widget build(BuildContext context) { - return IconButton( - icon: const Icon( - Icons.info_outline, - size: 18, - ), - color: Colors.lightBlueAccent, - splashRadius: 18, - onPressed: () async => _buttonPressed(context), - ); - } -} - -/// Lists all allowed numbers and constants. -class _AllowedNumbers extends StatelessWidget { - /// Creates a [_AllowedNumbers] widget. - const _AllowedNumbers(); - - @override - Widget build(BuildContext context) { - return Column( - mainAxisSize: MainAxisSize.min, - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - Text(context.l10n.input_allowed_numbers), - Text(context.l10n.input_allowed_fractions), - Text(context.l10n.input_allowed_constants), - ], - ); - } -} - -/// Lists all allowed numbers, constants and mathematical functions. -class _AllowsFunctions extends StatelessWidget { - /// Creates a [_AllowsFunctions] widget. - const _AllowsFunctions(); - - @override - Widget build(BuildContext context) { - return Column( - mainAxisSize: MainAxisSize.min, - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - // Allows numbers - const _AllowedNumbers(), - - // Separator line - const Divider( - height: 35, - ), - - // Lists the supported functions - Text(context.l10n.input_allowed_functions), - const SizedBox(height: 15), - const Wrap( - runSpacing: 5, - spacing: 5, - children: [ - _FunctionCard(functionName: 'sqrt(x)'), - _FunctionCard(functionName: 'sin(x)'), - _FunctionCard(functionName: 'cos(x)'), - _FunctionCard(functionName: 'tan(x)'), - _FunctionCard(functionName: 'log(x)'), - _FunctionCard(functionName: 'acos(x)'), - _FunctionCard(functionName: 'asin(x)'), - _FunctionCard(functionName: 'atan(x)'), - _FunctionCard(functionName: 'csc(x)'), - _FunctionCard(functionName: 'sec(x)'), - ], - ), - - // Warning about the multiplication - const _MultiplicationSign(), - ], - ); - } -} - -/// A wrapper of [Card] that holds a mathematical function sign. This is used -/// within [_AllowsFunctions]. -class _FunctionCard extends StatelessWidget { - /// The function name. - final String functionName; - const _FunctionCard({ - required this.functionName, - }); - - @override - Widget build(BuildContext context) { - return Card( - elevation: 4, - margin: const EdgeInsets.all(5), - shadowColor: Colors.blue, - child: Padding( - padding: const EdgeInsets.all(8), - child: Text(functionName), - ), - ); - } -} - -class _MultiplicationSign extends StatelessWidget { - /// Creates a [_MultiplicationSign] widget. - const _MultiplicationSign(); - - @override - Widget build(BuildContext context) { - return Column( - mainAxisSize: MainAxisSize.min, - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - // Warning about the multiplication - Padding( - padding: const EdgeInsets.only( - top: 20, - bottom: 12, - ), - child: Text(context.l10n.input_allowed_multiplication_sign), - ), - - // Good example - const Text.rich( - TextSpan( - text: ' - ', - children: [ - TextSpan( - text: 'OK', - style: TextStyle( - color: Colors.lightGreen, - fontWeight: FontWeight.bold, - ), - ), - TextSpan( - text: ': 2*x-cos(3*x)', - ), - ], - ), - ), - - // Bad example - const Text.rich( - TextSpan( - text: ' - ', - children: [ - TextSpan( - text: 'NO', - style: TextStyle( - color: Colors.redAccent, - fontWeight: FontWeight.bold, - ), - ), - TextSpan( - text: ': 2x-cos(3x)', - ), - ], - ), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/no_results.dart b/example/flutter_example/lib/routes/utils/no_results.dart deleted file mode 100644 index dc4454d2..00000000 --- a/example/flutter_example/lib/routes/utils/no_results.dart +++ /dev/null @@ -1,25 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:flutter/material.dart'; - -/// A wrapper of [Text] simply stating that no results are available. -class NoResults extends StatelessWidget { - /// Creates a [NoResults] widget. - const NoResults({ - super.key, - }); - - @override - Widget build(BuildContext context) { - return Center( - child: Padding( - padding: const EdgeInsets.fromLTRB(80, 35, 80, 5), - child: Text( - context.l10n.no_solutions, - style: const TextStyle( - fontSize: 16, - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/plot_widget/color_area.dart b/example/flutter_example/lib/routes/utils/plot_widget/color_area.dart deleted file mode 100644 index bb0ffb4c..00000000 --- a/example/flutter_example/lib/routes/utils/plot_widget/color_area.dart +++ /dev/null @@ -1,51 +0,0 @@ -import 'package:equations_solver/routes/utils/plot_widget/equation_painter.dart'; -import 'package:flutter/material.dart'; - -/// Used in [EquationPainter] to color a portion of area below the function. -final class ColorArea { - /// The [Color] of the area below the function. - /// - /// By default, this is set to [Colors.transparent]. - final Color color; - - /// The point on the `x` axis from which starting to color the area. - final double startPoint; - - /// The point on the `x` axis where the area to color ends. - final double endPoint; - - /// Creates a [ColorArea] class to give instructions to a [EquationPainter] - /// about coloring the area below a function. - const ColorArea({ - required this.startPoint, - required this.endPoint, - this.color = Colors.transparent, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is ColorArea) { - return runtimeType == other.runtimeType && - color == other.color && - startPoint == other.startPoint && - endPoint == other.endPoint; - } else { - return false; - } - } - - @override - int get hashCode => Object.hash(color, startPoint, endPoint); - - @override - String toString() { - final start = startPoint.toStringAsFixed(2); - final end = endPoint.toStringAsFixed(2); - - return '$color from $start to $end'; - } -} diff --git a/example/flutter_example/lib/routes/utils/plot_widget/equation_drawer_widget.dart b/example/flutter_example/lib/routes/utils/plot_widget/equation_drawer_widget.dart deleted file mode 100644 index be3fe766..00000000 --- a/example/flutter_example/lib/routes/utils/plot_widget/equation_drawer_widget.dart +++ /dev/null @@ -1,154 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/utils/plot_widget/color_area.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_painter.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:flutter/material.dart'; - -/// This widget draws a cartesian plane and, if there's a [plotMode], it also -/// plots a real function `f(x)`. -/// -/// If [plotMode] is not `null`, then a plot_zoom is also added below the widget -/// to scale the image. -/// -/// If [plotMode] is `null`, the plot_zoom doesn't appear and the widget only -/// draws a cartesian plane (with no function within). -class EquationDrawerWidget extends StatelessWidget { - /// Provides the ability to evaluate a real function on a point. - final FunctionEvaluator? plotMode; - - /// The color that highlights the area below a function. - /// - /// By default, this is set to [Colors.transparent] so nothing will be - /// colored. - final Color areaColor; - - /// The lower limit that indicates from which point in the x axis the area - /// below the function has to be colored. - /// - /// By default, this is `null` meaning that no lower limits are applied (so - /// the entire region on the left is colored). - final double? lowerAreaLimit; - - /// The upper limit that indicates up to which point in the x axis the area - /// below the function has to be colored. - /// - /// By default, this is `null` meaning that no upper limits are applied (so - /// the entire region on the right is colored). - final double? upperAreaLimit; - - /// Creates a [EquationDrawerWidget] instance. - const EquationDrawerWidget({ - super.key, - this.areaColor = Colors.transparent, - this.plotMode, - this.lowerAreaLimit, - this.upperAreaLimit, - }); - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.fromLTRB(50, 45, 50, 40), - child: Column( - mainAxisSize: MainAxisSize.min, - children: [ - // The plot - _PlotBody( - plotMode: plotMode, - areaColor: areaColor, - lowerAreaLimit: lowerAreaLimit, - upperAreaLimit: upperAreaLimit, - ), - - // Some spacing - const SizedBox(height: 35), - - // Placing the slider ONLY if there's a function - if (plotMode != null) const _PlotSlider(), - ], - ), - ); - } -} - -class _PlotBody extends StatelessWidget { - /// The [FunctionEvaluator] object. - final FunctionEvaluator? plotMode; - - /// The color that highlights the area below a function. - final Color areaColor; - - /// The lower limit that indicates from which point in the x axis the area - /// below the function has to be colored. - final double? lowerAreaLimit; - - /// The upper limit that indicates up to which point in the x axis the area - /// below the function has to be colored. - final double? upperAreaLimit; - - /// Creates a [_PlotBody] widget. - const _PlotBody({ - required this.plotMode, - required this.areaColor, - required this.lowerAreaLimit, - required this.upperAreaLimit, - super.key, - }); - - @override - Widget build(BuildContext context) { - return Material( - elevation: 8, - borderRadius: const BorderRadius.all(Radius.circular(20)), - child: ClipRRect( - borderRadius: const BorderRadius.all(Radius.circular(20)), - child: ListenableBuilder( - listenable: context.plotZoomState, - builder: (context, state) { - return LayoutBuilder( - builder: (context, sizes) { - final normalized = sizes.normalize().maxWidth; - - return CustomPaint( - painter: EquationPainter( - plotMode: plotMode, - range: context.plotZoomState.zoom.round(), - colorArea: ColorArea( - color: areaColor, - startPoint: lowerAreaLimit ?? -context.plotZoomState.zoom, - endPoint: upperAreaLimit ?? context.plotZoomState.zoom, - ), - ), - size: Size.square(normalized), - ); - }, - ); - }, - ), - ), - ); - } -} - -class _PlotSlider extends StatelessWidget { - const _PlotSlider(); - - void update(BuildContext context, double value) => - context.plotZoomState.updateSlider(value); - - @override - Widget build(BuildContext context) { - return ListenableBuilder( - listenable: context.plotZoomState, - builder: (context, state) { - return Slider( - min: 2, - max: 10, - value: context.plotZoomState.zoom, - onChanged: (value) => update(context, value), - label: '${context.plotZoomState.zoom.round()}', - ); - }, - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/plot_widget/equation_painter.dart b/example/flutter_example/lib/routes/utils/plot_widget/equation_painter.dart deleted file mode 100644 index 6514eac0..00000000 --- a/example/flutter_example/lib/routes/utils/plot_widget/equation_painter.dart +++ /dev/null @@ -1,169 +0,0 @@ -import 'package:equations_solver/routes/utils/plot_widget/color_area.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:flutter/material.dart'; - -/// A [CustomPainter] that creates a XY cartesian plane and draws any kind of -/// mathematical function on it. Thanks to its [range] parameter, the user is -/// able to define the "scale" of the plot (or the "zoom"). -class EquationPainter extends CustomPainter { - /// Provides the ability to evaluate a real function on a point. - /// - /// If this is `null` then the painter only draws a cartesian plane (without - /// a function). - final FunctionEvaluator? plotMode; - - /// The 'scale' of the plot - final int range; - - /// The [ColorArea] object used to retrieve info about the color of the area - /// below the function. - final ColorArea colorArea; - - /// Draws a cartesian plane with a grey grid lines and black (thick) X and Y - /// axis. The function instead is plotted in [Colors.blueAccent]. - const EquationPainter({ - required this.plotMode, - this.range = 5, - this.colorArea = const ColorArea( - startPoint: 5, - endPoint: 5, - ), - }); - - @override - void paint(Canvas canvas, Size size) { - _drawMainAxis(canvas, size); - _drawAxis(canvas, size); - - // Drawing the function ONLY if there's an evaluator available - if (plotMode != null) { - _drawEquation(canvas, size); - } - } - - @override - bool shouldRepaint(covariant EquationPainter oldDelegate) { - return range != oldDelegate.range || - plotMode != oldDelegate.plotMode || - colorArea != oldDelegate.colorArea; - } - - void _drawMainAxis(Canvas canvas, Size size) { - final blackThick = Paint() - ..color = Colors.black - ..strokeWidth = 2.0; - - // Draws the main X and Y axis - canvas - ..drawLine( - Offset(0, size.height / 2), - Offset(size.width, size.height / 2), - blackThick, - ) - ..drawLine( - Offset(size.width / 2, 0), - Offset(size.width / 2, size.height), - blackThick, - ); - } - - void _drawAxis(Canvas canvas, Size size) { - final line = Paint() - ..color = Colors.blueGrey - ..strokeWidth = 1.0; - - // X and Y axis - final scale = range; - final distX = (size.width / 2) / scale; - final distY = (size.height / 2) / scale; - - var prevPoint = Offset(distX, 0); - var currPoint = Offset(0, distY); - - // Drawing the grid (with scaling) - for (var i = -scale; i < scale; ++i) { - if (i == 0) { - continue; - } - - canvas - ..drawLine(prevPoint, Offset(prevPoint.dx, size.height), line) - ..drawLine(currPoint, Offset(size.width, currPoint.dy), line); - - prevPoint = Offset(prevPoint.dx + distX, prevPoint.dy); - currPoint = Offset(currPoint.dx, currPoint.dy + distY); - } - } - - void _drawEquation(Canvas canvas, Size size) { - final line = Paint() - ..color = Colors.blueAccent - ..strokeWidth = 2.0; - - final area = Paint() - ..color = colorArea.color - ..strokeWidth = 1.0; - - var logy = 0.0; - var logx = 0.0; - - final width = size.width; - final height = size.height; - - var currPoint = Offset.zero; - var prevPoint = Offset.zero; - - // In case the user entered the startPoint greater than the endPoint, we - // swap the values - var actualColorArea = colorArea; - - if (colorArea.startPoint > colorArea.endPoint) { - actualColorArea = ColorArea( - startPoint: colorArea.endPoint, - endPoint: colorArea.startPoint, - color: colorArea.color, - ); - } - - for (var i = 0; i < size.width; ++i) { - logx = _screenToLog(Offset(i * 1.0, 0), width, height).dx; - - // Using '!' on 'plotMode' here is safe because this function is called - // only if 'plotMode != null' (see the 'paint' method above) - logy = plotMode!.evaluateOn(logx); - - final pts = Offset(logx, logy); - currPoint = Offset(i * 1.0, _logToScreen(pts, width, height).dy); - - if (currPoint.dx > 0) { - canvas.drawLine(currPoint, prevPoint, line); - } - - // Highlighting the area below the function ONLY if a color is defined - if (actualColorArea.color != Colors.transparent) { - final xAxis = Offset(currPoint.dx, size.height / 2); - - if (logx >= actualColorArea.startPoint && - logx <= actualColorArea.endPoint) { - canvas.drawLine(xAxis, currPoint, area); - } - } - - prevPoint = currPoint; - } - } - - Offset _screenToLog(Offset screenPoint, double width, double height) { - return Offset( - -range + (screenPoint.dx / width) * (range + range), - -range + (height - screenPoint.dy) * (range + range), - ); - } - - Offset _logToScreen(Offset logPoint, double width, double height) { - return Offset( - width * (logPoint.dx + range) / (range + range), - height - height * (logPoint.dy + range) / (range + range), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/plot_widget/function_evaluators.dart b/example/flutter_example/lib/routes/utils/plot_widget/function_evaluators.dart deleted file mode 100644 index c4507f6d..00000000 --- a/example/flutter_example/lib/routes/utils/plot_widget/function_evaluators.dart +++ /dev/null @@ -1,63 +0,0 @@ -import 'package:equations/equations.dart'; - -/// This class provides the ability to evaluate a function on a given point. The -/// [equation] dependency defines the behavior of [evaluateOn]. -sealed class FunctionEvaluator { - /// The equation object that defines the [evaluateOn] method. - final T equation; - - /// Creates an instance of [FunctionEvaluator]. - const FunctionEvaluator(this.equation); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is FunctionEvaluator) { - return runtimeType == other.runtimeType && equation == other.equation; - } else { - return false; - } - } - - @override - int get hashCode => equation.hashCode; - - /// Evaluates the [equation] on the specified real number [x]. - double evaluateOn(double x); -} - -/// Polynomial functions evaluator. -class PolynomialEvaluator extends FunctionEvaluator { - /// Creates an instance of [PolynomialEvaluator]. - const PolynomialEvaluator({ - required Algebraic algebraic, - }) : super(algebraic); - - @override - double evaluateOn(double x) => equation.realEvaluateOn(x).real; -} - -/// Nonlinear functions evaluator. -class NonlinearEvaluator extends FunctionEvaluator { - /// Creates an instance of [NonlinearEvaluator]. - const NonlinearEvaluator({ - required NonLinear nonLinear, - }) : super(nonLinear); - - @override - double evaluateOn(double x) => equation.evaluateOn(x) as double; -} - -/// Integral functions evaluator. -class IntegralEvaluator extends FunctionEvaluator { - /// Creates an instance of [IntegralEvaluator]. - const IntegralEvaluator({ - required NumericalIntegration function, - }) : super(function); - - @override - double evaluateOn(double x) => equation.evaluateFunction(x); -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/bool_result_card.dart b/example/flutter_example/lib/routes/utils/result_cards/bool_result_card.dart deleted file mode 100644 index f7681fbf..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/bool_result_card.dart +++ /dev/null @@ -1,39 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// This widget shows a [bool] value into a [Card] widget. -class BoolResultCard extends StatelessWidget { - /// The value to be displayed. - final bool value; - - /// Text to be displayed in front of the boolean value. - final String leading; - - /// Creates a [BoolResultCard] widget. - const BoolResultCard({ - required this.value, - required this.leading, - super.key, - }); - - @override - Widget build(BuildContext context) { - final localizedValue = value ? context.l10n.yes : context.l10n.no; - - return Center( - child: Padding( - padding: const EdgeInsets.only(top: 35), - child: SizedBox( - width: cardWidgetsWidth, - child: Card( - elevation: 5, - child: ListTile( - title: Text('$leading$localizedValue'), - ), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/colored_text.dart b/example/flutter_example/lib/routes/utils/result_cards/colored_text.dart deleted file mode 100644 index fe943e3a..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/colored_text.dart +++ /dev/null @@ -1,37 +0,0 @@ -import 'package:flutter/material.dart'; - -/// Appends a leading blue string in front of the actual string value. -class ColoredText extends StatelessWidget { - /// The blue leading text. - final String leading; - - /// The actual string value. - final String value; - - /// Creates a [ColoredText] widget. - const ColoredText({ - required this.leading, - required this.value, - super.key, - }); - - @override - Widget build(BuildContext context) { - return Text.rich( - TextSpan( - text: leading, - style: const TextStyle( - color: Colors.blue, - ), - children: [ - TextSpan( - text: value, - style: const TextStyle( - color: Colors.black, - ), - ), - ], - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/complex_result_card.dart b/example/flutter_example/lib/routes/utils/result_cards/complex_result_card.dart deleted file mode 100644 index c484017a..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/complex_result_card.dart +++ /dev/null @@ -1,123 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:equations_solver/routes/utils/result_cards/colored_text.dart'; -import 'package:equations_solver/routes/utils/result_cards/number_printer_extension.dart'; -import 'package:flutter/material.dart'; - -/// This widget shows a [Complex] value into a [Card] widget and expands to show -/// other details. -class ComplexResultCard extends StatelessWidget { - /// The number to be displayed. - /// - /// This value is printed with [resultCardPrecisionDigits] decimal digits. - final Complex value; - - /// Text displayed in front of [value]. - /// - /// By default, this value is an empty string. - final String leading; - - /// Widget displayed after [value]. - /// - /// By default, this value is initialized with [SizedBox.shrink]. - final Widget trailing; - - /// Creates a [ComplexResultCard] widget. - const ComplexResultCard({ - required this.value, - this.leading = '', - this.trailing = const SizedBox.shrink(), - super.key, - }); - - String _printComplex({ - required BuildContext context, - required Complex value, - bool isPrimary = true, - }) { - if (!value.real.isFinite || !value.imaginary.isFinite) { - return context.l10n.not_computed; - } - - return isPrimary - ? value.toStringApproximated(resultCardPrecisionDigits) - : '$value'; - } - - String _printComplexFraction({ - required BuildContext context, - required Complex value, - }) { - try { - return value.toStringAsFraction(); - } on Exception { - return context.l10n.not_computed; - } - } - - @override - Widget build(BuildContext context) { - final fraction = _printComplexFraction(context: context, value: value); - final primaryText = _printComplex(context: context, value: value); - final secondaryText = _printComplex( - context: context, - value: value, - isPrimary: false, - ); - - return SizedBox( - width: cardWidgetsWidth, - child: Card( - margin: const EdgeInsets.only(top: 35), - elevation: 5, - child: Collapsible( - primary: Row( - children: [ - Expanded( - child: Text( - '$leading$primaryText', - style: const TextStyle( - fontSize: 15, - ), - ), - ), - trailing, - ], - ), - secondary: Column( - mainAxisSize: MainAxisSize.min, - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - // Not approximated value - ColoredText( - leading: context.l10n.more_digits, - value: secondaryText, - ), - - const SizedBox(height: 15), - - // Fraction - ColoredText( - leading: context.l10n.fraction, - value: ': $fraction', - ), - - const SizedBox(height: 8), - - // Warning - Text( - context.l10n.fraction_warning, - style: const TextStyle( - color: Colors.blueGrey, - fontSize: 12, - ), - ), - ], - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/message_card.dart b/example/flutter_example/lib/routes/utils/result_cards/message_card.dart deleted file mode 100644 index bde81400..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/message_card.dart +++ /dev/null @@ -1,29 +0,0 @@ -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter/material.dart'; - -/// A wrapper of [Card] that displays a message. -class MessageCard extends StatelessWidget { - /// The message. - final String message; - - /// Creates a [MessageCard] widget. - const MessageCard({required this.message, super.key}); - - @override - Widget build(BuildContext context) { - return SizedBox( - width: cardWidgetsWidth, - child: Card( - margin: const EdgeInsets.only(top: 35), - elevation: 5, - child: Padding( - padding: const EdgeInsets.all(14), - child: Align( - alignment: Alignment.centerLeft, - child: Text(message), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/number_printer_extension.dart b/example/flutter_example/lib/routes/utils/result_cards/number_printer_extension.dart deleted file mode 100644 index 04c0bbca..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/number_printer_extension.dart +++ /dev/null @@ -1,57 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:intl/intl.dart'; - -/// Extension method on [num] that adds the [toStringApproximated] function. -extension RealNumberPrinter on num { - /// Prints a decimal number with [maxFractionDigits] without trailing zeroes. - /// An exception is thrown if [maxFractionDigits] is negative. For example: - /// - /// ```dart - /// 5.254.toStringApproximated(2) // 5.25 - /// 5.254.toStringApproximated(5) // 5.254 - /// 5.254.toStringApproximated(0) // 5 - /// 5.254.toStringApproximated(-1) // Exception! - /// ``` - String toStringApproximated(int maxFractionDigits) { - if (maxFractionDigits.isNegative) { - throw const FormatException('Fraction digits value cannot be negative.'); - } - - final formatter = NumberFormat() - ..minimumFractionDigits = 0 - ..maximumFractionDigits = maxFractionDigits; - - return formatter.format(this); - } -} - -/// Extension method on [Complex] that adds the [toStringApproximated] function. -extension ComplexNumberPrinter on Complex { - /// Prints a complex number with [maxFractionDigits] without trailing zeroes. - /// An exception is thrown if [maxFractionDigits] is negative. For example: - /// - /// ```dart - /// Complex(1.1543, 3.9847).toStringApproximated(2) // 1.15 + 3.98i - /// Complex(1.154, 3.9847).toStringApproximated(5) // 1.154 + 3.9847i - /// Complex(1.154, 3.9847).toStringApproximated(0) // 1 + 4i - /// Complex(1.154, 3.9847).toStringApproximated(-1) // Exception! - /// ``` - String toStringApproximated(int maxFractionDigits) { - if (maxFractionDigits.isNegative) { - throw const FormatException('Fraction digits value cannot be negative.'); - } - - final buffer = StringBuffer(); - final formatter = NumberFormat() - ..minimumFractionDigits = 0 - ..maximumFractionDigits = maxFractionDigits; - - buffer - ..write(formatter.format(real)) - ..write(imaginary.isNegative ? ' - ' : ' + ') - ..write(formatter.format(imaginary.abs())) - ..write('i'); - - return buffer.toString(); - } -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/polynomial_result_card.dart b/example/flutter_example/lib/routes/utils/result_cards/polynomial_result_card.dart deleted file mode 100644 index 4889a467..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/polynomial_result_card.dart +++ /dev/null @@ -1,88 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; - -/// This widget shows a [Algebraic] value into a [Card] widget and expands to -/// show other details. -class PolynomialResultCard extends StatelessWidget { - /// The [Algebraic] type to be displayed. - /// - /// The coefficients are printed with [resultCardPrecisionDigits] decimal - /// digits. - final Algebraic algebraic; - - /// Creates a [PolynomialResultCard] widget. - const PolynomialResultCard({ - required this.algebraic, - super.key, - }); - - @override - Widget build(BuildContext context) { - return Column( - mainAxisSize: MainAxisSize.min, - children: [ - for (var i = 0; i < algebraic.coefficients.length; ++i) - ComplexResultCard( - value: algebraic.coefficients[i], - trailing: Padding( - padding: const EdgeInsets.symmetric( - horizontal: 4, - ), - child: _ExponentOnVariable( - exponent: i, - ), - ), - ), - ], - ); - } -} - -/// Nicely prints the exponent as superscript next to the `x` letter, like -/// x2. There are two exceptions: -/// -/// - the exponent isn't displayed when [exponent] is `1`; -/// - nothing is displayed when [exponent] is zero. -class _ExponentOnVariable extends StatelessWidget { - /// The exponent of the `x` unknown. - final int exponent; - - /// Creates an [_ExponentOnVariable] widget. - const _ExponentOnVariable({ - required this.exponent, - }); - - @override - Widget build(BuildContext context) { - if (exponent == 0) { - return const SizedBox.shrink(); - } - - return Row( - mainAxisSize: MainAxisSize.min, - children: [ - // The 'x' unknown - const Text( - 'x', - style: TextStyle( - fontSize: 16, - ), - ), - - // The superscript - if (exponent > 1) - Padding( - padding: const EdgeInsets.only(bottom: 10), - child: Text( - '$exponent', - style: const TextStyle( - fontSize: 12, - ), - ), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/result_cards/real_result_card.dart b/example/flutter_example/lib/routes/utils/result_cards/real_result_card.dart deleted file mode 100644 index 579a9f19..00000000 --- a/example/flutter_example/lib/routes/utils/result_cards/real_result_card.dart +++ /dev/null @@ -1,110 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:equations_solver/routes/utils/result_cards/colored_text.dart'; -import 'package:equations_solver/routes/utils/result_cards/number_printer_extension.dart'; -import 'package:flutter/material.dart'; - -/// This widget shows a [double] value into a [Card] widget and expands to show -/// other details. -class RealResultCard extends StatelessWidget { - /// The number to be displayed. - /// - /// This value is printed with [resultCardPrecisionDigits] decimal digits. - final double value; - - /// Text displayed in front of [value]. - /// - /// By default, this value is an empty string. - final String leading; - - /// Creates a [RealResultCard] widget. - const RealResultCard({ - required this.value, - this.leading = '', - super.key, - }); - - String _printDecimal({ - required BuildContext context, - required double value, - bool isPrimary = true, - }) { - if (!value.isFinite) { - return context.l10n.not_computed; - } - - return isPrimary - ? value.toStringApproximated(resultCardPrecisionDigits) - : '$value'; - } - - String _printFraction({ - required BuildContext context, - required double value, - }) { - try { - return value.toFraction().toString(); - } on Exception { - return context.l10n.not_computed; - } - } - - @override - Widget build(BuildContext context) { - final fraction = _printFraction(context: context, value: value); - final primaryText = _printDecimal(context: context, value: value); - final secondaryText = _printDecimal( - context: context, - value: value, - isPrimary: false, - ); - - return SizedBox( - width: cardWidgetsWidth, - child: Card( - margin: const EdgeInsets.only(top: 35), - elevation: 5, - child: Collapsible( - primary: Text( - '$leading$primaryText', - style: const TextStyle( - fontSize: 15, - ), - ), - secondary: Column( - mainAxisSize: MainAxisSize.min, - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - // Not approximated value - ColoredText( - leading: context.l10n.more_digits, - value: secondaryText, - ), - - const SizedBox(height: 15), - - // Fraction - ColoredText( - leading: context.l10n.fraction, - value: ': $fraction', - ), - - const SizedBox(height: 8), - - // Warning - Text( - context.l10n.fraction_warning, - style: const TextStyle( - color: Colors.blueGrey, - fontSize: 12, - ), - ), - ], - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/section_title.dart b/example/flutter_example/lib/routes/utils/section_title.dart deleted file mode 100644 index 1953260a..00000000 --- a/example/flutter_example/lib/routes/utils/section_title.dart +++ /dev/null @@ -1,42 +0,0 @@ -import 'package:flutter/material.dart'; - -/// This widget is used as "separator" in lists or columns to define different -/// portions of UI. It's made up of an icon on the left and some text on the -/// right. -class SectionTitle extends StatelessWidget { - /// The title of the page. - final String pageTitle; - - /// The image associate to the title (appearing to the left). - final Widget icon; - - /// Creates a [SectionTitle] widget. - const SectionTitle({ - required this.pageTitle, - required this.icon, - super.key, - }); - - @override - Widget build(BuildContext context) { - return Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - Padding( - padding: const EdgeInsets.only(right: 20), - child: icon, - ), - Flexible( - child: Text( - pageTitle, - style: const TextStyle( - fontSize: 26, - color: Colors.blueGrey, - overflow: TextOverflow.ellipsis, - ), - ), - ), - ], - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/svg_images/svg_image.dart b/example/flutter_example/lib/routes/utils/svg_images/svg_image.dart deleted file mode 100644 index 46affffd..00000000 --- a/example/flutter_example/lib/routes/utils/svg_images/svg_image.dart +++ /dev/null @@ -1,28 +0,0 @@ -import 'package:flutter/material.dart'; -import 'package:flutter_svg/flutter_svg.dart'; - -/// A base class for all of the SVG wrapper widgets. -abstract class SvgImage extends StatelessWidget { - /// The size of the svg image. - /// - /// By default, this is set to `40`. - final double size; - - /// Creates a [SvgImage] widget, - const SvgImage({ - super.key, - this.size = 40, - }); - - /// The name of the Svg asset file. - String get assetName; - - @override - Widget build(BuildContext context) { - return SvgPicture.asset( - 'assets/svg/$assetName.svg', - height: size, - width: size, - ); - } -} diff --git a/example/flutter_example/lib/routes/utils/svg_images/types/sections_logos.dart b/example/flutter_example/lib/routes/utils/svg_images/types/sections_logos.dart deleted file mode 100644 index 054ed46f..00000000 --- a/example/flutter_example/lib/routes/utils/svg_images/types/sections_logos.dart +++ /dev/null @@ -1,61 +0,0 @@ -import 'package:equations_solver/routes/utils/svg_images/svg_image.dart'; - -/// Vectorial logo for polynomial equations. -class PolynomialLogo extends SvgImage { - /// Creates an [PolynomialLogo] widget. - const PolynomialLogo({ - super.key, - super.size, - }); - - @override - String get assetName => 'polynomial'; -} - -/// Vectorial logo for nonlinear equations. -class NonlinearLogo extends SvgImage { - /// Creates an [NonlinearLogo] widget. - const NonlinearLogo({ - super.key, - super.size, - }); - - @override - String get assetName => 'function'; -} - -/// Vectorial logo for systems of equations. -class SystemsLogo extends SvgImage { - /// Creates an [SystemsLogo] widget. - const SystemsLogo({ - super.key, - super.size, - }); - - @override - String get assetName => 'matrix'; -} - -/// Vectorial logo for integrals. -class IntegralLogo extends SvgImage { - /// Creates an [IntegralLogo] widget. - const IntegralLogo({ - super.key, - super.size, - }); - - @override - String get assetName => 'integral'; -} - -/// Vectorial logo for the "other" section. -class OtherLogo extends SvgImage { - /// Creates an [OtherLogo] widget. - const OtherLogo({ - super.key, - super.size, - }); - - @override - String get assetName => 'wrench'; -} diff --git a/example/flutter_example/lib/routes/utils/svg_images/types/vectorial_images.dart b/example/flutter_example/lib/routes/utils/svg_images/types/vectorial_images.dart deleted file mode 100644 index 1dea632e..00000000 --- a/example/flutter_example/lib/routes/utils/svg_images/types/vectorial_images.dart +++ /dev/null @@ -1,145 +0,0 @@ -import 'package:equations_solver/routes/utils/svg_images/svg_image.dart'; - -/// The application logo. -class ApplicationLogo extends SvgImage { - /// Creates a [ApplicationLogo] widget. - const ApplicationLogo({ - super.key, - super.size, - }); - - @override - String get assetName => 'logo'; -} - -/// A rotated cartesian plane. -class CartesianPlaneBackground extends SvgImage { - /// Creates a [CartesianPlaneBackground] widget. - const CartesianPlaneBackground({ - super.key, - super.size, - }); - - @override - String get assetName => 'axis'; -} - -/// A stylized gaussian curve. -class GaussianCurveBackground extends SvgImage { - /// Creates a [GaussianCurveBackground] widget. - const GaussianCurveBackground({ - super.key, - super.size, - }); - - @override - String get assetName => 'plot_opacity'; -} - -/// The "i" symbol of the complex unit in imaginary numbers. -class OtherComplexNumbers extends SvgImage { - /// Creates a [OtherComplexNumbers] widget. - const OtherComplexNumbers({ - super.key, - super.size, - }); - - @override - String get assetName => 'tools_imaginary'; -} - -/// A 3x4 matrix with a linear gradient going from green to blue. -class OtherMatrix extends SvgImage { - /// Creates a [OtherMatrix] widget. - const OtherMatrix({ - super.key, - super.size, - }); - - @override - String get assetName => 'tools_matrix'; -} - -/// A square matrix whose entries are blue numbers. -class SquareMatrix extends SvgImage { - /// Creates a [SquareMatrix] widget. - const SquareMatrix({ - super.key, - super.size, - }); - - @override - String get assetName => 'square_matrix'; -} - -/// The square root with a blue 'x' variable and the black sign. -class SquareRoot extends SvgImage { - /// Creates a [SquareRoot] widget. - const SquareRoot({ - super.key, - super.size, - }); - - @override - String get assetName => 'square-root-simple'; -} - -/// A 45 degree angle image. -class HalfRightAngle extends SvgImage { - /// Creates a [HalfRightAngle] widget. - const HalfRightAngle({ - super.key, - super.size, - }); - - @override - String get assetName => 'angle'; -} - -/// A cartesian plane with a stylized gaussian curve. -class CartesianPlane extends SvgImage { - /// Creates an [CartesianPlane] widget. - const CartesianPlane({ - super.key, - super.size, - }); - - @override - String get assetName => 'plot'; -} - -/// A simple equation in the 'x' variable -class EquationSolution extends SvgImage { - /// Creates an [EquationSolution] widget. - const EquationSolution({ - super.key, - super.size, - }); - - @override - String get assetName => 'solutions'; -} - -/// Some atoms linked by a grey line. -class Atoms extends SvgImage { - /// Creates an [Atoms] widget. - const Atoms({ - super.key, - super.size, - }); - - @override - String get assetName => 'atoms'; -} - -/// A red cloud with a white cross at the bottom-middle of its body. -class UrlError extends SvgImage { - /// Creates an [UrlError] widget. - const UrlError({ - super.key, - super.size, - }); - - @override - String get assetName => 'url_error'; -} diff --git a/example/flutter_example/linux/.gitignore b/example/flutter_example/linux/.gitignore deleted file mode 100644 index c7ea17fc..00000000 --- a/example/flutter_example/linux/.gitignore +++ /dev/null @@ -1 +0,0 @@ -flutter/ephemeral diff --git a/example/flutter_example/linux/CMakeLists.txt b/example/flutter_example/linux/CMakeLists.txt deleted file mode 100644 index 9da659f2..00000000 --- a/example/flutter_example/linux/CMakeLists.txt +++ /dev/null @@ -1,139 +0,0 @@ -# Project-level configuration. -cmake_minimum_required(VERSION 3.10) -project(equations_solver LANGUAGES CXX) - -# The name of the executable created for the application. Change this to change -# the on-disk name of your application. -set(BINARY_NAME "Equations Solver") - -# The unique GTK application identifier for this application. See: -# https://wiki.gnome.org/HowDoI/ChooseApplicationID -set(APPLICATION_ID "com.fluttercompletereference.flutter_example") - -# Explicitly opt in to modern CMake behaviors to avoid warnings with recent -# versions of CMake. -cmake_policy(SET CMP0063 NEW) - -# Load bundled libraries from the lib/ directory relative to the binary. -set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") - -# Root filesystem for cross-building. -if(FLUTTER_TARGET_PLATFORM_SYSROOT) - set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) - set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) - set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) - set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) - set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) - set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) -endif() - -# Define build configuration options. -if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) - set(CMAKE_BUILD_TYPE "Debug" CACHE - STRING "Flutter build mode" FORCE) - set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS - "Debug" "Profile" "Release") -endif() - -# Compilation settings that should be applied to most targets. -# -# Be cautious about adding new options here, as plugins use this function by -# default. In most cases, you should add new options to specific targets instead -# of modifying this function. -function(APPLY_STANDARD_SETTINGS TARGET) - target_compile_features(${TARGET} PUBLIC cxx_std_14) - target_compile_options(${TARGET} PRIVATE -Wall -Werror) - target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") - target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") -endfunction() - -# Flutter library and tool build rules. -set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") -add_subdirectory(${FLUTTER_MANAGED_DIR}) - -# System-level dependencies. -find_package(PkgConfig REQUIRED) -pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) - -add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") - -# Define the application target. To change its name, change BINARY_NAME above, -# not the value here, or `flutter run` will no longer work. -# -# Any new source files that you add to the application should be added here. -add_executable(${BINARY_NAME} - "main.cc" - "my_application.cc" - "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" -) - -# Apply the standard set of build settings. This can be removed for applications -# that need different build settings. -apply_standard_settings(${BINARY_NAME}) - -# Add dependency libraries. Add any application-specific dependencies here. -target_link_libraries(${BINARY_NAME} PRIVATE flutter) -target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) - -# Run the Flutter tool portions of the build. This must not be removed. -add_dependencies(${BINARY_NAME} flutter_assemble) - -# Only the install-generated bundle's copy of the executable will launch -# correctly, since the resources must in the right relative locations. To avoid -# people trying to run the unbundled copy, put it in a subdirectory instead of -# the default top-level location. -set_target_properties(${BINARY_NAME} - PROPERTIES - RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" -) - -# Generated plugin build rules, which manage building the plugins and adding -# them to the application. -include(flutter/generated_plugins.cmake) - - -# === Installation === -# By default, "installing" just makes a relocatable bundle in the build -# directory. -set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") -if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) - set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) -endif() - -# Start with a clean build bundle directory every time. -install(CODE " - file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") - " COMPONENT Runtime) - -set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") -set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") - -install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" - COMPONENT Runtime) - -install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" - COMPONENT Runtime) - -install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) - -foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) - install(FILES "${bundled_library}" - DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) -endforeach(bundled_library) - -# Fully re-copy the assets directory on each build to avoid having stale files -# from a previous install. -set(FLUTTER_ASSET_DIR_NAME "flutter_assets") -install(CODE " - file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") - " COMPONENT Runtime) -install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" - DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) - -# Install the AOT library on non-Debug builds only. -if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") - install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) -endif() diff --git a/example/flutter_example/linux/flutter/CMakeLists.txt b/example/flutter_example/linux/flutter/CMakeLists.txt deleted file mode 100644 index 27860e80..00000000 --- a/example/flutter_example/linux/flutter/CMakeLists.txt +++ /dev/null @@ -1,88 +0,0 @@ -# This file controls Flutter-level build steps. It should not be edited. -cmake_minimum_required(VERSION 3.10) - -set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") - -# Configuration provided via flutter tool. -include(${EPHEMERAL_DIR}/generated_config.cmake) - -# TODO: Move the rest of this into files in ephemeral. See -# https://github.com/flutter/flutter/issues/57146. - -# Serves the same purpose as list(TRANSFORM ... PREPEND ...), -# which isn't available in 3.10. -function(list_prepend LIST_NAME PREFIX) - set(NEW_LIST "") - foreach(element ${${LIST_NAME}}) - list(APPEND NEW_LIST "${PREFIX}${element}") - endforeach(element) - set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) -endfunction() - -# === Flutter Library === -# System-level dependencies. -find_package(PkgConfig REQUIRED) -pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) -pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) -pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) - -set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") - -# Published to parent scope for install step. -set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) -set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) -set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) -set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) - -list(APPEND FLUTTER_LIBRARY_HEADERS - "fl_basic_message_channel.h" - "fl_binary_codec.h" - "fl_binary_messenger.h" - "fl_dart_project.h" - "fl_engine.h" - "fl_json_message_codec.h" - "fl_json_method_codec.h" - "fl_message_codec.h" - "fl_method_call.h" - "fl_method_channel.h" - "fl_method_codec.h" - "fl_method_response.h" - "fl_plugin_registrar.h" - "fl_plugin_registry.h" - "fl_standard_message_codec.h" - "fl_standard_method_codec.h" - "fl_string_codec.h" - "fl_value.h" - "fl_view.h" - "flutter_linux.h" -) -list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") -add_library(flutter INTERFACE) -target_include_directories(flutter INTERFACE - "${EPHEMERAL_DIR}" -) -target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") -target_link_libraries(flutter INTERFACE - PkgConfig::GTK - PkgConfig::GLIB - PkgConfig::GIO -) -add_dependencies(flutter flutter_assemble) - -# === Flutter tool backend === -# _phony_ is a non-existent file to force this command to run every time, -# since currently there's no way to get a full input/output list from the -# flutter tool. -add_custom_command( - OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} - ${CMAKE_CURRENT_BINARY_DIR}/_phony_ - COMMAND ${CMAKE_COMMAND} -E env - ${FLUTTER_TOOL_ENVIRONMENT} - "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" - ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} - VERBATIM -) -add_custom_target(flutter_assemble DEPENDS - "${FLUTTER_LIBRARY}" - ${FLUTTER_LIBRARY_HEADERS} -) diff --git a/example/flutter_example/linux/flutter/generated_plugin_registrant.cc b/example/flutter_example/linux/flutter/generated_plugin_registrant.cc deleted file mode 100644 index e71a16d2..00000000 --- a/example/flutter_example/linux/flutter/generated_plugin_registrant.cc +++ /dev/null @@ -1,11 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#include "generated_plugin_registrant.h" - - -void fl_register_plugins(FlPluginRegistry* registry) { -} diff --git a/example/flutter_example/linux/flutter/generated_plugin_registrant.h b/example/flutter_example/linux/flutter/generated_plugin_registrant.h deleted file mode 100644 index e0f0a47b..00000000 --- a/example/flutter_example/linux/flutter/generated_plugin_registrant.h +++ /dev/null @@ -1,15 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#ifndef GENERATED_PLUGIN_REGISTRANT_ -#define GENERATED_PLUGIN_REGISTRANT_ - -#include - -// Registers Flutter plugins. -void fl_register_plugins(FlPluginRegistry* registry); - -#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/flutter_example/linux/flutter/generated_plugins.cmake b/example/flutter_example/linux/flutter/generated_plugins.cmake deleted file mode 100644 index 2e1de87a..00000000 --- a/example/flutter_example/linux/flutter/generated_plugins.cmake +++ /dev/null @@ -1,23 +0,0 @@ -# -# Generated file, do not edit. -# - -list(APPEND FLUTTER_PLUGIN_LIST -) - -list(APPEND FLUTTER_FFI_PLUGIN_LIST -) - -set(PLUGIN_BUNDLED_LIBRARIES) - -foreach(plugin ${FLUTTER_PLUGIN_LIST}) - add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) - target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) - list(APPEND PLUGIN_BUNDLED_LIBRARIES $) - list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) -endforeach(plugin) - -foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) - add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) - list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) -endforeach(ffi_plugin) diff --git a/example/flutter_example/linux/main.cc b/example/flutter_example/linux/main.cc deleted file mode 100644 index 4340ffc1..00000000 --- a/example/flutter_example/linux/main.cc +++ /dev/null @@ -1,6 +0,0 @@ -#include "my_application.h" - -int main(int argc, char** argv) { - g_autoptr(MyApplication) app = my_application_new(); - return g_application_run(G_APPLICATION(app), argc, argv); -} diff --git a/example/flutter_example/linux/my_application.cc b/example/flutter_example/linux/my_application.cc deleted file mode 100644 index 6bb0add4..00000000 --- a/example/flutter_example/linux/my_application.cc +++ /dev/null @@ -1,104 +0,0 @@ -#include "my_application.h" - -#include -#ifdef GDK_WINDOWING_X11 -#include -#endif - -#include "flutter/generated_plugin_registrant.h" - -struct _MyApplication { - GtkApplication parent_instance; - char** dart_entrypoint_arguments; -}; - -G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) - -// Implements GApplication::activate. -static void my_application_activate(GApplication* application) { - MyApplication* self = MY_APPLICATION(application); - GtkWindow* window = - GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); - - // Use a header bar when running in GNOME as this is the common style used - // by applications and is the setup most users will be using (e.g. Ubuntu - // desktop). - // If running on X and not using GNOME then just use a traditional title bar - // in case the window manager does more exotic layout, e.g. tiling. - // If running on Wayland assume the header bar will work (may need changing - // if future cases occur). - gboolean use_header_bar = TRUE; -#ifdef GDK_WINDOWING_X11 - GdkScreen* screen = gtk_window_get_screen(window); - if (GDK_IS_X11_SCREEN(screen)) { - const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); - if (g_strcmp0(wm_name, "GNOME Shell") != 0) { - use_header_bar = FALSE; - } - } -#endif - if (use_header_bar) { - GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); - gtk_widget_show(GTK_WIDGET(header_bar)); - gtk_header_bar_set_title(header_bar, "Equations Solver"); - gtk_header_bar_set_show_close_button(header_bar, TRUE); - gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); - } else { - gtk_window_set_title(window, "Equations Solver"); - } - - gtk_window_set_default_size(window, 1280, 720); - gtk_widget_show(GTK_WIDGET(window)); - - g_autoptr(FlDartProject) project = fl_dart_project_new(); - fl_dart_project_set_dart_entrypoint_arguments(project, self->dart_entrypoint_arguments); - - FlView* view = fl_view_new(project); - gtk_widget_show(GTK_WIDGET(view)); - gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); - - fl_register_plugins(FL_PLUGIN_REGISTRY(view)); - - gtk_widget_grab_focus(GTK_WIDGET(view)); -} - -// Implements GApplication::local_command_line. -static gboolean my_application_local_command_line(GApplication* application, gchar*** arguments, int* exit_status) { - MyApplication* self = MY_APPLICATION(application); - // Strip out the first argument as it is the binary name. - self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); - - g_autoptr(GError) error = nullptr; - if (!g_application_register(application, nullptr, &error)) { - g_warning("Failed to register: %s", error->message); - *exit_status = 1; - return TRUE; - } - - g_application_activate(application); - *exit_status = 0; - - return TRUE; -} - -// Implements GObject::dispose. -static void my_application_dispose(GObject* object) { - MyApplication* self = MY_APPLICATION(object); - g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); - G_OBJECT_CLASS(my_application_parent_class)->dispose(object); -} - -static void my_application_class_init(MyApplicationClass* klass) { - G_APPLICATION_CLASS(klass)->activate = my_application_activate; - G_APPLICATION_CLASS(klass)->local_command_line = my_application_local_command_line; - G_OBJECT_CLASS(klass)->dispose = my_application_dispose; -} - -static void my_application_init(MyApplication* self) {} - -MyApplication* my_application_new() { - return MY_APPLICATION(g_object_new(my_application_get_type(), - "application-id", APPLICATION_ID, - "flags", G_APPLICATION_NON_UNIQUE, - nullptr)); -} diff --git a/example/flutter_example/linux/my_application.h b/example/flutter_example/linux/my_application.h deleted file mode 100644 index 8f20fb55..00000000 --- a/example/flutter_example/linux/my_application.h +++ /dev/null @@ -1,18 +0,0 @@ -#ifndef FLUTTER_MY_APPLICATION_H_ -#define FLUTTER_MY_APPLICATION_H_ - -#include - -G_DECLARE_FINAL_TYPE(MyApplication, my_application, MY, APPLICATION, - GtkApplication) - -/** - * my_application_new: - * - * Creates a new Flutter-based application. - * - * Returns: a new #MyApplication. - */ -MyApplication* my_application_new(); - -#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/example/flutter_example/macos/.gitignore b/example/flutter_example/macos/.gitignore deleted file mode 100644 index 746adbb6..00000000 --- a/example/flutter_example/macos/.gitignore +++ /dev/null @@ -1,7 +0,0 @@ -# Flutter-related -**/Flutter/ephemeral/ -**/Pods/ - -# Xcode-related -**/dgph -**/xcuserdata/ diff --git a/example/flutter_example/macos/Flutter/Flutter-Debug.xcconfig b/example/flutter_example/macos/Flutter/Flutter-Debug.xcconfig deleted file mode 100644 index 4b81f9b2..00000000 --- a/example/flutter_example/macos/Flutter/Flutter-Debug.xcconfig +++ /dev/null @@ -1,2 +0,0 @@ -#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" -#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/example/flutter_example/macos/Flutter/Flutter-Release.xcconfig b/example/flutter_example/macos/Flutter/Flutter-Release.xcconfig deleted file mode 100644 index 5caa9d15..00000000 --- a/example/flutter_example/macos/Flutter/Flutter-Release.xcconfig +++ /dev/null @@ -1,2 +0,0 @@ -#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" -#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/example/flutter_example/macos/Flutter/GeneratedPluginRegistrant.swift b/example/flutter_example/macos/Flutter/GeneratedPluginRegistrant.swift deleted file mode 100644 index cccf817a..00000000 --- a/example/flutter_example/macos/Flutter/GeneratedPluginRegistrant.swift +++ /dev/null @@ -1,10 +0,0 @@ -// -// Generated file. Do not edit. -// - -import FlutterMacOS -import Foundation - - -func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { -} diff --git a/example/flutter_example/macos/Podfile b/example/flutter_example/macos/Podfile deleted file mode 100644 index 049abe29..00000000 --- a/example/flutter_example/macos/Podfile +++ /dev/null @@ -1,40 +0,0 @@ -platform :osx, '10.14' - -# CocoaPods analytics sends network stats synchronously affecting flutter build latency. -ENV['COCOAPODS_DISABLE_STATS'] = 'true' - -project 'Runner', { - 'Debug' => :debug, - 'Profile' => :release, - 'Release' => :release, -} - -def flutter_root - generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'ephemeral', 'Flutter-Generated.xcconfig'), __FILE__) - unless File.exist?(generated_xcode_build_settings_path) - raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure \"flutter pub get\" is executed first" - end - - File.foreach(generated_xcode_build_settings_path) do |line| - matches = line.match(/FLUTTER_ROOT\=(.*)/) - return matches[1].strip if matches - end - raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Flutter-Generated.xcconfig, then run \"flutter pub get\"" -end - -require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) - -flutter_macos_podfile_setup - -target 'Runner' do - use_frameworks! - use_modular_headers! - - flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__)) -end - -post_install do |installer| - installer.pods_project.targets.each do |target| - flutter_additional_macos_build_settings(target) - end -end diff --git a/example/flutter_example/macos/Podfile.lock b/example/flutter_example/macos/Podfile.lock deleted file mode 100644 index d4b359af..00000000 --- a/example/flutter_example/macos/Podfile.lock +++ /dev/null @@ -1,16 +0,0 @@ -PODS: - - FlutterMacOS (1.0.0) - -DEPENDENCIES: - - FlutterMacOS (from `Flutter/ephemeral`) - -EXTERNAL SOURCES: - FlutterMacOS: - :path: Flutter/ephemeral - -SPEC CHECKSUMS: - FlutterMacOS: 8f6f14fa908a6fb3fba0cd85dbd81ec4b251fb24 - -PODFILE CHECKSUM: 353c8bcc5d5b0994e508d035b5431cfe18c1dea7 - -COCOAPODS: 1.12.1 diff --git a/example/flutter_example/macos/Runner.xcodeproj/project.pbxproj b/example/flutter_example/macos/Runner.xcodeproj/project.pbxproj deleted file mode 100644 index 75ddc65c..00000000 --- a/example/flutter_example/macos/Runner.xcodeproj/project.pbxproj +++ /dev/null @@ -1,615 +0,0 @@ -// !$*UTF8*$! -{ - archiveVersion = 1; - classes = { - }; - objectVersion = 54; - objects = { - -/* Begin PBXAggregateTarget section */ - 33CC111A2044C6BA0003C045 /* Flutter Assemble */ = { - isa = PBXAggregateTarget; - buildConfigurationList = 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */; - buildPhases = ( - 33CC111E2044C6BF0003C045 /* ShellScript */, - ); - dependencies = ( - ); - name = "Flutter Assemble"; - productName = FLX; - }; -/* End PBXAggregateTarget section */ - -/* Begin PBXBuildFile section */ - 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; - 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; - 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; - 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; }; - 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; }; - 76B1E06BF774404AA5CEBC2F /* Pods_Runner.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3918F6132FD0BB955E9BBDF2 /* Pods_Runner.framework */; }; -/* End PBXBuildFile section */ - -/* Begin PBXContainerItemProxy section */ - 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */ = { - isa = PBXContainerItemProxy; - containerPortal = 33CC10E52044A3C60003C045 /* Project object */; - proxyType = 1; - remoteGlobalIDString = 33CC111A2044C6BA0003C045; - remoteInfo = FLX; - }; -/* End PBXContainerItemProxy section */ - -/* Begin PBXCopyFilesBuildPhase section */ - 33CC110E2044A8840003C045 /* Bundle Framework */ = { - isa = PBXCopyFilesBuildPhase; - buildActionMask = 2147483647; - dstPath = ""; - dstSubfolderSpec = 10; - files = ( - ); - name = "Bundle Framework"; - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXCopyFilesBuildPhase section */ - -/* Begin PBXFileReference section */ - 03FBF17CA45827E0FB14A202 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = ""; }; - 1FB54FB8063A5C0BC0541E45 /* Pods-Runner.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.release.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"; sourceTree = ""; }; - 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; - 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; - 33CC10ED2044A3C60003C045 /* flutter_example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = flutter_example.app; sourceTree = BUILT_PRODUCTS_DIR; }; - 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; - 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; - 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; - 33CC10F72044A3C60003C045 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Runner/Info.plist; sourceTree = ""; }; - 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MainFlutterWindow.swift; sourceTree = ""; }; - 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Debug.xcconfig"; sourceTree = ""; }; - 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Release.xcconfig"; sourceTree = ""; }; - 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = "Flutter-Generated.xcconfig"; path = "ephemeral/Flutter-Generated.xcconfig"; sourceTree = ""; }; - 33E51913231747F40026EE4D /* DebugProfile.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = DebugProfile.entitlements; sourceTree = ""; }; - 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; - 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; - 3918F6132FD0BB955E9BBDF2 /* Pods_Runner.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Runner.framework; sourceTree = BUILT_PRODUCTS_DIR; }; - 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; - 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; - E92D0D2FC6DE0AB639D22F31 /* Pods-Runner.profile.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.profile.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.profile.xcconfig"; sourceTree = ""; }; -/* End PBXFileReference section */ - -/* Begin PBXFrameworksBuildPhase section */ - 33CC10EA2044A3C60003C045 /* Frameworks */ = { - isa = PBXFrameworksBuildPhase; - buildActionMask = 2147483647; - files = ( - 76B1E06BF774404AA5CEBC2F /* Pods_Runner.framework in Frameworks */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXFrameworksBuildPhase section */ - -/* Begin PBXGroup section */ - 281FE511AD565E7C2EACF62F /* Pods */ = { - isa = PBXGroup; - children = ( - 03FBF17CA45827E0FB14A202 /* Pods-Runner.debug.xcconfig */, - 1FB54FB8063A5C0BC0541E45 /* Pods-Runner.release.xcconfig */, - E92D0D2FC6DE0AB639D22F31 /* Pods-Runner.profile.xcconfig */, - ); - name = Pods; - path = Pods; - sourceTree = ""; - }; - 33BA886A226E78AF003329D5 /* Configs */ = { - isa = PBXGroup; - children = ( - 33E5194F232828860026EE4D /* AppInfo.xcconfig */, - 9740EEB21CF90195004384FC /* Debug.xcconfig */, - 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, - 333000ED22D3DE5D00554162 /* Warnings.xcconfig */, - ); - path = Configs; - sourceTree = ""; - }; - 33CC10E42044A3C60003C045 = { - isa = PBXGroup; - children = ( - 33FAB671232836740065AC1E /* Runner */, - 33CEB47122A05771004F2AC0 /* Flutter */, - 33CC10EE2044A3C60003C045 /* Products */, - D73912EC22F37F3D000D13A0 /* Frameworks */, - 281FE511AD565E7C2EACF62F /* Pods */, - ); - sourceTree = ""; - }; - 33CC10EE2044A3C60003C045 /* Products */ = { - isa = PBXGroup; - children = ( - 33CC10ED2044A3C60003C045 /* flutter_example.app */, - ); - name = Products; - sourceTree = ""; - }; - 33CC11242044D66E0003C045 /* Resources */ = { - isa = PBXGroup; - children = ( - 33CC10F22044A3C60003C045 /* Assets.xcassets */, - 33CC10F42044A3C60003C045 /* MainMenu.xib */, - 33CC10F72044A3C60003C045 /* Info.plist */, - ); - name = Resources; - path = ..; - sourceTree = ""; - }; - 33CEB47122A05771004F2AC0 /* Flutter */ = { - isa = PBXGroup; - children = ( - 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */, - 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */, - 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */, - 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */, - ); - path = Flutter; - sourceTree = ""; - }; - 33FAB671232836740065AC1E /* Runner */ = { - isa = PBXGroup; - children = ( - 33CC10F02044A3C60003C045 /* AppDelegate.swift */, - 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */, - 33E51913231747F40026EE4D /* DebugProfile.entitlements */, - 33E51914231749380026EE4D /* Release.entitlements */, - 33CC11242044D66E0003C045 /* Resources */, - 33BA886A226E78AF003329D5 /* Configs */, - ); - path = Runner; - sourceTree = ""; - }; - D73912EC22F37F3D000D13A0 /* Frameworks */ = { - isa = PBXGroup; - children = ( - 3918F6132FD0BB955E9BBDF2 /* Pods_Runner.framework */, - ); - name = Frameworks; - sourceTree = ""; - }; -/* End PBXGroup section */ - -/* Begin PBXNativeTarget section */ - 33CC10EC2044A3C60003C045 /* Runner */ = { - isa = PBXNativeTarget; - buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; - buildPhases = ( - D9773A7C4392AA926D478124 /* [CP] Check Pods Manifest.lock */, - 33CC10E92044A3C60003C045 /* Sources */, - 33CC10EA2044A3C60003C045 /* Frameworks */, - 33CC10EB2044A3C60003C045 /* Resources */, - 33CC110E2044A8840003C045 /* Bundle Framework */, - 3399D490228B24CF009A79C7 /* ShellScript */, - ); - buildRules = ( - ); - dependencies = ( - 33CC11202044C79F0003C045 /* PBXTargetDependency */, - ); - name = Runner; - productName = Runner; - productReference = 33CC10ED2044A3C60003C045 /* flutter_example.app */; - productType = "com.apple.product-type.application"; - }; -/* End PBXNativeTarget section */ - -/* Begin PBXProject section */ - 33CC10E52044A3C60003C045 /* Project object */ = { - isa = PBXProject; - attributes = { - LastSwiftUpdateCheck = 0920; - LastUpgradeCheck = 1430; - ORGANIZATIONNAME = ""; - TargetAttributes = { - 33CC10EC2044A3C60003C045 = { - CreatedOnToolsVersion = 9.2; - LastSwiftMigration = 1100; - ProvisioningStyle = Automatic; - SystemCapabilities = { - com.apple.Sandbox = { - enabled = 1; - }; - }; - }; - 33CC111A2044C6BA0003C045 = { - CreatedOnToolsVersion = 9.2; - ProvisioningStyle = Manual; - }; - }; - }; - buildConfigurationList = 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */; - compatibilityVersion = "Xcode 9.3"; - developmentRegion = en; - hasScannedForEncodings = 0; - knownRegions = ( - en, - Base, - ); - mainGroup = 33CC10E42044A3C60003C045; - productRefGroup = 33CC10EE2044A3C60003C045 /* Products */; - projectDirPath = ""; - projectRoot = ""; - targets = ( - 33CC10EC2044A3C60003C045 /* Runner */, - 33CC111A2044C6BA0003C045 /* Flutter Assemble */, - ); - }; -/* End PBXProject section */ - -/* Begin PBXResourcesBuildPhase section */ - 33CC10EB2044A3C60003C045 /* Resources */ = { - isa = PBXResourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */, - 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXResourcesBuildPhase section */ - -/* Begin PBXShellScriptBuildPhase section */ - 3399D490228B24CF009A79C7 /* ShellScript */ = { - isa = PBXShellScriptBuildPhase; - alwaysOutOfDate = 1; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - ); - outputFileListPaths = ( - ); - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "echo \"$PRODUCT_NAME.app\" > \"$PROJECT_DIR\"/Flutter/ephemeral/.app_filename && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh embed\n"; - }; - 33CC111E2044C6BF0003C045 /* ShellScript */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - Flutter/ephemeral/FlutterInputs.xcfilelist, - ); - inputPaths = ( - Flutter/ephemeral/tripwire, - ); - outputFileListPaths = ( - Flutter/ephemeral/FlutterOutputs.xcfilelist, - ); - outputPaths = ( - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; - }; - D9773A7C4392AA926D478124 /* [CP] Check Pods Manifest.lock */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - "${PODS_PODFILE_DIR_PATH}/Podfile.lock", - "${PODS_ROOT}/Manifest.lock", - ); - name = "[CP] Check Pods Manifest.lock"; - outputFileListPaths = ( - ); - outputPaths = ( - "$(DERIVED_FILE_DIR)/Pods-Runner-checkManifestLockResult.txt", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; - showEnvVarsInLog = 0; - }; -/* End PBXShellScriptBuildPhase section */ - -/* Begin PBXSourcesBuildPhase section */ - 33CC10E92044A3C60003C045 /* Sources */ = { - isa = PBXSourcesBuildPhase; - buildActionMask = 2147483647; - files = ( - 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */, - 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */, - 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */, - ); - runOnlyForDeploymentPostprocessing = 0; - }; -/* End PBXSourcesBuildPhase section */ - -/* Begin PBXTargetDependency section */ - 33CC11202044C79F0003C045 /* PBXTargetDependency */ = { - isa = PBXTargetDependency; - target = 33CC111A2044C6BA0003C045 /* Flutter Assemble */; - targetProxy = 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */; - }; -/* End PBXTargetDependency section */ - -/* Begin PBXVariantGroup section */ - 33CC10F42044A3C60003C045 /* MainMenu.xib */ = { - isa = PBXVariantGroup; - children = ( - 33CC10F52044A3C60003C045 /* Base */, - ); - name = MainMenu.xib; - path = Runner; - sourceTree = ""; - }; -/* End PBXVariantGroup section */ - -/* Begin XCBuildConfiguration section */ - 338D0CE9231458BD00FA5F75 /* Profile */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CODE_SIGN_IDENTITY = "-"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - ENABLE_NS_ASSERTIONS = NO; - ENABLE_STRICT_OBJC_MSGSEND = YES; - GCC_C_LANGUAGE_STANDARD = gnu11; - GCC_NO_COMMON_BLOCKS = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - MACOSX_DEPLOYMENT_TARGET = 10.14; - MTL_ENABLE_DEBUG_INFO = NO; - SDKROOT = macosx; - SWIFT_COMPILATION_MODE = wholemodule; - SWIFT_OPTIMIZATION_LEVEL = "-O"; - }; - name = Profile; - }; - 338D0CEA231458BD00FA5F75 /* Profile */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; - buildSettings = { - ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; - CLANG_ENABLE_MODULES = YES; - CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; - CODE_SIGN_STYLE = Automatic; - COMBINE_HIDPI_IMAGES = YES; - INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/../Frameworks", - ); - PROVISIONING_PROFILE_SPECIFIER = ""; - SWIFT_VERSION = 5.0; - }; - name = Profile; - }; - 338D0CEB231458BD00FA5F75 /* Profile */ = { - isa = XCBuildConfiguration; - buildSettings = { - CODE_SIGN_STYLE = Manual; - PRODUCT_NAME = "$(TARGET_NAME)"; - }; - name = Profile; - }; - 33CC10F92044A3C60003C045 /* Debug */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CODE_SIGN_IDENTITY = "-"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = dwarf; - ENABLE_STRICT_OBJC_MSGSEND = YES; - ENABLE_TESTABILITY = YES; - GCC_C_LANGUAGE_STANDARD = gnu11; - GCC_DYNAMIC_NO_PIC = NO; - GCC_NO_COMMON_BLOCKS = YES; - GCC_OPTIMIZATION_LEVEL = 0; - GCC_PREPROCESSOR_DEFINITIONS = ( - "DEBUG=1", - "$(inherited)", - ); - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - MACOSX_DEPLOYMENT_TARGET = 10.14; - MTL_ENABLE_DEBUG_INFO = YES; - ONLY_ACTIVE_ARCH = YES; - SDKROOT = macosx; - SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - }; - name = Debug; - }; - 33CC10FA2044A3C60003C045 /* Release */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; - buildSettings = { - ALWAYS_SEARCH_USER_PATHS = NO; - CLANG_ANALYZER_NONNULL = YES; - CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; - CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; - CLANG_CXX_LIBRARY = "libc++"; - CLANG_ENABLE_MODULES = YES; - CLANG_ENABLE_OBJC_ARC = YES; - CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; - CLANG_WARN_BOOL_CONVERSION = YES; - CLANG_WARN_CONSTANT_CONVERSION = YES; - CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; - CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; - CLANG_WARN_DOCUMENTATION_COMMENTS = YES; - CLANG_WARN_EMPTY_BODY = YES; - CLANG_WARN_ENUM_CONVERSION = YES; - CLANG_WARN_INFINITE_RECURSION = YES; - CLANG_WARN_INT_CONVERSION = YES; - CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; - CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; - CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; - CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; - CLANG_WARN_SUSPICIOUS_MOVE = YES; - CODE_SIGN_IDENTITY = "-"; - COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; - ENABLE_NS_ASSERTIONS = NO; - ENABLE_STRICT_OBJC_MSGSEND = YES; - GCC_C_LANGUAGE_STANDARD = gnu11; - GCC_NO_COMMON_BLOCKS = YES; - GCC_WARN_64_TO_32_BIT_CONVERSION = YES; - GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; - GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; - GCC_WARN_UNUSED_FUNCTION = YES; - GCC_WARN_UNUSED_VARIABLE = YES; - MACOSX_DEPLOYMENT_TARGET = 10.14; - MTL_ENABLE_DEBUG_INFO = NO; - SDKROOT = macosx; - SWIFT_COMPILATION_MODE = wholemodule; - SWIFT_OPTIMIZATION_LEVEL = "-O"; - }; - name = Release; - }; - 33CC10FC2044A3C60003C045 /* Debug */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; - buildSettings = { - ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; - CLANG_ENABLE_MODULES = YES; - CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; - CODE_SIGN_STYLE = Automatic; - COMBINE_HIDPI_IMAGES = YES; - INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/../Frameworks", - ); - PROVISIONING_PROFILE_SPECIFIER = ""; - SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - SWIFT_VERSION = 5.0; - }; - name = Debug; - }; - 33CC10FD2044A3C60003C045 /* Release */ = { - isa = XCBuildConfiguration; - baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; - buildSettings = { - ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; - CLANG_ENABLE_MODULES = YES; - CODE_SIGN_ENTITLEMENTS = Runner/Release.entitlements; - CODE_SIGN_STYLE = Automatic; - COMBINE_HIDPI_IMAGES = YES; - INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = ( - "$(inherited)", - "@executable_path/../Frameworks", - ); - PROVISIONING_PROFILE_SPECIFIER = ""; - SWIFT_VERSION = 5.0; - }; - name = Release; - }; - 33CC111C2044C6BA0003C045 /* Debug */ = { - isa = XCBuildConfiguration; - buildSettings = { - CODE_SIGN_STYLE = Manual; - PRODUCT_NAME = "$(TARGET_NAME)"; - }; - name = Debug; - }; - 33CC111D2044C6BA0003C045 /* Release */ = { - isa = XCBuildConfiguration; - buildSettings = { - CODE_SIGN_STYLE = Automatic; - PRODUCT_NAME = "$(TARGET_NAME)"; - }; - name = Release; - }; -/* End XCBuildConfiguration section */ - -/* Begin XCConfigurationList section */ - 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 33CC10F92044A3C60003C045 /* Debug */, - 33CC10FA2044A3C60003C045 /* Release */, - 338D0CE9231458BD00FA5F75 /* Profile */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 33CC10FC2044A3C60003C045 /* Debug */, - 33CC10FD2044A3C60003C045 /* Release */, - 338D0CEA231458BD00FA5F75 /* Profile */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; - 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */ = { - isa = XCConfigurationList; - buildConfigurations = ( - 33CC111C2044C6BA0003C045 /* Debug */, - 33CC111D2044C6BA0003C045 /* Release */, - 338D0CEB231458BD00FA5F75 /* Profile */, - ); - defaultConfigurationIsVisible = 0; - defaultConfigurationName = Release; - }; -/* End XCConfigurationList section */ - }; - rootObject = 33CC10E52044A3C60003C045 /* Project object */; -} diff --git a/example/flutter_example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/flutter_example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist deleted file mode 100644 index 18d98100..00000000 --- a/example/flutter_example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +++ /dev/null @@ -1,8 +0,0 @@ - - - - - IDEDidComputeMac32BitWarning - - - diff --git a/example/flutter_example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/flutter_example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme deleted file mode 100644 index 74197b28..00000000 --- a/example/flutter_example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/example/flutter_example/macos/Runner.xcworkspace/contents.xcworkspacedata b/example/flutter_example/macos/Runner.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 21a3cc14..00000000 --- a/example/flutter_example/macos/Runner.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/example/flutter_example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/flutter_example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist deleted file mode 100644 index 18d98100..00000000 --- a/example/flutter_example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +++ /dev/null @@ -1,8 +0,0 @@ - - - - - IDEDidComputeMac32BitWarning - - - diff --git a/example/flutter_example/macos/Runner/AppDelegate.swift b/example/flutter_example/macos/Runner/AppDelegate.swift deleted file mode 100644 index d53ef643..00000000 --- a/example/flutter_example/macos/Runner/AppDelegate.swift +++ /dev/null @@ -1,9 +0,0 @@ -import Cocoa -import FlutterMacOS - -@NSApplicationMain -class AppDelegate: FlutterAppDelegate { - override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { - return true - } -} diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json deleted file mode 100644 index 8d4e7cb8..00000000 --- a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "images" : [ - { - "size" : "16x16", - "idiom" : "mac", - "filename" : "app_icon_16.png", - "scale" : "1x" - }, - { - "size" : "16x16", - "idiom" : "mac", - "filename" : "app_icon_32.png", - "scale" : "2x" - }, - { - "size" : "32x32", - "idiom" : "mac", - "filename" : "app_icon_32.png", - "scale" : "1x" - }, - { - "size" : "32x32", - "idiom" : "mac", - "filename" : "app_icon_64.png", - "scale" : "2x" - }, - { - "size" : "128x128", - "idiom" : "mac", - "filename" : "app_icon_128.png", - "scale" : "1x" - }, - { - "size" : "128x128", - "idiom" : "mac", - "filename" : "app_icon_256.png", - "scale" : "2x" - }, - { - "size" : "256x256", - "idiom" : "mac", - "filename" : "app_icon_256.png", - "scale" : "1x" - }, - { - "size" : "256x256", - "idiom" : "mac", - "filename" : "app_icon_512.png", - "scale" : "2x" - }, - { - "size" : "512x512", - "idiom" : "mac", - "filename" : "app_icon_512.png", - "scale" : "1x" - }, - { - "size" : "512x512", - "idiom" : "mac", - "filename" : "app_icon_1024.png", - "scale" : "2x" - } - ], - "info" : { - "version" : 1, - "author" : "xcode" - } -} diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png deleted file mode 100644 index 23d8a02b..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png deleted file mode 100644 index fcd08243..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png deleted file mode 100644 index 6cc75cf9..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png deleted file mode 100644 index ee217712..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png deleted file mode 100644 index 2f6831dd..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png deleted file mode 100644 index 7fe65a60..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png deleted file mode 100644 index daae4fde..00000000 Binary files a/example/flutter_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png and /dev/null differ diff --git a/example/flutter_example/macos/Runner/Base.lproj/MainMenu.xib b/example/flutter_example/macos/Runner/Base.lproj/MainMenu.xib deleted file mode 100644 index 80e867a4..00000000 --- a/example/flutter_example/macos/Runner/Base.lproj/MainMenu.xib +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/example/flutter_example/macos/Runner/Configs/AppInfo.xcconfig b/example/flutter_example/macos/Runner/Configs/AppInfo.xcconfig deleted file mode 100644 index ba843db8..00000000 --- a/example/flutter_example/macos/Runner/Configs/AppInfo.xcconfig +++ /dev/null @@ -1,14 +0,0 @@ -// Application-level settings for the Runner target. -// -// This may be replaced with something auto-generated from metadata (e.g., pubspec.yaml) in the -// future. If not, the values below would default to using the project name when this becomes a -// 'flutter create' template. - -// The application's name. By default this is also the title of the Flutter window. -PRODUCT_NAME = Equations Solver - -// The application's bundle identifier -PRODUCT_BUNDLE_IDENTIFIER = com.fluttercompletereference.flutterExample - -// The copyright displayed in application information -PRODUCT_COPYRIGHT = Copyright © 2022 com.fluttercompletereference. All rights reserved. diff --git a/example/flutter_example/macos/Runner/Configs/Debug.xcconfig b/example/flutter_example/macos/Runner/Configs/Debug.xcconfig deleted file mode 100644 index 36b0fd94..00000000 --- a/example/flutter_example/macos/Runner/Configs/Debug.xcconfig +++ /dev/null @@ -1,2 +0,0 @@ -#include "../../Flutter/Flutter-Debug.xcconfig" -#include "Warnings.xcconfig" diff --git a/example/flutter_example/macos/Runner/Configs/Release.xcconfig b/example/flutter_example/macos/Runner/Configs/Release.xcconfig deleted file mode 100644 index dff4f495..00000000 --- a/example/flutter_example/macos/Runner/Configs/Release.xcconfig +++ /dev/null @@ -1,2 +0,0 @@ -#include "../../Flutter/Flutter-Release.xcconfig" -#include "Warnings.xcconfig" diff --git a/example/flutter_example/macos/Runner/Configs/Warnings.xcconfig b/example/flutter_example/macos/Runner/Configs/Warnings.xcconfig deleted file mode 100644 index 42bcbf47..00000000 --- a/example/flutter_example/macos/Runner/Configs/Warnings.xcconfig +++ /dev/null @@ -1,13 +0,0 @@ -WARNING_CFLAGS = -Wall -Wconditional-uninitialized -Wnullable-to-nonnull-conversion -Wmissing-method-return-type -Woverlength-strings -GCC_WARN_UNDECLARED_SELECTOR = YES -CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES -CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE -CLANG_WARN__DUPLICATE_METHOD_MATCH = YES -CLANG_WARN_PRAGMA_PACK = YES -CLANG_WARN_STRICT_PROTOTYPES = YES -CLANG_WARN_COMMA = YES -GCC_WARN_STRICT_SELECTOR_MATCH = YES -CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES -CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES -GCC_WARN_SHADOW = YES -CLANG_WARN_UNREACHABLE_CODE = YES diff --git a/example/flutter_example/macos/Runner/DebugProfile.entitlements b/example/flutter_example/macos/Runner/DebugProfile.entitlements deleted file mode 100644 index dddb8a30..00000000 --- a/example/flutter_example/macos/Runner/DebugProfile.entitlements +++ /dev/null @@ -1,12 +0,0 @@ - - - - - com.apple.security.app-sandbox - - com.apple.security.cs.allow-jit - - com.apple.security.network.server - - - diff --git a/example/flutter_example/macos/Runner/Info.plist b/example/flutter_example/macos/Runner/Info.plist deleted file mode 100644 index 4789daa6..00000000 --- a/example/flutter_example/macos/Runner/Info.plist +++ /dev/null @@ -1,32 +0,0 @@ - - - - - CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIconFile - - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - APPL - CFBundleShortVersionString - $(FLUTTER_BUILD_NAME) - CFBundleVersion - $(FLUTTER_BUILD_NUMBER) - LSMinimumSystemVersion - $(MACOSX_DEPLOYMENT_TARGET) - NSHumanReadableCopyright - $(PRODUCT_COPYRIGHT) - NSMainNibFile - MainMenu - NSPrincipalClass - NSApplication - - diff --git a/example/flutter_example/macos/Runner/MainFlutterWindow.swift b/example/flutter_example/macos/Runner/MainFlutterWindow.swift deleted file mode 100644 index 2722837e..00000000 --- a/example/flutter_example/macos/Runner/MainFlutterWindow.swift +++ /dev/null @@ -1,15 +0,0 @@ -import Cocoa -import FlutterMacOS - -class MainFlutterWindow: NSWindow { - override func awakeFromNib() { - let flutterViewController = FlutterViewController.init() - let windowFrame = self.frame - self.contentViewController = flutterViewController - self.setFrame(windowFrame, display: true) - - RegisterGeneratedPlugins(registry: flutterViewController) - - super.awakeFromNib() - } -} diff --git a/example/flutter_example/macos/Runner/Release.entitlements b/example/flutter_example/macos/Runner/Release.entitlements deleted file mode 100644 index 852fa1a4..00000000 --- a/example/flutter_example/macos/Runner/Release.entitlements +++ /dev/null @@ -1,8 +0,0 @@ - - - - - com.apple.security.app-sandbox - - - diff --git a/example/flutter_example/macos/RunnerTests/RunnerTests.swift b/example/flutter_example/macos/RunnerTests/RunnerTests.swift deleted file mode 100644 index ba12981d..00000000 --- a/example/flutter_example/macos/RunnerTests/RunnerTests.swift +++ /dev/null @@ -1,12 +0,0 @@ -import FlutterMacOS -import Cocoa -import XCTest - -class RunnerTests: XCTestCase { - - func testExample() { - // If you add code to the Runner application, consider adding tests here. - // See https://developer.apple.com/documentation/xctest for more information about using XCTest. - } - -} diff --git a/example/flutter_example/pubspec.yaml b/example/flutter_example/pubspec.yaml deleted file mode 100644 index 7dcccde5..00000000 --- a/example/flutter_example/pubspec.yaml +++ /dev/null @@ -1,35 +0,0 @@ -name: equations_solver -description: An equation-solving application that uses the API of the 'equations' package. -version: 1.0.0+1 -publish_to: none - -environment: - sdk: ^3.1.0 - -dependencies: - equations: - path: ../../ - - flutter: - sdk: flutter - - flutter_localizations: - sdk: flutter - - flutter_svg: ^2.0.7 - go_router: ^10.1.0 - intl: ^0.18.1 - -dev_dependencies: - flutter_test: - sdk: flutter - - integration_test: - sdk: flutter - -flutter: - uses-material-design: true - generate: true - - assets: - - assets/svg/ diff --git a/example/flutter_example/test/double_approximation_matcher.dart b/example/flutter_example/test/double_approximation_matcher.dart deleted file mode 100644 index b424bb5d..00000000 --- a/example/flutter_example/test/double_approximation_matcher.dart +++ /dev/null @@ -1,58 +0,0 @@ -import 'package:flutter_test/flutter_test.dart'; - -/// A [Matcher] used to compare two [double]s value within some tolerated error. -/// -/// Comparing floating point values using `operator==` is dangerous since -/// floating point arithmetic is not precise Values close to zero or with too -/// much decimal digits may cause unexpected behaviors. -/// -/// This matcher makes sure that at least the first [precision] digits of the -/// tested value are equal. -class MoreOrLessEquals extends Matcher { - /// The value to be tested - final double value; - - /// The accuracy of the test - final double precision; - - /// Matches a value with another using the given [precision]. - const MoreOrLessEquals( - this.value, { - this.precision = 1.0e-12, - }) : assert(precision >= 0, 'The precision must be >= 0'); - - @override - // ignore: avoid-dynamic - bool matches( - // ignore: avoid_annotating_with_dynamic - dynamic object, - Map matchState, - ) { - if (object is double) { - return (object - value).abs() <= precision; - } - - return object == value; - } - - @override - Description describe(Description description) { - return description.add('$value (±$precision)'); - } - - @override - Description describeMismatch( - // ignore: avoid_annotating_with_dynamic - dynamic item, - Description mismatchDescription, - Map matchState, - bool verbose, - ) { - return super.describeMismatch( - item, - mismatchDescription, - matchState, - verbose, - )..add('$item is not in the range of $value (±$precision).'); - } -} diff --git a/example/flutter_example/test/localization/english_strings.dart b/example/flutter_example/test/localization/english_strings.dart deleted file mode 100644 index 20547af7..00000000 --- a/example/flutter_example/test/localization/english_strings.dart +++ /dev/null @@ -1,91 +0,0 @@ -const englishStrings = { - 'appTitle': 'Equations solver', - 'polynomials': 'Polynomials', - 'functions': 'Functions', - 'systems': 'Systems', - 'integrals': 'Integrals', - 'interpolation': 'Interpolation', - 'other': 'Other', - 'firstDegree': 'Linear', - 'secondDegree': 'Quadratic', - 'thirdDegree': 'Cubic', - 'fourthDegree': 'Quartic', - 'anyDegree': 'Any', - 'solution': 'Solution', - 'solutions': 'Solutions', - 'chart': 'Chart', - 'solve': 'Solve', - 'clean': 'Clean', - 'cancel': 'Cancel', - 'no_solutions': 'No solutions to display.', - 'no_chart': 'No chart to plot.', - 'no_discriminant': 'No discriminant.', - 'polynomial_error': "One or more coefficients aren't valid.", - 'wrong_input': 'Invalid input', - 'tap_more': 'Tap to see more details', - 'discriminant': 'Discriminant', - 'fraction': 'Fraction', - 'single_point': 'Single point', - 'bracketing': 'Bracketing', - 'precision': 'Precision', - 'convergence': 'Convergence', - 'efficiency': 'Efficiency', - 'not_computed': 'Not computed', - 'nonlinear_error': 'Wrong equation or parameters format.', - 'row_reduction': 'Row reduction', - 'factorization': 'Factorization', - 'iterative': 'Iterative', - 'size': 'Size', - 'matrix_size1': '1x1 matrix', - 'matrix_size2': '2x2 matrix', - 'matrix_size3': '3x3 matrix', - 'matrix_size4': '4x4 matrix', - 'matrix_description': 'The matrix with the equations coefficients', - 'vector_description': 'The vector with the known values', - 'sor_w': 'Relaxation factor', - 'jacobi_initial': 'Initial guesses vector', - 'singular_matrix_error': - 'The system cannot be solved because the matrix is singular!', - 'invalid_values': "One or more values aren't correct.", - 'matrices': 'Matrices', - 'linear': 'Linear', - 'analyze': 'Analyze', - 'results': 'Results', - 'wait_a_moment': 'Wait a moment...', - 'rank': 'Rank', - 'trace': 'Trace', - 'transpose': 'Transpose', - 'determinant': 'Determinant', - 'inverse': 'Inverse', - 'cofactor': 'Cofactor', - 'characteristicPolynomial': 'Characteristic polynomial', - 'eigenvalues': 'Eigenvalues', - 'properties': 'Properties', - 'complex_numbers': 'Complex numbers', - 'phase': 'Phase', - 'abs': 'Modulus / absolute value', - 'conjugate': 'Conjugate', - 'reciprocal': 'Reciprocal', - 'sqrt': 'Square root', - 'length': 'Length', - 'angle_deg': 'Angle (degree)', - 'angle_rad': 'Angle (radians)', - 'polar_coordinates': 'Polar coordinates', - 'yes': 'Yes', - 'no': 'No', - 'diagonal': 'Diagonal', - 'symmetric': 'Symmetric', - 'identity': 'Identity', - 'url_error': "This page doesn't exists!", - 'version': 'Version', - 'input_allowed_values': 'Allowed values', - 'input_allowed_numbers': ' - Decimal and integer numbers.', - 'input_allowed_fractions': ' - Fractions.', - 'input_allowed_constants': - ' - Constants: pi (3.1415), e (2.7182) and sqrt2 (1.4142).', - 'input_allowed_functions': 'The equation f(x) allows these functions:', - 'input_allowed_multiplication_sign': - 'The multiplication requires the sign. For example:', - 'more_digits': 'No approximation: ', - 'nonlinear_fail_converge': "The method didn't converge to a solution.", -}; diff --git a/example/flutter_example/test/localization/french_strings.dart b/example/flutter_example/test/localization/french_strings.dart deleted file mode 100644 index 140ab435..00000000 --- a/example/flutter_example/test/localization/french_strings.dart +++ /dev/null @@ -1,91 +0,0 @@ -const frenchStrings = { - 'appTitle': 'Équations solver', - 'polynomials': 'Polynômes', - 'functions': 'Fonctions', - 'systems': 'Systèmes', - 'integrals': 'Intégrales', - 'interpolation': 'Interpolation', - 'other': 'Autre', - 'firstDegree': 'Linéaire', - 'secondDegree': 'Quadratique', - 'thirdDegree': 'Cubique', - 'fourthDegree': 'Quartic', - 'anyDegree': 'Tous', - 'solution': 'Solution', - 'solutions': 'Solutions', - 'chart': 'Graphique', - 'solve': 'Résoudre', - 'clean': 'Nettoyer', - 'cancel': 'Annuler', - 'no_solutions': 'Aucune solution à afficher', - 'no_chart': 'Aucune graphique à afficher', - 'no_discriminant': 'Aucun discriminant.', - 'polynomial_error': 'Un ou plusieurs coefficients ne sont pas valides.', - 'wrong_input': 'Entrée invalide', - 'tap_more': 'Appuyez pour voir plus de détails ', - 'discriminant': 'Discriminant', - 'fraction': 'Fraction', - 'single_point': 'Point fixe', - 'bracketing': 'Intervalle', - 'precision': 'Précision', - 'convergence': 'Convergence', - 'efficiency': 'Efficience', - 'not_computed': 'Non calculé ', - 'nonlinear_error': "Format d'équation ou de paramètres incorrect.", - 'row_reduction': 'Élimination', - 'factorization': 'Factorisation', - 'iterative': 'Itératif', - 'size': 'Taille', - 'matrix_size1': '1x1 matrice', - 'matrix_size2': '2x2 matrice', - 'matrix_size3': '3x3 matrice', - 'matrix_size4': '4x4 matrice', - 'matrix_description': 'La matrice avec les coefficients des équations', - 'vector_description': 'Le vecteur avec les valeurs connues', - 'sor_w': 'Facteur de relaxation', - 'jacobi_initial': 'Vecteur de valeurs initiales', - 'singular_matrix_error': - 'Le système ne peut pas être résolu car la matrice est singulière', - 'invalid_values': 'Une ou plusieurs valeurs ne sont pas correctes.', - 'matrices': 'Matrices', - 'linear': 'Affine', - 'analyze': 'Analyser', - 'results': 'Résultats', - 'wait_a_moment': 'Attendez un moment...', - 'rank': 'Rang', - 'trace': 'Trace', - 'transpose': 'Transposée', - 'determinant': 'Déterminant', - 'inverse': 'Inverse', - 'cofactor': 'Comatrice', - 'characteristicPolynomial': 'Polynôme caractéristique', - 'eigenvalues': 'Valeurs propre', - 'properties': 'Propriétés', - 'complex_numbers': 'Nombres complexes', - 'phase': 'Phase', - 'abs': 'Module / valeur absolue', - 'conjugate': 'Conjugué', - 'reciprocal': 'Inverse', - 'sqrt': 'Racine carrée', - 'length': 'Rayon', - 'angle_deg': 'Angle (degrés)', - 'angle_rad': 'Angle (radians)', - 'polar_coordinates': 'Coordonnées polaires', - 'yes': 'Oui', - 'no': 'Non', - 'diagonal': 'Diagonale', - 'symmetric': 'Symétrique', - 'identity': 'Identité', - 'url_error': "Cette page n'existe pas!", - 'version': 'Version', - 'input_allowed_values': 'Valeurs autorisées', - 'input_allowed_numbers': ' - Nombres décimaux et entiers.', - 'input_allowed_fractions': ' - Fractions.', - 'input_allowed_constants': - ' - Constantes: pi (3.1415), e (2.7182) et sqrt2 (1.4142)', - 'input_allowed_functions': "L'equation f(x) permet à ces fonctions:", - 'input_allowed_multiplication_sign': - 'La multiplication nécessite le signe. Par exemple:', - 'more_digits': 'Sans approximation: ', - 'nonlinear_fail_converge': "La méthode n'a pas convergé vers une solution.", -}; diff --git a/example/flutter_example/test/localization/italian_strings.dart b/example/flutter_example/test/localization/italian_strings.dart deleted file mode 100644 index ac77ac79..00000000 --- a/example/flutter_example/test/localization/italian_strings.dart +++ /dev/null @@ -1,91 +0,0 @@ -const italianStrings = { - 'appTitle': 'Risolutore di equazioni', - 'polynomials': 'Polinomi', - 'functions': 'Funzioni', - 'systems': 'Sistemi', - 'integrals': 'Integrali', - 'interpolation': 'Interpolazione', - 'other': 'Altro', - 'firstDegree': 'Lineare', - 'secondDegree': 'Quadratica', - 'thirdDegree': 'Cubica', - 'fourthDegree': 'Quartica', - 'anyDegree': 'Qualsiasi', - 'solution': 'Soluzione', - 'solutions': 'Soluzioni', - 'chart': 'Grafico', - 'solve': 'Risolvi', - 'clean': 'Pulisci', - 'cancel': 'Annulla', - 'no_solutions': 'Nessuna soluzione da mostrare.', - 'no_chart': 'Nessun grafico da disegnare.', - 'no_discriminant': 'Nessun discriminante.', - 'polynomial_error': 'Uno o più coefficienti non sono validi.', - 'wrong_input': 'Input non valido', - 'tap_more': 'Premi per vedere più dettagli', - 'discriminant': 'Discriminante', - 'fraction': 'Frazione', - 'single_point': 'Punto fisso', - 'bracketing': 'Intervalli', - 'precision': 'Precisione', - 'convergence': 'Convergenza', - 'efficiency': 'Efficienza', - 'not_computed': 'Non calcolata', - 'nonlinear_error': "Il formato dell'equazione o dei parametri non è valido.", - 'row_reduction': 'Elim. Gauss', - 'factorization': 'Decomposizione', - 'iterative': 'Iterativo', - 'size': 'Dimensione', - 'matrix_size1': 'matrice 1x1', - 'matrix_size2': 'matrice 2x2', - 'matrix_size3': 'matrice 3x3', - 'matrix_size4': 'matrice 4x4', - 'matrix_description': 'La matrice dei coefficienti delle equazioni', - 'vector_description': 'Il vettore con termini noti', - 'sor_w': 'Fattore di rilassamento', - 'jacobi_initial': 'Vettore iniziale', - 'singular_matrix_error': - 'Il sistema non può essere risolto perchè la matrice è singolare!', - 'invalid_values': 'Uno o più valori non sono corretti.', - 'matrices': 'Matrici', - 'linear': 'Lineare', - 'analyze': 'Analizza', - 'results': 'Risultati', - 'wait_a_moment': 'Aspetta un momento...', - 'rank': 'Rango', - 'trace': 'Traccia', - 'transpose': 'Trasposta', - 'determinant': 'Determinant3', - 'inverse': 'Inversa', - 'cofactor': 'Cofattori', - 'characteristicPolynomial': 'Polinomio caratteristico', - 'eigenvalues': 'Autovalori', - 'properties': 'Proprietà', - 'complex_numbers': 'Numeri complessi', - 'phase': 'Fase', - 'abs': 'Modulo / valore assoluto', - 'conjugate': 'Coniugato', - 'reciprocal': 'Reciproco', - 'sqrt': 'Radice quadrata', - 'length': 'Lunghezza', - 'angle_deg': 'Angolo (gradi)', - 'angle_rad': 'Angolo (radianti)', - 'polar_coordinates': 'Coordinate polari', - 'yes': 'Si', - 'no': 'No', - 'diagonal': 'Diagonale', - 'symmetric': 'Simmetrica', - 'identity': 'Identità', - 'url_error': 'Questa pagina non esiste!', - 'version': 'Versione', - 'input_allowed_values': 'Valori ammessi', - 'input_allowed_numbers': ' - Numeri interi e decimali.', - 'input_allowed_fractions': ' - Frazioni.', - 'input_allowed_constants': - ' - Costanti: pi (3.1415), e (2.7182) and sqrt2 (1.4142).', - 'input_allowed_functions': "L'equazione f(x) permette queste funzioni:", - 'input_allowed_multiplication_sign': - 'La moltiplicazione richiede il segno. Per esempio:', - 'more_digits': 'Senza approssimazione: ', - 'nonlinear_fail_converge': 'Il metodo non ha converso ad una soluzione.', -}; diff --git a/example/flutter_example/test/localization/localization_test.dart b/example/flutter_example/test/localization/localization_test.dart deleted file mode 100644 index 01b96fd2..00000000 --- a/example/flutter_example/test/localization/localization_test.dart +++ /dev/null @@ -1,204 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'english_strings.dart'; -import 'french_strings.dart'; -import 'italian_strings.dart'; - -void main() { - void checklocalizedStringsLengths({ - required AppLocalizations appLocalizations, - required List localizedValues, - }) { - final values = [ - appLocalizations.appTitle, - appLocalizations.polynomials, - appLocalizations.functions, - appLocalizations.systems, - appLocalizations.integrals, - appLocalizations.interpolation, - appLocalizations.other, - appLocalizations.firstDegree, - appLocalizations.secondDegree, - appLocalizations.thirdDegree, - appLocalizations.fourthDegree, - appLocalizations.anyDegree, - appLocalizations.solution, - appLocalizations.solutions, - appLocalizations.chart, - appLocalizations.solve, - appLocalizations.clean, - appLocalizations.cancel, - appLocalizations.no_solutions, - appLocalizations.no_chart, - appLocalizations.no_discriminant, - appLocalizations.polynomial_error, - appLocalizations.wrong_input, - appLocalizations.tap_more, - appLocalizations.discriminant, - appLocalizations.fraction, - appLocalizations.single_point, - appLocalizations.bracketing, - appLocalizations.precision, - appLocalizations.convergence, - appLocalizations.efficiency, - appLocalizations.not_computed, - appLocalizations.nonlinear_error, - appLocalizations.row_reduction, - appLocalizations.factorization, - appLocalizations.iterative, - appLocalizations.size, - appLocalizations.matrix_size1, - appLocalizations.matrix_size2, - appLocalizations.matrix_size3, - appLocalizations.matrix_size4, - appLocalizations.matrix_description, - appLocalizations.vector_description, - appLocalizations.sor_w, - appLocalizations.jacobi_initial, - appLocalizations.singular_matrix_error, - appLocalizations.invalid_values, - appLocalizations.matrices, - appLocalizations.linear, - appLocalizations.analyze, - appLocalizations.results, - appLocalizations.wait_a_moment, - appLocalizations.rank, - appLocalizations.trace, - appLocalizations.transpose, - appLocalizations.determinant, - appLocalizations.inverse, - appLocalizations.cofactor, - appLocalizations.characteristicPolynomial, - appLocalizations.eigenvalues, - appLocalizations.properties, - appLocalizations.complex_numbers, - appLocalizations.phase, - appLocalizations.abs, - appLocalizations.conjugate, - appLocalizations.reciprocal, - appLocalizations.sqrt, - appLocalizations.length, - appLocalizations.angle_deg, - appLocalizations.angle_rad, - appLocalizations.polar_coordinates, - appLocalizations.yes, - appLocalizations.no, - appLocalizations.diagonal, - appLocalizations.symmetric, - appLocalizations.identity, - appLocalizations.url_error, - appLocalizations.version, - appLocalizations.input_allowed_values, - appLocalizations.input_allowed_numbers, - appLocalizations.input_allowed_fractions, - appLocalizations.input_allowed_constants, - appLocalizations.input_allowed_functions, - appLocalizations.input_allowed_multiplication_sign, - appLocalizations.more_digits, - appLocalizations.nonlinear_error, - ]; - - expect(values.length, equals(86)); - expect(values.length, equals(localizedValues.length)); - - for (var i = 0; i < values.length; ++i) { - values[i] = localizedValues[i]; - } - } - - testWidgets('Making sure that localization works on context', (tester) async { - late final AppLocalizations? localizations; - - await tester.pumpWidget( - MaterialApp( - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - home: Builder( - builder: (context) { - localizations = AppLocalizations.of(context); - - return const SizedBox(); - }, - ), - ), - ); - - expect(localizations, isNotNull); - }); - - testWidgets('Making sure that English is correctly loaded', (tester) async { - late AppLocalizations localizations; - - await tester.pumpWidget( - MaterialApp( - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - home: Builder( - builder: (context) { - localizations = AppLocalizations.of(context); - - return const SizedBox(); - }, - ), - ), - ); - - expect(localizations.localeName, equals('en')); - checklocalizedStringsLengths( - appLocalizations: localizations, - localizedValues: englishStrings.values.toList(growable: false), - ); - }); - - testWidgets('Making sure that Italian is correctly loaded', (tester) async { - late AppLocalizations localizations; - - await tester.pumpWidget( - MaterialApp( - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - locale: const Locale('it'), - home: Builder( - builder: (context) { - localizations = AppLocalizations.of(context); - - return const SizedBox(); - }, - ), - ), - ); - - expect(localizations.localeName, equals('it')); - checklocalizedStringsLengths( - appLocalizations: localizations, - localizedValues: italianStrings.values.toList(growable: false), - ); - }); - - testWidgets('Making sure that French is correctly loaded', (tester) async { - late AppLocalizations localizations; - - await tester.pumpWidget( - MaterialApp( - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - locale: const Locale('fr'), - home: Builder( - builder: (context) { - localizations = AppLocalizations.of(context); - - return const SizedBox(); - }, - ), - ), - ); - - expect(localizations.localeName, equals('fr')); - checklocalizedStringsLengths( - appLocalizations: localizations, - localizedValues: frenchStrings.values.toList(growable: false), - ); - }); -} diff --git a/example/flutter_example/test/main_test.dart b/example/flutter_example/test/main_test.dart deleted file mode 100644 index ad497011..00000000 --- a/example/flutter_example/test/main_test.dart +++ /dev/null @@ -1,40 +0,0 @@ -import 'package:equations_solver/main.dart' as app_main; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group('Testing the entry point of the app', () { - testWidgets( - "Making sure that 'main()' doesn't throw", - (tester) async { - var throws = false; - - try { - app_main.main(); - } on Exception { - throws = true; - } - - expect(throws, isFalse); - }, - ); - - testWidgets( - "Making sure that the root widget contains a 'MaterialApp' and" - ' it is correctly initialized', - (tester) async { - await tester.pumpWidget(const app_main.EquationsApp()); - expect(find.byType(MaterialApp), findsOneWidget); - - // Checking MaterialApp's properties - final materialApp = tester.firstWidget( - find.byType(MaterialApp), - ); - - expect(materialApp.supportedLocales.length, equals(3)); - expect(materialApp.routerConfig, isNotNull); - expect(materialApp.debugShowCheckedModeBanner, isFalse); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/error_page_test.dart b/example/flutter_example/test/routes/error_page_test.dart deleted file mode 100644 index f4f0b225..00000000 --- a/example/flutter_example/test/routes/error_page_test.dart +++ /dev/null @@ -1,39 +0,0 @@ -import 'package:equations_solver/routes/error_page.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'mock_wrapper.dart'; - -void main() { - group("Testing the 'ErrorPage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ErrorPage(), - ), - ); - - expect(find.byType(SliverFillRemaining), findsOneWidget); - expect(find.byType(UrlError), findsOneWidget); - expect(find.byType(ErrorPage), findsOneWidget); - expect(find.byType(EquationScaffold), findsOneWidget); - }); - }); - - group('Golden tests - ErrorPage', () { - testWidgets('ErrorPage', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ErrorPage(), - ), - ); - - await expectLater( - find.byType(ErrorPage), - matchesGoldenFile('goldens/error_page.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/goldens/error_page.png b/example/flutter_example/test/routes/goldens/error_page.png deleted file mode 100644 index 6f7a6158..00000000 Binary files a/example/flutter_example/test/routes/goldens/error_page.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/integral_body_large_screen.png b/example/flutter_example/test/routes/goldens/integral_body_large_screen.png deleted file mode 100644 index 3a8525ee..00000000 Binary files a/example/flutter_example/test/routes/goldens/integral_body_large_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/integral_body_large_screen_with_data.png b/example/flutter_example/test/routes/goldens/integral_body_large_screen_with_data.png deleted file mode 100644 index dd3f194e..00000000 Binary files a/example/flutter_example/test/routes/goldens/integral_body_large_screen_with_data.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/integral_body_small_screen.png b/example/flutter_example/test/routes/goldens/integral_body_small_screen.png deleted file mode 100644 index d4e0c140..00000000 Binary files a/example/flutter_example/test/routes/goldens/integral_body_small_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/integral_body_small_screen_with_data.png b/example/flutter_example/test/routes/goldens/integral_body_small_screen_with_data.png deleted file mode 100644 index 5ed4ff77..00000000 Binary files a/example/flutter_example/test/routes/goldens/integral_body_small_screen_with_data.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen.png b/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen.png deleted file mode 100644 index cdf2704c..00000000 Binary files a/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen_with_data.png b/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen_with_data.png deleted file mode 100644 index 10bff8c3..00000000 Binary files a/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen_with_data.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen_with_error.png b/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen_with_error.png deleted file mode 100644 index 6153c903..00000000 Binary files a/example/flutter_example/test/routes/goldens/nonlinear_body_large_screen_with_error.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen.png b/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen.png deleted file mode 100644 index ebf75db1..00000000 Binary files a/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen_with_data.png b/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen_with_data.png deleted file mode 100644 index 8e350416..00000000 Binary files a/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen_with_data.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen_with_error.png b/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen_with_error.png deleted file mode 100644 index ee5f03fd..00000000 Binary files a/example/flutter_example/test/routes/goldens/nonlinear_body_small_screen_with_error.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/other_body_complex_large_screen.png b/example/flutter_example/test/routes/goldens/other_body_complex_large_screen.png deleted file mode 100644 index 4b0933e9..00000000 Binary files a/example/flutter_example/test/routes/goldens/other_body_complex_large_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/other_body_complex_small_screen.png b/example/flutter_example/test/routes/goldens/other_body_complex_small_screen.png deleted file mode 100644 index efc5e10b..00000000 Binary files a/example/flutter_example/test/routes/goldens/other_body_complex_small_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/other_body_matrix_large_screen.png b/example/flutter_example/test/routes/goldens/other_body_matrix_large_screen.png deleted file mode 100644 index 98da3f55..00000000 Binary files a/example/flutter_example/test/routes/goldens/other_body_matrix_large_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/other_body_matrix_small_screen_part1.png b/example/flutter_example/test/routes/goldens/other_body_matrix_small_screen_part1.png deleted file mode 100644 index 343f5f86..00000000 Binary files a/example/flutter_example/test/routes/goldens/other_body_matrix_small_screen_part1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/other_body_matrix_small_screen_part2.png b/example/flutter_example/test/routes/goldens/other_body_matrix_small_screen_part2.png deleted file mode 100644 index 5a62f74a..00000000 Binary files a/example/flutter_example/test/routes/goldens/other_body_matrix_small_screen_part2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/polynomial_body_large_screen.png b/example/flutter_example/test/routes/goldens/polynomial_body_large_screen.png deleted file mode 100644 index 9c0e33bd..00000000 Binary files a/example/flutter_example/test/routes/goldens/polynomial_body_large_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/polynomial_body_large_screen_with_data.png b/example/flutter_example/test/routes/goldens/polynomial_body_large_screen_with_data.png deleted file mode 100644 index 62ee0646..00000000 Binary files a/example/flutter_example/test/routes/goldens/polynomial_body_large_screen_with_data.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/polynomial_body_small_screen.png b/example/flutter_example/test/routes/goldens/polynomial_body_small_screen.png deleted file mode 100644 index 62c8fab8..00000000 Binary files a/example/flutter_example/test/routes/goldens/polynomial_body_small_screen.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/polynomial_body_small_screen_with_data.png b/example/flutter_example/test/routes/goldens/polynomial_body_small_screen_with_data.png deleted file mode 100644 index 7e198d16..00000000 Binary files a/example/flutter_example/test/routes/goldens/polynomial_body_small_screen_with_data.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_factorization.png b/example/flutter_example/test/routes/goldens/system_body_factorization.png deleted file mode 100644 index 5132332d..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_factorization.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_factorization_singular.png b/example/flutter_example/test/routes/goldens/system_body_factorization_singular.png deleted file mode 100644 index 237674bf..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_factorization_singular.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_factorization_solution.png b/example/flutter_example/test/routes/goldens/system_body_factorization_solution.png deleted file mode 100644 index 28fe7064..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_factorization_solution.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_iterative.png b/example/flutter_example/test/routes/goldens/system_body_iterative.png deleted file mode 100644 index 9d758185..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_iterative.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_iterative_singular.png b/example/flutter_example/test/routes/goldens/system_body_iterative_singular.png deleted file mode 100644 index c3baff94..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_iterative_singular.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_iterative_solution.png b/example/flutter_example/test/routes/goldens/system_body_iterative_solution.png deleted file mode 100644 index 73f1a2e9..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_iterative_solution.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_rowreduction.png b/example/flutter_example/test/routes/goldens/system_body_rowreduction.png deleted file mode 100644 index 0ce9a8fa..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_rowreduction.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_rowreduction_singular.png b/example/flutter_example/test/routes/goldens/system_body_rowreduction_singular.png deleted file mode 100644 index fc96c92c..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_rowreduction_singular.png and /dev/null differ diff --git a/example/flutter_example/test/routes/goldens/system_body_rowreduction_solution.png b/example/flutter_example/test/routes/goldens/system_body_rowreduction_solution.png deleted file mode 100644 index e0a45e45..00000000 Binary files a/example/flutter_example/test/routes/goldens/system_body_rowreduction_solution.png and /dev/null differ diff --git a/example/flutter_example/test/routes/home_page/card_container_test.dart b/example/flutter_example/test/routes/home_page/card_container_test.dart deleted file mode 100644 index 1dead41e..00000000 --- a/example/flutter_example/test/routes/home_page/card_container_test.dart +++ /dev/null @@ -1,81 +0,0 @@ -import 'package:equations_solver/routes/home_page/card_containers.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'HomePage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: CardContainer( - title: 'Title', - image: const SizedBox(), - // ignore: no-empty-block - onTap: () {}, - ), - ), - ); - - expect(find.byType(CardContainer), findsOneWidget); - expect(find.byType(GestureDetector), findsOneWidget); - expect(find.byType(Card), findsOneWidget); - }); - - testWidgets('Making sure that the widget is tappable', (tester) async { - var counter = 0; - - await tester.pumpWidget( - MockWrapper( - child: CardContainer( - title: 'Title', - image: const SizedBox(), - onTap: () => counter++, - ), - ), - ); - - await tester.tap(find.byType(CardContainer)); - await tester.pump(); - - expect(counter, equals(0)); - }); - }); - - group('Golden tests', () { - testWidgets('Golden test - CardContainer', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: CardContainer( - title: 'Title', - image: const SizedBox(), - // ignore: no-empty-block - onTap: () {}, - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/cardcontainer_no_image.png'), - ); - }); - - testWidgets('Golden test - CardContainer', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: CardContainer( - title: 'Title', - image: const Icon(Icons.ac_unit), - // ignore: no-empty-block - onTap: () {}, - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/cardcontainer_with_image.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/home_page/goldens/cardcontainer_no_image.png b/example/flutter_example/test/routes/home_page/goldens/cardcontainer_no_image.png deleted file mode 100644 index e27c97a6..00000000 Binary files a/example/flutter_example/test/routes/home_page/goldens/cardcontainer_no_image.png and /dev/null differ diff --git a/example/flutter_example/test/routes/home_page/goldens/cardcontainer_with_image.png b/example/flutter_example/test/routes/home_page/goldens/cardcontainer_with_image.png deleted file mode 100644 index c52bf39b..00000000 Binary files a/example/flutter_example/test/routes/home_page/goldens/cardcontainer_with_image.png and /dev/null differ diff --git a/example/flutter_example/test/routes/home_page/goldens/home_contents.png b/example/flutter_example/test/routes/home_page/goldens/home_contents.png deleted file mode 100644 index 10347e66..00000000 Binary files a/example/flutter_example/test/routes/home_page/goldens/home_contents.png and /dev/null differ diff --git a/example/flutter_example/test/routes/home_page/home_contents_test.dart b/example/flutter_example/test/routes/home_page/home_contents_test.dart deleted file mode 100644 index ff0f7b22..00000000 --- a/example/flutter_example/test/routes/home_page/home_contents_test.dart +++ /dev/null @@ -1,165 +0,0 @@ -import 'package:equations_solver/routes/home_page/card_containers.dart'; -import 'package:equations_solver/routes/home_page/home_contents.dart'; -import 'package:equations_solver/routes/integral_page.dart'; -import 'package:equations_solver/routes/nonlinear_page.dart'; -import 'package:equations_solver/routes/other_page.dart'; -import 'package:equations_solver/routes/polynomial_page.dart'; -import 'package:equations_solver/routes/system_page.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'HomeContents' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SingleChildScrollView( - child: HomeContents(), - ), - ), - ); - - expect(find.byType(CardContainer), findsNWidgets(5)); - expect(find.byType(PolynomialLogo), findsOneWidget); - expect(find.byType(NonlinearLogo), findsOneWidget); - }); - - testWidgets( - 'Making sure that tapping on the CardContainer widget for ' - 'polynomial equations opens a new route', - (tester) async { - await tester.pumpWidget( - const MockWrapperWithNavigator(), - ); - final finder = find.byKey(const Key('PolynomialLogo-Container')); - - // Tapping an waiting for the animations to complete - await tester.tap(finder); - await tester.pumpAndSettle(); - - // Expecting to be on the new page - expect(find.byType(PolynomialPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - expect(find.byType(HomeContents), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that tapping on the CardContainer widget for ' - 'nonlinear equations opens a new route', - (tester) async { - await tester.pumpWidget( - const MockWrapperWithNavigator(), - ); - final finder = find.byKey(const Key('NonlinearLogo-Container')); - - // Tapping an waiting for the animations to complete - await tester.tap(finder); - await tester.pumpAndSettle(); - - // Expecting to be on the new page - expect(find.byType(NonlinearPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - expect(find.byType(HomeContents), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that tapping on the CardContainer widget for ' - 'systems of equations opens a new route', - (tester) async { - await tester.pumpWidget( - const MockWrapperWithNavigator(), - ); - final finder = find.byKey(const Key('SystemsLogo-Container')); - - // Tapping an waiting for the animations to complete - await tester.tap(finder); - await tester.pumpAndSettle(); - - // Expecting to be on the new page - expect(find.byType(SystemPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - expect(find.byType(HomeContents), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that tapping on the CardContainer widget for ' - 'integrals opens a new route', - (tester) async { - await tester.pumpWidget( - const MockWrapperWithNavigator(), - ); - final finder = find.byKey(const Key('IntegralsLogo-Container')); - - // Tapping an waiting for the animations to complete - await tester.tap(finder); - await tester.pumpAndSettle(); - - // Expecting to be on the new page - expect(find.byType(IntegralPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - expect(find.byType(HomeContents), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that tapping on the CardContainer widget for ' - 'the analyzers ("Other" page) opens a new route', - (tester) async { - await tester.pumpWidget( - const MockWrapperWithNavigator(), - ); - final finder = find.byKey(const Key('OtherLogo-Container')); - - // Tapping an waiting for the animations to complete - await tester.ensureVisible(finder); - await tester.pumpAndSettle(); - - await tester.tap(finder); - await tester.pumpAndSettle(); - - // Expecting to be on the new page - expect(find.byType(OtherPage), findsOneWidget); - - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - expect(find.byType(HomeContents), findsOneWidget); - }, - ); - }); - - group('Golden tests - HomeContents', () { - testWidgets('Golden test - HomeContents', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SingleChildScrollView( - child: HomeContents(), - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/home_contents.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/home_page_test.dart b/example/flutter_example/test/routes/home_page_test.dart deleted file mode 100644 index b9b592ce..00000000 --- a/example/flutter_example/test/routes/home_page_test.dart +++ /dev/null @@ -1,26 +0,0 @@ -import 'package:equations_solver/routes/home_page.dart'; -import 'package:equations_solver/routes/home_page/home_contents.dart'; -import 'package:equations_solver/routes/utils/app_logo.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'mock_wrapper.dart'; - -void main() { - group("Testing the 'HomePage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: HomePage(), - ), - ); - - expect(find.byType(CustomScrollView), findsOneWidget); - expect(find.byType(SliverFillRemaining), findsOneWidget); - expect(find.byType(AppLogo), findsOneWidget); - expect(find.byType(HomeContents), findsOneWidget); - expect(find.byType(EquationScaffold), findsOneWidget); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_midpoint.png b/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_midpoint.png deleted file mode 100644 index b6ff6fa2..00000000 Binary files a/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_midpoint.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_simpson.png b/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_simpson.png deleted file mode 100644 index 4c82cd7d..00000000 Binary files a/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_simpson.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_trapezoid.png b/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_trapezoid.png deleted file mode 100644 index d65c6422..00000000 Binary files a/example/flutter_example/test/routes/integral_page/goldens/integral_data_input_trapezoid.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/integral_body_test.dart b/example/flutter_example/test/routes/integral_page/integral_body_test.dart deleted file mode 100644 index e8da5b5f..00000000 --- a/example/flutter_example/test/routes/integral_page/integral_body_test.dart +++ /dev/null @@ -1,180 +0,0 @@ -import 'package:equations_solver/routes/integral_page/integral_data_input.dart'; -import 'package:equations_solver/routes/integral_page/integral_results.dart'; -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'integral_mock.dart'; - -void main() { - group("Testing the 'IntegralBody' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(IntegralDataInput), findsOneWidget); - expect(find.byType(IntegralResultsWidget), findsOneWidget); - expect(find.byType(InputKindDialogButton), findsOneWidget); - }); - - testWidgets( - 'Making sure that the widget is responsive - small screens test', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect( - find.byKey(const Key('SingleChildScrollView-mobile-responsive')), - findsOneWidget, - ); - expect( - find.byKey(const Key('SingleChildScrollView-desktop-responsive')), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that the widget is responsive - large screens test', - (tester) async { - await tester.binding.setSurfaceSize(const Size(2000, 2000)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect( - find.byKey(const Key('SingleChildScrollView-mobile-responsive')), - findsNothing, - ); - expect( - find.byKey(const Key('SingleChildScrollView-desktop-responsive')), - findsOneWidget, - ); - }, - ); - - testWidgets('Making sure that simpson solver works', (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x+2'); - await tester.enterText(lowerInput, '1'); - await tester.enterText(upperInput, '3'); - - // Initial state - expect(find.byType(NoResults), findsOneWidget); - - // Evaluating the integral - await tester.tap(find.byKey(const Key('Integral-button-solve'))); - await tester.pumpAndSettle(); - - // Results - expect(find.byType(NoResults), findsNothing); - expect(find.byType(RealResultCard), findsOneWidget); - }); - - testWidgets('Making sure that midpoint solver works', (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.midpoint.name, - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x+2'); - await tester.enterText(lowerInput, '1'); - await tester.enterText(upperInput, '3'); - - // Initial state - expect(find.byType(NoResults), findsOneWidget); - - // Evaluating the integral - await tester.tap(find.byKey(const Key('Integral-button-solve'))); - await tester.pumpAndSettle(); - - // Results - expect(find.byType(NoResults), findsNothing); - expect(find.byType(RealResultCard), findsOneWidget); - }); - - testWidgets('Making sure that trapezoid solver works', (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.midpoint.name, - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x+2'); - await tester.enterText(lowerInput, '1'); - await tester.enterText(upperInput, '3'); - - // Initial state - expect(find.byType(NoResults), findsOneWidget); - - // Evaluating the integral - await tester.tap(find.byKey(const Key('Integral-button-solve'))); - await tester.pumpAndSettle(); - - // Results - expect(find.byType(NoResults), findsNothing); - expect(find.byType(RealResultCard), findsOneWidget); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/integral_data_input_test.dart b/example/flutter_example/test/routes/integral_page/integral_data_input_test.dart deleted file mode 100644 index 0da829f4..00000000 --- a/example/flutter_example/test/routes/integral_page/integral_data_input_test.dart +++ /dev/null @@ -1,253 +0,0 @@ -import 'package:equations_solver/routes/integral_page/integral_data_input.dart'; -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; -import 'integral_mock.dart'; - -void main() { - group("Testing the 'IntegralDataInput' widget", () { - testWidgets( - 'Making sure that when trying to evaluate an integral, if at least one ' - 'of the inputs is wrong, a snackbar appears', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: const IntegralDataInput(), - ), - ); - - // No snackbar by default - expect(find.byType(SnackBar), findsNothing); - - // Tap the 'Solve' button - final finder = find.byKey(const Key('Integral-button-solve')); - await tester.tap(finder); - - // The snackbar appeared - await tester.pumpAndSettle(); - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that fields can be cleared', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: const IntegralDataInput(), - ), - ); - - // Entering values - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x^2-1'); - await tester.enterText(lowerInput, '17'); - await tester.enterText(upperInput, '18'); - - // Making sure that fields are filled - expect(find.text('x^2-1'), findsOneWidget); - expect(find.text('17'), findsOneWidget); - expect(find.text('18'), findsOneWidget); - - // Tap the 'Clear' button - final finder = find.byKey(const Key('Integral-button-clean')); - await tester.tap(finder); - await tester.pumpAndSettle(); - - // Making sure that fields have been cleared - expect(find.text('x^2-1'), findsNothing); - expect(find.text('17'), findsNothing); - expect(find.text('18'), findsNothing); - - tester - .widgetList(find.byType(TextFormField)) - .forEach((t) { - expect(t.controller!.text.length, isZero); - }); - }, - ); - - testWidgets( - 'Making sure that integrals can be evaluated using the Simpson method', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(RealResultCard), findsNothing); - - // Entering values - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x^2-1'); - await tester.enterText(lowerInput, '2'); - await tester.enterText(upperInput, '5'); - - // Tap the 'Solve' button - final finder = find.byKey(const Key('Integral-button-solve')); - await tester.tap(finder); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that integrals can be evaluated using the Midpoint rule', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.midpoint.name, - ), - ); - - expect(find.byType(RealResultCard), findsNothing); - - // Entering values - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x^2-1'); - await tester.enterText(lowerInput, '2'); - await tester.enterText(upperInput, '5'); - - // Tap the 'Solve' button - final finder = find.byKey(const Key('Integral-button-solve')); - await tester.tap(finder); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that integrals can be evaluated using the Trapezoid rule', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.trapezoid.name, - ), - ); - - expect(find.byType(RealResultCard), findsNothing); - - // Entering values - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x^2-1'); - await tester.enterText(lowerInput, '2'); - await tester.enterText(upperInput, '5'); - - // Tap the 'Solve' button - final finder = find.byKey(const Key('Integral-button-solve')); - await tester.tap(finder); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - }); - - group('Golden tests - IntegralDataInput', () { - testWidgets('IntegralDataInput - simpson', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 500)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.simpson.name, - child: const IntegralDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/integral_data_input_simpson.png'), - ); - }); - - testWidgets('IntegralDataInput - midpoint', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 500)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.midpoint.name, - child: const IntegralDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/integral_data_input_midpoint.png'), - ); - }); - - testWidgets('IntegralDataInput - trapezoid', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 500)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.trapezoid.name, - child: const IntegralDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/integral_data_input_trapezoid.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/integral_mock.dart b/example/flutter_example/test/routes/integral_page/integral_mock.dart deleted file mode 100644 index 4948fcd8..00000000 --- a/example/flutter_example/test/routes/integral_page/integral_mock.dart +++ /dev/null @@ -1,48 +0,0 @@ -import 'package:equations_solver/routes/integral_page/integral_body.dart'; -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:flutter/material.dart'; - -import '../mock_wrapper.dart'; - -class MockIntegralWidget extends StatelessWidget { - final List textControllers; - final Widget child; - final String? dropdownValue; - const MockIntegralWidget({ - super.key, - this.textControllers = const [], - this.child = const IntegralBody(), - this.dropdownValue, - }); - - @override - Widget build(BuildContext context) { - return MockWrapper( - child: InheritedIntegral( - integralState: IntegralState(), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - dropdownValue ?? IntegralDropdownItems.simpson.name, - ), - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedTextControllers( - textControllers: textControllers, - child: child, - ), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/test/routes/integral_page/integral_results_test.dart b/example/flutter_example/test/routes/integral_page/integral_results_test.dart deleted file mode 100644 index 3d21e3d9..00000000 --- a/example/flutter_example/test/routes/integral_page/integral_results_test.dart +++ /dev/null @@ -1,88 +0,0 @@ -import 'package:equations_solver/routes/integral_page/integral_results.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'integral_mock.dart'; - -void main() { - group("Testing the 'IntegralResultsWidget' widget", () { - testWidgets( - 'Making sure that, by default, the "No results" text appears', - (tester) async { - await tester.pumpWidget( - const MockIntegralWidget( - child: IntegralResultsWidget(), - ), - ); - - // No snackbar by default - expect(find.byType(NoResults), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that a result card appears when there is a solution to show', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x+2'); - await tester.enterText(lowerInput, '1'); - await tester.enterText(upperInput, '3'); - - // Solving the equation - await tester.tap(find.byKey(const Key('Integral-button-solve'))); - await tester.pumpAndSettle(); - - // No snackbar by default - expect(find.byType(NoResults), findsNothing); - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that a snackbar appears in case of computation errors', - (tester) async { - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, ''); - await tester.enterText(lowerInput, '1'); - await tester.enterText(upperInput, '3'); - - // Solving the equation - await tester.tap(find.byKey(const Key('Integral-button-solve'))); - await tester.pumpAndSettle(); - - // No snackbar by default - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/model/inherited_integral_test.dart b/example/flutter_example/test/routes/integral_page/model/inherited_integral_test.dart deleted file mode 100644 index 031e739a..00000000 --- a/example/flutter_example/test/routes/integral_page/model/inherited_integral_test.dart +++ /dev/null @@ -1,54 +0,0 @@ -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedIntegral' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final inheritedIntegral = InheritedIntegral( - integralState: IntegralState(), - child: const SizedBox.shrink(), - ); - - expect( - inheritedIntegral.updateShouldNotify(inheritedIntegral), - isFalse, - ); - expect( - inheritedIntegral.updateShouldNotify( - InheritedIntegral( - integralState: IntegralState(), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late IntegralState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedIntegral( - integralState: IntegralState(), - child: Builder( - builder: (context) { - reference = InheritedIntegral.of(context).integralState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.state, isNotNull); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/model/integral_result_test.dart b/example/flutter_example/test/routes/integral_page/model/integral_result_test.dart deleted file mode 100644 index ef450d81..00000000 --- a/example/flutter_example/test/routes/integral_page/model/integral_result_test.dart +++ /dev/null @@ -1,102 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_result.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'IntegralResult' class", () { - test('Initial values', () { - const integralResult = IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ); - - expect(integralResult.numericalIntegration, isA()); - }); - - test('Making sure that objects can be properly compared', () { - const integralResult = IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ); - - expect( - integralResult, - equals( - const IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ), - ), - ); - - expect( - const IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ), - integralResult, - ); - - expect( - integralResult == - const IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ), - isTrue, - ); - - expect( - const IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ) == - integralResult, - isTrue, - ); - - expect( - const IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-1', - lowerBound: 1, - upperBound: 2, - ), - ) == - integralResult, - isFalse, - ); - - expect( - integralResult.hashCode, - equals( - const IntegralResult( - numericalIntegration: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ).hashCode, - ), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/model/integral_state_test.dart b/example/flutter_example/test/routes/integral_page/model/integral_state_test.dart deleted file mode 100644 index 7163ba6c..00000000 --- a/example/flutter_example/test/routes/integral_page/model/integral_state_test.dart +++ /dev/null @@ -1,56 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_result.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'IntegralState' class", () { - test('Initial values', () { - final integralState = IntegralState(); - - expect(integralState.state, equals(const IntegralResult())); - expect(integralState.state.numericalIntegration, isNull); - }); - - test('Making sure that equations can be solved and cleared', () { - var count = 0; - final integralState = IntegralState()..addListener(() => ++count); - - expect(integralState.state, equals(const IntegralResult())); - expect(integralState.state.numericalIntegration, isNull); - - integralState.solveIntegral( - upperBound: '1', - lowerBound: '2', - function: 'x-3', - intervals: 30, - integralType: IntegralType.trapezoid, - ); - - expect(integralState.state.numericalIntegration, isA()); - expect(count, equals(1)); - - integralState.clear(); - - expect(integralState.state, equals(const IntegralResult())); - expect(integralState.state.numericalIntegration, isNull); - }); - - test('Making sure that exceptions are handled', () { - var count = 0; - final integralState = IntegralState()..addListener(() => ++count); - expect(integralState.state, equals(const IntegralResult())); - - integralState.solveIntegral( - upperBound: '', - lowerBound: '', - function: '', - intervals: 30, - integralType: IntegralType.trapezoid, - ); - - expect(integralState.state.numericalIntegration, isNull); - expect(count, equals(1)); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/utils/dropdown_selection_test.dart b/example/flutter_example/test/routes/integral_page/utils/dropdown_selection_test.dart deleted file mode 100644 index aa093a87..00000000 --- a/example/flutter_example/test/routes/integral_page/utils/dropdown_selection_test.dart +++ /dev/null @@ -1,146 +0,0 @@ -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../integral_mock.dart'; - -void main() { - group("Testing the 'IntegralDropdownSelection' widget", () { - test( - "Making sure that an 'IntegralDropdownItemsExt' is correctly converted " - 'into a string', - () { - expect(IntegralDropdownItems.simpson.name, equals('Simpson')); - expect(IntegralDropdownItems.trapezoid.name, equals('Trapezoid')); - expect(IntegralDropdownItems.midpoint.name, equals('Midpoint')); - }, - ); - - test( - "Making sure that an 'IntegralDropdownItemsExt' can correctly be " - 'generated from a string', - () { - expect( - 'simpson'.toIntegralDropdownItems(), - equals(IntegralDropdownItems.simpson), - ); - expect( - 'trapezoid'.toIntegralDropdownItems(), - equals(IntegralDropdownItems.trapezoid), - ); - expect( - 'midpoint'.toIntegralDropdownItems(), - equals(IntegralDropdownItems.midpoint), - ); - - expect( - () => 'a'.toIntegralDropdownItems(), - throwsArgumentError, - ); - }, - ); - - testWidgets( - 'Making sure that the dropdown items can be changed', - (tester) async { - await tester.pumpWidget( - const MockIntegralWidget( - child: IntegralDropdownSelection(), - ), - ); - - // Initial value - expect( - find.text(IntegralDropdownItems.simpson.name), - findsOneWidget, - ); - - // Changing the value - await tester.tap( - find.byKey(const Key('Integral-Dropdown-Button-Selection')), - ); - await tester.pumpAndSettle(); - - await tester.tap( - find.byKey(const Key('Midpoint-Dropdown')).last, - warnIfMissed: false, - ); - await tester.pumpAndSettle(); - - // Verifying the new dropdown state - expect( - find.text(IntegralDropdownItems.midpoint.name), - findsOneWidget, - ); - expect(find.text('Midpoint'), findsOneWidget); - - // Changing the value again - await tester.tap( - find.byKey(const Key('Integral-Dropdown-Button-Selection')), - ); - await tester.pumpAndSettle(); - - await tester.tap( - find.byKey(const Key('Trapezoid-Dropdown')).last, - warnIfMissed: false, - ); - await tester.pumpAndSettle(); - - // Verifying the new dropdown state - expect( - find.text(IntegralDropdownItems.trapezoid.name), - findsOneWidget, - ); - expect(find.text('Trapezoid'), findsOneWidget); - }, - ); - }); - - group('Golden tests - IntegralDropdownSelection', () { - testWidgets('IntegralDropdownSelection - simpson', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 200)); - - await tester.pumpWidget( - MockIntegralWidget( - dropdownValue: IntegralDropdownItems.simpson.name, - child: const IntegralDropdownSelection(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/dropdown_selection_simpson.png'), - ); - }); - - testWidgets('IntegralDropdownSelection - midpoint', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 200)); - - await tester.pumpWidget( - MockIntegralWidget( - dropdownValue: IntegralDropdownItems.midpoint.name, - child: const IntegralDropdownSelection(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/dropdown_selection_midpoint.png'), - ); - }); - - testWidgets('IntegralDropdownSelection - trapezoid', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 200)); - - await tester.pumpWidget( - MockIntegralWidget( - dropdownValue: IntegralDropdownItems.trapezoid.name, - child: const IntegralDropdownSelection(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/dropdown_selection_trapezoid.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_midpoint.png b/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_midpoint.png deleted file mode 100644 index 38d76970..00000000 Binary files a/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_midpoint.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_simpson.png b/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_simpson.png deleted file mode 100644 index 753785fe..00000000 Binary files a/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_simpson.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_trapezoid.png b/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_trapezoid.png deleted file mode 100644 index 51c11164..00000000 Binary files a/example/flutter_example/test/routes/integral_page/utils/goldens/dropdown_selection_trapezoid.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_midpoint.png b/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_midpoint.png deleted file mode 100644 index 9c6e3ac5..00000000 Binary files a/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_midpoint.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_simpson.png b/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_simpson.png deleted file mode 100644 index 4ceb9b26..00000000 Binary files a/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_simpson.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_trapezoid.png b/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_trapezoid.png deleted file mode 100644 index 8026e79b..00000000 Binary files a/example/flutter_example/test/routes/integral_page/utils/goldens/integral_plot_trapezoid.png and /dev/null differ diff --git a/example/flutter_example/test/routes/integral_page/utils/integral_plot_test.dart b/example/flutter_example/test/routes/integral_page/utils/integral_plot_test.dart deleted file mode 100644 index 09a6fc22..00000000 --- a/example/flutter_example/test/routes/integral_page/utils/integral_plot_test.dart +++ /dev/null @@ -1,120 +0,0 @@ -import 'package:equations_solver/routes/integral_page/model/inherited_integral.dart'; -import 'package:equations_solver/routes/integral_page/model/integral_state.dart'; -import 'package:equations_solver/routes/integral_page/utils/integral_plot_widget.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'IntegralPlotWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - InheritedIntegral( - integralState: IntegralState() - ..solveIntegral( - upperBound: '2', - lowerBound: '1', - function: 'x-2', - intervals: 30, - integralType: IntegralType.simpson, - ), - child: const MockWrapper( - child: SingleChildScrollView( - child: IntegralPlotWidget(), - ), - ), - ), - ); - - expect(find.byType(IntegralPlotWidget), findsOneWidget); - expect(find.byType(CartesianPlane), findsOneWidget); - }); - }); - - group('Golden test - IntegralPlotWidget', () { - Widget mockedTree({ - required IntegralState state, - }) { - return MockWrapper( - child: InheritedIntegral( - integralState: state, - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 10, - initial: 5, - ), - child: const IntegralPlotWidget(), - ), - ), - ); - } - - testWidgets('IntegralPlotWidget - simpson', (tester) async { - await tester.binding.setSurfaceSize(const Size(800, 800)); - - await tester.pumpWidget( - mockedTree( - state: IntegralState() - ..solveIntegral( - upperBound: '2.5', - lowerBound: '0', - function: 'cos(x)*e^x', - intervals: 30, - integralType: IntegralType.simpson, - ), - ), - ); - await expectLater( - find.byType(IntegralPlotWidget), - matchesGoldenFile('goldens/integral_plot_simpson.png'), - ); - }); - - testWidgets('IntegralPlotWidget - midpoint', (tester) async { - await tester.binding.setSurfaceSize(const Size(800, 800)); - - await tester.pumpWidget( - mockedTree( - state: IntegralState() - ..solveIntegral( - upperBound: '0.75', - lowerBound: '-1', - function: 'x^3-2*x+1', - intervals: 30, - integralType: IntegralType.midPoint, - ), - ), - ); - await expectLater( - find.byType(IntegralPlotWidget), - matchesGoldenFile('goldens/integral_plot_midpoint.png'), - ); - }); - - testWidgets('IntegralPlotWidget - trapezoid', (tester) async { - await tester.binding.setSurfaceSize(const Size(800, 800)); - - await tester.pumpWidget( - mockedTree( - state: IntegralState() - ..solveIntegral( - upperBound: '3', - lowerBound: '-3', - function: 'x+2', - intervals: 30, - integralType: IntegralType.trapezoid, - ), - ), - ); - await expectLater( - find.byType(IntegralPlotWidget), - matchesGoldenFile('goldens/integral_plot_trapezoid.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/integral_page_test.dart b/example/flutter_example/test/routes/integral_page_test.dart deleted file mode 100644 index 9a7ed786..00000000 --- a/example/flutter_example/test/routes/integral_page_test.dart +++ /dev/null @@ -1,128 +0,0 @@ -import 'package:equations_solver/routes/integral_page.dart'; -import 'package:equations_solver/routes/integral_page/integral_body.dart'; -import 'package:equations_solver/routes/integral_page/integral_results.dart'; -import 'package:equations_solver/routes/integral_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'integral_page/integral_mock.dart'; -import 'mock_wrapper.dart'; - -void main() { - group("Testing the 'IntegralPage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: IntegralPage(), - ), - ); - - expect(find.byType(IntegralPage), findsOneWidget); - expect(find.byType(EquationScaffold), findsOneWidget); - expect(find.byType(IntegralBody), findsOneWidget); - }); - }); - - group('Golden tests - IntegralBody', () { - Future solveIntegral(WidgetTester tester) async { - final equationInput = find.byKey(const Key('EquationInput-function')); - final lowerInput = find.byKey(const Key('IntegralInput-lower-bound')); - final upperInput = find.byKey(const Key('IntegralInput-upper-bound')); - - // Filling the forms - await tester.enterText(equationInput, 'x+2'); - await tester.enterText(lowerInput, '1'); - await tester.enterText(upperInput, '3'); - - // Solving the equation - await tester.tap(find.byKey(const Key('Integral-button-solve'))); - await tester.pumpAndSettle(); - - await tester.ensureVisible(find.byType(IntegralResultsWidget).last); - await tester.pumpAndSettle(); - } - - testWidgets('IntegralBody - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1300)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.simpson.name, - ), - ); - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/integral_body_small_screen.png'), - ); - }); - - testWidgets('IntegralBody - large screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(1200, 900)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.simpson.name, - ), - ); - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/integral_body_large_screen.png'), - ); - }); - - testWidgets('IntegralBody - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1300)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.simpson.name, - ), - ); - - await solveIntegral(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/integral_body_small_screen_with_data.png'), - ); - }); - - testWidgets('IntegralBody - large screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(1300, 900)); - - await tester.pumpWidget( - MockIntegralWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: IntegralDropdownItems.simpson.name, - ), - ); - - await solveIntegral(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/integral_body_large_screen_with_data.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/mock_wrapper.dart b/example/flutter_example/test/routes/mock_wrapper.dart deleted file mode 100644 index 9056ff2e..00000000 --- a/example/flutter_example/test/routes/mock_wrapper.dart +++ /dev/null @@ -1,76 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:flutter/material.dart'; - -/// A wrapper of a [MaterialApp] with localization support to be used in widget -/// tests. -class MockWrapper extends StatelessWidget { - /// The child to be tested. - final Widget child; - - /// This is useful when there's the need to make sure that a route is pushed - /// or popped. - final List navigatorObservers; - - /// The initial value of the dropdown. - /// - /// By default, this is an empty string. - final String dropdownInitial; - - /// Creates a [MockWrapper] widget. - const MockWrapper({ - required this.child, - this.navigatorObservers = const [], - this.dropdownInitial = '', - super.key, - }); - - @override - Widget build(BuildContext context) { - return MaterialApp( - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - navigatorObservers: navigatorObservers, - debugShowCheckedModeBanner: false, - home: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 10, - initial: 2, - ), - child: Scaffold( - body: child, - ), - ), - ); - } -} - -/// A wrapper of a [MaterialApp] with localization and navigator support to be -/// used in widget tests. -class MockWrapperWithNavigator extends StatelessWidget { - /// The initial route. - final String initialRoute; - - /// Creates a [MockWrapperWithNavigator] widget. - const MockWrapperWithNavigator({ - super.key, - this.initialRoute = homePagePath, - }); - - @override - Widget build(BuildContext context) { - final appRouter = generateRouter(initialRoute: initialRoute); - - return MaterialApp.router( - routerDelegate: appRouter.routerDelegate, - routeInformationParser: appRouter.routeInformationParser, - routeInformationProvider: appRouter.routeInformationProvider, - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - debugShowCheckedModeBanner: false, - ); - } -} diff --git a/example/flutter_example/test/routes/model/dropdown_value/inherited_dropdown_value_test.dart b/example/flutter_example/test/routes/model/dropdown_value/inherited_dropdown_value_test.dart deleted file mode 100644 index 0bf0ffca..00000000 --- a/example/flutter_example/test/routes/model/dropdown_value/inherited_dropdown_value_test.dart +++ /dev/null @@ -1,64 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedPolynomial' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final valueNotifier = ValueNotifier('test'); - - final inheritedDropdown = InheritedDropdownValue( - dropdownValue: valueNotifier, - child: const SizedBox.shrink(), - ); - - expect( - inheritedDropdown.updateShouldNotify(inheritedDropdown), - isFalse, - ); - expect( - inheritedDropdown.updateShouldNotify( - InheritedDropdownValue( - dropdownValue: ValueNotifier('test'), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedDropdown.updateShouldNotify( - InheritedDropdownValue( - dropdownValue: ValueNotifier(''), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late ValueNotifier reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedDropdownValue( - dropdownValue: ValueNotifier('test'), - child: Builder( - builder: (context) { - reference = InheritedDropdownValue.of(context).dropdownValue; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.value, equals('test')); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/model/inherited_navigation/inherited_navigation_test.dart b/example/flutter_example/test/routes/model/inherited_navigation/inherited_navigation_test.dart deleted file mode 100644 index 15501b99..00000000 --- a/example/flutter_example/test/routes/model/inherited_navigation/inherited_navigation_test.dart +++ /dev/null @@ -1,88 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedNavigation' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final valueNotifier = ValueNotifier(0); - - final inheritedNavigation = InheritedNavigation( - navigationIndex: valueNotifier, - fab: null, - tabController: TabController( - length: 1, - vsync: const TestVSync(), - ), - navigationItems: const [], - child: const SizedBox.shrink(), - ); - - expect( - inheritedNavigation.updateShouldNotify(inheritedNavigation), - isFalse, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedNavigation( - navigationIndex: valueNotifier, - fab: null, - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - navigationItems: const [], - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedNavigation( - navigationIndex: ValueNotifier(1), - fab: null, - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - navigationItems: const [], - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late ValueNotifier reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedNavigation( - navigationIndex: ValueNotifier(1), - fab: null, - tabController: TabController( - length: 1, - vsync: const TestVSync(), - ), - navigationItems: const [], - child: Builder( - builder: (context) { - reference = InheritedNavigation.of(context).navigationIndex; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.value, equals(1)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/model/number_switcher/inherited_number_switcher_test.dart b/example/flutter_example/test/routes/model/number_switcher/inherited_number_switcher_test.dart deleted file mode 100644 index 6aca6700..00000000 --- a/example/flutter_example/test/routes/model/number_switcher/inherited_number_switcher_test.dart +++ /dev/null @@ -1,80 +0,0 @@ -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedNavigation' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final numberSwitcher = NumberSwitcherState( - min: 1, - max: 10, - ); - - final inheritedNavigation = InheritedNumberSwitcher( - numberSwitcherState: numberSwitcher, - child: const SizedBox.shrink(), - ); - - expect( - inheritedNavigation.updateShouldNotify(inheritedNavigation), - isFalse, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 10, - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 3, - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late NumberSwitcherState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 3, - ), - child: Builder( - builder: (context) { - reference = - InheritedNumberSwitcher.of(context).numberSwitcherState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.min, equals(1)); - expect(reference.max, equals(3)); - expect(reference.state, equals(1)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/model/number_switcher/number_switcher_state_test.dart b/example/flutter_example/test/routes/model/number_switcher/number_switcher_state_test.dart deleted file mode 100644 index 381c894e..00000000 --- a/example/flutter_example/test/routes/model/number_switcher/number_switcher_state_test.dart +++ /dev/null @@ -1,52 +0,0 @@ -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NumberSwitcherState' class", () { - test('Initial values', () { - final numberSwitcher = NumberSwitcherState(min: 1, max: 5); - - expect(numberSwitcher.min, equals(1)); - expect(numberSwitcher.max, equals(5)); - expect(numberSwitcher.state, equals(1)); - }); - - test('Making sure that increase and decrease methods work correctly', () { - var notifyCounter = 0; - final numberSwitcher = NumberSwitcherState(min: 1, max: 5) - ..addListener(() => ++notifyCounter); - - expect(notifyCounter, isZero); - expect(numberSwitcher.state, equals(1)); - - // Increasing - numberSwitcher.increase(); - expect(notifyCounter, equals(1)); - expect(numberSwitcher.state, equals(2)); - - // Decreasing - numberSwitcher.decrease(); - expect(notifyCounter, equals(2)); - expect(numberSwitcher.state, equals(1)); - - // Increasing more than the max. allowed - numberSwitcher - ..increase() - ..increase() - ..increase() - ..increase() - ..increase() - ..increase() - ..increase() - ..increase(); - expect(notifyCounter, equals(6)); - expect(numberSwitcher.state, equals(5)); - - // Reset - numberSwitcher.reset(); - - expect(notifyCounter, equals(7)); - expect(numberSwitcher.state, equals(1)); - }); - }); -} diff --git a/example/flutter_example/test/routes/model/plot_zoom/inherited_plot_zoom_test.dart b/example/flutter_example/test/routes/model/plot_zoom/inherited_plot_zoom_test.dart deleted file mode 100644 index 6bd1bb5e..00000000 --- a/example/flutter_example/test/routes/model/plot_zoom/inherited_plot_zoom_test.dart +++ /dev/null @@ -1,83 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedPlotZoom' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final plotZoom = PlotZoomState( - minValue: 1, - maxValue: 5, - initial: 3, - ); - - final inheritedNavigation = InheritedPlotZoom( - plotZoomState: plotZoom, - child: const SizedBox.shrink(), - ); - - expect( - inheritedNavigation.updateShouldNotify(inheritedNavigation), - isFalse, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 5, - initial: 3, - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 5, - initial: 2, - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late PlotZoomState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 5, - initial: 3, - ), - child: Builder( - builder: (context) { - reference = InheritedPlotZoom.of(context).plotZoomState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.minValue, equals(1)); - expect(reference.maxValue, equals(5)); - expect(reference.initial, equals(3)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/model/plot_zoom/plot_zoom_state_test.dart b/example/flutter_example/test/routes/model/plot_zoom/plot_zoom_state_test.dart deleted file mode 100644 index 97be00a9..00000000 --- a/example/flutter_example/test/routes/model/plot_zoom/plot_zoom_state_test.dart +++ /dev/null @@ -1,39 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'PlotZoomState' class", () { - test('Initial values', () { - final plotZoom = PlotZoomState(minValue: 1, maxValue: 5, initial: 3); - - expect(plotZoom.minValue, equals(1)); - expect(plotZoom.maxValue, equals(5)); - expect(plotZoom.initial, equals(3)); - }); - - test('Making sure that increase and decrease methods work correctly', () { - var notifyCounter = 0; - final plotZoom = PlotZoomState(minValue: 1, maxValue: 5, initial: 3) - ..addListener(() => ++notifyCounter); - - expect(notifyCounter, isZero); - expect(plotZoom.zoom, equals(3)); - - // Increasing - plotZoom.updateSlider(4); - expect(notifyCounter, equals(1)); - expect(plotZoom.zoom, equals(4.0)); - - // Increasing but out of bounds - plotZoom.updateSlider(100); - expect(notifyCounter, equals(1)); - expect(plotZoom.zoom, equals(4.0)); - - // Reset - plotZoom.reset(); - - expect(notifyCounter, equals(2)); - expect(plotZoom.zoom, equals(3.0)); - }); - }); -} diff --git a/example/flutter_example/test/routes/model/precision_slider/inherited_precision_slider.dart b/example/flutter_example/test/routes/model/precision_slider/inherited_precision_slider.dart deleted file mode 100644 index 63f828b6..00000000 --- a/example/flutter_example/test/routes/model/precision_slider/inherited_precision_slider.dart +++ /dev/null @@ -1,79 +0,0 @@ -import 'package:equations_solver/routes/models/precision_slider/inherited_precision_slider.dart'; -import 'package:equations_solver/routes/models/precision_slider/precision_slider_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedPrecisionSlider' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final precisionSlider = PrecisionSliderState( - minValue: 1, - maxValue: 8, - ); - - final inheritedNavigation = InheritedPrecisionSlider( - precisionState: precisionSlider, - child: const SizedBox.shrink(), - ); - - expect( - inheritedNavigation.updateShouldNotify(inheritedNavigation), - isFalse, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedPrecisionSlider( - precisionState: PrecisionSliderState( - minValue: 1, - maxValue: 8, - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedPrecisionSlider( - precisionState: PrecisionSliderState( - minValue: 2, - maxValue: 8, - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late PrecisionSliderState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedPrecisionSlider( - precisionState: PrecisionSliderState( - minValue: 2, - maxValue: 8, - ), - child: Builder( - builder: (context) { - reference = - InheritedPrecisionSlider.of(context).precisionState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.minValue, equals(1)); - expect(reference.maxValue, equals(5)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/model/precision_slider/precision_slider_state_test.dart b/example/flutter_example/test/routes/model/precision_slider/precision_slider_state_test.dart deleted file mode 100644 index 1dbba212..00000000 --- a/example/flutter_example/test/routes/model/precision_slider/precision_slider_state_test.dart +++ /dev/null @@ -1,38 +0,0 @@ -import 'package:equations_solver/routes/models/precision_slider/precision_slider_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'PrecisionSliderState' class", () { - test('Initial values', () { - final precisionSlider = PrecisionSliderState(minValue: 1, maxValue: 5); - - expect(precisionSlider.minValue, equals(1)); - expect(precisionSlider.maxValue, equals(5)); - }); - - test('Making sure that increase and decrease methods work correctly', () { - var notifyCounter = 0; - final precisionSlider = PrecisionSliderState(minValue: 1, maxValue: 5) - ..addListener(() => ++notifyCounter); - - expect(notifyCounter, isZero); - expect(precisionSlider.value, equals(3)); - - // Increasing - precisionSlider.updateSlider(4); - expect(notifyCounter, equals(1)); - expect(precisionSlider.value, equals(4.0)); - - // Increasing but out of bounds - precisionSlider.updateSlider(100); - expect(notifyCounter, equals(1)); - expect(precisionSlider.value, equals(4.0)); - - // Reset - precisionSlider.reset(); - - expect(notifyCounter, equals(2)); - expect(precisionSlider.value, equals(3.0)); - }); - }); -} diff --git a/example/flutter_example/test/routes/model/system_text_controllers/inherited_system_text_controllers_test.dart b/example/flutter_example/test/routes/model/system_text_controllers/inherited_system_text_controllers_test.dart deleted file mode 100644 index c05b95a7..00000000 --- a/example/flutter_example/test/routes/model/system_text_controllers/inherited_system_text_controllers_test.dart +++ /dev/null @@ -1,111 +0,0 @@ -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/system_text_controllers.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedTextControllers' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final systemControllers = SystemTextControllers( - matrixControllers: [ - TextEditingController(), - ], - vectorControllers: [ - TextEditingController(), - ], - jacobiControllers: [ - TextEditingController(), - ], - wSorController: TextEditingController(), - ); - - final inheritedNavigation = InheritedSystemControllers( - systemTextControllers: systemControllers, - child: const SizedBox.shrink(), - ); - - expect( - inheritedNavigation.updateShouldNotify(inheritedNavigation), - isFalse, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: [ - TextEditingController(), - ], - vectorControllers: [ - TextEditingController(), - ], - jacobiControllers: [ - TextEditingController(), - ], - wSorController: TextEditingController(), - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: [ - TextEditingController(), - ], - vectorControllers: [], - jacobiControllers: [ - TextEditingController(), - ], - wSorController: TextEditingController(), - ), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late SystemTextControllers reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: [ - TextEditingController(), - ], - vectorControllers: [ - TextEditingController(), - ], - jacobiControllers: [ - TextEditingController(), - ], - wSorController: TextEditingController(), - ), - child: Builder( - builder: (context) { - reference = InheritedSystemControllers.of(context) - .systemTextControllers; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.matrixControllers.length, equals(1)); - expect(reference.vectorControllers.length, equals(1)); - expect(reference.jacobiControllers.length, equals(1)); - expect(reference.wSorController, isNotNull); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/model/text_controllers/inherited_text_controllers_test.dart b/example/flutter_example/test/routes/model/text_controllers/inherited_text_controllers_test.dart deleted file mode 100644 index 65812166..00000000 --- a/example/flutter_example/test/routes/model/text_controllers/inherited_text_controllers_test.dart +++ /dev/null @@ -1,69 +0,0 @@ -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedTextControllers' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final controllers = [TextEditingController()]; - - final inheritedNavigation = InheritedTextControllers( - textControllers: controllers, - child: const SizedBox.shrink(), - ); - - expect( - inheritedNavigation.updateShouldNotify(inheritedNavigation), - isFalse, - ); - expect( - inheritedNavigation.updateShouldNotify( - const InheritedTextControllers( - textControllers: [], - child: SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNavigation.updateShouldNotify( - InheritedTextControllers( - textControllers: [TextEditingController()], - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late List reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedTextControllers( - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: Builder( - builder: (context) { - reference = - InheritedTextControllers.of(context).textControllers; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.length, equals(3)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/goldens/nonlinear_data_input_bracketing.png b/example/flutter_example/test/routes/nonlinear_page/goldens/nonlinear_data_input_bracketing.png deleted file mode 100644 index 043b3f0b..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/goldens/nonlinear_data_input_bracketing.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/goldens/nonlinear_data_input_single_point.png b/example/flutter_example/test/routes/nonlinear_page/goldens/nonlinear_data_input_single_point.png deleted file mode 100644 index 4f905fe0..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/goldens/nonlinear_data_input_single_point.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/model/inherited_nonlinear_test.dart b/example/flutter_example/test/routes/nonlinear_page/model/inherited_nonlinear_test.dart deleted file mode 100644 index 89e171f1..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/model/inherited_nonlinear_test.dart +++ /dev/null @@ -1,64 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedNonlinear' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final inheritedNonlinear = InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.singlePoint), - child: const SizedBox.shrink(), - ); - - expect( - inheritedNonlinear.updateShouldNotify(inheritedNonlinear), - isFalse, - ); - expect( - inheritedNonlinear.updateShouldNotify( - InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.singlePoint), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNonlinear.updateShouldNotify( - InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.singlePoint), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late NonlinearState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.singlePoint), - child: Builder( - builder: (context) { - reference = InheritedNonlinear.of(context).nonlinearState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.nonlinearType, equals(NonlinearType.singlePoint)); - expect(reference.state.nonlinear, isNull); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/model/nonlinear_result_test.dart b/example/flutter_example/test/routes/nonlinear_page/model/nonlinear_result_test.dart deleted file mode 100644 index 5a8ded2d..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/model/nonlinear_result_test.dart +++ /dev/null @@ -1,94 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_result.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NonlinearResult' class", () { - test('Initial values', () { - const nonlinearResult = NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ); - - expect(nonlinearResult.nonlinear, isA()); - }); - - test('Making sure that objects can be properly compared', () { - const nonlinearResult = NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ); - - expect( - nonlinearResult, - equals( - const NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ), - ), - ); - - expect( - const NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ), - nonlinearResult, - ); - - expect( - nonlinearResult == - const NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ), - isTrue, - ); - - expect( - const NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ) == - nonlinearResult, - isTrue, - ); - - expect( - const NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2.1, - ), - ) == - nonlinearResult, - isFalse, - ); - - expect( - nonlinearResult.hashCode, - equals( - const NonlinearResult( - nonlinear: Newton( - function: 'x-2', - x0: 2, - ), - ).hashCode, - ), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/model/nonlinear_state_test.dart b/example/flutter_example/test/routes/nonlinear_page/model/nonlinear_state_test.dart deleted file mode 100644 index ff276f09..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/model/nonlinear_state_test.dart +++ /dev/null @@ -1,162 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_result.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NonlinearType' enum", () { - test('Properties values', () { - expect(NonlinearType.values.length, equals(2)); - expect(SinglePointMethods.values.length, equals(2)); - expect(BracketingMethods.values.length, equals(3)); - }); - }); - - group("Testing the 'NonlinearState' class", () { - test('Initial values', () { - final nonlinearState = NonlinearState(NonlinearType.singlePoint); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state, equals(const NonlinearResult())); - }); - - test('Making sure that s. point equations can be solved and cleared', () { - var count = 0; - final nonlinearState = NonlinearState(NonlinearType.singlePoint) - ..addListener(() => ++count); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state, equals(const NonlinearResult())); - - nonlinearState.solveWithSinglePoint( - function: 'x-2', - precision: 1.0e-10, - initialGuess: '2', - method: SinglePointMethods.newton, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state.nonlinear, isNotNull); - expect(count, equals(1)); - - nonlinearState.clear(); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state, equals(const NonlinearResult())); - expect(count, equals(2)); - - nonlinearState.solveWithSinglePoint( - function: 'x-2', - precision: 1.0e-10, - initialGuess: '2', - method: SinglePointMethods.steffensen, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state.nonlinear, isNotNull); - expect(count, equals(3)); - }); - - test('Making sure that bracketing equations can be solved and cleared', () { - var count = 0; - final nonlinearState = NonlinearState(NonlinearType.bracketing) - ..addListener(() => ++count); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state, equals(const NonlinearResult())); - - nonlinearState.solveWithBracketing( - function: 'x-2', - precision: 1.0e-10, - upperBound: '1', - lowerBound: '1', - method: BracketingMethods.bisection, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state.nonlinear, isNotNull); - expect(count, equals(1)); - - nonlinearState.clear(); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state, equals(const NonlinearResult())); - expect(count, equals(2)); - - nonlinearState.solveWithBracketing( - function: 'x-2', - precision: 1.0e-10, - upperBound: '1', - lowerBound: '1', - method: BracketingMethods.brent, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state.nonlinear, isNotNull); - expect(count, equals(3)); - }); - - test('Making sure that exceptions are handled - Single point', () { - var count = 0; - final nonlinearState = NonlinearState(NonlinearType.singlePoint) - ..addListener(() => ++count); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state, equals(const NonlinearResult())); - - nonlinearState.solveWithSinglePoint( - function: '', - precision: 1.0e-10, - initialGuess: '', - method: SinglePointMethods.newton, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state.nonlinear, isNull); - expect(count, equals(1)); - - nonlinearState.solveWithSinglePoint( - function: 'x^2', - precision: 1.0e-10, - initialGuess: '', - method: SinglePointMethods.newton, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.singlePoint)); - expect(nonlinearState.state.nonlinear, isNull); - expect(count, equals(2)); - }); - - test('Making sure that exceptions are handled - Bracketing', () { - var count = 0; - final nonlinearState = NonlinearState(NonlinearType.bracketing) - ..addListener(() => ++count); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state, equals(const NonlinearResult())); - - nonlinearState.solveWithBracketing( - function: 'x-2', - precision: 1.0e-10, - lowerBound: '', - upperBound: '1', - method: BracketingMethods.bisection, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state.nonlinear, isNull); - expect(count, equals(1)); - - nonlinearState.solveWithBracketing( - function: 'x-2', - precision: 1.0e-10, - lowerBound: '0', - upperBound: '', - method: BracketingMethods.bisection, - ); - - expect(nonlinearState.nonlinearType, equals(NonlinearType.bracketing)); - expect(nonlinearState.state.nonlinear, isNull); - expect(count, equals(2)); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/nonlinear_body_test.dart b/example/flutter_example/test/routes/nonlinear_page/nonlinear_body_test.dart deleted file mode 100644 index 37216883..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/nonlinear_body_test.dart +++ /dev/null @@ -1,173 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_body.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_data_input.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_results.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'nonlinear_mock.dart'; - -void main() { - group("Testing the 'NonlinearBody' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(NonlinearDataInput), findsOneWidget); - expect(find.byType(NonlinearResults), findsOneWidget); - expect(find.byType(InputKindDialogButton), findsOneWidget); - }); - - testWidgets( - 'Making sure that the widget is responsive - small screens ' - 'test', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect( - find.byKey(const Key('SingleChildScrollView-mobile-responsive')), - findsOneWidget, - ); - expect( - find.byKey(const Key('SingleChildScrollView-desktop-responsive')), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that the widget is responsive - large screens ' - 'test', - (tester) async { - await tester.binding.setSurfaceSize(const Size(2000, 2000)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect( - find.byKey(const Key('SingleChildScrollView-mobile-responsive')), - findsNothing, - ); - expect( - find.byKey(const Key('SingleChildScrollView-desktop-responsive')), - findsOneWidget, - ); - }, - ); - - testWidgets( - 'Making sure that single point equations works', - (tester) async { - late String title; - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - child: Builder( - builder: (context) { - title = context.l10n.single_point; - - return const NonlinearBody(); - }, - ), - ), - ); - - expect(find.text(title), findsOneWidget); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput = find.byKey(const Key('EquationInput-first-param')); - final solveButton = find.byKey(const Key('Nonlinear-button-solve')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3'); - await tester.enterText(paramInput, '3'); - - // Making sure that there are no results - expect(find.byType(NoResults), findsOneWidget); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Solutions on the UI! - expect(find.byType(NoResults), findsNothing); - expect(find.byType(RealResultCard), findsNWidgets(3)); - }, - ); - - testWidgets('Making sure that bracketing equations works', (tester) async { - late String title; - - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - dropdownValue: 'Bisection', - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: Builder( - builder: (context) { - title = context.l10n.bracketing; - - return const NonlinearBody(); - }, - ), - ), - ); - - expect(find.text(title), findsOneWidget); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput1 = find.byKey(const Key('EquationInput-first-param')); - final paramInput2 = find.byKey(const Key('EquationInput-second-param')); - final solveButton = find.byKey(const Key('Nonlinear-button-solve')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3.17263'); - await tester.enterText(paramInput1, '2'); - await tester.enterText(paramInput2, '4.3'); - - // Making sure that there are no results - expect(find.byType(NoResults), findsOneWidget); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Solutions on the UI! - expect(find.byType(NoResults), findsNothing); - expect(find.byType(RealResultCard), findsNWidgets(3)); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/nonlinear_data_input_test.dart b/example/flutter_example/test/routes/nonlinear_page/nonlinear_data_input_test.dart deleted file mode 100644 index 7fd4282c..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/nonlinear_data_input_test.dart +++ /dev/null @@ -1,259 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_data_input.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/precision_slider.dart'; -import 'package:equations_solver/routes/utils/equation_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; -import 'nonlinear_mock.dart'; - -void main() { - group("Testing the 'NonlinearDataInput' widget", () { - testWidgets( - "Making sure that with a 'singlePoint' configuration type only " - 'has 2 input fields appear on the screen', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - dropdownValue: NonlinearDropdownItems.newton.name, - child: const NonlinearDataInput(), - ), - ); - - expect(find.byType(NonlinearDataInput), findsOneWidget); - expect(find.byType(EquationInput), findsNWidgets(2)); - expect(find.byType(NonlinearDropdownSelection), findsOneWidget); - expect(find.byType(PrecisionSlider), findsOneWidget); - - // To make sure that fields validation actually happens - expect(find.byType(Form), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that with a 'bracketing' configuration type only " - 'has 3 input fields appear on the screen', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: NonlinearDropdownItems.secant.name, - child: const NonlinearDataInput(), - ), - ); - - expect(find.byType(NonlinearDataInput), findsOneWidget); - expect(find.byType(EquationInput), findsNWidgets(3)); - expect(find.byType(NonlinearDropdownSelection), findsOneWidget); - expect(find.byType(PrecisionSlider), findsOneWidget); - - // To make sure that fields validation actually happens - expect(find.byType(Form), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that when trying to solve an equation, if at ' - 'least one of the inputs is wrong, a snackbar appears', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: NonlinearDropdownItems.secant.name, - child: const NonlinearDataInput(), - ), - ); - - // No snackbar by default - expect(find.byType(SnackBar), findsNothing); - - // Tap the 'Solve' button - final finder = find.byKey(const Key('Nonlinear-button-solve')); - await tester.tap(finder); - - // The snackbar appeared - await tester.pumpAndSettle(); - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that single point equations can be solved', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - child: const NonlinearDataInput(), - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput = find.byKey(const Key('EquationInput-first-param')); - final solveButton = find.byKey(const Key('Nonlinear-button-solve')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3'); - await tester.enterText(paramInput, '3'); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - final inheritedWidget = tester.widget( - find.byType(InheritedNonlinear), - ); - expect(inheritedWidget.nonlinearState.state.nonlinear, isNotNull); - }, - ); - - testWidgets( - 'Making sure that bracketing equations can be solved', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - dropdownValue: NonlinearDropdownItems.secant.name, - child: const NonlinearDataInput(), - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput1 = find.byKey(const Key('EquationInput-first-param')); - final paramInput2 = find.byKey(const Key('EquationInput-second-param')); - final solveButton = find.byKey(const Key('Nonlinear-button-solve')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3'); - await tester.enterText(paramInput1, '1'); - await tester.enterText(paramInput2, '4'); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - final inheritedWidget = tester.widget( - find.byType(InheritedNonlinear), - ); - expect(inheritedWidget.nonlinearState.state.nonlinear, isNotNull); - - // Cleaning - await tester.tap(find.byKey(const Key('Nonlinear-button-clean'))); - await tester.pumpAndSettle(); - - expect(find.text('x-3'), findsNothing); - expect(find.text('1'), findsNothing); - expect(find.text('4'), findsNothing); - }, - ); - - testWidgets('Making sure that textfields can be cleared', (tester) async { - late FocusScopeNode focusScope; - - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - focusScope = FocusScope.of(context); - - return MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - child: const NonlinearDataInput(), - ); - }, - ), - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput = find.byKey(const Key('EquationInput-first-param')); - final cleanButton = find.byKey(const Key('Nonlinear-button-clean')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3'); - await tester.enterText(paramInput, '3'); - - // Making sure that fields are filled - expect(find.text('x-3'), findsOneWidget); - expect(find.text('3'), findsOneWidget); - expect(focusScope.hasFocus, isTrue); - - // Tap the 'Clear' button - await tester.tap(cleanButton); - await tester.pumpAndSettle(); - - final inheritedWidget = tester.widget( - find.byType(InheritedNonlinear), - ); - expect(inheritedWidget.nonlinearState.state.nonlinear, isNull); - - tester.widgetList(find.byType(TextFormField)).forEach((t) { - expect(t.controller!.text.length, isZero); - }); - }); - }); - - group('Golden tests - NonlinearDataInput', () { - testWidgets('NonlinearDataInput - single point', (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - child: const NonlinearDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/nonlinear_data_input_single_point.png'), - ); - }); - - testWidgets('NonlinearDataInput - bracketing', (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - dropdownValue: NonlinearDropdownItems.bisection.name, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: const NonlinearDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/nonlinear_data_input_bracketing.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/nonlinear_mock.dart b/example/flutter_example/test/routes/nonlinear_page/nonlinear_mock.dart deleted file mode 100644 index 98e6a678..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/nonlinear_mock.dart +++ /dev/null @@ -1,58 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/models/precision_slider/inherited_precision_slider.dart'; -import 'package:equations_solver/routes/models/precision_slider/precision_slider_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_body.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/dropdown_selection.dart'; -import 'package:flutter/material.dart'; - -import '../mock_wrapper.dart'; - -class MockNonlinearWidget extends StatelessWidget { - final List textControllers; - final NonlinearType nonlinearType; - final Widget child; - final String? dropdownValue; - const MockNonlinearWidget({ - super.key, - this.textControllers = const [], - this.nonlinearType = NonlinearType.singlePoint, - this.dropdownValue, - this.child = const NonlinearBody(), - }); - - @override - Widget build(BuildContext context) { - return MockWrapper( - child: InheritedNonlinear( - nonlinearState: NonlinearState(nonlinearType), - child: InheritedTextControllers( - textControllers: textControllers, - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - dropdownValue ?? NonlinearDropdownItems.newton.name, - ), - child: InheritedPrecisionSlider( - precisionState: PrecisionSliderState( - minValue: 2, - maxValue: 10, - ), - child: child, - ), - ), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/test/routes/nonlinear_page/nonlinear_results_test.dart b/example/flutter_example/test/routes/nonlinear_page/nonlinear_results_test.dart deleted file mode 100644 index 0dad26ff..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/nonlinear_results_test.dart +++ /dev/null @@ -1,124 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/nonlinear_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/message_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'nonlinear_mock.dart'; - -void main() { - group("Testing the 'NonlinearResults' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - child: const NonlinearResults(), - ), - ); - - expect(find.byType(NonlinearResults), findsOneWidget); - expect(find.byType(SectionTitle), findsOneWidget); - }); - - testWidgets( - 'Making sure that when an error occurred while solving the equation, ' - 'a Snackbar appears.', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - // Refreshing to make the snackbar appear - await tester.tap(find.byKey(const Key('Nonlinear-button-solve'))); - await tester.pumpAndSettle(); - - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that a message appears when the method fails to converge.', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - // Filling the forms - await tester.enterText( - find.byKey(const Key('EquationInput-function')), - 'x-3', - ); - await tester.enterText( - find.byKey(const Key('EquationInput-first-param')), - '0', - ); - - // Solving the equation - await tester.tap(find.byKey(const Key('Nonlinear-button-solve'))); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - expect(find.byType(MessageCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that, when there are no solutions, a text widget ' - "appears saying that there's nothing to display", - (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: NonlinearResults(), - ), - ); - - expect(find.byType(RealResultCard), findsNothing); - expect(find.text('No solutions to display.'), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that, when there are solutions, solution widgets ' - 'appear on the screen', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput = find.byKey(const Key('EquationInput-first-param')); - final solveButton = find.byKey(const Key('Nonlinear-button-solve')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3'); - await tester.enterText(paramInput, '3'); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.text('No solutions to display.'), findsNothing); - expect(find.byType(RealResultCard), findsNWidgets(3)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/dropdown_selection_test.dart b/example/flutter_example/test/routes/nonlinear_page/utils/dropdown_selection_test.dart deleted file mode 100644 index 1be3fbc7..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/utils/dropdown_selection_test.dart +++ /dev/null @@ -1,169 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/dropdown_selection.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../nonlinear_mock.dart'; - -void main() { - group("Testing the 'DropdownSelection' widget", () { - test("Testing the 'NonlinearDropdownItemsExt' extension method", () { - expect(NonlinearDropdownItems.newton.name, equals('Newton')); - expect( - NonlinearDropdownItems.steffensen.name, - equals('Steffensen'), - ); - expect(NonlinearDropdownItems.bisection.name, equals('Bisection')); - expect(NonlinearDropdownItems.secant.name, equals('Secant')); - expect(NonlinearDropdownItems.brent.name, equals('Brent')); - }); - - test("Testing the 'StringExt' extension method", () { - expect( - 'newton'.toNonlinearDropdownItems(), - equals(NonlinearDropdownItems.newton), - ); - expect( - 'steffensen'.toNonlinearDropdownItems(), - equals(NonlinearDropdownItems.steffensen), - ); - expect( - 'bisection'.toNonlinearDropdownItems(), - equals(NonlinearDropdownItems.bisection), - ); - expect( - 'secant'.toNonlinearDropdownItems(), - equals(NonlinearDropdownItems.secant), - ); - expect( - 'brent'.toNonlinearDropdownItems(), - equals(NonlinearDropdownItems.brent), - ); - expect(''.toNonlinearDropdownItems, throwsArgumentError); - }); - - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: NonlinearDropdownSelection(), - ), - ); - - expect(find.byType(NonlinearDropdownSelection), findsOneWidget); - }); - - testWidgets( - "Making sure that when the state is of type 'singlePoint' the dropdown " - 'only contains single point algorithms', - (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: NonlinearDropdownSelection(), - ), - ); - - await tester.tap(find.text('Newton')); - await tester.pumpAndSettle(); - - final widgetFinder = find.byType(NonlinearDropdownSelection); - final state = - tester.state(widgetFinder) as NonlinearDropdownSelectionState; - - expect(state.dropdownItems.length, equals(2)); - expect( - state.dropdownItems.first.value, - equals(NonlinearDropdownItems.newton), - ); - expect( - state.dropdownItems[1].value, - equals(NonlinearDropdownItems.steffensen), - ); - }, - ); - - testWidgets( - "Making sure that when the state is of type 'bracketing' the dropdown " - 'only contains bracketing algorithms', - (tester) async { - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - dropdownValue: NonlinearDropdownItems.bisection.name, - child: const NonlinearDropdownSelection(), - ), - ); - - await tester.tap(find.text('Bisection')); - await tester.pumpAndSettle(); - - final widgetFinder = find.byType(NonlinearDropdownSelection); - final state = - tester.state(widgetFinder) as NonlinearDropdownSelectionState; - - expect(state.dropdownItems.length, equals(3)); - expect( - state.dropdownItems.first.value, - equals(NonlinearDropdownItems.bisection), - ); - expect( - state.dropdownItems[1].value, - equals(NonlinearDropdownItems.secant), - ); - expect( - state.dropdownItems[2].value, - equals(NonlinearDropdownItems.brent), - ); - }, - ); - - testWidgets( - 'Making sure that dropdown values can be changed', - (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: NonlinearDropdownSelection(), - ), - ); - - await tester.tap(find.text('Newton')); - await tester.pumpAndSettle(); - - await tester.tap(find.text('Steffensen').last); - await tester.pumpAndSettle(); - }, - ); - }); - - group('Golden tests - NonlinearDropdownSelection', () { - testWidgets('NonlinearDropdownSelection - single point', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 250)); - - await tester.pumpWidget( - const MockNonlinearWidget( - child: NonlinearDropdownSelection(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/dropdown_selection_single_point.png'), - ); - }); - - testWidgets('NonlinearDropdownSelection - bracketing', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 250)); - - await tester.pumpWidget( - MockNonlinearWidget( - nonlinearType: NonlinearType.bracketing, - dropdownValue: NonlinearDropdownItems.bisection.name, - child: const NonlinearDropdownSelection(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/dropdown_selection_bracketing.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/dropdown_selection_bracketing.png b/example/flutter_example/test/routes/nonlinear_page/utils/goldens/dropdown_selection_bracketing.png deleted file mode 100644 index 511ba24a..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/dropdown_selection_bracketing.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/dropdown_selection_single_point.png b/example/flutter_example/test/routes/nonlinear_page/utils/goldens/dropdown_selection_single_point.png deleted file mode 100644 index ff5f701c..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/dropdown_selection_single_point.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/nonlinear_plot_bisection.png b/example/flutter_example/test/routes/nonlinear_page/utils/goldens/nonlinear_plot_bisection.png deleted file mode 100644 index 85f78536..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/nonlinear_plot_bisection.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/nonlinear_plot_single_point.png b/example/flutter_example/test/routes/nonlinear_page/utils/goldens/nonlinear_plot_single_point.png deleted file mode 100644 index 271ed30f..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/nonlinear_plot_single_point.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/precision_slider.png b/example/flutter_example/test/routes/nonlinear_page/utils/goldens/precision_slider.png deleted file mode 100644 index 2d701443..00000000 Binary files a/example/flutter_example/test/routes/nonlinear_page/utils/goldens/precision_slider.png and /dev/null differ diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/nonlinear_plot_test.dart b/example/flutter_example/test/routes/nonlinear_page/utils/nonlinear_plot_test.dart deleted file mode 100644 index 8d36b15e..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/utils/nonlinear_plot_test.dart +++ /dev/null @@ -1,97 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/inherited_nonlinear.dart'; -import 'package:equations_solver/routes/nonlinear_page/model/nonlinear_state.dart'; -import 'package:equations_solver/routes/nonlinear_page/utils/nonlinear_plot_widget.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'NonlinearPlotWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - InheritedNonlinear( - nonlinearState: NonlinearState(NonlinearType.singlePoint) - ..solveWithSinglePoint( - initialGuess: 'x0', - function: 'x-2', - precision: 1.0e-10, - method: SinglePointMethods.newton, - ), - child: const MockWrapper( - child: SingleChildScrollView( - child: NonlinearPlotWidget(), - ), - ), - ), - ); - - expect(find.byType(NonlinearPlotWidget), findsOneWidget); - expect(find.byType(CartesianPlane), findsOneWidget); - }); - }); - - group('Golden test - NonlinearPlotWidget', () { - Widget mockedTree({ - required NonlinearState state, - }) { - return MockWrapper( - child: InheritedNonlinear( - nonlinearState: state, - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 10, - initial: 5, - ), - child: const NonlinearPlotWidget(), - ), - ), - ); - } - - testWidgets('NonlinearPlotWidget - single point', (tester) async { - await tester.binding.setSurfaceSize(const Size(900, 900)); - - await tester.pumpWidget( - mockedTree( - state: NonlinearState(NonlinearType.singlePoint) - ..solveWithSinglePoint( - initialGuess: '-3', - function: 'e^x-sin(x)', - precision: 1.0e-10, - method: SinglePointMethods.newton, - ), - ), - ); - await expectLater( - find.byType(NonlinearPlotWidget), - matchesGoldenFile('goldens/nonlinear_plot_single_point.png'), - ); - }); - - testWidgets('NonlinearPlotWidget - bracketing', (tester) async { - await tester.binding.setSurfaceSize(const Size(900, 900)); - - await tester.pumpWidget( - mockedTree( - state: NonlinearState(NonlinearType.bracketing) - ..solveWithBracketing( - lowerBound: '0.25', - upperBound: '1.46', - function: 'x^5-e^x', - precision: 1.0e-10, - method: BracketingMethods.bisection, - ), - ), - ); - await expectLater( - find.byType(NonlinearPlotWidget), - matchesGoldenFile('goldens/nonlinear_plot_bisection.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page/utils/precision_slider_test.dart b/example/flutter_example/test/routes/nonlinear_page/utils/precision_slider_test.dart deleted file mode 100644 index 1fa37640..00000000 --- a/example/flutter_example/test/routes/nonlinear_page/utils/precision_slider_test.dart +++ /dev/null @@ -1,79 +0,0 @@ -import 'package:equations_solver/routes/nonlinear_page/utils/precision_slider.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../nonlinear_mock.dart'; - -void main() { - group("Testing the 'PrecisionSlider' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: PrecisionSlider(), - ), - ); - - expect(find.byType(PrecisionSlider), findsOneWidget); - }); - - testWidgets( - 'Making sure that the slider has the exact initial position (at the ' - 'middle of the range values).', - (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: PrecisionSlider(), - ), - ); - - final finder = find.byType(Slider); - final slider = tester.firstWidget(finder) as Slider; - expect(slider.value, equals(6)); - - // State - expect(find.text('1.0e-6'), findsOneWidget); - expect(find.byType(Slider), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the slider can actually slide', - (tester) async { - await tester.pumpWidget( - const MockNonlinearWidget( - child: PrecisionSlider(), - ), - ); - - final finder = find.byType(Slider); - final slider = tester.firstWidget(finder) as Slider; - expect(slider.value, equals(6)); - - // State - expect(find.text('1.0e-6'), findsOneWidget); - expect(finder, findsOneWidget); - - // Moving the plot_zoom - await tester.drag(finder, const Offset(-20, 0)); - expect(find.text('1.0e-8'), findsNothing); - }, - ); - }); - - group('Golden tests - PrecisionSlider', () { - testWidgets('PrecisionSlider', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 200)); - - await tester.pumpWidget( - const MockNonlinearWidget( - child: PrecisionSlider(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/precision_slider.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/nonlinear_page_test.dart b/example/flutter_example/test/routes/nonlinear_page_test.dart deleted file mode 100644 index 468e8daa..00000000 --- a/example/flutter_example/test/routes/nonlinear_page_test.dart +++ /dev/null @@ -1,195 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/nonlinear_page.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_body.dart'; -import 'package:equations_solver/routes/nonlinear_page/nonlinear_results.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'mock_wrapper.dart'; -import 'nonlinear_page/nonlinear_mock.dart'; - -void main() { - group("Testing the 'NonlinearPage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: NonlinearPage(), - ), - ); - - expect(find.byType(NonlinearBody), findsOneWidget); - expect(find.byType(NonlinearPage), findsOneWidget); - }); - - testWidgets('Making sure that pages can be changed', (tester) async { - var bracketing = ''; - var singlePoint = ''; - - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - bracketing = context.l10n.bracketing; - singlePoint = context.l10n.single_point; - - return const NonlinearPage(); - }, - ), - ), - ); - - // Bracketing page - await tester.tap(find.text(bracketing)); - await tester.pumpAndSettle(); - expect(find.text(bracketing), findsNWidgets(2)); - expect(find.text(singlePoint), findsOneWidget); - - // Single point page - await tester.tap(find.text(singlePoint)); - await tester.pumpAndSettle(); - expect(find.text(singlePoint), findsNWidgets(2)); - expect(find.text(bracketing), findsOneWidget); - }); - }); - - group('Golden tests - NonlinearBody', () { - Future solveNonlinear( - WidgetTester tester, { - bool withError = false, - }) async { - final equationInput = find.byKey(const Key('EquationInput-function')); - final paramInput = find.byKey(const Key('EquationInput-first-param')); - final solveButton = find.byKey(const Key('Nonlinear-button-solve')); - - // Filling the forms - await tester.enterText(equationInput, 'x-3'); - - if (withError) { - await tester.enterText(paramInput, '0'); - } else { - await tester.enterText(paramInput, '3'); - } - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - await tester.ensureVisible(find.byType(NonlinearResults).last); - await tester.pumpAndSettle(); - } - - testWidgets('NonlinearBody - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1400)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/nonlinear_body_small_screen.png'), - ); - }); - - testWidgets('NonlinearBody - large screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(1200, 900)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/nonlinear_body_large_screen.png'), - ); - }); - - testWidgets('NonlinearBody - small screen with data', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1500)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await solveNonlinear(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/nonlinear_body_small_screen_with_data.png'), - ); - }); - - testWidgets('NonlinearBody - large screen with data', (tester) async { - await tester.binding.setSurfaceSize(const Size(1300, 1100)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await solveNonlinear(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/nonlinear_body_large_screen_with_data.png'), - ); - }); - - testWidgets('NonlinearBody - small screen with error', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1500)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await solveNonlinear(tester, withError: true); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/nonlinear_body_small_screen_with_error.png'), - ); - }); - - testWidgets('NonlinearBody - large screen with error', (tester) async { - await tester.binding.setSurfaceSize(const Size(1300, 1100)); - - await tester.pumpWidget( - MockNonlinearWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await solveNonlinear(tester, withError: true); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/nonlinear_body_large_screen_with_error.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/complex_analyzer_input_test.dart b/example/flutter_example/test/routes/other_page/complex_numbers/complex_analyzer_input_test.dart deleted file mode 100644 index 5042553a..00000000 --- a/example/flutter_example/test/routes/other_page/complex_numbers/complex_analyzer_input_test.dart +++ /dev/null @@ -1,116 +0,0 @@ -import 'package:equations_solver/routes/other_page/complex_numbers/complex_analyzer_input.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../complex_numbers_mock.dart'; - -void main() { - group("Testing the 'ComplexAnalyzerInput' widget", () { - testWidgets('Making sure that the widget renders', (tester) async { - await tester.pumpWidget( - const MockComplexNumbers( - child: ComplexAnalyzerInput(), - ), - ); - - expect(find.byType(ComplexAnalyzerInput), findsOneWidget); - expect(find.byType(ComplexNumberInput), findsOneWidget); - expect(find.byType(Form), findsOneWidget); - }); - - testWidgets( - 'Making sure that when trying to evaluate a complex number, if at least ' - 'one of the inputs is wrong, a snackbar appears', - (tester) async { - await tester.pumpWidget( - const MockComplexNumbers( - child: ComplexAnalyzerInput(), - ), - ); - - // Entering some text - const realKey = Key('ComplexNumberInput-TextFormField-RealPart'); - const imagKey = Key('ComplexNumberInput-TextFormField-ImaginaryPart'); - - await tester.enterText(find.byKey(realKey), '-1/2'); - await tester.enterText(find.byKey(imagKey), '..'); - await tester.tap( - find.byKey(const Key('ComplexAnalyze-button-analyze')), - ); - await tester.pumpAndSettle(); - - // Making sure that we can see the entered text and the snackbar - expect(find.text('-1/2'), findsOneWidget); - expect(find.byType(SnackBar), findsOneWidget); - - // Clearing - await tester.tap(find.byKey(const Key('ComplexAnalyze-button-clean'))); - await tester.pumpAndSettle(); - - expect(find.text('-1/2'), findsNothing); - }, - ); - - testWidgets( - 'Making sure that complex numbers can be analyzed', - (tester) async { - await tester.pumpWidget( - const MockComplexNumbers( - child: ComplexAnalyzerInput(), - ), - ); - - // Entering some text - const realKey = Key('ComplexNumberInput-TextFormField-RealPart'); - const imagKey = Key('ComplexNumberInput-TextFormField-ImaginaryPart'); - - await tester.enterText(find.byKey(realKey), '-1/2'); - await tester.enterText(find.byKey(imagKey), '5'); - - await tester.tap( - find.byKey(const Key('ComplexAnalyze-button-analyze')), - ); - await tester.pumpAndSettle(); - - expect(find.text('-1/2'), findsOneWidget); - expect(find.text('5'), findsOneWidget); - - // Cleaning - final finder = find.byKey(const Key('ComplexAnalyze-button-clean')); - await tester.tap(finder); - await tester.pumpAndSettle(); - - expect(find.text('-1/2'), findsNothing); - expect(find.text('5'), findsNothing); - - tester.widgetList(find.byType(TextFormField)).forEach( - (textController) { - expect(textController.controller!.text.length, isZero); - }, - ); - }, - ); - }); - - group('Golden tests - ComplexAnalyzerInput', () { - testWidgets('ComplexAnalyzerInput', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 200)); - - await tester.pumpWidget( - MockComplexNumbers( - controllers: [ - TextEditingController(text: '2'), - TextEditingController(text: '-1'), - ], - child: const ComplexAnalyzerInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/complex_analyze_input.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/complex_analyzer_result_test.dart b/example/flutter_example/test/routes/other_page/complex_numbers/complex_analyzer_result_test.dart deleted file mode 100644 index d8728175..00000000 --- a/example/flutter_example/test/routes/other_page/complex_numbers/complex_analyzer_result_test.dart +++ /dev/null @@ -1,71 +0,0 @@ -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_analyzer_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../complex_numbers_mock.dart'; - -void main() { - group("Testing the 'ComplexNumberAnalyzerResult' widget", () { - testWidgets('Making sure that the widget renders', (tester) async { - await tester.pumpWidget( - const MockComplexNumbers( - child: ComplexNumberAnalyzerResult(), - ), - ); - - expect(find.byType(ComplexNumberAnalyzerResult), findsOneWidget); - expect(find.byType(RealResultCard), findsNothing); - }); - - testWidgets('Making sure that the widget is responsive', (tester) async { - await tester.binding.setSurfaceSize(const Size(2000, 2000)); - - await tester.pumpWidget( - const MockComplexNumbers( - complexMockData: true, - ), - ); - - expect( - find.byType(Wrap), - findsOneWidget, - ); - }); - - testWidgets( - 'Making sure that analysis results can correctly be displayed', - (tester) async { - await tester.pumpWidget( - const MockComplexNumbers( - complexMockData: true, - child: ComplexNumberAnalyzerResult(), - ), - ); - - expect(find.byType(CircularProgressIndicator), findsNothing); - expect(find.byType(RealResultCard), findsNWidgets(5)); - expect(find.byType(ComplexResultCard), findsNWidgets(3)); - }, - ); - }); - - group('Golden tests - MockComplexNumbers', () { - testWidgets('MockComplexNumbers', (tester) async { - await tester.binding.setSurfaceSize(const Size(800, 800)); - - await tester.pumpWidget( - const MockComplexNumbers( - complexMockData: true, - child: ComplexNumberAnalyzerResult(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/complex_output_results.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/complex_number_input_test.dart b/example/flutter_example/test/routes/other_page/complex_numbers/complex_number_input_test.dart deleted file mode 100644 index 4add1d11..00000000 --- a/example/flutter_example/test/routes/other_page/complex_numbers/complex_number_input_test.dart +++ /dev/null @@ -1,61 +0,0 @@ -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'ComplexNumberInput' widget", () { - testWidgets('Making sure that the widget renders', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: ComplexNumberInput( - realController: TextEditingController(), - imaginaryController: TextEditingController(), - ), - ), - ); - - expect(find.byType(ComplexNumberInput), findsOneWidget); - expect(find.byType(TextFormField), findsNWidgets(2)); - expect(find.text('i'), findsOneWidget); - expect(find.text('+'), findsOneWidget); - }); - }); - - group('Golden tests - ComplexNumberInput', () { - testWidgets('ComplexNumberInput - no values', (tester) async { - await tester.binding.setSurfaceSize(const Size(200, 80)); - - await tester.pumpWidget( - MockWrapper( - child: ComplexNumberInput( - realController: TextEditingController(), - imaginaryController: TextEditingController(), - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/complex_input_novalues.png'), - ); - }); - - testWidgets('ComplexNumberInput - values', (tester) async { - await tester.binding.setSurfaceSize(const Size(200, 80)); - - await tester.pumpWidget( - MockWrapper( - child: ComplexNumberInput( - realController: TextEditingController(text: '3'), - imaginaryController: TextEditingController(text: '1'), - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/complex_input_values.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_analyze_input.png b/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_analyze_input.png deleted file mode 100644 index 843be3f2..00000000 Binary files a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_analyze_input.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_input_novalues.png b/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_input_novalues.png deleted file mode 100644 index 00a63458..00000000 Binary files a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_input_novalues.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_input_values.png b/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_input_values.png deleted file mode 100644 index 0ab0c6c5..00000000 Binary files a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_input_values.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_output_results.png b/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_output_results.png deleted file mode 100644 index 3a08bd5f..00000000 Binary files a/example/flutter_example/test/routes/other_page/complex_numbers/goldens/complex_output_results.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/complex_numbers_body_test.dart b/example/flutter_example/test/routes/other_page/complex_numbers_body_test.dart deleted file mode 100644 index 1193edb1..00000000 --- a/example/flutter_example/test/routes/other_page/complex_numbers_body_test.dart +++ /dev/null @@ -1,22 +0,0 @@ -import 'package:equations_solver/routes/other_page/complex_numbers/complex_analyzer_input.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers/complex_number_analyzer_results.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers_body.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'complex_numbers_mock.dart'; - -void main() { - group("Testing the 'ComplexNumberOtherBody' widget", () { - testWidgets('Making sure that the widget renders', (tester) async { - await tester.pumpWidget( - const MockComplexNumbers(), - ); - - expect(find.byType(ComplexNumberOtherBody), findsOneWidget); - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(ComplexAnalyzerInput), findsOneWidget); - expect(find.byType(ComplexNumberAnalyzerResult), findsOneWidget); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/complex_numbers_mock.dart b/example/flutter_example/test/routes/other_page/complex_numbers_mock.dart deleted file mode 100644 index e650d792..00000000 --- a/example/flutter_example/test/routes/other_page/complex_numbers_mock.dart +++ /dev/null @@ -1,51 +0,0 @@ -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers_body.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:flutter/material.dart'; - -import '../mock_wrapper.dart'; - -class MockComplexNumbers extends StatelessWidget { - /// The [TextEditingController]s for the inputs. - final List? controllers; - - /// Whether initializing the state with mock data - final bool complexMockData; - - /// The child. - final Widget child; - - /// Creates a [MockComplexNumbers] widget. - const MockComplexNumbers({ - super.key, - this.controllers, - this.complexMockData = false, - this.child = const ComplexNumberOtherBody(), - }); - - @override - Widget build(BuildContext context) { - final state = OtherState(); - - if (complexMockData) { - state.complexAnalyze(realPart: '-3', imaginaryPart: '5'); - } - - final actualControllers = controllers ?? - [ - TextEditingController(), - TextEditingController(), - ]; - - return MockWrapper( - child: InheritedOther( - otherState: state, - child: InheritedTextControllers( - textControllers: actualControllers, - child: child, - ), - ), - ); - } -} diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_1x1.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_1x1.png deleted file mode 100644 index e0196dbb..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_1x1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_2x2.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_2x2.png deleted file mode 100644 index 34595b63..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_2x2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_3x3.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_3x3.png deleted file mode 100644 index b8a99eea..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_3x3.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_4x4.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_4x4.png deleted file mode 100644 index 9da7ebaf..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_input_4x4.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_results.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_results.png deleted file mode 100644 index 8a49b688..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_results.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_results_onecolumn.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_results_onecolumn.png deleted file mode 100644 index cf59b4a3..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_analyze_results_onecolumn.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_1x1.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_1x1.png deleted file mode 100644 index d633c9ea..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_1x1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_2x2.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_2x2.png deleted file mode 100644 index 3c8b110e..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_2x2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_2x2_nodecimals.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_2x2_nodecimals.png deleted file mode 100644 index eeaa19cd..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_2x2_nodecimals.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_3x3.png b/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_3x3.png deleted file mode 100644 index cf8c3b22..00000000 Binary files a/example/flutter_example/test/routes/other_page/matrix/goldens/matrix_output_3x3.png and /dev/null differ diff --git a/example/flutter_example/test/routes/other_page/matrix/matrix_analyze_input_test.dart b/example/flutter_example/test/routes/other_page/matrix/matrix_analyze_input_test.dart deleted file mode 100644 index bb3964a5..00000000 --- a/example/flutter_example/test/routes/other_page/matrix/matrix_analyze_input_test.dart +++ /dev/null @@ -1,186 +0,0 @@ -import 'package:equations_solver/routes/other_page/matrix/matrix_analyzer_input.dart'; -import 'package:equations_solver/routes/system_page/utils/matrix_input.dart'; -import 'package:equations_solver/routes/system_page/utils/size_picker.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../matrix_mock.dart'; - -void main() { - List generateControllers() { - return List.generate( - 25, - (index) => TextEditingController(text: '$index'), - growable: false, - ); - } - - group("Testing the 'MatrixAnalyzerInput' widget", () { - testWidgets( - 'Making sure that matrices can be analyzed', - (tester) async { - await tester.pumpWidget( - MockMatrixOther( - controllers: [ - TextEditingController(), - ], - child: const MatrixAnalyzerInput(), - ), - ); - - expect(find.byType(SizePicker), findsOneWidget); - expect(find.byType(MatrixInput), findsOneWidget); - expect(find.byType(Form), findsOneWidget); - - // Matrix input - await tester.enterText(find.byType(TextFormField), '1'); - await tester.tap(find.byKey(const Key('MatrixAnalyze-button-analyze'))); - await tester.pumpAndSettle(); - - expect(find.byType(SnackBar), findsNothing); - expect(find.text('1'), findsOneWidget); - - // Cleaning - final finder = find.byKey(const Key('MatrixAnalyze-button-clean')); - await tester.tap(finder); - await tester.pumpAndSettle(); - - expect(find.text('1'), findsNothing); - - tester.widgetList(find.byType(TextFormField)).forEach( - (textController) { - expect(textController.controller!.text.length, isZero); - }, - ); - }, - ); - - testWidgets( - 'Making sure that when trying to evaluate a matrix, if at least one of ' - 'the inputs is wrong, a snackbar appears', - (tester) async { - await tester.pumpWidget( - MockMatrixOther( - controllers: [ - TextEditingController(), - ], - child: const MatrixAnalyzerInput(), - ), - ); - - expect(find.byType(SizePicker), findsOneWidget); - expect(find.byType(MatrixInput), findsOneWidget); - expect(find.byType(Form), findsOneWidget); - - // Wrong input check - await tester.tap(find.byKey(const Key('MatrixAnalyze-button-analyze'))); - await tester.pumpAndSettle(); - - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the form can be cleared correctly', - (tester) async { - await tester.pumpWidget( - MockMatrixOther( - min: 2, - controllers: generateControllers(), - child: const MatrixAnalyzerInput(), - ), - ); - - expect(find.byType(SizePicker), findsOneWidget); - expect(find.byType(MatrixInput), findsOneWidget); - - // Expecting to find some mock data - expect(find.text('0'), findsOneWidget); - expect(find.text('1'), findsOneWidget); - expect(find.text('2'), findsOneWidget); - expect(find.text('3'), findsOneWidget); - - // Now clearing - await tester.tap(find.byKey(const Key('MatrixAnalyze-button-clean'))); - await tester.pumpAndSettle(); - - expect(find.text('0'), findsNothing); - expect(find.text('1'), findsNothing); - expect(find.text('2'), findsNothing); - expect(find.text('3'), findsNothing); - - tester.widgetList(find.byType(TextFormField)).forEach( - (textFormField) { - expect(textFormField.controller!.text.length, isZero); - }, - ); - }, - ); - }); - - group('Golden tests - MatrixAnalyzerInput', () { - testWidgets('MatrixAnalyzerInput - 1x1', (tester) async { - await tester.binding.setSurfaceSize(const Size(450, 350)); - - await tester.pumpWidget( - MockMatrixOther( - controllers: generateControllers(), - child: const MatrixAnalyzerInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_analyze_input_1x1.png'), - ); - }); - - testWidgets('MatrixAnalyzerInput - 2x2', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 370)); - - await tester.pumpWidget( - MockMatrixOther( - min: 2, - controllers: generateControllers(), - child: const MatrixAnalyzerInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_analyze_input_2x2.png'), - ); - }); - - testWidgets('MatrixAnalyzerInput - 3x3', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 450)); - - await tester.pumpWidget( - MockMatrixOther( - min: 3, - controllers: generateControllers(), - child: const MatrixAnalyzerInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_analyze_input_3x3.png'), - ); - }); - - testWidgets('MatrixAnalyzerInput - 4x4', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 500)); - - await tester.pumpWidget( - MockMatrixOther( - min: 4, - controllers: generateControllers(), - child: const MatrixAnalyzerInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_analyze_input_4x4.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/matrix/matrix_analyze_results_test.dart b/example/flutter_example/test/routes/other_page/matrix/matrix_analyze_results_test.dart deleted file mode 100644 index ac7906c2..00000000 --- a/example/flutter_example/test/routes/other_page/matrix/matrix_analyze_results_test.dart +++ /dev/null @@ -1,103 +0,0 @@ -import 'package:equations_solver/routes/other_page/matrix/matrix_analyze_results.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_output.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../matrix_mock.dart'; - -void main() { - group("Testing the 'MatrixOtherBody' widget", () { - testWidgets( - 'Making sure that the widget renders nothing when there are no ' - 'analysis results', - (tester) async { - await tester.pumpWidget( - const MockMatrixOther( - child: MatrixAnalyzerResults(), - ), - ); - - expect(find.byType(RealResultCard), findsNothing); - }, - ); - - testWidgets('Making sure that the widget is responsive', (tester) async { - await tester.binding.setSurfaceSize(const Size(2000, 2000)); - - await tester.pumpWidget( - const MockMatrixOther( - matrixMockData: true, - child: MatrixAnalyzerResults(), - ), - ); - - expect( - find.byType(Wrap), - findsOneWidget, - ); - }); - - testWidgets( - 'Making sure that the widget correctly shows the results', - (tester) async { - await tester.pumpWidget( - const MockMatrixOther( - matrixMockData: true, - child: MatrixAnalyzerResults(), - ), - ); - - expect(find.byType(NoResults), findsNothing); - expect(find.byType(CircularProgressIndicator), findsNothing); - expect(find.byType(RealResultCard), findsNWidgets(3)); - expect(find.byType(ComplexResultCard), findsNWidgets(5)); - expect(find.byType(MatrixOutput), findsNWidgets(3)); - }, - ); - }); - - group('Golden tests - MatrixAnalyzerResults', () { - testWidgets('MatrixAnalyzerResults - results', (tester) async { - await tester.binding.setSurfaceSize(const Size(400, 1400)); - - await tester.pumpWidget( - const MockMatrixOther( - matrixMockData: true, - child: SizedBox( - width: 900, - child: SingleChildScrollView( - child: MatrixAnalyzerResults(), - ), - ), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_analyze_results_onecolumn.png'), - ); - }); - - testWidgets('MatrixAnalyzerResults - results', (tester) async { - await tester.binding.setSurfaceSize(const Size(1200, 800)); - - await tester.pumpWidget( - const MockMatrixOther( - matrixMockData: true, - child: SingleChildScrollView( - child: MatrixAnalyzerResults(), - ), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_analyze_results.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/matrix/matrix_output_test.dart b/example/flutter_example/test/routes/other_page/matrix/matrix_output_test.dart deleted file mode 100644 index 72debbd6..00000000 --- a/example/flutter_example/test/routes/other_page/matrix/matrix_output_test.dart +++ /dev/null @@ -1,169 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_output.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../matrix_mock.dart'; - -void main() { - group("Testing the 'MatrixOutput' widget", () { - testWidgets( - 'Making sure that the widget renders ', - (tester) async { - await tester.pumpWidget( - MockMatrixOther( - child: MatrixOutput( - matrix: RealMatrix.diagonal( - rows: 2, - columns: 2, - diagonalValue: 3, - ), - description: 'Demo', - ), - ), - ); - - expect(find.byType(MatrixOutput), findsOneWidget); - expect(find.text('Demo'), findsOneWidget); - expect(find.byType(Table), findsOneWidget); - expect(find.byType(TextFormField), findsNWidgets(4)); - }, - ); - - testWidgets( - "Making sure that 'didUpdateWidget' is executed", - (tester) async { - var matrixSize = 2; - - await tester.pumpWidget( - MockMatrixOther( - child: StatefulBuilder( - builder: (context, setState) { - return Column( - mainAxisSize: MainAxisSize.min, - children: [ - MatrixOutput( - matrix: RealMatrix.diagonal( - rows: matrixSize, - columns: matrixSize, - diagonalValue: 3, - ), - description: 'Demo', - ), - ElevatedButton( - onPressed: () { - setState(() { - matrixSize = matrixSize == 2 ? 3 : 2; - }); - }, - child: const Text('Rebuild'), - ), - ], - ); - }, - ), - ), - ); - - expect(find.byType(TextFormField), findsNWidgets(4)); - - await tester.tap(find.byType(ElevatedButton)); - await tester.pumpAndSettle(); - - expect(find.byType(TextFormField), findsNWidgets(9)); - }, - ); - }); - - group('Golden tests - MatrixOutput', () { - testWidgets('MatrixOutput - 1x1', (tester) async { - await tester.binding.setSurfaceSize(const Size(80, 90)); - - await tester.pumpWidget( - MockMatrixOther( - child: MatrixOutput( - matrix: RealMatrix.diagonal( - rows: 1, - columns: 1, - diagonalValue: 3, - ), - description: '1x1', - ), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_output_1x1.png'), - ); - }); - - testWidgets('MatrixOutput - 2x2', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 150)); - - await tester.pumpWidget( - MockMatrixOther( - child: MatrixOutput( - matrix: RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [1.01, 2.456, 3.0254, -4.2], - ), - description: '2x2', - ), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_output_2x2.png'), - ); - }); - - testWidgets('MatrixOutput - 2x2 no decimals', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 150)); - - await tester.pumpWidget( - MockMatrixOther( - child: MatrixOutput( - matrix: RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [1.01, 2.456, 3.0254, -4.2], - ), - description: '2x2', - decimalDigits: 0, - ), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_output_2x2_nodecimals.png'), - ); - }); - - testWidgets('MatrixOutput - 3x3', (tester) async { - await tester.binding.setSurfaceSize(const Size(230, 230)); - - await tester.pumpWidget( - MockMatrixOther( - child: MatrixOutput( - matrix: RealMatrix.fromFlattenedData( - rows: 3, - columns: 3, - data: [6, -7, 3, 5, -6, 0, -1, 2, 8], - ), - description: '3x3', - ), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/matrix_output_3x3.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/matrix_body_test.dart b/example/flutter_example/test/routes/other_page/matrix_body_test.dart deleted file mode 100644 index 0aa048f7..00000000 --- a/example/flutter_example/test/routes/other_page/matrix_body_test.dart +++ /dev/null @@ -1,22 +0,0 @@ -import 'package:equations_solver/routes/other_page/matrix/matrix_analyze_results.dart'; -import 'package:equations_solver/routes/other_page/matrix/matrix_analyzer_input.dart'; -import 'package:equations_solver/routes/other_page/matrix_body.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'matrix_mock.dart'; - -void main() { - group("Testing the 'MatrixOtherBody' widget", () { - testWidgets('Making sure that the widget renders', (tester) async { - await tester.pumpWidget( - const MockMatrixOther(), - ); - - expect(find.byType(MatrixOtherBody), findsOneWidget); - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(MatrixAnalyzerInput), findsOneWidget); - expect(find.byType(MatrixAnalyzerResults), findsOneWidget); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/matrix_mock.dart b/example/flutter_example/test/routes/other_page/matrix_mock.dart deleted file mode 100644 index a8c28e0c..00000000 --- a/example/flutter_example/test/routes/other_page/matrix_mock.dart +++ /dev/null @@ -1,115 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/matrix_body.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:flutter/material.dart'; - -import '../mock_wrapper.dart'; - -class MockMatrixOther extends StatelessWidget { - /// Returns a pre-built [MatrixResultWrapper] object. - static MatrixResultWrapper mockMatrixResult() { - return MatrixResultWrapper( - eigenvalues: const [ - Complex.fromReal(5.37288), - Complex.fromReal(-0.372281), - ], - rank: 2, - determinant: -2, - trace: 5, - inverse: RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [ - -2, - 1, - 1.5, - -0.5, - ], - ), - cofactorMatrix: RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [ - 4, - -3, - -2, - 1, - ], - ), - transpose: RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [ - 1, - 3, - 2, - 4, - ], - ), - characteristicPolynomial: Algebraic.fromReal([1, -5, -2]), - isIdentity: true, - isDiagonal: true, - isSymmetric: false, - ); - } - - /// The [TextEditingController]s for the inputs. - final List? controllers; - - /// The minimum value of the [NumberSwitcherState]. - final int min; - - /// Whether initializing the state with mock data - final bool matrixMockData; - - /// The child. - final Widget child; - - /// Creates a [MockMatrixOther] widget. - const MockMatrixOther({ - super.key, - this.min = 1, - this.matrixMockData = false, - this.child = const MatrixOtherBody(), - this.controllers, - }); - - @override - Widget build(BuildContext context) { - final state = OtherState(); - - if (matrixMockData) { - state.matrixAnalyze( - matrix: const ['-2', '5', '1', '3'], - size: 2, - ); - } - - final actualControllers = controllers ?? - [ - TextEditingController(), - TextEditingController(), - ]; - - return MockWrapper( - child: InheritedOther( - otherState: state, - child: InheritedTextControllers( - textControllers: actualControllers, - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: min, - max: 4, - ), - child: child, - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/test/routes/other_page/model/inherited_other_test.dart b/example/flutter_example/test/routes/other_page/model/inherited_other_test.dart deleted file mode 100644 index 8b0c7361..00000000 --- a/example/flutter_example/test/routes/other_page/model/inherited_other_test.dart +++ /dev/null @@ -1,54 +0,0 @@ -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedNonlinear' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final inheritedOther = InheritedOther( - otherState: OtherState(), - child: const SizedBox.shrink(), - ); - - expect( - inheritedOther.updateShouldNotify(inheritedOther), - isFalse, - ); - expect( - inheritedOther.updateShouldNotify( - InheritedOther( - otherState: OtherState(), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late OtherState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedOther( - otherState: OtherState(), - child: Builder( - builder: (context) { - reference = InheritedOther.of(context).otherState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.state.results, isNull); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/other_page/model/other_result_test.dart b/example/flutter_example/test/routes/other_page/model/other_result_test.dart deleted file mode 100644 index ea235181..00000000 --- a/example/flutter_example/test/routes/other_page/model/other_result_test.dart +++ /dev/null @@ -1,159 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/other_result.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'OtherResult' class", () { - test('Initial values', () { - const otherResult = OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ); - - expect(otherResult.results, isA()); - }); - - test('Making sure that objects can be properly compared', () { - const otherResult = OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ); - - expect( - otherResult, - equals( - const OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ), - ), - ); - - expect( - const OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ), - otherResult, - ); - - expect( - otherResult == - const OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ), - isTrue, - ); - - expect( - const OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ) == - otherResult, - isTrue, - ); - - expect( - const OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 2, - ), - ) == - otherResult, - isFalse, - ); - - expect( - otherResult.hashCode, - equals( - const OtherResult( - results: ComplexResultWrapper( - polarComplex: PolarComplex( - r: 1, - phiRadians: 1, - phiDegrees: 1, - ), - conjugate: Complex.zero(), - reciprocal: Complex.zero(), - abs: 1, - sqrt: Complex.zero(), - phase: 1, - ), - ).hashCode, - ), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page/model/other_state_test.dart b/example/flutter_example/test/routes/other_page/model/other_state_test.dart deleted file mode 100644 index fffe6412..00000000 --- a/example/flutter_example/test/routes/other_page/model/other_state_test.dart +++ /dev/null @@ -1,59 +0,0 @@ -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/complex_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/analyzer/wrappers/matrix_result_wrapper.dart'; -import 'package:equations_solver/routes/other_page/model/other_result.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NonlinearState' class", () { - test('Initial values', () { - final otherState = OtherState(); - - expect(otherState.state, equals(const OtherResult())); - }); - - test('Making sure that matrices can be analyzed and cleared', () { - var count = 0; - final otherState = OtherState()..addListener(() => ++count); - expect(otherState.state, equals(const OtherResult())); - - otherState.matrixAnalyze(matrix: ['1'], size: 1); - expect(otherState.state.results, isA()); - expect(count, equals(1)); - - otherState.clear(); - - expect(otherState.state, equals(const OtherResult())); - expect(count, equals(2)); - }); - - test('Making sure that complex numbers can be analyzed and cleared', () { - var count = 0; - final otherState = OtherState()..addListener(() => ++count); - expect(otherState.state, equals(const OtherResult())); - - otherState.complexAnalyze(realPart: '1', imaginaryPart: '2'); - expect(otherState.state.results, isA()); - expect(count, equals(1)); - - otherState.clear(); - - expect(otherState.state, equals(const OtherResult())); - expect(count, equals(2)); - }); - - test('Making sure that exceptions are handled', () { - var count = 0; - final otherState = OtherState()..addListener(() => ++count); - expect(otherState.state, equals(const OtherResult())); - - otherState.matrixAnalyze(matrix: [''], size: 1); - expect(otherState.state.results, isNull); - expect(count, equals(1)); - - otherState.complexAnalyze(realPart: '1', imaginaryPart: ''); - expect(otherState.state.results, isNull); - expect(count, equals(2)); - }); - }); -} diff --git a/example/flutter_example/test/routes/other_page_test.dart b/example/flutter_example/test/routes/other_page_test.dart deleted file mode 100644 index 3d52d34b..00000000 --- a/example/flutter_example/test/routes/other_page_test.dart +++ /dev/null @@ -1,206 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/other_page.dart'; -import 'package:equations_solver/routes/other_page/complex_numbers_body.dart'; -import 'package:equations_solver/routes/other_page/matrix_body.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_result.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'mock_wrapper.dart'; - -void main() { - group("Testing the 'OtherPage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - expect(find.byType(EquationScaffold), findsOneWidget); - expect(find.byType(MatrixOtherBody), findsOneWidget); - expect(find.byType(ComplexNumberOtherBody), findsNothing); - }); - - testWidgets( - 'Making sure that changing size clears everything', - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - final stateFinder = find.byType(InheritedOther); - - // Analyzing the matrix - await tester.enterText(find.byType(TextFormField), '1'); - await tester.tap(find.byKey(const Key('MatrixAnalyze-button-analyze'))); - await tester.pumpAndSettle(); - - expect(find.byType(SnackBar), findsNothing); - expect(find.text('1'), findsOneWidget); - expect( - tester.widget(stateFinder).otherState.state, - isNot(const OtherResult()), - ); - tester.widgetList(find.byType(TextFormField)).forEach( - (textController) { - expect(textController.controller!.text, isNotEmpty); - }, - ); - - // Changing size - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pumpAndSettle(); - - // No more inputs - expect(find.text('1'), findsNothing); - - tester.widgetList(find.byType(TextFormField)).forEach( - (textController) { - expect(textController.controller!.text.length, isZero); - }, - ); - expect( - tester.widget(stateFinder).otherState.state, - equals(const OtherResult()), - ); - }, - ); - }); - - group('Golden tests - IntegralBody', () { - Future analyzeMatrix(WidgetTester tester) async { - await tester.enterText(find.byType(TextFormField), '1'); - await tester.pumpAndSettle(); - - // Analyzing the matrix - await tester.tap(find.byKey(const Key('MatrixAnalyze-button-analyze'))); - await tester.pumpAndSettle(); - } - - Future analyzeComplexNumber(WidgetTester tester) async { - tester - .widget( - find.byType(InheritedNavigation), - ) - .navigationIndex - .value = 1; - - await tester.pumpAndSettle(); - - await tester.enterText( - find.byKey( - const Key('ComplexNumberInput-TextFormField-RealPart'), - ), - '1', - ); - await tester.enterText( - find.byKey( - const Key('ComplexNumberInput-TextFormField-ImaginaryPart'), - ), - '2', - ); - await tester.pumpAndSettle(); - - // Analyzing the matrix - await tester.tap(find.byKey(const Key('ComplexAnalyze-button-analyze'))); - await tester.pumpAndSettle(); - } - - testWidgets('OtherPage - matrix - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 1500)); - - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - await analyzeMatrix(tester); - - await expectLater( - find.byType(MatrixOtherBody), - matchesGoldenFile('goldens/other_body_matrix_small_screen_part1.png'), - ); - }); - - testWidgets('OtherPage - matrix - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 900)); - - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - await analyzeMatrix(tester); - - await tester.dragUntilVisible( - find.byKey(const Key('MatrixAnalyzerResults-cofactor-matrix')), - find.byType(ListView), - const Offset(0, 500), - ); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(MatrixOtherBody), - matchesGoldenFile('goldens/other_body_matrix_small_screen_part2.png'), - ); - }); - - testWidgets('OtherPage - matrix - large screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(1500, 1150)); - - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - await analyzeMatrix(tester); - - await expectLater( - find.byType(MatrixOtherBody), - matchesGoldenFile('goldens/other_body_matrix_large_screen.png'), - ); - }); - - testWidgets('OtherPage - complex - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1450)); - - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - await analyzeComplexNumber(tester); - - await expectLater( - find.byType(ComplexNumberOtherBody), - matchesGoldenFile('goldens/other_body_complex_small_screen.png'), - ); - }); - - testWidgets('OtherPage - complex - large screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(1100, 1000)); - - await tester.pumpWidget( - const MockWrapper( - child: OtherPage(), - ), - ); - - await analyzeComplexNumber(tester); - - await expectLater( - find.byType(ComplexNumberOtherBody), - matchesGoldenFile('goldens/other_body_complex_large_screen.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_cubic.png b/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_cubic.png deleted file mode 100644 index 851a6dd2..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_cubic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_linear.png b/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_linear.png deleted file mode 100644 index b063bea9..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_linear.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_quadratic.png b/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_quadratic.png deleted file mode 100644 index 81451529..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_quadratic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_quartic.png b/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_quartic.png deleted file mode 100644 index 4fb73d69..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_data_input_quartic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_input_field.png b/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_input_field.png deleted file mode 100644 index 8423be94..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_input_field.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_results.png b/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_results.png deleted file mode 100644 index e92b375e..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/goldens/polynomial_results.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/model/inherited_polynomial_test.dart b/example/flutter_example/test/routes/polynomial_page/model/inherited_polynomial_test.dart deleted file mode 100644 index 856a54c5..00000000 --- a/example/flutter_example/test/routes/polynomial_page/model/inherited_polynomial_test.dart +++ /dev/null @@ -1,64 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedPolynomial' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final inheritedPolynomial = InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear), - child: const SizedBox.shrink(), - ); - - expect( - inheritedPolynomial.updateShouldNotify(inheritedPolynomial), - isFalse, - ); - expect( - inheritedPolynomial.updateShouldNotify( - InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedPolynomial.updateShouldNotify( - InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.quadratic), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late PolynomialState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear), - child: Builder( - builder: (context) { - reference = InheritedPolynomial.of(context).polynomialState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.polynomialType, equals(PolynomialType.linear)); - expect(reference.state.algebraic, isNull); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/model/polynomial_result_test.dart b/example/flutter_example/test/routes/polynomial_page/model/polynomial_result_test.dart deleted file mode 100644 index ed09b092..00000000 --- a/example/flutter_example/test/routes/polynomial_page/model/polynomial_result_test.dart +++ /dev/null @@ -1,86 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_result.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'PolynomialResult' class", () { - test('Initial values', () { - final polynomialResult = PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ); - - expect(polynomialResult.algebraic, isA()); - }); - - test('Making sure that objects can be properly compared', () { - final polynomialResult = PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ); - - expect( - polynomialResult, - equals( - PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ), - ), - ); - - expect( - PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ), - polynomialResult, - ); - - expect( - polynomialResult == - PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ), - isTrue, - ); - - expect( - PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ) == - polynomialResult, - isTrue, - ); - - expect( - PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, -2], - ), - ) == - polynomialResult, - isFalse, - ); - - expect( - polynomialResult.hashCode, - equals( - PolynomialResult( - algebraic: Algebraic.fromReal( - const [1, 2], - ), - ).hashCode, - ), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/model/polynomial_state_test.dart b/example/flutter_example/test/routes/polynomial_page/model/polynomial_state_test.dart deleted file mode 100644 index d4b84f9d..00000000 --- a/example/flutter_example/test/routes/polynomial_page/model/polynomial_state_test.dart +++ /dev/null @@ -1,61 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/polynomial_result.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'PolynomialType' enum", () { - test('Properties values', () { - expect(PolynomialType.linear.coefficients, equals(2)); - expect(PolynomialType.quadratic.coefficients, equals(3)); - expect(PolynomialType.cubic.coefficients, equals(4)); - expect(PolynomialType.quartic.coefficients, equals(5)); - - expect(PolynomialType.values.length, equals(4)); - }); - }); - - group("Testing the 'PolynomialState' class", () { - test('Initial values', () { - final polynomialState = PolynomialState(PolynomialType.linear); - - expect(polynomialState.polynomialType, equals(PolynomialType.linear)); - expect(polynomialState.state, equals(const PolynomialResult())); - }); - - test('Making sure that equations can be solved and cleared', () { - var count = 0; - final polynomialState = PolynomialState(PolynomialType.linear) - ..addListener(() => ++count); - - expect(polynomialState.polynomialType, equals(PolynomialType.linear)); - expect(polynomialState.state, equals(const PolynomialResult())); - - polynomialState.solvePolynomial(const ['1', '2']); - - expect(polynomialState.polynomialType, equals(PolynomialType.linear)); - expect(polynomialState.state.algebraic, isNotNull); - expect(count, equals(1)); - - polynomialState.clear(); - - expect(polynomialState.polynomialType, equals(PolynomialType.linear)); - expect(polynomialState.state, equals(const PolynomialResult())); - expect(count, equals(2)); - }); - - test('Making sure that exceptions are handled', () { - var count = 0; - final polynomialState = PolynomialState(PolynomialType.linear) - ..addListener(() => ++count); - - expect(polynomialState.polynomialType, equals(PolynomialType.linear)); - expect(polynomialState.state, equals(const PolynomialResult())); - - polynomialState.solvePolynomial(const ['', '']); - - expect(polynomialState.polynomialType, equals(PolynomialType.linear)); - expect(polynomialState.state.algebraic, isNull); - expect(count, equals(1)); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/polynomial_body_test.dart b/example/flutter_example/test/routes/polynomial_page/polynomial_body_test.dart deleted file mode 100644 index 0307fe71..00000000 --- a/example/flutter_example/test/routes/polynomial_page/polynomial_body_test.dart +++ /dev/null @@ -1,311 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_data_input.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_results.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_plot_widget.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; -import 'polynomial_mock.dart'; - -void main() { - group("Testing the 'PolynomialBody' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(PolynomialDataInput), findsOneWidget); - expect(find.byType(PolynomialResults), findsOneWidget); - }); - - testWidgets( - 'Making sure that the widget is responsive - small screens ' - 'test', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect( - find.byKey(const Key('SingleChildScrollView-mobile-responsive')), - findsOneWidget, - ); - expect( - find.byKey(const Key('SingleChildScrollView-desktop-responsive')), - findsNothing, - ); - expect( - find.byType(PolynomialPlotWidget), - findsOneWidget, - ); - }, - ); - - testWidgets( - 'Making sure that the widget is responsive - large screens ' - 'test', - (tester) async { - await tester.binding.setSurfaceSize(const Size(2000, 2000)); - - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect( - find.byKey(const Key('SingleChildScrollView-mobile-responsive')), - findsNothing, - ); - expect( - find.byKey(const Key('SingleChildScrollView-desktop-responsive')), - findsOneWidget, - ); - }, - ); - - testWidgets('Making sure that solving linear eq. works', (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - final coeffA = - find.byKey(const Key('PolynomialInputField-coefficient-0')); - final coeffB = - find.byKey(const Key('PolynomialInputField-coefficient-1')); - final solveButton = find.byKey(const Key('Polynomial-button-solve')); - - // Filling the forms - await tester.enterText(coeffA, '-5'); - await tester.enterText(coeffB, '1/2'); - - // Making sure that there are no results - final inheritedWidget = tester.widget( - find.byType(InheritedPolynomial), - ); - expect(inheritedWidget.polynomialState.state.algebraic, isNull); - expect(find.byType(NoResults), findsOneWidget); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Solutions in the UI! - expect(inheritedWidget.polynomialState.state.algebraic, isNotNull); - expect(find.byType(NoResults), findsNothing); - expect(find.byKey(const Key('PolynomialDiscriminant')), findsOneWidget); - expect(find.byType(ComplexResultCard), findsNWidgets(2)); - }); - - testWidgets('Making sure that solving quadratic eq. works', (tester) async { - var quadraticTabName = ''; - - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - quadraticTabName = context.l10n.secondDegree; - - return MockPolynomialWidget( - polynomialType: PolynomialType.quadratic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ); - }, - ), - ), - ); - - // Moving to the second page - await tester.tap(find.text(quadraticTabName)); - await tester.pumpAndSettle(); - - // Data input - final coeffA = - find.byKey(const Key('PolynomialInputField-coefficient-0')); - final coeffB = - find.byKey(const Key('PolynomialInputField-coefficient-1')); - final coeffC = - find.byKey(const Key('PolynomialInputField-coefficient-2')); - final solveButton = find.byKey(const Key('Polynomial-button-solve')); - - // Filling the forms - await tester.enterText(coeffA, '-5'); - await tester.enterText(coeffB, '1/2'); - await tester.enterText(coeffC, '3'); - - // Making sure that there are no results - final inheritedWidget = tester.widget( - find.byType(InheritedPolynomial), - ); - expect(inheritedWidget.polynomialState.state.algebraic, isNull); - expect(find.byType(NoResults), findsOneWidget); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Solutions on the UI! - expect(inheritedWidget.polynomialState.state.algebraic, isNotNull); - expect(find.byType(NoResults), findsNothing); - expect(find.byKey(const Key('PolynomialDiscriminant')), findsOneWidget); - expect(find.byType(ComplexResultCard), findsNWidgets(3)); - }); - - testWidgets('Making sure that solving cubic eq. works', (tester) async { - var cubicTabName = ''; - - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - cubicTabName = context.l10n.thirdDegree; - - return MockPolynomialWidget( - polynomialType: PolynomialType.cubic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ); - }, - ), - ), - ); - - // Moving to the second page - await tester.tap(find.text(cubicTabName)); - await tester.pumpAndSettle(); - - // Data input - final coeffA = - find.byKey(const Key('PolynomialInputField-coefficient-0')); - final coeffB = - find.byKey(const Key('PolynomialInputField-coefficient-1')); - final coeffC = - find.byKey(const Key('PolynomialInputField-coefficient-2')); - final coeffD = - find.byKey(const Key('PolynomialInputField-coefficient-3')); - final solveButton = find.byKey(const Key('Polynomial-button-solve')); - - // Filling the forms - await tester.enterText(coeffA, '-5'); - await tester.enterText(coeffB, '1/2'); - await tester.enterText(coeffC, '0'); - await tester.enterText(coeffD, '1'); - - // Making sure that there are no results - final inheritedWidget = tester.widget( - find.byType(InheritedPolynomial), - ); - expect(inheritedWidget.polynomialState.state.algebraic, isNull); - expect(find.byType(NoResults), findsOneWidget); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Solutions on the UI! - expect(inheritedWidget.polynomialState.state.algebraic, isNotNull); - expect(find.byType(NoResults), findsNothing); - expect(find.byKey(const Key('PolynomialDiscriminant')), findsOneWidget); - expect(find.byType(ComplexResultCard), findsNWidgets(4)); - }); - - testWidgets('Making sure that solving quartic eq. works', (tester) async { - var quarticTabName = ''; - - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - quarticTabName = context.l10n.fourthDegree; - - return MockPolynomialWidget( - polynomialType: PolynomialType.quartic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ); - }, - ), - ), - ); - - // Moving to the second page - await tester.tap(find.text(quarticTabName)); - await tester.pumpAndSettle(); - - // Data input - final coeffA = - find.byKey(const Key('PolynomialInputField-coefficient-0')); - final coeffB = - find.byKey(const Key('PolynomialInputField-coefficient-1')); - final coeffC = - find.byKey(const Key('PolynomialInputField-coefficient-2')); - final coeffD = - find.byKey(const Key('PolynomialInputField-coefficient-3')); - final coeffE = - find.byKey(const Key('PolynomialInputField-coefficient-4')); - final solveButton = find.byKey(const Key('Polynomial-button-solve')); - - // Filling the forms - await tester.enterText(coeffA, '-5'); - await tester.enterText(coeffB, '1/2'); - await tester.enterText(coeffC, '0'); - await tester.enterText(coeffD, '1'); - await tester.enterText(coeffE, 'e'); - - // Making sure that there are no results - final inheritedWidget = tester.widget( - find.byType(InheritedPolynomial), - ); - expect(inheritedWidget.polynomialState.state.algebraic, isNull); - expect(find.byType(NoResults), findsOneWidget); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Solutions on the UI! - expect(inheritedWidget.polynomialState.state.algebraic, isNotNull); - expect(find.byType(NoResults), findsNothing); - expect(find.byKey(const Key('PolynomialDiscriminant')), findsOneWidget); - expect(find.byType(ComplexResultCard), findsNWidgets(5)); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/polynomial_data_input_test.dart b/example/flutter_example/test/routes/polynomial_page/polynomial_data_input_test.dart deleted file mode 100644 index 179b4705..00000000 --- a/example/flutter_example/test/routes/polynomial_page/polynomial_data_input_test.dart +++ /dev/null @@ -1,283 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_data_input.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_input_field.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; -import 'polynomial_mock.dart'; - -void main() { - group("Testing the 'PolynomialDataInput' widget", () { - testWidgets( - "Making sure that with a 'linear' configuration type only " - '2 input fields appear on the screen', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(PolynomialDataInput), findsOneWidget); - expect(find.byType(PolynomialInputField), findsNWidgets(2)); - - // To make sure that fields validation actually happens - expect(find.byType(Form), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that with a 'quadratic' configuration type only " - '3 input fields appear on the screen', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - polynomialType: PolynomialType.quadratic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(PolynomialDataInput), findsOneWidget); - expect(find.byType(PolynomialInputField), findsNWidgets(3)); - - // To make sure that fields validation actually happens - expect(find.byType(Form), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that with a 'cubic' configuration type only " - '4 input fields appear on the screen', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - polynomialType: PolynomialType.cubic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(PolynomialDataInput), findsOneWidget); - expect(find.byType(PolynomialInputField), findsNWidgets(4)); - - // To make sure that fields validation actually happens - expect(find.byType(Form), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that with a 'quartic' configuration type only " - '5 input fields appear on the screen', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - polynomialType: PolynomialType.quartic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ), - ); - - expect(find.byType(PolynomialDataInput), findsOneWidget); - expect(find.byType(PolynomialInputField), findsNWidgets(5)); - - // To make sure that fields validation actually happens - expect(find.byType(Form), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that when trying to solve an equation, if at ' - 'least one of the inputs is wrong, a snackbar appears', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - // No snackbar by default - expect(find.byType(SnackBar), findsNothing); - - // Tap the 'Solve' button - final finder = find.byKey(const Key('Polynomial-button-solve')); - await tester.tap(finder); - - // The snackbar appeared - await tester.pumpAndSettle(); - expect(find.byType(SnackBar), findsOneWidget); - - final inheritedWidget = tester.widget( - find.byType(InheritedPolynomial), - ); - expect(inheritedWidget.polynomialState.state.algebraic, isNull); - }, - ); - - testWidgets('Making sure that equations can be solved', (tester) async { - late FocusScopeNode focusScope; - - await tester.pumpWidget( - MaterialApp( - home: Builder( - builder: (context) { - focusScope = FocusScope.of(context); - - return MockPolynomialWidget( - polynomialType: PolynomialType.quadratic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - ); - }, - ), - ), - ); - - final coeffA = find.byKey( - const Key('PolynomialInputField-coefficient-0'), - ); - final coeffB = find.byKey( - const Key('PolynomialInputField-coefficient-1'), - ); - final coeffC = find.byKey( - const Key('PolynomialInputField-coefficient-2'), - ); - final solveButton = find.byKey( - const Key('Polynomial-button-solve'), - ); - final cleanButton = find.byKey( - const Key('Polynomial-button-clean'), - ); - - // Filling the forms - await tester.enterText(coeffA, '-5'); - await tester.enterText(coeffB, '1/2'); - await tester.enterText(coeffC, '3'); - - final inheritedWidget = tester.widget( - find.byType(InheritedPolynomial), - ); - expect(inheritedWidget.polynomialState.state.algebraic, isNull); - expect(focusScope.hasFocus, isTrue); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - // Cleaning the UI - await tester.tap(cleanButton); - await tester.pumpAndSettle(); - - tester.widgetList(find.byType(TextFormField)).forEach((t) { - expect(t.controller!.text.length, isZero); - }); - }); - }); - - group('Golden tests - PolynomialDataInput', () { - testWidgets('PolynomialDataInput - linear', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 250)); - - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - child: const PolynomialDataInput(), - ), - ); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_data_input_linear.png'), - ); - }); - - testWidgets('PolynomialDataInput - quadratic', (tester) async { - await tester.binding.setSurfaceSize(const Size(400, 250)); - - await tester.pumpWidget( - MockPolynomialWidget( - polynomialType: PolynomialType.quadratic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: const PolynomialDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_data_input_quadratic.png'), - ); - }); - - testWidgets('PolynomialDataInput - cubic', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 250)); - - await tester.pumpWidget( - MockPolynomialWidget( - polynomialType: PolynomialType.cubic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: const PolynomialDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_data_input_cubic.png'), - ); - }); - - testWidgets('PolynomialDataInput - quartic', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 250)); - - await tester.pumpWidget( - MockPolynomialWidget( - polynomialType: PolynomialType.quartic, - textControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - child: const PolynomialDataInput(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_data_input_quartic.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/polynomial_input_field_test.dart b/example/flutter_example/test/routes/polynomial_page/polynomial_input_field_test.dart deleted file mode 100644 index 64c6d2e5..00000000 --- a/example/flutter_example/test/routes/polynomial_page/polynomial_input_field_test.dart +++ /dev/null @@ -1,76 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/polynomial_input_field.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'PolynomialInputField' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - final controller = TextEditingController(); - - await tester.pumpWidget( - MockWrapper( - child: PolynomialInputField( - controller: controller, - placeholder: 'Demo', - ), - ), - ); - - expect(find.byType(PolynomialInputField), findsOneWidget); - expect(find.byType(TextFormField), findsOneWidget); - }); - - testWidgets( - 'Making sure that a PolynomialInputField has a validator ' - 'function to validate inputs', - (tester) async { - final controller = TextEditingController(); - - await tester.pumpWidget( - MockWrapper( - child: PolynomialInputField( - controller: controller, - placeholder: 'Demo', - ), - ), - ); - - final finder = - find.byKey(const Key('PolynomialInputField-TextFormField')); - expect(finder, findsOneWidget); - - // Testing the validator. Making sure that is accepts numbers and - // fractions - final textField = tester.firstWidget(finder) as TextFormField; - final validatorFunction = textField.validator!; - - expect(validatorFunction('1'), isNull); - expect(validatorFunction('-2/3'), isNull); - expect(validatorFunction('2.2587'), isNull); - - expect(validatorFunction(''), isNotNull); - }, - ); - }); - - group('Golden test - PolynomialInputField', () { - testWidgets('PolynomialInputField', (tester) async { - await tester.binding.setSurfaceSize(const Size(100, 100)); - - await tester.pumpWidget( - MockWrapper( - child: PolynomialInputField( - controller: TextEditingController(text: '-1/2'), - placeholder: 'Demo', - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_input_field.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/polynomial_mock.dart b/example/flutter_example/test/routes/polynomial_page/polynomial_mock.dart deleted file mode 100644 index a70b7c96..00000000 --- a/example/flutter_example/test/routes/polynomial_page/polynomial_mock.dart +++ /dev/null @@ -1,41 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_body.dart'; -import 'package:flutter/material.dart'; - -import '../mock_wrapper.dart'; - -class MockPolynomialWidget extends StatelessWidget { - final List textControllers; - final PolynomialType polynomialType; - final Widget child; - const MockPolynomialWidget({ - required this.textControllers, - this.polynomialType = PolynomialType.linear, - this.child = const PolynomialBody(), - super.key, - }); - - @override - Widget build(BuildContext context) { - return MockWrapper( - child: InheritedPolynomial( - polynomialState: PolynomialState(polynomialType), - child: InheritedTextControllers( - textControllers: textControllers, - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 2, - maxValue: 10, - initial: 3, - ), - child: child, - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/test/routes/polynomial_page/polynomial_results_test.dart b/example/flutter_example/test/routes/polynomial_page/polynomial_results_test.dart deleted file mode 100644 index 58b79d85..00000000 --- a/example/flutter_example/test/routes/polynomial_page/polynomial_results_test.dart +++ /dev/null @@ -1,114 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_results.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_discriminant.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; -import 'polynomial_mock.dart'; - -void main() { - group("Testing the 'PolynomialResults' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear), - child: const PolynomialResults(), - ), - ), - ); - - expect(find.byType(PolynomialResults), findsOneWidget); - expect(find.byType(SectionTitle), findsNWidgets(2)); - expect(find.byType(PolynomialDiscriminant), findsOneWidget); - }); - - testWidgets( - 'Making sure that, when there are no solutions, a text widget ' - "appears saying that there's nothing to display", - (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear), - child: const PolynomialResults(), - ), - ), - ); - - expect(find.byType(ComplexResultCard), findsNothing); - expect(find.text('No solutions to display.'), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that, when there are solutions, solution widgets ' - 'appear on the screen', - (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear) - ..solvePolynomial(const ['1', '2']), - child: const PolynomialResults(), - ), - ), - ); - - await tester.pumpAndSettle(); - - expect(find.text('No solutions to display.'), findsNothing); - expect(find.byType(ComplexResultCard), findsNWidgets(2)); - expect(find.byKey(const Key('PolynomialDiscriminant')), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that when an error occurred while solving the ' - 'equation, a Snackbar appears.', - (tester) async { - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await tester.tap(find.byKey(const Key('Polynomial-button-solve'))); - await tester.pumpAndSettle(); - - // Refreshing to make the snackbar appear - await tester.pumpAndSettle(); - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - }); - - group('Golden tests - PolynomialResults', () { - testWidgets('PolynomialResults', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 500)); - - await tester.pumpWidget( - MockWrapper( - child: InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear) - ..solvePolynomial(const ['1', '2']), - child: const PolynomialResults(), - ), - ), - ); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_results.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/utils/goldens/no_discriminant.png b/example/flutter_example/test/routes/polynomial_page/utils/goldens/no_discriminant.png deleted file mode 100644 index 0b41ad34..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/utils/goldens/no_discriminant.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_discriminant.png b/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_discriminant.png deleted file mode 100644 index 88f0bf9e..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_discriminant.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_cubic.png b/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_cubic.png deleted file mode 100644 index 266086ff..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_cubic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_linear.png b/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_linear.png deleted file mode 100644 index 441e13ff..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_linear.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_quadratic.png b/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_quadratic.png deleted file mode 100644 index a5ff0a7b..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_quadratic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_quartic.png b/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_quartic.png deleted file mode 100644 index f5383580..00000000 Binary files a/example/flutter_example/test/routes/polynomial_page/utils/goldens/polynomial_plot_quartic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/polynomial_page/utils/no_discriminant_test.dart b/example/flutter_example/test/routes/polynomial_page/utils/no_discriminant_test.dart deleted file mode 100644 index 9f3ab73c..00000000 --- a/example/flutter_example/test/routes/polynomial_page/utils/no_discriminant_test.dart +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/utils/no_discriminant.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'NoDiscriminant' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget(const MockWrapper(child: NoDiscriminant())); - - expect(find.byType(NoDiscriminant), findsOneWidget); - expect(find.byType(Center), findsOneWidget); - expect(find.text('No discriminant.'), findsOneWidget); - }); - }); - - group('Golden tests - NoDiscriminant', () { - testWidgets('NoDiscriminant', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 80)); - - await tester.pumpWidget( - const MockWrapper( - child: NoDiscriminant(), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/no_discriminant.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/utils/polynomial_discriminant_test.dart b/example/flutter_example/test/routes/polynomial_page/utils/polynomial_discriminant_test.dart deleted file mode 100644 index 857fab46..00000000 --- a/example/flutter_example/test/routes/polynomial_page/utils/polynomial_discriminant_test.dart +++ /dev/null @@ -1,47 +0,0 @@ -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_discriminant.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'PolynomialDiscriminant' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear) - ..solvePolynomial(['1', '2']), - child: const MockWrapper( - child: PolynomialDiscriminant(), - ), - ), - ); - - expect(find.byType(PolynomialDiscriminant), findsOneWidget); - expect(find.byType(ComplexResultCard), findsOneWidget); - }); - }); - - group('Golden test - PolynomialDiscriminant', () { - testWidgets('PolynomialDiscriminant', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 200)); - - await tester.pumpWidget( - InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear) - ..solvePolynomial(['1', '2']), - child: const MockWrapper( - child: PolynomialDiscriminant(), - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_discriminant.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page/utils/polynomial_plot_test.dart b/example/flutter_example/test/routes/polynomial_page/utils/polynomial_plot_test.dart deleted file mode 100644 index 99cc0c5d..00000000 --- a/example/flutter_example/test/routes/polynomial_page/utils/polynomial_plot_test.dart +++ /dev/null @@ -1,103 +0,0 @@ -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/polynomial_page/model/inherited_polynomial.dart'; -import 'package:equations_solver/routes/polynomial_page/model/polynomial_state.dart'; -import 'package:equations_solver/routes/polynomial_page/utils/polynomial_plot_widget.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'PolynomialPlotWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - InheritedPolynomial( - polynomialState: PolynomialState(PolynomialType.linear) - ..solvePolynomial(['1', '2']), - child: const MockWrapper( - child: PolynomialPlotWidget(), - ), - ), - ); - - expect(find.byType(PolynomialPlotWidget), findsOneWidget); - expect(find.byType(CartesianPlane), findsOneWidget); - }); - }); - - group('Golden test - PolynomialPlotWidget', () { - Widget mockedTree({ - required PolynomialState state, - }) { - return MockWrapper( - child: InheritedPolynomial( - polynomialState: state, - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 10, - initial: 5, - ), - child: const PolynomialPlotWidget(), - ), - ), - ); - } - - testWidgets('PolynomialPlotWidget - linear equation', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 750)); - - await tester.pumpWidget( - mockedTree( - state: PolynomialState(PolynomialType.linear) - ..solvePolynomial(const ['1', '2']), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_plot_linear.png'), - ); - }); - - testWidgets('PolynomialPlotWidget - quadratic equation', (tester) async { - await tester.pumpWidget( - mockedTree( - state: PolynomialState(PolynomialType.quadratic) - ..solvePolynomial(const ['-2', '-1/4', '3']), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_plot_quadratic.png'), - ); - }); - - testWidgets('PolynomialPlotWidget - cubic equation', (tester) async { - await tester.pumpWidget( - mockedTree( - state: PolynomialState(PolynomialType.cubic) - ..solvePolynomial(const ['1', '-2', '-1/4', '3']), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_plot_cubic.png'), - ); - }); - - testWidgets('PolynomialPlotWidget - quartic equation', (tester) async { - await tester.pumpWidget( - mockedTree( - state: PolynomialState(PolynomialType.quartic) - ..solvePolynomial(const ['-1', '0', '3', '0', '-1']), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/polynomial_plot_quartic.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/polynomial_page_test.dart b/example/flutter_example/test/routes/polynomial_page_test.dart deleted file mode 100644 index afdff23b..00000000 --- a/example/flutter_example/test/routes/polynomial_page_test.dart +++ /dev/null @@ -1,190 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/polynomial_page.dart'; -import 'package:equations_solver/routes/polynomial_page/polynomial_body.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'mock_wrapper.dart'; -import 'polynomial_page/polynomial_mock.dart'; - -void main() { - group("Testing the 'PolynomialPage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: PolynomialPage(), - ), - ); - - expect(find.byType(PolynomialBody), findsOneWidget); - expect(find.byType(PolynomialPage), findsOneWidget); - }); - - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: PolynomialPage(), - ), - ); - - expect(find.byType(PolynomialBody), findsOneWidget); - expect(find.byType(PolynomialPage), findsOneWidget); - }); - - testWidgets('Making sure that pages can be changed', (tester) async { - var firstDegree = ''; - var secondDegree = ''; - var thirdDegree = ''; - var fourthDegree = ''; - - // There will always be 1 string matching the name because of the bottom - // navigation bar. To make sure we're on a certain page, we need to check - // whether 2 text are present (one on the bottom bar AND one at the top - // of the newly opened page). - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - firstDegree = context.l10n.firstDegree; - secondDegree = context.l10n.secondDegree; - thirdDegree = context.l10n.thirdDegree; - fourthDegree = context.l10n.fourthDegree; - - return const PolynomialPage(); - }, - ), - ), - ); - - // Second degree page - await tester.tap(find.text(secondDegree)); - await tester.pumpAndSettle(); - expect(find.text(firstDegree), findsOneWidget); - expect(find.text(secondDegree), findsNWidgets(2)); - expect(find.text(thirdDegree), findsOneWidget); - expect(find.text(fourthDegree), findsOneWidget); - - // Third degree page - await tester.tap(find.text(thirdDegree)); - await tester.pumpAndSettle(); - expect(find.text(firstDegree), findsOneWidget); - expect(find.text(secondDegree), findsOneWidget); - expect(find.text(thirdDegree), findsNWidgets(2)); - expect(find.text(fourthDegree), findsOneWidget); - - // Fourth degree page - await tester.tap(find.text(fourthDegree)); - await tester.pumpAndSettle(); - expect(find.text(firstDegree), findsOneWidget); - expect(find.text(secondDegree), findsOneWidget); - expect(find.text(thirdDegree), findsOneWidget); - expect(find.text(fourthDegree), findsNWidgets(2)); - - // Fist degree page - await tester.tap(find.text(firstDegree)); - await tester.pumpAndSettle(); - expect(find.text(firstDegree), findsNWidgets(2)); - expect(find.text(secondDegree), findsOneWidget); - expect(find.text(thirdDegree), findsOneWidget); - expect(find.text(fourthDegree), findsOneWidget); - }); - }); - - group('Golden tests - PolynomialBody', () { - Future solvePolynomial(WidgetTester tester) async { - final firstInput = find.byKey( - const Key('PolynomialInputField-coefficient-0'), - ); - final secondInput = find.byKey( - const Key('PolynomialInputField-coefficient-1'), - ); - final solveButton = find.byKey(const Key('Polynomial-button-solve')); - - // Filling the form - await tester.enterText(firstInput, '1'); - await tester.enterText(secondInput, '2'); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - await tester.ensureVisible(find.byType(ComplexResultCard).last); - await tester.pumpAndSettle(); - } - - testWidgets('PolynomialBody - small screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1400)); - - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/polynomial_body_small_screen.png'), - ); - }); - - testWidgets('PolynomialBody - large screen', (tester) async { - await tester.binding.setSurfaceSize(const Size(1200, 900)); - - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/polynomial_body_large_screen.png'), - ); - }); - - testWidgets('PolynomialBody - small screen with data', (tester) async { - await tester.binding.setSurfaceSize(const Size(600, 1500)); - - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await solvePolynomial(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/polynomial_body_small_screen_with_data.png'), - ); - }); - - testWidgets('PolynomialBody - large screen with data', (tester) async { - await tester.binding.setSurfaceSize(const Size(1300, 1100)); - - await tester.pumpWidget( - MockPolynomialWidget( - textControllers: [ - TextEditingController(), - TextEditingController(), - ], - ), - ); - - await solvePolynomial(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/polynomial_body_large_screen_with_data.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/goldens/system_data_input_cholesky.png b/example/flutter_example/test/routes/system_page/goldens/system_data_input_cholesky.png deleted file mode 100644 index af2a42f5..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_data_input_cholesky.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_data_input_jacobi.png b/example/flutter_example/test/routes/system_page/goldens/system_data_input_jacobi.png deleted file mode 100644 index c1776fb1..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_data_input_jacobi.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_data_input_lu.png b/example/flutter_example/test/routes/system_page/goldens/system_data_input_lu.png deleted file mode 100644 index 9ab05808..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_data_input_lu.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_data_input_row_reduction.png b/example/flutter_example/test/routes/system_page/goldens/system_data_input_row_reduction.png deleted file mode 100644 index ea69604a..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_data_input_row_reduction.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_data_input_sor.png b/example/flutter_example/test/routes/system_page/goldens/system_data_input_sor.png deleted file mode 100644 index ce7e7284..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_data_input_sor.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_input_field_noplaceholder.png b/example/flutter_example/test/routes/system_page/goldens/system_input_field_noplaceholder.png deleted file mode 100644 index 27e99dc8..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_input_field_noplaceholder.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_input_field_placeholder.png b/example/flutter_example/test/routes/system_page/goldens/system_input_field_placeholder.png deleted file mode 100644 index b1074a9f..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_input_field_placeholder.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_results_cards.png b/example/flutter_example/test/routes/system_page/goldens/system_results_cards.png deleted file mode 100644 index e8961dbb..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_results_cards.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/goldens/system_results_nothing.png b/example/flutter_example/test/routes/system_page/goldens/system_results_nothing.png deleted file mode 100644 index 3abccf32..00000000 Binary files a/example/flutter_example/test/routes/system_page/goldens/system_results_nothing.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/model/inherited_system_test.dart b/example/flutter_example/test/routes/system_page/model/inherited_system_test.dart deleted file mode 100644 index 18503795..00000000 --- a/example/flutter_example/test/routes/system_page/model/inherited_system_test.dart +++ /dev/null @@ -1,64 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'InheritedSystem' widget", () { - test("Making sure that 'updateShouldNotify' is correctly overridden", () { - final inheritedNonlinear = InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: const SizedBox.shrink(), - ); - - expect( - inheritedNonlinear.updateShouldNotify(inheritedNonlinear), - isFalse, - ); - expect( - inheritedNonlinear.updateShouldNotify( - InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - expect( - inheritedNonlinear.updateShouldNotify( - InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: const SizedBox.shrink(), - ), - ), - isTrue, - ); - }); - - testWidgets( - "Making sure that the static 'of' method doesn't throw when located up " - 'in the tree', - (tester) async { - late SystemState reference; - - await tester.pumpWidget( - MaterialApp( - home: InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: Builder( - builder: (context) { - reference = InheritedSystem.of(context).systemState; - - return const SizedBox.shrink(); - }, - ), - ), - ), - ); - - expect(reference.systemType, equals(SystemType.rowReduction)); - expect(reference.state.systemSolver, isNull); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/system_page/model/system_result_test.dart b/example/flutter_example/test/routes/system_page/model/system_result_test.dart deleted file mode 100644 index 2b60bc5d..00000000 --- a/example/flutter_example/test/routes/system_page/model/system_result_test.dart +++ /dev/null @@ -1,151 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/system_page/model/system_result.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NonlinearResult' class", () { - test('Initial values', () { - final systemResult = SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ); - - expect(systemResult.systemSolver, isA()); - expect(systemResult.isSingular, isFalse); - }); - - test('Making sure that objects can be properly compared', () { - final systemResult = SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ); - - expect( - systemResult, - equals( - SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ), - ), - ); - - expect( - SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ), - systemResult, - ); - - expect( - systemResult == - SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ), - isTrue, - ); - - expect( - SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ) == - systemResult, - isTrue, - ); - - expect( - SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, 1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ) == - systemResult, - isFalse, - ); - - expect( - systemResult.hashCode, - equals( - SystemResult( - systemSolver: LUSolver( - matrix: RealMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [3, -1], - [1, 0], - ], - ), - knownValues: const [1, 2], - ), - ).hashCode, - ), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/model/system_state_test.dart b/example/flutter_example/test/routes/system_page/model/system_state_test.dart deleted file mode 100644 index 9a4e8d74..00000000 --- a/example/flutter_example/test/routes/system_page/model/system_state_test.dart +++ /dev/null @@ -1,269 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/system_result.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NonlinearType' enum", () { - test('Properties values', () { - expect(SystemType.values.length, equals(3)); - expect(RowReductionMethods.values.length, equals(1)); - expect(FactorizationMethods.values.length, equals(2)); - expect(IterativeMethods.values.length, equals(3)); - }); - }); - - group("Testing static methods on 'SystemState'", () { - test("Testing the 'rowReductionResolve' method", () { - expect( - SystemState.rowReductionResolve('gauss'), - equals(RowReductionMethods.gauss), - ); - expect( - () => SystemState.rowReductionResolve(''), - throwsArgumentError, - ); - }); - - test("Testing the 'factorizationResolve' method", () { - expect( - SystemState.factorizationResolve('lu'), - equals(FactorizationMethods.lu), - ); - expect( - SystemState.factorizationResolve('cholesky'), - equals(FactorizationMethods.cholesky), - ); - expect( - () => SystemState.factorizationResolve(''), - throwsArgumentError, - ); - }); - - test("Testing the 'iterativeResolve' method", () { - expect( - SystemState.iterativeResolve('sor'), - equals(IterativeMethods.sor), - ); - expect( - SystemState.iterativeResolve('jacobi'), - equals(IterativeMethods.jacobi), - ); - expect( - () => SystemState.iterativeResolve(''), - throwsArgumentError, - ); - }); - }); - - group("Testing the 'SystemState' class", () { - test('Initial values', () { - final systemState = SystemState(SystemType.iterative); - - expect(systemState.systemType, equals(SystemType.iterative)); - expect(systemState.state, equals(const SystemResult())); - }); - - test( - 'Making sure that singular matrices return no results - rowReduction', - () { - final systemState = SystemState(SystemType.rowReduction) - ..rowReductionSolver( - flatMatrix: ['1', '2', '1', '2'], - knownValues: ['0', '-1'], - size: 2, - ); - - expect(systemState.systemType, equals(SystemType.rowReduction)); - expect(systemState.state, equals(const SystemResult(isSingular: true))); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isTrue); - }, - ); - - test( - 'Making sure that singular matrices return no results - factorization', - () { - final systemState = SystemState(SystemType.factorization) - ..factorizationSolver( - method: FactorizationMethods.lu, - flatMatrix: ['1', '2', '1', '2'], - knownValues: ['0', '-1'], - size: 2, - ); - - expect(systemState.systemType, equals(SystemType.factorization)); - expect(systemState.state, equals(const SystemResult(isSingular: true))); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isTrue); - }, - ); - - test( - 'Making sure that singular matrices return no results - iterative', - () { - final systemState = SystemState(SystemType.iterative) - ..iterativeSolver( - method: IterativeMethods.sor, - flatMatrix: ['1', '2', '1', '2'], - knownValues: ['0', '-1'], - size: 2, - ); - - expect(systemState.systemType, equals(SystemType.iterative)); - expect(systemState.state, equals(const SystemResult(isSingular: true))); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isTrue); - }, - ); - - test( - 'Making sure that systems can be solved and cleared using row reduction' - ' methods', - () { - var count = 0; - final systemState = SystemState(SystemType.iterative) - ..addListener(() => ++count); - - expect(systemState.systemType, equals(SystemType.iterative)); - expect(systemState.state, equals(const SystemResult())); - - systemState.iterativeSolver( - flatMatrix: ['1', '3', '2', '5'], - knownValues: ['0', '-1'], - size: 2, - method: IterativeMethods.gaussSeidel, - ); - - expect(systemState.systemType, equals(SystemType.iterative)); - expect(systemState.state.systemSolver, isNotNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(1)); - - systemState.clear(); - - expect(systemState.systemType, equals(SystemType.iterative)); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(2)); - }, - ); - - test( - 'Making sure that systems can be solved and cleared using iterative' - ' methods', - () { - var count = 0; - final systemState = SystemState(SystemType.rowReduction) - ..addListener(() => ++count); - - expect(systemState.systemType, equals(SystemType.rowReduction)); - expect(systemState.state, equals(const SystemResult())); - - systemState.rowReductionSolver( - flatMatrix: ['1', '3', '2', '5'], - knownValues: ['0', '-1'], - size: 2, - ); - - expect(systemState.systemType, equals(SystemType.rowReduction)); - expect(systemState.state.systemSolver, isNotNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(1)); - - systemState.clear(); - - expect(systemState.systemType, equals(SystemType.rowReduction)); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(2)); - }, - ); - - test( - 'Making sure that systems can be solved and cleared using factorization' - ' methods', - () { - var count = 0; - final systemState = SystemState(SystemType.factorization) - ..addListener(() => ++count); - - expect(systemState.systemType, equals(SystemType.factorization)); - expect(systemState.state, equals(const SystemResult())); - - systemState.factorizationSolver( - flatMatrix: ['1', '3', '2', '5'], - knownValues: ['0', '-1'], - size: 2, - method: FactorizationMethods.lu, - ); - - expect(systemState.systemType, equals(SystemType.factorization)); - expect(systemState.state.systemSolver, isNotNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(1)); - - systemState.clear(); - - expect(systemState.systemType, equals(SystemType.factorization)); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(2)); - }, - ); - - test('Making sure that exceptions are handled', () { - var count = 0; - final systemState = SystemState(SystemType.factorization) - ..addListener(() => ++count); - - expect(systemState.systemType, equals(SystemType.factorization)); - expect(systemState.state, equals(const SystemResult())); - - systemState.rowReductionSolver( - flatMatrix: ['1', '2', '1', '2'], - knownValues: ['1', '2'], - size: 2, - ); - - expect(systemState.state, equals(const SystemResult(isSingular: true))); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isTrue); - expect(count, equals(1)); - - systemState.rowReductionSolver( - flatMatrix: ['', '', '', ''], - knownValues: ['', ''], - size: 2, - ); - - expect(systemState.state, equals(const SystemResult())); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(2)); - - systemState.iterativeSolver( - flatMatrix: ['', '', '', ''], - knownValues: ['', ''], - size: 2, - method: IterativeMethods.sor, - ); - - expect(systemState.state, equals(const SystemResult())); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(3)); - - systemState.factorizationSolver( - flatMatrix: ['', '', '', ''], - knownValues: ['', ''], - size: 2, - method: FactorizationMethods.lu, - ); - - expect(systemState.state, equals(const SystemResult())); - expect(systemState.state.systemSolver, isNull); - expect(systemState.state.isSingular, isFalse); - expect(count, equals(4)); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/system_body_test.dart b/example/flutter_example/test/routes/system_page/system_body_test.dart deleted file mode 100644 index 67f49205..00000000 --- a/example/flutter_example/test/routes/system_page/system_body_test.dart +++ /dev/null @@ -1,284 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_data_input.dart'; -import 'package:equations_solver/routes/system_page/system_results.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'system_mock.dart'; - -void main() { - group("Testing the 'SystemBody' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockSystemWidget(), - ); - - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(SystemDataInput), findsOneWidget); - expect(find.byType(SystemResults), findsOneWidget); - expect(find.byType(PageTitle), findsOneWidget); - expect(find.byType(SystemsLogo), findsOneWidget); - }); - - testWidgets( - 'Making sure that the "Clear" button actually clears the state', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - ), - ); - - // Filling the matrix with some data - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - expect(find.byType(RealResultCard), findsNothing); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - - // Clearing the page - await tester.tap(find.byKey(const Key('System-button-clean'))); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsNothing); - tester.widgetList(find.byType(TextFormField)).forEach( - (widget) { - expect(widget.controller!.text.length, isZero); - }, - ); - }, - ); - - testWidgets( - 'Making sure that the "Solve" button actually solves the ' - 'system of equations using the row reduction algorithm', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget(), - ); - - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - expect(find.byType(RealResultCard), findsNothing); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the "Solve" button actually solves the ' - 'system of equations with a factorization method (LU)', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - ), - ); - - // Filling the matrix with some data - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - - expect(find.byType(RealResultCard), findsNothing); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the "Solve" button actually solves the ' - 'system of equations with a factorization method (Cholesky)', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.cholesky.asString, - ), - ); - - // Filling the matrix with some data - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - - expect(find.byType(RealResultCard), findsNothing); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the "Solve" button actually solves the ' - 'system of equations with an iterative method (SOR)', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.sor.asString, - ), - ); - - // Filling the matrix with some data - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - await tester.enterText( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - '1', - ); - - expect(find.byType(RealResultCard), findsNothing); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the "Solve" button actually solves the ' - 'system of equations with an iterative method (Jacobi)', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - ), - ); - - // Filling the matrix with some data - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText( - find.byKey(const Key('VectorEntry-0')).first, - '1', - ); - await tester.enterText( - find.byKey(const Key('VectorEntry-0')).last, - '1', - ); - - expect(find.byType(RealResultCard), findsNothing); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(RealResultCard), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the "Solve" button does NOT solve the ' - 'system in case of malformed input', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget(), - ); - - // Solving the system - final solveButton = find.byKey(const Key('System-button-solve')); - - await tester.ensureVisible(solveButton); - await tester.tap(solveButton); - await tester.pumpAndSettle(); - - expect(find.byType(SnackBar), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the number switcher also changes the total ' - 'number of input tiles on the screen', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget(), - ); - - expect(find.byKey(const Key('SystemEntry-0-0')), findsOneWidget); - expect(find.byKey(const Key('VectorEntry-0')), findsOneWidget); - - // Changing the size - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pumpAndSettle(); - - expect(find.byKey(const Key('SystemEntry-0-0')), findsOneWidget); - expect(find.byKey(const Key('SystemEntry-0-1')), findsOneWidget); - expect(find.byKey(const Key('SystemEntry-1-0')), findsOneWidget); - expect(find.byKey(const Key('SystemEntry-1-1')), findsOneWidget); - expect(find.byKey(const Key('VectorEntry-0')), findsOneWidget); - expect(find.byKey(const Key('VectorEntry-1')), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the number switcher also clears everything when ' - 'changing values', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget(), - ); - - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '-5'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '7'); - await tester.pumpAndSettle(); - - await tester.tap(find.byKey(const Key('System-button-solve'))); - await tester.pumpAndSettle(); - - expect(find.text('-5'), findsOneWidget); - expect(find.text('7'), findsOneWidget); - expect(find.byType(RealResultCard), findsOneWidget); - - // Changing the size - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pumpAndSettle(); - - // Making sure the form is clean - expect(find.text('-5'), findsNothing); - expect(find.text('7'), findsNothing); - expect(find.byType(RealResultCard), findsNothing); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/system_page/system_data_input_test.dart b/example/flutter_example/test/routes/system_page/system_data_input_test.dart deleted file mode 100644 index d5c296b3..00000000 --- a/example/flutter_example/test/routes/system_page/system_data_input_test.dart +++ /dev/null @@ -1,232 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_data_input.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/system_page/utils/matrix_input.dart'; -import 'package:equations_solver/routes/system_page/utils/size_picker.dart'; -import 'package:equations_solver/routes/system_page/utils/vector_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'system_mock.dart'; - -void main() { - group("Testing the 'SystemDataInput' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockSystemWidget( - child: SystemDataInput(), - ), - ); - - expect(find.byType(SystemDataInput), findsOneWidget); - expect(find.byType(SizePicker), findsOneWidget); - expect(find.byType(MatrixInput), findsOneWidget); - expect(find.byType(VectorInput), findsOneWidget); - expect(find.byType(SystemDropdownSelection), findsOneWidget); - - expect(find.byKey(const Key('System-button-solve')), findsOneWidget); - expect(find.byKey(const Key('System-button-clean')), findsOneWidget); - }); - - testWidgets( - 'Making sure that row reduction methods do not show SOR or jacobi inputs', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget( - child: SystemDataInput(), - ), - ); - - expect(find.byType(SystemDataInput), findsOneWidget); - expect( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - findsNothing, - ); - expect( - find.byKey( - const Key('Jacobi-Vector-Input-Column'), - ), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that LU does not show SOR or jacobi inputs', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.lu.asString, - systemType: SystemType.factorization, - child: const SystemDataInput(), - ), - ); - - expect(find.byType(SystemDataInput), findsOneWidget); - expect( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - findsNothing, - ); - expect( - find.byKey( - const Key('Jacobi-Vector-Input-Column'), - ), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that Cholesky does not show SOR or jacobi inputs', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.cholesky.asString, - systemType: SystemType.factorization, - child: const SystemDataInput(), - ), - ); - - expect(find.byType(SystemDataInput), findsOneWidget); - expect( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - findsNothing, - ); - expect( - find.byKey( - const Key('Jacobi-Vector-Input-Column'), - ), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that SOR only shows the relaxation factor input', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.sor.asString, - systemType: SystemType.iterative, - child: const SingleChildScrollView( - child: SystemDataInput(), - ), - ), - ); - - expect(find.byType(SystemDataInput), findsOneWidget); - expect( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - findsOneWidget, - ); - expect( - find.byKey( - const Key('Jacobi-Vector-Input-Column'), - ), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that Jacobi only shows the initial vector input', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.jacobi.asString, - systemType: SystemType.iterative, - child: const SingleChildScrollView( - child: SystemDataInput(), - ), - ), - ); - - expect(find.byType(SystemDataInput), findsOneWidget); - expect( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - findsNothing, - ); - expect( - find.byKey( - const Key('Jacobi-Vector-Input-Column'), - ), - findsOneWidget, - ); - }, - ); - }); - - group('Golden tests - SystemDataInput', () { - testWidgets('SystemDataInput - Row reduction', (tester) async { - await tester.pumpWidget( - const MockSystemWidget( - child: SystemDataInput(), - ), - ); - await expectLater( - find.byType(SystemDataInput), - matchesGoldenFile('goldens/system_data_input_row_reduction.png'), - ); - }); - - testWidgets('SystemDataInput - LU', (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - child: const SystemDataInput(), - ), - ); - await expectLater( - find.byType(SystemDataInput), - matchesGoldenFile('goldens/system_data_input_lu.png'), - ); - }); - - testWidgets('SystemDataInput - Cholesky', (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.cholesky.asString, - child: const SystemDataInput(), - ), - ); - await expectLater( - find.byType(SystemDataInput), - matchesGoldenFile('goldens/system_data_input_cholesky.png'), - ); - }); - - testWidgets('SystemDataInput - SOR', (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.sor.asString, - child: const SingleChildScrollView( - child: SystemDataInput(), - ), - ), - ); - await expectLater( - find.byType(SystemDataInput), - matchesGoldenFile('goldens/system_data_input_sor.png'), - ); - }); - - testWidgets('SystemDataInput - Jacobi', (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - child: const SingleChildScrollView( - child: SystemDataInput(), - ), - ), - ); - await expectLater( - find.byType(SystemDataInput), - matchesGoldenFile('goldens/system_data_input_jacobi.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/system_input_field_test.dart b/example/flutter_example/test/routes/system_page/system_input_field_test.dart deleted file mode 100644 index 72312661..00000000 --- a/example/flutter_example/test/routes/system_page/system_input_field_test.dart +++ /dev/null @@ -1,57 +0,0 @@ -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'SystemBody' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: SystemInputField( - controller: TextEditingController(), - ), - ), - ); - - expect(find.byType(SystemInputField), findsOneWidget); - expect(find.byType(TextFormField), findsOneWidget); - }); - }); - - group('Golden tests - SystemInputField', () { - testWidgets('SystemInputField - without placeholder', (tester) async { - await tester.binding.setSurfaceSize(const Size(100, 100)); - - await tester.pumpWidget( - MockWrapper( - child: SystemInputField( - controller: TextEditingController(), - ), - ), - ); - await expectLater( - find.byType(SystemInputField), - matchesGoldenFile('goldens/system_input_field_noplaceholder.png'), - ); - }); - - testWidgets('SystemInputField - with placeholder', (tester) async { - await tester.binding.setSurfaceSize(const Size(100, 100)); - - await tester.pumpWidget( - MockWrapper( - child: SystemInputField( - controller: TextEditingController(), - placeholder: 'x', - ), - ), - ); - await expectLater( - find.byType(SystemInputField), - matchesGoldenFile('goldens/system_input_field_placeholder.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/system_mock.dart b/example/flutter_example/test/routes/system_page/system_mock.dart deleted file mode 100644 index 9f5976a4..00000000 --- a/example/flutter_example/test/routes/system_page/system_mock.dart +++ /dev/null @@ -1,96 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/system_text_controllers.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_body.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:flutter/material.dart'; - -import '../mock_wrapper.dart'; - -class MockSystemWidget extends StatefulWidget { - final SystemType systemType; - final Widget child; - final String? dropdownValue; - const MockSystemWidget({ - super.key, - this.systemType = SystemType.rowReduction, - this.child = const SystemBody(), - this.dropdownValue, - }); - - @override - State createState() => _MockSystemWidgetState(); -} - -class _MockSystemWidgetState extends State { - final matrixControllers = List.generate( - 16, - (_) => TextEditingController(), - growable: false, - ); - - final vectorControllers = List.generate( - 4, - (_) => TextEditingController(), - growable: false, - ); - - final jacobiControllers = List.generate( - 4, - (_) => TextEditingController(), - growable: false, - ); - - final wSorController = TextEditingController(); - - @override - void dispose() { - for (final controller in matrixControllers) { - controller.dispose(); - } - - for (final controller in vectorControllers) { - controller.dispose(); - } - - for (final controller in jacobiControllers) { - controller.dispose(); - } - - wSorController.dispose(); - super.dispose(); - } - - @override - Widget build(BuildContext context) { - return MockWrapper( - child: InheritedSystem( - systemState: SystemState(widget.systemType), - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 1, - max: 4, - ), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - widget.dropdownValue ?? SystemDropdownItems.lu.asString, - ), - child: InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - matrixControllers: matrixControllers, - vectorControllers: vectorControllers, - jacobiControllers: jacobiControllers, - wSorController: wSorController, - ), - child: widget.child, - ), - ), - ), - ), - ); - } -} diff --git a/example/flutter_example/test/routes/system_page/system_results_test.dart b/example/flutter_example/test/routes/system_page/system_results_test.dart deleted file mode 100644 index bcd44d27..00000000 --- a/example/flutter_example/test/routes/system_page/system_results_test.dart +++ /dev/null @@ -1,126 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_results.dart'; -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:equations_solver/routes/utils/result_cards/message_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'system_mock.dart'; - -void main() { - group("Testing the 'PolynomialResults' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockSystemWidget( - child: SystemResults(), - ), - ); - - expect(find.byType(SystemResults), findsOneWidget); - expect(find.byType(SectionTitle), findsOneWidget); - expect(find.byType(EquationSolution), findsOneWidget); - }); - - testWidgets( - 'Making sure that, when there are no solutions, no result cards appear', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget( - child: SystemResults(), - ), - ); - - expect(find.byType(NoResults), findsOneWidget); - expect(find.byType(RealResultCard), findsNothing); - }, - ); - - testWidgets( - 'Making sure that singular matrices show an error message', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - child: InheritedSystem( - systemState: SystemState(SystemType.rowReduction) - ..rowReductionSolver( - flatMatrix: ['1', '2', '2', '4'], - knownValues: ['3', '2'], - size: 2, - ), - child: const SystemResults(), - ), - ), - ); - - expect(find.byType(NoResults), findsNothing); - expect(find.byType(MessageCard), findsOneWidget); - expect(find.byType(RealResultCard), findsNothing); - }, - ); - - testWidgets( - 'Making sure that, when there are solutions, result cards appear', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - child: InheritedSystem( - systemState: SystemState(SystemType.rowReduction) - ..rowReductionSolver( - flatMatrix: ['-2', '3', '1', '5'], - knownValues: ['3', '2'], - size: 2, - ), - child: const SystemResults(), - ), - ), - ); - - expect(find.byType(NoResults), findsNothing); - expect(find.byType(MessageCard), findsNothing); - expect(find.byType(RealResultCard), findsNWidgets(2)); - }, - ); - }); - - group('Golden tests - SystemResults', () { - testWidgets('SystemResults - no results', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 250)); - - await tester.pumpWidget( - const MockSystemWidget( - child: SystemResults(), - ), - ); - await expectLater( - find.byType(SystemResults), - matchesGoldenFile('goldens/system_results_nothing.png'), - ); - }); - - testWidgets('SystemResults - no results', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 450)); - - await tester.pumpWidget( - MockSystemWidget( - child: InheritedSystem( - systemState: SystemState(SystemType.rowReduction) - ..rowReductionSolver( - flatMatrix: ['-2', '3', '1', '5'], - knownValues: ['3', '2'], - size: 2, - ), - child: const SystemResults(), - ), - ), - ); - await expectLater( - find.byType(SystemResults), - matchesGoldenFile('goldens/system_results_cards.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/utils/dropdown_selection_test.dart b/example/flutter_example/test/routes/system_page/utils/dropdown_selection_test.dart deleted file mode 100644 index d37e1d65..00000000 --- a/example/flutter_example/test/routes/system_page/utils/dropdown_selection_test.dart +++ /dev/null @@ -1,221 +0,0 @@ -import 'package:equations_solver/routes/models/dropdown_value/inherited_dropdown_value.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; -import '../system_mock.dart'; - -void main() { - group("Testing the 'SystemDropdownSelection' widget", () { - test("Testing the 'SystemDropdownItemsExt' extension method", () { - expect(SystemDropdownItems.lu.asString, equals('LU')); - expect(SystemDropdownItems.cholesky.asString, equals('Cholesky')); - expect(SystemDropdownItems.sor.asString, equals('SOR')); - expect(SystemDropdownItems.jacobi.asString, equals('Jacobi')); - }); - - test("Testing the 'StringExt' extension method", () { - expect( - 'lu'.toSystemDropdownItems(), - equals(SystemDropdownItems.lu), - ); - expect( - 'cholesky'.toSystemDropdownItems(), - equals(SystemDropdownItems.cholesky), - ); - expect( - 'sor'.toSystemDropdownItems(), - equals(SystemDropdownItems.sor), - ); - expect( - 'jacobi'.toSystemDropdownItems(), - equals(SystemDropdownItems.jacobi), - ); - expect(''.toSystemDropdownItems, throwsArgumentError); - }); - - testWidgets( - 'Making sure that the widget shows no dropdown when row ' - 'reduction type is selected', - (tester) async { - await tester.pumpWidget( - const MockSystemWidget( - child: SystemDropdownSelection(), - ), - ); - - expect(find.byType(SystemDropdownSelection), findsOneWidget); - expect( - find.byKey(const Key('System-Dropdown-Button-Selection')), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that the widget shows the dropdown when the ' - 'factorization type is selected', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - child: const SystemDropdownSelection(), - ), - ); - - expect(find.byType(SystemDropdownSelection), findsOneWidget); - expect( - find.byKey(const Key('System-Dropdown-Button-Selection')), - findsOneWidget, - ); - expect(find.text('LU'), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that the widget shows the dropdown when the ' - 'iterative type is selected', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.sor.asString, - child: const SystemDropdownSelection(), - ), - ); - - expect(find.byType(SystemDropdownSelection), findsOneWidget); - expect( - find.byKey(const Key('System-Dropdown-Button-Selection')), - findsOneWidget, - ); - expect(find.text('SOR'), findsOneWidget); - }, - ); - - testWidgets( - 'Making sure that dropdown values can be changed', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - child: const SystemDropdownSelection(), - ), - ); - - await tester.tap(find.text('LU')); - await tester.pumpAndSettle(); - - await tester.tap(find.text('Cholesky').last); - await tester.pumpAndSettle(); - }, - ); - }); - - group('Golden tests - SystemDropdownSelection', () { - testWidgets('SystemDropdownSelection - gauss', (tester) async { - await tester.binding.setSurfaceSize(const Size(400, 150)); - - await tester.pumpWidget( - MockWrapper( - child: InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier(''), - child: const SystemDropdownSelection(), - ), - ), - ), - ); - await expectLater( - find.byType(SystemDropdownSelection), - matchesGoldenFile('goldens/dropdown_input_gauss.png'), - ); - }); - - testWidgets('SystemDropdownSelection - lu', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedSystem( - systemState: SystemState(SystemType.factorization), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - SystemDropdownItems.lu.asString, - ), - child: const SystemDropdownSelection(), - ), - ), - ), - ); - await expectLater( - find.byType(SystemDropdownSelection), - matchesGoldenFile('goldens/dropdown_input_lu.png'), - ); - }); - - testWidgets('SystemDropdownSelection - cholesky', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedSystem( - systemState: SystemState(SystemType.factorization), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - SystemDropdownItems.cholesky.asString, - ), - child: const SystemDropdownSelection(), - ), - ), - ), - ); - await expectLater( - find.byType(SystemDropdownSelection), - matchesGoldenFile('goldens/dropdown_input_cholesky.png'), - ); - }); - - testWidgets('SystemDropdownSelection - jacobi', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedSystem( - systemState: SystemState(SystemType.iterative), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - SystemDropdownItems.jacobi.asString, - ), - child: const SystemDropdownSelection(), - ), - ), - ), - ); - await expectLater( - find.byType(SystemDropdownSelection), - matchesGoldenFile('goldens/dropdown_input_jacobi.png'), - ); - }); - - testWidgets('SystemDropdownSelection - sor', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedSystem( - systemState: SystemState(SystemType.iterative), - child: InheritedDropdownValue( - dropdownValue: ValueNotifier( - SystemDropdownItems.sor.asString, - ), - child: const SystemDropdownSelection(), - ), - ), - ), - ); - await expectLater( - find.byType(SystemDropdownSelection), - matchesGoldenFile('goldens/dropdown_input_sor.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_cholesky.png b/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_cholesky.png deleted file mode 100644 index 64dac3b4..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_cholesky.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_gauss.png b/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_gauss.png deleted file mode 100644 index f8bffc78..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_gauss.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_jacobi.png b/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_jacobi.png deleted file mode 100644 index ee23eb2a..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_jacobi.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_lu.png b/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_lu.png deleted file mode 100644 index 63c8e87c..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_lu.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_sor.png b/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_sor.png deleted file mode 100644 index 1666b1c5..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/dropdown_input_sor.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_1.png b/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_1.png deleted file mode 100644 index eca28d16..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_2.png b/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_2.png deleted file mode 100644 index 3aeaac60..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_3.png b/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_3.png deleted file mode 100644 index 12a16651..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_3.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_4.png b/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_4.png deleted file mode 100644 index a5e1ab46..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/jacobi_vector_input_4.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_1.png b/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_1.png deleted file mode 100644 index 54410cf2..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_2.png b/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_2.png deleted file mode 100644 index 9b5438ee..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_3.png b/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_3.png deleted file mode 100644 index b281f5d0..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_3.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_4.png b/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_4.png deleted file mode 100644 index 006f40f5..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/matrix_input_4.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/relaxation_factor_input.png b/example/flutter_example/test/routes/system_page/utils/goldens/relaxation_factor_input.png deleted file mode 100644 index b5740c9c..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/relaxation_factor_input.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_1.png b/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_1.png deleted file mode 100644 index d6acffbe..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_2.png b/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_2.png deleted file mode 100644 index d6acffbe..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_3.png b/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_3.png deleted file mode 100644 index d6acffbe..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_3.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_4.png b/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_4.png deleted file mode 100644 index d6acffbe..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/size_picker_4.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_1.png b/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_1.png deleted file mode 100644 index 34e996ee..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_1.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_2.png b/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_2.png deleted file mode 100644 index 33fccf75..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_2.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_3.png b/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_3.png deleted file mode 100644 index 638cfcd5..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_3.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_4.png b/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_4.png deleted file mode 100644 index e8e9d103..00000000 Binary files a/example/flutter_example/test/routes/system_page/utils/goldens/vector_input_4.png and /dev/null differ diff --git a/example/flutter_example/test/routes/system_page/utils/jacobi_initial_vector_test.dart b/example/flutter_example/test/routes/system_page/utils/jacobi_initial_vector_test.dart deleted file mode 100644 index cc8fdbfc..00000000 --- a/example/flutter_example/test/routes/system_page/utils/jacobi_initial_vector_test.dart +++ /dev/null @@ -1,139 +0,0 @@ -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/system_page/utils/jacobi_initial_vector.dart'; -import 'package:equations_solver/routes/system_page/utils/vector_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../system_mock.dart'; - -void main() { - group("Testing the 'JacobiVectorInput' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - child: const JacobiVectorInput(), - ), - ); - - expect(find.byType(JacobiVectorInput), findsOneWidget); - expect(find.byType(VectorInput), findsOneWidget); - expect(find.byType(SystemInputField), findsOneWidget); - }); - - testWidgets( - 'Making sure that nothing is rendered when the selected ' - 'method is NOT Jacobi', - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - child: const JacobiVectorInput(), - ), - ); - - expect(find.byType(JacobiVectorInput), findsOneWidget); - expect(find.byType(VectorInput), findsNothing); - expect(find.byType(SystemInputField), findsNothing); - }, - ); - }); - - group('Golden tests - JacobiVectorInput', () { - testWidgets('JacobiVectorInput - 1', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 170)); - - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - child: const JacobiVectorInput(), - ), - ); - await expectLater( - find.byType(JacobiVectorInput), - matchesGoldenFile('goldens/jacobi_vector_input_1.png'), - ); - }); - - testWidgets('JacobiVectorInput - 2', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 220)); - - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - child: const JacobiVectorInput(), - ), - ); - - tester - .widget(find.byType(InheritedNumberSwitcher)) - .numberSwitcherState - .increase(); - - await tester.pumpAndSettle(); - - await expectLater( - find.byType(JacobiVectorInput), - matchesGoldenFile('goldens/jacobi_vector_input_2.png'), - ); - }); - - testWidgets('JacobiVectorInput - 3', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 270)); - - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - child: const JacobiVectorInput(), - ), - ); - - tester - .widget(find.byType(InheritedNumberSwitcher)) - .numberSwitcherState - ..increase() - ..increase(); - - await tester.pumpAndSettle(); - - await expectLater( - find.byType(JacobiVectorInput), - matchesGoldenFile('goldens/jacobi_vector_input_3.png'), - ); - }); - - testWidgets('JacobiVectorInput - 4', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 340)); - - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.jacobi.asString, - child: const JacobiVectorInput(), - ), - ); - - tester - .widget(find.byType(InheritedNumberSwitcher)) - .numberSwitcherState - ..increase() - ..increase() - ..increase(); - - await tester.pumpAndSettle(); - - await expectLater( - find.byType(JacobiVectorInput), - matchesGoldenFile('goldens/jacobi_vector_input_4.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/utils/matrix_input_test.dart b/example/flutter_example/test/routes/system_page/utils/matrix_input_test.dart deleted file mode 100644 index 896dccbf..00000000 --- a/example/flutter_example/test/routes/system_page/utils/matrix_input_test.dart +++ /dev/null @@ -1,134 +0,0 @@ -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/system_page/utils/matrix_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'MatrixInput' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: MatrixInput( - matrixControllers: [ - TextEditingController(), - TextEditingController(), - TextEditingController(), - TextEditingController(), - ], - matrixSize: 2, - ), - ), - ); - - expect(find.byType(MatrixInput), findsOneWidget); - expect(find.byType(Table), findsOneWidget); - expect(find.byType(SystemInputField), findsNWidgets(4)); - }); - }); - - group('Golden tests - MatrixInput', () { - testWidgets('MatrixInput - 1x1', (tester) async { - await tester.binding.setSurfaceSize(const Size(110, 110)); - - await tester.pumpWidget( - MockWrapper( - child: MatrixInput( - matrixControllers: [ - TextEditingController(text: '1'), - ], - matrixSize: 1, - ), - ), - ); - await expectLater( - find.byType(MatrixInput), - matchesGoldenFile('goldens/matrix_input_1.png'), - ); - }); - - testWidgets('MatrixInput - 2x2', (tester) async { - await tester.binding.setSurfaceSize(const Size(170, 170)); - - await tester.pumpWidget( - MockWrapper( - child: MatrixInput( - matrixControllers: [ - TextEditingController(text: '1'), - TextEditingController(text: '2'), - TextEditingController(text: '3'), - TextEditingController(text: '4'), - ], - matrixSize: 2, - ), - ), - ); - await expectLater( - find.byType(MatrixInput), - matchesGoldenFile('goldens/matrix_input_2.png'), - ); - }); - - testWidgets('MatrixInput - 3x3', (tester) async { - await tester.binding.setSurfaceSize(const Size(200, 200)); - - await tester.pumpWidget( - MockWrapper( - child: MatrixInput( - matrixControllers: [ - TextEditingController(text: '1'), - TextEditingController(text: '2'), - TextEditingController(text: '3'), - TextEditingController(text: '4'), - TextEditingController(text: '5'), - TextEditingController(text: '6'), - TextEditingController(text: '7'), - TextEditingController(text: '8'), - TextEditingController(text: '9'), - ], - matrixSize: 3, - ), - ), - ); - await expectLater( - find.byType(MatrixInput), - matchesGoldenFile('goldens/matrix_input_3.png'), - ); - }); - - testWidgets('MatrixInput - 4x4', (tester) async { - await tester.binding.setSurfaceSize(const Size(230, 230)); - - await tester.pumpWidget( - MockWrapper( - child: MatrixInput( - matrixControllers: [ - TextEditingController(text: '1'), - TextEditingController(text: '2'), - TextEditingController(text: '3'), - TextEditingController(text: '4'), - TextEditingController(text: '5'), - TextEditingController(text: '6'), - TextEditingController(text: '7'), - TextEditingController(text: '8'), - TextEditingController(text: '9'), - TextEditingController(text: '10'), - TextEditingController(text: '11'), - TextEditingController(text: '12'), - TextEditingController(text: '13'), - TextEditingController(text: '14'), - TextEditingController(text: '15'), - TextEditingController(text: '16'), - ], - matrixSize: 4, - ), - ), - ); - await expectLater( - find.byType(MatrixInput), - matchesGoldenFile('goldens/matrix_input_4.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/utils/size_picker_test.dart b/example/flutter_example/test/routes/system_page/utils/size_picker_test.dart deleted file mode 100644 index bdc0526f..00000000 --- a/example/flutter_example/test/routes/system_page/utils/size_picker_test.dart +++ /dev/null @@ -1,218 +0,0 @@ -import 'package:equations_solver/routes/models/number_switcher/inherited_number_switcher.dart'; -import 'package:equations_solver/routes/models/number_switcher/number_switcher_state.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/inherited_system_controllers.dart'; -import 'package:equations_solver/routes/models/system_text_controllers/system_text_controllers.dart'; -import 'package:equations_solver/routes/models/text_controllers/inherited_text_controllers.dart'; -import 'package:equations_solver/routes/other_page/model/inherited_other.dart'; -import 'package:equations_solver/routes/other_page/model/other_state.dart'; -import 'package:equations_solver/routes/system_page/model/inherited_system.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/utils/size_picker.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'SizePicker' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNumberSwitcher( - numberSwitcherState: NumberSwitcherState( - min: 2, - max: 4, - ), - child: const SizePicker( - isInOtherPage: true, - ), - ), - ), - ); - - expect(find.byType(SizePicker), findsOneWidget); - expect(find.byType(ElevatedButton), findsNWidgets(2)); - }); - - testWidgets( - 'Making sure that numbers can be changed in Others page', - (tester) async { - final state = NumberSwitcherState( - min: 1, - max: 4, - ); - - // This is required to ensure that no exceptions are thrown when the - // "SizePicker" clears the state and the controllers of the "Other" page - await tester.pumpWidget( - MockWrapper( - child: InheritedOther( - otherState: OtherState(), - child: InheritedTextControllers( - textControllers: const [], - child: InheritedNumberSwitcher( - numberSwitcherState: state, - child: const SizePicker( - isInOtherPage: true, - ), - ), - ), - ), - ), - ); - - expect(state.state, equals(1)); - expect(find.text('1x1 matrix'), findsOneWidget); - - // Moving forward - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pump(); - - expect(find.text('3x3 matrix'), findsOneWidget); - expect(state.state, equals(3)); - - // Moving back - await tester.tap(find.byKey(const Key('SizePicker-Back-Button'))); - await tester.pump(); - - expect(find.text('2x2 matrix'), findsOneWidget); - expect(state.state, equals(2)); - }, - ); - - testWidgets( - 'Making sure that numbers can be changed in Others page', - (tester) async { - final state = NumberSwitcherState( - min: 1, - max: 4, - ); - - // This is required to ensure that no exceptions are thrown when the - // "SizePicker" clears the state and the controllers of the "Other" page - await tester.pumpWidget( - MockWrapper( - child: InheritedSystem( - systemState: SystemState(SystemType.rowReduction), - child: InheritedSystemControllers( - systemTextControllers: SystemTextControllers( - jacobiControllers: const [], - vectorControllers: const [], - matrixControllers: const [], - wSorController: TextEditingController(), - ), - child: InheritedNumberSwitcher( - numberSwitcherState: state, - child: const SizePicker( - isInOtherPage: false, - ), - ), - ), - ), - ), - ); - - expect(state.state, equals(1)); - expect(find.text('1x1 matrix'), findsOneWidget); - - // Moving forward - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pump(); - - expect(find.text('3x3 matrix'), findsOneWidget); - expect(state.state, equals(3)); - - // Moving back - await tester.tap(find.byKey(const Key('SizePicker-Back-Button'))); - await tester.pump(); - - expect(find.text('2x2 matrix'), findsOneWidget); - expect(state.state, equals(2)); - }, - ); - }); - - group('Golden tests - SystemDropdownSelection', () { - Widget mockSliderForGolder({int matrixSize = 1}) { - final state = NumberSwitcherState( - min: 1, - max: 5, - ); - - for (var i = 1; i < matrixSize; ++i) { - state.increase(); - } - - return MockWrapper( - child: InheritedOther( - otherState: OtherState(), - child: InheritedTextControllers( - textControllers: const [], - child: InheritedNumberSwitcher( - numberSwitcherState: state, - child: const SizePicker( - isInOtherPage: true, - ), - ), - ), - ), - ); - } - - testWidgets('SizePicker - 1x1 matrix', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 60)); - - await tester.pumpWidget( - mockSliderForGolder(), - ); - await expectLater( - find.byType(SizePicker), - matchesGoldenFile('goldens/size_picker_1.png'), - ); - }); - - testWidgets('SizePicker - 2x2 matrix', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 60)); - - await tester.pumpWidget( - mockSliderForGolder( - matrixSize: 2, - ), - ); - await expectLater( - find.byType(SizePicker), - matchesGoldenFile('goldens/size_picker_2.png'), - ); - }); - - testWidgets('SizePicker - 3x3 matrix', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 60)); - - await tester.pumpWidget( - mockSliderForGolder( - matrixSize: 3, - ), - ); - await expectLater( - find.byType(SizePicker), - matchesGoldenFile('goldens/size_picker_3.png'), - ); - }); - - testWidgets('SizePicker - 4x4 matrix', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 60)); - - await tester.pumpWidget( - mockSliderForGolder( - matrixSize: 4, - ), - ); - await expectLater( - find.byType(SizePicker), - matchesGoldenFile('goldens/size_picker_4.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/utils/sor_relaxation_factor_test.dart b/example/flutter_example/test/routes/system_page/utils/sor_relaxation_factor_test.dart deleted file mode 100644 index 988a1fcb..00000000 --- a/example/flutter_example/test/routes/system_page/utils/sor_relaxation_factor_test.dart +++ /dev/null @@ -1,66 +0,0 @@ -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_data_input.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:equations_solver/routes/system_page/utils/sor_relaxation_factor.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../system_mock.dart'; - -void main() { - group("Testing the 'RelaxationFactorInput' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.sor.asString, - child: const SingleChildScrollView( - child: SystemDataInput(), - ), - ), - ); - - expect(find.byType(RelaxationFactorInput), findsOneWidget); - expect( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - findsOneWidget, - ); - }); - - testWidgets( - 'Making sure that the widget does NOT show an input field ' - "when the system solving algorithm isn't SOR", - (tester) async { - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.factorization, - dropdownValue: SystemDropdownItems.lu.asString, - child: const SingleChildScrollView( - child: SystemDataInput(), - ), - ), - ); - - expect(find.byType(RelaxationFactorInput), findsNothing); - }, - ); - }); - - group('Golden tests - RelaxationFactorInput', () { - testWidgets('RelaxationFactorInput', (tester) async { - await tester.binding.setSurfaceSize(const Size(140, 140)); - - await tester.pumpWidget( - MockSystemWidget( - systemType: SystemType.iterative, - dropdownValue: SystemDropdownItems.sor.asString, - child: const RelaxationFactorInput(), - ), - ); - await expectLater( - find.byType(RelaxationFactorInput), - matchesGoldenFile('goldens/relaxation_factor_input.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page/utils/vector_input_test.dart b/example/flutter_example/test/routes/system_page/utils/vector_input_test.dart deleted file mode 100644 index 0845e9a5..00000000 --- a/example/flutter_example/test/routes/system_page/utils/vector_input_test.dart +++ /dev/null @@ -1,111 +0,0 @@ -import 'package:equations_solver/routes/system_page/system_input_field.dart'; -import 'package:equations_solver/routes/system_page/utils/vector_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'VectorInput' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: VectorInput( - vectorControllers: [ - TextEditingController(), - TextEditingController(), - ], - vectorSize: 2, - ), - ), - ); - - expect(find.byType(VectorInput), findsOneWidget); - expect(find.byType(SystemInputField), findsNWidgets(2)); - }); - }); - - group('Golden tests - VectorInput', () { - testWidgets('VectorInput - 1', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 150)); - - await tester.pumpWidget( - MockWrapper( - child: VectorInput( - vectorControllers: [ - TextEditingController(text: '1'), - ], - vectorSize: 1, - ), - ), - ); - await expectLater( - find.byType(VectorInput), - matchesGoldenFile('goldens/vector_input_1.png'), - ); - }); - - testWidgets('VectorInput - 2', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 200)); - - await tester.pumpWidget( - MockWrapper( - child: VectorInput( - vectorControllers: [ - TextEditingController(text: '1'), - TextEditingController(text: '2'), - ], - vectorSize: 2, - ), - ), - ); - await expectLater( - find.byType(VectorInput), - matchesGoldenFile('goldens/vector_input_2.png'), - ); - }); - - testWidgets('VectorInput - 3', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 250)); - - await tester.pumpWidget( - MockWrapper( - child: VectorInput( - vectorControllers: [ - TextEditingController(text: '1'), - TextEditingController(text: '2'), - TextEditingController(text: '3'), - ], - vectorSize: 3, - ), - ), - ); - await expectLater( - find.byType(VectorInput), - matchesGoldenFile('goldens/vector_input_3.png'), - ); - }); - - testWidgets('VectorInput - 4', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 300)); - - await tester.pumpWidget( - MockWrapper( - child: VectorInput( - vectorControllers: [ - TextEditingController(text: '1'), - TextEditingController(text: '2'), - TextEditingController(text: '3'), - TextEditingController(text: '4'), - ], - vectorSize: 4, - ), - ), - ); - await expectLater( - find.byType(VectorInput), - matchesGoldenFile('goldens/vector_input_4.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/system_page_test.dart b/example/flutter_example/test/routes/system_page_test.dart deleted file mode 100644 index d26ee53e..00000000 --- a/example/flutter_example/test/routes/system_page_test.dart +++ /dev/null @@ -1,273 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes/system_page.dart'; -import 'package:equations_solver/routes/system_page/model/system_state.dart'; -import 'package:equations_solver/routes/system_page/system_body.dart'; -import 'package:equations_solver/routes/system_page/utils/dropdown_selection.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import 'mock_wrapper.dart'; -import 'system_page/system_mock.dart'; - -void main() { - group("Testing the 'SystemPage' widget", () { - testWidgets('Making sure that the widget is rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SystemPage(), - ), - ); - - expect(find.byType(SystemBody), findsOneWidget); - expect(find.byType(SystemPage), findsOneWidget); - }); - - testWidgets('Making sure that pages can be changed', (tester) async { - var rowReduction = ''; - var factorization = ''; - var iterative = ''; - - // There will always be 1 string matching the name because of the bottom - // navigation bar. To make sure we're on a certain page, we need to check - // whether 2 text are present (one on the bottom bar AND one at the top - // of the newly opened page). - await tester.pumpWidget( - MockWrapper( - child: Builder( - builder: (context) { - rowReduction = context.l10n.row_reduction; - factorization = context.l10n.factorization; - iterative = context.l10n.iterative; - - return const SystemPage(); - }, - ), - ), - ); - - // Iterative page - await tester.tap(find.text(iterative)); - await tester.pumpAndSettle(); - expect(find.text(rowReduction), findsOneWidget); - expect(find.text(factorization), findsOneWidget); - expect(find.text(iterative), findsNWidgets(2)); - - // Row reduction page - await tester.tap(find.text(rowReduction)); - await tester.pumpAndSettle(); - expect(find.text(rowReduction), findsNWidgets(2)); - expect(find.text(factorization), findsOneWidget); - expect(find.text(iterative), findsOneWidget); - - // Factorization page - await tester.tap(find.text(factorization)); - await tester.pumpAndSettle(); - expect(find.text(rowReduction), findsOneWidget); - expect(find.text(factorization), findsNWidgets(2)); - expect(find.text(iterative), findsOneWidget); - }); - }); - - group('Golden tests - SystemBody', () { - Future createSingularMatrix( - WidgetTester tester, { - SystemType systemType = SystemType.rowReduction, - }) async { - await tester.tap(find.byKey(const Key('SizePicker-Forward-Button'))); - await tester.pumpAndSettle(); - - // Fill the matrix - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('SystemEntry-0-1')), '2'); - await tester.enterText(find.byKey(const Key('SystemEntry-1-0')), '2'); - await tester.enterText(find.byKey(const Key('SystemEntry-1-1')), '4'); - - // Fills the vector - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-1')), '2'); - - final solveButton = find.byKey(const Key('System-button-solve')); - - if (systemType == SystemType.iterative) { - await tester.enterText( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - '1', - ); - await tester.pumpAndSettle(); - } - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - } - - Future solveSystem( - WidgetTester tester, { - SystemType systemType = SystemType.rowReduction, - }) async { - await tester.enterText(find.byKey(const Key('SystemEntry-0-0')), '1'); - await tester.enterText(find.byKey(const Key('VectorEntry-0')), '1'); - - if (systemType == SystemType.iterative) { - await tester.enterText( - find.byKey(const Key('SystemSolver-Iterative-RelaxationFactor')), - '1', - ); - await tester.pumpAndSettle(); - } - - final solveButton = find.byKey(const Key('System-button-solve')); - - // Solving the equation - await tester.tap(solveButton); - await tester.pumpAndSettle(); - } - - testWidgets('SystemBody - row reduction', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 900)); - - await tester.pumpWidget( - const MockSystemWidget(), - ); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_rowreduction.png'), - ); - }); - - testWidgets('SystemBody - row reduction with solution', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 900)); - - await tester.pumpWidget( - const MockSystemWidget(), - ); - - await solveSystem(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_rowreduction_solution.png'), - ); - }); - - testWidgets('SystemBody - row reduction (singular matrix)', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 950)); - - await tester.pumpWidget( - const MockSystemWidget(), - ); - - await createSingularMatrix(tester); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_rowreduction_singular.png'), - ); - }); - - testWidgets('SystemBody - factorization', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 900)); - - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.lu.asString, - systemType: SystemType.factorization, - ), - ); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_factorization.png'), - ); - }); - - testWidgets('SystemBody - factorization with solution', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 950)); - - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.lu.asString, - systemType: SystemType.factorization, - ), - ); - - await solveSystem(tester, systemType: SystemType.factorization); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_factorization_solution.png'), - ); - }); - - testWidgets('SystemBody - factorization (singular matrix)', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 1050)); - - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.lu.asString, - systemType: SystemType.factorization, - ), - ); - - await createSingularMatrix(tester, systemType: SystemType.factorization); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_factorization_singular.png'), - ); - }); - - testWidgets('SystemBody - iterative', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 1050)); - - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.sor.asString, - systemType: SystemType.iterative, - ), - ); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_iterative.png'), - ); - }); - - testWidgets('SystemBody - iterative with solution', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 1100)); - - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.sor.asString, - systemType: SystemType.iterative, - ), - ); - - await solveSystem(tester, systemType: SystemType.iterative); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_iterative_solution.png'), - ); - }); - - testWidgets('SystemBody - iterative (singular matrix)', (tester) async { - await tester.binding.setSurfaceSize(const Size(420, 1150)); - - await tester.pumpWidget( - MockSystemWidget( - dropdownValue: SystemDropdownItems.sor.asString, - systemType: SystemType.iterative, - ), - ); - - await createSingularMatrix(tester, systemType: SystemType.iterative); - - await expectLater( - find.byType(Scaffold), - matchesGoldenFile('goldens/system_body_iterative_singular.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/app_logo_test.dart b/example/flutter_example/test/routes/utils/app_logo_test.dart deleted file mode 100644 index b38ea8bf..00000000 --- a/example/flutter_example/test/routes/utils/app_logo_test.dart +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:equations_solver/routes/utils/app_logo.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_svg/flutter_svg.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'AppLogo' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget(const MockWrapper(child: AppLogo())); - - expect(find.byType(AppLogo), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }); - }); - - group('Golden tests - AppLogo', () { - testWidgets('AppLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size(90, 90)); - - await tester.pumpWidget( - const MockWrapper( - child: AppLogo(), - ), - ); - await expectLater( - find.byType(AppLogo), - matchesGoldenFile('goldens/app_logo.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/body_pages/equation_text_formatter_test.dart b/example/flutter_example/test/routes/utils/body_pages/equation_text_formatter_test.dart deleted file mode 100644 index d20913d7..00000000 --- a/example/flutter_example/test/routes/utils/body_pages/equation_text_formatter_test.dart +++ /dev/null @@ -1,46 +0,0 @@ -import 'package:equations_solver/routes/utils/body_pages/equation_text_formatter.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'EquationTextFormatter' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: Scaffold( - body: EquationTextFormatter( - equation: 'x^2 - 5', - ), - ), - ), - ); - - expect(find.byType(EquationTextFormatter), findsOneWidget); - expect(find.byType(RichText), findsOneWidget); - }); - }); - - group('Golden tests - EquationTextFormatter', () { - testWidgets('EquationTextFormatter', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 80)); - - await tester.pumpWidget( - const MockWrapper( - child: SizedBox( - width: 200, - height: 100, - child: EquationTextFormatter( - equation: 'x^2 - 5', - ), - ), - ), - ); - await expectLater( - find.byType(EquationTextFormatter), - matchesGoldenFile('goldens/equation_text_formatter.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/body_pages/go_back_button_test.dart b/example/flutter_example/test/routes/utils/body_pages/go_back_button_test.dart deleted file mode 100644 index 059fa1c8..00000000 --- a/example/flutter_example/test/routes/utils/body_pages/go_back_button_test.dart +++ /dev/null @@ -1,82 +0,0 @@ -import 'package:equations_solver/routes/home_page.dart'; -import 'package:equations_solver/routes/polynomial_page.dart'; -import 'package:equations_solver/routes/utils/body_pages/go_back_button.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'GoBackButton' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: Scaffold( - body: GoBackButton(), - ), - ), - ); - - expect(find.byType(GoBackButton), findsOneWidget); - expect(find.byType(IconButton), findsOneWidget); - }); - - testWidgets('Making sure that the button can be tapped', (tester) async { - await tester.pumpWidget( - const MockWrapperWithNavigator(), - ); - - // Opening a page - await tester.tap(find.byKey(const Key('PolynomialLogo-Container'))); - await tester.pumpAndSettle(); - expect(find.byType(PolynomialPage), findsOneWidget); - - // Going back - await tester.tap(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - expect(find.byType(HomePage), findsOneWidget); - }); - }); - - group('Golden tests - EquationTextFormatter', () { - testWidgets('GoBackButton', (tester) async { - await tester.binding.setSurfaceSize(const Size(100, 100)); - - await tester.pumpWidget( - const MockWrapper( - child: SizedBox( - width: 90, - height: 90, - child: GoBackButton(), - ), - ), - ); - await expectLater( - find.byType(GoBackButton), - matchesGoldenFile('goldens/go_back_button.png'), - ); - }); - - testWidgets('GoBackButton', (tester) async { - await tester.binding.setSurfaceSize(const Size(100, 100)); - - await tester.pumpWidget( - const MockWrapper( - child: SizedBox( - width: 90, - height: 90, - child: GoBackButton(), - ), - ), - ); - - await tester.press(find.byType(GoBackButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(GoBackButton), - matchesGoldenFile('goldens/go_back_button_pressed.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/body_pages/goldens/equation_text_formatter.png b/example/flutter_example/test/routes/utils/body_pages/goldens/equation_text_formatter.png deleted file mode 100644 index f79b7743..00000000 Binary files a/example/flutter_example/test/routes/utils/body_pages/goldens/equation_text_formatter.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/body_pages/goldens/go_back_button.png b/example/flutter_example/test/routes/utils/body_pages/goldens/go_back_button.png deleted file mode 100644 index ba356350..00000000 Binary files a/example/flutter_example/test/routes/utils/body_pages/goldens/go_back_button.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/body_pages/goldens/go_back_button_pressed.png b/example/flutter_example/test/routes/utils/body_pages/goldens/go_back_button_pressed.png deleted file mode 100644 index cb6a1795..00000000 Binary files a/example/flutter_example/test/routes/utils/body_pages/goldens/go_back_button_pressed.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/body_pages/goldens/page_title.png b/example/flutter_example/test/routes/utils/body_pages/goldens/page_title.png deleted file mode 100644 index 6b72e77a..00000000 Binary files a/example/flutter_example/test/routes/utils/body_pages/goldens/page_title.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/body_pages/page_title_test.dart b/example/flutter_example/test/routes/utils/body_pages/page_title_test.dart deleted file mode 100644 index 700b9a6c..00000000 --- a/example/flutter_example/test/routes/utils/body_pages/page_title_test.dart +++ /dev/null @@ -1,45 +0,0 @@ -import 'package:equations_solver/routes/utils/body_pages/page_title.dart'; -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'PageTitle' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: Scaffold( - body: PageTitle( - pageLogo: PolynomialLogo(), - pageTitle: 'Demo title', - ), - ), - ), - ); - - expect(find.byType(PageTitle), findsOneWidget); - expect(find.text('Demo title'), findsOneWidget); - }); - }); - - group('Golden tests - PageTitle', () { - testWidgets('PageTitle', (tester) async { - await tester.binding.setSurfaceSize(const Size(340, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: PageTitle( - pageLogo: PolynomialLogo(), - pageTitle: 'Demo title', - ), - ), - ); - await expectLater( - find.byType(PageTitle), - matchesGoldenFile('goldens/page_title.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/breakpoints_test.dart b/example/flutter_example/test/routes/utils/breakpoints_test.dart deleted file mode 100644 index 82205fb5..00000000 --- a/example/flutter_example/test/routes/utils/breakpoints_test.dart +++ /dev/null @@ -1,28 +0,0 @@ -import 'package:equations_solver/routes/utils/breakpoints.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group('Testing breakpoints', () { - test('Smoke test', () { - expect(bottomNavigationBreakpoint, equals(950.0)); - expect(extraBackgroundBreakpoint, equals(1300.0)); - expect(doubleColumnPageBreakpoint, equals(1100.0)); - expect(maxWidthPlot, equals(600.0)); - expect(matricesPageColumnWidth, equals(cardWidgetsWidth + 30 * 2)); - expect(complexNumbersPageColumnWidth, equals(cardWidgetsWidth + 30 * 2)); - expect(cardWidgetsWidth, equals(275.0)); - expect(resultCardPrecisionDigits, equals(5)); - expect(collapsibleInnerSpacing, equals(16.0)); - expect(polynomialInputFieldWidth, equals(70.0)); - expect(nonlinearDropdownWidth, equals(200.0)); - expect(systemDropdownWidth, equals(250.0)); - expect(integralDropdownWidth, equals(200.0)); - expect(precisonSliderWidth, equals(300.0)); - expect(systemInputFieldSize, equals(60.0)); - expect(nonlinearValuesWidth, equals(80.0)); - expect(integrationBoundsWidth, equals(80.0)); - expect(complexInputWidth, equals(65.0)); - expect(matrixOutputWidth, equals(70.0)); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/collapsible_test.dart b/example/flutter_example/test/routes/utils/collapsible_test.dart deleted file mode 100644 index 1bae924e..00000000 --- a/example/flutter_example/test/routes/utils/collapsible_test.dart +++ /dev/null @@ -1,94 +0,0 @@ -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'Collapsible' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: Collapsible( - primary: Text('Primary'), - secondary: Text('Secondary'), - ), - ), - ); - - expect(find.byType(Collapsible), findsOneWidget); - expect(find.byType(IconButton), findsOneWidget); - expect(find.text('Primary'), findsOneWidget); - expect(find.text('Secondary'), findsOneWidget); - }); - - testWidgets('Making sure that expansion works', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: Collapsible( - primary: Text('Primary'), - secondary: Text('Secondary'), - ), - ), - ); - - final transitionFinder = find.byType(SizeTransition); - - expect(find.byType(Collapsible), findsOneWidget); - expect(find.byType(IconButton), findsOneWidget); - expect( - tester.widget(transitionFinder).sizeFactor.value, - isZero, - ); - - // Expanding - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - expect( - tester.widget(transitionFinder).sizeFactor.value, - equals(1), - ); - }); - }); - - group('Golden tests - Collapsible', () { - testWidgets('Collapsible - collapsed', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 100)); - - await tester.pumpWidget( - const MockWrapper( - child: Collapsible( - primary: Text('Primary'), - secondary: Text('Secondary'), - ), - ), - ); - await expectLater( - find.byType(Collapsible), - matchesGoldenFile('goldens/collapsible_collapsed.png'), - ); - }); - - testWidgets('Collapsible - expanded', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Collapsible( - primary: Text('Primary'), - secondary: Text('Secondary'), - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(Collapsible), - matchesGoldenFile('goldens/collapsible_expanded.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/color_area_test.dart b/example/flutter_example/test/routes/utils/color_area_test.dart deleted file mode 100644 index e90d1075..00000000 --- a/example/flutter_example/test/routes/utils/color_area_test.dart +++ /dev/null @@ -1,76 +0,0 @@ -import 'package:equations_solver/routes/utils/plot_widget/color_area.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'ColorArea' class", () { - test('Making sure that default values are correct', () { - const obj = ColorArea( - startPoint: 6, - endPoint: 19, - ); - - expect(obj.color, equals(Colors.transparent)); - expect(obj.startPoint, equals(6)); - expect(obj.endPoint, equals(19)); - - expect('$obj', equals('Color(0x00000000) from 6.00 to 19.00')); - }); - - test('Making sure that a custom color can be set', () { - const obj = ColorArea( - startPoint: -1, - endPoint: 2, - color: Colors.red, - ); - - expect(obj.color, equals(Colors.red)); - expect(obj.startPoint, equals(-1)); - expect(obj.endPoint, equals(2)); - }); - - test('Making sure that instances can be properly compared.', () { - const colorArea = ColorArea( - startPoint: 6, - endPoint: 19, - ); - - expect( - colorArea == - const ColorArea( - startPoint: 6, - endPoint: 19, - ), - isTrue, - ); - - expect( - colorArea.hashCode, - equals( - const ColorArea( - startPoint: 6, - endPoint: 19, - ).hashCode, - ), - ); - - expect( - colorArea == - const ColorArea( - startPoint: -6, - endPoint: 19, - ), - isFalse, - ); - expect( - colorArea == - const ColorArea( - startPoint: 6, - endPoint: 19, - color: Colors.orange, - ), - isFalse, - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_input_test.dart b/example/flutter_example/test/routes/utils/equation_input_test.dart deleted file mode 100644 index b5428c65..00000000 --- a/example/flutter_example/test/routes/utils/equation_input_test.dart +++ /dev/null @@ -1,43 +0,0 @@ -import 'package:equations_solver/routes/utils/equation_input.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'EquationInput' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: EquationInput( - controller: TextEditingController(), - placeholderText: 'Demo', - ), - ), - ); - - expect(find.byType(EquationInput), findsOneWidget); - expect(find.byType(TextFormField), findsOneWidget); - }); - }); - - group('Golden tests - EquationInput', () { - testWidgets('EquationInput', (tester) async { - await tester.binding.setSurfaceSize(const Size(160, 90)); - - await tester.pumpWidget( - MockWrapper( - child: EquationInput( - controller: TextEditingController(), - placeholderText: 'Demo', - baseWidth: 150, - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/equation_input.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/bottom_navigation_bar_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/bottom_navigation_bar_test.dart deleted file mode 100644 index 65528ab8..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/bottom_navigation_bar_test.dart +++ /dev/null @@ -1,75 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/bottom_navigation_bar.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'BottomNavigation' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [], - navigationIndex: ValueNotifier(0), - child: const BottomNavigation( - navigationItems: [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - ), - ), - ), - ); - - final finder = find.byType(BottomNavigation); - expect(finder, findsOneWidget); - - final bottomNavigation = tester.widget(finder) as BottomNavigation; - expect(bottomNavigation.navigationItems.length, equals(2)); - }); - }); - - group('Golden tests - BottomNavigation', () { - testWidgets('BottomNavigation', (tester) async { - await tester.binding.setSurfaceSize(const Size(350, 80)); - - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [], - navigationIndex: ValueNotifier(0), - child: const BottomNavigation( - navigationItems: [ - NavigationItem( - title: 'Test 1', - content: Text('Page 1'), - ), - NavigationItem( - title: 'Test 2', - content: Text('Page 2'), - ), - ], - ), - ), - ), - ); - await expectLater( - find.byType(BottomNavigation), - matchesGoldenFile('goldens/bottom_navigation.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/bottom_navigation_widget_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/bottom_navigation_widget_test.dart deleted file mode 100644 index 4e5227b1..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/bottom_navigation_widget_test.dart +++ /dev/null @@ -1,71 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/bottom_navigation_bar.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/bottom_navigation_widget.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/tabbed_layout.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'BottomNavigationWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: ValueNotifier(0), - child: const BottomNavigationWidget(), - ), - ), - ); - - final finder = find.byType(BottomNavigation); - expect(finder, findsOneWidget); - - final bottomNavigation = tester.widget(finder) as BottomNavigation; - expect(bottomNavigation.navigationItems.length, equals(2)); - - expect(find.byType(TabbedNavigationLayout), findsOneWidget); - expect(find.byType(BottomNavigation), findsOneWidget); - expect(find.byType(FloatingActionButton), findsNothing); - }); - }); - - group('Golden tests - BottomNavigationWidget', () { - testWidgets('BottomNavigationWidget', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 500)); - - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: ValueNotifier(0), - child: const BottomNavigationWidget(), - ), - ), - ); - await expectLater( - find.byType(BottomNavigation), - matchesGoldenFile('goldens/bottom_navigation_widget.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/bottom_navigation.png b/example/flutter_example/test/routes/utils/equation_scaffold/goldens/bottom_navigation.png deleted file mode 100644 index 827207d4..00000000 Binary files a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/bottom_navigation.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/bottom_navigation_widget.png b/example/flutter_example/test/routes/utils/equation_scaffold/goldens/bottom_navigation_widget.png deleted file mode 100644 index 5510461b..00000000 Binary files a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/bottom_navigation_widget.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/rail_navigation.png b/example/flutter_example/test/routes/utils/equation_scaffold/goldens/rail_navigation.png deleted file mode 100644 index 35b8ff1a..00000000 Binary files a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/rail_navigation.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/rail_navigation_widget.png b/example/flutter_example/test/routes/utils/equation_scaffold/goldens/rail_navigation_widget.png deleted file mode 100644 index 4cef0d5b..00000000 Binary files a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/rail_navigation_widget.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/scaffold_contents.png b/example/flutter_example/test/routes/utils/equation_scaffold/goldens/scaffold_contents.png deleted file mode 100644 index 9366d48a..00000000 Binary files a/example/flutter_example/test/routes/utils/equation_scaffold/goldens/scaffold_contents.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/navigation_item_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/navigation_item_test.dart deleted file mode 100644 index 1b19f3a1..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/navigation_item_test.dart +++ /dev/null @@ -1,94 +0,0 @@ -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'NavigationItem' widget", () { - testWidgets('Making sure that default values are correct', (tester) async { - const navigationItem = NavigationItem( - title: 'Item title', - content: SizedBox(), - ); - - expect(navigationItem.title, equals('Item title')); - expect(navigationItem.content, isA()); - expect(navigationItem.icon, isA()); - expect(navigationItem.activeIcon, isA()); - }); - - testWidgets( - 'Making sure that objects can correctly be compared', - (tester) async { - const child = SizedBox(); - const navigationItem = NavigationItem( - title: 'Item title', - content: child, - ); - - expect( - const NavigationItem( - title: 'Item title', - content: child, - ), - equals(navigationItem), - ); - - expect( - navigationItem, - equals( - const NavigationItem( - title: 'Item title', - content: child, - ), - ), - ); - - expect( - const NavigationItem( - title: 'Item title', - content: child, - ) == - navigationItem, - isTrue, - ); - - expect( - navigationItem == - const NavigationItem( - title: 'Item title', - content: child, - ), - isTrue, - ); - - expect( - navigationItem == - const NavigationItem( - title: 'Item title', - content: SizedBox(), - ), - isFalse, - ); - - expect( - navigationItem == - const NavigationItem( - title: 'Item', - content: SizedBox(), - ), - isFalse, - ); - - expect( - navigationItem.hashCode, - equals( - const NavigationItem( - title: 'Item title', - content: child, - ).hashCode, - ), - ); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/rail_navigation_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/rail_navigation_test.dart deleted file mode 100644 index 4530e5bc..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/rail_navigation_test.dart +++ /dev/null @@ -1,101 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/rail_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/tabbed_layout.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'RailNavigation' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: ValueNotifier(0), - child: const RailNavigation(), - ), - ), - ); - - final finder = find.byType(RailNavigation); - expect(finder, findsOneWidget); - - expect(find.byType(TabbedNavigationLayout), findsOneWidget); - expect(find.byType(NavigationRail), findsOneWidget); - expect(find.byType(VerticalDivider), findsOneWidget); - }); - - testWidgets('Making sure that routes can be changed', (tester) async { - final navigationIndex = ValueNotifier(0); - - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: navigationIndex, - child: const RailNavigation(), - ), - ), - ); - - expect(navigationIndex.value, isZero); - - await tester.tap(find.text('Test 2')); - await tester.pumpAndSettle(); - - expect(navigationIndex.value, equals(1)); - }); - }); - - group('Golden tests - RailNavigation', () { - testWidgets('RailNavigation', (tester) async { - await tester.binding.setSurfaceSize(const Size(120, 350)); - - await tester.pumpWidget( - SizedBox( - width: 200, - height: 400, - child: MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: ValueNotifier(0), - child: const RailNavigation(), - ), - ), - ), - ); - - await expectLater( - find.byType(RailNavigation), - matchesGoldenFile('goldens/rail_navigation.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/rail_navigation_widget_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/rail_navigation_widget_test.dart deleted file mode 100644 index ad390cad..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/rail_navigation_widget_test.dart +++ /dev/null @@ -1,68 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/rail_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/rail_navigation_widget.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/tabbed_layout.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'RailNavigationWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: ValueNotifier(0), - child: const RailNavigationWidget(), - ), - ), - ); - - final finder = find.byType(RailNavigation); - expect(finder, findsOneWidget); - - expect(find.byType(TabbedNavigationLayout), findsOneWidget); - expect(find.byType(RailNavigation), findsOneWidget); - expect(find.byType(FloatingActionButton), findsNothing); - }); - }); - - group('Golden tests - RailNavigationWidget', () { - testWidgets('RailNavigationWidget', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 500)); - - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: TabController( - length: 2, - vsync: const TestVSync(), - ), - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: SizedBox()), - NavigationItem(title: 'Test 2', content: SizedBox()), - ], - navigationIndex: ValueNotifier(0), - child: const RailNavigationWidget(), - ), - ), - ); - await expectLater( - find.byType(RailNavigationWidget), - matchesGoldenFile('goldens/rail_navigation_widget.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/scaffold_contents_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/scaffold_contents_test.dart deleted file mode 100644 index dffc33a0..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/scaffold_contents_test.dart +++ /dev/null @@ -1,46 +0,0 @@ -import 'package:equations_solver/routes/utils/equation_scaffold/scaffold_contents.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_svg/flutter_svg.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'RailNavigationWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ScaffoldContents( - body: SizedBox.shrink( - key: Key('test'), - ), - ), - ), - ); - - expect(find.byType(ScaffoldContents), findsOneWidget); - expect(find.byKey(const Key('test')), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }); - }); - - group('Golden tests - ScaffoldContents', () { - testWidgets('ScaffoldContents', (tester) async { - await tester.binding.setSurfaceSize(const Size(500, 500)); - - await tester.pumpWidget( - const MockWrapper( - child: ScaffoldContents( - body: Center( - child: Text('ScaffoldContents'), - ), - ), - ), - ); - await expectLater( - find.byType(ScaffoldContents), - matchesGoldenFile('goldens/scaffold_contents.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold/tabbed_navigation_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold/tabbed_navigation_test.dart deleted file mode 100644 index beeb8049..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold/tabbed_navigation_test.dart +++ /dev/null @@ -1,154 +0,0 @@ -import 'package:equations_solver/routes/models/inherited_navigation/inherited_navigation.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/tabbed_layout.dart'; -import 'package:flutter/foundation.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - late final TabController controller; - - setUpAll(() { - controller = TabController( - length: 2, - vsync: const TestVSync(), - ); - }); - - group("Testing the 'TabbedNavigationLayout' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: controller, - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: Text('A')), - NavigationItem(title: 'Test 2', content: Text('B')), - ], - navigationIndex: ValueNotifier(0), - child: const TabbedNavigationLayout(), - ), - ), - ); - - final finder = find.byType(TabbedNavigationLayout); - expect(finder, findsOneWidget); - - expect(find.byType(TabbedNavigationLayout), findsOneWidget); - expect(find.byType(TabBarView), findsOneWidget); - }); - - testWidgets( - 'Making sure that tabs can be changed with a controller', - (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: controller, - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: Text('A')), - NavigationItem(title: 'Test 2', content: Text('B')), - ], - navigationIndex: ValueNotifier(0), - child: const TabbedNavigationLayout(), - ), - ), - ); - - final finder = find.byType(TabbedNavigationLayout); - final state = tester.state(finder) as TabbedNavigationLayoutState; - - // Start at 0 - expect(controller.index, isZero); - expect(find.text('A'), findsOneWidget); - expect(find.text('B'), findsNothing); - - // Changing the page - state.changePage(1); - await tester.pumpAndSettle(); - - expect(controller.index, equals(1)); - expect(find.text('B'), findsOneWidget); - expect(find.text('A'), findsNothing); - }, - ); - - // Tests the scroll physics of a TabBarView widget on the given platform. - Future testSwipeOnPlatforms({ - required WidgetTester tester, - required TargetPlatform platform, - required bool shouldSwipe, - }) async { - debugDefaultTargetPlatformOverride = platform; - - try { - await tester.pumpWidget( - MockWrapper( - child: InheritedNavigation( - tabController: controller, - fab: null, - navigationItems: const [ - NavigationItem(title: 'Test 1', content: Text('A')), - NavigationItem(title: 'Test 2', content: Text('B')), - ], - navigationIndex: ValueNotifier(0), - child: const TabbedNavigationLayout(), - ), - ), - ); - - await tester.pumpAndSettle(); - - final finder = find.byType(TabBarView); - final physics = tester.widget(finder).physics; - - if (shouldSwipe) { - expect(physics, isNull); - } else { - expect(physics, isNotNull); - } - } finally { - debugDefaultTargetPlatformOverride = null; - } - } - - testWidgets( - 'Making sure tabs can only be swiped on mobile devices', - (tester) async { - await testSwipeOnPlatforms( - tester: tester, - platform: TargetPlatform.android, - shouldSwipe: true, - ); - - await testSwipeOnPlatforms( - tester: tester, - platform: TargetPlatform.iOS, - shouldSwipe: true, - ); - - await testSwipeOnPlatforms( - tester: tester, - platform: TargetPlatform.fuchsia, - shouldSwipe: true, - ); - - await testSwipeOnPlatforms( - tester: tester, - platform: TargetPlatform.macOS, - shouldSwipe: false, - ); - - await testSwipeOnPlatforms( - tester: tester, - platform: TargetPlatform.windows, - shouldSwipe: false, - ); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/utils/equation_scaffold_test.dart b/example/flutter_example/test/routes/utils/equation_scaffold_test.dart deleted file mode 100644 index e51cdb00..00000000 --- a/example/flutter_example/test/routes/utils/equation_scaffold_test.dart +++ /dev/null @@ -1,118 +0,0 @@ -import 'package:equations_solver/routes/utils/equation_scaffold.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/navigation_item.dart'; -import 'package:equations_solver/routes/utils/equation_scaffold/rail_navigation.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - late final List navigationItems; - - setUpAll(() { - navigationItems = const [ - NavigationItem( - title: 'Test', - content: SizedBox(), - ), - NavigationItem( - title: 'Test', - content: SizedBox(), - ), - ]; - }); - - group("Testing the 'EquationScaffold' widget", () { - testWidgets( - 'Making sure that the scaffold can be rendered', - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: EquationScaffold( - body: SizedBox(), - ), - ), - ); - - expect(find.byKey(const Key('ScaffoldBackground')), findsOneWidget); - expect(find.byKey(const Key('ScaffoldExtraBackground')), findsNothing); - - final finder = find.byType(EquationScaffold); - expect(finder, findsOneWidget); - - final scaffold = tester.firstWidget(finder) as EquationScaffold; - expect(scaffold.body, isNotNull); - expect(scaffold.fab, isNull); - expect(scaffold.navigationItems.length, isZero); - }, - ); - - testWidgets( - 'Making sure that the navigation scaffold can be rendered', - (tester) async { - await tester.pumpWidget( - MockWrapper( - child: EquationScaffold.navigation( - navigationItems: navigationItems, - ), - ), - ); - - expect(find.byKey(const Key('ScaffoldBackground')), findsOneWidget); - expect(find.byKey(const Key('ScaffoldExtraBackground')), findsNothing); - - expect(find.byType(RailNavigation), findsNothing); - expect( - find.byKey(const Key('TabbedNavigationLayout-Scaffold')), - findsOneWidget, - ); - - final finder = find.byType(EquationScaffold); - expect(finder, findsOneWidget); - - final scaffold = tester.firstWidget(finder) as EquationScaffold; - expect(scaffold.fab, isNull); - expect(scaffold.navigationItems.length, equals(2)); - }, - ); - - testWidgets( - 'Making sure that the rail navigation appears when the ' - 'screen is wide (web & desktop platforms)', - (tester) async { - await tester.binding.setSurfaceSize(const Size(4000, 4000)); - - await tester.pumpWidget( - MockWrapper( - child: EquationScaffold.navigation( - navigationItems: navigationItems, - ), - ), - ); - - expect( - find.byKey(const Key('ScaffoldBackground')), - findsOneWidget, - ); - expect(find.byType(RailNavigation), findsOneWidget); - expect( - find.byKey(const Key('TabbedNavigationLayout-Scaffold')), - findsNothing, - ); - }, - ); - - testWidgets( - 'Making sure that the navigation scaffold, when there are no ' - 'navigation items, throws an assertion error', - (tester) async { - expect( - () => EquationScaffold.navigation( - navigationItems: const [], - ), - throwsAssertionError, - ); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/utils/goldens/app_logo.png b/example/flutter_example/test/routes/utils/goldens/app_logo.png deleted file mode 100644 index 618014ea..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/app_logo.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/collapsible_collapsed.png b/example/flutter_example/test/routes/utils/goldens/collapsible_collapsed.png deleted file mode 100644 index 75a6784d..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/collapsible_collapsed.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/collapsible_expanded.png b/example/flutter_example/test/routes/utils/goldens/collapsible_expanded.png deleted file mode 100644 index d0259dfe..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/collapsible_expanded.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/equation_input.png b/example/flutter_example/test/routes/utils/goldens/equation_input.png deleted file mode 100644 index dc21cc42..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/equation_input.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/input_kind_button_equations_dialog.png b/example/flutter_example/test/routes/utils/goldens/input_kind_button_equations_dialog.png deleted file mode 100644 index f0b3d30e..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/input_kind_button_equations_dialog.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/input_kind_button_number_dialog.png b/example/flutter_example/test/routes/utils/goldens/input_kind_button_number_dialog.png deleted file mode 100644 index f1820761..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/input_kind_button_number_dialog.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/input_kind_button_pressed.png b/example/flutter_example/test/routes/utils/goldens/input_kind_button_pressed.png deleted file mode 100644 index 9bb8da5a..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/input_kind_button_pressed.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/no_results.png b/example/flutter_example/test/routes/utils/goldens/no_results.png deleted file mode 100644 index ddfe6257..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/no_results.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/goldens/section_title.png b/example/flutter_example/test/routes/utils/goldens/section_title.png deleted file mode 100644 index 08fecf24..00000000 Binary files a/example/flutter_example/test/routes/utils/goldens/section_title.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/input_kind_dialog_button_test.dart b/example/flutter_example/test/routes/utils/input_kind_dialog_button_test.dart deleted file mode 100644 index 2a7901f6..00000000 --- a/example/flutter_example/test/routes/utils/input_kind_dialog_button_test.dart +++ /dev/null @@ -1,156 +0,0 @@ -import 'package:equations_solver/routes/utils/input_kind_dialog_button.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'InputKindDialogButton' class", () { - test('InputKindMessage smoke test', () { - expect(InputKindMessage.values.length, equals(2)); - }); - - testWidgets('Smoke test', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - ); - - expect(find.byType(InputKindDialogButton), findsOneWidget); - expect(find.byType(IconButton), findsOneWidget); - }); - - testWidgets('Numeric input test', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - expect(find.byType(AlertDialog), findsOneWidget); - expect(find.text('OK'), findsOneWidget); - expect(find.byType(Card), findsNothing); - - expect(find.text('sqrt(x)'), findsNothing); - expect(find.text('sin(x)'), findsNothing); - expect(find.text('cos(x)'), findsNothing); - expect(find.text('tan(x)'), findsNothing); - expect(find.text('log(x)'), findsNothing); - expect(find.text('acos(x)'), findsNothing); - expect(find.text('asin(x)'), findsNothing); - expect(find.text('atan(x)'), findsNothing); - expect(find.text('csc(x)'), findsNothing); - expect(find.text('sec(x)'), findsNothing); - - // Close the dialog - await tester.tap(find.text('OK')); - await tester.pumpAndSettle(); - - expect(find.byType(AlertDialog), findsNothing); - }); - - testWidgets('Equations input test', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.equations, - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - expect(find.byType(AlertDialog), findsOneWidget); - expect(find.text('OK'), findsOneWidget); - expect(find.byType(Card), findsNWidgets(10)); - - expect(find.text('sqrt(x)'), findsOneWidget); - expect(find.text('sin(x)'), findsOneWidget); - expect(find.text('cos(x)'), findsOneWidget); - expect(find.text('tan(x)'), findsOneWidget); - expect(find.text('log(x)'), findsOneWidget); - expect(find.text('acos(x)'), findsOneWidget); - expect(find.text('asin(x)'), findsOneWidget); - expect(find.text('atan(x)'), findsOneWidget); - expect(find.text('csc(x)'), findsOneWidget); - expect(find.text('sec(x)'), findsOneWidget); - - // Close the dialog - await tester.tap(find.text('OK')); - await tester.pumpAndSettle(); - - expect(find.byType(AlertDialog), findsNothing); - }); - }); - - group('Golden tests - InputKindDialogButton', () { - testWidgets('InputKindDialogButton - pressed', (tester) async { - await tester.binding.setSurfaceSize(const Size(80, 80)); - - await tester.pumpWidget( - const MockWrapper( - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.equations, - ), - ), - ); - - await tester.press(find.byType(IconButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(IconButton), - matchesGoldenFile('goldens/input_kind_button_pressed.png'), - ); - }); - - testWidgets('InputKindDialogButton - numbers', (tester) async { - await tester.binding.setSurfaceSize(const Size(700, 500)); - - await tester.pumpWidget( - const MockWrapper( - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.numbers, - ), - ), - ); - - await tester.tap(find.byType(InputKindDialogButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(AlertDialog), - matchesGoldenFile('goldens/input_kind_button_number_dialog.png'), - ); - }); - - testWidgets('InputKindDialogButton - equations', (tester) async { - await tester.binding.setSurfaceSize(const Size(800, 600)); - - await tester.pumpWidget( - const MockWrapper( - child: InputKindDialogButton( - inputKindMessage: InputKindMessage.equations, - ), - ), - ); - - await tester.tap(find.byType(InputKindDialogButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(AlertDialog), - matchesGoldenFile('goldens/input_kind_button_equations_dialog.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/no_results_test.dart b/example/flutter_example/test/routes/utils/no_results_test.dart deleted file mode 100644 index 5c6677ba..00000000 --- a/example/flutter_example/test/routes/utils/no_results_test.dart +++ /dev/null @@ -1,37 +0,0 @@ -import 'package:equations_solver/routes/utils/no_results.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group("Testing the 'NoDiscriminant' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: NoResults(), - ), - ); - - expect(find.byType(NoResults), findsOneWidget); - expect(find.byType(Center), findsOneWidget); - expect(find.text('No solutions to display.'), findsOneWidget); - }); - }); - - group('Golden tests - NoResults', () { - testWidgets('NoResults', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 80)); - - await tester.pumpWidget( - const MockWrapper( - child: NoResults(), - ), - ); - await expectLater( - find.byType(NoResults), - matchesGoldenFile('goldens/no_results.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/plot_widget/color_area_test.dart b/example/flutter_example/test/routes/utils/plot_widget/color_area_test.dart deleted file mode 100644 index 4dde8fe8..00000000 --- a/example/flutter_example/test/routes/utils/plot_widget/color_area_test.dart +++ /dev/null @@ -1,85 +0,0 @@ -import 'package:equations_solver/routes/utils/plot_widget/color_area.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'ColorArea' class", () { - test('Making sure that default values are correct', () { - const colorArea = ColorArea( - startPoint: 1, - endPoint: 2, - ); - - expect(colorArea.startPoint, equals(1)); - expect(colorArea.endPoint, equals(2)); - expect(colorArea.color, equals(Colors.transparent)); - }); - - test('Making sure that object comparison works properly', () { - const colorArea = ColorArea( - startPoint: 3.6, - endPoint: 10, - color: Colors.blue, - ); - - expect( - colorArea, - equals( - const ColorArea( - startPoint: 3.6, - endPoint: 10, - color: Colors.blue, - ), - ), - ); - - expect( - const ColorArea( - startPoint: 3.6, - endPoint: 10, - color: Colors.blue, - ), - equals(colorArea), - ); - - expect( - colorArea.hashCode == - const ColorArea( - startPoint: 3.6, - endPoint: 10, - color: Colors.blue, - ).hashCode, - isTrue, - ); - - expect( - colorArea == - const ColorArea( - startPoint: 3.6, - endPoint: 10.1, - color: Colors.blue, - ), - isFalse, - ); - - expect( - colorArea == - const ColorArea( - startPoint: 3.6, - endPoint: 10, - color: Colors.red, - ), - isFalse, - ); - - expect( - colorArea == - const ColorArea( - startPoint: 3, - endPoint: 10, - ), - isFalse, - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/plot_widget/equation_drawer_widget_test.dart b/example/flutter_example/test/routes/utils/plot_widget/equation_drawer_widget_test.dart deleted file mode 100644 index 6349ec3a..00000000 --- a/example/flutter_example/test/routes/utils/plot_widget/equation_drawer_widget_test.dart +++ /dev/null @@ -1,103 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/models/plot_zoom/inherited_plot_zoom.dart'; -import 'package:equations_solver/routes/models/plot_zoom/plot_zoom_state.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_drawer_widget.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - late final Widget equationDrawerWidget; - - setUpAll(() { - equationDrawerWidget = Center( - child: SizedBox( - width: 300, - height: 400, - child: EquationDrawerWidget( - plotMode: PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 2, -3, -2]), - ), - ), - ), - ); - }); - - group("Testing the 'EquationDrawerWidget' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: equationDrawerWidget, - ), - ); - - expect(find.byType(Slider), findsOneWidget); - expect(find.byType(ClipRRect), findsOneWidget); - }); - }); - - group('Golden tests - EquationDrawerWidget', () { - testWidgets('EquationDrawerWidget', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 10, - initial: 4, - ), - child: SizedBox( - width: 500, - height: 580, - child: EquationDrawerWidget( - key: const Key('EquationDrawerWidget-Golden'), - plotMode: PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 2, -3, -2]), - ), - ), - ), - ), - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_drawer_widget.png'), - ); - }); - - testWidgets('EquationDrawerWidget - zoom', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: InheritedPlotZoom( - plotZoomState: PlotZoomState( - minValue: 1, - maxValue: 10, - initial: 4, - ), - child: SizedBox( - width: 500, - height: 580, - child: EquationDrawerWidget( - key: const Key('EquationDrawerWidget-Golden'), - plotMode: PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 2, -3, -2]), - ), - ), - ), - ), - ), - ); - - final slider = find.byType(Slider); - await tester.drag(slider, const Offset(80, 0)); - await tester.pumpAndSettle(); - - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_drawer_widget_zoom.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/plot_widget/equation_painter_test.dart b/example/flutter_example/test/routes/utils/plot_widget/equation_painter_test.dart deleted file mode 100644 index 1d0373f0..00000000 --- a/example/flutter_example/test/routes/utils/plot_widget/equation_painter_test.dart +++ /dev/null @@ -1,231 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/plot_widget/color_area.dart'; -import 'package:equations_solver/routes/utils/plot_widget/equation_painter.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - Widget buildPolynomialPainter({ - int range = 5, - ColorArea colorArea = const ColorArea( - startPoint: 5, - endPoint: 5, - ), - List coefficients = const [1, 2, -3, -2], - }) { - return MockWrapper( - child: ClipRRect( - borderRadius: const BorderRadius.all(Radius.circular(10)), - child: Card( - color: Colors.white, - clipBehavior: Clip.antiAlias, - child: CustomPaint( - key: const Key('EquationDrawerWidget-Golden'), - painter: EquationPainter( - plotMode: PolynomialEvaluator( - algebraic: Algebraic.fromReal(coefficients), - ), - range: range, - colorArea: colorArea, - ), - size: const Size.square(200), - ), - ), - ), - ); - } - - Widget buildNonlinearPainter({ - int range = 5, - ColorArea colorArea = const ColorArea( - startPoint: 5, - endPoint: 5, - ), - }) { - return ClipRRect( - borderRadius: const BorderRadius.all(Radius.circular(5)), - child: CustomPaint( - key: const Key('EquationDrawerWidget-Golden'), - painter: EquationPainter( - plotMode: const NonlinearEvaluator( - nonLinear: Newton(function: 'e^x+x^3', x0: -1), - ), - range: range, - colorArea: colorArea, - ), - size: const Size.square(350), - ), - ); - } - - group('Golden tests - PlotPainter (no area)', () { - testWidgets('Polynomial - low range', (tester) async { - await tester.binding.setSurfaceSize(const Size(270, 270)); - - await tester.pumpWidget( - buildPolynomialPainter( - range: 2, - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_polynomial_low.png'), - ); - }); - - testWidgets('Polynomial - default', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter(), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_polynomial.png'), - ); - }); - - testWidgets('Polynomial - high range', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter( - range: 9, - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_polynomial_high.png'), - ); - }); - - testWidgets('Polynomial - with edges', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter(coefficients: [1, 0]), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_polynomial_edges.png'), - ); - }); - - testWidgets('Nonlinear - low range', (tester) async { - await tester.pumpWidget( - buildNonlinearPainter( - range: 2, - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_nonlinear_low.png'), - ); - }); - - testWidgets('Nonlinear - default', (tester) async { - await tester.pumpWidget( - buildNonlinearPainter(), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_nonlinear.png'), - ); - }); - - testWidgets('Nonlinear - high range', (tester) async { - await tester.pumpWidget( - buildNonlinearPainter( - range: 9, - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_nonlinear_high.png'), - ); - }); - }); - - group('Golden tests - PlotPainter (with area)', () { - testWidgets('Color only', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter( - colorArea: ColorArea( - color: Colors.lightGreen.withAlpha(80), - startPoint: -5, - endPoint: 5, - ), - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_area_color.png'), - ); - }); - - testWidgets('Color and ranges', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter( - colorArea: ColorArea( - color: Colors.lightGreen.withAlpha(80), - startPoint: -1, - endPoint: 2, - ), - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_area_color_and_ranges.png'), - ); - }); - - testWidgets('Color and ranges swapped', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter( - colorArea: ColorArea( - color: Colors.lightGreen.withAlpha(80), - startPoint: 2, - endPoint: -1, - ), - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile( - 'goldens/equation_painter_area_color_and_ranges_swapped.png', - ), - ); - }); - - testWidgets('Color and left range only', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter( - colorArea: ColorArea( - color: Colors.lightGreen.withAlpha(80), - startPoint: -1, - endPoint: 5, - ), - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile('goldens/equation_painter_area_color_left_range.png'), - ); - }); - - testWidgets('Color and right range only', (tester) async { - await tester.pumpWidget( - buildPolynomialPainter( - colorArea: ColorArea( - color: Colors.lime.withAlpha(80), - startPoint: -5, - endPoint: 3.5, - ), - ), - ); - await expectLater( - find.byKey(const Key('EquationDrawerWidget-Golden')), - matchesGoldenFile( - 'goldens/equation_painter_area_color_right_range.png', - ), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/plot_widget/function_evaluators_test.dart b/example/flutter_example/test/routes/utils/plot_widget/function_evaluators_test.dart deleted file mode 100644 index 0dff09ea..00000000 --- a/example/flutter_example/test/routes/utils/plot_widget/function_evaluators_test.dart +++ /dev/null @@ -1,127 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/plot_widget/function_evaluators.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group("Testing the 'PlotMode' analyzers", () { - test('Making sure that objects comparison works properly', () { - expect( - PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 4]), - ), - equals( - PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 4]), - ), - ), - ); - - expect( - PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 4]), - ).hashCode, - equals( - PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, 4]), - ).hashCode, - ), - ); - - expect( - const NonlinearEvaluator( - nonLinear: Newton( - function: 'x-3', - x0: 1, - ), - ), - equals( - const NonlinearEvaluator( - nonLinear: Newton( - function: 'x-3', - x0: 1, - ), - ), - ), - ); - - expect( - const NonlinearEvaluator( - nonLinear: Newton( - function: 'x-3', - x0: 1, - ), - ).hashCode, - equals( - const NonlinearEvaluator( - nonLinear: Newton( - function: 'x-3', - x0: 1, - ), - ).hashCode, - ), - ); - - expect( - const IntegralEvaluator( - function: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ).hashCode, - equals( - const IntegralEvaluator( - function: SimpsonRule( - function: 'x-2', - lowerBound: 1, - upperBound: 2, - ), - ).hashCode, - ), - ); - }); - - test( - 'Making sure that function evaluation works as expected with ' - 'polynomial equations.', - () { - final plot = PolynomialEvaluator( - algebraic: Algebraic.fromReal([1, -5]), - ); - - expect(plot.evaluateOn(-3), equals(-8)); - }, - ); - - test( - 'Making sure that function evaluation works as expected with ' - 'nonlinear equations.', - () { - const plot = NonlinearEvaluator( - nonLinear: Newton( - function: 'x-5', - x0: 1, - ), - ); - - expect(plot.evaluateOn(-3), equals(-8)); - }, - ); - - test( - 'Making sure that function evaluation works as expected with ' - 'integrals.', - () { - const plot = IntegralEvaluator( - function: SimpsonRule( - function: 'x', - lowerBound: 1, - upperBound: 2, - ), - ); - - expect(plot.evaluateOn(5), equals(5)); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_drawer_widget.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_drawer_widget.png deleted file mode 100644 index 0a919b73..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_drawer_widget.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_drawer_widget_zoom.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_drawer_widget_zoom.png deleted file mode 100644 index 2d94e6eb..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_drawer_widget_zoom.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color.png deleted file mode 100644 index e0d43654..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_and_ranges.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_and_ranges.png deleted file mode 100644 index 1ef70cd4..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_and_ranges.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_and_ranges_swapped.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_and_ranges_swapped.png deleted file mode 100644 index 1ef70cd4..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_and_ranges_swapped.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_left_range.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_left_range.png deleted file mode 100644 index 906c8e66..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_left_range.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_right_range.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_right_range.png deleted file mode 100644 index bee01481..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_area_color_right_range.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear.png deleted file mode 100644 index 4d208a77..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear_high.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear_high.png deleted file mode 100644 index 42bf8d2e..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear_high.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear_low.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear_low.png deleted file mode 100644 index d2177388..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_nonlinear_low.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial.png deleted file mode 100644 index e793778f..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_edges.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_edges.png deleted file mode 100644 index 1cb63c55..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_edges.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_high.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_high.png deleted file mode 100644 index b50d0b95..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_high.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_low.png b/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_low.png deleted file mode 100644 index 575fb01e..00000000 Binary files a/example/flutter_example/test/routes/utils/plot_widget/goldens/equation_painter_polynomial_low.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/bool_result_card_test.dart b/example/flutter_example/test/routes/utils/result_cards/bool_result_card_test.dart deleted file mode 100644 index 9f981dfc..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/bool_result_card_test.dart +++ /dev/null @@ -1,58 +0,0 @@ -import 'dart:ui'; - -import 'package:equations_solver/routes/utils/result_cards/bool_result_card.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'BoolResultCard' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: BoolResultCard( - leading: 'Test: ', - value: true, - ), - ), - ); - - expect(find.byType(BoolResultCard), findsOneWidget); - expect(find.text('Test: Yes'), findsOneWidget); - }); - }); - - group('Golden tests - BoolResultCard', () { - testWidgets('BoolResultCard - true', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: BoolResultCard( - leading: 'Test: ', - value: true, - ), - ), - ); - await expectLater( - find.byType(BoolResultCard), - matchesGoldenFile('goldens/bool_result_card_true.png'), - ); - }); - - testWidgets('BoolResultCard - false', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: BoolResultCard( - leading: 'Test: ', - value: false, - ), - ), - ); - await expectLater( - find.byType(BoolResultCard), - matchesGoldenFile('goldens/bool_result_card_false.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/result_cards/colored_text_test.dart b/example/flutter_example/test/routes/utils/result_cards/colored_text_test.dart deleted file mode 100644 index 8a3cac7c..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/colored_text_test.dart +++ /dev/null @@ -1,42 +0,0 @@ -import 'package:equations_solver/routes/utils/result_cards/colored_text.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'ColoredText' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ColoredText( - leading: 'Leading: ', - value: 'value', - ), - ), - ); - - expect(find.byType(ColoredText), findsOneWidget); - expect(find.text('Leading: value'), findsOneWidget); - }); - }); - - group('Golden tests - ColoredText', () { - testWidgets('ColoredText', (tester) async { - await tester.binding.setSurfaceSize(const Size(150, 60)); - - await tester.pumpWidget( - const MockWrapper( - child: ColoredText( - leading: 'Leading: ', - value: 'value', - ), - ), - ); - await expectLater( - find.byType(ColoredText), - matchesGoldenFile('goldens/colored_text.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/result_cards/complex_result_card_test.dart b/example/flutter_example/test/routes/utils/result_cards/complex_result_card_test.dart deleted file mode 100644 index fca1319f..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/complex_result_card_test.dart +++ /dev/null @@ -1,181 +0,0 @@ -import 'dart:math'; - -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'ComplexResultCard' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ComplexResultCard( - value: Complex(5, -3), - ), - ), - ); - - expect(find.byType(ComplexResultCard), findsOneWidget); - expect(find.byType(Collapsible), findsOneWidget); - expect(find.text('5 - 3i'), findsOneWidget); - }); - - testWidgets('Making sure that the leading string appears', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ComplexResultCard( - leading: 'Text: ', - value: Complex(5, -3), - ), - ), - ); - - expect(find.text('Text: 5 - 3i'), findsOneWidget); - }); - - testWidgets('Making sure that the trailing widget appears', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ComplexResultCard( - trailing: Text('Text'), - value: Complex(5, -3), - ), - ), - ); - - expect(find.text('Text'), findsOneWidget); - }); - - testWidgets( - "Making sure that when the value is 'NaN', an error message " - 'actually appears', - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: ComplexResultCard( - value: Complex(5, double.nan), - ), - ), - ); - - expect(find.byType(ComplexResultCard), findsOneWidget); - expect(find.text('Not computed'), findsOneWidget); - }, - ); - }); - - group('Golden tests - ComplexResultCard', () { - testWidgets('ComplexResultCard', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: ComplexResultCard( - value: Complex(pi, e), - ), - ), - ), - ); - - await expectLater( - find.byType(ComplexResultCard), - matchesGoldenFile('goldens/complex_result_card.png'), - ); - }); - - testWidgets('ComplexResultCard - leading value', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: ComplexResultCard( - value: Complex(pi, e), - leading: 'z = ', - ), - ), - ), - ); - - await expectLater( - find.byType(ComplexResultCard), - matchesGoldenFile('goldens/complex_result_card_leading.png'), - ); - }); - - testWidgets('ComplexResultCard - leading and trailing', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: ComplexResultCard( - value: Complex(pi, e), - leading: 'z = ', - trailing: Text(':)'), - ), - ), - ), - ); - - await expectLater( - find.byType(ComplexResultCard), - matchesGoldenFile('goldens/complex_result_card_leading_trailing.png'), - ); - }); - - testWidgets('ComplexResultCard - expanded', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 400)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: ComplexResultCard( - value: Complex(pi, e), - ), - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(ComplexResultCard), - matchesGoldenFile('goldens/complex_result_card_expanded.png'), - ); - }); - - testWidgets('ComplexResultCard - expanded with NaN', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 400)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: ComplexResultCard( - value: Complex(double.negativeInfinity, double.nan), - ), - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(ComplexResultCard), - matchesGoldenFile('goldens/complex_result_card_expanded_with_nan.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/bool_result_card_false.png b/example/flutter_example/test/routes/utils/result_cards/goldens/bool_result_card_false.png deleted file mode 100644 index 05199a06..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/bool_result_card_false.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/bool_result_card_true.png b/example/flutter_example/test/routes/utils/result_cards/goldens/bool_result_card_true.png deleted file mode 100644 index ac834707..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/bool_result_card_true.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/colored_text.png b/example/flutter_example/test/routes/utils/result_cards/goldens/colored_text.png deleted file mode 100644 index 94c0443e..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/colored_text.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card.png b/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card.png deleted file mode 100644 index 48d54c70..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_expanded.png b/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_expanded.png deleted file mode 100644 index b8adf85a..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_expanded.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_expanded_with_nan.png b/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_expanded_with_nan.png deleted file mode 100644 index 8f8e1c17..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_expanded_with_nan.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_leading.png b/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_leading.png deleted file mode 100644 index 0a243d37..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_leading.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_leading_trailing.png b/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_leading_trailing.png deleted file mode 100644 index 41201a0b..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/complex_result_card_leading_trailing.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/message_card.png b/example/flutter_example/test/routes/utils/result_cards/goldens/message_card.png deleted file mode 100644 index e199a26d..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/message_card.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/message_card_long_text.png b/example/flutter_example/test/routes/utils/result_cards/goldens/message_card_long_text.png deleted file mode 100644 index aca538dd..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/message_card_long_text.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_constant.png b/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_constant.png deleted file mode 100644 index 80e4cb44..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_constant.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_cubic.png b/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_cubic.png deleted file mode 100644 index 3d4521d9..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_cubic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_linear.png b/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_linear.png deleted file mode 100644 index 437df789..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_linear.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_quadratic.png b/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_quadratic.png deleted file mode 100644 index 3c7362b3..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_quadratic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_quartic.png b/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_quartic.png deleted file mode 100644 index 9b069d24..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/polynomial_result_card_quartic.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card.png b/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card.png deleted file mode 100644 index 2aa2ea4a..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_expanded.png b/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_expanded.png deleted file mode 100644 index ebafd8a5..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_expanded.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_expanded_with_nan.png b/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_expanded_with_nan.png deleted file mode 100644 index 6d37f85d..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_expanded_with_nan.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_leading.png b/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_leading.png deleted file mode 100644 index 43877489..00000000 Binary files a/example/flutter_example/test/routes/utils/result_cards/goldens/real_result_card_leading.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/result_cards/message_card_test.dart b/example/flutter_example/test/routes/utils/result_cards/message_card_test.dart deleted file mode 100644 index 74f9179c..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/message_card_test.dart +++ /dev/null @@ -1,69 +0,0 @@ -import 'package:equations_solver/routes/utils/result_cards/message_card.dart'; -import 'package:flutter/src/widgets/basic.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'MessageCard' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: MessageCard( - message: 'Test', - ), - ), - ); - - expect(find.byType(MessageCard), findsOneWidget); - expect(find.text('Test'), findsOneWidget); - }); - }); - - group('Golden tests - MessageCard', () { - testWidgets('MessageCard', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only( - left: 6, - bottom: 6, - ), - child: MessageCard( - message: 'Test', - ), - ), - ), - ); - await expectLater( - find.byType(MessageCard), - matchesGoldenFile('goldens/message_card.png'), - ); - }); - - testWidgets('MessageCard - long text', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only( - left: 6, - bottom: 6, - ), - child: MessageCard( - message: - 'Test with a very very long text that goes to a new line', - ), - ), - ), - ); - await expectLater( - find.byType(MessageCard), - matchesGoldenFile('goldens/message_card_long_text.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/result_cards/number_printer_extension_test.dart b/example/flutter_example/test/routes/utils/result_cards/number_printer_extension_test.dart deleted file mode 100644 index 8c0223b7..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/number_printer_extension_test.dart +++ /dev/null @@ -1,49 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/result_cards/number_printer_extension.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group('Testing number printers extensions', () { - test('RealNumberPrinter smoke', () { - expect(0.27.toStringApproximated(1), '0.3'); - expect(5.254.toStringApproximated(2), '5.25'); - expect(5.254.toStringApproximated(5), '5.254'); - expect(5.254.toStringApproximated(0), '5'); - expect((-5.254).toStringApproximated(2), '-5.25'); - expect((-5.254).toStringApproximated(5), '-5.254'); - expect((-5.254).toStringApproximated(0), '-5'); - expect(() => 5.254.toStringApproximated(-1), throwsFormatException); - }); - - test('ComplexNumberPrinter smoke', () { - expect( - const Complex(1.1543, 3.9847).toStringApproximated(2), - '1.15 + 3.98i', - ); - expect( - const Complex(1.154, 3.9847).toStringApproximated(5), - '1.154 + 3.9847i', - ); - expect( - const Complex(1.154, 3.9847).toStringApproximated(0), - '1 + 4i', - ); - expect( - (-const Complex(1.154, 3.9847)).toStringApproximated(2), - '-1.15 - 3.98i', - ); - expect( - (-const Complex(1.154, 3.9847)).toStringApproximated(5), - '-1.154 - 3.9847i', - ); - expect( - (-const Complex(1.154, 3.9847)).toStringApproximated(0), - '-1 - 4i', - ); - expect( - () => const Complex(1.154, 3.9847).toStringApproximated(-1), - throwsFormatException, - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/result_cards/polynomial_result_card_test.dart b/example/flutter_example/test/routes/utils/result_cards/polynomial_result_card_test.dart deleted file mode 100644 index 88306180..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/polynomial_result_card_test.dart +++ /dev/null @@ -1,150 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:equations_solver/routes/utils/result_cards/complex_result_card.dart'; -import 'package:equations_solver/routes/utils/result_cards/polynomial_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'PolynomialResultCard' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - MockWrapper( - child: PolynomialResultCard( - algebraic: Algebraic.fromReal( - [1, 2, 3], - ), - ), - ), - ); - - expect(find.byType(PolynomialResultCard), findsOneWidget); - expect(find.byType(Collapsible), findsWidgets); - expect(find.byType(ComplexResultCard), findsNWidgets(3)); - }); - }); - - group('Golden tests - PolynomialResultCard', () { - testWidgets( - 'PolynomialResultCard - constant', - (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - MockWrapper( - child: Padding( - padding: const EdgeInsets.only(left: 10), - child: PolynomialResultCard( - algebraic: Algebraic.fromReal([1]), - ), - ), - ), - ); - await expectLater( - find.byType(PolynomialResultCard), - matchesGoldenFile( - 'goldens/polynomial_result_card_constant.png', - ), - ); - }, - ); - - testWidgets( - 'PolynomialResultCard - linear', - (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 250)); - - await tester.pumpWidget( - MockWrapper( - child: Padding( - padding: const EdgeInsets.only(left: 10), - child: PolynomialResultCard( - algebraic: Algebraic.fromReal([1, 2.5]), - ), - ), - ), - ); - await expectLater( - find.byType(PolynomialResultCard), - matchesGoldenFile( - 'goldens/polynomial_result_card_linear.png', - ), - ); - }, - ); - - testWidgets( - 'PolynomialResultCard - quadratic', - (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 350)); - - await tester.pumpWidget( - MockWrapper( - child: Padding( - padding: const EdgeInsets.only(left: 10), - child: PolynomialResultCard( - algebraic: Algebraic.fromReal([1, 2, 3]), - ), - ), - ), - ); - await expectLater( - find.byType(PolynomialResultCard), - matchesGoldenFile( - 'goldens/polynomial_result_card_quadratic.png', - ), - ); - }, - ); - - testWidgets( - 'PolynomialResultCard - cubic', - (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 450)); - - await tester.pumpWidget( - MockWrapper( - child: Padding( - padding: const EdgeInsets.only(left: 10), - child: PolynomialResultCard( - algebraic: Algebraic.fromReal([1, 2, 3 / 4, 4]), - ), - ), - ), - ); - await expectLater( - find.byType(PolynomialResultCard), - matchesGoldenFile( - 'goldens/polynomial_result_card_cubic.png', - ), - ); - }, - ); - - testWidgets( - 'PolynomialResultCard - quartic', - (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 550)); - - await tester.pumpWidget( - MockWrapper( - child: Padding( - padding: const EdgeInsets.only(left: 10), - child: PolynomialResultCard( - algebraic: Algebraic.fromReal([1, 2, 3, 4, 5]), - ), - ), - ), - ); - await expectLater( - find.byType(PolynomialResultCard), - matchesGoldenFile( - 'goldens/polynomial_result_card_quartic.png', - ), - ); - }, - ); - }); -} diff --git a/example/flutter_example/test/routes/utils/result_cards/real_result_card_test.dart b/example/flutter_example/test/routes/utils/result_cards/real_result_card_test.dart deleted file mode 100644 index cf02cb0e..00000000 --- a/example/flutter_example/test/routes/utils/result_cards/real_result_card_test.dart +++ /dev/null @@ -1,145 +0,0 @@ -import 'dart:math'; - -import 'package:equations_solver/routes/utils/collapsible.dart'; -import 'package:equations_solver/routes/utils/result_cards/real_result_card.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group("Testing the 'RealResultCard' widget", () { - testWidgets('Making sure that the widget can be rendered', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: RealResultCard( - value: pi, - ), - ), - ); - - expect(find.byType(RealResultCard), findsOneWidget); - expect(find.byType(Collapsible), findsOneWidget); - expect(find.text('3.14159'), findsOneWidget); - }); - - testWidgets('Making sure that the leading string appears', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: RealResultCard( - leading: 'text ', - value: pi, - ), - ), - ); - - expect(find.text('text 3.14159'), findsOneWidget); - }); - - testWidgets( - "Making sure that when the value is 'NaN', an error message " - 'actually appears', - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: RealResultCard( - value: double.nan, - ), - ), - ); - - expect(find.byType(RealResultCard), findsOneWidget); - expect(find.text('Not computed'), findsOneWidget); - }, - ); - }); - - group('Golden tests - RealResultCard', () { - testWidgets('RealResultCard', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: RealResultCard( - value: pi, - ), - ), - ), - ); - - await expectLater( - find.byType(RealResultCard), - matchesGoldenFile('goldens/real_result_card.png'), - ); - }); - - testWidgets('RealResultCard - leading value', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 150)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: RealResultCard( - value: pi, - leading: 'pi: ', - ), - ), - ), - ); - - await expectLater( - find.byType(RealResultCard), - matchesGoldenFile('goldens/real_result_card_leading.png'), - ); - }); - - testWidgets('RealResultCard - expanded', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 350)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: RealResultCard( - value: pi, - ), - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(RealResultCard), - matchesGoldenFile('goldens/real_result_card_expanded.png'), - ); - }); - - testWidgets('RealResultCard - expanded with NaN', (tester) async { - await tester.binding.setSurfaceSize(const Size(300, 350)); - - await tester.pumpWidget( - const MockWrapper( - child: Padding( - padding: EdgeInsets.only(left: 10), - child: RealResultCard( - value: double.nan, - ), - ), - ), - ); - - await tester.tap(find.byType(IconButton)); - await tester.pumpAndSettle(); - - await expectLater( - find.byType(RealResultCard), - matchesGoldenFile('goldens/real_result_card_expanded_with_nan.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/section_title_test.dart b/example/flutter_example/test/routes/utils/section_title_test.dart deleted file mode 100644 index 0dd40a44..00000000 --- a/example/flutter_example/test/routes/utils/section_title_test.dart +++ /dev/null @@ -1,42 +0,0 @@ -import 'package:equations_solver/routes/utils/section_title.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../mock_wrapper.dart'; - -void main() { - group('Making sure that sections logos can be rendered', () { - testWidgets("Testing 'SectionTitle'", (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SectionTitle( - icon: Icon(Icons.ac_unit), - pageTitle: 'Demo text', - ), - ), - ); - - expect(find.byType(SectionTitle), findsOneWidget); - expect(find.text('Demo text'), findsOneWidget); - }); - }); - - group('Golden tests - SectionTitle', () { - testWidgets('SectionTitle', (tester) async { - await tester.binding.setSurfaceSize(const Size(230, 40)); - - await tester.pumpWidget( - const MockWrapper( - child: SectionTitle( - icon: Icon(Icons.ac_unit), - pageTitle: 'Demo text', - ), - ), - ); - await expectLater( - find.byType(MockWrapper), - matchesGoldenFile('goldens/section_title.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/svg_images/goldens/integral_logo.png b/example/flutter_example/test/routes/utils/svg_images/goldens/integral_logo.png deleted file mode 100644 index 95a5e3cc..00000000 Binary files a/example/flutter_example/test/routes/utils/svg_images/goldens/integral_logo.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/svg_images/goldens/nonlinear_logo.png b/example/flutter_example/test/routes/utils/svg_images/goldens/nonlinear_logo.png deleted file mode 100644 index f4fc9e4e..00000000 Binary files a/example/flutter_example/test/routes/utils/svg_images/goldens/nonlinear_logo.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/svg_images/goldens/other_logo.png b/example/flutter_example/test/routes/utils/svg_images/goldens/other_logo.png deleted file mode 100644 index 48f5c40e..00000000 Binary files a/example/flutter_example/test/routes/utils/svg_images/goldens/other_logo.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/svg_images/goldens/polynomial_logo.png b/example/flutter_example/test/routes/utils/svg_images/goldens/polynomial_logo.png deleted file mode 100644 index 36d513b9..00000000 Binary files a/example/flutter_example/test/routes/utils/svg_images/goldens/polynomial_logo.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/svg_images/goldens/system_logo.png b/example/flutter_example/test/routes/utils/svg_images/goldens/system_logo.png deleted file mode 100644 index 335f4031..00000000 Binary files a/example/flutter_example/test/routes/utils/svg_images/goldens/system_logo.png and /dev/null differ diff --git a/example/flutter_example/test/routes/utils/svg_images/section_logos_test.dart b/example/flutter_example/test/routes/utils/svg_images/section_logos_test.dart deleted file mode 100644 index 8fad508b..00000000 --- a/example/flutter_example/test/routes/utils/svg_images/section_logos_test.dart +++ /dev/null @@ -1,159 +0,0 @@ -import 'package:equations_solver/routes/utils/svg_images/types/sections_logos.dart'; -import 'package:flutter/rendering.dart'; -import 'package:flutter_svg/flutter_svg.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group('Making sure that sections logos can be rendered', () { - testWidgets( - "Making sure that 'PolynomialLogo' can be rendered", - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: PolynomialLogo(), - ), - ); - - expect(find.byType(PolynomialLogo), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that 'NonlinearLogo' can be rendered", - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: NonlinearLogo(), - ), - ); - - expect(find.byType(NonlinearLogo), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that 'SystemsLogo' can be rendered", - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SystemsLogo(), - ), - ); - - expect(find.byType(SystemsLogo), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }, - ); - - testWidgets( - "Making sure that 'IntegralLogo' can be rendered", - (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: IntegralLogo(), - ), - ); - - expect(find.byType(IntegralLogo), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }, - ); - - testWidgets("Making sure that 'OtherLogo' can be rendered", (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: OtherLogo(), - ), - ); - - expect(find.byType(OtherLogo), findsOneWidget); - expect(find.byType(SvgPicture), findsOneWidget); - }); - }); - - group('Golden tests - PolynomialLogo', () { - testWidgets('PolynomialLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(210)); - - await tester.pumpWidget( - const MockWrapper( - child: PolynomialLogo( - size: 200, - ), - ), - ); - await expectLater( - find.byType(PolynomialLogo), - matchesGoldenFile('goldens/polynomial_logo.png'), - ); - }); - - testWidgets('NonlinearLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(210)); - - await tester.pumpWidget( - const MockWrapper( - child: NonlinearLogo( - size: 200, - ), - ), - ); - await expectLater( - find.byType(NonlinearLogo), - matchesGoldenFile('goldens/nonlinear_logo.png'), - ); - }); - - testWidgets('SystemsLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(210)); - - await tester.pumpWidget( - const MockWrapper( - child: SystemsLogo( - size: 200, - ), - ), - ); - await expectLater( - find.byType(SystemsLogo), - matchesGoldenFile('goldens/system_logo.png'), - ); - }); - - testWidgets('IntegralLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(210)); - - await tester.pumpWidget( - const MockWrapper( - child: IntegralLogo( - size: 200, - ), - ), - ); - await expectLater( - find.byType(IntegralLogo), - matchesGoldenFile('goldens/integral_logo.png'), - ); - }); - - testWidgets('OtherLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(210)); - - await tester.pumpWidget( - const MockWrapper( - child: OtherLogo( - size: 200, - ), - ), - ); - await expectLater( - find.byType(OtherLogo), - matchesGoldenFile('goldens/other_logo.png'), - ); - }); - }); -} diff --git a/example/flutter_example/test/routes/utils/svg_images/vectorial_images_test.dart b/example/flutter_example/test/routes/utils/svg_images/vectorial_images_test.dart deleted file mode 100644 index faa478b3..00000000 --- a/example/flutter_example/test/routes/utils/svg_images/vectorial_images_test.dart +++ /dev/null @@ -1,145 +0,0 @@ -import 'package:equations_solver/routes/utils/svg_images/types/vectorial_images.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -import '../../mock_wrapper.dart'; - -void main() { - group('Testing vectorial images', () { - testWidgets('ApplicationLogo', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(50)); - - await tester.pumpWidget( - const MockWrapper( - child: ApplicationLogo(), - ), - ); - - expect(find.byType(ApplicationLogo), findsOneWidget); - expect(const ApplicationLogo().assetName, equals('logo')); - }); - - testWidgets('CartesianPlaneBackground', (tester) async { - await tester.binding.setSurfaceSize(const Size.square(50)); - - await tester.pumpWidget( - const MockWrapper( - child: CartesianPlaneBackground(), - ), - ); - - expect(find.byType(CartesianPlaneBackground), findsOneWidget); - expect(const CartesianPlaneBackground().assetName, equals('axis')); - }); - - testWidgets('GaussianCurveBackground', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: GaussianCurveBackground(), - ), - ); - - expect(find.byType(GaussianCurveBackground), findsOneWidget); - expect(const GaussianCurveBackground().assetName, equals('plot_opacity')); - }); - - testWidgets('OtherComplexNumbers', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: OtherComplexNumbers(), - ), - ); - - expect(find.byType(OtherComplexNumbers), findsOneWidget); - expect(const OtherComplexNumbers().assetName, equals('tools_imaginary')); - }); - - testWidgets('OtherMatrix', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: OtherMatrix(), - ), - ); - - expect(find.byType(OtherMatrix), findsOneWidget); - expect(const OtherMatrix().assetName, equals('tools_matrix')); - }); - - testWidgets('SquareMatrix', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SquareMatrix(), - ), - ); - - expect(find.byType(SquareMatrix), findsOneWidget); - expect(const SquareMatrix().assetName, equals('square_matrix')); - }); - - testWidgets('SquareRoot', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: SquareRoot(), - ), - ); - - expect(find.byType(SquareRoot), findsOneWidget); - expect(const SquareRoot().assetName, equals('square-root-simple')); - }); - - testWidgets('HalfRightAngle', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: HalfRightAngle(), - ), - ); - - expect(find.byType(HalfRightAngle), findsOneWidget); - expect(const HalfRightAngle().assetName, equals('angle')); - }); - - testWidgets('CartesianPlane', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: CartesianPlane(), - ), - ); - - expect(find.byType(CartesianPlane), findsOneWidget); - expect(const CartesianPlane().assetName, equals('plot')); - }); - - testWidgets('EquationSolution', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: EquationSolution(), - ), - ); - - expect(find.byType(EquationSolution), findsOneWidget); - expect(const EquationSolution().assetName, equals('solutions')); - }); - - testWidgets('Atoms', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: Atoms(), - ), - ); - - expect(find.byType(Atoms), findsOneWidget); - expect(const Atoms().assetName, equals('atoms')); - }); - - testWidgets('UrlError', (tester) async { - await tester.pumpWidget( - const MockWrapper( - child: UrlError(), - ), - ); - - expect(find.byType(UrlError), findsOneWidget); - expect(const UrlError().assetName, equals('url_error')); - }); - }); -} diff --git a/example/flutter_example/test/routes_test.dart b/example/flutter_example/test/routes_test.dart deleted file mode 100644 index e68b6de4..00000000 --- a/example/flutter_example/test/routes_test.dart +++ /dev/null @@ -1,51 +0,0 @@ -import 'package:equations_solver/localization/localization.dart'; -import 'package:equations_solver/routes.dart'; -import 'package:equations_solver/routes/error_page.dart'; -import 'package:equations_solver/routes/home_page.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - group('Making sure that route names are consistent', () { - test('Verifying route names', () { - expect(homePagePath, equals('/')); - expect(polynomialPagePath, equals('/polynomials')); - expect(nonlinearPagePath, equals('/nonlinears')); - expect(systemPagePath, equals('/systems')); - expect(integralPagePath, equals('/integrals')); - expect(otherPagePath, equals('/other')); - }); - - test('Making sure that the generator produces correct routes', () { - final appRoutes = generateRouter(); - expect(appRoutes.configuration.routes.length, equals(6)); - }); - - testWidgets( - 'Making sure that invalid paths redirect to the error page', - (tester) async { - final router = generateRouter(); - - await tester.pumpWidget( - MaterialApp.router( - routeInformationParser: router.routeInformationParser, - routerDelegate: router.routerDelegate, - routeInformationProvider: router.routeInformationProvider, - localizationsDelegates: AppLocalizations.localizationsDelegates, - supportedLocales: AppLocalizations.supportedLocales, - ), - ); - - // Home page - router.go(homePagePath); - await tester.pumpAndSettle(); - expect(find.byType(HomePage), findsOneWidget); - - // Wrong address - router.go('/does-not-exist'); - await tester.pumpAndSettle(); - expect(find.byType(ErrorPage), findsOneWidget); - }, - ); - }); -} diff --git a/example/flutter_example/web/icons/Icon-192.png b/example/flutter_example/web/icons/Icon-192.png deleted file mode 100644 index f46582d0..00000000 Binary files a/example/flutter_example/web/icons/Icon-192.png and /dev/null differ diff --git a/example/flutter_example/web/icons/Icon-512.png b/example/flutter_example/web/icons/Icon-512.png deleted file mode 100644 index 7fe65a60..00000000 Binary files a/example/flutter_example/web/icons/Icon-512.png and /dev/null differ diff --git a/example/flutter_example/web/icons/Icon-maskable-192.png b/example/flutter_example/web/icons/Icon-maskable-192.png deleted file mode 100644 index 38a01126..00000000 Binary files a/example/flutter_example/web/icons/Icon-maskable-192.png and /dev/null differ diff --git a/example/flutter_example/web/icons/Icon-maskable-512.png b/example/flutter_example/web/icons/Icon-maskable-512.png deleted file mode 100644 index c1802c55..00000000 Binary files a/example/flutter_example/web/icons/Icon-maskable-512.png and /dev/null differ diff --git a/example/flutter_example/web/icons/favicon-16.png b/example/flutter_example/web/icons/favicon-16.png deleted file mode 100644 index 6eae16df..00000000 Binary files a/example/flutter_example/web/icons/favicon-16.png and /dev/null differ diff --git a/example/flutter_example/web/icons/favicon-192.png b/example/flutter_example/web/icons/favicon-192.png deleted file mode 100644 index f46582d0..00000000 Binary files a/example/flutter_example/web/icons/favicon-192.png and /dev/null differ diff --git a/example/flutter_example/web/icons/favicon-32.png b/example/flutter_example/web/icons/favicon-32.png deleted file mode 100644 index 2f6831dd..00000000 Binary files a/example/flutter_example/web/icons/favicon-32.png and /dev/null differ diff --git a/example/flutter_example/web/icons/favicon-96.png b/example/flutter_example/web/icons/favicon-96.png deleted file mode 100644 index f807f487..00000000 Binary files a/example/flutter_example/web/icons/favicon-96.png and /dev/null differ diff --git a/example/flutter_example/web/images/circle_logo.svg b/example/flutter_example/web/images/circle_logo.svg deleted file mode 100644 index 7dfe725f..00000000 --- a/example/flutter_example/web/images/circle_logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/example/flutter_example/web/index.html b/example/flutter_example/web/index.html deleted file mode 100644 index 6ff5f623..00000000 --- a/example/flutter_example/web/index.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - Equation Solver - - - - - - - - - - - Logo -
- - - - - diff --git a/example/flutter_example/web/manifest.json b/example/flutter_example/web/manifest.json deleted file mode 100644 index 46f49b02..00000000 --- a/example/flutter_example/web/manifest.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "name": "Equation Solver", - "short_name": "equation_solver", - "start_url": ".", - "display": "standalone", - "background_color": "#0175C2", - "theme_color": "#0175C2", - "description": "An equation solving application created with Flutter.", - "orientation": "portrait-primary", - "prefer_related_applications": false, - "icons": [ - { - "src": "icons/Icon-192.png", - "sizes": "192x192", - "type": "image/png" - }, - { - "src": "icons/Icon-512.png", - "sizes": "512x512", - "type": "image/png" - }, - { - "src": "icons/favicon-16.png", - "sizes": "16x16", - "type": "image/png" - }, - { - "src": "icons/favicon-32.png", - "sizes": "32x32", - "type": "image/png" - }, - { - "src": "icons/favicon-96.png", - "sizes": "96x96", - "type": "image/png" - }, - { - "src": "icons/favicon-192.png", - "sizes": "192x192", - "type": "image/png" - }, - { - "src": "icons/Icon-maskable-192.png", - "sizes": "192x192", - "type": "image/png", - "purpose": "maskable" - }, - { - "src": "icons/Icon-maskable-512.png", - "sizes": "512x512", - "type": "image/png", - "purpose": "maskable" - } - ] -} diff --git a/example/flutter_example/web/messages.js b/example/flutter_example/web/messages.js deleted file mode 100644 index 77686125..00000000 --- a/example/flutter_example/web/messages.js +++ /dev/null @@ -1,3 +0,0 @@ -const english=["Loading entrypoint...","Initializing Flutter...","We're almost there...",];const italian=["Caricamento dell'entrypoint...","Inizializzazione di Flutter...","Ci siamo quasi...",];function localizedMessage(index){var lang="";if(navigator.languages!=undefined){lang=navigator.languages[0]}else{lang=navigator.language} -if(lang.includes('it')){return italian[index]} -return english[index]} diff --git a/example/flutter_example/web/styles/styles.min.css b/example/flutter_example/web/styles/styles.min.css deleted file mode 100644 index f987bb78..00000000 --- a/example/flutter_example/web/styles/styles.min.css +++ /dev/null @@ -1 +0,0 @@ -body,html{padding:0;margin:0;width:100%;height:100%}body{display:flex;justify-content:center;align-items:center;flex-direction:column}img{height:70px;width:70px}.loading_spinner{border:6px solid #f3f3f3;border-radius:50%;border-top:6px solid #3498db;width:35px;height:35px;animation:spinner .6s linear infinite}@keyframes spinner{0%{transform:rotate(0)}100%{transform:rotate(360deg)}}.status{font-family:Arial;margin: 30px 0;} diff --git a/example/flutter_example/windows/.gitignore b/example/flutter_example/windows/.gitignore deleted file mode 100644 index ec4098aa..00000000 --- a/example/flutter_example/windows/.gitignore +++ /dev/null @@ -1,17 +0,0 @@ -flutter/ephemeral/ - -# Visual Studio user-specific files. -*.suo -*.user -*.userosscache -*.sln.docstates - -# Visual Studio build-related files. -x64/ -x86/ - -# Visual Studio cache files -# files ending in .cache can be ignored -*.[Cc]ache -# but keep track of directories ending in .cache -!*.[Cc]ache/ diff --git a/example/flutter_example/windows/CMakeLists.txt b/example/flutter_example/windows/CMakeLists.txt deleted file mode 100644 index 969ab20a..00000000 --- a/example/flutter_example/windows/CMakeLists.txt +++ /dev/null @@ -1,101 +0,0 @@ -# Project-level configuration. -cmake_minimum_required(VERSION 3.14) -project(equations_solver LANGUAGES CXX) - -# The name of the executable created for the application. Change this to change -# the on-disk name of your application. -set(BINARY_NAME "equations_solver") - -# Explicitly opt in to modern CMake behaviors to avoid warnings with recent -# versions of CMake. -cmake_policy(SET CMP0063 NEW) - -# Define build configuration option. -get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) -if(IS_MULTICONFIG) - set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" - CACHE STRING "" FORCE) -else() - if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) - set(CMAKE_BUILD_TYPE "Debug" CACHE - STRING "Flutter build mode" FORCE) - set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS - "Debug" "Profile" "Release") - endif() -endif() -# Define settings for the Profile build mode. -set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") -set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") -set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") -set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") - -# Use Unicode for all projects. -add_definitions(-DUNICODE -D_UNICODE) - -# Compilation settings that should be applied to most targets. -# -# Be cautious about adding new options here, as plugins use this function by -# default. In most cases, you should add new options to specific targets instead -# of modifying this function. -function(APPLY_STANDARD_SETTINGS TARGET) - target_compile_features(${TARGET} PUBLIC cxx_std_17) - target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") - target_compile_options(${TARGET} PRIVATE /EHsc) - target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") - target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") -endfunction() - -# Flutter library and tool build rules. -set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") -add_subdirectory(${FLUTTER_MANAGED_DIR}) - -# Application build; see runner/CMakeLists.txt. -add_subdirectory("runner") - -# Generated plugin build rules, which manage building the plugins and adding -# them to the application. -include(flutter/generated_plugins.cmake) - - -# === Installation === -# Support files are copied into place next to the executable, so that it can -# run in place. This is done instead of making a separate bundle (as on Linux) -# so that building and running from within Visual Studio will work. -set(BUILD_BUNDLE_DIR "$") -# Make the "install" step default, as it's required to run. -set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) -if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) - set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) -endif() - -set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") -set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") - -install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" - COMPONENT Runtime) - -install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" - COMPONENT Runtime) - -install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) - -if(PLUGIN_BUNDLED_LIBRARIES) - install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" - DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) -endif() - -# Fully re-copy the assets directory on each build to avoid having stale files -# from a previous install. -set(FLUTTER_ASSET_DIR_NAME "flutter_assets") -install(CODE " - file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") - " COMPONENT Runtime) -install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" - DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) - -# Install the AOT library on non-Debug builds only. -install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" - CONFIGURATIONS Profile;Release - COMPONENT Runtime) diff --git a/example/flutter_example/windows/flutter/CMakeLists.txt b/example/flutter_example/windows/flutter/CMakeLists.txt deleted file mode 100644 index 3f71e173..00000000 --- a/example/flutter_example/windows/flutter/CMakeLists.txt +++ /dev/null @@ -1,104 +0,0 @@ -# This file controls Flutter-level build steps. It should not be edited. -cmake_minimum_required(VERSION 3.14) - -set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") - -# Configuration provided via flutter tool. -include(${EPHEMERAL_DIR}/generated_config.cmake) - -# TODO: Move the rest of this into files in ephemeral. See -# https://github.com/flutter/flutter/issues/57146. -set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") - -# === Flutter Library === -set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") - -# Published to parent scope for install step. -set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) -set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) -set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) -set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) - -list(APPEND FLUTTER_LIBRARY_HEADERS - "flutter_export.h" - "flutter_windows.h" - "flutter_messenger.h" - "flutter_plugin_registrar.h" - "flutter_texture_registrar.h" -) -list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") -add_library(flutter INTERFACE) -target_include_directories(flutter INTERFACE - "${EPHEMERAL_DIR}" -) -target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") -add_dependencies(flutter flutter_assemble) - -# === Wrapper === -list(APPEND CPP_WRAPPER_SOURCES_CORE - "core_implementations.cc" - "standard_codec.cc" -) -list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") -list(APPEND CPP_WRAPPER_SOURCES_PLUGIN - "plugin_registrar.cc" -) -list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") -list(APPEND CPP_WRAPPER_SOURCES_APP - "flutter_engine.cc" - "flutter_view_controller.cc" -) -list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") - -# Wrapper sources needed for a plugin. -add_library(flutter_wrapper_plugin STATIC - ${CPP_WRAPPER_SOURCES_CORE} - ${CPP_WRAPPER_SOURCES_PLUGIN} -) -apply_standard_settings(flutter_wrapper_plugin) -set_target_properties(flutter_wrapper_plugin PROPERTIES - POSITION_INDEPENDENT_CODE ON) -set_target_properties(flutter_wrapper_plugin PROPERTIES - CXX_VISIBILITY_PRESET hidden) -target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) -target_include_directories(flutter_wrapper_plugin PUBLIC - "${WRAPPER_ROOT}/include" -) -add_dependencies(flutter_wrapper_plugin flutter_assemble) - -# Wrapper sources needed for the runner. -add_library(flutter_wrapper_app STATIC - ${CPP_WRAPPER_SOURCES_CORE} - ${CPP_WRAPPER_SOURCES_APP} -) -apply_standard_settings(flutter_wrapper_app) -target_link_libraries(flutter_wrapper_app PUBLIC flutter) -target_include_directories(flutter_wrapper_app PUBLIC - "${WRAPPER_ROOT}/include" -) -add_dependencies(flutter_wrapper_app flutter_assemble) - -# === Flutter tool backend === -# _phony_ is a non-existent file to force this command to run every time, -# since currently there's no way to get a full input/output list from the -# flutter tool. -set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") -set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) -add_custom_command( - OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} - ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} - ${CPP_WRAPPER_SOURCES_APP} - ${PHONY_OUTPUT} - COMMAND ${CMAKE_COMMAND} -E env - ${FLUTTER_TOOL_ENVIRONMENT} - "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" - windows-x64 $ - VERBATIM -) -add_custom_target(flutter_assemble DEPENDS - "${FLUTTER_LIBRARY}" - ${FLUTTER_LIBRARY_HEADERS} - ${CPP_WRAPPER_SOURCES_CORE} - ${CPP_WRAPPER_SOURCES_PLUGIN} - ${CPP_WRAPPER_SOURCES_APP} -) diff --git a/example/flutter_example/windows/flutter/generated_plugin_registrant.cc b/example/flutter_example/windows/flutter/generated_plugin_registrant.cc deleted file mode 100644 index 8b6d4680..00000000 --- a/example/flutter_example/windows/flutter/generated_plugin_registrant.cc +++ /dev/null @@ -1,11 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#include "generated_plugin_registrant.h" - - -void RegisterPlugins(flutter::PluginRegistry* registry) { -} diff --git a/example/flutter_example/windows/flutter/generated_plugin_registrant.h b/example/flutter_example/windows/flutter/generated_plugin_registrant.h deleted file mode 100644 index dc139d85..00000000 --- a/example/flutter_example/windows/flutter/generated_plugin_registrant.h +++ /dev/null @@ -1,15 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#ifndef GENERATED_PLUGIN_REGISTRANT_ -#define GENERATED_PLUGIN_REGISTRANT_ - -#include - -// Registers Flutter plugins. -void RegisterPlugins(flutter::PluginRegistry* registry); - -#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/flutter_example/windows/flutter/generated_plugins.cmake b/example/flutter_example/windows/flutter/generated_plugins.cmake deleted file mode 100644 index b93c4c30..00000000 --- a/example/flutter_example/windows/flutter/generated_plugins.cmake +++ /dev/null @@ -1,23 +0,0 @@ -# -# Generated file, do not edit. -# - -list(APPEND FLUTTER_PLUGIN_LIST -) - -list(APPEND FLUTTER_FFI_PLUGIN_LIST -) - -set(PLUGIN_BUNDLED_LIBRARIES) - -foreach(plugin ${FLUTTER_PLUGIN_LIST}) - add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) - target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) - list(APPEND PLUGIN_BUNDLED_LIBRARIES $) - list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) -endforeach(plugin) - -foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) - add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) - list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) -endforeach(ffi_plugin) diff --git a/example/flutter_example/windows/runner/CMakeLists.txt b/example/flutter_example/windows/runner/CMakeLists.txt deleted file mode 100644 index c832c4b1..00000000 --- a/example/flutter_example/windows/runner/CMakeLists.txt +++ /dev/null @@ -1,39 +0,0 @@ -cmake_minimum_required(VERSION 3.14) -project(runner LANGUAGES CXX) - -# Define the application target. To change its name, change BINARY_NAME in the -# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer -# work. -# -# Any new source files that you add to the application should be added here. -add_executable(${BINARY_NAME} WIN32 - "flutter_window.cpp" - "main.cpp" - "utils.cpp" - "win32_window.cpp" - "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" - "Runner.rc" - "runner.exe.manifest" -) - -# Apply the standard set of build settings. This can be removed for applications -# that need different build settings. -apply_standard_settings(${BINARY_NAME}) - -# Add preprocessor definitions for the build version. -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") - -# Disable Windows macros that collide with C++ standard library functions. -target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") - -# Add dependency libraries and include directories. Add any application-specific -# dependencies here. -target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) -target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") - -# Run the Flutter tool portions of the build. This must not be removed. -add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/example/flutter_example/windows/runner/Runner.rc b/example/flutter_example/windows/runner/Runner.rc deleted file mode 100644 index 062be28d..00000000 --- a/example/flutter_example/windows/runner/Runner.rc +++ /dev/null @@ -1,121 +0,0 @@ -// Microsoft Visual C++ generated resource script. -// -#pragma code_page(65001) -#include "resource.h" - -#define APSTUDIO_READONLY_SYMBOLS -///////////////////////////////////////////////////////////////////////////// -// -// Generated from the TEXTINCLUDE 2 resource. -// -#include "winres.h" - -///////////////////////////////////////////////////////////////////////////// -#undef APSTUDIO_READONLY_SYMBOLS - -///////////////////////////////////////////////////////////////////////////// -// English (United States) resources - -#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) -LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US - -#ifdef APSTUDIO_INVOKED -///////////////////////////////////////////////////////////////////////////// -// -// TEXTINCLUDE -// - -1 TEXTINCLUDE -BEGIN - "resource.h\0" -END - -2 TEXTINCLUDE -BEGIN - "#include ""winres.h""\r\n" - "\0" -END - -3 TEXTINCLUDE -BEGIN - "\r\n" - "\0" -END - -#endif // APSTUDIO_INVOKED - - -///////////////////////////////////////////////////////////////////////////// -// -// Icon -// - -// Icon with lowest ID value placed first to ensure application icon -// remains consistent on all systems. -IDI_APP_ICON ICON "resources\\app_icon.ico" - - -///////////////////////////////////////////////////////////////////////////// -// -// Version -// - -#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) -#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD -#else -#define VERSION_AS_NUMBER 1,0,0,0 -#endif - -#if defined(FLUTTER_VERSION) -#define VERSION_AS_STRING FLUTTER_VERSION -#else -#define VERSION_AS_STRING "1.0.0" -#endif - -VS_VERSION_INFO VERSIONINFO - FILEVERSION VERSION_AS_NUMBER - PRODUCTVERSION VERSION_AS_NUMBER - FILEFLAGSMASK VS_FFI_FILEFLAGSMASK -#ifdef _DEBUG - FILEFLAGS VS_FF_DEBUG -#else - FILEFLAGS 0x0L -#endif - FILEOS VOS__WINDOWS32 - FILETYPE VFT_APP - FILESUBTYPE 0x0L -BEGIN - BLOCK "StringFileInfo" - BEGIN - BLOCK "040904e4" - BEGIN - VALUE "CompanyName", "com.fluttercompletereference" "\0" - VALUE "FileDescription", "An equation solving library written in Dart." "\0" - VALUE "FileVersion", VERSION_AS_STRING "\0" - VALUE "InternalName", "flutter_equations" "\0" - VALUE "LegalCopyright", "Copyright (C) 2022 com.fluttercompletereference. All rights reserved." "\0" - VALUE "OriginalFilename", "equation_solver.exe" "\0" - VALUE "ProductName", "Equations solver" "\0" - VALUE "ProductVersion", VERSION_AS_STRING "\0" - END - END - BLOCK "VarFileInfo" - BEGIN - VALUE "Translation", 0x409, 1252 - END -END - -#endif // English (United States) resources -///////////////////////////////////////////////////////////////////////////// - - - -#ifndef APSTUDIO_INVOKED -///////////////////////////////////////////////////////////////////////////// -// -// Generated from the TEXTINCLUDE 3 resource. -// - - -///////////////////////////////////////////////////////////////////////////// -#endif // not APSTUDIO_INVOKED diff --git a/example/flutter_example/windows/runner/flutter_window.cpp b/example/flutter_example/windows/runner/flutter_window.cpp deleted file mode 100644 index 3a11b51d..00000000 --- a/example/flutter_example/windows/runner/flutter_window.cpp +++ /dev/null @@ -1,61 +0,0 @@ -#include "flutter_window.h" - -#include - -#include "flutter/generated_plugin_registrant.h" - -FlutterWindow::FlutterWindow(const flutter::DartProject& project) - : project_(project) {} - -FlutterWindow::~FlutterWindow() {} - -bool FlutterWindow::OnCreate() { - if (!Win32Window::OnCreate()) { - return false; - } - - RECT frame = GetClientArea(); - - // The size here must match the window dimensions to avoid unnecessary surface - // creation / destruction in the startup path. - flutter_controller_ = std::make_unique( - frame.right - frame.left, frame.bottom - frame.top, project_); - // Ensure that basic setup of the controller was successful. - if (!flutter_controller_->engine() || !flutter_controller_->view()) { - return false; - } - RegisterPlugins(flutter_controller_->engine()); - SetChildContent(flutter_controller_->view()->GetNativeWindow()); - return true; -} - -void FlutterWindow::OnDestroy() { - if (flutter_controller_) { - flutter_controller_ = nullptr; - } - - Win32Window::OnDestroy(); -} - -LRESULT -FlutterWindow::MessageHandler(HWND hwnd, UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept { - // Give Flutter, including plugins, an opportunity to handle window messages. - if (flutter_controller_) { - std::optional result = - flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, - lparam); - if (result) { - return *result; - } - } - - switch (message) { - case WM_FONTCHANGE: - flutter_controller_->engine()->ReloadSystemFonts(); - break; - } - - return Win32Window::MessageHandler(hwnd, message, wparam, lparam); -} diff --git a/example/flutter_example/windows/runner/flutter_window.h b/example/flutter_example/windows/runner/flutter_window.h deleted file mode 100644 index 28c23839..00000000 --- a/example/flutter_example/windows/runner/flutter_window.h +++ /dev/null @@ -1,33 +0,0 @@ -#ifndef RUNNER_FLUTTER_WINDOW_H_ -#define RUNNER_FLUTTER_WINDOW_H_ - -#include -#include - -#include - -#include "win32_window.h" - -// A window that does nothing but host a Flutter view. -class FlutterWindow : public Win32Window { - public: - // Creates a new FlutterWindow hosting a Flutter view running |project|. - explicit FlutterWindow(const flutter::DartProject& project); - virtual ~FlutterWindow(); - - protected: - // Win32Window: - bool OnCreate() override; - void OnDestroy() override; - LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, - LPARAM const lparam) noexcept override; - - private: - // The project to run. - flutter::DartProject project_; - - // The Flutter instance hosted by this window. - std::unique_ptr flutter_controller_; -}; - -#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/example/flutter_example/windows/runner/main.cpp b/example/flutter_example/windows/runner/main.cpp deleted file mode 100644 index ef9a1c52..00000000 --- a/example/flutter_example/windows/runner/main.cpp +++ /dev/null @@ -1,43 +0,0 @@ -#include -#include -#include - -#include "flutter_window.h" -#include "utils.h" - -int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, - _In_ wchar_t *command_line, _In_ int show_command) { - // Attach to console when present (e.g., 'flutter run') or create a - // new console when running with a debugger. - if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { - CreateAndAttachConsole(); - } - - // Initialize COM, so that it is available for use in the library and/or - // plugins. - ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); - - flutter::DartProject project(L"data"); - - std::vector command_line_arguments = - GetCommandLineArguments(); - - project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); - - FlutterWindow window(project); - Win32Window::Point origin(10, 10); - Win32Window::Size size(1280, 720); - if (!window.CreateAndShow(L"Equations Solver", origin, size)) { - return EXIT_FAILURE; - } - window.SetQuitOnClose(true); - - ::MSG msg; - while (::GetMessage(&msg, nullptr, 0, 0)) { - ::TranslateMessage(&msg); - ::DispatchMessage(&msg); - } - - ::CoUninitialize(); - return EXIT_SUCCESS; -} diff --git a/example/flutter_example/windows/runner/resource.h b/example/flutter_example/windows/runner/resource.h deleted file mode 100644 index ddc7f3ef..00000000 --- a/example/flutter_example/windows/runner/resource.h +++ /dev/null @@ -1,16 +0,0 @@ -//{{NO_DEPENDENCIES}} -// Microsoft Visual C++ generated include file. -// Used by Runner.rc -// -#define IDI_APP_ICON 101 - -// Next default values for new objects -// -#ifdef APSTUDIO_INVOKED -#ifndef APSTUDIO_READONLY_SYMBOLS -#define _APS_NEXT_RESOURCE_VALUE 102 -#define _APS_NEXT_COMMAND_VALUE 40001 -#define _APS_NEXT_CONTROL_VALUE 1001 -#define _APS_NEXT_SYMED_VALUE 101 -#endif -#endif diff --git a/example/flutter_example/windows/runner/resources/app_icon.ico b/example/flutter_example/windows/runner/resources/app_icon.ico deleted file mode 100644 index 78276093..00000000 Binary files a/example/flutter_example/windows/runner/resources/app_icon.ico and /dev/null differ diff --git a/example/flutter_example/windows/runner/runner.exe.manifest b/example/flutter_example/windows/runner/runner.exe.manifest deleted file mode 100644 index 2c680b8b..00000000 --- a/example/flutter_example/windows/runner/runner.exe.manifest +++ /dev/null @@ -1,20 +0,0 @@ - - - - - PerMonitorV2 - - - - - - - - - - - - - - - diff --git a/example/flutter_example/windows/runner/utils.cpp b/example/flutter_example/windows/runner/utils.cpp deleted file mode 100644 index 92ed5472..00000000 --- a/example/flutter_example/windows/runner/utils.cpp +++ /dev/null @@ -1,64 +0,0 @@ -#include "utils.h" - -#include -#include -#include -#include - -#include - -void CreateAndAttachConsole() { - if (::AllocConsole()) { - FILE *unused; - if (freopen_s(&unused, "CONOUT$", "w", stdout)) { - _dup2(_fileno(stdout), 1); - } - if (freopen_s(&unused, "CONOUT$", "w", stderr)) { - _dup2(_fileno(stdout), 2); - } - std::ios::sync_with_stdio(); - FlutterDesktopResyncOutputStreams(); - } -} - -std::vector GetCommandLineArguments() { - // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. - int argc; - wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); - if (argv == nullptr) { - return std::vector(); - } - - std::vector command_line_arguments; - - // Skip the first argument as it's the binary name. - for (int i = 1; i < argc; i++) { - command_line_arguments.push_back(Utf8FromUtf16(argv[i])); - } - - ::LocalFree(argv); - - return command_line_arguments; -} - -std::string Utf8FromUtf16(const wchar_t* utf16_string) { - if (utf16_string == nullptr) { - return std::string(); - } - int target_length = ::WideCharToMultiByte( - CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, - -1, nullptr, 0, nullptr, nullptr); - std::string utf8_string; - if (target_length == 0 || target_length > utf8_string.max_size()) { - return utf8_string; - } - utf8_string.resize(target_length); - int converted_length = ::WideCharToMultiByte( - CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, - -1, utf8_string.data(), - target_length, nullptr, nullptr); - if (converted_length == 0) { - return std::string(); - } - return utf8_string; -} diff --git a/example/flutter_example/windows/runner/utils.h b/example/flutter_example/windows/runner/utils.h deleted file mode 100644 index 3f0e05cb..00000000 --- a/example/flutter_example/windows/runner/utils.h +++ /dev/null @@ -1,19 +0,0 @@ -#ifndef RUNNER_UTILS_H_ -#define RUNNER_UTILS_H_ - -#include -#include - -// Creates a console for the process, and redirects stdout and stderr to -// it for both the runner and the Flutter library. -void CreateAndAttachConsole(); - -// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string -// encoded in UTF-8. Returns an empty std::string on failure. -std::string Utf8FromUtf16(const wchar_t* utf16_string); - -// Gets the command line arguments passed in as a std::vector, -// encoded in UTF-8. Returns an empty std::vector on failure. -std::vector GetCommandLineArguments(); - -#endif // RUNNER_UTILS_H_ diff --git a/example/flutter_example/windows/runner/win32_window.cpp b/example/flutter_example/windows/runner/win32_window.cpp deleted file mode 100644 index 97f4439c..00000000 --- a/example/flutter_example/windows/runner/win32_window.cpp +++ /dev/null @@ -1,245 +0,0 @@ -#include "win32_window.h" - -#include - -#include "resource.h" - -namespace { - -constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; - -// The number of Win32Window objects that currently exist. -static int g_active_window_count = 0; - -using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); - -// Scale helper to convert logical scaler values to physical using passed in -// scale factor -int Scale(int source, double scale_factor) { - return static_cast(source * scale_factor); -} - -// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. -// This API is only needed for PerMonitor V1 awareness mode. -void EnableFullDpiSupportIfAvailable(HWND hwnd) { - HMODULE user32_module = LoadLibraryA("User32.dll"); - if (!user32_module) { - return; - } - auto enable_non_client_dpi_scaling = - reinterpret_cast( - GetProcAddress(user32_module, "EnableNonClientDpiScaling")); - if (enable_non_client_dpi_scaling != nullptr) { - enable_non_client_dpi_scaling(hwnd); - FreeLibrary(user32_module); - } -} - -} // namespace - -// Manages the Win32Window's window class registration. -class WindowClassRegistrar { - public: - ~WindowClassRegistrar() = default; - - // Returns the singleton registar instance. - static WindowClassRegistrar* GetInstance() { - if (!instance_) { - instance_ = new WindowClassRegistrar(); - } - return instance_; - } - - // Returns the name of the window class, registering the class if it hasn't - // previously been registered. - const wchar_t* GetWindowClass(); - - // Unregisters the window class. Should only be called if there are no - // instances of the window. - void UnregisterWindowClass(); - - private: - WindowClassRegistrar() = default; - - static WindowClassRegistrar* instance_; - - bool class_registered_ = false; -}; - -WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; - -const wchar_t* WindowClassRegistrar::GetWindowClass() { - if (!class_registered_) { - WNDCLASS window_class{}; - window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); - window_class.lpszClassName = kWindowClassName; - window_class.style = CS_HREDRAW | CS_VREDRAW; - window_class.cbClsExtra = 0; - window_class.cbWndExtra = 0; - window_class.hInstance = GetModuleHandle(nullptr); - window_class.hIcon = - LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); - window_class.hbrBackground = 0; - window_class.lpszMenuName = nullptr; - window_class.lpfnWndProc = Win32Window::WndProc; - RegisterClass(&window_class); - class_registered_ = true; - } - return kWindowClassName; -} - -void WindowClassRegistrar::UnregisterWindowClass() { - UnregisterClass(kWindowClassName, nullptr); - class_registered_ = false; -} - -Win32Window::Win32Window() { - ++g_active_window_count; -} - -Win32Window::~Win32Window() { - --g_active_window_count; - Destroy(); -} - -bool Win32Window::CreateAndShow(const std::wstring& title, - const Point& origin, - const Size& size) { - Destroy(); - - const wchar_t* window_class = - WindowClassRegistrar::GetInstance()->GetWindowClass(); - - const POINT target_point = {static_cast(origin.x), - static_cast(origin.y)}; - HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); - UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); - double scale_factor = dpi / 96.0; - - HWND window = CreateWindow( - window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE, - Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), - Scale(size.width, scale_factor), Scale(size.height, scale_factor), - nullptr, nullptr, GetModuleHandle(nullptr), this); - - if (!window) { - return false; - } - - return OnCreate(); -} - -// static -LRESULT CALLBACK Win32Window::WndProc(HWND const window, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept { - if (message == WM_NCCREATE) { - auto window_struct = reinterpret_cast(lparam); - SetWindowLongPtr(window, GWLP_USERDATA, - reinterpret_cast(window_struct->lpCreateParams)); - - auto that = static_cast(window_struct->lpCreateParams); - EnableFullDpiSupportIfAvailable(window); - that->window_handle_ = window; - } else if (Win32Window* that = GetThisFromHandle(window)) { - return that->MessageHandler(window, message, wparam, lparam); - } - - return DefWindowProc(window, message, wparam, lparam); -} - -LRESULT -Win32Window::MessageHandler(HWND hwnd, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept { - switch (message) { - case WM_DESTROY: - window_handle_ = nullptr; - Destroy(); - if (quit_on_close_) { - PostQuitMessage(0); - } - return 0; - - case WM_DPICHANGED: { - auto newRectSize = reinterpret_cast(lparam); - LONG newWidth = newRectSize->right - newRectSize->left; - LONG newHeight = newRectSize->bottom - newRectSize->top; - - SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, - newHeight, SWP_NOZORDER | SWP_NOACTIVATE); - - return 0; - } - case WM_SIZE: { - RECT rect = GetClientArea(); - if (child_content_ != nullptr) { - // Size and position the child window. - MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, - rect.bottom - rect.top, TRUE); - } - return 0; - } - - case WM_ACTIVATE: - if (child_content_ != nullptr) { - SetFocus(child_content_); - } - return 0; - } - - return DefWindowProc(window_handle_, message, wparam, lparam); -} - -void Win32Window::Destroy() { - OnDestroy(); - - if (window_handle_) { - DestroyWindow(window_handle_); - window_handle_ = nullptr; - } - if (g_active_window_count == 0) { - WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); - } -} - -Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { - return reinterpret_cast( - GetWindowLongPtr(window, GWLP_USERDATA)); -} - -void Win32Window::SetChildContent(HWND content) { - child_content_ = content; - SetParent(content, window_handle_); - RECT frame = GetClientArea(); - - MoveWindow(content, frame.left, frame.top, frame.right - frame.left, - frame.bottom - frame.top, true); - - SetFocus(child_content_); -} - -RECT Win32Window::GetClientArea() { - RECT frame; - GetClientRect(window_handle_, &frame); - return frame; -} - -HWND Win32Window::GetHandle() { - return window_handle_; -} - -void Win32Window::SetQuitOnClose(bool quit_on_close) { - quit_on_close_ = quit_on_close; -} - -bool Win32Window::OnCreate() { - // No-op; provided for subclasses. - return true; -} - -void Win32Window::OnDestroy() { - // No-op; provided for subclasses. -} diff --git a/example/flutter_example/windows/runner/win32_window.h b/example/flutter_example/windows/runner/win32_window.h deleted file mode 100644 index d9bcac1b..00000000 --- a/example/flutter_example/windows/runner/win32_window.h +++ /dev/null @@ -1,98 +0,0 @@ -#ifndef RUNNER_WIN32_WINDOW_H_ -#define RUNNER_WIN32_WINDOW_H_ - -#include - -#include -#include -#include - -// A class abstraction for a high DPI-aware Win32 Window. Intended to be -// inherited from by classes that wish to specialize with custom -// rendering and input handling -class Win32Window { - public: - struct Point { - unsigned int x; - unsigned int y; - Point(unsigned int x, unsigned int y) : x(x), y(y) {} - }; - - struct Size { - unsigned int width; - unsigned int height; - Size(unsigned int width, unsigned int height) - : width(width), height(height) {} - }; - - Win32Window(); - virtual ~Win32Window(); - - // Creates and shows a win32 window with |title| and position and size using - // |origin| and |size|. New windows are created on the default monitor. Window - // sizes are specified to the OS in physical pixels, hence to ensure a - // consistent size to will treat the width height passed in to this function - // as logical pixels and scale to appropriate for the default monitor. Returns - // true if the window was created successfully. - bool CreateAndShow(const std::wstring& title, - const Point& origin, - const Size& size); - - // Release OS resources associated with window. - void Destroy(); - - // Inserts |content| into the window tree. - void SetChildContent(HWND content); - - // Returns the backing Window handle to enable clients to set icon and other - // window properties. Returns nullptr if the window has been destroyed. - HWND GetHandle(); - - // If true, closing this window will quit the application. - void SetQuitOnClose(bool quit_on_close); - - // Return a RECT representing the bounds of the current client area. - RECT GetClientArea(); - - protected: - // Processes and route salient window messages for mouse handling, - // size change and DPI. Delegates handling of these to member overloads that - // inheriting classes can handle. - virtual LRESULT MessageHandler(HWND window, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept; - - // Called when CreateAndShow is called, allowing subclass window-related - // setup. Subclasses should return false if setup fails. - virtual bool OnCreate(); - - // Called when Destroy is called. - virtual void OnDestroy(); - - private: - friend class WindowClassRegistrar; - - // OS callback called by message pump. Handles the WM_NCCREATE message which - // is passed when the non-client area is being created and enables automatic - // non-client DPI scaling so that the non-client area automatically - // responsponds to changes in DPI. All other messages are handled by - // MessageHandler. - static LRESULT CALLBACK WndProc(HWND const window, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept; - - // Retrieves a class instance pointer for |window| - static Win32Window* GetThisFromHandle(HWND const window) noexcept; - - bool quit_on_close_ = false; - - // window handle for top level window. - HWND window_handle_ = nullptr; - - // window handle for hosted content. - HWND child_content_ = nullptr; -}; - -#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/lib/equations.dart b/lib/equations.dart index 2d861b00..8af2b8a3 100644 --- a/lib/equations.dart +++ b/lib/equations.dart @@ -1,26 +1,21 @@ -/// This package is used to solve numerical analysis problems, such as: +/// The `equations` package helps you with: /// -/// - finding roots of polynomial equations; -/// - finding roots of nonlinear equations; -/// - solving linear systems of equations; -/// - evaluating definite integrals; -/// - manipulating and decomposing matrices; -/// - interpolate data points using interpolation algorithms. +/// - solving polynomial equations and inequalities; +/// - solve nonlinear equations; +/// - solve linear systems of equations. /// -/// Additionally, the package also has utilities to work with complex numbers, -/// real/complex matrices, fractions, and expression parsing. -library equations; +/// In addition, you can also find utilities to work with: +/// +/// - real and complex matrices; +/// - complex numbers; +/// - integral evaluation; +/// - data interpolation. +library; export 'package:fraction/fraction.dart'; export 'src/algebraic/algebraic.dart'; -export 'src/algebraic/types/constant.dart'; -export 'src/algebraic/types/cubic.dart'; -export 'src/algebraic/types/durand_kerner.dart'; -export 'src/algebraic/types/linear.dart'; -export 'src/algebraic/types/quadratic.dart'; -export 'src/algebraic/types/quartic.dart'; -export 'src/algebraic/utils/algebraic_division.dart'; +export 'src/algebraic/utils/algebraic_inequality.dart'; export 'src/algebraic/utils/polynomial_long_division.dart'; export 'src/algebraic/utils/sylvester_matrix.dart'; export 'src/integral/numerical_integration.dart'; diff --git a/lib/src/algebraic/algebraic.dart b/lib/src/algebraic/algebraic.dart index 4173513e..f8d6a26d 100644 --- a/lib/src/algebraic/algebraic.dart +++ b/lib/src/algebraic/algebraic.dart @@ -1,53 +1,76 @@ import 'dart:math'; import 'package:equations/equations.dart'; +import 'package:equations/src/utils/math_utils.dart'; + +part 'types/constant.dart'; +part 'types/cubic.dart'; +part 'types/generic_algebraic.dart'; +part 'types/linear.dart'; +part 'types/quadratic.dart'; +part 'types/quartic.dart'; /// The message thrown by the constructor to indicate that the polynomial cannot -/// correctly be created. +/// be created correctly. const _exceptionError = ''' -To solve a polynomial equation (unless it's a constant), the coefficient with the highest degree cannot be zero. As such, make sure to pass a list that either: - - 1. Contains a single value (like `[5]` or `[-2]`) to represent a polynomial whose degree is zero. - 2. Contains one or more values AND the first parameter is not zero (like `[1, 0]` or `[-6, -3, 2, 8]`). - '''; - -/// Abstract class representing an _algebraic equation_, also know as -/// _polynomial equation_, which has a single variable with a maximum degree. +To create a valid polynomial equation (except for constant values), the coefficient with the highest degree cannot be zero. Therefore, ensure that your list either: + 1. contains a single value (like `[5]` or `[-2]`) to represent a polynomial whose degree is zero (a constant value); + 2. contains one or more values AND the first parameter is not zero (for example, `[1, 0]` or `[-6, -3, 2, 8]`). +'''; + +/// A record type that holds the quotient and the remainder of a division +/// between two polynomials. When you use `operator/` on two [Algebraic] +/// objects, this type is returned. The quotient represents the result of the +/// division, while the remainder represents what's left after the division. +/// +/// For example: +/// +/// ```dart +/// final numerator = Algebraic.fromReal([1, -3, 2]); +/// final denominator = Algebraic.fromReal([1, 2]); +/// +/// final res = numerator / denominator; +/// +/// print(res.quotient); // Algebraic.fromReal([1, -5, 7]) +/// print(res.remainder); // Algebraic.fromReal([-11, 24]) +/// ``` +typedef AlgebraicDivision = ({Algebraic quotient, Algebraic remainder}); + +/// {@template algebraic} +/// An abstract class that represents an _algebraic equation_, also known as +/// a _polynomial equation_, which has a single variable and a maximum degree. /// /// The coefficients of the algebraic equations can be real numbers or complex -/// numbers. These are examples of an algebraic equations of third degree: +/// numbers. These are examples of algebraic equations of third degree: /// -/// - x3 + 5x + 2 = 0 -/// - 2x3 + (6+i)x + 8i = 0 +/// • x³ + 5x + 2 = 0 +/// • 2x³ + (6+i)x + 8i = 0 /// /// This class stores the coefficients list starting from the one with the -/// **highest** degree. -abstract base class Algebraic { - /// The list with the polynomial coefficients. +/// **highest** degree. For example, the equation `x³ + 5x² + 3x - 2 = 0` +/// would require a subclass of [Algebraic] to call the following: +/// +/// ```dart +/// super([ +/// Complex.fromReal(1), // x³ +/// Complex.fromReal(5), // x² +/// Complex.fromReal(3), // x +/// Complex.fromReal(-2), // constant value +/// ]); +/// ``` +/// +/// The constructor throws an [AlgebraicException] if the first element of +/// [coefficients] is zero. +/// {@endtemplate} +sealed class Algebraic { + /// The polynomial coefficients. final List coefficients; - /// Creates a new algebraic equation by taking the coefficients of the - /// polynomial starting from the one with the highest degree. - /// - /// For example, the equation `x^3 + 5x^2 + 3x - 2 = 0` would require a - /// subclass of `Algebraic` to call the following... - /// - /// ```dart - /// super([ - /// Complex.fromReal(1), // x^3 - /// Complex.fromReal(5), // x^2 - /// Complex.fromReal(3), // x - /// Complex.fromReal(-2), // -2 - /// ]); - /// ``` + /// {@macro algebraic} /// - /// ... because the coefficient with the highest degree goes first. - /// - /// If the coefficients of the polynomial are all real numbers, consider using - /// the [Algebraic.realEquation] constructor which is more convenient. - /// - /// This constructor throws an [AlgebraicException] if the first element of - /// [coefficients] is zero. + /// Use this constructor if you have complex coefficients. If no [Complex] + /// values are required, consider using [Algebraic.realEquation] for a less + /// verbose syntax. Algebraic(this.coefficients) { // Unless this is a constant value, the coefficient with the highest degree // cannot be zero. @@ -56,40 +79,27 @@ abstract base class Algebraic { } } - /// Creates a new algebraic equation by taking the coefficients of the - /// polynomial starting from the one with the highest degree. - /// - /// For example, the equation `x^3 + 5x^2 + 3x - 2 = 0` would require a - /// subclass of `Algebraic` to call the following... - /// - /// ```dart - /// super.realEquation(1, 5, 3, 2); - /// ``` - /// - /// ... because the coefficient with the highest degree goes first. + /// {@macro algebraic} /// - /// Use this constructor when the coefficients are all real numbers. If there - /// were complex numbers as well, use the [Algebraic.new] default constructor - /// instead. - /// - /// This constructor throws an [AlgebraicException] if the first element of - /// [coefficients] is zero. + /// If the coefficients of your polynomial contain complex numbers, use the + /// [Algebraic.new] constructor instead. Algebraic.realEquation(List coefficients) - : this(coefficients.map(Complex.fromReal).toList(growable: false)); + : this( + coefficients.map(Complex.fromReal).toList(growable: false), + ); - /// Creates an [Algebraic] subtype according with the length of the - /// [coefficients] list. In particular: + /// {@template algebraic_from} + /// Creates an [Algebraic] object according to the length of [coefficients]. + /// In particular: /// /// - if the length is 1, a [Constant] object is returned; /// - if the length is 2, a [Linear] object is returned; /// - if the length is 3, a [Quadratic] object is returned; /// - if the length is 4, a [Cubic] object is returned; /// - if the length is 5, a [Quartic] object is returned; - /// - if the length is 6 or higher, a [DurandKerner] object is returned. + /// - if the length is 6 or higher, a [GenericAlgebraic] object is returned. /// - /// If the length of [coefficients] was 3 for example, it would mean that - /// you're trying to solve a quadratic equation (because a quadratic has - /// exactly 3 coefficients). Another example: + /// For example: /// /// ```dart /// final linear = Algebraic.from(const [ @@ -99,24 +109,18 @@ abstract base class Algebraic { /// ``` /// /// In this case, `linear` is of type [Linear] because the given coefficients - /// list represent the `(1 + 3i)x + i = 0` equation. + /// list represents the `(1 + 3i)x + i = 0` equation. + /// {@endtemplate} /// /// Use this method when the coefficients can be complex numbers. If there - /// were only real numbers, use the [Algebraic.fromReal] method which is more - /// convenient. + /// are only real numbers, use the [Algebraic.fromReal] constructor which is + /// more convenient. factory Algebraic.from(List coefficients) { - // Reminder: 'Complex' is immutable so there's no risk of getting undesired - // side effects if 'coefficients' is altered switch (coefficients.length) { case 1: - return Constant( - a: coefficients.first, - ); + return Constant(a: coefficients.first); case 2: - return Linear( - a: coefficients.first, - b: coefficients[1], - ); + return Linear(a: coefficients.first, b: coefficients[1]); case 3: return Quadratic( a: coefficients.first, @@ -139,38 +143,19 @@ abstract base class Algebraic { e: coefficients[4], ); default: - return DurandKerner( + return GenericAlgebraic( coefficients: coefficients, ); } } - /// Creates an [Algebraic] subtype according with the length of the - /// [coefficients] list. In particular: - /// - /// - if the length is 1, a [Constant] object is returned; - /// - if the length is 2, a [Linear] object is returned; - /// - if the length is 3, a [Quadratic] object is returned; - /// - if the length is 4, a [Cubic] object is returned; - /// - if the length is 5, a [Quartic] object is returned; - /// - if the length is 6 or higher, a [DurandKerner] object is returned. + /// {@macro algebraic_from} /// - /// If the length of [coefficients] was 3 for example, it would mean that - /// you're trying to solve a quadratic equation (because a quadratic has - /// exactly 3 coefficients). Another example: - /// - /// ```dart - /// final linear = Algebraic.fromReal(const [0.5, 6]); - /// ``` - /// - /// In this case, `linear` is of type [Linear] because the given coefficients - /// represent the `0.5x + 6 = 0` equation. - /// - /// Use this method when the coefficients are all real numbers. If there - /// were complex numbers as well, use the [Algebraic.new] instead. + /// Use this method when the coefficients are all real numbers. If there are + /// complex numbers as well, use the [Algebraic.from] constructor instead. factory Algebraic.fromReal(List coefficients) => Algebraic.from( - coefficients.map(Complex.fromReal).toList(growable: false), - ); + coefficients.map(Complex.fromReal).toList(growable: false), + ); @override bool operator ==(Object other) { @@ -179,25 +164,16 @@ abstract base class Algebraic { } if (other is Algebraic) { - // The lengths of the coefficients must match. if (coefficients.length != other.coefficients.length) { return false; } - - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the - // coefficients list. - var equalsCount = 0; - for (var i = 0; i < coefficients.length; ++i) { - if (coefficients[i] == other.coefficients[i]) { - ++equalsCount; + if (coefficients[i] != other.coefficients[i]) { + return false; } } - // They must have the same runtime type AND all items must be equal. - return runtimeType == other.runtimeType && - equalsCount == coefficients.length; + return runtimeType == other.runtimeType; } else { return false; } @@ -211,6 +187,10 @@ abstract base class Algebraic { /// Returns a string representation of the polynomial where the coefficients /// are converted into their fractional representation. + /// + /// This method provides a more readable representation of polynomials with + /// rational coefficients by converting decimal values to fractions where + /// possible. String toStringWithFractions() => _convertToString(asFraction: true); /// Represents the equation as a string. If [asFraction] is `true` then @@ -277,15 +257,33 @@ abstract base class Algebraic { } } - /// A polynomial equation is **valid** if the coefficient associated to the - /// variable of highest degree is different from zero. In other words, the - /// polynomial is valid if `a` is different from zero. + /// A polynomial equation is **valid** if the coefficient associated with the + /// variable of highest degree is not zero. In other words, the polynomial is + /// valid if the first coefficient in the list (which represents the highest + /// degree term) is not zero. /// - /// A [Constant] is an exception because a constant value has no variables + /// A [Constant] is a special case because a constant value has no variables /// with a degree. - bool get _isValid => this is Constant || !coefficients.first.isZero; + bool get _isValid { + if (coefficients.isEmpty) { + return false; + } + + return this is Constant || !coefficients.first.isZero; + } - /// Evaluates the polynomial on the given [x] value. + /// Evaluates the polynomial at the given complex value [x]. + /// + /// This method computes P(x) where P is this polynomial and x is the given + /// complex number. The evaluation is performed using Horner's method for + /// numerical stability. + /// + /// Example: + /// ```dart + /// final poly = Quadratic.realEquation(a: 1, b: 2, c: 1); // x² + 2x + 1 + /// final result = poly.evaluateOn(Complex.fromReal(3)); + /// // result = Complex(16, 0) because 3² + 2(3) + 1 = 9 + 6 + 1 = 16 + /// ``` Complex evaluateOn(Complex x) { var value = const Complex.zero(); var power = coefficients.length - 1; @@ -303,10 +301,35 @@ abstract base class Algebraic { return value; } - /// Evaluates the polynomial on the given decimal [x] value. + /// Evaluates the polynomial at the given real value [x]. + /// + /// This is a convenience method that converts the real number [x] to a + /// complex number and calls [evaluateOn]. It's useful when you know you're + /// working with real numbers and want to avoid the verbosity of creating + /// [Complex] objects. + /// + /// Example: + /// ```dart + /// final poly = Linear.realEquation(a: 2, b: 3); // 2x + 3 + /// final result = poly.realEvaluateOn(5); + /// // result = Complex(13, 0) because 2(5) + 3 = 13 + Complex realEvaluateOn(double x) => evaluateOn(Complex.fromReal(x)); - /// Evaluates the integral of the the polynomial between [lower] and [upper]. + /// Evaluates the definite integral of the polynomial from [lower] to [upper]. + /// + /// This method computes ∫`[lower, upper]` P(x)dx where P is this polynomial. + /// The integral is computed analytically using the power rule for + /// integration. For example: + /// + /// ```dart + /// final poly = Linear.realEquation(a: 2, b: 3); // 2x + 3 + /// final integral = poly.evaluateIntegralOn(0, 2); + /// // integral = Complex(10, 0) because ∫(2x+3)dx from 0 to 2 = 10 + /// ``` + /// + /// The method works with both real and complex coefficients, returning + /// complex results when necessary. Complex evaluateIntegralOn(double lower, double upper) { var upperSum = const Complex.zero(); var lowerSum = const Complex.zero(); @@ -378,7 +401,7 @@ abstract base class Algebraic { /// coefficients. /// /// The degrees of the two polynomials don't need to be the same. For example, - /// you could sum a [Cubic] with a [Linear]. + /// you can sum a [Cubic] with a [Linear]. Algebraic operator +(Algebraic other) { final maxDegree = max(coefficients.length, other.coefficients.length); final newCoefficients = []; @@ -404,7 +427,7 @@ abstract base class Algebraic { /// corresponding coefficients. /// /// The degrees of the two polynomials don't need to be the same. For example, - /// you could subtract a [Quadratic] and a [Quartic]. + /// you can subtract a [Quadratic] from a [Quartic]. Algebraic operator -(Algebraic other) { final maxDegree = max(coefficients.length, other.coefficients.length); final newCoefficients = []; @@ -430,7 +453,7 @@ abstract base class Algebraic { /// corresponding coefficients of the polynomials. /// /// The degrees of the two polynomials don't need to be the same. For example, - /// you could multiply a [Constant] with a [DurandKerner]. + /// you can multiply a [Constant] with a [GenericAlgebraic]. Algebraic operator *(Algebraic other) { // Generating the new list of coefficients final newLength = coefficients.length + other.coefficients.length - 1; @@ -450,11 +473,13 @@ abstract base class Algebraic { return Algebraic.from(newCoefficients); } - /// This operator divides a polynomial by another polynomial of the same or - /// lower degree. + /// This operator divides a polynomial by another polynomial using the + /// polynomial long division algorithm. The returned [AlgebraicDivision] type + /// is a record type that contains both the quotient and the remainder of the + /// division. /// - /// The algorithm used to divide a polynomial by another is called "Polynomial - /// long division" and it's implemented in the [PolynomialLongDivision] class. + /// The algorithm used to divide polynomials is implemented by the + /// [PolynomialLongDivision] class. AlgebraicDivision operator /(Algebraic other) { final polyLongDivison = PolynomialLongDivision( polyNumerator: this, @@ -464,19 +489,208 @@ abstract base class Algebraic { return polyLongDivison.divide(); } - /// The 'negation' operator changes the sign of every coefficient of the + /// The unary minus operator changes the sign of every coefficient of the /// polynomial. For example: /// /// ```dart /// final poly1 = Linear.realEquation(a: 3, b: -5); /// final poly2 = -poly1; // poly2 = Linear.realEquation(a: -3, b: 5); /// ``` - /// - /// As you can see, in `poly2` all the coefficients have the opposite sign. Algebraic operator -() => Algebraic.from(coefficients.map((c) => -c).toList(growable: false)); + /// Factors the polynomial into irreducible factors. + /// + /// This method decomposes the polynomial into a product of irreducible + /// factors. For example: + /// + /// ```dart + /// final poly1 = Quadratic.realEquation(b: 0, c: -4); // x² - 4 + /// final factors1 = poly1.factor(); + /// // Returns [Linear(b: -2), Linear(b: 2)] + /// // Which represents (x - 2)(x + 2) + /// + /// final poly2 = Quadratic.realEquation(b: 0, c: 4); // x² + 4 + /// final factors2 = poly2.factor(); + /// // Returns [Linear(b: -2i), Linear(b: 2i)] + /// // Which represents (x - 2i)(x + 2i) + /// ``` + /// + /// Edge cases: + /// + /// - If the polynomial has no roots, returns a list containing only this + /// polynomial (indicating it is already irreducible) + /// + /// - If the polynomial is constant (degree 0), returns a list containing + /// only this polynomial + /// + /// - Repeated roots are handled correctly, with factors appearing multiple + /// times according to their multiplicity + /// + /// The factorization is not guaranteed to be unique, especially for + /// polynomials with complex coefficients. + List factor() { + final roots = solutions(); + + // If the polynomial has no roots, it is already factored. + if (roots.isEmpty) { + return [this]; + } + + // Group roots by their value (to handle repeated roots) + final rootGroups = {}; + for (final root in roots) { + rootGroups[root] = (rootGroups[root] ?? 0) + 1; + } + + // Convert each root into a linear factor + final factors = []; + for (final entry in rootGroups.entries) { + final root = entry.key; + final multiplicity = entry.value; + + // Create a linear factor (x - root) + final factor = Linear(b: -root); + + // Add the factor as many times as its multiplicity + for (var i = 0; i < multiplicity; i++) { + factors.add(factor); + } + } + + return factors; + } + + /// Solves the inequality associated with this polynomial. + /// + /// The inequality type is specified by the [inequalityType] parameter, which + /// can be one of the following (where P(x) represents this polynomial): + /// + /// - [AlgebraicInequalityType.lessThan]: solves P(x) < 0 + /// - [AlgebraicInequalityType.lessThanOrEqualTo]: solves P(x) ≤ 0 + /// - [AlgebraicInequalityType.greaterThan]: solves P(x) > 0 + /// - [AlgebraicInequalityType.greaterThanOrEqualTo]: solves P(x) ≥ 0 + /// + /// The [precision] parameter (defaults to 1e-10) is used to determine if a + /// root is real or complex. If the imaginary part of a root is less than + /// [precision], it is considered real. The precision must be a positive + /// number. + /// + /// Returns a list of [AlgebraicInequalitySolution] objects representing the + /// intervals where the inequality is satisfied. + /// + /// The returned list can be empty if the inequality is not satisfied for any + /// real number. + /// + /// Throws an [AlgebraicException] if: + /// - The polynomial has complex coefficients + /// - The precision parameter is not positive + List solveInequality({ + required AlgebraicInequalityType inequalityType, + double precision = 1e-10, + }) { + // First check the simpler validation + if (precision <= 0) { + throw const AlgebraicException( + 'The precision must be a positive number.', + ); + } + + // Then check for complex coefficients + if (!isRealEquation) { + throw const AlgebraicException( + 'Inequalities are not well-defined in the complex plane.', + ); + } + + // Get all roots of the polynomial + final roots = solutions(); + + // Filter out complex roots and convert to real numbers + final realRoots = roots + .where((root) => root.imaginary.abs() < precision) + .map((root) => root.real) + .toList(); + + // If there are no real roots, check if the polynomial is always positive or + // negative + if (realRoots.isEmpty) { + final testValue = realEvaluateOn(0); + final isPositive = testValue.real > 0; + final isSatisfied = switch (inequalityType) { + AlgebraicInequalityType.lessThan => !isPositive, + AlgebraicInequalityType.lessThanOrEqualTo => !isPositive, + AlgebraicInequalityType.greaterThan => isPositive, + AlgebraicInequalityType.greaterThanOrEqualTo => isPositive, + }; + + return isSatisfied ? [const AlgebraicInequalityAllRealNumbers()] : []; + } + + // Sort roots in ascending order + realRoots.sort((a, b) => a.compareTo(b)); + final inequalitySolutions = []; + + // Test interval before first root + final testBeforeFirst = realEvaluateOn(realRoots.first - 1.0); + if (_isInequalitySatisfied(testBeforeFirst, inequalityType)) { + inequalitySolutions.add( + AlgebraicInequalitySmallerThan( + value: realRoots.first, + isInclusive: + inequalityType == AlgebraicInequalityType.lessThanOrEqualTo, + ), + ); + } + + // Test intervals between consecutive roots + for (var i = 0; i < realRoots.length - 1; i++) { + final midPoint = (realRoots[i] + realRoots[i + 1]) / 2; + final testValue = realEvaluateOn(midPoint); + + if (_isInequalitySatisfied(testValue, inequalityType)) { + inequalitySolutions.add( + AlgebraicInequalityInterval( + start: realRoots[i], + end: realRoots[i + 1], + isInclusive: + inequalityType == AlgebraicInequalityType.lessThanOrEqualTo || + inequalityType == AlgebraicInequalityType.greaterThanOrEqualTo, + ), + ); + } + } + + // Test interval after last root + final testAfterLast = realEvaluateOn(realRoots.last + 1.0); + if (_isInequalitySatisfied(testAfterLast, inequalityType)) { + inequalitySolutions.add( + AlgebraicInequalityGreaterThan( + value: realRoots.last, + isInclusive: + inequalityType == AlgebraicInequalityType.greaterThanOrEqualTo, + ), + ); + } + + return inequalitySolutions; + } + + /// Helper method to check if a value satisfies the inequality + bool _isInequalitySatisfied(Complex value, AlgebraicInequalityType type) => + switch (type) { + AlgebraicInequalityType.lessThan => value.real < 0, + AlgebraicInequalityType.lessThanOrEqualTo => value.real <= 0, + AlgebraicInequalityType.greaterThan => value.real > 0, + AlgebraicInequalityType.greaterThanOrEqualTo => value.real >= 0, + }; + /// The polynomial discriminant, if it exists. + /// + /// The discriminant is a mathematical expression that provides information + /// about the nature of the roots of a polynomial equation. The discriminant + /// is well-defined for polynomials up to degree 4. For higher-degrees, it is + /// approximated with a numerical method. Complex discriminant(); /// Finds the roots (the solutions) of the associated _P(x) = 0_ equation. diff --git a/lib/src/algebraic/types/constant.dart b/lib/src/algebraic/types/constant.dart index 291c2026..3ac758d4 100644 --- a/lib/src/algebraic/types/constant.dart +++ b/lib/src/algebraic/types/constant.dart @@ -1,27 +1,25 @@ -import 'package:equations/equations.dart'; +part of '../algebraic.dart'; -/// Concrete implementation of [Algebraic] that represents a constant value -/// `a`. It can be either real or complex. +/// {@template constant_algebraic} +/// Concrete implementation of [Algebraic] that represents a constant value `a`. +/// It can be either a real or complex number, such as: /// -/// For example: -/// -/// - f(x) = 5 -/// - f(x) = 3 + 6i +/// - P(x) = 5 +/// - P(x) = 3 + 6i /// /// In the context of a polynomial with one variable, the non-zero constant /// function is a polynomial of degree 0. +/// {@endtemplate} final class Constant extends Algebraic { - /// The only coefficient of the polynomial is represented by a [Complex] - /// number [a]. - Constant({ - Complex a = const Complex.fromReal(1), - }) : super([a]); - - /// The only coefficient of the polynomial is represented by a [double] - /// (real) number [a]. - Constant.realEquation({ - double a = 1, - }) : super.realEquation([a]); + /// {@macro constant_algebraic} + /// + /// The only coefficient of the polynomial is represented by [a]. + Constant({Complex a = const Complex.fromReal(1)}) : super([a]); + + /// {@macro constant_algebraic} + /// + /// The only real coefficient of the polynomial is represented by [a]. + Constant.realEquation({double a = 1}) : super.realEquation([a]); @override num get degree => a.isZero ? double.negativeInfinity : 0; diff --git a/lib/src/algebraic/types/cubic.dart b/lib/src/algebraic/types/cubic.dart index c1c21d77..e29b2e64 100644 --- a/lib/src/algebraic/types/cubic.dart +++ b/lib/src/algebraic/types/cubic.dart @@ -1,7 +1,6 @@ -import 'dart:math' as math; - -import 'package:equations/equations.dart'; +part of '../algebraic.dart'; +/// {@template cubic_algebraic} /// Concrete implementation of [Algebraic] that represents a third degree /// polynomial equation in the form `ax^3 + bx^2 + cx + d = 0`. /// @@ -11,66 +10,88 @@ import 'package:equations/equations.dart'; /// - 3 real roots (some of them are equal) and 0 complex roots /// - 1 real root and 2 complex conjugate roots /// -/// The above cases depend on the value of the discriminant. +/// The above cases depend on the value of the discriminant. Some edge cases: +/// +/// - If [a] is very close to zero, the equation becomes numerically unstable; +/// - If the discriminant is very close to zero, the roots may be very close to +/// each other; +/// - Very large or very small coefficients may cause numerical overflow or +/// underflow. +/// +/// Throws [AlgebraicException] if: +/// +/// - [a] is zero (which would make it a quadratic equation); +/// - [a] is very close to zero (less than [epsilon]). +/// {@endtemplate} +/// +/// {@template cubic_algebraic_examples} +/// These are examples of cubic equations, where the coefficient with the +/// highest degree goes first: +/// +/// ```dart +/// // f(x) = 2x^3 + x^2 + 5 +/// final eq = Cubic( +/// a: Complex.fromReal(2), +/// b: Complex.fromReal(1), +/// d: Complex.fromReal(5), +/// ); +/// +/// // f(x) = x^3 + (-2 + 6i)x +/// final eq = Cubic( +/// a: Complex.fromReal(1), +/// c: Complex(-2, 6), +/// ); +/// +/// // f(x) = 2x^3 + x^2 + 5 +/// final eq = Cubic.fromReal( +/// a: 2, +/// b: 1, +/// d: 5, +/// ); +/// ``` +/// {@endtemplate} final class Cubic extends Algebraic { - /// These are examples of cubic equations, where the coefficient with the - /// highest degree goes first: + /// The value used to check if a coefficient is very close to zero. In other + /// words, if `|a| < epsilon`, then `a` is considered to be zero. /// - /// ```dart - /// // f(x) = 2x^3 + x^2 + 5 - /// final eq = Cubic( - /// a: Complex.fromReal(2), - /// b: Complex.fromReal(1), - /// d: Complex.fromReal(5), - /// ); + /// This value is used to avoid numerical instability when solving the cubic + /// equation. + static const epsilon = 1e-10; + + /// {@macro cubic_algebraic} /// - /// // f(x) = x^3 + (-2 + 6i)x - /// final eq = Cubic( - /// a: Complex.fromReal(1), - /// c: Complex(-2, 6), - /// ); - /// ``` + /// {@macro cubic_algebraic_examples} /// /// Use this constructor if you have complex coefficients. If no [Complex] - /// values are required, then consider using [Cubic.realEquation] for a - /// less verbose syntax. + /// values are required, consider using [Cubic.realEquation] for a less + /// verbose syntax. Cubic({ Complex a = const Complex.fromReal(1), Complex b = const Complex.zero(), Complex c = const Complex.zero(), Complex d = const Complex.zero(), - }) : super([a, b, c, d]); + }) : super([a, b, c, d]) { + _validateCoefficients(a); + } - /// These are examples of cubic equations, where the coefficient with the - /// highest degree goes first: + /// {@macro cubic_algebraic} /// - /// ```dart - /// // f(x) = 2x^3 + x^2 + 5 - /// final eq = Cubic.fromReal( - /// a: 2, - /// b: 1, - /// d: 5, - /// ); - /// ``` + /// {@macro cubic_algebraic_examples} /// /// If the coefficients of your polynomial contain complex numbers, consider /// using the [Cubic.new] constructor instead. - Cubic.realEquation({ - double a = 1, - double b = 0, - double c = 0, - double d = 0, - }) : super.realEquation([a, b, c, d]); + Cubic.realEquation({double a = 1, double b = 0, double c = 0, double d = 0}) + : super.realEquation([a, b, c, d]); @override int get degree => 3; @override Algebraic derivative() => Quadratic( - a: a * const Complex.fromReal(3), - b: b * const Complex.fromReal(2), - c: c, - ); + a: a * const Complex.fromReal(3), + b: b * const Complex.fromReal(2), + c: c, + ); @override Complex discriminant() { @@ -85,40 +106,108 @@ final class Cubic extends Algebraic { @override List solutions() { + // Special case: c = d = 0 (equation in form ax^3 + bx^2 = 0) + if (c.isZero && d.isZero) { + return [const Complex.zero(), const Complex.zero(), -b / a]; + } + + // Special case: b = c = 0 (depressed cubic) + if (b.isZero && c.isZero) { + return _solveDepressedCubic(); + } + + // General case using Cardano's formula + return _solveGeneralCubic(); + } + + /// Solves the depressed cubic equation ax³ + d = 0. + List _solveDepressedCubic() { + final solution1 = (d.negate / a).nthRoot(3); + final omega = Complex(-1 / 2, sqrt(3) / 2); + + return [solution1, solution1 * omega, solution1 * omega.pow(2)]; + } + + /// Solves the general cubic equation using Cardano's formula. + List _solveGeneralCubic() { const two = Complex.fromReal(2); const three = Complex.fromReal(3); - final sigma = Complex(-1 / 2, 1 / 2 * math.sqrt(3)); + final omega = Complex(-1 / 2, sqrt(3) / 2); + // Calculate intermediate values final d0 = b * b - a * c * three; - final d1 = (b.pow(3) * two) - + final d1 = + (b.pow(3) * two) - (a * b * c * const Complex.fromReal(9)) + (a * a * d * const Complex.fromReal(27)); - final sqrtD = (discriminant() * a * a * const Complex.fromReal(-27)).sqrt(); - final C = ((d1 + sqrtD) / two).nthRoot(3); + + // Calculate discriminant + final disc = discriminant(); + + // Handle case where discriminant is very close to zero + if (disc.abs() < epsilon) { + return _handleNearZeroDiscriminant(d0, d1); + } + + // Calculate C using a more stable formula + final sqrtD = (disc * a * a * const Complex.fromReal(-27)).sqrt(); + final C = _calculateC(d1, sqrtD); + + // Calculate the constant term final constTerm = const Complex.fromReal(-1) / (a * three); + // Return the three solutions return [ constTerm * (b + C + (d0 / C)), - constTerm * (b + (C * sigma) + (d0 / (C * sigma))), - constTerm * (b + (C * sigma.pow(2)) + (d0 / (C * sigma.pow(2)))), + constTerm * (b + (C * omega) + (d0 / (C * omega))), + constTerm * (b + (C * omega.pow(2)) + (d0 / (C * omega.pow(2)))), ]; } - /// The first coefficient of the equation in the form - /// _f(x) = ax^3 + bx^2 + cx + d = 0_ - Complex get a => coefficients.first; + /// Handles the case where the discriminant is very close to zero + List _handleNearZeroDiscriminant(Complex d0, Complex d1) { + // When discriminant is near zero, we have a triple root or a double root + final x = -b / (a * const Complex.fromReal(3)); - /// The second coefficient of the equation in the form - /// _f(x) = ax^3 + bx^2 + cx + d = 0_ - Complex get b => coefficients[1]; + if (d0.abs() < epsilon) { + // Triple root + return [x, x, x]; + } else { + // Double root and a single root + final doubleRoot = x; + final singleRoot = -b / a - const Complex.fromReal(2) * x; + return [doubleRoot, doubleRoot, singleRoot]; + } + } - /// The third coefficient of the equation in the form - /// _f(x) = ax^3 + bx^2 + cx + d = 0_ - Complex get c => coefficients[2]; + /// Calculates C in a numerically stable way + Complex _calculateC(Complex d1, Complex sqrtD) { + // Use a more stable formula for calculating C + final sum = d1 + sqrtD; + final diff = d1 - sqrtD; - /// The fourth coefficient of the equation in the form - /// _f(x) = ax^3 + bx^2 + cx + d = 0_ - Complex get d => coefficients[3]; + if (sum.abs() > diff.abs()) { + return (sum / const Complex.fromReal(2)).nthRoot(3); + } else { + return (diff / const Complex.fromReal(2)).nthRoot(3); + } + } + + /// Validates the coefficients of the cubic equation. + void _validateCoefficients(Complex a) { + if (a.isZero) { + throw const AlgebraicException( + 'The coefficient of x^3 cannot be zero in a cubic equation.', + ); + } + + // Check if a is very close to zero (for numerical stability) + if (a.abs() < epsilon) { + throw const AlgebraicException( + '"a" is too close to zero, which may cause numerical instability.', + ); + } + } /// {@macro algebraic_deep_copy} Cubic copyWith({ @@ -126,11 +215,28 @@ final class Cubic extends Algebraic { Complex? b, Complex? c, Complex? d, - }) => - Cubic( - a: a ?? this.a, - b: b ?? this.b, - c: c ?? this.c, - d: d ?? this.d, - ); + }) => Cubic( + a: a ?? this.a, + b: b ?? this.b, + c: c ?? this.c, + d: d ?? this.d, + ); + + /// {@macro first_coefficient_algebraic} + /// {@template cubic.equation_form} + /// _f(x) = ax^3 + bx^2 + cx + d = 0_ + /// {@endtemplate} + Complex get a => coefficients.first; + + /// {@macro second_coefficient_algebraic} + /// {@macro cubic.equation_form} + Complex get b => coefficients[1]; + + /// {@macro third_coefficient_algebraic} + /// {@macro cubic.equation_form} + Complex get c => coefficients[2]; + + /// {@macro fourth_coefficient_algebraic} + /// {@macro cubic.equation_form} + Complex get d => coefficients[3]; } diff --git a/lib/src/algebraic/types/durand_kerner.dart b/lib/src/algebraic/types/durand_kerner.dart deleted file mode 100644 index cd1e6f23..00000000 --- a/lib/src/algebraic/types/durand_kerner.dart +++ /dev/null @@ -1,563 +0,0 @@ -import 'dart:math' as math; - -import 'package:equations/equations.dart'; -import 'package:equations/src/utils/math_utils.dart'; - -/// The Durand–Kerner method, also known as Weierstrass method, is a root -/// finding algorithm for solving polynomial equations. With this class, you -/// can find all roots of a polynomial of any degree. -/// -/// This is the preferred approach: -/// -/// - when the polynomial degree is 5 or higher, use [DurandKerner]; -/// - when the polynomial degree is 4, use [Quartic]; -/// - when the polynomial degree is 3, use [Cubic]; -/// - when the polynomial degree is 2, use [Quadratic]; -/// - when the polynomial degree is 1, use [Linear]. -/// -/// The algorithm requires an initial set of values to find the roots. This -/// implementation generates some random values if the user doesn't provide -/// initial points to the algorithm. -/// -/// Note that this algorithm does **NOT** always converge. To be more clear, it -/// is **NOT** true that for every polynomial, the set of initial vectors that -/// eventually converges to roots is open and dense. -final class DurandKerner extends Algebraic with MathUtils { - /// The initial guess from which the algorithm has to start finding the roots. - /// - /// By default, this is an empty list because this class can provide some - /// pre-built values that are good in **most of** the cases (but not always). - /// - /// You can provide specific initial guesses with this param. - /// - /// The length of the [initialGuess] must equals the coefficients length minus - /// one. For example, this is ok... - /// - /// ```dart - /// final durandKerner = DurandKerner( - /// coefficients: [ - /// Complex.fromReal(-5), - /// Complex.fromReal(3), - /// Complex.i(), - /// ], - /// initialGuess: [ - /// Complex(1, -2), - /// Complex.fromReal(3), - /// ], - /// ); - /// ``` - /// - /// ... but this is **not** ok: - /// - ///```dart - /// final durandKerner = DurandKerner( - /// coefficients: [ - /// Complex.fromReal(-5), - /// Complex.fromReal(3), - /// Complex.i(), - /// ], - /// initialGuess: [ - /// Complex(1, -2), - /// // missing a value here! - /// ], - /// ); - /// ``` - final List initialGuess; - - /// The accuracy of the algorithm. - final double precision; - - /// The maximum steps to be made by the algorithm. - final int maxSteps; - - /// Creates a new object that finds all the roots of a polynomial equation - /// using the Durand-Kerner algorithm. The polynomial can have both complex - /// ([Complex]) and real ([double]) values. - /// - /// - [coefficients]: the coefficients of the polynomial; - /// - [initialGuess]: the initial guess from which the algorithm has to - /// start finding the roots; - /// - [precision]: the accuracy of the algorithm; - /// - [maxSteps]: the maximum steps to be made by the algorithm. - /// - /// Note that the coefficient with the highest degree goes first. For example, - /// the coefficients of the `-5x^2 + 3x + i = 0` have to be inserted in the - /// following way: - /// - /// ```dart - /// final durandKerner = DurandKerner( - /// coefficients: [ - /// Complex.fromReal(-5), - /// Complex.fromReal(3), - /// Complex.i(), - /// ], - /// ); - /// ``` - /// - /// Since `-5` is the coefficient with the highest degree (2), it goes first. - /// If the coefficients of your polynomial are only real numbers, consider - /// using the [DurandKerner.realEquation] constructor instead. - DurandKerner({ - required List coefficients, - this.initialGuess = const [], - this.precision = 1.0e-10, - this.maxSteps = 2000, - }) : super(coefficients); - - /// Creates a new object that finds all the roots of a polynomial equation - /// using the Durand-Kerner algorithm. The polynomial can only have real - /// ([double]) values. - /// - /// - [coefficients]: the coefficients of the polynomial; - /// - [initialGuess]: the initial guess from which the algorithm has to - /// start finding the roots; - /// - [precision]: the accuracy of the algorithm; - /// - [maxSteps]: the maximum steps to be made by the algorithm. - /// - /// Note that the coefficient with the highest degree goes first. For example, - /// the coefficients of the `-5x^2 + 3x + 1 = 0` has to be inserted in the - /// following way: - /// - /// ```dart - /// final durandKerner = DurandKerner.realEquation( - /// coefficients [-5, 3, 1], - /// ); - /// ``` - /// - /// Since `-5` is the coefficient with the highest degree (2), it goes first. - /// If the coefficients of your polynomial contain complex numbers, consider - /// using the [DurandKerner.new] constructor instead. - DurandKerner.realEquation({ - required List coefficients, - this.initialGuess = const [], - this.precision = 1.0e-10, - this.maxSteps = 2000, - }) : super.realEquation(coefficients); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is DurandKerner) { - // The lengths of the data lists must match - if (initialGuess.length != other.initialGuess.length) { - return false; - } - - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the data - // list. - var equalsCount = 0; - - for (var i = 0; i < initialGuess.length; ++i) { - if (initialGuess[i] == other.initialGuess[i]) { - ++equalsCount; - } - } - - // They must have the same runtime type AND all items must be equal. - return super == other && - equalsCount == initialGuess.length && - precision == other.precision && - maxSteps == other.maxSteps; - } else { - return false; - } - } - - @override - int get hashCode { - var result = super.hashCode; - - // Like we did in operator== iterating over all elements ensures that the - // hashCode is properly calculated. - for (var i = 0; i < initialGuess.length; ++i) { - result = result * 37 + initialGuess[i].hashCode; - } - - result = result * 37 + precision.hashCode; - result = result * 37 + maxSteps.hashCode; - - return result; - } - - @override - int get degree => coefficients.length - 1; - - @override - Algebraic derivative() { - // Rather than always returning 'DurandKerner', if the degree is <= 4 there - // is the possibility to return a more convenient object - switch (coefficients.length) { - case 1: - return Constant( - a: coefficients.first, - ).derivative(); - case 2: - return Linear( - a: coefficients.first, - b: coefficients[1], - ).derivative(); - case 3: - return Quadratic( - a: coefficients.first, - b: coefficients[1], - c: coefficients[2], - ).derivative(); - case 4: - return Cubic( - a: coefficients.first, - b: coefficients[1], - c: coefficients[2], - d: coefficients[3], - ).derivative(); - case 5: - return Quartic( - a: coefficients.first, - b: coefficients[1], - c: coefficients[2], - d: coefficients[3], - e: coefficients[4], - ).derivative(); - case 6: - final coeffs = _derivativeOf(); - return Quartic( - a: coeffs.first, - b: coeffs[1], - c: coeffs[2], - d: coeffs[3], - e: coeffs[4], - ); - default: - return DurandKerner( - coefficients: _derivativeOf(), - precision: precision, - maxSteps: maxSteps, - ); - } - } - - @override - Complex discriminant() { - // Say that P(x) is the polynomial represented by this instance and - // P'(x) is the derivative of P. In order to calculate the discriminant of - // a polynomial, we need to first compute the resultant Res(A, A') which - // is equivalent to the determinant of the Sylvester matrix. - final sylvester = SylvesterMatrix( - polynomial: this, - ); - - // Computes Res(A, A') and then determines the sign according with the - // degree of the polynomial. - return sylvester.polynomialDiscriminant(); - } - - @override - List solutions() { - // In case the polynomial was a constant, just return an empty array because - // there are no solutions. - if (coefficients.length <= 1) { - return []; - } - - // Proceeding with the setup since the polynomial degree is >= 1. - final coefficientsLength = coefficients.length; - final reversedCoeffs = coefficients.reversed.toList(growable: false); - - // Buffers for numerators and denominators or real and complex parts. - final realBuffer = reversedCoeffs.map((e) => e.real).toList( - growable: false, - ); - final imaginaryBuffer = reversedCoeffs.map((e) => e.imaginary).toList( - growable: false, - ); - - // Scaling the various coefficients. - var upperReal = realBuffer[coefficientsLength - 1]; - var upperComplex = imaginaryBuffer[coefficientsLength - 1]; - final squareSum = upperReal * upperReal + upperComplex * upperComplex; - - upperReal /= squareSum; - upperComplex /= -squareSum; - - var k1 = 0.0; - var k2 = 0.0; - var k3 = 0.0; - final s = upperComplex - upperReal; - final t = upperReal + upperComplex; - - for (var i = 0; i < coefficientsLength - 1; ++i) { - k1 = upperReal * (realBuffer[i] + imaginaryBuffer[i]); - k2 = realBuffer[i] * s; - k3 = imaginaryBuffer[i] * t; - realBuffer[i] = k1 - k3; - imaginaryBuffer[i] = k1 + k2; - } - - realBuffer[coefficientsLength - 1] = 1.0; - imaginaryBuffer[coefficientsLength - 1] = 0.0; - - // Using default values to compute the solutions. If they aren't provided, - // we will generate default ones. - if (initialGuess.isNotEmpty) { - final real = initialGuess.map((e) => e.real).toList( - growable: false, - ); - final complex = initialGuess.map((e) => e.imaginary).toList( - growable: false, - ); - - return _solve( - realValues: real, - imaginaryValues: complex, - realBuffer: realBuffer, - imaginaryBuffer: imaginaryBuffer, - ); - } else { - // If we're here, it means that no initial guesses were provided and so we - // need to generate some good ones. - final real = List.generate( - coefficientsLength - 1, - (_) => 0.0, - growable: false, - ); - final complex = List.generate( - coefficientsLength - 1, - (_) => 0.0, - growable: false, - ); - - final bound = _bound( - value: coefficientsLength, - realBuffer: realBuffer, - imaginaryBuffer: imaginaryBuffer, - ); - final factor = bound * 0.65; - final multiplier = math.cos(0.25 * 2 * math.pi); - - for (var i = 0; i < coefficientsLength - 1; ++i) { - real[i] = factor * multiplier; - complex[i] = factor * math.sqrt(1.0 - multiplier * multiplier); - } - - return _solve( - realValues: real, - imaginaryValues: complex, - realBuffer: realBuffer, - imaginaryBuffer: imaginaryBuffer, - ); - } - } - - /// Returns the coefficients of the derivative of a given polynomial. - List _derivativeOf() { - final newLength = coefficients.length - 1; - - // The derivative - final result = List.generate( - newLength, - (_) => const Complex.zero(), - growable: false, - ); - - // Evaluation of the derivative - for (var i = 0; i < newLength; ++i) { - result[i] = coefficients[i] * Complex.fromReal((newLength - i) * 1.0); - } - - return result; - } - - /// {@macro algebraic_deep_copy} - DurandKerner copyWith({ - List? coefficients, - List? initialGuess, - double? precision, - int? maxSteps, - }) => - DurandKerner( - coefficients: coefficients ?? List.from(this.coefficients), - initialGuess: initialGuess ?? List.from(this.initialGuess), - precision: precision ?? this.precision, - maxSteps: maxSteps ?? this.maxSteps, - ); - - /// Determines whether subsequent points are close enough (where "enough" is - /// defined by [precision]. - bool _near(double a, double b, double c, double d) { - final qa = a - c; - final qb = b - d; - - return (qa * qa + qb * qb) < precision; - } - - /// Returns the maximum magnitude of the complex number, increased by 1. - double _bound({ - required int value, - required List realBuffer, - required List imaginaryBuffer, - }) { - var bound = 0.0; - - for (var i = 0; i < value; ++i) { - final realSquare = realBuffer[i] * realBuffer[i]; - final imagSquare = imaginaryBuffer[i] * imaginaryBuffer[i]; - - bound = math.max(bound, realSquare + imagSquare); - } - - return 1.0 + math.sqrt(bound); - } - - /// The Durand-Kerner algorithm that finds the roots of the polynomial. - List _solve({ - required List realValues, - required List imaginaryValues, - required List realBuffer, - required List imaginaryBuffer, - }) { - final coefficientsLength = coefficients.length; - final realValuesLen = realValues.length; - - // Variables setup. - var pa = 0.0; - var pb = 0.0; - var qa = 0.0; - var qb = 0.0; - var k1 = 0.0; - var k2 = 0.0; - var k3 = 0.0; - var na = 0.0; - var nb = 0.0; - var s1 = 0.0; - var s2 = 0.0; - - // Main iteration loop of the Durand-Kerner algorithm. - for (var i = 0; i < maxSteps; ++i) { - var d = 0.0; - - for (var j = 0; j < realValuesLen; ++j) { - pa = realValues[j]; - pb = imaginaryValues[j]; - - // Computing the denominator of type (zj - z0) * ... * (zj - z_{n-1}). - var a = 1.0; - var b = 1.0; - for (var k = 0; k < realValuesLen; ++k) { - if (k == j) { - continue; - } - - qa = pa - realValues[k]; - qb = pb - imaginaryValues[k]; - - // Tolerance test. - if (qa * qa + qb * qb < precision) { - continue; - } - - k1 = qa * (a + b); - k2 = a * (qb - qa); - k3 = b * (qa + qb); - a = k1 - k3; - b = k1 + k2; - } - - // Computing the numerator. - na = realBuffer[coefficientsLength - 1]; - nb = imaginaryBuffer[coefficientsLength - 1]; - s1 = pb - pa; - s2 = pa + pb; - - for (var k = coefficientsLength - 2; k >= 0; --k) { - k1 = pa * (na + nb); - k2 = na * s1; - k3 = nb * s2; - na = k1 - k3 + realBuffer[k]; - nb = k1 + k2 + imaginaryBuffer[k]; - } - - // Computing the reciprocal. - k1 = a * a + b * b; - if (k1.abs() > precision) { - a /= k1; - b /= -k1; - } else { - a = 1.0; - b = 0.0; - } - - // Multiplying and accumulating. - k1 = na * (a + b); - k2 = a * (nb - na); - k3 = b * (na + nb); - - qa = k1 - k3; - qb = k1 + k2; - - realValues[j] = pa - qa; - imaginaryValues[j] = pb - qb; - - d = math.max(d, math.max(qa.abs(), qb.abs())); - } - - // Exiting early if convergence is reached. - if (d < precision) { - break; - } - } - - // Done! Now we need to combine together repeated roots. - var count = 0.0; - - for (var i = 0; i < realValuesLen; ++i) { - count = 1; - var a = realValues[i]; - var b = imaginaryValues[i]; - for (var j = 0; j < realValuesLen; ++j) { - if (i == j) { - continue; - } - if (_near( - realValues[i], - imaginaryValues[i], - realValues[j], - imaginaryValues[j], - )) { - ++count; - a += realValues[j]; - b += imaginaryValues[j]; - } - } - if (count > 1) { - a /= count; - b /= count; - for (var j = 0; j < realValuesLen; ++j) { - if (i == j) { - continue; - } - if (_near( - realValues[i], - imaginaryValues[i], - realValues[j], - imaginaryValues[j], - )) { - realValues[j] = a; - imaginaryValues[j] = b; - } - } - realValues[i] = a; - imaginaryValues[i] = b; - } - } - - // Merging the two real and complex helper arrays into a single list. - return List.generate( - coefficientsLength - 1, - (index) => Complex(realValues[index], imaginaryValues[index]), - growable: false, - ); - } -} diff --git a/lib/src/algebraic/types/generic_algebraic.dart b/lib/src/algebraic/types/generic_algebraic.dart new file mode 100644 index 00000000..47223e68 --- /dev/null +++ b/lib/src/algebraic/types/generic_algebraic.dart @@ -0,0 +1,371 @@ +part of '../algebraic.dart'; + +/// {@template generic_algebraic} +/// Concrete implementation of [Algebraic] that approximates all roots of a +/// polynomial of any degree. +/// +/// For finding roots of a polynomial of degree 4 or lower, consider using +/// [Quartic], [Cubic], [Quadratic] or [Linear] instead, as they are more +/// efficient and numerically stable. +/// +/// There is NO direct formula for finding the roots of a polynomial of degree +/// 5 or higher so this class returns a good approximation of the roots, but not +/// the exact ones. +/// +/// An initial set of values [initialGuess] is required to find the roots but it +/// is optional. This implementation by default uses the Aberth method to +/// generate initial guesses if none are provided. If you are not sure which +/// initial values to provide, just leave [initialGuess] empty. +/// +/// Note that this algorithm does **NOT** always converge. In other words, it is +/// **NOT** true that for every polynomial, the set of initial vectors that +/// eventually converges to roots is open and dense. +/// {@endtemplate} +/// +/// {@template generic_algebraic_example} +/// These are examples of generic algebraic equations, where the coefficient +/// with the highest degree goes first: +/// +/// ```dart +/// // P(x) = -5x^2 + 3x + i +/// final genericAlgebraic1 = GenericAlgebraic( +/// coefficients: [ +/// Complex.fromReal(-5), +/// Complex.fromReal(3), +/// Complex.i(), +/// ], +/// initialGuess: [ +/// Complex(1, -2), +/// Complex.fromReal(3), +/// ], +/// ); +/// +/// // P(x) = (3 + 8i)x^4 - 2x^2 + (-1 + 5i)x + 6 + (3 + 4i) +/// final genericAlgebraic2 = GenericAlgebraic( +/// coefficients: [ +/// Complex(3, 8), +/// Complex.fromReal(-2), +/// Complex(-1, 5), +/// Complex.fromReal(6), +/// Complex(3, 4), +/// ], +/// ); +/// ``` +/// {@endtemplate} +final class GenericAlgebraic extends Algebraic with MathUtils { + /// An initial set of values is required to find the roots but it is optional. + /// + /// This class by default uses the Aberth method to generate initial guesses + /// if none are provided. If you are not sure which initial values to provide, + /// just leave [initialGuess] empty. + final List initialGuess; + + /// The accuracy of the algorithm. + final double precision; + + /// The maximum steps to be made by the algorithm. + final int maxSteps; + + /// The minimum distance between initial guesses. + final double minGuessDistance; + + /// The stagnation threshold for convergence. + final double stagnationThreshold; + + /// {@macro generic_algebraic} + /// + /// {@macro generic_algebraic_example} + /// + /// If the coefficients of your polynomial contain only real numbers, consider + /// using the [GenericAlgebraic.realEquation] constructor instead. + GenericAlgebraic({ + required List coefficients, + this.initialGuess = const [], + this.precision = 1.0e-10, + this.maxSteps = 2000, + this.minGuessDistance = 1.0e-6, + this.stagnationThreshold = 1.0e-10, + }) : super(coefficients); + + /// {@macro generic_algebraic} + /// + /// {@macro generic_algebraic_example} + /// + /// If the coefficients of your polynomial contain complex numbers, consider + /// using the [GenericAlgebraic.new] constructor instead. + GenericAlgebraic.realEquation({ + required List coefficients, + this.initialGuess = const [], + this.precision = 1.0e-10, + this.maxSteps = 2000, + this.minGuessDistance = 1.0e-6, + this.stagnationThreshold = 1.0e-10, + }) : super.realEquation(coefficients); + + @override + bool operator ==(Object other) { + if (identical(this, other)) { + return true; + } + + if (other is GenericAlgebraic) { + // Check all fields for equality + if (coefficients.length != other.coefficients.length) { + return false; + } + for (var i = 0; i < coefficients.length; ++i) { + if (coefficients[i] != other.coefficients[i]) { + return false; + } + } + + // Compare initial guesses + if (initialGuess.length != other.initialGuess.length) { + return false; + } + for (var i = 0; i < initialGuess.length; ++i) { + if (initialGuess[i] != other.initialGuess[i]) { + return false; + } + } + + // Compare other fields + return precision == other.precision && + maxSteps == other.maxSteps && + minGuessDistance == other.minGuessDistance && + stagnationThreshold == other.stagnationThreshold && + runtimeType == other.runtimeType; + } + + return false; + } + + @override + int get hashCode => Object.hash( + Object.hashAll(coefficients), + Object.hashAll(initialGuess), + precision, + maxSteps, + minGuessDistance, + stagnationThreshold, + ); + + @override + int get degree => coefficients.length - 1; + + @override + Algebraic derivative() { + // Rather than always returning 'GenericAlgebraic', if the degree is <= 4 + // there is the possibility to return a more convenient object + switch (coefficients.length) { + case 1: + return Constant( + a: coefficients.first, + ).derivative(); + case 2: + return Linear( + a: coefficients.first, + b: coefficients[1], + ).derivative(); + case 3: + return Quadratic( + a: coefficients.first, + b: coefficients[1], + c: coefficients[2], + ).derivative(); + case 4: + return Cubic( + a: coefficients.first, + b: coefficients[1], + c: coefficients[2], + d: coefficients[3], + ).derivative(); + case 5: + return Quartic( + a: coefficients.first, + b: coefficients[1], + c: coefficients[2], + d: coefficients[3], + e: coefficients[4], + ).derivative(); + case 6: + final coeffs = _derivativeOf(); + return Quartic( + a: coeffs.first, + b: coeffs[1], + c: coeffs[2], + d: coeffs[3], + e: coeffs[4], + ); + default: + return GenericAlgebraic( + coefficients: _derivativeOf(), + precision: precision, + maxSteps: maxSteps, + minGuessDistance: minGuessDistance, + stagnationThreshold: stagnationThreshold, + ); + } + } + + @override + Complex discriminant() { + // Say that P(x) is the polynomial represented by this instance and + // P'(x) is the derivative of P. In order to calculate the discriminant of + // a polynomial, we need to first compute the resultant Res(A, A') which + // is equivalent to the determinant of the Sylvester matrix. + final sylvester = SylvesterMatrix(polynomial: this); + + // Computes Res(A, A') and then determines the sign according with the + // degree of the polynomial. + return sylvester.polynomialDiscriminant(); + } + + @override + List solutions() { + // In case the polynomial was a constant, just return an empty array because + // there are no solutions. + if (coefficients.length <= 1) { + return const []; + } + + // Make a copy of the coefficients and scale to make the polynomial monic + final leadingCoeff = coefficients.first; + if (leadingCoeff.abs() < precision) { + throw const AlgebraicException( + 'Leading coefficient is too close to zero', + ); + } + + // Scale all coefficients by dividing by the leading coefficient + final scaledCoefficients = coefficients + .map((c) => c / leadingCoeff) + .toList(); + final degree = (scaledCoefficients.length - 1).toDouble(); + + // Initialize roots using Aberth's method if no initial guesses provided + List roots; + + if (initialGuess.isNotEmpty) { + roots = List.from(initialGuess); + } else { + // Calculate the center of the roots using the first two coefficients + final center = -scaledCoefficients[1] / Complex.fromReal(degree); + + // Calculate the radius using the Aberth bound + var radius = 0.0; + for (var i = 1; i < scaledCoefficients.length; i++) { + radius = max(radius, scaledCoefficients[i].abs() * (1.0 / i)); + } + radius = 2 * radius; // Aberth's method typically uses a factor of 2 + + // Generate initial guesses using Aberth's method + roots = List.generate(degree.floor(), (i) { + // Calculate the angle with a small random perturbation + final angle = 2 * pi * i / degree + (Random().nextDouble() - 0.5) * 0.1; + + // Calculate the radius with a small random perturbation + final perturbedRadius = + radius * (1 + (Random().nextDouble() - 0.5) * 0.1); + + // Generate the initial guess + return center + + Complex.fromReal(perturbedRadius) * Complex(cos(angle), sin(angle)); + }); + + // Ensure minimum distance between initial guesses + for (var i = 0; i < roots.length; i++) { + for (var j = i + 1; j < roots.length; j++) { + final distance = (roots[i] - roots[j]).abs(); + if (distance < minGuessDistance) { + // Move the second root away from the first + final direction = + (roots[j] - roots[i]) / Complex.fromReal(distance); + roots[j] = + roots[i] + direction * Complex.fromReal(minGuessDistance); + } + } + } + } + + // Durand-Kerner iteration + var converged = false; + var iteration = 0; + + while (!converged && iteration < maxSteps) { + converged = true; + final newRoots = List.from(roots); + + for (var i = 0; i < degree.floor(); i++) { + // Evaluate polynomial at current root + var p = scaledCoefficients[0]; + for (var j = 1; j < scaledCoefficients.length; j++) { + p = p * roots[i] + scaledCoefficients[j]; + } + + // Evaluate denominator (product of differences) + var denominator = const Complex.fromReal(1); + for (var j = 0; j < degree.floor(); j++) { + if (j != i) { + denominator *= roots[i] - roots[j]; + } + } + + // Update root using Durand-Kerner formula + if (denominator.abs() > precision) { + final correction = p / denominator; + newRoots[i] = roots[i] - correction; + + // Check for convergence + if (correction.abs() > precision) { + converged = false; + } + } + } + + roots = newRoots; + iteration++; + } + + // Sort roots by real part for stability + roots.sort((a, b) => a.real.compareTo(b.real)); + + return roots; + } + + /// Returns the coefficients of the derivative of a given polynomial. + List _derivativeOf() { + final newLength = coefficients.length - 1; + + // The derivative + final result = List.generate( + newLength, + (_) => const Complex.zero(), + growable: false, + ); + + // Evaluation of the derivative + for (var i = 0; i < newLength; ++i) { + result[i] = coefficients[i] * Complex.fromReal((newLength - i) * 1.0); + } + + return result; + } + + /// {@macro algebraic_deep_copy} + GenericAlgebraic copyWith({ + List? coefficients, + List? initialGuess, + double? precision, + int? maxSteps, + double? minGuessDistance, + double? stagnationThreshold, + }) => GenericAlgebraic( + coefficients: coefficients ?? List.from(this.coefficients), + initialGuess: initialGuess ?? List.from(this.initialGuess), + precision: precision ?? this.precision, + maxSteps: maxSteps ?? this.maxSteps, + minGuessDistance: minGuessDistance ?? this.minGuessDistance, + stagnationThreshold: stagnationThreshold ?? this.stagnationThreshold, + ); +} diff --git a/lib/src/algebraic/types/linear.dart b/lib/src/algebraic/types/linear.dart index 4b4822f4..bbf82468 100644 --- a/lib/src/algebraic/types/linear.dart +++ b/lib/src/algebraic/types/linear.dart @@ -1,26 +1,46 @@ -import 'package:equations/equations.dart'; +part of '../algebraic.dart'; +/// {@template linear_algebraic} /// Concrete implementation of [Algebraic] that represents a first degree /// polynomial equation in the form _ax + b = 0_. /// /// This equation has exactly 1 solution, which can be real or complex. +/// {@endtemplate} +/// +/// {@template linear_algebraic_examples} +/// These are examples of linear equations, where the coefficient with the +/// highest degree goes first: +/// +/// ```dart +/// // f(x) = 2x + 5 +/// final eq = Linear( +/// a: Complex.fromReal(2), +/// b: Complex.fromReal(5), +/// ); +/// +/// // f(x) = (3 + i)x + 6 +/// final eq = Linear( +/// a: Complex(3, 1), +/// b: Complex.fromReal(6), +/// ); +/// +/// // f(x) = 2x + 5 +/// final eq = Linear.realEquation( +/// a: 2, +/// b: 5, +/// ); +/// +/// // f(x) = 3 - x +/// final eq = Linear.realEquation( +/// a: -1, +/// b: 3, +/// ); +/// ``` +/// {@endtemplate} final class Linear extends Algebraic { - /// These are examples of linear equations, where the coefficient with the - /// highest degree goes first: - /// - /// ```dart - /// // f(x) = 2x + 5 - /// final eq = Linear( - /// a: Complex.fromReal(2), - /// b: Complex.fromReal(5), - /// ); + /// {@macro linear_algebraic} /// - /// // f(x) = (3 + i)x + 6 - /// final eq = Linear( - /// a: Complex(3, 1), - /// b: Complex.fromReal(6), - /// ); - /// ``` + /// {@macro linear_algebraic_examples} /// /// Use this constructor if you have complex coefficients. If no [Complex] /// values are required, then consider using [Linear.realEquation] for a @@ -30,29 +50,14 @@ final class Linear extends Algebraic { Complex b = const Complex.zero(), }) : super([a, b]); - /// These are examples of linear equations, where the coefficient with the - /// highest degree goes first: + /// {@macro linear_algebraic} /// - /// ```dart - /// // f(x) = 2x + 5 - /// final eq = Linear.realEquation( - /// a: 2, - /// b: 5, - /// ); - /// - /// // f(x) = 3 - x - /// final eq = Linear.realEquation( - /// a: -1, - /// b: 3, - /// ); - /// ``` + /// {@macro linear_algebraic_examples} /// /// If the coefficients of your polynomial contain complex numbers, consider /// using the [Linear.new] constructor instead. - Linear.realEquation({ - double a = 1, - double b = 0, - }) : super.realEquation([a, b]); + Linear.realEquation({double a = 1, double b = 0}) + : super.realEquation([a, b]); @override int get degree => 1; @@ -66,19 +71,17 @@ final class Linear extends Algebraic { @override List solutions() => [b.negate / a]; - /// The first coefficient of the equation in the form _f(x) = ab + b_. + /// {@macro algebraic_deep_copy} + Linear copyWith({Complex? a, Complex? b}) => + Linear(a: a ?? this.a, b: b ?? this.b); + + /// {@macro first_coefficient_algebraic} + /// {@template linear.equation_form} + /// _f(x) = ax + b = 0_ + /// {@endtemplate} Complex get a => coefficients.first; - /// The second coefficient of the equation in the form _f(x) = ab + b_. + /// {@macro second_coefficient_algebraic} + /// {@macro linear.equation_form} Complex get b => coefficients[1]; - - /// {@macro algebraic_deep_copy} - Linear copyWith({ - Complex? a, - Complex? b, - }) => - Linear( - a: a ?? this.a, - b: b ?? this.b, - ); } diff --git a/lib/src/algebraic/types/quadratic.dart b/lib/src/algebraic/types/quadratic.dart index c3e89e5d..f6b66f34 100644 --- a/lib/src/algebraic/types/quadratic.dart +++ b/lib/src/algebraic/types/quadratic.dart @@ -1,102 +1,122 @@ -import 'package:equations/equations.dart'; +part of '../algebraic.dart'; +/// {@template quadratic_algebraic} /// Concrete implementation of [Algebraic] that represents a second degree /// polynomial equation in the form _ax^2 + bx + c = 0_. /// /// This equation has exactly 2 roots, both real or both complex, depending /// on the value of the discriminant. +/// {@endtemplate} +/// +/// {@template quadratic_algebraic_examples} +/// These are examples of quadratic equations, where the coefficient with the +/// highest degree goes first: +/// +/// ```dart +/// // f(x) = x^2 - 6x + 5 +/// final eq = Quadratic( +/// a: Complex.fromReal(2), +/// b: Complex.fromReal(-6), +/// c: Complex.fromReal(5), +/// ); +/// +/// // f(x) = ix^2 - 3 +/// final eq = Quadratic( +/// a: Complex.fromImaginary(1), +/// c: Complex.fromReal(-3), +/// ); +/// +/// // f(x) = x^2 - 6x + 5 +/// final eq = Quadratic.realEquation( +/// a: 2, +/// b: -6, +/// c: 5, +/// ); +/// ``` +/// {@endtemplate} final class Quadratic extends Algebraic { - /// These are examples of quadratic equations, where the coefficient with the - /// highest degree goes first: - /// - /// ```dart - /// // f(x) = x^2 - 6x + 5 - /// final eq = Quadratic( - /// a: Complex.fromReal(2), - /// b: Complex.fromReal(-6), - /// c: Complex.fromReal(5), - /// ); + /// {@macro quadratic_algebraic} /// - /// // f(x) = ix^2 - 3 - /// final eq = Quadratic( - /// a: Complex.fromImaginary(1), - /// c: Complex.fromReal(-3), - /// ); - /// ``` + /// {@macro quadratic_algebraic_examples} /// /// Use this constructor if you have complex coefficients. If no [Complex] - /// values are required, then consider using [Quadratic.realEquation] for a - /// less verbose syntax. + /// values are required, consider using [Quadratic.realEquation] for a less + /// verbose syntax. Quadratic({ Complex a = const Complex.fromReal(1), Complex b = const Complex.zero(), Complex c = const Complex.zero(), }) : super([a, b, c]); - /// This is an example of a quadratic equation, where the coefficient with the - /// highest degree goes first: + /// {@macro quadratic_algebraic} /// - /// ```dart - /// // f(x) = x^2 - 6x + 5 - /// final eq = Quadratic.realEquation( - /// a: 2, - /// b: -6, - /// c: 5, - /// ); - /// ``` + /// {@macro quadratic_algebraic_examples} /// /// If the coefficients of your polynomial contain complex numbers, consider /// using the [Quadratic.new] constructor instead. - Quadratic.realEquation({ - double a = 1, - double b = 0, - double c = 0, - }) : super.realEquation([a, b, c]); + Quadratic.realEquation({double a = 1, double b = 0, double c = 0}) + : super.realEquation([a, b, c]); @override int get degree => 2; @override - Algebraic derivative() => Linear( - a: a * const Complex.fromReal(2), - b: b, - ); + Algebraic derivative() => Linear(a: a * const Complex.fromReal(2), b: b); @override - Complex discriminant() => (b * b) - const Complex.fromReal(4) * a * c; + Complex discriminant() { + const four = Complex.fromReal(4); + return b * b - four * a * c; + } @override List solutions() { - final disc = discriminant(); final twoA = const Complex.fromReal(2) * a; - return [ - (b.negate + disc.sqrt()) / twoA, - (b.negate - disc.sqrt()) / twoA, - ]; - } + // For better numerical stability, we use a different approach based on the + // value of b + if (b.isZero) { + // Special case when b = 0 -> x = +/- sqrt(-c/a) + final sqrtTerm = (-c / a).sqrt(); + return [sqrtTerm, -sqrtTerm]; + } - /// The first coefficient of the equation in the form - /// _f(x) = ax^2 + bx + c = 0_ - Complex get a => coefficients.first; + // Use the more stable form of the quadratic formula: + // + // x = (-b/2a) ± sqrt((b/2a)^2 - c/a) + final halfBOverA = b / twoA; + final sqrtTerm = (halfBOverA * halfBOverA - c / a).sqrt(); + final root1 = -halfBOverA + sqrtTerm; - /// The second coefficient of the equation in the form - /// _f(x) = ax^2 + bx + c = 0_ - Complex get b => coefficients[1]; + // Use Vieta's formulas to compute the other root more accurately + final product = c / a; + final betterRoot2 = product / root1; - /// The third coefficient of the equation in the form - /// _f(x) = ax^2 + bx + c = 0_ - Complex get c => coefficients[2]; + return [root1, betterRoot2]; + } /// {@macro algebraic_deep_copy} Quadratic copyWith({ Complex? a, Complex? b, Complex? c, - }) => - Quadratic( - a: a ?? this.a, - b: b ?? this.b, - c: c ?? this.c, - ); + }) => Quadratic( + a: a ?? this.a, + b: b ?? this.b, + c: c ?? this.c, + ); + + /// {@macro first_coefficient_algebraic} + /// {@template quadratic.equation_form} + /// _f(x) = ax^2 + bx + c = 0_ + /// {@endtemplate} + Complex get a => coefficients.first; + + /// {@macro second_coefficient_algebraic} + /// {@macro quadratic.equation_form} + Complex get b => coefficients[1]; + + /// {@macro third_coefficient_algebraic} + /// {@macro quadratic.equation_form} + Complex get c => coefficients[2]; } diff --git a/lib/src/algebraic/types/quartic.dart b/lib/src/algebraic/types/quartic.dart index ba8a9d13..142fd6ff 100644 --- a/lib/src/algebraic/types/quartic.dart +++ b/lib/src/algebraic/types/quartic.dart @@ -1,5 +1,6 @@ -import 'package:equations/equations.dart'; +part of '../algebraic.dart'; +/// {@template quartic_algebraic} /// Concrete implementation of [Algebraic] that represents a fourth degree /// polynomial equation in the form _ax^4 + bx^3 + cx^2 + dx + e = 0_. /// @@ -11,25 +12,53 @@ import 'package:equations/equations.dart'; /// - Multiple roots which can be all equal or paired (complex or real) /// /// The above cases depend on the value of the discriminant. +/// {@endtemplate} +/// +/// {@template quartic_algebraic_examples} +/// These are examples of quartic equations, where the coefficient with the +/// highest degree goes first: +/// +/// ```dart +/// // f(x) = -x^4 - 8x^3 - 1 +/// final eq = Quartic( +/// a: Complex.fromReal(-1), +/// b: Complex.fromReal(-8), +/// e: Complex.fromReal(-1), +/// ); +/// +/// // f(x) = ix^4 - ix^2 + 6 +/// final eq = Quartic( +/// a: Complex.fromImaginary(1), +/// c: Complex.fromImaginary(-1), +/// e: Complex.fromReal(6), +/// ); +/// // f(x) = -x^4 - 8x^3 - 1 +/// final eq = Quartic.realEquation( +/// a: Complex.fromReal(-1), +/// b: Complex.fromReal(-8), +/// e: Complex.fromReal(-1), +/// ); +/// ``` +/// {@endtemplate} final class Quartic extends Algebraic { - /// These are examples of quartic equations, where the coefficient with the - /// highest degree goes first: + /// The value used to check if a coefficient is very close to zero. In other + /// words, if `|a| < epsilon`, then `a` is considered to be zero. /// - /// ```dart - /// // f(x) = -x^4 - 8x^3 - 1 - /// final eq = Quartic( - /// a: Complex.fromReal(-1), - /// b: Complex.fromReal(-8), - /// e: Complex.fromReal(-1), - /// ); + /// This value is used to avoid numerical instability when solving the cubic + /// equation. + static const epsilon = 1e-10; + + /// The maximum value a coefficient can have. If a coefficient is greater + /// than this value, an exception will be thrown. + static const maxCoefficient = 1e10; + + /// The minimum value a coefficient can have. If a coefficient is less than + /// this value, an exception will be thrown. + static const minCoefficient = 1e-10; + + /// {@macro quartic_algebraic} /// - /// // f(x) = ix^4 - ix^2 + 6 - /// final eq = Quartic( - /// a: Complex.fromImaginary(1), - /// c: Complex.fromImaginary(-1), - /// e: Complex.fromReal(6), - /// ); - /// ``` + /// {@macro quartic_algebraic_examples} /// /// Use this constructor if you have complex coefficients. If no [Complex] /// values are required, then consider using [Quartic.realEquation] for a @@ -40,19 +69,13 @@ final class Quartic extends Algebraic { Complex c = const Complex.zero(), Complex d = const Complex.zero(), Complex e = const Complex.zero(), - }) : super([a, b, c, d, e]); + }) : super([a, b, c, d, e]) { + _validateCoefficients(); + } - /// This is an example of a quartic equations, where the coefficient with the - /// highest degree goes first: + /// {@macro quartic_algebraic} /// - /// ```dart - /// // f(x) = -x^4 - 8x^3 - 1 - /// final eq = Quartic.realEquation( - /// a: Complex.fromReal(-1), - /// b: Complex.fromReal(-8), - /// e: Complex.fromReal(-1), - /// ); - /// ``` + /// {@macro quartic_algebraic_examples} /// /// If the coefficients of your polynomial contain complex numbers, consider /// using the [Quartic.new] constructor instead. @@ -62,84 +85,229 @@ final class Quartic extends Algebraic { double c = 0, double d = 0, double e = 0, - }) : super.realEquation([a, b, c, d, e]); + }) : super.realEquation([a, b, c, d, e]) { + _validateCoefficients(); + } + + /// Validates the coefficients of the quartic equation + void _validateCoefficients() { + // Check for extremely large coefficients that might cause numerical + // nstability + for (var i = 0; i < coefficients.length; i++) { + if (coefficients[i].abs() > maxCoefficient) { + throw AlgebraicException( + 'Coefficient at index $i is too large (|c| > $maxCoefficient)', + ); + } + } + } @override int get degree => 4; @override Algebraic derivative() => Cubic( - a: a * const Complex.fromReal(4), - b: b * const Complex.fromReal(3), - c: c * const Complex.fromReal(2), - d: d, - ); + a: a * const Complex.fromReal(4), + b: b * const Complex.fromReal(3), + c: c * const Complex.fromReal(2), + d: d, + ); @override Complex discriminant() { - final k = (b * b * c * c * d * d) - - (d * d * d * b * b * b * const Complex.fromReal(4)) - - (d * d * c * c * c * a * const Complex.fromReal(4)) + - (d * d * d * c * b * a * const Complex.fromReal(18)) - - (d * d * d * d * a * a * const Complex.fromReal(27)) + - (e * e * e * a * a * a * const Complex.fromReal(256)); - - final p = e * - ((c * c * c * b * b * const Complex.fromReal(-4)) + - (b * b * b * c * d * const Complex.fromReal(18)) + - (c * c * c * c * a * const Complex.fromReal(16)) - - (d * c * c * b * a * const Complex.fromReal(80)) - - (d * d * b * b * a * const Complex.fromReal(6)) + - (d * d * a * a * c * const Complex.fromReal(144))); - - final r = (e * e) * - (b * b * b * b * const Complex.fromReal(-27) + - b * b * c * a * const Complex.fromReal(144) - - a * a * c * c * const Complex.fromReal(128) - - d * b * a * a * const Complex.fromReal(192)); + final b2 = b * b; + final c2 = c * c; + final d2 = d * d; + final a2 = a * a; + final b3 = b2 * b; + final c3 = c2 * c; + final d3 = d2 * d; + + final k = + (b2 * c2 * d2) - + (d3 * b3 * const Complex.fromReal(4)) - + (d2 * c3 * a * const Complex.fromReal(4)) + + (d3 * c * b * a * const Complex.fromReal(18)) - + (d2 * d2 * a2 * const Complex.fromReal(27)) + + (e * e * e * a2 * a * const Complex.fromReal(256)); + + final p = + e * + ((c3 * b2 * const Complex.fromReal(-4)) + + (b3 * c * d * const Complex.fromReal(18)) + + (c2 * c2 * a * const Complex.fromReal(16)) - + (d * c2 * b * a * const Complex.fromReal(80)) - + (d2 * b2 * a * const Complex.fromReal(6)) + + (d2 * a2 * c * const Complex.fromReal(144))); + + final r = + (e * e) * + (b2 * b2 * const Complex.fromReal(-27) + + b2 * c * a * const Complex.fromReal(144) - + a2 * c2 * const Complex.fromReal(128) - + d * b * a2 * const Complex.fromReal(192)); return k + p + r; } + /// Normalizes coefficients to improve numerical stability + List _normalizeCoefficients() { + final maxCoeff = coefficients + .map((c) => c.abs()) + .reduce((a, b) => a > b ? a : b); + + if (maxCoeff > maxCoefficient) { + // coverage:ignore-start + final scale = Complex.fromReal(maxCoefficient / maxCoeff); + return coefficients.map((c) => c * scale).toList(); + // coverage:ignore-end + } + + return coefficients; + } + @override List solutions() { + // Normalize coefficients for better numerical stability + final normalizedCoeffs = _normalizeCoefficients(); + final a = normalizedCoeffs[0]; + final b = normalizedCoeffs[1]; + final c = normalizedCoeffs[2]; + final d = normalizedCoeffs[3]; + final e = normalizedCoeffs[4]; + + // Special case: all coefficients are zero + if (b.abs() < epsilon && + c.abs() < epsilon && + d.abs() < epsilon && + e.abs() < epsilon) { + return const [ + Complex.zero(), + Complex.zero(), + Complex.zero(), + Complex.zero(), + ]; + } + + // Special case: ax^4 + e = 0 + if (b.abs() < epsilon && c.abs() < epsilon && d.abs() < epsilon) { + // This reduces to ax^4 + e = 0 + // Solutions are the fourth roots of -e/a + final solutions = []; + final root = (e.negate / a).pow(0.25); + + // Add all four fourth roots + solutions + ..add(root) + ..add(root * const Complex.i()) + ..add(root.negate) + ..add(root * const Complex.i().negate); + + return solutions; + } + + // Special case: ax^4 + cx^2 + e = 0 + if (b.abs() < epsilon && d.abs() < epsilon) { + // This reduces to ax^4 + cx^2 + e = 0 + // Using substitution y = x^2, we get ay^2 + cy + e = 0 + final solutions = []; + final quadratic = Quadratic(a: a, b: c, c: e); + final roots = quadratic.solutions(); + + for (final root in roots) { + if (root.abs() < epsilon) { + // When root is zero, sqrt(0) = 0 and -sqrt(0) = 0, so add zero twice + solutions + ..add(const Complex.zero()) + ..add(const Complex.zero()); + } else { + final sqrt = root.sqrt(); + solutions + ..add(sqrt) + ..add(sqrt.negate); + } + } + return solutions; + } + + // Special case: ax^4 + bx^3 + cx^2 = 0 + if (d.abs() < epsilon && e.abs() < epsilon) { + // This reduces to x^2(ax^2 + bx + c) = 0 + // One solution is x = 0 (double root) + // The other two solutions come from ax^2 + bx + c = 0 + final quadratic = Quadratic(a: a, b: b, c: c); + final roots = quadratic.solutions(); + + return [const Complex.zero(), const Complex.zero(), ...roots]; + } + + // Normalize by leading coefficient final fb = b / a; final fc = c / a; final fd = d / a; final fe = e / a; - final q1 = (fc * fc) - + // Calculate intermediate values for the quartic formula. These values are + // part of the Ferrari's method for solving quartic equations. + final q1 = + (fc * fc) - (fb * fd * const Complex.fromReal(3)) + (fe * const Complex.fromReal(12)); - final q2 = (fc.pow(3) * const Complex.fromReal(2)) - + + final q2 = + (fc.pow(3) * const Complex.fromReal(2)) - (fb * fc * fd * const Complex.fromReal(9)) + (fd.pow(2) * const Complex.fromReal(27)) + (fb.pow(2) * fe * const Complex.fromReal(27)) - (fc * fe * const Complex.fromReal(72)); - final q3 = (fb * fc * const Complex.fromReal(8)) - + + final q3 = + (fb * fc * const Complex.fromReal(8)) - (fd * const Complex.fromReal(16)) - (fb.pow(3) * const Complex.fromReal(2)); - final q4 = (fb.pow(2) * const Complex.fromReal(3)) - + + final q4 = + (fb.pow(2) * const Complex.fromReal(3)) - (fc * const Complex.fromReal(8)); + // Calculate the first part of the roots with improved numerical stability. var temp = (q2 * q2 / const Complex.fromReal(4)) - (q1.pow(3)); + if (temp.abs() < epsilon) { + temp = const Complex.fromReal(epsilon); + } final q5 = (temp.sqrt() + (q2 / const Complex.fromReal(2))).pow(1.0 / 3.0); final q6 = ((q1 / q5) + q5) / const Complex.fromReal(3); temp = (q4 / const Complex.fromReal(12)) + q6; + if (temp.abs() < epsilon) { + temp = const Complex.fromReal(epsilon); + } final q7 = temp.sqrt() * const Complex.fromReal(2); - temp = ((q4 * const Complex.fromReal(4)) / const Complex.fromReal(6)) - + + // Calculate the second part of the roots. + temp = + ((q4 * const Complex.fromReal(4)) / const Complex.fromReal(6)) - (q6 * const Complex.fromReal(4)) - (q3 / q7); + if (temp.abs() < epsilon) { + temp = const Complex.fromReal(epsilon); + } + final solutions = [ (fb.negate - q7 - temp.sqrt()) / const Complex.fromReal(4), (fb.negate - q7 + temp.sqrt()) / const Complex.fromReal(4), ]; - temp = ((q4 * const Complex.fromReal(4)) / const Complex.fromReal(6)) - + // Calculate the third and fourth parts of the roots. + temp = + ((q4 * const Complex.fromReal(4)) / const Complex.fromReal(6)) - (q6 * const Complex.fromReal(4)) + (q3 / q7); + if (temp.abs() < epsilon) { + temp = const Complex.fromReal(epsilon); + } + solutions ..add((fb.negate + q7 - temp.sqrt()) / const Complex.fromReal(4)) ..add((fb.negate + q7 + temp.sqrt()) / const Complex.fromReal(4)); @@ -147,39 +315,50 @@ final class Quartic extends Algebraic { return solutions; } + /// {@macro algebraic_deep_copy} + Quartic copyWith({ + Complex? a, + Complex? b, + Complex? c, + Complex? d, + Complex? e, + }) => Quartic( + a: a ?? this.a, + b: b ?? this.b, + c: c ?? this.c, + d: d ?? this.d, + e: e ?? this.e, + ); + + /// {@template first_coefficient_algebraic} /// The first coefficient of the equation in the form + /// {@endtemplate} + /// {@template quartic.equation_form} /// _f(x) = ax^4 + bx^3 + cx^2 + dx + e = 0_ + /// {@endtemplate} Complex get a => coefficients.first; + /// {@template second_coefficient_algebraic} /// The second coefficient of the equation in the form - /// _f(x) = ax^4 + bx^3 + cx^2 + dx + e = 0_ + /// {@endtemplate} + /// {@macro quartic.equation_form} Complex get b => coefficients[1]; + /// {@template third_coefficient_algebraic} /// The third coefficient of the equation in the form - /// _f(x) = ax^4 + bx^3 + cx^2 + dx + e = 0_ + /// {@endtemplate} + /// {@macro quartic.equation_form} Complex get c => coefficients[2]; + /// {@template fourth_coefficient_algebraic} /// The fourth coefficient of the equation in the form - /// _f(x) = ax^4 + bx^3 + cx^2 + dx + e = 0_ + /// {@endtemplate} + /// {@macro quartic.equation_form} Complex get d => coefficients[3]; + /// {@template fifth_coefficient_algebraic} /// The fifth coefficient of the equation in the form - /// _f(x) = ax^4 + bx^3 + cx^2 + dx + e = 0_ + /// {@endtemplate} + /// {@macro quartic.equation_form} Complex get e => coefficients[4]; - - /// {@macro algebraic_deep_copy} - Quartic copyWith({ - Complex? a, - Complex? b, - Complex? c, - Complex? d, - Complex? e, - }) => - Quartic( - a: a ?? this.a, - b: b ?? this.b, - c: c ?? this.c, - d: d ?? this.d, - e: e ?? this.e, - ); } diff --git a/lib/src/algebraic/utils/algebraic_division.dart b/lib/src/algebraic/utils/algebraic_division.dart deleted file mode 100644 index ba248081..00000000 --- a/lib/src/algebraic/utils/algebraic_division.dart +++ /dev/null @@ -1,53 +0,0 @@ -import 'package:equations/equations.dart'; - -/// This utility class holds the quotient and the remainder of a division -/// between two polynomials. When you use `operator/` on two [Algebraic] -/// objects, this class is returned. For example: -/// -/// ```dart -/// final numerator = Algebraic.fromReal([1, -3, 2]); -/// final denominator = Algebraic.fromReal([1, 2]); -/// -/// final res = numerator / denominator; // 'res' is of type 'AlgebraicDivision' -/// ``` -/// -/// When dividing two polynomials, there always are a quotient and a remainder. -class AlgebraicDivision { - /// The quotient of the division. - final Algebraic quotient; - - /// The remainder of the divison. - final Algebraic remainder; - - /// Creates an [AlgebraicDivision] with the given [quotient] and [remainder]. - const AlgebraicDivision({ - required this.quotient, - required this.remainder, - }); - - @override - bool operator ==(Object other) { - if (identical(this, other)) { - return true; - } - - if (other is AlgebraicDivision) { - return runtimeType == other.runtimeType && - quotient == other.quotient && - remainder == other.remainder; - } else { - return false; - } - } - - @override - int get hashCode => Object.hash(quotient, remainder); - - @override - String toString() { - final q = '$quotient'.replaceAll('f(x) = ', ''); - final r = '$remainder'.replaceAll('f(x) = ', ''); - - return 'Q = $q\nR = $r'; - } -} diff --git a/lib/src/algebraic/utils/algebraic_inequality.dart b/lib/src/algebraic/utils/algebraic_inequality.dart new file mode 100644 index 00000000..d535f5b6 --- /dev/null +++ b/lib/src/algebraic/utils/algebraic_inequality.dart @@ -0,0 +1,181 @@ +import 'package:equations/equations.dart'; + +/// {@template algebraic_inequality_type} +/// The kind of [Algebraic] inequality to solve. +/// {@endtemplate} +enum AlgebraicInequalityType { + /// The inequality in the form _P(x) < 0_. + lessThan, + + /// The inequality in the form _P(x) <= 0_. + lessThanOrEqualTo, + + /// The inequality in the form _P(x) > 0_. + greaterThan, + + /// The inequality in the form _P(x) >= 0_. + greaterThanOrEqualTo, +} + +/// {@template algebraic_inequality_solution} +/// A solution of an [Algebraic] inequality. +/// {@endtemplate} +sealed class AlgebraicInequalitySolution { + /// {@macro algebraic_inequality_solution} + const AlgebraicInequalitySolution({ + required this.isInclusive, + }); + + /// Whether the inequality solution is inclusive of the boundaries or not. + final bool isInclusive; + + @override + bool operator ==(Object other) { + if (identical(this, other)) { + return true; + } + + if (other is AlgebraicInequalitySolution) { + return runtimeType == other.runtimeType && + isInclusive == other.isInclusive; + } + + return false; + } + + @override + int get hashCode => isInclusive.hashCode; +} + +/// {@template algebraic_inequality_interval} +/// A solution of an [Algebraic] inequality that is an interval between [start] +/// and [end] values. +/// {@endtemplate} +class AlgebraicInequalityInterval extends AlgebraicInequalitySolution { + /// The start of the interval. + final double start; + + /// The end of the interval. + final double end; + + /// {@macro algebraic_inequality_interval} + const AlgebraicInequalityInterval({ + required this.start, + required this.end, + required super.isInclusive, + }); + + @override + bool operator ==(Object other) { + if (identical(this, other)) { + return true; + } + + if (other is AlgebraicInequalityInterval) { + return runtimeType == other.runtimeType && + start == other.start && + end == other.end && + isInclusive == other.isInclusive; + } + + return false; + } + + @override + int get hashCode => Object.hash( + start, + end, + isInclusive, + ); + + @override + String toString() => + 'Interval(start: $start, end: $end, isInclusive: $isInclusive)'; +} + +/// {@template algebraic_inequality_smaller_than} +/// A solution of an [Algebraic] inequality that is smaller than [value]. +/// {@endtemplate} +class AlgebraicInequalitySmallerThan extends AlgebraicInequalitySolution { + /// The value. + final double value; + + /// {@macro algebraic_inequality_smaller_than} + const AlgebraicInequalitySmallerThan({ + required this.value, + required super.isInclusive, + }); + + @override + bool operator ==(Object other) { + if (identical(this, other)) { + return true; + } + + if (other is AlgebraicInequalitySmallerThan) { + return runtimeType == other.runtimeType && + value == other.value && + isInclusive == other.isInclusive; + } + + return false; + } + + @override + int get hashCode => Object.hash( + value, + isInclusive, + ); + + @override + String toString() => 'SmallerThan(value: $value, isInclusive: $isInclusive)'; +} + +/// {@template algebraic_inequality_greater_than} +/// A solution of an [Algebraic] inequality that is greater than [value]. +/// {@endtemplate} +class AlgebraicInequalityGreaterThan extends AlgebraicInequalitySolution { + /// The value. + final double value; + + /// {@macro algebraic_inequality_greater_than} + const AlgebraicInequalityGreaterThan({ + required this.value, + required super.isInclusive, + }); + + @override + bool operator ==(Object other) { + if (identical(this, other)) { + return true; + } + + if (other is AlgebraicInequalityGreaterThan) { + return runtimeType == other.runtimeType && + value == other.value && + isInclusive == other.isInclusive; + } + + return false; + } + + @override + int get hashCode => Object.hash( + value, + isInclusive, + ); + + @override + String toString() => 'GreaterThan(value: $value, isInclusive: $isInclusive)'; +} + +/// {@template algebraic_inequality_all_real_numbers} +/// A solution of an [Algebraic] inequality that includes all real numbers. +/// {@endtemplate} +class AlgebraicInequalityAllRealNumbers extends AlgebraicInequalitySolution { + /// {@macro algebraic_inequality_all_real_numbers} + const AlgebraicInequalityAllRealNumbers() : super(isInclusive: true); + + @override + String toString() => 'AllRealNumbers(isInclusive: $isInclusive)'; +} diff --git a/lib/src/algebraic/utils/polynomial_long_division.dart b/lib/src/algebraic/utils/polynomial_long_division.dart index f449f151..c2fbe968 100644 --- a/lib/src/algebraic/utils/polynomial_long_division.dart +++ b/lib/src/algebraic/utils/polynomial_long_division.dart @@ -1,29 +1,74 @@ import 'package:equations/equations.dart'; -/// The "Polynomial long division" algorithm divides a polynomial by another -/// polynomial of the same or lower degree. +/// {@template polynomial_long_division} +/// Implements the polynomial long division algorithm, which divides one +/// polynomial by another polynomial. /// -/// The only constraint of this procedure is that the degree of the denominator -/// cannot exceed the degree of the numerator. If this condition is not -/// satisfied, an exception is thrown. +/// This implementation requires that the degree of the denominator be less than +/// or equal to the degree of the numerator. If this condition is not met, a +/// [PolynomialLongDivisionException] will be thrown. +/// +/// ## Algorithm Overview +/// +/// The polynomial long division algorithm works similarly to numerical long +/// division: +/// +/// 1. Divide the leading term of the numerator by the leading term of the +/// denominator +/// 2. Multiply the entire denominator by this quotient +/// 3. Subtract the result from the numerator +/// 4. Repeat until the degree of the remainder is less than the degree of the +/// denominator +/// +/// ## Example +/// ```dart +/// final division = PolynomialLongDivision( +/// polyNumerator: Algebraic.fromReal([1, 3, -6]), // P(x) = x^2 + 3x - 6 +/// polyDenominator: Algebraic.fromReal([1, 7]), // Q(x) = x + 7 +/// ); +/// +/// final result = division.divide(); +/// // result.quotient = x - 4 +/// // result.remainder = 22 +/// ``` +/// {@endtemplate} class PolynomialLongDivision { - /// The numerator. + /// The polynomial to be divided (numerator). final Algebraic polyNumerator; - /// The denominator. + /// The polynomial to divide by (denominator). final Algebraic polyDenominator; - /// Creates a [PolynomialLongDivision] object. + /// {@macro polynomial_long_division} const PolynomialLongDivision({ required this.polyNumerator, required this.polyDenominator, }); - /// Divides [polyNumerator] by [polyDenominator] and wraps quotient and - /// remainder in the [AlgebraicDivision] class. + /// Performs polynomial long division of [polyNumerator] by [polyDenominator]. + /// + /// Returns an [AlgebraicDivision] containing both the quotient and remainder + /// of the division. The remainder will always have a degree less than the + /// denominator polynomial. + /// + /// Throws a [PolynomialLongDivisionException] if the degree of + /// [polyDenominator] is greater than the degree of [polyNumerator]. + /// + /// ## Special Cases + /// - If both polynomials are equal, returns a quotient 1 and remainder 0 + /// - If both polynomials are constants, performs regular division + /// - If the denominator is zero, throws a division by zero exception /// - /// An exception of type [PolynomialLongDivisionException] is thrown if the - /// degree of the denominator exceeds the degree of the numerator. + /// ## Example + /// ```dart + /// final division = PolynomialLongDivision( + /// polyNumerator: Algebraic.fromReal([3, -5, 10, -3]), // 3x³ - 5x² + 10x - 3 + /// polyDenominator: Algebraic.fromReal([3, 1]), // 3x + 1 + /// ); + /// final result = division.divide(); + /// // result.quotient = x² - 2x + 4 + /// // result.remainder = -7 + /// ``` AlgebraicDivision divide() { if (polyNumerator.degree < polyDenominator.degree) { throw const PolynomialLongDivisionException( @@ -31,29 +76,57 @@ class PolynomialLongDivision { ); } - // If both are equals, just return 1 with a remainder of 0 + // Handle special cases if (polyNumerator == polyDenominator) { - return AlgebraicDivision( - quotient: Constant(), - remainder: Constant( - a: const Complex.zero(), - ), - ); + return _handleEqualPolynomials(); } - // If both are constant values, just do a regular 'double' division. if (polyNumerator is Constant && polyDenominator is Constant) { - return AlgebraicDivision( - quotient: Constant( - a: polyNumerator[0] / polyDenominator[0], - ), - remainder: Constant( - a: const Complex.zero(), - ), + return _handleConstantDivision(); + } + + return _performLongDivision(); + } + + /// Handles the case where both polynomials are equal. + /// + /// When dividing a polynomial by itself, the result is always: + /// - quotient = 1 (constant polynomial with value 1) + /// - remainder = 0 (zero polynomial) + AlgebraicDivision _handleEqualPolynomials() => ( + quotient: Constant(), + remainder: Constant(a: const Complex.zero()), + ); + + /// Handles division of constant polynomials (degree 0). + /// + /// This is equivalent to regular division of complex numbers. + /// Throws a [PolynomialLongDivisionException] if attempting to divide by 0. + AlgebraicDivision _handleConstantDivision() { + final denominator = (polyDenominator as Constant).a; + if (denominator == const Complex.zero()) { + throw const PolynomialLongDivisionException( + 'Division by zero is not allowed.', ); } - // Polynomial long division algorithm starts here! + return ( + quotient: Constant(a: (polyNumerator as Constant).a / denominator), + remainder: Constant(a: const Complex.zero()), + ); + } + + /// Performs the actual polynomial long division algorithm. + /// + /// This method implements the standard polynomial long division algorithm: + /// 1. Reverse coefficient arrays (highest degree first) + /// 2. Iteratively divide leading terms and subtract multiples of the den. + /// 3. Continue until the remainder has degree less than the denominator + /// 4. Clean up the remainder by removing leading zeros + /// + /// The algorithm uses pre-allocated lists for better performance and + /// avoids creating unnecessary intermediate objects. + AlgebraicDivision _performLongDivision() { final numerator = polyNumerator.coefficients.reversed.toList( growable: false, ); @@ -64,63 +137,68 @@ class PolynomialLongDivision { var numDegree = polyNumerator.degree as int; final denomDegree = polyDenominator.degree as int; - // Support list. - var tempDen = List.generate( + // Pre-allocate lists for better performance + final tempDen = List.generate( numDegree + 1, (_) => const Complex.zero(), growable: false, ); - // The results (quotient and remainder). final quotient = List.generate( numDegree - denomDegree + 1, (_) => const Complex.zero(), growable: false, ); - // Polynomial long division algorithm that produces. - if (numDegree >= denomDegree) { - while (numDegree >= denomDegree) { - tempDen = List.generate( - tempDen.length, - (_) => const Complex.zero(), - growable: false, - ); - - for (var i = 0; i <= denomDegree; i++) { - tempDen[i + numDegree - denomDegree] = denominator[i]; - } + // Perform the division algorithm + while (numDegree >= denomDegree) { + // Clear tempDen efficiently for reuse + for (var i = 0; i < tempDen.length; i++) { + tempDen[i] = const Complex.zero(); + } - quotient[numDegree - denomDegree] = - numerator[numDegree] / tempDen[numDegree]; + // Set up the temporary denominator aligned with current position + for (var i = 0; i <= denomDegree; i++) { + tempDen[i + numDegree - denomDegree] = denominator[i]; + } - for (var i = 0; i < numDegree - denomDegree + 1; i++) { - tempDen[i] = tempDen[i] * quotient[numDegree - denomDegree]; - } + // Calculate the quotient coefficient for current degree + quotient[numDegree - denomDegree] = + numerator[numDegree] / tempDen[numDegree]; - for (var i = 0; i < numDegree + 1; i++) { - numerator[i] = numerator[i] - tempDen[i]; - } + // Scale the temporary denominator by the quotient coefficient + for (var i = 0; i < numDegree - denomDegree + 1; i++) { + tempDen[i] = tempDen[i] * quotient[numDegree - denomDegree]; + } - numDegree--; + // Subtract the scaled denominator from the numerator + for (var i = 0; i < numDegree + 1; i++) { + numerator[i] = numerator[i] - tempDen[i]; } + + numDegree--; } - // Creating the remainder array. + // Process the remainder, skipping leading zeros final remainder = []; + var foundNonZero = false; - // Skipping leading zeroes which will raise an exception when reversing the - // contents of the list. for (var i = 0; i <= numDegree; i++) { - if (numerator[i] == const Complex.zero()) { + if (!foundNonZero && numerator[i] == const Complex.zero()) { continue; } - + foundNonZero = true; remainder.add(numerator[i]); } - // Returning the results. - return AlgebraicDivision( + // If all coefficients were zero, add a single zero to represent zero + // polynomial + if (remainder.isEmpty) { + remainder.add(const Complex.zero()); + } + + // Convert back to normal coefficient order (lowest degree first) + return ( quotient: Algebraic.from(quotient.reversed.toList()), remainder: Algebraic.from(remainder.reversed.toList()), ); diff --git a/lib/src/algebraic/utils/sylvester_matrix.dart b/lib/src/algebraic/utils/sylvester_matrix.dart index 64d903a4..d0cc038f 100644 --- a/lib/src/algebraic/utils/sylvester_matrix.dart +++ b/lib/src/algebraic/utils/sylvester_matrix.dart @@ -2,13 +2,15 @@ import 'dart:math' as math; import 'package:equations/equations.dart'; -/// A Sylvester matrix is used to compute the discriminant of a polynomial -/// starting from its coefficients. +/// {@template sylvester_matrix} +/// The Sylvester matrix is used to compute the discriminant of a polynomial +/// of any degree. +/// {@endtemplate} class SylvesterMatrix { /// The polynomial used to build the Sylvester matrix. final Algebraic polynomial; - /// Creates a [SylvesterMatrix] object. + /// {@macro sylvester_matrix} const SylvesterMatrix({ required this.polynomial, }); @@ -33,6 +35,14 @@ class SylvesterMatrix { ComplexMatrix buildMatrix() { // Computing the derivative of the polynomial and the size of the matrix final coefficients = polynomial.coefficients; + + // Handle constant polynomial case + if (coefficients.length <= 1) { + throw const MatrixException( + 'Cannot build Sylvester matrix for a constant polynomial', + ); + } + final derivative = polynomial.derivative().coefficients; final size = (coefficients.length - 1) + (derivative.length - 1); @@ -43,24 +53,30 @@ class SylvesterMatrix { growable: false, ); - /* Iterating over the coefficients and placing them in the matrix. Since the - * 2D array is "flattened", the way we have to access "cells" is this... - * - * > flatData[arraySize * row + column] = value - * - * which is equivalent to 'flatData[row][column]' if 'flatData' was a 2D - * array. - */ - for (var i = 0; i < size - coefficients.length + 1; ++i) { - for (var j = 0; j < coefficients.length; ++j) { - flatData[size * i + (j + i)] = coefficients[j]; + // Pre-calculate positions for better performance + final coeffLength = coefficients.length; + final derivLength = derivative.length; + + // Place polynomial coefficients + for (var i = 0; i < size - coeffLength + 1; ++i) { + for (var j = 0; j < coeffLength; ++j) { + final value = coefficients[j]; + // Skip near-zero coefficients for numerical stability + if (value.abs() > 1e-10) { + flatData[size * i + (j + i)] = value; + } } } + // Place derivative coefficients var pos = 0; - for (var i = size - coefficients.length + 1; i < size; ++i) { - for (var j = 0; j < derivative.length; ++j) { - flatData[size * i + (j + pos)] = derivative[j]; + for (var i = size - coeffLength + 1; i < size; ++i) { + for (var j = 0; j < derivLength; ++j) { + final value = derivative[j]; + // Skip near-zero coefficients for numerical stability + if (value.abs() > 1e-10) { + flatData[size * i + (j + pos)] = value; + } } ++pos; } @@ -78,30 +94,15 @@ class SylvesterMatrix { /// The discriminant of a polynomial P(x) is the determinant of the Sylvester /// matrix of P and P' (where P' is the derivative of P). - /// - /// By default, the [optimize] parameter is set to `true` so that the - /// Sylvester matrix is not computed for polynomials whose degree is 4 or - /// lower. To be more precise: - /// - /// - With `optimize = true`, if the degree of the polynomial is lower than - /// 4, then the Sylvester matrix is not built. The computation of its - /// determinant can be computationally heavy so we can just avoid such - /// complexity by using the simple formulas for lower degree polynomials. - /// - /// - With `optimize = false`, the Sylvester matrix and its determinant are - /// always computed regardless the degree of the polynomial. - /// - /// You should keep the default value of [optimize]. - Complex polynomialDiscriminant({bool optimize = true}) { - final quarticOrLower = polynomial is Constant || + Complex polynomialDiscriminant() { + final quarticOrLower = + polynomial is Constant || polynomial is Linear || polynomial is Quadratic || polynomial is Cubic || polynomial is Quartic; - // In case the optimization flag was 'true' and the degree of the - // polynomial is <= 4, then go for the easy way. - if (optimize && quarticOrLower) { + if (quarticOrLower) { return polynomial.discriminant(); } else { // The determinant of the Sylvester matrix @@ -124,6 +125,11 @@ class SylvesterMatrix { final sign = math.pow(-1, degree * (degree - 1) / 2) as double; final denominator = coefficients.first; + // Check for near-zero denominator + if (denominator.abs() < 1e-10) { + throw const MatrixException('Leading coefficient is too close to zero'); + } + // Returning the determinant with the correct sign return Complex.fromReal(sign) / denominator * determinant; } diff --git a/lib/src/integral/numerical_integration.dart b/lib/src/integral/numerical_integration.dart index 7e6cea08..9d0e1713 100644 --- a/lib/src/integral/numerical_integration.dart +++ b/lib/src/integral/numerical_integration.dart @@ -1,5 +1,6 @@ import 'package:equations/equations.dart'; +/// {@template numerical_integration} /// When it comes to analysis, the term **numerical integration** indicates a /// group of algorithms for calculating the numerical value of a definite /// integral on an interval. @@ -8,7 +9,7 @@ import 'package:equations/equations.dart'; /// definite integral with a certain degree of accuracy. `NumericalIntegration` /// is the direct supertype of: /// -/// 1. [IntervalsIntegration], which is used for numerical integration +/// 1. [IntervalsIntegration], which is used by numerical integration /// algorithms that split the integration bounds into intervals. /// /// 2. [AdaptiveQuadrature], which uses the "adaptive quadrature" algorithm to @@ -16,8 +17,9 @@ import 'package:equations/equations.dart'; /// /// The function must be continuous in the `[lowerBound, upperBound]` /// interval. +/// {@endtemplate} abstract base class NumericalIntegration { - /// Internal functions evaluator. + /// Internal function evaluator. static const _evaluator = ExpressionParser(); /// The function to be integrated on the given interval. @@ -29,7 +31,7 @@ abstract base class NumericalIntegration { /// The upper bound of the integral. final double upperBound; - /// Creates a [NumericalIntegration] object. + /// {@macro numerical_integration} const NumericalIntegration({ required this.function, required this.lowerBound, @@ -53,7 +55,11 @@ abstract base class NumericalIntegration { } @override - int get hashCode => Object.hash(function, lowerBound, upperBound); + int get hashCode => Object.hash( + function, + lowerBound, + upperBound, + ); @override String toString() { @@ -63,7 +69,7 @@ abstract base class NumericalIntegration { return '$function on [$lower, $upper]'; } - /// Evaluates the given [function] on the [x] point. + /// Evaluates the given [function] at the [x] point. double evaluateFunction(double x) => _evaluator.evaluateOn(function, x); /// Calculates the numerical value of the **definite** [function] integral @@ -74,6 +80,6 @@ abstract base class NumericalIntegration { /// the algorithm on each step; /// /// - a `result` named field, which contains the evaluation of the integral - /// in the `[a, b]` interval. + /// in the `[lowerBound, upperBound]` interval. ({List guesses, double result}) integrate(); } diff --git a/lib/src/integral/types/adaptive_quadrature.dart b/lib/src/integral/types/adaptive_quadrature.dart index 6c1e3373..648a34fc 100644 --- a/lib/src/integral/types/adaptive_quadrature.dart +++ b/lib/src/integral/types/adaptive_quadrature.dart @@ -1,22 +1,45 @@ import 'package:equations/equations.dart'; +/// {@template adaptive_quadrature} /// The "Adaptive quadrature" is a technique for approximating the value of a -/// definite integral. +/// definite integral that automatically adjusts the step size based on the +/// local behavior of the function being integrated. +/// +/// ## Details +/// +/// Unlike fixed-step methods like Simpson's rule or the trapezoidal method, +/// adaptive quadrature: +/// +/// - Uses smaller step sizes in regions where the function varies rapidly +/// - Uses larger step sizes in regions where the function is smooth +/// - Automatically determines the best subdivision of the integration interval +/// - Provides better accuracy with fewer function evaluations +/// +/// The algorithm works by: +/// +/// 1. Computing two different approximations of the same subinterval +/// 2. Comparing their difference to a tolerance value +/// 3. If the difference is small enough, accepting the more accurate result +/// 4. If not, subdividing the interval and recursively applying the method +/// +/// This approach makes adaptive quadrature particularly effective for functions +/// with varying smoothness or regions of high curvature. /// /// This algorithm requires two initial points ([lowerBound] and [upperBound]) /// that indicate the lower and upper integration bounds. +/// {@endtemplate} final class AdaptiveQuadrature extends NumericalIntegration { - /// Creates a [AdaptiveQuadrature] object. + /// {@macro adaptive_quadrature} const AdaptiveQuadrature({ required super.function, required super.lowerBound, required super.upperBound, }); - /// Uses the "adaptive quadrature" algorithm to evaluate the integral within + /// Uses the "adaptive quadrature" algorithm to evaluate the integral between /// [a] and [b]. double _adaptive(double a, double b, List guesses) { - const tolerance = 1.0e-8; + const tolerance = 1.0e-10; final h = b - a; final c = (a + b) / 2.0; @@ -27,7 +50,8 @@ final class AdaptiveQuadrature extends NumericalIntegration { final fb = evaluateFunction(b); final q1 = h / 6 * (fa + 4 * evaluateFunction(c) + fb); - final q2 = h / + final q2 = + h / 12 * (fa + 4 * evaluateFunction(d) + diff --git a/lib/src/integral/types/intervals_integration.dart b/lib/src/integral/types/intervals_integration.dart index 276ce9d5..22fbed53 100644 --- a/lib/src/integral/types/intervals_integration.dart +++ b/lib/src/integral/types/intervals_integration.dart @@ -1,8 +1,9 @@ import 'package:equations/equations.dart'; +/// {@template intervals_integration} /// This class is extended by classes whose algorithms divide the integration -/// bounds into smaller intervals to compute the result. There currently are -/// three subclasses of `IntervalsIntegration`: +/// bounds into smaller intervals to compute the result. There are currently +/// three subclasses of [IntervalsIntegration]: /// /// - [TrapezoidalRule] /// - [SimpsonRule] @@ -10,12 +11,24 @@ import 'package:equations/equations.dart'; /// /// For a different approach that doesn't use [intervals], see /// [AdaptiveQuadrature]. +/// +/// ## Details +/// +/// Interval-based methods (like the ones in this class) use a fixed number of +/// equally-sized subintervals to approximate the integral. The accuracy depends +/// on the number of intervals specified by the user. +/// +/// In contrast, adaptive quadrature methods (see [AdaptiveQuadrature]) +/// automatically adjust the subinterval sizes based on the function's behavior, +/// using more subdivisions where the function varies rapidly and fewer where it +/// is smooth. +/// {@endtemplate} abstract base class IntervalsIntegration extends NumericalIntegration { /// The number of parts in which the interval `[lowerBound, upperBound]` has /// to be split by the algorithm. final int intervals; - /// Creates a [IntervalsIntegration] object. + /// {@macro intervals_integration} const IntervalsIntegration({ required super.function, required super.lowerBound, @@ -41,7 +54,12 @@ abstract base class IntervalsIntegration extends NumericalIntegration { } @override - int get hashCode => Object.hash(function, lowerBound, upperBound, intervals); + int get hashCode => Object.hash( + function, + lowerBound, + upperBound, + intervals, + ); @override String toString() { diff --git a/lib/src/integral/types/intervals_methods/midpoint_rule.dart b/lib/src/integral/types/intervals_methods/midpoint_rule.dart index c0e10c4e..a81814ee 100644 --- a/lib/src/integral/types/intervals_methods/midpoint_rule.dart +++ b/lib/src/integral/types/intervals_methods/midpoint_rule.dart @@ -1,15 +1,26 @@ import 'package:equations/equations.dart'; -/// The "midpoint rule" is a technique for approximating the value of a -/// definite integral. +/// {@template midpoint_rule} +/// The midpoint rule is a numerical integration technique for approximating +/// definite integrals using Riemann sums. Given a definite integral in the +/// form ∫`[a,b]` f(x) dx, the midpoint rule approximates it as: /// -/// This algorithm requires the [intervals] parameter, which indicates how many -/// partitions have to be computed by the algorithm. +/// ∫`[a,b]` f(x) dx ≈ h * Σ`[i=0 to n-1]` f(xᵢ) +/// +/// where: +/// - h = (b - a) / n is the step size +/// - xᵢ = a + h/2 + i*h is the midpoint of the i-th subinterval +/// - n is the number of intervals /// -/// The midpoint rule estimates a definite integral using a Riemann sum with -/// sub-intervals of equal width. +/// The midpoint rule has an error bound of O(h^2), making it more accurate than +/// the trapezoidal rule for many functions. The error decreases as the number +/// of intervals increases. +/// +/// This algorithm requires the [intervals] parameter, which indicates how many +/// partitions must be computed by the algorithm. +/// {@endtemplate} base class MidpointRule extends IntervalsIntegration { - /// Creates a [MidpointRule] object. + /// {@macro midpoint_rule} /// /// By default, [intervals] is set to `30`. const MidpointRule({ @@ -21,7 +32,7 @@ base class MidpointRule extends IntervalsIntegration { @override ({List guesses, double result}) integrate() { - // The 'step' of the algorithm. + // The step size of the algorithm. final h = (upperBound - lowerBound) / intervals; // This variable will keep track of the actual result. @@ -31,8 +42,9 @@ base class MidpointRule extends IntervalsIntegration { final guesses = List.generate( intervals, (index) { - final midpoint = lowerBound + h / 2; - final guess = evaluateFunction(midpoint + index * h); + // Calculate the midpoint of the i-th subinterval + final midpoint = lowerBound + h / 2 + index * h; + final guess = evaluateFunction(midpoint); integralResult += guess; return guess; diff --git a/lib/src/integral/types/intervals_methods/simpson_rule.dart b/lib/src/integral/types/intervals_methods/simpson_rule.dart index 56610809..7f8fb1ff 100644 --- a/lib/src/integral/types/intervals_methods/simpson_rule.dart +++ b/lib/src/integral/types/intervals_methods/simpson_rule.dart @@ -1,18 +1,31 @@ import 'package:equations/equations.dart'; import 'package:equations/src/utils/exceptions/types/numerical_integration_exception.dart'; -/// The "Simpson rule" is a technique for approximating the value of a -/// definite integral. +/// {@template simpson_rule} +/// Simpson's Rule is a numerical integration technique that approximates the +/// value of a definite integral using quadratic polynomials. Given a definite +/// integral in the form ∫`[a,b]` f(x) dx, Simpson's rule approximates it as: /// -/// This algorithm requires the [intervals] parameter, which indicates how many -/// partitions have to be computed by the algorithm. +/// ∫`[a,b]` f(x) dx ≈ (h/3) * `[f(x₀) + 4f(x₁) + 2f(x₂) + ... + 4f(xₙ₋₁) + f(xₙ)]` /// -/// Note that [intervals] must be an even number. If [intervals] is not even, a -/// [NumericalIntegrationException] object is thrown. +/// where: +/// - h = (b - a) / n is the step size +/// - n is the number of intervals (must be even) +/// - xᵢ = a + ih for i = 0, 1, 2, ..., n +/// +/// Simpson's Rule has an error bound of O(h^4), making it more accurate than +/// the Trapezoidal Rule (O(h^4)) for smooth functions. The method is exact for +/// polynomials of degree 3 or less. Here are the requirements for this method: +/// +/// - [intervals] must be an even number (required for quadratic approximation); +/// - the function should be continuous on `[lowerBound, upperBound]`; +/// - for best accuracy, the function should be smooth (few discontinuities). +/// {@endtemplate} base class SimpsonRule extends IntervalsIntegration { - /// Creates a [SimpsonRule] object. + /// {@macro simpson_rule} /// - /// By default, [intervals] is set to `32`. + /// By default, [intervals] is set to `32`. For most applications, this + /// provides a good balance between accuracy and computational cost. const SimpsonRule({ required super.function, required super.lowerBound, @@ -22,41 +35,63 @@ base class SimpsonRule extends IntervalsIntegration { @override ({List guesses, double result}) integrate() { - // Make sure to throw an exception if 'intervals' is odd. + // Validate that intervals is even (required for Simpson's Rule) if (intervals % 2 != 0) { throw const NumericalIntegrationException( 'There must be an even number of partitions.', ); } - // The 'step' of the algorithm. + // Validate that intervals is positive + if (intervals <= 0) { + throw const NumericalIntegrationException( + 'The number of intervals must be positive. ', + ); + } + + // Calculate the step size final h = (upperBound - lowerBound) / intervals; - // Keeping track separately of the sums of the even and odd series. + // Initialize sums for the Simpson's Rule formula + // oddSum: sum of f(x) at odd-indexed points (multiplied by 4) + // evenSum: sum of f(x) at even-indexed points (multiplied by 2) var oddSum = 0.0; var evenSum = 0.0; - // The list containing the various guesses of the algorithm. + // Pre-allocate the guesses list for better performance final guesses = List.filled(intervals, 0); - // The first iteration. + // Evaluate function at odd-indexed points (x₁, x₃, x₅, ..., xₙ₋₁) + // These get multiplied by 4 in the final formula for (var i = 1; i < intervals; i += 2) { - oddSum += evaluateFunction(lowerBound + i * h); - guesses[i] = oddSum; + final x = lowerBound + i * h; + final fx = evaluateFunction(x); + oddSum += fx; + guesses[i] = fx; } - // The second iteration. + // Evaluate function at even-indexed points (x₂, x₄, x₆, ..., xₙ₋₂) + // These get multiplied by 2 in the final formula for (var i = 2; i < intervals - 1; i += 2) { - evenSum += evaluateFunction(lowerBound + i * h); - guesses[i] = evenSum; + final x = lowerBound + i * h; + final fx = evaluateFunction(x); + evenSum += fx; + guesses[i] = fx; } - // Returning the result. - final bounds = evaluateFunction(lowerBound) + evaluateFunction(upperBound); + // Evaluate function at the endpoints (x₀ and xₙ) + final fLower = evaluateFunction(lowerBound); + final fUpper = evaluateFunction(upperBound); + guesses[0] = fLower; + guesses[intervals - 1] = fUpper; + + // Apply Simpson's Rule formula: + // ∫[a,b] f(x) dx ≈ (h/3) * [f(x₀) + 4*sum_odd + 2*sum_even + f(xₙ)] + final result = (fLower + 4 * oddSum + 2 * evenSum + fUpper) * h / 3; return ( guesses: guesses, - result: (bounds + (evenSum * 2) + (oddSum * 4)) * h / 3, + result: result, ); } } diff --git a/lib/src/integral/types/intervals_methods/trapezoidal_rule.dart b/lib/src/integral/types/intervals_methods/trapezoidal_rule.dart index 525198fd..0058c10e 100644 --- a/lib/src/integral/types/intervals_methods/trapezoidal_rule.dart +++ b/lib/src/integral/types/intervals_methods/trapezoidal_rule.dart @@ -1,16 +1,32 @@ import 'package:equations/equations.dart'; +import 'package:equations/src/utils/exceptions/types/numerical_integration_exception.dart'; -/// The "trapezoidal rule" is a technique for approximating the value of a -/// definite integral. +/// {@template trapezoidal_rule} +/// The trapezoidal rule is a numerical integration technique for approximating +/// definite integrals using linear interpolation. Given a definite integral in +/// the form ∫`[a,b]` f(x) dx, the trapezoidal rule approximates it as: /// -/// This algorithm requires the [intervals] parameter, which indicates how many -/// partitions have to be computed by the algorithm. +/// ∫`[a,b]` f(x) dx ≈ (h/2) * `[f(x₀) + 2f(x₁) + 2f(x₂) + ... + 2f(xₙ₋₁) + f(xₙ)]` +/// +/// where: +/// - h = (b - a) / n is the step size +/// - xᵢ = a + ih for i = 0, 1, 2, ..., n +/// - n is the number of intervals +/// +/// The trapezoidal rule has an error bound of O(h²), meaning the error +/// decreases quadratically as the number of intervals increases. The method is +/// exact for linear functions and provides good accuracy for smooth functions. /// -/// The bigger the value of [intervals], the better the result approximation. +/// This algorithm requires the [intervals] parameter, which indicates how many +/// partitions must be computed by the algorithm. The larger the number of +/// intervals, the better the approximation (but at increased computational +/// cost). +/// {@endtemplate} base class TrapezoidalRule extends IntervalsIntegration { - /// Creates a [TrapezoidalRule] object. + /// {@macro trapezoidal_rule} /// - /// By default, [intervals] is set to `20`. + /// By default, [intervals] is set to `20`. For most applications, this + /// provides a good balance between accuracy and computational cost. const TrapezoidalRule({ required super.function, required super.lowerBound, @@ -20,27 +36,45 @@ base class TrapezoidalRule extends IntervalsIntegration { @override ({List guesses, double result}) integrate() { - // The 'step' of the algorithm. + // Validate that intervals is positive + if (intervals <= 0) { + throw const NumericalIntegrationException( + 'The number of intervals must be positive.', + ); + } + + // Calculate the step size final h = (upperBound - lowerBound) / intervals; - // The initial approximation of the result. - var integralResult = - evaluateFunction(lowerBound) + evaluateFunction(upperBound); + // Evaluate function at the endpoints (these get multiplied by 1/2) + final fLower = evaluateFunction(lowerBound); + final fUpper = evaluateFunction(upperBound); + + // Initialize the sum for interior points (these get multiplied by 1) + var interiorSum = 0.0; - // The list containing the various guesses of the algorithm. + // Pre-allocate the guesses list for better performance final guesses = List.filled(intervals, 0); - // The actual algorithm. - for (var i = 0; i < intervals; ++i) { + // Evaluate function at interior points (x₁, x₂, ..., xₙ₋₁) + // These get multiplied by 1 in the final formula + for (var i = 1; i < intervals; ++i) { final x = lowerBound + i * h; - - integralResult += 2 * evaluateFunction(x); - guesses[i] = integralResult; + final fx = evaluateFunction(x); + interiorSum += fx; + guesses[i] = fx; } + // Store endpoint values in guesses + guesses[0] = fLower; + + // Apply trapezoidal rule formula: + // ∫[a,b] f(x) dx ≈ (h/2) * [f(x₀) + 2 * sum_interior + f(xₙ)] + final result = (fLower + 2 * interiorSum + fUpper) * h / 2; + return ( guesses: guesses, - result: integralResult * h / 2, + result: result, ); } } diff --git a/lib/src/interpolation/interpolation.dart b/lib/src/interpolation/interpolation.dart index 6f6f28c0..3edc79aa 100644 --- a/lib/src/interpolation/interpolation.dart +++ b/lib/src/interpolation/interpolation.dart @@ -1,18 +1,20 @@ import 'package:equations/equations.dart'; +/// {@template interpolation} /// An abstract class that represents an interpolation strategy, used to find /// new data points based on a given discrete set of data points (called nodes). -/// The algorithms implemented by this package are: +/// The available interpolation algorithms are: /// /// - [LinearInterpolation]; /// - [PolynomialInterpolation]; /// - [NewtonInterpolation]; /// - [SplineInterpolation]. +/// {@endtemplate} abstract base class Interpolation { /// The interpolation nodes. final List nodes; - /// Creates an [Interpolation] object with the given nodes. + /// {@macro interpolation} const Interpolation({ required this.nodes, }); @@ -24,24 +26,16 @@ abstract base class Interpolation { } if (other is Interpolation) { - // The lengths of the coefficients must match. if (nodes.length != other.nodes.length) { return false; } - - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the - // coefficients list. - var equalsCount = 0; - for (var i = 0; i < nodes.length; ++i) { - if (nodes[i] == other.nodes[i]) { - ++equalsCount; + if (nodes[i] != other.nodes[i]) { + return false; } } - // They must have the same runtime type AND all items must be equal. - return runtimeType == other.runtimeType && equalsCount == nodes.length; + return runtimeType == other.runtimeType; } else { return false; } diff --git a/lib/src/interpolation/types/linear_interpolation.dart b/lib/src/interpolation/types/linear_interpolation.dart index 4290a6b2..f5f9ed7a 100644 --- a/lib/src/interpolation/types/linear_interpolation.dart +++ b/lib/src/interpolation/types/linear_interpolation.dart @@ -1,16 +1,15 @@ import 'package:equations/equations.dart'; +/// {@template linear_interpolation} /// Linear interpolation is a curve fitting method that uses linear polynomials /// to construct new data points within the range of a discrete set of known /// data points. /// /// This can also be seen as a special case of polynomial interpolation where /// the degree is set to 1. +/// {@endtemplate} base class LinearInterpolation extends Interpolation { - /// Creates a [LinearInterpolation] object from the given interpolation - /// nodes. - /// - /// There **must** only be 2 nodes. + /// {@macro linear_interpolation} const LinearInterpolation({ required super.nodes, }) : assert(nodes.length == 2, 'There must exactly be 2 nodes!'); diff --git a/lib/src/interpolation/types/newton_interpolation.dart b/lib/src/interpolation/types/newton_interpolation.dart index 131dbb06..103c089c 100644 --- a/lib/src/interpolation/types/newton_interpolation.dart +++ b/lib/src/interpolation/types/newton_interpolation.dart @@ -1,20 +1,65 @@ import 'package:equations/equations.dart'; import 'package:equations/src/utils/factorial.dart'; -/// Newton interpolation is an interpolation polynomial for a given set of data -/// points. It can be expressed using forward or backward divided differences. +/// {@template newton_interpolation} +/// Newton interpolation (also known as Newton's divided difference +/// interpolation) is a polynomial interpolation method that constructs an +/// interpolation polynomial for a given set of data points using divided +/// differences. +/// +/// This implementation supports both **forward differences** and **backward +/// differences**: +/// +/// - **Forward differences**: Best used when interpolating near the beginning +/// of the data set (i.e., when `x` is close to the first node's x-value). +/// The formula uses Newton's forward difference formula. +/// +/// - **Backward differences**: Best used when interpolating near the end of +/// the data set (i.e., when `x` is close to the last node's x-value). +/// The formula uses Newton's backward difference formula. +/// +/// ## Requirements +/// +/// The interpolation nodes should be **equally spaced** for optimal accuracy. +/// While the algorithm will work with unequally spaced nodes, the results may +/// be less accurate. +/// +/// ## Example +/// +/// ```dart +/// const interpolation = NewtonInterpolation( +/// nodes: [ +/// InterpolationNode(x: 45, y: 0.7071), +/// InterpolationNode(x: 50, y: 0.766), +/// InterpolationNode(x: 55, y: 0.8192), +/// InterpolationNode(x: 60, y: 0.866), +/// ], +/// forwardDifference: true, // Use forward differences +/// ); +/// +/// // Interpolate at x = 52 +/// final result = interpolation.compute(52); +/// print(result); // Approximately 0.788 +/// ``` +/// {@endtemplate} base class NewtonInterpolation extends Interpolation { /// Required to compute the factorial of a number. static const _factorial = Factorial(); - /// When `true`, the Newton interpolation with forward differences is used. - /// When `false`, the Newton interpolation with backward differences is used. + /// When true, the algorithm uses forward differences. + /// When false, the algorithm uses backward differences. + /// + /// **Forward differences** are typically more accurate when interpolating + /// near the beginning of the data set, while **backward differences** are + /// better for interpolation near the end of the data set. /// /// By default, this is set to `true`. final bool forwardDifference; - /// Creates a [NewtonInterpolation] instance from the given interpolation - /// nodes. + /// {@macro newton_interpolation} + /// + /// The [nodes] should be equally spaced for best results. The + /// [forwardDifference] parameter determines which difference formula to use. const NewtonInterpolation({ required super.nodes, this.forwardDifference = true, @@ -29,7 +74,28 @@ base class NewtonInterpolation extends Interpolation { return _backwardEvaluation(backwardDifferenceTable(), x); } - /// Computes the u of the formula, where `u = (x – a)/h`. + /// Computes the product `u(u-1)(u-2)...(u-(n-1))` used in Newton's + /// interpolation formulas. + /// + /// This method computes the falling factorial `u(u-1)(u-2)...(u-(n-1))` which + /// is used in both forward and backward difference formulas: + /// + /// - **Forward differences**: Directly uses `u(u-1)(u-2)...` where `u ≥ 0` + /// (when `x ≥ x₀`). + /// + /// - **Backward differences**: Uses the same formula, but since `u` is + /// typically negative (when `x < xₙ`), the pattern `u(u-1)(u-2)...` with + /// negative `u` produces the correct alternating signs needed for the + /// backward difference formula. + /// + /// The parameter [u] is the normalized value: + /// - For forward differences: `u = (x - x₀)/h` + /// - For backward differences: `u = (x - xₙ)/h` + /// + /// where `h` is the step size between nodes. + /// + /// The parameter [n] represents the order of the difference being computed + /// (1 for first-order, 2 for second-order, etc.). double _computeU(double u, int n) { var temp = u; for (var i = 1; i < n; i++) { @@ -39,12 +105,18 @@ base class NewtonInterpolation extends Interpolation { return temp; } - /// Evaluates the function on a given [x] point using the forward differences - /// table. + /// Evaluates the interpolation polynomial at point [x] using Newton's forward + /// difference formula. double _forwardEvaluation(RealMatrix differencesTable, double x) { + // Start with f(x₀), the first value in the difference table var sum = differencesTable(0, 0); - final u = (x - nodes.first.x) / (nodes[1].x - nodes.first.x); + // Compute normalized x-value: u = (x - x₀) / h + // where h is the step size between consecutive nodes + final stepSize = nodes[1].x - nodes.first.x; + final u = (x - nodes.first.x) / stepSize; + + // Add terms: u·Δf(x₀)/1! + u(u-1)·Δ²f(x₀)/2! + ... for (var i = 1; i < differencesTable.rowCount; i++) { final fact = _factorial.compute(i); sum += (_computeU(u, i) * differencesTable(0, i)) / fact; @@ -53,13 +125,23 @@ base class NewtonInterpolation extends Interpolation { return sum; } - /// Evaluates the function on a given [x] point using the backward differences - /// table. + /// Evaluates the interpolation polynomial at point [x] using Newton's + /// backward difference formula. double _backwardEvaluation(RealMatrix differencesTable, double x) { final size = nodes.length - 1; + + // Start with f(xₙ), the last value in the difference table var sum = differencesTable(size, 0); - final u = (x - nodes[size].x) / (nodes[1].x - nodes.first.x); + // Compute normalized x-value: u = (x - xₙ) / h + // where h is the step size between consecutive nodes + // For backward differences, use the spacing between the last two nodes + final stepSize = nodes[size].x - nodes[size - 1].x; + final u = (x - nodes[size].x) / stepSize; + + // Add terms: u·∇f(xₙ)/1! + u(u+1)·∇²f(xₙ)/2! + ... + // Note: Since u is typically negative (x < xₙ), _computeU(u, i) with + // negative u effectively computes u(u+1)(u+2)... for backward differences for (var i = 1; i < differencesTable.rowCount; i++) { final fact = _factorial.compute(i); sum += (_computeU(u, i) * differencesTable(size, i)) / fact; @@ -70,6 +152,11 @@ base class NewtonInterpolation extends Interpolation { /// Computes the forward differences table and stores the results in a /// [RealMatrix] object. + /// + /// The first row (row 0) contains the differences used in Newton's forward + /// difference formula. + /// + /// Returns a square matrix of size `n × n` where `n` is the number of nodes. RealMatrix forwardDifferenceTable() { final size = nodes.length; final table = List>.generate( @@ -78,13 +165,13 @@ base class NewtonInterpolation extends Interpolation { growable: false, ); - // Initializing the column + // Initialize the first column with the function values f(xᵢ) var index = 0; for (final node in nodes) { table[index++].first = node.y; } - // Forward difference table + // Compute forward differences: Δᵏf(xᵢ) = Δᵏ⁻¹f(xᵢ₊₁) - Δᵏ⁻¹f(xᵢ) for (var i = 1; i < size; i++) { for (var j = 0; j < size - i; j++) { table[j][i] = table[j + 1][i - 1] - table[j][i - 1]; @@ -100,6 +187,11 @@ base class NewtonInterpolation extends Interpolation { /// Computes the backward differences table and stores the results in a /// [RealMatrix] object. + /// + /// The last row (row `n-1`) contains the differences used in Newton's + /// backward difference formula. + /// + /// Returns a square matrix of size `n × n` where `n` is the number of nodes. RealMatrix backwardDifferenceTable() { final size = nodes.length; final table = List>.generate( @@ -108,13 +200,14 @@ base class NewtonInterpolation extends Interpolation { growable: false, ); - // Initializing the column + // Initialize the first column with the function values f(xᵢ) var index = 0; for (final node in nodes) { table[index++].first = node.y; } - // Backward difference table + // Compute backward differences: ∇ᵏf(xᵢ) = ∇ᵏ⁻¹f(xᵢ) - ∇ᵏ⁻¹f(xᵢ₋₁) + // Process from bottom to top to ensure dependencies are computed first for (var i = 1; i < size; i++) { for (var j = size - 1; j >= i; j--) { table[j][i] = table[j][i - 1] - table[j - 1][i - 1]; diff --git a/lib/src/interpolation/types/polynomial_interpolation.dart b/lib/src/interpolation/types/polynomial_interpolation.dart index 8b63b02f..42cb3d74 100644 --- a/lib/src/interpolation/types/polynomial_interpolation.dart +++ b/lib/src/interpolation/types/polynomial_interpolation.dart @@ -2,27 +2,121 @@ import 'dart:math'; import 'package:equations/equations.dart'; -/// Polynomial interpolation is the interpolation of a given data set by the -/// polynomial of lowest possible degree that passes through the points of the -/// data set. +/// {@template polynomial_interpolation} +/// Polynomial interpolation using **Lagrange's interpolation formula** to find +/// the unique polynomial of degree `n-1` that passes through `n` given data +/// points. /// -/// This can also be seen as a generalization of linear interpolation. +/// This implementation uses the Lagrange basis polynomial approach, which +/// directly constructs the interpolating polynomial without solving a system +/// of equations. +/// +/// ## Requirements +/// +/// - **At least 2 nodes** are required for interpolation +/// - **All x-values must be distinct** (duplicate x-values will cause division +/// by zero and throw an [InterpolationException]) +/// - Nodes can be in any order (sorting is not required) +/// +/// ## Limitations +/// +/// - **Runge's phenomenon**: For large numbers of equally-spaced nodes, the +/// interpolating polynomial may oscillate wildly between nodes, especially +/// near the edges of the interval. Consider using [SplineInterpolation] for +/// large datasets. +/// - **Numerical stability**: The Vandermonde matrix approach used in +/// [buildPolynomial] can be ill-conditioned for large datasets or when nodes +/// are close together. +/// +/// ## When to Use +/// +/// - Small datasets (typically < 10-15 nodes) +/// - When you need the exact polynomial expression +/// - When nodes are not equally spaced +/// - When you need to evaluate at many different points (the polynomial can be +/// built once and reused) +/// {@endtemplate} base class PolynomialInterpolation extends Interpolation { - /// Creates a [PolynomialInterpolation] instance from the given interpolation - /// nodes. + /// {@macro polynomial_interpolation} + /// + /// **Note**: Validation of nodes (checking for duplicates and minimum count) + /// is performed lazily when [compute] or [buildPolynomial] is called. Invalid + /// nodes will cause an [InterpolationException] to be thrown at that time. const PolynomialInterpolation({ required super.nodes, }); + /// Validates that the nodes meet the requirements for polynomial + /// interpolation. + /// + /// Throws an [InterpolationException] if: + /// - There are fewer than 2 nodes + /// - There are duplicate x-values in the nodes + void _validateNodes() { + if (nodes.length < 2) { + throw const InterpolationException( + 'At least 2 nodes are required for polynomial interpolation.', + ); + } + + // Check for duplicate x-values + final xValues = {}; + for (final node in nodes) { + if (xValues.contains(node.x)) { + throw InterpolationException( + 'Duplicate x-value found: ${node.x}. All x-values must be distinct ' + 'for polynomial interpolation.', + ); + } + xValues.add(node.x); + } + } + + /// Evaluates the Lagrange interpolation polynomial at the given point [x]. + /// + /// This method uses the Lagrange basis polynomial formula to compute the + /// interpolated value. For each node `(xi, yi)`, it computes the Lagrange + /// basis polynomial `L(x)` and multiplies it by `yi`, then sums all terms. + /// + /// The algorithm optimizes by computing denominators once per call and + /// reusing them within the evaluation loop, avoiding repeated division + /// operations. @override double compute(double x) { + _validateNodes(); + + // Early return: if x exactly matches a node's x-value, return its y-value + for (var i = 0; i < nodes.length; i++) { + if (x == nodes[i].x) { + return nodes[i].y; + } + } + + // Precompute denominators once for this evaluation call + // denominators[i][j] stores 1 / (nodes[i].x - nodes[j].x) for i != j + final n = nodes.length; + final denominators = List.generate( + n, + (i) => List.generate(n, (j) => 0.0, growable: false), + growable: false, + ); + + for (var i = 0; i < n; i++) { + for (var j = 0; j < n; j++) { + if (i != j) { + denominators[i][j] = 1.0 / (nodes[i].x - nodes[j].x); + } + } + } + + // Compute using Lagrange interpolation formula var result = 0.0; - for (var i = 0; i < nodes.length; ++i) { + for (var i = 0; i < nodes.length; i++) { var term = nodes[i].y; for (var j = 0; j < nodes.length; j++) { if (i != j) { - term *= (x - nodes[j].x) / (nodes[i].x - nodes[j].x); + term *= (x - nodes[j].x) * denominators[i][j]; } } result += term; @@ -33,7 +127,23 @@ base class PolynomialInterpolation extends Interpolation { /// Computes the interpolation polynomial and returns it as an [Algebraic] /// object. + /// + /// This method constructs the interpolating polynomial by solving a system + /// of linear equations using the **Vandermonde matrix** approach. The + /// Vandermonde matrix is constructed from the x-values of the nodes, and + /// the system is solved using LU decomposition to find the polynomial + /// coefficients. + /// + /// The Vandermonde matrix can be **ill-conditioned** for: + /// - Large numbers of nodes (> 15-20) + /// - Nodes that are close together + /// - Equally-spaced nodes over large intervals + /// + /// In such cases, numerical errors may affect the accuracy of the computed + /// coefficients. For large datasets, consider using [NewtonInterpolation] or + /// [SplineInterpolation] instead. Algebraic buildPolynomial() { + _validateNodes(); final length = nodes.length * nodes.length; final matrixSource = List.generate(length, (_) => 0); diff --git a/lib/src/interpolation/types/spline_interpolation.dart b/lib/src/interpolation/types/spline_interpolation.dart index c4ee57e5..b672d11f 100644 --- a/lib/src/interpolation/types/spline_interpolation.dart +++ b/lib/src/interpolation/types/spline_interpolation.dart @@ -1,12 +1,15 @@ import 'package:equations/equations.dart'; import 'package:equations/src/interpolation/utils/spline_function.dart'; +/// {@template spline_interpolation} /// Performs spline interpolation given a set of control points. The algorithm /// can compute a "monotone cubic spline" or a "linear spline" based on the /// properties of the control points. +/// +/// See [SplineFunction] for more information. +/// {@endtemplate} base class SplineInterpolation extends Interpolation { - /// Creates a [SplineInterpolation] instance from the given interpolation - /// nodes. + /// {@macro spline_interpolation} const SplineInterpolation({ required super.nodes, }); diff --git a/lib/src/interpolation/utils/interpolation_node.dart b/lib/src/interpolation/utils/interpolation_node.dart index a1cd3df1..1e4673be 100644 --- a/lib/src/interpolation/utils/interpolation_node.dart +++ b/lib/src/interpolation/utils/interpolation_node.dart @@ -1,8 +1,10 @@ import 'package:equations/equations.dart'; +/// {@template interpolation_node} /// A point in the cartesian coordinate system used by [Interpolation] types to /// represent interpolation nodes. This class simply represents the `x` and `y` /// coordinates of a point on a cartesian plane. +/// {@endtemplate} final class InterpolationNode { /// The x coordinate. final double x; diff --git a/lib/src/interpolation/utils/spline_function.dart b/lib/src/interpolation/utils/spline_function.dart index 0cc075ca..82bf1d32 100644 --- a/lib/src/interpolation/utils/spline_function.dart +++ b/lib/src/interpolation/utils/spline_function.dart @@ -5,17 +5,19 @@ import 'package:equations/src/interpolation/utils/spline_functions/montone_cubic export 'spline_functions/linear_spline.dart'; export 'spline_functions/montone_cubic_spline.dart'; +/// {@template spline_function} /// A **spline** is a special function defined piecewise by polynomials. /// /// In interpolating problems, spline interpolation is often preferred to /// polynomial interpolation because it yields similar results, even when using /// low-degree polynomials, while avoiding Runge's phenomenon for higher /// degrees. +/// {@endtemplate} abstract base class SplineFunction { /// The interpolation nodes. final List nodes; - /// Creates a [SplineFunction] object with the given nodes. + /// {@macro spline_function} const SplineFunction({ required this.nodes, }); @@ -55,24 +57,16 @@ abstract base class SplineFunction { } if (other is SplineFunction) { - // The lengths of the coefficients must match. if (nodes.length != other.nodes.length) { return false; } - - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the - // coefficients list. - var equalsCount = 0; - for (var i = 0; i < nodes.length; ++i) { - if (nodes[i] == other.nodes[i]) { - ++equalsCount; + if (nodes[i] != other.nodes[i]) { + return false; } } - // They must have the same runtime type AND all items must be equal. - return runtimeType == other.runtimeType && equalsCount == nodes.length; + return runtimeType == other.runtimeType; } else { return false; } diff --git a/lib/src/interpolation/utils/spline_functions/linear_spline.dart b/lib/src/interpolation/utils/spline_functions/linear_spline.dart index 52c6cb98..191228c4 100644 --- a/lib/src/interpolation/utils/spline_functions/linear_spline.dart +++ b/lib/src/interpolation/utils/spline_functions/linear_spline.dart @@ -1,22 +1,56 @@ import 'package:equations/src/interpolation/utils/spline_function.dart'; +/// {@template linear_spline} /// Represents a linear spline from a given set of control points. The -/// interpolated curve will be monotonic if the control points. +/// interpolated curve will be monotonic if the control points are monotonic. +/// {@endtemplate} final class LinearSpline extends SplineFunction { - /// Creates a [LinearSpline] object from the given nodes. - const LinearSpline({ + /// Cached slopes (computed lazily on first use). + List? _nodesM; + + /// {@macro linear_spline} + LinearSpline({ required super.nodes, }); - @override - double interpolate(double x) { - // Linear spline creation + /// Computes and caches the slopes for the spline. + List _computeSlopes() { + if (_nodesM != null) { + return _nodesM!; + } + final nodesM = List.generate( nodes.length - 1, (i) => (nodes[i + 1].y - nodes[i].y) / (nodes[i + 1].x - nodes[i].x), growable: false, ); + _nodesM = nodesM; + return nodesM; + } + + /// Finds the segment index containing x using binary search. + /// Returns the index i such that `nodes[i].x <= x < nodes[i+1].x`. + int _findSegment(double x) { + var left = 0; + var right = nodes.length - 2; + + while (left <= right) { + final mid = (left + right) ~/ 2; + if (x < nodes[mid].x) { + right = mid - 1; + } else if (x >= nodes[mid + 1].x) { + left = mid + 1; + } else { + return mid; + } + } + + return left; + } + + @override + double interpolate(double x) { // Interpolating if (x.isNaN) { return x; @@ -33,15 +67,15 @@ final class LinearSpline extends SplineFunction { // Finding the i-th element of the last point with smaller 'x'. // We are sure that this will be within the spline due to the previous // boundary tests. - var i = 0; - while (x >= nodes[i + 1].x) { - ++i; + final i = _findSegment(x); - if (x == nodes[i].x) { - return nodes[i].y; - } + if (x == nodes[i].x) { + return nodes[i].y; } + // Get cached slopes (computed on first use) + final nodesM = _computeSlopes(); + return nodes[i].y + nodesM[i] * (x - nodes[i].x); } } diff --git a/lib/src/interpolation/utils/spline_functions/montone_cubic_spline.dart b/lib/src/interpolation/utils/spline_functions/montone_cubic_spline.dart index 8687a49a..a5ed6109 100644 --- a/lib/src/interpolation/utils/spline_functions/montone_cubic_spline.dart +++ b/lib/src/interpolation/utils/spline_functions/montone_cubic_spline.dart @@ -2,20 +2,28 @@ import 'package:equations/equations.dart'; import 'package:equations/src/interpolation/utils/spline_function.dart'; import 'package:equations/src/utils/math_utils.dart'; +/// {@template monotone_cubic_spline} /// Represents a monotone cubic spline from a given set of control points. /// /// The spline is guaranteed to pass through each control point exactly. In /// addition, assuming the control points are monotonic, then the interpolated /// values will also be monotonic. +/// {@endtemplate} final class MonotoneCubicSpline extends SplineFunction with MathUtils { - /// Creates a [MonotoneCubicSpline] object from the given nodes. - const MonotoneCubicSpline({ + /// Cached tangents (computed lazily on first use). + List? _nodesM; + + /// {@macro monotone_cubic_spline} + MonotoneCubicSpline({ required super.nodes, }); - @override - double interpolate(double x) { - // Monotonic cubic spline creation + /// Computes and caches the tangents for the spline. + List _computeTangents() { + if (_nodesM != null) { + return _nodesM!; + } + final nodesM = List.generate(nodes.length, (_) => 0); final pointsD = List.generate(nodes.length - 1, (_) => 0); @@ -67,11 +75,40 @@ final class MonotoneCubicSpline extends SplineFunction with MathUtils { } } + _nodesM = nodesM; + return nodesM; + } + + /// Finds the segment index containing x using binary search. + /// Returns the index i such that `nodes[i].x <= x < nodes[i+1].x`. + int _findSegment(double x) { + var left = 0; + var right = nodes.length - 2; + + while (left <= right) { + final mid = (left + right) ~/ 2; + if (x < nodes[mid].x) { + right = mid - 1; + } else if (x >= nodes[mid + 1].x) { + left = mid + 1; + } else { + return mid; + } + } + + return left; + } + + @override + double interpolate(double x) { // Interpolating if (x.isNaN) { return x; } + // Validate nodes by computing tangents (throws if nodes are invalid) + _computeTangents(); + if (x < nodes.first.x) { return nodes.first.y; } @@ -83,15 +120,15 @@ final class MonotoneCubicSpline extends SplineFunction with MathUtils { // Finding the i-th element of the last point with smaller 'x'. // We are sure that this will be within the spline due to the previous // boundary tests. - var i = 0; - while (x >= nodes[i + 1].x) { - ++i; + final i = _findSegment(x); - if (x == nodes[i].x) { - return nodes[i].y; - } + if (x == nodes[i].x) { + return nodes[i].y; } + // Get cached tangents (computed on first use) + final nodesM = _computeTangents(); + // Cubic Hermite spline interpolation. final h = nodes[i + 1].x - nodes[i].x; final t = (x - nodes[i].x) / h; diff --git a/lib/src/nonlinear/nonlinear.dart b/lib/src/nonlinear/nonlinear.dart index 9ba7762a..e7b0bf80 100644 --- a/lib/src/nonlinear/nonlinear.dart +++ b/lib/src/nonlinear/nonlinear.dart @@ -2,6 +2,7 @@ import 'dart:math' as math; import 'package:equations/equations.dart'; +/// {@template nonlinear} /// An abstract class that represents a nonlinear equation, which can be solved /// with a particular root-finding algorithm. No complex numbers are allowed. /// @@ -22,6 +23,7 @@ import 'package:equations/equations.dart'; /// Each subclass of [NonLinear] has to override the [solve] method to build the /// scalar succession with a certain logic. It's expected to produce a series /// of values that progressively get closer to the real root. +/// {@endtemplate} abstract base class NonLinear { /// The function f(x) for which the algorithm has to find a solution. final String function; @@ -32,7 +34,7 @@ abstract base class NonLinear { /// The maximum number of iterations to be made by the algorithm. final int maxSteps; - /// Creates a new [NonLinear] object. + /// {@macro nonlinear} const NonLinear({ required this.function, required this.tolerance, @@ -43,18 +45,30 @@ abstract base class NonLinear { String toString() => 'f(x) = $function'; /// To get a meaningful result, it makes sense to compute the rate of - /// convergence only if the algorithm made **at least** 3 [steps] - /// (iterations). + /// convergence only if there are **at least** 4 guesses in the [guesses] + /// list (which means at least 3 iterations were performed). /// - /// If [steps] is 2 or lower, [double.nan] is returned. + /// If there are fewer than 4 guesses, [double.nan] is returned. double convergence(List guesses, int steps) { final size = guesses.length - 1; if (size >= 3) { - final numerator = (guesses[size] - guesses[size - 1]).abs() / - (guesses[size - 1] - guesses[size - 2]).abs(); - final denominator = (guesses[size - 1] - guesses[size - 2]).abs() / - (guesses[size - 2] - guesses[size - 3]).abs(); + final diff1 = (guesses[size] - guesses[size - 1]).abs(); + final diff2 = (guesses[size - 1] - guesses[size - 2]).abs(); + final diff3 = (guesses[size - 2] - guesses[size - 3]).abs(); + + // Avoid division by zero if consecutive guesses are identical + if (diff2 == 0 || diff3 == 0) { + return double.nan; + } + + final numerator = diff1 / diff2; + final denominator = diff2 / diff3; + + // Avoid log(0) or log(negative) which would result in invalid values + if (numerator <= 0 || denominator <= 0) { + return double.nan; + } return math.log(numerator) / math.log(denominator); } @@ -62,10 +76,13 @@ abstract base class NonLinear { return double.nan; } - /// The efficiency is evaluated only if the convergence is not [double.nan]. + /// Computes the efficiency of the algorithm using the convergence rate. /// The formula is: /// - /// - efficiency = convergenceRate 1 / max_steps + /// - efficiency = convergenceRate^(1/steps) + /// + /// If the convergence rate is [double.nan], the efficiency will also be + /// [double.nan]. double efficiency(List guesses, int steps) { final c = convergence(guesses, steps); @@ -76,13 +93,28 @@ abstract base class NonLinear { num evaluateOn(double x) => const ExpressionParser().evaluateOn(function, x); /// Evaluates the derivative of the function on the given [x] value. + /// + /// Uses the central difference formula with an adaptive step size that + /// combines absolute and relative components for numerical stability: + /// + /// - When [x] is zero, returns [double.nan] + /// - For small [x], uses a minimum step size to avoid precision loss + /// - For large [x], uses a relative step size to maintain accuracy num evaluateDerivativeOn(double x) { - // Setting the precision to 1.0e-15 - final h = math.pow(1.0e-15, 1 / 3) * x; + // When x is zero, h becomes zero, leading to NaN + if (x == 0) { + return double.nan; + } + + // Use cube root of machine epsilon for the base step size + final epsilon = math.pow(1.0e-15, 1 / 3); + + // Combine absolute and relative components: prevents h from being + // too small (precision issues) or too large (accuracy issues) + final h = epsilon * math.max(x.abs(), 1.0); final upper = evaluateOn(x + h); final lower = evaluateOn(x - h); - return (upper - lower) / (h * 2); } diff --git a/lib/src/nonlinear/types/bisection.dart b/lib/src/nonlinear/types/bisection.dart index b661b425..7a52ca00 100644 --- a/lib/src/nonlinear/types/bisection.dart +++ b/lib/src/nonlinear/types/bisection.dart @@ -1,13 +1,22 @@ import 'package:equations/equations.dart'; -/// Implements the 'bisection' method to find the roots of a given equation. -/// -/// **Characteristics**: +/// {@template bisection} +/// Implements the bisection method to find a root of a given equation. /// /// - The method is guaranteed to converge to a root of `f(x)` if `f(x)` is a /// continuous function on the interval `[a, b]`. /// -/// - The values of `f(a)` and `f(b)` must have opposite signs. +/// - The values of `f(a)` and `f(b)` must have opposite signs (i.e., +/// `f(a) * f(b) < 0`), which ensures that at least one root exists in the +/// interval by the Intermediate Value Theorem. +/// +/// - The method has linear convergence rate, making it slower than methods +/// like Newton's method, but it is very robust and always converges when the +/// conditions are met. +/// +/// - The interval is repeatedly bisected, and the subinterval containing the +/// root is selected based on the sign of the function at the midpoint. +/// {@endtemplate} final class Bisection extends NonLinear { /// The starting point of the interval. final double a; @@ -15,20 +24,13 @@ final class Bisection extends NonLinear { /// The ending point of the interval. final double b; - /// Creates a [Bisection] object to find the root of an equation by using the - /// bisection method. - /// - /// - [function]: the function f(x); - /// - [a]: the first interval in which evaluate `f(a)`; - /// - [b]: the second interval in which evaluate `f(b)`; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro bisection} const Bisection({ required super.function, required this.a, required this.b, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -54,31 +56,55 @@ final class Bisection extends NonLinear { @override ({List guesses, double convergence, double efficiency}) solve() { - var amp = tolerance + 1; - var n = 1; + // Validate that the root is bracketed in the interval + final evalA = evaluateOn(a); + final evalB = evaluateOn(b); + + if (evalA * evalB >= 0) { + throw NonlinearException( + 'The root is not bracketed in [$a, $b]. ' + 'f(a) and f(b) must have opposite signs.', + ); + } + final guesses = []; + var n = 1; var pA = a; var pB = b; - var fa = evaluateOn(pA); + var fa = evalA; - while ((amp >= tolerance) && (n <= maxSteps)) { - ++n; - amp = (pB - pA).abs(); - final x0 = pA + amp * 0.5; + while (n <= maxSteps) { + // Calculate the interval width + final amp = (pB - pA).abs(); - guesses.add(x0); + // Check if we've reached the desired tolerance + if (amp < tolerance) { + break; + } + + // Compute the midpoint + final x0 = (pA + pB) / 2; final fx = evaluateOn(x0); + // Add the guess to the list + guesses.add(x0); + + // If we've found the exact root, we're done + if (fx == 0) { + break; + } + + // Update the interval based on the sign of the function if (fa * fx < 0) { + // Root is in [pA, x0] pB = x0; } else { - if (fa * fx > 0) { - pA = x0; - fa = fx; - } else { - amp = 0; - } + // Root is in [x0, pB] + pA = x0; + fa = fx; } + + ++n; } return ( diff --git a/lib/src/nonlinear/types/brent.dart b/lib/src/nonlinear/types/brent.dart index 1f425121..e29d8505 100644 --- a/lib/src/nonlinear/types/brent.dart +++ b/lib/src/nonlinear/types/brent.dart @@ -1,14 +1,26 @@ import 'package:equations/equations.dart'; +/// {@template brent} /// Implements Brent's method to find the roots of a given equation. /// -/// **Characteristics**: +/// Brent's method is a root-finding algorithm that combines the bisection +/// method, the secant method, and inverse quadratic interpolation. It has the +/// reliability of bisection but can be as fast as some of the less-reliable +/// methods. /// /// - The method is guaranteed to converge to a root of `f(x)` if `f(x)` is a /// continuous function on the interval `[a, b]`. /// /// - The root must be inside the `[a, b]` interval. For this reason, the /// method will fail if `f(a) * f(b) >= 0`. +/// +/// - The algorithm uses inverse quadratic interpolation when possible, falls +/// back to the secant method, and uses bisection when necessary to ensure +/// convergence. +/// +/// - Typically has superlinear convergence rate, making it faster than pure +/// bisection while maintaining guaranteed convergence. +/// {@endtemplate} final class Brent extends NonLinear { /// The starting point of the interval. final double a; @@ -16,20 +28,13 @@ final class Brent extends NonLinear { /// The ending point of the interval. final double b; - /// Creates a [Brent] object to find the root of an equation using Brent's - /// method. - /// - /// - [function]: the function f(x); - /// - [a]: the first interval in which evaluate `f(a)`; - /// - [b]: the second interval in which evaluate `f(b)`; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro brent} const Brent({ required super.function, required this.a, required this.b, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -53,21 +58,45 @@ final class Brent extends NonLinear { @override int get hashCode => Object.hash(function, a, b, tolerance, maxSteps); + /// Checks if the interpolated point `s` is outside the acceptable range + /// for inverse quadratic interpolation or secant method. + /// + /// Returns `true` if `s` is not in the interval `[(3a+b)/4, b]`, indicating + /// that bisection should be used instead. bool _condition1(double s, double a, double b) { final lower = (a * 3 + b) / 4; return !((s >= lower) && (s <= b)); } + /// Checks if the step size is too large when using inverse quadratic + /// interpolation (flag is true). + /// + /// Returns `true` if the step from `b` to `s` is at least half the distance + /// from `b` to `c`, indicating that bisection should be used instead. bool _condition2(double s, bool flag, double b, double c) => flag && ((s - b).abs() >= ((b - c).abs() / 2)); + /// Checks if the step size is too large when using secant method (flag is + /// false). + /// + /// Returns `true` if the step from `b` to `s` is at least half the distance + /// from `c` to `d`, indicating that bisection should be used instead. bool _condition3(double s, bool flag, double b, double c, double d) => !flag && ((s - b).abs() >= ((c - d).abs() / 2)); + /// Checks if the convergence is too slow when using inverse quadratic + /// interpolation (flag is true). + /// + /// Returns `true` if `b` and `c` are very close, indicating that bisection + /// should be used instead. bool _condition4(bool flag, double b, double c) => flag && ((b - c).abs() <= tolerance.abs()); + /// Checks if the convergence is too slow when using secant method. + /// + /// Returns `true` if `c` and `d` are very close, indicating that bisection + /// should be used instead. bool _condition5(bool flag, double c, double d) => !flag && ((c - d).abs() <= tolerance.abs()); @@ -81,7 +110,10 @@ final class Brent extends NonLinear { // Making sure that the root is in the given interval if (evalA * evalB >= 0) { - throw const NonlinearException('The root is not bracketed.'); + throw NonlinearException( + 'The root is not bracketed in [$a, $b]. ' + 'f(a) and f(b) must have opposite signs.', + ); } // Variables setup @@ -131,17 +163,27 @@ final class Brent extends NonLinear { guesses.add(s); // Generating new brackets for the next iteration - final fs = evaluateOn(s); + final fs = evaluateOn(s).toDouble(); valueD = valueC; valueC = valueB; + // Update the bracket containing the root + double newFa; + double newFb; + if (fa * fs < 0) { valueB = s; + newFa = fa.toDouble(); // valueA unchanged, so fa is still valid + newFb = fs; // valueB is now s, so fs is the new fb } else { valueA = s; + newFa = fs; // valueA is now s, so fs is the new fa + newFb = fb.toDouble(); // valueB unchanged, so fb is still valid } - if (fa.abs() < fb.abs()) { + // Ensure valueA always has the larger function value in absolute terms + // This helps maintain numerical stability + if (newFa.abs() < newFb.abs()) { final temp = valueA; valueA = valueB; valueB = temp; diff --git a/lib/src/nonlinear/types/chords.dart b/lib/src/nonlinear/types/chords.dart index 72acdc9f..3db69211 100644 --- a/lib/src/nonlinear/types/chords.dart +++ b/lib/src/nonlinear/types/chords.dart @@ -1,14 +1,14 @@ import 'package:equations/equations.dart'; +/// {@template chords} /// Implements the 'chords' method to find the roots of a given equation. /// -/// **Characteristics**: -/// /// - The method is guaranteed to converge to a root of `f(x)` if `f(x)` is a /// continuous function on the interval `[a, b]`. /// /// - The values of `f(a)` and `f(b)` must have opposite signs AND there must /// be at least one root in `[a, b]`. These are 2 required conditions. +/// {@endtemplate} final class Chords extends NonLinear { /// The starting point of the interval. final double a; @@ -16,20 +16,13 @@ final class Chords extends NonLinear { /// The ending point of the interval. final double b; - /// Creates a [Chords] object to find the root of an equation by using the - /// chords method. - /// - /// - [function]: the function f(x); - /// - [a]: the first interval in which evaluate `f(a)`; - /// - [b]: the second interval in which evaluate `f(b)`; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro chords} const Chords({ required super.function, required this.a, required this.b, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -58,10 +51,29 @@ final class Chords extends NonLinear { final guesses = []; var n = 1; - var x0 = (a * evaluateOn(b) - b * evaluateOn(a)) / - (evaluateOn(b) - evaluateOn(a)); + final evalA = evaluateOn(a); + final evalB = evaluateOn(b); + + if (evalA * evalB >= 0) { + throw NonlinearException( + 'The root is not bracketed in [$a, $b]. ' + 'f(a) and f(b) must have opposite signs.', + ); + } + + var x0 = (a * evalB - b * evalA) / (evalB - evalA); var diff = evaluateOn(x0).abs(); + // If the initial guess already satisfies the tolerance, add it and return + if (diff < tolerance) { + guesses.add(x0); + return ( + guesses: guesses, + convergence: convergence(guesses, maxSteps), + efficiency: efficiency(guesses, maxSteps), + ); + } + while ((diff >= tolerance) && (n <= maxSteps)) { final fa = evaluateOn(a); final fx = evaluateOn(x0); @@ -74,7 +86,7 @@ final class Chords extends NonLinear { } guesses.add(x0); - diff = fx.abs(); + diff = evaluateOn(x0).abs(); ++n; } diff --git a/lib/src/nonlinear/types/newton.dart b/lib/src/nonlinear/types/newton.dart index e5924a67..1840628d 100644 --- a/lib/src/nonlinear/types/newton.dart +++ b/lib/src/nonlinear/types/newton.dart @@ -1,26 +1,30 @@ import 'package:equations/equations.dart'; -/// Implements Newton's method to find the roots of a given equation. +/// {@template newton} +/// Implements Newton's method (also known as the Newton-Raphson method) to find +/// the roots of a given equation. /// -/// **Characteristics**: +/// - The method has quadratic convergence rate when it converges, making it +/// one of the fastest root-finding algorithms. /// /// - The method is extremely powerful but it's not guaranteed to converge to -/// a root of `f(x)`. +/// a root of `f(x)`. Convergence depends on the choice of the initial guess +/// and the behavior of the function and its derivative. /// -/// - The algorithm may fail for example due to a division by zero, if the -/// derivative evaluated at a certain value is 0, or because the initial guess -/// is too far from the solution. +/// - The algorithm requires the derivative `f'(x)` to be computable and +/// non-zero near the root. The method may fail if: +/// - The derivative evaluated at a certain value is 0 or NaN +/// - The initial guess is too far from the solution +/// - The function has multiple roots or oscillates +/// +/// - Newton's method uses the iterative formula: +/// `x_{n+1} = x_n - f(x_n) / f'(x_n)` +/// {@endtemplate} final class Newton extends NonLinear { /// The initial guess x0. final double x0; - /// Creates a [Newton] object object to find the root of an equation using - /// Newton's method. - /// - /// - [function]: the function f(x); - /// - [x0]: the initial guess x0; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro newton} const Newton({ required super.function, required this.x0, @@ -59,7 +63,10 @@ final class Newton extends NonLinear { final der = evaluateDerivativeOn(currx0); if ((der == 0) || (der.isNaN)) { - throw NonlinearException("Couldn't evaluate f'($currx0)"); + throw NonlinearException( + "Couldn't evaluate f'($currx0). " + 'The derivative is ${der.isNaN ? "NaN" : "zero"}', + ); } diff = -evaluateOn(currx0) / der; diff --git a/lib/src/nonlinear/types/regula_falsi.dart b/lib/src/nonlinear/types/regula_falsi.dart index 78cbf9d3..02e9da6f 100644 --- a/lib/src/nonlinear/types/regula_falsi.dart +++ b/lib/src/nonlinear/types/regula_falsi.dart @@ -1,16 +1,32 @@ import 'package:equations/equations.dart'; -/// Implements the regula falsi method (also known as "_false position method_") -/// to find the roots of a given equation. +/// {@template regula_falsi} +/// Implements the regula falsi method (also known as the "_false position +/// method_") to find the roots of a given equation. /// -/// **Characteristics**: +/// - The method is guaranteed to converge to a root of `f(x)` if `f(x)` is a +/// continuous function on the interval `[a, b]`. /// -/// - The method requires the root to be bracketed between two points `a` and -/// `b` otherwise it won't work. +/// - The values of `f(a)` and `f(b)` must have opposite signs (i.e., +/// `f(a) * f(b) < 0`), which ensures that at least one root exists in the +/// interval by the Intermediate Value Theorem. /// -/// - If you cannot assume that a function may be interpolated by a linear -/// function, then applying this method method could result in worse results -/// than the bisection method. +/// - The method has linear convergence rate, similar to bisection, but +/// typically converges faster when the function is well-approximated by a +/// linear function near the root. +/// +/// - If the function cannot be well-approximated by a linear function, the +/// method may converge slower than bisection, especially when one endpoint +/// of the interval remains fixed for many iterations. +/// +/// - The algorithm uses the formula: +/// `c = (f(a) * b - f(b) * a) / (f(a) - f(b))` +/// which finds the intersection of the line through `(a, f(a))` and +/// `(b, f(b))` with the x-axis. +/// +/// - The interval is repeatedly narrowed by replacing one endpoint with the +/// computed intersection point, maintaining the bracketing condition. +/// {@endtemplate} final class RegulaFalsi extends NonLinear { /// The starting point of the interval. final double a; @@ -18,20 +34,13 @@ final class RegulaFalsi extends NonLinear { /// The ending point of the interval. final double b; - /// Creates a [RegulaFalsi] object to find the root of an equation by using - /// the regula falsi method. - /// - /// - [function]: the function f(x); - /// - [a]: the first interval in which evaluate `f(a)`; - /// - [b]: the second interval in which evaluate `f(b)`; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro regula_falsi} const RegulaFalsi({ required super.function, required this.a, required this.b, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -57,43 +66,79 @@ final class RegulaFalsi extends NonLinear { @override ({List guesses, double convergence, double efficiency}) solve() { - // Exit immediately if the root is not bracketed - if (evaluateOn(a) * evaluateOn(b) >= 0) { - throw NonlinearException('The root is not bracketed in [$a, $b]'); + // Validate that the root is bracketed in the interval + final evalA = evaluateOn(a); + final evalB = evaluateOn(b); + + if (evalA * evalB > 0) { + throw NonlinearException( + 'The root is not bracketed in [$a, $b]. ' + 'f(a) and f(b) must have opposite signs.', + ); + } + + // Check if we've already found the root at one of the initial points + if (evalA == 0) { + return ( + guesses: [a], + convergence: convergence([a], maxSteps), + efficiency: efficiency([a], maxSteps), + ); + } + if (evalB == 0) { + return ( + guesses: [b], + convergence: convergence([b], maxSteps), + efficiency: efficiency([b], maxSteps), + ); } final guesses = []; - var toleranceCheck = true; var n = 1; + var intervalA = a; + var intervalB = b; + var fa = evalA; - var tempA = a; - var tempB = b; + while (n <= maxSteps) { + // Evaluate function at the current interval endpoints + final fb = evaluateOn(intervalB); - while (toleranceCheck && (n <= maxSteps)) { - // Evaluating on A and B the function - final fa = evaluateOn(tempA); - final fb = evaluateOn(tempB); - - // Computing the guess - final c = (fa * tempB - fb * tempA) / (fa - fb); + // Compute the intersection point using the regula falsi formula: + // c = (f(a) * b - f(b) * a) / (f(a) - f(b)) + final c = (fa * intervalB - fb * intervalA) / (fa - fb); final fc = evaluateOn(c); - // Making sure the evaluation is not zero + // Check for invalid function values + if (fc.isNaN || fc.isInfinite) { + throw NonlinearException( + 'Function evaluation resulted in invalid value at iteration $n. ' + 'f($c) = $fc. The function may not be well-defined at this point.', + ); + } + + // Add the guess to the list + guesses.add(c); + + // Check if we've found the exact root if (fc == 0) { break; } - // Shrink the interval + // Check if we've reached the desired tolerance + if (fc.abs() <= tolerance) { + break; + } + + // Shrink the interval while maintaining the bracketing condition if (fa * fc < 0) { - tempB = c; + // Root is in [intervalA, c] + intervalB = c; } else { - tempA = c; + // Root is in [c, intervalB] + intervalA = c; + fa = fc; } - // Add the root to the list - guesses.add(c); - - toleranceCheck = fc.abs() > tolerance; ++n; } diff --git a/lib/src/nonlinear/types/riddler.dart b/lib/src/nonlinear/types/riddler.dart index e36a4211..bff83c17 100644 --- a/lib/src/nonlinear/types/riddler.dart +++ b/lib/src/nonlinear/types/riddler.dart @@ -2,15 +2,30 @@ import 'dart:math'; import 'package:equations/equations.dart'; -/// Implements the Riddler's method to find the roots of a given equation. +/// {@template riddler} +/// Implements Riddler's method (also known as the Ridders' method) to find the +/// roots of a given equation. /// -/// **Characteristics**: +/// Uses exponential interpolation to find the root. It's a modification of the +/// false position method that improves convergence. /// /// - The method requires the root to be bracketed between two points `a` and -/// `b` otherwise it won't work. +/// `b` (i.e., `f(a) * f(b) < 0`), otherwise it won't work. /// -/// - The rate of convergence is `sqrt(2)` and the convergence is guaranteed -/// for not well-behaved functions. +/// - The rate of convergence is approximately `sqrt(2)` (superlinear), which +/// is faster than bisection but slower than Newton's method. +/// +/// - The convergence is guaranteed for continuous functions when the root is +/// properly bracketed, making it more reliable than methods like Newton's +/// method for ill-behaved functions. +/// +/// - The algorithm uses the formula: +/// `x = x2 + (x2 - x0) * sign(y0 - y1) * y2 / sqrt(y2^2 - y0 * y1)` +/// where `x2` is the midpoint and `y0`, `y1`, `y2` are function values. +/// +/// - The method may fail if the expression under the square root becomes +/// negative or zero, in which case the algorithm falls back to bisection. +/// {@endtemplate} final class Riddler extends NonLinear { /// The starting point of the interval. final double a; @@ -18,20 +33,13 @@ final class Riddler extends NonLinear { /// The ending point of the interval. final double b; - /// Creates a [Riddler] object to find the root of an equation using Riddler's - /// method. - /// - /// - [function]: the function f(x); - /// - [a]: the first interval in which evaluate `f(a)`; - /// - [b]: the second interval in which evaluate `f(b)`; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro riddler} const Riddler({ required super.function, required this.a, required this.b, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -57,9 +65,15 @@ final class Riddler extends NonLinear { @override ({List guesses, double convergence, double efficiency}) solve() { - // Exit immediately if the root is not bracketed - if (evaluateOn(a) * evaluateOn(b) >= 0) { - throw NonlinearException('The root is not bracketed in [$a, $b]'); + // Validate that the root is bracketed in the interval + final evalA = evaluateOn(a); + final evalB = evaluateOn(b); + + if (evalA * evalB >= 0) { + throw NonlinearException( + 'The root is not bracketed in [$a, $b]. ' + 'f(a) and f(b) must have opposite signs.', + ); } final guesses = []; @@ -67,40 +81,78 @@ final class Riddler extends NonLinear { var x0 = a; var x1 = b; - var y0 = evaluateOn(x0); - var y1 = evaluateOn(x1); + var y0 = evalA.toDouble(); + var y1 = evalB.toDouble(); while (n <= maxSteps) { + // Calculate the midpoint final x2 = (x0 + x1) / 2; - final y2 = evaluateOn(x2); + final y2 = evaluateOn(x2).toDouble(); + + // Check if we've found the exact root at the midpoint + if (y2 == 0) { + guesses.add(x2); + break; + } + + // Check for invalid function values + if (y2.isNaN || y2.isInfinite) { + throw NonlinearException( + "Couldn't evaluate f($x2). " + 'The function value is ${y2.isNaN ? "NaN" : "infinite"}.', + ); + } + + // Compute the expression under the square root: y2^2 - y0 * y1 + final discriminant = y2 * y2 - y0 * y1; + + // Use Riddler's formula if the discriminant is positive and non-zero + // Otherwise, fall back to bisection for numerical stability + double x; + if (discriminant > 0) { + final sqrtDiscriminant = sqrt(discriminant); + if (sqrtDiscriminant == 0) { + // Fall back to bisection + x = x2; + } else { + // x = x2 + (x2 - x0) * sign(y0 - y1) * y2 / sqrt(y2^2 - y0 * y1) + x = x2 + (x2 - x0) * (y0 - y1).sign * y2 / sqrtDiscriminant; + } + } else { + // Discriminant is negative or zero, fall back to bisection + x = x2; + } - // The guess on the n-th iteration - final x = x2 + (x2 - x0) * (y0 - y1).sign * y2 / sqrt(y2 * y2 - y0 * y1); + // Ensure the new guess is within the current interval + // If it's outside, clamp it to the interval bounds + if (x < x0 || x > x1) { + x = x2; // Use midpoint if the formula gives an invalid result + } - // Add the root to the list + // Check convergence: either the interval is small enough or the function + // value is close to zero + final y = evaluateOn(x).toDouble(); guesses.add(x); - // Tolerance - if (min((x - x0).abs(), (x - x1).abs()) < tolerance) { + if (y.abs() < tolerance || (x1 - x0).abs() < tolerance) { break; } - final y = evaluateOn(x); + // Early exit if we've found the exact root + if (y == 0) { + break; + } - // Fixing signs + // Update the interval based on the sign of the function values + // The root must be between points with opposite signs if (y2.sign != y.sign) { x0 = x2; y0 = y2; x1 = x; y1 = y; } else { - if (y1.sign != y.sign) { - x0 = x; - y0 = y; - } else { - x1 = x; - y1 = y; - } + x0 = x; + y0 = y; } ++n; diff --git a/lib/src/nonlinear/types/secant.dart b/lib/src/nonlinear/types/secant.dart index 029f1f57..631c46bf 100644 --- a/lib/src/nonlinear/types/secant.dart +++ b/lib/src/nonlinear/types/secant.dart @@ -1,34 +1,46 @@ import 'package:equations/equations.dart'; -/// Implements the secant method to find the roots of a given equation. +/// {@template secant} +/// Implements the secant method to find the roots of a given equation. It is +/// similar to [Newton]'s method but does not require the computation of +/// derivatives. /// -/// **Characteristics**: +/// - The method has superlinear convergence rate (approximately 1.618, the +/// golden ratio) when it converges, making it faster than linear methods like +/// bisection but slower than quadratic methods like Newton's method. /// -/// - The method is not guaranteed to converge to a root of _f(x)_. +/// - Unlike [Newton]'s method, the secant method does **not** require the +/// derivative `f'(x)` of the function, making it useful when derivatives are +/// difficult or expensive to compute. /// -/// - The secant method does not require the root to remain bracketed, like -/// the bisection method does for example, so it doesn't always converge. +/// - The method is not guaranteed to converge to a root of `f(x)`. The secant +/// method does not require the root to remain bracketed (unlike bisection or +/// regula falsi), so convergence depends on the choice of initial guesses and +/// the behavior of the function. The method may fail if: +/// - The two initial guesses `a` and `b` are too far from the solution +/// - The function has multiple roots or oscillates +/// - The denominator `f(b) - f(a)` becomes zero, causing division by zero +/// - The function values become infinite or NaN +/// +/// - The secant method uses the iterative formula: +/// `x_{n+1} = x_n - f(x_n) * (x_n - x_{n-1}) / (f(x_n) - f(x_{n-1}))` +/// which approximates Newton's method by replacing the derivative with a +/// finite difference quotient. +/// {@endtemplate} final class Secant extends NonLinear { - /// The first guess. + /// The first initial guess x0. final double a; - /// The second guess. + /// The second initial guess x1. final double b; - /// Creates a [Secant] object to find the root of an equation by using the - /// secant method. Ideally, the two guesses should be close to the root. - /// - /// - [function]: the function f(x); - /// - [a]: the first interval in which evaluate _f(a)_; - /// - [b]: the second interval in which evaluate _f(b)_; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro secant} const Secant({ required super.function, required this.a, required this.b, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -54,36 +66,74 @@ final class Secant extends NonLinear { @override ({List guesses, double convergence, double efficiency}) solve() { + // Check if initial guesses are identical + if (a == b) { + throw NonlinearException( + 'The two initial guesses must be different. ' + 'Both a and b are equal to $a.', + ); + } + final guesses = []; var n = 1; - var xold = a; - var x0 = b; + // Initialize with the two initial guesses + var xPrev = a; + var xCurr = b; + + var fPrev = evaluateOn(xPrev); + var fCurr = evaluateOn(xCurr); + + // Check if we've already found the root at one of the initial guesses + if (fPrev == 0) { + guesses.add(xPrev); + return ( + guesses: guesses, + convergence: convergence(guesses, maxSteps), + efficiency: efficiency(guesses, maxSteps), + ); + } + if (fCurr == 0) { + guesses.add(xCurr); + return ( + guesses: guesses, + convergence: convergence(guesses, maxSteps), + efficiency: efficiency(guesses, maxSteps), + ); + } - var fold = evaluateOn(xold); - var fnew = evaluateOn(x0); var diff = tolerance + 1; while ((diff >= tolerance) && (n <= maxSteps)) { - final den = fnew - fold; + // Compute the denominator: f(x_curr) - f(x_prev) + final denominator = fCurr - fPrev; - if ((den == 0) || (den.isNaN)) { + // Check for invalid denominator values + if (denominator == 0 || denominator.isNaN || denominator.isInfinite) { throw NonlinearException( - 'Invalid denominator encountered. ' - 'The invalid value for the denominator was $den', + 'Invalid denominator encountered at iteration $n. ' + 'The denominator f($xCurr) - f($xPrev) = $denominator. ', ); } - diff = -(fnew * (x0 - xold)) / den; - xold = x0; - fold = fnew; - x0 += diff; + // x_{n+1} = x_n - f(x_n) * (x_n - x_{n-1}) / (f(x_n) - f(x_{n-1})) + diff = -(fCurr * (xCurr - xPrev)) / denominator; + + // Update for next iteration + xPrev = xCurr; + fPrev = fCurr; + xCurr += diff; diff = diff.abs(); ++n; - guesses.add(x0); - fnew = evaluateOn(x0); + guesses.add(xCurr); + fCurr = evaluateOn(xCurr); + + // Early exit if we've found the exact root + if (fCurr == 0) { + break; + } } return ( diff --git a/lib/src/nonlinear/types/steffensen.dart b/lib/src/nonlinear/types/steffensen.dart index 1dc6185f..5a941528 100644 --- a/lib/src/nonlinear/types/steffensen.dart +++ b/lib/src/nonlinear/types/steffensen.dart @@ -1,32 +1,37 @@ import 'package:equations/equations.dart'; -/// Implements Seffensen's method to find the roots of a given equation. +/// {@template steffensen} +/// Implements Steffensen's method to find the roots of a given equation. /// -/// **Characteristics**: +/// - The method has quadratic convergence rate when it converges, similar to +/// [Newton]'s method, making it one of the fastest root-finding algorithms. /// -/// - Similar to [Newton] as they use the same approach and both have a -/// quadratic convergence. +/// - This method does **not** require the derivative _f'(x)_ of the function. +/// Instead, it approximates the derivative using the formula: +/// _g(x) = `[f(x + f(x)) - f(x)]` / f(x) = f(x + f(x))/f(x) - 1_ /// -/// - This method does **not** use the derivative _f'(x)_ of the function. +/// - The method is extremely powerful but it's not guaranteed to converge to +/// a root of `f(x)`. Convergence depends on the choice of the initial guess +/// and the behavior of the function. The method may fail if: +/// - The initial guess `x0` is too far from the solution +/// - The function value `f(x)` is very small, causing numerical instability +/// - The approximated derivative `g(x)` becomes zero, infinite, or NaN +/// - The function has multiple roots or oscillates /// -/// - If _x0_ is too far from the root, the method might fail so the -/// convergence is not guaranteed. +/// - Steffensen's method uses the iterative formula: +/// `x_{n+1} = x_n - f(x_n) / g(x_n)` +/// where `g(x_n) = f(x_n + f(x_n))/f(x_n) - 1` approximates the derivative. +/// {@endtemplate} final class Steffensen extends NonLinear { /// The initial guess x0. final double x0; - /// Creates a [Steffensen] object to find the root of an equation by using - /// Steffensen's method. - /// - /// - [function]: the function f(x); - /// - [x0]: the initial guess x0; - /// - [tolerance]: how accurate the algorithm has to be; - /// - [maxSteps]: how many iterations at most the algorithm has to do. + /// {@macro steffensen} const Steffensen({ required super.function, required this.x0, super.tolerance = 1.0e-10, - super.maxSteps = 15, + super.maxSteps = 30, }); @override @@ -56,14 +61,38 @@ final class Steffensen extends NonLinear { var x = x0; final guesses = []; - while ((diff >= tolerance) && (n < maxSteps)) { + while ((diff >= tolerance) && (n <= maxSteps)) { final fx = evaluateOn(x); + + // If we've found the exact root, we're done + if (fx == 0) { + guesses.add(x); + break; + } + + // Check for division by zero when computing gx + if (fx.isNaN || fx.isInfinite) { + throw NonlinearException( + "Couldn't evaluate f($x). " + 'The function value is ${fx.isNaN ? "NaN" : "infinite"}.', + ); + } + final gx = (evaluateOn(x + fx) / fx) - 1; - x = x - fx / gx; + // Check for division by zero or invalid values when using gx + if ((gx == 0) || (gx.isNaN) || (gx.isInfinite)) { + throw NonlinearException( + "Couldn't compute the next iteration at x = $x. " + 'The value g(x) is not well defined', + ); + } + + final delta = fx / gx; + x -= delta; guesses.add(x); - diff = (-fx / gx).abs(); + diff = delta.abs(); ++n; } diff --git a/lib/src/system/system.dart b/lib/src/system/system.dart index 7bd98e25..1070de0e 100644 --- a/lib/src/system/system.dart +++ b/lib/src/system/system.dart @@ -1,5 +1,6 @@ import 'package:equations/equations.dart'; +/// {@template system_solver} /// An abstract class that represents a system of equations, which can be solved /// using various algorithms that manipulate the data of a matrix and a vector. /// @@ -11,25 +12,67 @@ import 'package:equations/equations.dart'; /// known as `b`. From this, we get an equation in the form `Ax = b`. /// /// The method [solve] returns the `x` vector of the `Ax = b` equation. +/// +/// ## Available Solvers +/// +/// - [GaussianElimination]: Direct method using row reduction; +/// - [LUSolver]: Direct method using LU decomposition; +/// - [CholeskySolver]: Direct method for symmetric positive-definite matrices; +/// - [JacobiSolver]: Iterative method for diagonally dominant systems +/// - [GaussSeidelSolver]: Iterative method, faster than Jacobi; +/// - [SORSolver]: Iterative method with relaxation factor. +/// +/// ## Recommendations +/// +/// - General-purpose solvers: Use [GaussianElimination] or [LUSolver] +/// - For symmetric positive-definite matrices: Use [CholeskySolver] (fastest) +/// - For large sparse systems: Use iterative methods ([JacobiSolver], +/// [GaussSeidelSolver], or [SORSolver]) +/// - For multiple systems with same matrix: Use [LUSolver] +/// {@endtemplate} +/// +/// {@template systems_constructor_intro} +/// Given an equation in the form `Ax = b`, `A` is a square matrix containing +/// `n` equations in `n` unknowns and `b` is the vector of the known values. +/// This class can only be built with square matrices. +/// {@endtemplate} abstract base class SystemSolver { /// The equations to be solved. + /// + /// This is the coefficient matrix `A` in the equation `Ax = b`. It must be + /// a square matrix (same number of rows and columns). final RealMatrix matrix; /// The vector containing the known values of the equations. + /// + /// This is the vector `b` in the equation `Ax = b`. The length of this vector + /// must match the number of rows (or columns) of the [matrix]. final List knownValues; /// The algorithm accuracy. + /// + /// This value determines the precision required for convergence in iterative + /// methods, or the tolerance used for numerical checks in direct methods. + /// Defaults to `1.0e-10`. + /// + /// For iterative solvers, the algorithm stops when the change between + /// iterations is less than this value. For direct solvers, this value is used + /// to detect singular or near-singular matrices. final double precision; - /// Given an equation in the form `Ax = b`, `A` is a square matrix containing - /// `n` equations in `n` unknowns and `b` is the vector of the known values. - /// This class can only be built with square matrices. In particular: + /// {@macro system_solver} + /// + /// {@macro systems_constructor_intro} /// - /// - [matrix] is the matrix with the equations; - /// - [knownValues] is the vector with the known values. + /// Parameters: + /// - [matrix] is the matrix with the equations (must be square); + /// - [knownValues] is the vector with the known values (must match matrix + /// size); + /// - [precision] is the algorithm accuracy (defaults to `1.0e-10`). /// - /// An exception of type [SystemSolverException] is thrown if the matrix is - /// not square. + /// Throws a [SystemSolverException] if: + /// - The matrix is not square, or + /// - The [knownValues] vector length doesn't match the matrix size. SystemSolver({ required this.matrix, required this.knownValues, @@ -56,25 +99,16 @@ abstract base class SystemSolver { } if (other is SystemSolver) { - // The lengths of the coefficients must match. if (knownValues.length != other.knownValues.length) { return false; } - - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the - // coefficients list. - var equalsCount = 0; - for (var i = 0; i < knownValues.length; ++i) { - if (knownValues[i] == other.knownValues[i]) { - ++equalsCount; + if (knownValues[i] != other.knownValues[i]) { + return false; } } - // They must have the same runtime type AND all items must be equal. return runtimeType == other.runtimeType && - equalsCount == knownValues.length && matrix == other.matrix && precision == other.precision; } else { @@ -83,13 +117,21 @@ abstract base class SystemSolver { } @override - int get hashCode => Object.hashAll([matrix, precision, ...knownValues]); + int get hashCode => + Object.hash(matrix, precision, Object.hashAll(knownValues)); @override String toString() => matrix.toString(); - /// Prints the **augmented matrix** of this instance, which is the equations - /// matrix plus the known values vector to the right. For example, if... + /// Returns a string representation of the **augmented matrix** of this + /// system. + /// + /// The augmented matrix combines the coefficient matrix `A` with the known + /// values vector `b` into a single matrix representation, separated by a + /// vertical bar `|`. This format is commonly used in linear algebra to + /// represent systems of equations. + /// + /// For example, if the system is: /// /// ```txt /// A = [1, 2] @@ -98,13 +140,16 @@ abstract base class SystemSolver { /// [6] /// ``` /// - /// ... then the `Ax = b` system represented by this instance is printed in - /// the following way: + /// Then the augmented matrix representation is: /// /// ```txt /// [1, 2 | 3] /// [4, 5 | 6] /// ``` + /// + /// This represents the system of equations: + /// - `1x + 2y = 3` + /// - `4x + 5y = 6` String toStringAugmented() { final buffer = StringBuffer(); @@ -143,59 +188,83 @@ abstract base class SystemSolver { /// Computes whether the system can be solved or not. /// /// A system can be solved (meaning that it has exactly ONE solution) if the - /// determinant it not zero. + /// determinant is not zero. If the determinant is zero, the matrix is + /// singular and the system either has no solution or infinitely many + /// solutions. + /// + /// Returns `true` if the system has a unique solution, `false` otherwise. + /// + /// Note: Some solvers (like [GaussianElimination] and [LUSolver]) will throw + /// a [SystemSolverException] if the system has no solution when [solve] is + /// called, even if this method returns `false`. bool hasSolution() => matrix.determinant() != 0; - /// Back substitution is an iterative process that solves equation matrices - /// in the form `Ux = b`, where `U` is an upper triangular matrix. - /// - /// In this case, [source] represents `U` and [vector] represents `b`. - static List backSubstitution( - List> source, - List vector, - ) { - final size = vector.length; - final solutions = List.generate(size, (_) => 0, growable: false); - - for (var i = size - 1; i >= 0; --i) { - solutions[i] = vector[i]; - for (var j = i + 1; j < size; ++j) { - solutions[i] = solutions[i] - source[i][j] * solutions[j]; - } - solutions[i] = solutions[i] / source[i][i]; - } - - return solutions; - } - - /// Forward substitution is an iterative process that solves equation matrices - /// in the form `Lx = b`, where `L` is a lower triangular matrix. - /// - /// In this case, [source] represents `L` and [vector] represents `b`. - static List forwardSubstitution( - List> source, - List vector, - ) { - final size = vector.length; - final solutions = List.generate(size, (_) => 0, growable: false); - - for (var i = 0; i < size; ++i) { - solutions[i] = vector[i]; - for (var j = 0; j < i; ++j) { - solutions[i] = solutions[i] - source[i][j] * solutions[j]; - } - solutions[i] = solutions[i] / source[i][i]; - } - - return solutions; - } - /// The dimension of the system (N equations in N unknowns). + /// + /// This is the number of equations (and unknowns) in the system. For a system + /// with `n` equations in `n` unknowns, this returns `n`. int get size => knownValues.length; /// Computes the determinant of the associated matrix. + /// + /// The determinant is a scalar value that can be computed from the elements + /// of a square matrix. It provides important information about the matrix: + /// + /// - If the determinant is zero, the matrix is singular (not invertible) + /// - If the determinant is non-zero, the matrix is non-singular (invertible) + /// + /// A non-zero determinant indicates that the system `Ax = b` has a unique + /// solution. Use [hasSolution] to check if the system can be solved. double determinant() => matrix.determinant(); /// Solves the `Ax = b` equation and returns the `x` vector. + /// + /// This method uses the specific algorithm implemented by the concrete solver + /// class to find the solution vector `x` that satisfies the equation + /// `Ax = b`. + /// + /// Returns a list of [double] values representing the solution vector `x`. + /// + /// Throws a [SystemSolverException] if: + /// - The system has no solution (singular matrix), or + /// - The algorithm fails to converge (for iterative methods), or + /// - Numerical instability is detected during computation. + /// + /// Example: + /// ```dart + /// final solver = GaussianElimination( + /// matrix: RealMatrix.fromData( + /// rows: 2, + /// columns: 2, + /// data: [[2, 1], [1, 3]], + /// ), + /// knownValues: [5, 7], + /// ); + /// + /// final solution = solver.solve(); + /// // Returns: [1.6, 1.8] (approximately) + /// ``` List solve(); + + /// Checks if the matrix is diagonally dominant. + /// + /// A matrix A is diagonally dominant if for each row i: + /// |a_{ii}| ≥ Σ_{j≠i} |a_{ij}| + static bool isDiagonallyDominant(RealMatrix matrix) { + for (var i = 0; i < matrix.rowCount; ++i) { + var rowSum = 0.0; + final diagonalElement = matrix(i, i).abs(); + + for (var j = 0; j < matrix.columnCount; ++j) { + if (i != j) { + rowSum += matrix(i, j).abs(); + } + } + + if (diagonalElement < rowSum) { + return false; + } + } + return true; + } } diff --git a/lib/src/system/types/cholesky.dart b/lib/src/system/types/cholesky.dart index 101aea65..aaf2be07 100644 --- a/lib/src/system/types/cholesky.dart +++ b/lib/src/system/types/cholesky.dart @@ -1,26 +1,81 @@ import 'package:equations/equations.dart'; -import 'package:equations/src/system/system.dart'; +import 'package:equations/src/system/utils/matrix_utils.dart'; -/// Implementation of the "Cholesky decomposition" algorithm for solving a -/// system of linear equations. It only works with square, Hermitian, -/// positive-definite matrices. -final class CholeskySolver extends SystemSolver { - /// {@template systems_constructor_intro} - /// Given an equation in the form `Ax = b`, `A` is a square matrix containing - /// `n` equations in `n` unknowns and `b` is the vector of the known values. - /// {@endtemplate} +/// {@template cholesky_solver} +/// Solves a system of linear equations using the Cholesky decomposition method. +/// +/// The Cholesky decomposition factors a symmetric positive-definite matrix `A` +/// into the product of a lower triangular matrix `L` and its transpose: +/// `A = LL^T`. This allows the system `Ax = b` to be solved in two steps: +/// +/// 1. **Forward substitution**: Solve `Ly = b` for `y` +/// 2. **Back substitution**: Solve `L^T x = y` for `x` +/// +/// Cholesky decomposition is particularly useful when: +/// +/// - The matrix `A` is symmetric and positive-definite +/// - You need the fastest direct method (approximately twice as fast as LU) +/// - The matrix comes from a covariance matrix, normal equations, or similar +/// applications that naturally produce positive-definite matrices +/// +/// ## Requirements +/// +/// The input matrix must be: +/// - Square (n×n) +/// - Symmetric (A = A^T) +/// - Positive-definite (all eigenvalues > 0, or equivalently, x^T A x > 0 for +/// all x ≠ 0) +/// +/// If the matrix is not positive-definite, a [SystemSolverException] will be +/// thrown during decomposition. +/// +/// ## Performance +/// +/// When applicable, the Cholesky decomposition is almost twice as efficient as +/// the LU decomposition for solving linear systems, making it the preferred +/// method for symmetric positive-definite matrices. +/// +/// ## Example +/// +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 3, +/// columns: 3, +/// data: [ +/// [4, 12, -16], +/// [12, 37, -43], +/// [-16, -43, 98], +/// ], +/// ); // Symmetric positive-definite matrix +/// +/// final solver = CholeskySolver( +/// matrix: matrix, +/// knownValues: [1, 2, 3], +/// ); +/// +/// final solution = solver.solve(); +/// ``` +/// {@endtemplate} +final class CholeskySolver extends SystemSolver with RealMatrixUtils { + /// {@macro systems_constructor_intro} /// - /// - [matrix] is the matrix containing the equations; - /// - [knownValues] is the vector with the known values; - /// - the matrix must be Hermitian and positive-definite. + /// {@macro cholesky_solver} /// - /// Note that, when applicable, the Cholesky decomposition is almost twice as - /// efficient as the LU decomposition when it comes to linear systems solving. + /// Parameters: + /// - [matrix] is the matrix containing the equations (must be symmetric + /// positive-definite); + /// - [knownValues] is the vector with the known values; + /// - [precision] determines the tolerance for numerical checks (defaults + /// to `1.0e-10`). + /// + /// Throws a [SystemSolverException] if: + /// - The matrix is not square, or + /// - The matrix is not symmetric positive-definite. CholeskySolver({ required super.matrix, required super.knownValues, super.precision, - }) : super(); + }); @override List solve() { @@ -29,11 +84,11 @@ final class CholeskySolver extends SystemSolver { // Solving Ly = b final L = cholesky.first.toListOfList(); final b = knownValues; - final y = SystemSolver.forwardSubstitution(L, b); + final y = forwardSubstitution(L, b); - // Solving Ux = y + // Solving L^T x = y (where L^T is the transpose of L) final transposedL = cholesky[1].toListOfList(); - return SystemSolver.backSubstitution(transposedL, y); + return backSubstitution(transposedL, y); } } diff --git a/lib/src/system/types/gauss.dart b/lib/src/system/types/gauss.dart index 153a08ce..7ba60e4c 100644 --- a/lib/src/system/types/gauss.dart +++ b/lib/src/system/types/gauss.dart @@ -1,16 +1,72 @@ import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix_utils.dart'; -/// Implementation of the "Gaussian elimination" algorithm, also known as "row -/// reduction", for solving a system of linear equations. This method only works -/// with square matrices. -final class GaussianElimination extends SystemSolver { +/// {@template gaussian_elimination} +/// Solves a system of linear equations using the Gaussian elimination +/// algorithm, also known as row reduction. +/// +/// Gaussian elimination is a direct method that transforms the system `Ax = b` +/// into an upper triangular form through a series of row operations, then +/// solves the system using back substitution. This implementation uses +/// partial pivoting to improve numerical stability by selecting the largest +/// pivot element in each column. +/// +/// ## When to Use +/// +/// Gaussian elimination is a general-purpose solver that works for any +/// non-singular square matrix. It's particularly useful when: +/// +/// - You need a direct method (no iteration required) +/// - The matrix isn't symmetric positive-definite (see[CholeskySolver] instead) +/// - You only need to solve one system (use [LUSolver] for multiple systems) +/// - You want a straightforward, well-understood algorithm +/// +/// ## Performance Optimizations +/// +/// This implementation is optimized for performance with the following +/// improvements: +/// +/// - Uses flattened arrays for better cache locality +/// - Avoids unnecessary matrix copying +/// - Implements early termination for singular matrices +/// - Uses efficient memory access patterns +/// +/// ## Example +/// +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 3, +/// columns: 3, +/// data: [ +/// [2, 1, 1], +/// [4, -6, 0], +/// [-2, 7, 2], +/// ], +/// ); +/// +/// final solver = GaussianElimination( +/// matrix: matrix, +/// knownValues: [5, -2, 9], +/// ); +/// +/// final solution = solver.solve(); +/// // Returns: [1, 1, 2] +/// ``` +/// {@endtemplate} +final class GaussianElimination extends SystemSolver with RealMatrixUtils { /// {@macro systems_constructor_intro} /// - /// - [matrix] is the matrix containing the equations; - /// - [knownValues] is the vector with the known values. + /// {@macro gaussian_elimination} /// - /// This algorithm swaps rows/columns and uses back substitution to solve the - /// system. + /// Parameters: + /// - [matrix] is the matrix containing the equations + /// - [knownValues] is the vector with the known values; + /// - [precision] determines the tolerance for detecting singular matrices + /// (defaults to `1.0e-10`). + /// + /// The algorithm uses partial pivoting to swap rows/columns and back substitution + /// to solve the system. Throws a [SystemSolverException] if the matrix is + /// singular or nearly singular. GaussianElimination({ required super.matrix, required super.knownValues, @@ -20,45 +76,107 @@ final class GaussianElimination extends SystemSolver { @override List solve() { final n = knownValues.length; - final A = matrix.toListOfList(); - final b = knownValues.toList(); - // Swapping rows and pivoting. + // Use flattened arrays for better cache performance + final A = matrix.flattenData.toList(growable: false); + final b = knownValues.toList(growable: false); + + // Row permutation array to track row swaps + final pivot = List.generate(n, (i) => i, growable: false); + + // Forward elimination with partial pivoting for (var p = 0; p < n; ++p) { - // Finding a pivot. - var max = p; + // Find pivot with maximum absolute value in current column + var maxRow = p; + var maxVal = A[p * n + p].abs(); + for (var i = p + 1; i < n; i++) { - if (A[i][p].abs() > A[max][p].abs()) { - max = i; + final val = A[i * n + p].abs(); + if (val > maxVal) { + maxVal = val; + maxRow = i; } } - // Swapping rows. - final temp = A[p]; - A[p] = A[max]; - A[max] = temp; - final t = b[p]; - b[p] = b[max]; - b[max] = t; - - // Making sure the matrix is not singular. - if (A[p][p].abs() <= precision) { + // Early termination if matrix is singular + if (maxVal <= precision) { throw const SystemSolverException( 'The matrix is singular or nearly singular.', ); } - // pivot within A and b. + // Swap rows if necessary + if (maxRow != p) { + // Swap pivot array + final tempPivot = pivot[p]; + pivot[p] = pivot[maxRow]; + pivot[maxRow] = tempPivot; + + // Swap matrix rows + for (var j = 0; j < n; j++) { + final temp = A[p * n + j]; + A[p * n + j] = A[maxRow * n + j]; + A[maxRow * n + j] = temp; + } + + // Swap vector elements + final temp = b[p]; + b[p] = b[maxRow]; + b[maxRow] = temp; + } + + // Cache the pivot element to avoid repeated access + final pivotElement = A[p * n + p]; + + // Eliminate column below pivot for (var i = p + 1; i < n; i++) { - final alpha = A[i][p] / A[p][p]; + final alpha = A[i * n + p] / pivotElement; + + // Early termination if elimination factor is too large (numerical + // instability) + if (alpha.abs() > 1e6) { + throw const SystemSolverException( + 'Numerical instability detected during elimination.', + ); + } + b[i] -= alpha * b[p]; + + // Eliminate elements in current row for (var j = p; j < n; j++) { - A[i][j] -= alpha * A[p][j]; + A[i * n + j] -= alpha * A[p * n + j]; } } } - // Back substitution. - return SystemSolver.backSubstitution(A, b); + // Back substitution using flattened array + return _backSubstitutionOptimized(A, b, n); + } + + /// Optimized back substitution that works with flattened arrays + List _backSubstitutionOptimized( + List A, + List b, + int n, + ) { + final solutions = List.generate(n, (_) => 0, growable: false); + + for (var i = n - 1; i >= 0; --i) { + solutions[i] = b[i]; + for (var j = i + 1; j < n; ++j) { + solutions[i] -= A[i * n + j] * solutions[j]; + } + + // Check for division by zero + if (A[i * n + i].abs() <= precision) { + throw const SystemSolverException( + 'Singular matrix detected during back substitution.', + ); + } + + solutions[i] /= A[i * n + i]; + } + + return solutions; } } diff --git a/lib/src/system/types/gauss_seidel.dart b/lib/src/system/types/gauss_seidel.dart index 7c6dbf64..ffceec08 100644 --- a/lib/src/system/types/gauss_seidel.dart +++ b/lib/src/system/types/gauss_seidel.dart @@ -1,23 +1,73 @@ import 'package:equations/equations.dart'; +/// {@template gauss_seidel_solver} /// Solves a system of linear equations using the Gauss-Seidel iterative method. -/// The given input matrix, representing the system of linear equations, must -/// be square. /// -/// Gauss-Seidel is the same as SOR when `w` = 1. -/// with `w = 1`. +/// The Gauss-Seidel method is an iterative algorithm that solves the system +/// `Ax = b` by iteratively updating each component of the solution vector. It +/// uses the most recently computed values immediately, which typically leads +/// to faster convergence than the Jacobi method. +/// +/// Gauss-Seidel is equivalent to the [SORSolver] with relaxation factor +/// `w = 1`. The SOR method generalizes Gauss-Seidel by introducing a relaxation +/// parameter. +/// +/// ## Convergence +/// +/// The method converges if the matrix is: +/// - Strictly diagonally dominant, or +/// - Symmetric positive-definite +/// +/// For non-diagonally dominant matrices, convergence is not guaranteed but may +/// still occur. +/// +/// ## When to Use +/// +/// Gauss-Seidel is particularly effective for: +/// - Large, sparse systems +/// - Systems with diagonally dominant matrices +/// - When you need faster convergence than Jacobi but don't want to tune a +/// relaxation factor (use SOR if you need even faster convergence) +/// +/// ## Example +/// +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 3, +/// columns: 3, +/// data: [ +/// [4, -1, 0], +/// [-1, 4, -1], +/// [0, -1, 4], +/// ], +/// ); +/// +/// final solver = GaussSeidelSolver( +/// matrix: matrix, +/// knownValues: [1, 5, 0], +/// precision: 1.0e-10, +/// maxSteps: 50, +/// ); +/// +/// final solution = solver.solve(); +/// ``` +/// {@endtemplate} final class GaussSeidelSolver extends SystemSolver { /// The maximum number of iterations to be made by the algorithm. + /// + /// If the algorithm doesn't converge within this number of iterations, + /// it will return the best approximation found so far. final int maxSteps; /// {@macro systems_constructor_intro} /// - /// - [matrix] is the matrix containing the equations; - /// - [knownValues] is the vector with the known values; - /// - [precision] determines how accurate the algorithm has to be; - /// - [maxSteps] the maximum number of iterations the algorithm. + /// {@macro gauss_seidel_solver} /// - /// By default, [maxSteps] is set to `30`. + /// Parameters: + /// - [matrix] is the matrix containing the equations; + /// - [knownValues] is the vector with the known values; + /// - [precision] determines how accurate the algorithm has to be + /// - [maxSteps] the maximum number of iterations (defaults to `30`). GaussSeidelSolver({ required super.matrix, required super.knownValues, @@ -39,9 +89,8 @@ final class GaussSeidelSolver extends SystemSolver { } @override - int get hashCode => Object.hashAll( - [matrix, precision, ...knownValues, maxSteps], - ); + int get hashCode => + Object.hashAll([matrix, precision, ...knownValues, maxSteps]); @override List solve() { @@ -50,6 +99,8 @@ final class GaussSeidelSolver extends SystemSolver { matrix: matrix, knownValues: knownValues, w: 1, + precision: precision, + maxSteps: maxSteps, ); return sor.solve(); diff --git a/lib/src/system/types/jacobi.dart b/lib/src/system/types/jacobi.dart index c0a540c6..5fd554ac 100644 --- a/lib/src/system/types/jacobi.dart +++ b/lib/src/system/types/jacobi.dart @@ -2,12 +2,35 @@ import 'dart:math' as math; import 'package:equations/equations.dart'; +/// {@template jacobi_solver} /// Solves a system of linear equations using the Jacobi iterative method. /// The given input matrix, representing the system of linear equations, must /// be square. /// -/// This algorithm only works with strictly diagonally dominant systems of -/// equations. +/// The [matrix] `A` must be strictly diagonally dominant for guaranteed +/// convergence. The method will check for zero diagonal elements and throw +/// an exception if found, as this would cause division by zero. +/// +/// For non-diagonally dominant matrices, convergence is not guaranteed, +/// but the method will still attempt to solve the system. +/// +/// Example: +/// +/// ```dart +/// final solver = JacobiSolver( +/// matrix: RealMatrix.fromData( +/// rows: 2, +/// columns: 2, +/// data: [[4, 1], [1, 3]], // Diagonally dominant +/// ), +/// knownValues: [5, 4], +/// x0: [0, 0], +/// ); +/// +/// final solution = solver.solve(); +/// print('Solution: $solution'); +/// ``` +/// {@endtemplate} final class JacobiSolver extends SystemSolver { /// The initial vector `x`, needed to start the algorithm. final List x0; @@ -17,13 +40,13 @@ final class JacobiSolver extends SystemSolver { /// {@macro systems_constructor_intro} /// + /// {@macro jacobi_solver} + /// /// - [matrix] is the matrix containing the equations; /// - [knownValues] is the vector with the known values; /// - [x0] is the initial guess (which is a vector); /// - [precision] tells how accurate the algorithm has to be; /// - [maxSteps] the maximum number of iterations the algorithm. - /// - /// The [matrix] `A` must be strictly diagonally dominant. factory JacobiSolver({ required RealMatrix matrix, required List knownValues, @@ -31,8 +54,7 @@ final class JacobiSolver extends SystemSolver { int maxSteps = 30, double precision = 1.0e-10, }) { - // The initial vector with the guesses MUST have the same size as the matrix - // of course + // Validate that the initial guess vector has the correct size if (x0.length != knownValues.length) { throw const SystemSolverException( 'The length of the guesses vector ' @@ -40,6 +62,16 @@ final class JacobiSolver extends SystemSolver { ); } + // Check for zero diagonal elements which would cause division by zero + for (var i = 0; i < matrix.rowCount; ++i) { + if (matrix(i, i) == 0) { + throw const SystemSolverException( + 'The matrix has zero diagonal elements, which would cause division ' + 'by zero in Jacobi method.', + ); + } + } + return JacobiSolver._( matrix: matrix, knownValues: knownValues, @@ -58,6 +90,32 @@ final class JacobiSolver extends SystemSolver { this.maxSteps = 30, }); + /// Returns whether the matrix is diagonally dominant. + /// + /// This can be useful for users to check if Jacobi is likely to converge + /// for their specific matrix. + bool isDiagonallyDominant() => SystemSolver.isDiagonallyDominant(matrix); + + /// Computes the residual norm of the current solution. + /// + /// The residual is defined as ||Ax - b||, where A is the matrix, + /// x is the solution vector, and b is the known values vector. + /// A smaller residual indicates a better solution. + double computeResidualNorm(List solution) { + var residualNorm = 0.0; + + for (var i = 0; i < matrix.rowCount; ++i) { + var rowSum = 0.0; + for (var j = 0; j < matrix.columnCount; ++j) { + rowSum += matrix(i, j) * solution[j]; + } + final residual = rowSum - knownValues[i]; + residualNorm += residual * residual; + } + + return math.sqrt(residualNorm); + } + @override bool operator ==(Object other) { if (identical(this, other)) { @@ -65,35 +123,28 @@ final class JacobiSolver extends SystemSolver { } if (other is JacobiSolver) { - // The lengths of the coefficients must match. if (x0.length != other.x0.length) { return false; } - - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the - // coefficients list. - var equalsCount = 0; - for (var i = 0; i < x0.length; ++i) { - if (x0[i] == other.x0[i]) { - ++equalsCount; + if (x0[i] != other.x0[i]) { + return false; } } - - // They must have the same runtime type AND all items must be equal. - return super == other && - equalsCount == x0.length && - maxSteps == other.maxSteps; + return super == other && maxSteps == other.maxSteps; } else { return false; } } @override - int get hashCode => Object.hashAll( - [matrix, precision, ...knownValues, maxSteps, ...x0], - ); + int get hashCode => Object.hash( + matrix, + Object.hashAll(knownValues), + precision, + maxSteps, + Object.hashAll(x0), + ); @override List solve() { @@ -101,51 +152,45 @@ final class JacobiSolver extends SystemSolver { var k = 0; var diff = precision + 1; - // Support lists. + // Pre-allocate vectors for better performance final size = knownValues.length; final solutions = List.from(x0); + final oldSolutions = List.generate(size, (_) => 0); - // Jacobi + // Jacobi iteration while ((diff >= precision) && (k < maxSteps)) { - final oldSolutions = List.from(solutions); + // Save current solution for convergence check + for (var i = 0; i < size; ++i) { + oldSolutions[i] = solutions[i]; + } + // Update each component using Jacobi formula for (var i = 0; i < size; ++i) { - // Initial value of the solution - solutions[i] = knownValues[i]; + var sigma = 0.0; + // Sum of products with old values for (var j = 0; j < size; ++j) { - // Skip the diagonal - if (i == j) { - continue; + if (i != j) { + sigma += matrix(i, j) * oldSolutions[j]; } - - solutions[i] = solutions[i] - matrix(i, j) * oldSolutions[j]; } - // New "refined" value of the solution - solutions[i] = solutions[i] / matrix(i, i); + // Jacobi update formula + solutions[i] = (knownValues[i] - sigma) / matrix(i, i); + } + + // Compute convergence criterion: maximum change in any component + diff = 0.0; + for (var i = 0; i < size; ++i) { + final change = (solutions[i] - oldSolutions[i]).abs(); + if (change > diff) { + diff = change; + } } ++k; - diff = _euclideanNorm(oldSolutions, solutions); } return solutions; } - - /// The euclidean norm is the square root of the sum of the square terms of - /// a vector. This method computes the euclidean norm on the difference of - /// two vectors. - double _euclideanNorm(List vectorA, List vectorB) { - // The difference vector - final difference = List.generate(vectorA.length, (_) => 0); - for (var i = 0; i < difference.length; ++i) { - difference[i] = vectorA[i] - vectorB[i]; - } - - // Computing the euclidean norm. - final sum = difference.map((xi) => xi * xi).reduce((a, b) => a + b); - - return math.sqrt(sum); - } } diff --git a/lib/src/system/types/lu.dart b/lib/src/system/types/lu.dart index d2972f34..9f7f8574 100644 --- a/lib/src/system/types/lu.dart +++ b/lib/src/system/types/lu.dart @@ -1,31 +1,95 @@ import 'package:equations/equations.dart'; -import 'package:equations/src/system/system.dart'; +import 'package:equations/src/system/utils/matrix_utils.dart'; -/// Solves a system of linear equations using the 'LU decomposition' method. -/// The given input matrix, representing the system of linear equations, must -/// be square. -final class LUSolver extends SystemSolver { +/// {@template lu_solver} +/// Solves a system of linear equations using the LU decomposition method. +/// +/// The LU decomposition factors a square matrix A into the product of a lower +/// triangular matrix L and an upper triangular matrix U: A = LU. This allows +/// the system Ax = b to be solved in two steps: +/// +/// 1. **Forward substitution**: Solve Ly = b for y +/// 2. **Back substitution**: Solve Ux = y for x +/// +/// ## When to Use +/// +/// LU decomposition is particularly useful when: +/// - You need to solve multiple systems with the same coefficient matrix A +/// - The matrix A is not symmetric positive-definite (use Cholesky instead) +/// - You want a direct method that doesn't require iteration +/// +/// ## Requirements +/// +/// The input matrix must be: +/// - Square (n×n) +/// - Non-singular (determinant ≠ 0) +/// - The matrix should not have zeros on the main diagonal after pivoting +/// +/// ## Example +/// +/// ```dart +/// final solver = LUSolver( +/// matrix: RealMatrix.fromData( +/// rows: 3, +/// columns: 3, +/// data: [ +/// [2, 1, 1], +/// [4, -6, 0], +/// [-2, 7, 2], +/// ], +/// ), +/// knownValues: [5, -2, 9], +/// ); +/// +/// final solution = solver.solve(); +/// // Returns: [1, 1, 2] +/// ``` +/// {@endtemplate} +final class LUSolver extends SystemSolver with RealMatrixUtils { /// {@macro systems_constructor_intro} /// + /// {@macro lu_solver} + /// /// - [matrix] is the matrix containing the equations; /// - [knownValues] is the vector with the known values. - LUSolver({ - required super.matrix, - required super.knownValues, - }); + LUSolver({required super.matrix, required super.knownValues}); @override List solve() { + if (!hasSolution()) { + throw const SystemSolverException( + 'The system has no solution: the matrix is singular (determinant = 0).', + ); + } + final lu = matrix.luDecomposition(); + final L = lu[0]; + final U = lu[1]; + final P = lu[2]; + + // Apply permutation to known values: Pb + final bPermuted = List.generate( + knownValues.length, + (i) { + // Find j such that P[i, j] = 1, then (Pb)[i] = b[j] + for (var j = 0; j < knownValues.length; j++) { + if (P(i, j) == 1.0) { + return knownValues[j]; + } + } + // Fallback value, shouldn't happen + return knownValues[i]; // coverage:ignore-line + }, + growable: false, + ); - // Solving Ly = b - final L = lu.first.toListOfList(); - final b = knownValues; - final y = SystemSolver.forwardSubstitution(L, b); + // Solving Ly = Pb + final lList = L.toListOfList(); + final y = forwardSubstitution(lList, bPermuted); // Solving Ux = y - final U = lu[1].toListOfList(); + final uList = U.toListOfList(); - return SystemSolver.backSubstitution(U, y); + return backSubstitution(uList, y); } } diff --git a/lib/src/system/types/sor.dart b/lib/src/system/types/sor.dart index 554e4f9e..0d7353e9 100644 --- a/lib/src/system/types/sor.dart +++ b/lib/src/system/types/sor.dart @@ -2,33 +2,129 @@ import 'dart:math' as math; import 'package:equations/equations.dart'; -/// Solves a system of linear equations using the SOR iterative method. The -/// given input matrix, representing the system of linear equations, must be -/// square. +/// {@template sor_solver} +/// Solves a system of linear equations using the Successive Over-Relaxation +/// (SOR) iterative method. /// /// A theorem due to Kahan (1958) shows that SOR fails to converge if `w` is not -/// in the (0, 2) range. +/// in the (0, 2) range. The optimal value of `w` depends on the spectral radius +/// of the iteration matrix: +/// +/// - For `w = 1`: SOR reduces to the Gauss-Seidel method +/// - For `0 < w < 1`: Under-relaxation (slower convergence, more stable) +/// - For `1 < w < 2`: Over-relaxation (faster convergence when optimal) +/// +/// ## When to use +/// +/// SOR is particularly effective for: +/// - Large, sparse systems +/// - Systems with diagonally dominant matrices +/// - When you need faster convergence than Gauss-Seidel +/// +/// ## Example +/// +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 3, +/// columns: 3, +/// data: [ +/// [4, -1, 0], +/// [-1, 4, -1], +/// [0, -1, 4], +/// ], +/// ); +/// +/// final sor = SORSolver( +/// matrix: matrix, +/// knownValues: [1, 5, 0], +/// w: 1.2, // Optimal relaxation factor for this matrix +/// precision: 1.0e-10, +/// maxSteps: 50, +/// ); +/// +/// final solution = sor.solve(); +/// ``` +/// {@endtemplate} final class SORSolver extends SystemSolver { - /// The relaxation factor `w` (omega). + /// The relaxation factor `w` (omega) that controls the convergence rate. + /// + /// The value must be in the range (0, 2) for convergence: + /// - `w = 1`: Equivalent to Gauss-Seidel method + /// - `0 < w < 1`: Under-relaxation (slower but more stable) + /// - `1 < w < 2`: Over-relaxation (faster when optimal) + /// + /// The optimal value depends on the spectral radius of the iteration matrix. final double w; /// The maximum number of iterations to be made by the algorithm. + /// + /// If the algorithm doesn't converge within this number of iterations, + /// it will return the best approximation found so far. final int maxSteps; /// {@macro systems_constructor_intro} /// + /// {@macro sor_solver} + /// /// - [matrix] is the matrix containing the equations; /// - [knownValues] is the vector with the known values; /// - [precision] determines how accurate the algorithm has to be; - /// - [w] is the relaxation factor; - /// - [maxSteps] the maximum number of iterations the algorithm. + /// - [w] is the relaxation factor (must be in range (0, 2)); + /// - [maxSteps] the maximum number of iterations (defaults to 30). + /// + /// The algorithm will stop when either: + /// - The residual norm is less than [precision], or + /// - The maximum number of iterations [maxSteps] is reached. SORSolver({ required super.matrix, required super.knownValues, required this.w, super.precision, this.maxSteps = 30, - }); + }) { + // Validate the relaxation factor + if (w <= 0 || w >= 2) { + throw const SystemSolverException( + 'The relaxation factor w must be in the range (0, 2) for convergence.', + ); + } + + // Check for zero diagonal elements which would cause division by zero + for (var i = 0; i < matrix.rowCount; ++i) { + if (matrix(i, i) == 0) { + throw const SystemSolverException( + 'The matrix has zero diagonal elements, which would cause division ' + 'by zero in SOR.', + ); + } + } + } + + /// Returns whether the matrix is diagonally dominant. + /// + /// This can be useful for users to check if SOR is likely to converge + /// for their specific matrix. + bool isDiagonallyDominant() => SystemSolver.isDiagonallyDominant(matrix); + + /// Computes the residual norm of the current solution. + /// + /// The residual is defined as ||Ax - b||, where A is the matrix, + /// x is the solution vector, and b is the known values vector. + /// A smaller residual indicates a better solution. + double computeResidualNorm(List solution) { + var residualNorm = 0.0; + + for (var i = 0; i < matrix.rowCount; ++i) { + var rowSum = 0.0; + for (var j = 0; j < matrix.columnCount; ++j) { + rowSum += matrix(i, j) * solution[j]; + } + final residual = rowSum - knownValues[i]; + residualNorm += residual * residual; + } + + return math.sqrt(residualNorm); + } @override bool operator ==(Object other) { @@ -44,9 +140,8 @@ final class SORSolver extends SystemSolver { } @override - int get hashCode => Object.hashAll( - [matrix, precision, ...knownValues, maxSteps, w], - ); + int get hashCode => + Object.hash(matrix, Object.hashAll(knownValues), precision, maxSteps, w); @override List solve() { @@ -54,53 +149,49 @@ final class SORSolver extends SystemSolver { var k = 0; var diff = precision + 1; - // Support lists. + // Pre-allocate vectors for better performance final size = knownValues.length; final phi = List.generate(size, (_) => 0); + final oldPhi = List.generate(size, (_) => 0); - // Jacobi. + // SOR iteration while ((diff >= precision) && (k < maxSteps)) { + // Save current solution for convergence check for (var i = 0; i < size; ++i) { - var sigma = 0.0; - for (var j = 0; j < size; ++j) { - if (j != i) { - sigma += matrix(i, j) * phi[j]; - } - } - phi[i] = - (1 - w) * phi[i] + (w / matrix(i, i)) * (knownValues[i] - sigma); + oldPhi[i] = phi[i]; } - ++k; - diff = _euclideanNorm(phi); - } + // Update each component using SOR formula + for (var i = 0; i < size; ++i) { + var sigma = 0.0; - return phi; - } + // Sum of products with already updated values (forward substitution) + for (var j = 0; j < i; ++j) { + sigma += matrix(i, j) * phi[j]; + } - /// The euclidean norm is the square root of the sum of the square terms of - /// a vector. This method computes the euclidean norm on the difference of - /// two vectors. - double _euclideanNorm(List phi) { - // This is A*phi (where A is the source matrix) - final difference = List.generate(matrix.rowCount, (_) => 0); + // Sum of products with old values (backward substitution) + for (var j = i + 1; j < size; ++j) { + sigma += matrix(i, j) * oldPhi[j]; + } - for (var i = 0; i < matrix.rowCount; ++i) { - var sum = 0.0; - for (var j = 0; j < matrix.columnCount; ++j) { - sum += matrix(i, j) * phi[j]; + // SOR update formula + phi[i] = + (1 - w) * oldPhi[i] + (w / matrix(i, i)) * (knownValues[i] - sigma); } - difference[i] = sum; - } - // Making the difference between (A*phi) - b - for (var i = 0; i < knownValues.length; ++i) { - difference[i] -= knownValues[i]; - } + // Compute convergence criterion: maximum change in any component + diff = 0.0; + for (var i = 0; i < size; ++i) { + final change = (phi[i] - oldPhi[i]).abs(); + if (change > diff) { + diff = change; + } + } - // Computing the euclidean norm - final sum = difference.map((xi) => xi * xi).reduce((a, b) => a + b); + ++k; + } - return math.sqrt(sum); + return phi; } } diff --git a/lib/src/system/utils/matrix.dart b/lib/src/system/utils/matrix.dart index 6815564e..bc73d2b6 100644 --- a/lib/src/system/utils/matrix.dart +++ b/lib/src/system/utils/matrix.dart @@ -1,35 +1,40 @@ import 'dart:collection'; - import 'package:equations/equations.dart'; -/// A simple Dart implementation of a matrix whose size is `m x n`. Thanks to -/// its generic nature, you can decide to work with [int], [double], [Complex] -/// or any other kind of numerical type. This library implements: +/// {@template matrix_class_header} +/// A matrix with [rowCount] rows and [columnCount] columns. This abstract type +/// allows the implementation of different types of matrices, each with their +/// own specific methods and types. This library implements: /// -/// - [RealMatrix] that works with [double]; -/// - [ComplexMatrix] that works with [Complex]. +/// - [RealMatrix], which works with [double]; +/// - [ComplexMatrix], which works with [Complex]. /// -/// By default, the cells of a matrix are initialized with zeroes. You can +/// By default, the cells of a matrix are initialized with zeros. You can /// access elements of the matrix either by calling [itemAt] or by using the /// [call] method (which makes the object 'callable'). +/// +/// This is a base abstract class. +/// {@endtemplate} abstract base class Matrix { - /// The number of rows of the matrix. + /// The number of rows in the matrix. final int rowCount; - /// The number of columns of the matrix. + /// The number of columns in the matrix. final int columnCount; /// The internal representation of the matrix. final List _data; + /// {@macro matrix_class_header} + /// /// {@template matrix_constructor_intro} - /// Creates a new `N x M` matrix where [rows] is `N` and [columns] is `M`. The - /// matrix is filled with zeroes. + /// Creates a new `NxM` matrix where [rows] is `N` and [columns] is `M`. The + /// matrix is filled with zeros. /// - /// If [identity] is set to `true` (by default it's `false`) then the matrix - /// is initialized with zeroes **and** the diagonal is filled with ones. + /// If [identity] is set to `true` (by default it's `false`), the matrix is + /// initialized with zeros **and** the diagonal is filled with ones. /// - /// A [MatrixException] object is thrown if [rows] or [columns] is set to 0. + /// A [MatrixException] is thrown if [rows] or [columns] is set to 0. /// {@endtemplate} Matrix({ required int rows, @@ -37,9 +42,9 @@ abstract base class Matrix { required T defaultValue, required T identityOneValue, bool identity = false, - }) : rowCount = rows, - columnCount = columns, - _data = List.filled(rows * columns, defaultValue) { + }) : rowCount = rows, + columnCount = columns, + _data = List.filled(rows * columns, defaultValue) { // Making sure the user entered valid dimensions for the matrix if ((rows == 0) || (columns == 0)) { throw const MatrixException('The rows or column count cannot be zero.'); @@ -58,19 +63,19 @@ abstract base class Matrix { } /// {@template matrix_fromData_constructor} - /// Creates a new `N x M` matrix where [rows] is `N` and [columns] is `M`. The + /// Creates a new `NxM` matrix where [rows] is `N` and [columns] is `M`. The /// matrix is filled with values from [data]. /// - /// A [MatrixException] object is thrown if [rows]*[columns] is **not** equal - /// to [data] length. + /// A [MatrixException] is thrown if [rows] * [columns] is **not** equal + /// to the length of [data]. /// {@endtemplate} Matrix.fromData({ required int rows, required int columns, required List> data, - }) : rowCount = rows, - columnCount = columns, - _data = data.expand((e) => e).toList(growable: false) { + }) : rowCount = rows, + columnCount = columns, + _data = data.expand((e) => e).toList(growable: false) { // Making sure the size is correct if (_data.length != (rows * columns)) { throw const MatrixException( @@ -80,19 +85,19 @@ abstract base class Matrix { } /// {@template matrix_fromFlattenedData_constructor} - /// Creates a new `N x M` matrix where [rows] is `N` and [columns] is `M`. The + /// Creates a new `NxM` matrix where [rows] is `N` and [columns] is `M`. The /// matrix is filled with values from [data]. /// /// The source matrix is expressed as an array whose size must **exactly** be - /// `N` * `M`, otherwise a [MatrixException] object is thrown. + /// `N` * `M`, otherwise a [MatrixException] is thrown. /// {@endtemplate} Matrix.fromFlattenedData({ required int rows, required int columns, required List data, - }) : rowCount = rows, - columnCount = columns, - _data = List.from(data) { + }) : rowCount = rows, + columnCount = columns, + _data = List.from(data) { // Making sure the size is correct if (data.length != (rows * columns)) { throw const MatrixException( @@ -103,20 +108,20 @@ abstract base class Matrix { } /// {@template matrix_diagonal_constructor} - /// Creates a new `N x M` matrix where [rows] is `N` and [columns] is `M`. The - /// matrix is filled with [diagonalValue] in the main diagonal and zeroes - /// otherwise. + /// Creates a new `NxM` matrix where [rows] is `N` and [columns] is `M`. The + /// matrix is filled with [diagonalValue] in the main diagonal and zeros + /// elsewhere. /// - /// A [MatrixException] object is thrown if [rows] or [columns] is set to 0. + /// A [MatrixException] is thrown if [rows] or [columns] is set to 0. /// {@endtemplate} Matrix.diagonal({ required int rows, required int columns, required T defaultValue, required T diagonalValue, - }) : rowCount = rows, - columnCount = columns, - _data = List.filled(rows * columns, defaultValue) { + }) : rowCount = rows, + columnCount = columns, + _data = List.filled(rows * columns, defaultValue) { // Making sure the user entered valid dimensions for the matrix. if ((rows == 0) || (columns == 0)) { throw const MatrixException('The rows or column count cannot be zero.'); @@ -139,34 +144,41 @@ abstract base class Matrix { } if (other is Matrix) { - // The lengths of the data lists must match - if (_data.length != other._data.length) { + if (rowCount != other.rowCount || + columnCount != other.columnCount || + _data.length != other._data.length) { return false; } - // Each successful comparison increases a counter by 1. If all elements - // are equal, then the counter will match the actual length of the data - // list. - var equalsCount = 0; - for (var i = 0; i < _data.length; ++i) { - if (_data[i] == other._data[i]) { - ++equalsCount; + if (_data[i] != other._data[i]) { + return false; } } - // They must have the same runtime type AND all items must be equal. - return runtimeType == other.runtimeType && - equalsCount == _data.length && - rowCount == other.rowCount && - columnCount == other.columnCount; - } else { - return false; + return runtimeType == other.runtimeType; } + return false; } @override - int get hashCode => Object.hashAll([rowCount, columnCount, ..._data]); + int get hashCode => Object.hash(rowCount, columnCount, Object.hashAll(_data)); + + /// Validates that the given row and column indices are within bounds. + /// + /// Throws a [MatrixException] if either index is negative or out of bounds. + void _validateIndices(int row, int col) { + if (row < 0 || row >= rowCount) { + throw MatrixException( + 'Row index $row is out of bounds. Matrix has $rowCount rows.', + ); + } + if (col < 0 || col >= columnCount) { + throw MatrixException( + 'Column index $col is out of bounds. Matrix has $columnCount columns.', + ); + } + } @override String toString() { @@ -200,19 +212,34 @@ abstract base class Matrix { } /// Returns a modifiable view of the matrix as a `List>` object. + /// + /// Each inner list represents a row of the matrix. The returned list is + /// modifiable, but changes to it will not affect the original matrix. List> toListOfList() => List>.generate( - rowCount, - (row) => List.generate(columnCount, (col) => this(row, col)), - growable: false, - ); + rowCount, + (row) => List.generate(columnCount, (col) => this(row, col)), + growable: false, + ); /// An unmodifiable, flattened representation of the matrix data. + /// + /// The data is stored in row-major order (elements are arranged row by row). + /// For example, a 2×3 matrix `[[a, b, c], [d, e, f]]` would be flattened + /// as `[a, b, c, d, e, f]`. List get flattenData => UnmodifiableListView(_data); /// Returns a modifiable "flattened" view of the matrix as a `List` object. + /// + /// The data is stored in row-major order (elements are arranged row by row). + /// The returned list is a copy of the internal data, so modifications to + /// it will not affect the original matrix. List toList() => List.from(_data); - /// Determines whether the matrix is square nor not. + /// Determines whether the matrix is square or not. + /// + /// A square matrix has the same number of rows and columns. Many matrix + /// operations (such as determinant, inverse, eigenvalues) require the + /// matrix to be square. bool get isSquareMatrix => rowCount == columnCount; /// Use this method to retrieve the element at a given position in the matrix. @@ -222,17 +249,13 @@ abstract base class Matrix { /// final value = myMatrix(2, 1); /// ``` /// - /// In the above example, you're accessing the value at position `(3, 2)`. + /// In the above example, you're accessing the value at position `(2, 1)`. /// This method is an alias of [itemAt]. /// /// A [MatrixException] is thrown if [row] and/or [col] is not within the /// size range of the matrix. T call(int row, int col) { - if ((row >= rowCount) || (col >= columnCount)) { - throw const MatrixException('The given indices are out of the bounds.'); - } - - // Data are stored sequentially so there's the need to work with the indices + _validateIndices(row, col); return _data[columnCount * row + col]; } @@ -240,22 +263,36 @@ abstract base class Matrix { /// Because equal matrices have equal dimensions, only square matrices can be /// symmetric. bool isSymmetric() { - if (isSquareMatrix) { - return this == transpose(); + if (!isSquareMatrix) { + return false; } - return false; + final n = rowCount; + for (var i = 0; i < n; i++) { + for (var j = i + 1; j < n; j++) { + if (this(i, j) != this(j, i)) { + return false; + } + } + } + return true; } + /// Checks if the matrix contains only zero elements. + /// + /// Returns `true` if all elements in the matrix are zero, `false` otherwise. + /// This is useful for checking if a matrix is the zero matrix. + bool isZero(); + /// Returns the value at ([row], [col]) position as if this matrix were - /// transposed. For example, let's say we have this matrix object: + /// transposed. For example, let's say we have this matrix: /// /// ```txt /// A = | 1 2 | /// | 3 4 | /// ``` /// - /// calling `itemAt(0, 1)` returns `2` because that's the value stored at row + /// Calling `itemAt(0, 1)` returns `2` because that's the value stored at row /// 0 and column 1. Calling `transposedValue(0, 1)` returns `3` because in the /// transposed matrix of A... /// @@ -264,7 +301,7 @@ abstract base class Matrix { /// | 2 4 | /// ``` /// - /// ... the number `3` is at row 0 an column 1. In other words, this method + /// ... the number `3` is at row 0 and column 1. In other words, this method /// returns the value of the transposed matrix of this matrix. T transposedValue(int row, int col) => this(col, row); @@ -275,65 +312,60 @@ abstract base class Matrix { /// final value = myMatrix.itemAt(2, 1); /// ``` /// - /// In the above example, you're accessing the value at position `(3, 2)`. - T itemAt(int row, int col) => this(row, col); + /// In the above example, you're accessing the value at position `(2, 1)`. + T itemAt(int row, int col) { + _validateIndices(row, col); + return _data[columnCount * row + col]; + } /// Returns the sum of two matrices. /// - /// {@template matrix_operation_size_mismatch_error} - /// An exception is thrown if the size of the source matrix does **not** match - /// the size of the other matrix. - /// {@endtemplate} + /// Matrix addition is performed element-wise. Each element in the result + /// is the sum of the corresponding elements in the two matrices. Matrix operator +(Matrix other); /// Returns the difference of two matrices. /// - /// {@macro matrix_operation_size_mismatch_error} + /// Matrix subtraction is performed element-wise. Each element in the result + /// is the difference of the corresponding elements in the two matrices. Matrix operator -(Matrix other); /// Returns the product of two matrices. /// - /// {@template matrix_operation_inverted_size_mismatch_error} - /// An exception is thrown if the column count of the source matrix does - /// **not** match the row count of the other matrix. - /// {@endtemplate} + /// Matrix multiplication is performed using the standard matrix + /// multiplication algorithm. The element at position (i, j) in the result + /// is the dot product of row i of this matrix and column j of [other]. Matrix operator *(Matrix other); /// Returns the division of two matrices. /// - /// {@macro matrix_operation_inverted_size_mismatch_error} + /// Matrix division is equivalent to multiplying this matrix by the inverse + /// of [other]. That is, `A / B` is equivalent to `A * B.inverse()`. Matrix operator /(Matrix other); /// Returns the transpose of this matrix. /// - /// This is an operation that simply flips a matrix over its diagonal (so it - /// switches the row and column indices of the matrix to create a new one). + /// This is an operation that flips a matrix over its diagonal (switching the + /// row and column indices of the matrix to create a new one). The transpose + /// of an `N×M` matrix is an `M×N` matrix where the element at position (i, j) + /// in the original matrix becomes the element at position (j, i) in the + /// transposed matrix. Matrix transpose(); /// A minor of a matrix `A` is the determinant of some smaller square matrix, /// cut down from `A` by removing one or more of its rows and columns. /// /// This function only computes the **first minor**, which is the minor - /// obtained by only removing 1 row and 1 column from the source matrix. This - /// is often useful to calculate cofactors. - /// - /// A [MatrixException] object is thrown in a few cases: - /// - /// - [row] or [col] is smaller than zero; - /// - [row] or [col] are higher than, respectively, the total row or column - /// count; - /// - [row] or [col] is 1. + /// obtained by removing 1 row and 1 column from the source matrix. This + /// is often useful for calculating cofactors. Matrix minor(int row, int col); /// The matrix formed by all of the cofactors of a square matrix is called the - /// "cofactor matrix" (also called "the matrix of cofactors"). - /// - /// In practice, this matrix is obtained by calling `minor(i, j)` for all the - /// rows and columns combinations of the matrix. + /// "cofactor matrix". /// - /// {@template matrix_not_square_error} - /// A [MatrixException] object is thrown if the matrix isn't square. - /// {@endtemplate} + /// In practice, this matrix is obtained by calling `minor(i, j)` for all + /// combinations of rows and columns of the matrix, then multiplying each + /// minor's determinant by (-1)i+j to get the cofactor. Matrix cofactorMatrix(); /// Returns the inverse of this matrix. @@ -342,40 +374,51 @@ abstract base class Matrix { /// is a matrix A-1 such that "A A-1 = I" where `I` is /// the identity matrix. /// - /// A square matrix has an inverse if and only if the determinant **isn't** 0. + /// A square matrix has an inverse if and only if its determinant is *not* 0. + /// A matrix that has an inverse is called **invertible** or **non-singular**. /// - /// {@macro matrix_not_square_error} + /// A matrix without an inverse is called **singular**. Matrix inverse(); - /// The trace of a square matrix `A`, denoted `tr(A)`, is defined to be the + /// The trace of a square matrix `A`, denoted `tr(A)`, is defined as the /// sum of elements on the main diagonal (from the upper left to the lower /// right). /// - /// {@macro matrix_not_square_error} + /// The trace has several important properties: + /// - tr(A + B) = tr(A) + tr(B) + /// - tr(cA) = c × tr(A) for any scalar c + /// - tr(AB) = tr(BA) + /// - The trace equals the sum of the eigenvalues T trace(); - /// A diagonal matrix is a matrix in which the entries outside the main - /// diagonal are all zero. + /// A diagonal matrix is a matrix in which all entries outside the main + /// diagonal are zero. + /// + /// Returns `true` if the matrix is diagonal (all non-diagonal elements are + /// zero), `false` otherwise. Note that a diagonal matrix must be square. bool isDiagonal(); /// The identity matrix is a square matrix with ones on the main diagonal /// and zeros elsewhere. It is denoted by In, or simply by I. /// - /// {@macro matrix_not_square_error} + /// The identity matrix has the property that for any matrix A of compatible + /// size, A x I = I x A = A. bool isIdentity(); /// The **rank** of a matrix `A` is the dimension of the vector space /// generated by its columns. This corresponds to the maximal number of /// linearly independent columns of `A`. /// - /// The rank is generally denoted by rank(A) or rk(A). + /// The rank is generally denoted by rank(A) or rk(A). The rank of a matrix + /// is equal to the rank of its transpose, and it cannot exceed the minimum + /// of the number of rows and columns. int rank(); /// The determinant can only be computed if the matrix is **square**, meaning /// that it must have the same number of columns and rows. /// - /// The determinant of a 1*1, 2*2, 3*3 or 4*4 matrix is efficiently computed. - /// Note that for all the other dimensions, the algorithm is exponentially + /// The determinant of a 1×1, 2×2, 3×3, or 4×4 matrix is efficiently computed. + /// Note that for all other dimensions, the algorithm is exponentially /// slower. T determinant(); @@ -387,13 +430,16 @@ abstract base class Matrix { /// /// If you want to find the eigenvalues of a matrix, you can compute the /// characteristic polynomial and solve the polynomial equation. However, for - /// 5x5 or bigger matrices, consider using the [eigenvalues] method which is + /// 5×5 or larger matrices, consider using the [eigenvalues] method which is /// faster and more accurate. /// - /// {@macro matrix_not_square_error} + /// {@template matrix_not_square_error} + /// A [MatrixException] is thrown if the matrix is not square (i.e., if + /// [rowCount] != [columnCount]). + /// {@endtemplate} Algebraic characteristicPolynomial(); - /// Returns the eigenvalues associated to this matrix. + /// Returns the eigenvalues associated with this matrix. /// /// Eigenvalues can only be computed if the matrix is **square**, meaning /// that it must have the same number of columns and rows. @@ -409,14 +455,14 @@ abstract base class Matrix { /// {@macro matrix_not_square_error} List> luDecomposition(); - /// Uses the the Cholesky decomposition algorithm to factor the matrix into + /// Uses the Cholesky decomposition algorithm to factor the matrix into /// the product of a lower triangular matrix and its conjugate transpose. In /// particular, this method returns the `L` and `L`T matrices of the /// - /// - A = L x LT + /// - A = L × LT /// - /// relation. The algorithm might fail in case the square root of a negative - /// number were encountered. + /// relation. The algorithm might fail if the square root of a negative + /// number is encountered. /// /// The returned list contains `L` at index 0 and `L`T at index 1. /// @@ -426,33 +472,35 @@ abstract base class Matrix { /// Computes the `Q` and `R` matrices of the QR decomposition algorithm. In /// particular, this method returns the `Q` and `R` matrices of the /// - /// - A = Q x R + /// - A = Q × R /// /// relation. The returned list contains `Q` at index 0 and `R` at index 1. List> qrDecomposition(); - /// Computes the `E`, `U` and `V` matrices of the SVD (Single Value + /// Computes the `E`, `U`, and `V` matrices of the SVD (Singular Value /// Decomposition) algorithm. In particular, this method returns the following /// matrices: /// /// - `E`: rectangular diagonal matrix with positive values on the diagonal; - /// - `U`: a square matrix of size [rowCount]x[rowCount]; - /// - `V`: a square matrix of size [columnCount]x[columnCount]. + /// - `U`: a square matrix of size [rowCount]×[rowCount]; + /// - `V`: a square matrix of size [columnCount]×[columnCount]. /// - /// The returned list contains `E` at index 0, `U` at index 1 and `V` at index - /// 2. + /// The returned list contains `E` at index 0, `U` at index 1, and `V` at + /// index 2. List> singleValueDecomposition(); - /// Computes the `V`, `D` and `V'` matrices of the eigendecomposition + /// Computes the `V`, `D`, and `V'` matrices of the eigendecomposition /// algorithm. In particular, this method returns the following matrices: /// - /// - `V`: square matrix whose ith column is the eigenvector of + /// - `V`: a square matrix whose ith column is the eigenvector of /// the source matrix; - /// - `U`: the diagonal matrix whose diagonal elements are the corresponding + /// - `D`: a diagonal matrix whose diagonal elements are the corresponding /// eigenvalues of A; - /// - `V`: the inverse of V. + /// - `V'`: the inverse of V. /// - /// The returned list contains `V` at index 0, `D` at index 1 and `V'` at + /// The returned list contains `V` at index 0, `D` at index 1, and `V'` at /// index 2. + /// + /// {@macro matrix_not_square_error} List> eigenDecomposition(); } diff --git a/lib/src/system/utils/matrix/complex_matrix.dart b/lib/src/system/utils/matrix/complex_matrix.dart index 1b72acd4..bc120311 100644 --- a/lib/src/system/utils/matrix/complex_matrix.dart +++ b/lib/src/system/utils/matrix/complex_matrix.dart @@ -1,9 +1,9 @@ import 'dart:math'; import 'package:equations/equations.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_complex_decomposition.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_complex.dart'; import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/complex_svd.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_complex.dart'; /// A simple Dart implementation of an `m x n` matrix whose data type is /// [Complex]. @@ -15,8 +15,8 @@ import 'package:equations/src/system/utils/matrix/decompositions/singular_value_ /// ); /// ``` /// -/// By default, the cells of a matrix are initialized with all zeroes. You can -/// access elements of the matrix very conveniently with the following syntax: +/// By default, the cells of a matrix are initialized with all zeros. You can +/// access elements of the matrix conveniently with the following syntax: /// /// ```dart /// final matrix = ComplexMatrix( @@ -30,7 +30,7 @@ import 'package:equations/src/system/utils/matrix/decompositions/singular_value_ /// /// Both versions return the same value but the first one is less verbose and /// preferred. In the example, `value` holds the value of the element at -/// position `(1, 3)` in the matrix. +/// position `(2, 3)` in the matrix. base class ComplexMatrix extends Matrix { /// {@macro matrix_constructor_intro} ComplexMatrix({ @@ -60,9 +60,7 @@ base class ComplexMatrix extends Matrix { required super.rows, required super.columns, required super.diagonalValue, - }) : super.diagonal( - defaultValue: const Complex.zero(), - ); + }) : super.diagonal(defaultValue: const Complex.zero()); void _setDataAt(List flatMatrix, int row, int col, Complex value) => flatMatrix[columnCount * row + col] = value; @@ -133,25 +131,58 @@ base class ComplexMatrix extends Matrix { ); } - // Performing the product + // Special case: zero matrix multiplication + if (isZero() || other.isZero()) { + return ComplexMatrix(rows: rowCount, columns: other.columnCount); + } + + // Cache dimensions and data for better performance + final n = rowCount; + final m = columnCount; + final p = other.columnCount; + final a = flattenData; + final b = other.flattenData; + + // Performing the product with block multiplication final flatMatrix = List.generate( - rowCount * other.columnCount, + n * p, (_) => const Complex.zero(), growable: false, ); - // Performing the multiplication - for (var i = 0; i < rowCount; i++) { - for (var j = 0; j < other.columnCount; j++) { - var sum = const Complex.zero(); - for (var k = 0; k < other.rowCount; k++) { - sum += this(i, k) * other(k, j); + // Block multiplication for better cache locality + const blockSize = 16; // Smaller block size for complex numbers + for (var ii = 0; ii < n; ii += blockSize) { + final iEnd = (ii + blockSize < n) ? ii + blockSize : n; + for (var jj = 0; jj < p; jj += blockSize) { + final jEnd = (jj + blockSize < p) ? jj + blockSize : p; + for (var kk = 0; kk < m; kk += blockSize) { + final kEnd = (kk + blockSize < m) ? kk + blockSize : m; + + // Multiply blocks + for (var i = ii; i < iEnd; i++) { + for (var j = jj; j < jEnd; j++) { + var sum = const Complex.zero(); + for (var k = kk; k < kEnd; k++) { + final aik = a[m * i + k]; + final bkj = b[p * k + j]; + // Optimize complex multiplication by avoiding temporary objects + sum = Complex( + sum.real + + aik.real * bkj.real - + aik.imaginary * bkj.imaginary, + sum.imaginary + + aik.real * bkj.imaginary + + aik.imaginary * bkj.real, + ); + } + flatMatrix[p * i + j] += sum; + } + } } - flatMatrix[other.columnCount * i + j] = sum; } } - // Building the new matrix return ComplexMatrix.fromFlattenedData( rows: rowCount, columns: other.columnCount, @@ -228,10 +259,8 @@ base class ComplexMatrix extends Matrix { final source = List>.generate( rowCount - 1, - (_) => List.generate( - columnCount - 1, - (_) => const Complex.zero(), - ), + (_) => + List.generate(columnCount - 1, (_) => const Complex.zero()), ); for (var i = 0; i < rowCount; ++i) { @@ -263,9 +292,7 @@ base class ComplexMatrix extends Matrix { return ComplexMatrix.fromFlattenedData( rows: 1, columns: 1, - data: const [ - Complex.fromReal(1), - ], + data: const [Complex.fromReal(1)], ); } @@ -277,7 +304,7 @@ base class ComplexMatrix extends Matrix { // Computing cofactors for (var i = 0; i < rowCount; ++i) { for (var j = 0; j < columnCount; ++j) { - final sign = Complex.fromReal(pow(-1, i + j) * 1.0); + final sign = Complex.fromReal(pow(-1, i + j).toDouble()); source[i][j] = sign * minor(i, j).determinant(); } } @@ -308,7 +335,8 @@ base class ComplexMatrix extends Matrix { // time. Note that, from here, we're sure that this matrix is square so no // need to check both the row count and the col count. if (rowCount == 2) { - final multiplier = const Complex(1, 0) / + final multiplier = + const Complex(1, 0) / (this(0, 0) * this(1, 1) - this(0, 1) * this(1, 0)); return ComplexMatrix.fromFlattenedData( @@ -472,17 +500,12 @@ base class ComplexMatrix extends Matrix { // For 1x1 matrices, directly compute it if (rowCount == 1) { - return Linear( - b: -this(0, 0), - ); + return Linear(b: -this(0, 0)); } // For 2x2 matrices, use a direct formula which is faster if (rowCount == 2) { - return Quadratic( - b: -trace(), - c: determinant(), - ); + return Quadratic(b: -trace(), c: determinant()); } // For 3x3 matrices and bigger, use the Faddeev–LeVerrier algorithm @@ -525,9 +548,7 @@ base class ComplexMatrix extends Matrix { } // For 3x3 matrices and bigger, use the "eigendecomposition" algorithm. - final eigenDecomposition = EigendecompositionComplex( - matrix: this, - ); + final eigenDecomposition = EigendecompositionComplex(matrix: this); // The 'D' matrix contains real and complex coefficients of the eigenvalues // so we can ignore the other 2. @@ -611,18 +632,15 @@ base class ComplexMatrix extends Matrix { // Making sure that the matrix is squared if (!isSquareMatrix) { throw const MatrixException( - 'LU decomposition only works with square matrices!', + 'Cholesky decomposition only works with square matrices!', ); } - // Exit immediately because if [0,0] is a negative number, the algorithm - // cannot even start since the square root of a negative number in R is not - // allowed. - if (this(0, 0) <= const Complex.zero()) { + final firstDiag = this(0, 0); + if (firstDiag.imaginary.abs() > 1.0e-12 || firstDiag.real <= 0) { throw const SystemSolverException('The matrix is not positive-definite.'); } - // Creating L and Lt matrices final L = List.generate( rowCount * columnCount, (_) => const Complex.zero(), @@ -634,25 +652,61 @@ base class ComplexMatrix extends Matrix { growable: false, ); - // Computing the L matrix so that A = L * Lt (where 'Lt' is L transposed) - for (var i = 0; i < rowCount; i++) { - for (var j = 0; j <= i; j++) { + const blockSize = 16; + for (var i = 0; i < rowCount; i += blockSize) { + final iEnd = (i + blockSize < rowCount) ? i + blockSize : rowCount; + + for (var j = i; j < iEnd; j++) { var sum = const Complex.zero(); - if (j == i) { - for (var k = 0; k < j; k++) { - sum += _getDataAt(L, j, k) * _getDataAt(L, j, k); + for (var k = 0; k < j; k++) { + final ljk = _getDataAt(L, j, k); + sum += ljk * ljk; + } + final diag = this(j, j) - sum; + if (diag.imaginary.abs() > 1.0e-12 || diag.real <= 0) { + throw const SystemSolverException( + 'The matrix is not positive-definite.', + ); + } + _setDataAt(L, j, j, diag.sqrt()); + + // Compute elements below diagonal + for (var k = j + 1; k < iEnd; k++) { + sum = const Complex.zero(); + for (var p = 0; p < j; p++) { + sum += _getDataAt(L, k, p) * _getDataAt(L, j, p); } - _setDataAt(L, j, j, (this(i, j) - sum).sqrt()); - } else { - for (var k = 0; k < j; k++) { - sum += _getDataAt(L, i, k) * _getDataAt(L, j, k); + final ljj = _getDataAt(L, j, j); + if (ljj == const Complex.zero()) { + throw const SystemSolverException( + 'Division by zero in Cholesky decomposition. Matrix is singular.', + ); + } + _setDataAt(L, k, j, (this(k, j) - sum) / ljj); + } + } + + // Process remaining blocks + for (var j = iEnd; j < rowCount; j += blockSize) { + final jEnd = (j + blockSize < rowCount) ? j + blockSize : rowCount; + for (var k = i; k < iEnd; k++) { + for (var l = j; l < jEnd; l++) { + var sum = const Complex.zero(); + for (var p = 0; p < k; p++) { + sum += _getDataAt(L, l, p) * _getDataAt(L, k, p); + } + final lkk = _getDataAt(L, k, k); + if (lkk == const Complex.zero()) { + throw const SystemSolverException( + 'Division by 0 in Cholesky decomposition. Matrix is singular.', + ); + } + _setDataAt(L, l, k, (this(l, k) - sum) / lkk); } - _setDataAt(L, i, j, (this(i, j) - sum) / _getDataAt(L, j, j)); } } } - // Computing Lt, the transposed version of L for (var i = 0; i < rowCount; i++) { for (var j = 0; j < rowCount; j++) { _setDataAt(transpL, i, j, _getDataAt(L, j, i)); @@ -692,13 +746,16 @@ base class ComplexMatrix extends Matrix { /// Computes the determinant of a 3x3 matrix Complex _compute3x3Determinant(ComplexMatrix source) { - final x = source.flattenData.first * + final x = + source.flattenData.first * ((source.flattenData[4] * source.flattenData[8]) - (source.flattenData[5] * source.flattenData[7])); - final y = source.flattenData[1] * + final y = + source.flattenData[1] * ((source.flattenData[3] * source.flattenData[8]) - (source.flattenData[5] * source.flattenData[6])); - final z = source.flattenData[2] * + final z = + source.flattenData[2] * ((source.flattenData[3] * source.flattenData[7]) - (source.flattenData[4] * source.flattenData[6])); @@ -707,29 +764,39 @@ base class ComplexMatrix extends Matrix { /// Computes the determinant of a 4x4 matrix Complex _compute4x4Determinant(ComplexMatrix source) { - final det2_01_01 = source.flattenData.first * source.flattenData[5] - + final det2_01_01 = + source.flattenData.first * source.flattenData[5] - source.flattenData[1] * source.flattenData[4]; - final det2_01_02 = source.flattenData.first * source.flattenData[6] - + final det2_01_02 = + source.flattenData.first * source.flattenData[6] - source.flattenData[2] * source.flattenData[4]; - final det2_01_03 = source.flattenData.first * source.flattenData[7] - + final det2_01_03 = + source.flattenData.first * source.flattenData[7] - source.flattenData[3] * source.flattenData[4]; - final det2_01_12 = source.flattenData[1] * source.flattenData[6] - + final det2_01_12 = + source.flattenData[1] * source.flattenData[6] - source.flattenData[2] * source.flattenData[5]; - final det2_01_13 = source.flattenData[1] * source.flattenData[7] - + final det2_01_13 = + source.flattenData[1] * source.flattenData[7] - source.flattenData[3] * source.flattenData[5]; - final det2_01_23 = source.flattenData[2] * source.flattenData[7] - + final det2_01_23 = + source.flattenData[2] * source.flattenData[7] - source.flattenData[3] * source.flattenData[6]; - final det3_201_012 = source.flattenData[8] * det2_01_12 - + final det3_201_012 = + source.flattenData[8] * det2_01_12 - source.flattenData[9] * det2_01_02 + source.flattenData[10] * det2_01_01; - final det3_201_013 = source.flattenData[8] * det2_01_13 - + final det3_201_013 = + source.flattenData[8] * det2_01_13 - source.flattenData[9] * det2_01_03 + source.flattenData[11] * det2_01_01; - final det3_201_023 = source.flattenData[8] * det2_01_23 - + final det3_201_023 = + source.flattenData[8] * det2_01_23 - source.flattenData[10] * det2_01_03 + source.flattenData[11] * det2_01_02; - final det3_201_123 = source.flattenData[9] * det2_01_23 - + final det3_201_123 = + source.flattenData[9] * det2_01_23 - source.flattenData[10] * det2_01_13 + source.flattenData[11] * det2_01_12; @@ -795,4 +862,7 @@ base class ComplexMatrix extends Matrix { return prodL * prodU; } + + @override + bool isZero() => flattenData.every((x) => x == const Complex.zero()); } diff --git a/lib/src/system/utils/matrix/decompositions/decomposition.dart b/lib/src/system/utils/matrix/decompositions/decomposition.dart index 204ea0d9..f154e460 100644 --- a/lib/src/system/utils/matrix/decompositions/decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/decomposition.dart @@ -3,22 +3,32 @@ import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_deco import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_decomposition.dart'; import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/single_value_decomposition.dart'; -/// Matrix decompositions, also knows as matrix factorizations, refer to a -/// family of algorithms that a factorize a matrix into a product of matrices. +/// {@template matrix_decomposition} +/// Matrix decompositions, also known as matrix factorizations, refer to a +/// family of algorithms that factorize a matrix into a product of matrices. +/// +/// Matrix decompositions are fundamental tools in linear algebra and numerical +/// analysis, used for solving systems of linear equations, computing matrix +/// inverses, finding eigenvalues, and many other applications. /// /// See also: /// -/// - [QRDecomposition] -/// - [SingleValueDecomposition] -/// - [EigenDecomposition] +/// - [QRDecomposition] - Decomposes a matrix into an orthogonal and upper +/// triangular matrix +/// - [SingleValueDecomposition] - Decomposes a matrix into singular values +/// and unitary matrices +/// - [EigenDecomposition] - Decomposes a matrix into eigenvalues and +/// eigenvectors +/// {@endtemplate} abstract base class Decomposition> { /// The matrix to be decomposed. final T matrix; - /// Creates an instance of [Decomposition] to factor the given [matrix]. - const Decomposition({ - required this.matrix, - }); + /// {@macro matrix_decomposition} + /// + /// The [matrix] parameter must be a valid matrix that can be decomposed + /// according to the specific decomposition algorithm being used. + const Decomposition({required this.matrix}); @override bool operator ==(Object other) { @@ -36,10 +46,22 @@ abstract base class Decomposition> { @override int get hashCode => matrix.hashCode; - @override - String toString() => '$matrix'; - - /// Factorizes [matrix] and returns, in order, the matrices to be multiplied - /// to obtain the original one. + /// Factorizes [matrix] and returns a list of matrices that, when multiplied + /// together in order, reconstruct the original matrix. + /// + /// The exact number and meaning of the returned matrices depends on the + /// specific decomposition algorithm. For example: + /// + /// - QR decomposition returns [Q, R] where Q is orthogonal and R is upper + /// triangular + /// - SVD returns [E, U, V] where E contains singular values, U and V are + /// unitary matrices + /// - Eigendecomposition returns [V, D, V^-1] where V contains eigenvectors + /// and D is a diagonal matrix of eigenvalues + /// + /// Returns a list of matrices that satisfy the decomposition equation. + /// + /// Throws a [MatrixException] if the matrix cannot be decomposed (e.g., if + /// it is singular or does not meet the requirements of the decomposition). List decompose(); } diff --git a/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_decomposition.dart b/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_decomposition.dart index 27dfd9d5..ff504554 100644 --- a/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_decomposition.dart @@ -6,27 +6,51 @@ import 'package:equations/src/system/utils/matrix/decompositions/decomposition.d /// of a matrix A into a product `A = V x D x V^-1` where: /// /// - V is a square matrix whose ith column is the eigenvector of A; -/// /// - D is the diagonal matrix whose diagonal elements are the corresponding -/// eigenvalues of A; -/// +/// eigenvalues of A; /// - V^-1 is the inverse of V. +/// +/// Eigendecomposition is only possible for diagonalizable matrices. For +/// symmetric matrices, the eigenvectors are orthogonal and the decomposition +/// is particularly stable. +/// {@endtemplate} +/// +/// {@template eigendecomposition_characteristics} +/// The implementation uses different algorithms depending on the matrix type: +/// +/// - **Symmetric matrices**: Uses Householder reduction to tridiagonal form, +/// followed by the QL algorithm for diagonalization +/// - **Non-symmetric matrices**: Uses Hessenberg reduction followed by +/// conversion to real Schur form /// {@endtemplate} abstract base class EigenDecomposition> extends Decomposition { - /// Creates a [EigenDecomposition] object. - const EigenDecomposition({ - required super.matrix, - }); + /// {@macro eigendecomposition_class_header} + /// + /// {@macro eigendecomposition_characteristics} + const EigenDecomposition({required super.matrix}); /// Computes the `V`, `D` and `V^-1` matrices of the eigendecomposition - /// algorithm. In particular, this method returns the `V`, `D and `V^-1` - /// matrices of the + /// algorithm. + /// + /// This method returns the matrices that satisfy the decomposition: /// /// - A = V x D x V^-1 /// - /// relation. The returned list contains `V` at index 0, `D` at index 1 and - /// `V^-1` at index 2. + /// where: + /// - V is the matrix of eigenvectors (each column is an eigenvector) + /// - D is the diagonal matrix of eigenvalues + /// - V^-1 is the inverse of V + /// + /// The returned list contains: + /// - `V` at index 0 + /// - `D` at index 1 + /// - `V^-1` at index 2 + /// + /// Returns a list of three matrices that satisfy the eigendecomposition. + /// + /// Throws a [MatrixException] if the matrix is not diagonalizable or if + /// numerical issues occur during the decomposition. @override List decompose(); } diff --git a/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_complex_decomposition.dart b/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_complex.dart similarity index 87% rename from lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_complex_decomposition.dart rename to lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_complex.dart index 385093c6..ffe06ce2 100644 --- a/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_complex_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_complex.dart @@ -8,12 +8,31 @@ import 'package:equations/src/utils/math_utils.dart'; /// {@macro eigendecomposition_class_header} /// /// This class performs the eigendecomposition on [ComplexMatrix] types. +/// +/// {@macro eigendecomposition_characteristics} +/// +/// This implementation handles complex eigenvalues and eigenvectors, which +/// may occur even for real matrices. The algorithm automatically detects +/// whether the matrix is symmetric and uses the appropriate method. +/// +/// Example: +/// ```dart +/// final matrix = ComplexMatrix.fromData( +/// rows: 2, +/// columns: 2, +/// data: [ +/// [Complex(1, 0), Complex(0, 1)], +/// [Complex(0, -1), Complex(1, 0)], +/// ], +/// ); +/// final decomposition = EigendecompositionComplex(matrix: matrix); +/// final [V, D, VInv] = decomposition.decompose(); +/// ``` final class EigendecompositionComplex - extends EigenDecomposition with MathUtils { - /// Requires the [matrix] matrix to be decomposed. - const EigendecompositionComplex({ - required super.matrix, - }); + extends EigenDecomposition + with MathUtils { + /// {@macro eigendecomposition_class_header} + const EigendecompositionComplex({required super.matrix}); @override List decompose() { @@ -99,14 +118,15 @@ final class EigendecompositionComplex ); // Returning the results. - return [ - V, - D, - V.inverse(), - ]; + return [V, D, V.inverse()]; } - /// Using Householder reduction to obtain the tridiagonal form. + /// Uses Householder reduction to transform a symmetric matrix to tridiagonal + /// form. + /// + /// This is the first step in the eigendecomposition of symmetric matrices. + /// The tridiagonal form simplifies the subsequent eigenvalue computation. + /// The method modifies the input arrays in place. void _tridiagonalForm({ required List realEigenvalues, required List complexEigenvalues, @@ -173,11 +193,7 @@ final class EigendecompositionComplex g = complexEigenvalues[j]; for (var k = j; k <= i - 1; k++) { final val = f * complexEigenvalues[k] + g * realEigenvalues[k]; - eigenVectors.set( - k, - j, - eigenVectors.get(k, j) - val, - ); + eigenVectors.set(k, j, eigenVectors.get(k, j) - val); } realEigenvalues[j] = eigenVectors.get(i - 1, j); eigenVectors.set(i, j, const Complex.zero()); @@ -225,8 +241,12 @@ final class EigendecompositionComplex complexEigenvalues.first = const Complex.zero(); } - /// Applying the tridiagonal QL algorithm, which is an efficient method to - /// find eigenvalues of a matrix. + /// Applies the tridiagonal QL algorithm to find eigenvalues and eigenvectors. + /// + /// This is an efficient iterative method for computing eigenvalues of a + /// tridiagonal matrix. The algorithm uses implicit shifts and Givens + /// rotations to converge to the eigenvalues. The eigenvectors are updated + /// throughout the process. void _qlTridiagonal({ required List realEigenvalues, required List complexEigenvalues, @@ -261,7 +281,8 @@ final class EigendecompositionComplex do { // Computing the implicit shift. var g = realEigenvalues[l]; - var p = (realEigenvalues[l + 1] - g) / + var p = + (realEigenvalues[l + 1] - g) / (const Complex.fromReal(2) * complexEigenvalues[l]); var r = complexHypot(p, const Complex.fromReal(1)); if (p < const Complex.zero()) { @@ -336,7 +357,12 @@ final class EigendecompositionComplex } } - /// Nonsymmetric reduction to the Hessenberg form. + /// Reduces a non-symmetric matrix to Hessenberg form using Householder + /// transformations. + /// + /// Hessenberg form is an intermediate step that simplifies eigenvalue + /// computation for non-symmetric matrices. A matrix in Hessenberg form has + /// zeros below the first subdiagonal. void _nonsymmetricHessReduction({ required List> hessenbergCache, required List hessenbergValues, @@ -443,7 +469,12 @@ final class EigendecompositionComplex } } - /// Nonsymmetric reduction from the Hessenbergform to the real Schur form. + /// Reduces a matrix from Hessenberg form to real Schur form. + /// + /// The real Schur form is an upper quasi-triangular matrix that reveals the + /// eigenvalues. This method uses the QR algorithm with shifts to iteratively + /// converge to the Schur form. The eigenvectors are accumulated during the + /// transformation process. void _hessenbergToSchur({ required List realEigenvalues, required List complexEigenvalues, @@ -502,17 +533,14 @@ final class EigendecompositionComplex } else if (l == n - 1) { // CASE 2: 2 roots found. w = hessenbergCache.get(n, n - 1) * hessenbergCache.get(n - 1, n); - p = (hessenbergCache.get(n - 1, n - 1) - hessenbergCache.get(n, n)) / + p = + (hessenbergCache.get(n - 1, n - 1) - hessenbergCache.get(n, n)) / const Complex.fromReal(2); q = p * p + w; z = q.sqrt(); hessenbergCache ..set(n, n, hessenbergCache.get(n, n) + exshift) - ..set( - n - 1, - n - 1, - hessenbergCache.get(n - 1, n - 1) + exshift, - ); + ..set(n - 1, n - 1, hessenbergCache.get(n - 1, n - 1) + exshift); x = hessenbergCache.get(n, n); // Real roots. @@ -541,11 +569,7 @@ final class EigendecompositionComplex for (var j = n - 1; j < nn; j++) { z = hessenbergCache.get(n - 1, j); hessenbergCache - ..set( - n - 1, - j, - q * z + p * hessenbergCache.get(n, j), - ) + ..set(n - 1, j, q * z + p * hessenbergCache.get(n, j)) ..set(n, j, q * hessenbergCache.get(n, j) - p * z); } @@ -553,11 +577,7 @@ final class EigendecompositionComplex for (var i = 0; i <= n; i++) { z = hessenbergCache.get(i, n - 1); hessenbergCache - ..set( - i, - n - 1, - q * z + p * hessenbergCache.get(i, n), - ) + ..set(i, n - 1, q * z + p * hessenbergCache.get(i, n)) ..set(i, n, q * hessenbergCache.get(i, n) - p * z); } @@ -621,7 +641,8 @@ final class EigendecompositionComplex z = hessenbergCache.get(m, m); r = x - z; s = y - z; - p = (r * s - w) / hessenbergCache.get(m + 1, m) + + p = + (r * s - w) / hessenbergCache.get(m + 1, m) + hessenbergCache.get(m, m + 1); q = hessenbergCache.get(m + 1, m + 1) - z - r - s; r = hessenbergCache.get(m + 2, m + 1); @@ -698,15 +719,12 @@ final class EigendecompositionComplex } hessenbergCache ..set(k, j, hessenbergCache.get(k, j) - p * x) - ..set( - k + 1, - j, - hessenbergCache.get(k + 1, j) - p * y, - ); + ..set(k + 1, j, hessenbergCache.get(k + 1, j) - p * y); } for (var i = 0; i <= math.min(n, k + 3); i++) { - p = x * hessenbergCache.get(i, k) + + p = + x * hessenbergCache.get(i, k) + y * hessenbergCache.get(i, k + 1); if (notlast) { p = p + z * hessenbergCache.get(i, k + 2); @@ -718,11 +736,7 @@ final class EigendecompositionComplex } hessenbergCache ..set(i, k, hessenbergCache.get(i, k) - p) - ..set( - i, - k + 1, - hessenbergCache.get(i, k + 1) - p * q, - ); + ..set(i, k + 1, hessenbergCache.get(i, k + 1) - p * q); } for (var i = low; i <= high; i++) { @@ -773,7 +787,8 @@ final class EigendecompositionComplex } else { x = hessenbergCache.get(i, i + 1); y = hessenbergCache.get(i + 1, i); - q = (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + + q = + (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + complexEigenvalues[i] * complexEigenvalues[i]; t = (x * s - z * r) / q; hessenbergCache.set(i, n, t); @@ -835,19 +850,15 @@ final class EigendecompositionComplex } else { l = i; if (complexEigenvalues[i] == const Complex.zero()) { - final division = _complexDiv( - -ra.real, - -sa.real, - w.real, - q.real, - ); + final division = _complexDiv(-ra.real, -sa.real, w.real, q.real); hessenbergCache ..set(i, n - 1, Complex.fromReal(division.real)) ..set(i, n, Complex.fromReal(division.imaginary)); } else { x = hessenbergCache.get(i, i + 1); y = hessenbergCache.get(i + 1, i); - vr = (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + + vr = + (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + complexEigenvalues[i] * complexEigenvalues[i] - q * q; vi = (realEigenvalues[i] - p) * const Complex.fromReal(2) * q; @@ -886,16 +897,8 @@ final class EigendecompositionComplex q.real, ); hessenbergCache - ..set( - i + 1, - n - 1, - Complex.fromReal(division.real), - ) - ..set( - i + 1, - n, - Complex.fromReal(division.imaginary), - ); + ..set(i + 1, n - 1, Complex.fromReal(division.real)) + ..set(i + 1, n, Complex.fromReal(division.imaginary)); } } @@ -908,11 +911,7 @@ final class EigendecompositionComplex if ((eps * t) * t > const Complex.fromReal(1)) { for (var j = i; j <= n; j++) { hessenbergCache - ..set( - j, - n - 1, - hessenbergCache.get(j, n - 1) / t, - ) + ..set(j, n - 1, hessenbergCache.get(j, n - 1) / t) ..set(j, n, hessenbergCache.get(j, n) / t); } } diff --git a/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_real_decomposition.dart b/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_real.dart similarity index 86% rename from lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_real_decomposition.dart rename to lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_real.dart index 947aa045..e38bb211 100644 --- a/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_real_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_real.dart @@ -8,20 +8,36 @@ import 'package:equations/src/utils/math_utils.dart'; /// {@macro eigendecomposition_class_header} /// /// This class performs the eigendecomposition on [RealMatrix] types. +/// +/// {@macro eigendecomposition_characteristics} +/// +/// For real matrices, eigenvalues and eigenvectors may be complex even if the +/// input matrix is real. This implementation handles such cases by storing +/// complex values appropriately. +/// +/// Example: +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 2, +/// columns: 2, +/// data: [ +/// [1, 2], +/// [3, 4], +/// ], +/// ); +/// final decomposition = EigendecompositionReal(matrix: matrix); +/// final [V, D, VInv] = decomposition.decompose(); +/// ``` final class EigendecompositionReal - extends EigenDecomposition with MathUtils { - /// Requires the [matrix] matrix to be decomposed. - const EigendecompositionReal({ - required super.matrix, - }); + extends EigenDecomposition + with MathUtils { + /// {@macro eigendecomposition_class_header} + const EigendecompositionReal({required super.matrix}); @override List decompose() { // Variables setup - final realEigenvalues = List.generate( - matrix.rowCount, - (_) => 0.0, - ); + final realEigenvalues = List.generate(matrix.rowCount, (_) => 0.0); final complexEigenvalues = List.generate( matrix.rowCount, (_) => 0.0, @@ -69,10 +85,7 @@ final class EigendecompositionReal // Now there's just the need to build 'Q' and 'V'. final dataMatrixD = List>.generate( matrix.rowCount, - (_) => List.generate( - matrix.columnCount, - (_) => 0, - ), + (_) => List.generate(matrix.columnCount, (_) => 0), ); for (var i = 0; i < matrix.rowCount; ++i) { @@ -99,14 +112,15 @@ final class EigendecompositionReal ); // Returning the results. - return [ - V, - D, - V.inverse(), - ]; + return [V, D, V.inverse()]; } - /// Using Householder reduction to obtain the tridiagonal form. + /// Uses Householder reduction to transform a symmetric matrix to tridiagonal + /// form. + /// + /// This is the first step in the eigendecomposition of symmetric matrices. + /// The tridiagonal form simplifies the subsequent eigenvalue computation. + /// The method modifies the input arrays in place. void _tridiagonalForm({ required List realEigenvalues, required List complexEigenvalues, @@ -173,11 +187,7 @@ final class EigendecompositionReal g = complexEigenvalues[j]; for (var k = j; k <= i - 1; k++) { final val = f * complexEigenvalues[k] + g * realEigenvalues[k]; - eigenVectors.set( - k, - j, - eigenVectors.get(k, j) - val, - ); + eigenVectors.set(k, j, eigenVectors.get(k, j) - val); } realEigenvalues[j] = eigenVectors.get(i - 1, j); eigenVectors.set(i, j, 0); @@ -221,8 +231,12 @@ final class EigendecompositionReal complexEigenvalues.first = 0.0; } - /// Applying the tridiagonal QL algorithm, which is an efficient method to - /// find eigenvalues of a matrix. + /// Applies the tridiagonal QL algorithm to find eigenvalues and eigenvectors. + /// + /// This is an efficient iterative method for computing eigenvalues of a + /// tridiagonal matrix. The algorithm uses implicit shifts and Givens + /// rotations to converge to the eigenvalues. The eigenvectors are updated + /// throughout the process. void _qlTridiagonal({ required List realEigenvalues, required List complexEigenvalues, @@ -329,7 +343,12 @@ final class EigendecompositionReal } } - /// Nonsymmetric reduction to the Hessenberg form. + /// Reduces a non-symmetric matrix to Hessenberg form using Householder + /// transformations. + /// + /// Hessenberg form is an intermediate step that simplifies eigenvalue + /// computation for non-symmetric matrices. A matrix in Hessenberg form has + /// zeros below the first subdiagonal. void _nonsymmetricHessReduction({ required List> hessenbergCache, required List hessenbergValues, @@ -432,7 +451,12 @@ final class EigendecompositionReal } } - /// Nonsymmetric reduction from the Hessenbergform to the real Schur form. + /// Reduces a matrix from Hessenberg form to real Schur form. + /// + /// The real Schur form is an upper quasi-triangular matrix that reveals the + /// eigenvalues. This method uses the QR algorithm with shifts to iteratively + /// converge to the Schur form. The eigenvectors are accumulated during the + /// transformation process. void _hessenbergToSchur({ required List realEigenvalues, required List complexEigenvalues, @@ -471,7 +495,8 @@ final class EigendecompositionReal // Looking for single small sub-diagonal elements. var l = n; while (l > low) { - s = hessenbergCache.get(l - 1, l - 1).abs() + + s = + hessenbergCache.get(l - 1, l - 1).abs() + hessenbergCache.get(l, l).abs(); if (s == 0.0) { s = norm; @@ -492,17 +517,14 @@ final class EigendecompositionReal } else if (l == n - 1) { // CASE 2: 2 roots found. w = hessenbergCache.get(n, n - 1) * hessenbergCache.get(n - 1, n); - p = (hessenbergCache.get(n - 1, n - 1) - hessenbergCache.get(n, n)) / + p = + (hessenbergCache.get(n - 1, n - 1) - hessenbergCache.get(n, n)) / 2.0; q = p * p + w; z = math.sqrt(q.abs()); hessenbergCache ..set(n, n, hessenbergCache.get(n, n) + exshift) - ..set( - n - 1, - n - 1, - hessenbergCache.get(n - 1, n - 1) + exshift, - ); + ..set(n - 1, n - 1, hessenbergCache.get(n - 1, n - 1) + exshift); x = hessenbergCache.get(n, n); // Real roots. @@ -531,11 +553,7 @@ final class EigendecompositionReal for (var j = n - 1; j < nn; j++) { z = hessenbergCache.get(n - 1, j); hessenbergCache - ..set( - n - 1, - j, - q * z + p * hessenbergCache.get(n, j), - ) + ..set(n - 1, j, q * z + p * hessenbergCache.get(n, j)) ..set(n, j, q * hessenbergCache.get(n, j) - p * z); } @@ -543,11 +561,7 @@ final class EigendecompositionReal for (var i = 0; i <= n; i++) { z = hessenbergCache.get(i, n - 1); hessenbergCache - ..set( - i, - n - 1, - q * z + p * hessenbergCache.get(i, n), - ) + ..set(i, n - 1, q * z + p * hessenbergCache.get(i, n)) ..set(i, n, q * hessenbergCache.get(i, n) - p * z); } @@ -582,7 +596,8 @@ final class EigendecompositionReal for (var i = low; i <= n; i++) { hessenbergCache.set(i, i, hessenbergCache.get(i, i) - x); } - s = hessenbergCache.get(n, n - 1).abs() + + s = + hessenbergCache.get(n, n - 1).abs() + hessenbergCache.get(n - 1, n - 2).abs(); x = y = s * 0.75; w = -0.4375 * s * s; @@ -612,7 +627,8 @@ final class EigendecompositionReal z = hessenbergCache.get(m, m); r = x - z; s = y - z; - p = (r * s - w) / hessenbergCache.get(m + 1, m) + + p = + (r * s - w) / hessenbergCache.get(m + 1, m) + hessenbergCache.get(m, m + 1); q = hessenbergCache.get(m + 1, m + 1) - z - r - s; r = hessenbergCache.get(m + 2, m + 1); @@ -687,15 +703,12 @@ final class EigendecompositionReal } hessenbergCache ..set(k, j, hessenbergCache.get(k, j) - p * x) - ..set( - k + 1, - j, - hessenbergCache.get(k + 1, j) - p * y, - ); + ..set(k + 1, j, hessenbergCache.get(k + 1, j) - p * y); } for (var i = 0; i <= math.min(n, k + 3); i++) { - p = x * hessenbergCache.get(i, k) + + p = + x * hessenbergCache.get(i, k) + y * hessenbergCache.get(i, k + 1); if (notlast) { p = p + z * hessenbergCache.get(i, k + 2); @@ -707,11 +720,7 @@ final class EigendecompositionReal } hessenbergCache ..set(i, k, hessenbergCache.get(i, k) - p) - ..set( - i, - k + 1, - hessenbergCache.get(i, k + 1) - p * q, - ); + ..set(i, k + 1, hessenbergCache.get(i, k + 1) - p * q); } for (var i = low; i <= high; i++) { @@ -762,7 +771,8 @@ final class EigendecompositionReal } else { x = hessenbergCache.get(i, i + 1); y = hessenbergCache.get(i + 1, i); - q = (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + + q = + (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + complexEigenvalues[i] * complexEigenvalues[i]; t = (x * s - z * r) / q; hessenbergCache.set(i, n, t); @@ -833,12 +843,14 @@ final class EigendecompositionReal } else { x = hessenbergCache.get(i, i + 1); y = hessenbergCache.get(i + 1, i); - vr = (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + + vr = + (realEigenvalues[i] - p) * (realEigenvalues[i] - p) + complexEigenvalues[i] * complexEigenvalues[i] - q * q; vi = (realEigenvalues[i] - p) * 2.0 * q; if (vr == 0.0 && vi == 0.0) { - vr = eps * + vr = + eps * norm * (w.abs() + q.abs() + x.abs() + y.abs() + z.abs()); } @@ -886,11 +898,7 @@ final class EigendecompositionReal if ((eps * t) * t > 1) { for (var j = i; j <= n; j++) { hessenbergCache - ..set( - j, - n - 1, - hessenbergCache.get(j, n - 1) / t, - ) + ..set(j, n - 1, hessenbergCache.get(j, n - 1) / t) ..set(j, n, hessenbergCache.get(j, n) / t); } } diff --git a/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart b/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart index e9eecc3e..e50793b8 100644 --- a/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart @@ -1,17 +1,40 @@ +import 'dart:math' as math; import 'package:equations/equations.dart'; import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_decomposition.dart'; /// {@macro qr_decomposition_class_header} /// /// This class performs the QR decomposition on [ComplexMatrix] types. +/// +/// The implementation uses Householder reflections with special handling for +/// complex numbers to ensure numerical stability. The algorithm computes the +/// 2-norm of columns using a numerically stable method to avoid overflow and +/// underflow issues. +/// +/// Example: +/// ```dart +/// final matrix = ComplexMatrix.fromData( +/// rows: 3, +/// columns: 2, +/// data: [ +/// [Complex(1, 0), Complex(2, 1)], +/// [Complex(3, -1), Complex(4, 0)], +/// [Complex(5, 2), Complex(6, -1)], +/// ], +/// ); +/// final decomposition = QRDecompositionComplex(matrix: matrix); +/// final [Q, R] = decomposition.decompose(); +/// ``` final class QRDecompositionComplex extends QRDecomposition { + /// Zero complex number constant. static const _zero = Complex.zero(); - /// Requires the [matrix] matrix to be decomposed. - const QRDecompositionComplex({ - required super.matrix, - }); + /// Small value for numerical stability checks. + static const _epsilon = 1e-10; + + /// {@macro qr_decomposition_class_header} + const QRDecompositionComplex({required super.matrix}); @override List decompose() { @@ -21,35 +44,38 @@ final class QRDecompositionComplex final diagonal = List.generate(columns, (index) => _zero); for (var k = 0; k < columns; k++) { - // Compute 2-norm of k-th column. + // Compute 2-norm of k-th column using a more stable method var nrm = _zero; for (var i = k; i < rows; i++) { - nrm = _complexSideLen(nrm, matrixQR[i][k]); + nrm = _complexNorm(nrm, matrixQR[i][k]); } - if (nrm != _zero) { - // Form k-th Householder vector. - for (var i = k; i < rows; i++) { - matrixQR[i][k] /= nrm; - } + // Check for numerical stability + if (nrm.abs() < _epsilon) { + throw const MatrixException('Matrix is numerically singular'); + } - matrixQR[k][k] += const Complex.fromReal(1); + // Form k-th Householder vector + for (var i = k; i < rows; i++) { + matrixQR[i][k] /= nrm; + } - // Apply transformation to remaining columns. - for (var j = k + 1; j < columns; j++) { - var s = _zero; + matrixQR[k][k] += const Complex.fromReal(1); - for (var i = k; i < rows; i++) { - s += matrixQR[i][k] * matrixQR[i][j]; - } + // Apply transformation to remaining columns + for (var j = k + 1; j < columns; j++) { + var s = _zero; - if (matrixQR[k][k] != const Complex.zero()) { - s = -s / matrixQR[k][k]; - } + for (var i = k; i < rows; i++) { + s += matrixQR[i][k] * matrixQR[i][j]; + } - for (var i = k; i < rows; i++) { - matrixQR[i][j] += s * matrixQR[i][k]; - } + if (matrixQR[k][k].abs() > _epsilon) { + s = -s / matrixQR[k][k]; + } + + for (var i = k; i < rows; i++) { + matrixQR[i][j] += s * matrixQR[i][k]; } } @@ -59,10 +85,7 @@ final class QRDecompositionComplex // Computing the 'R' matrix final R = List>.generate( columns, - (index) => List.generate( - columns, - (index) => _zero, - ), + (index) => List.generate(columns, (index) => _zero), ); for (var i = 0; i < columns; i++) { @@ -82,10 +105,7 @@ final class QRDecompositionComplex // Get Q final Q = List>.generate( rows, - (index) => List.generate( - columns, - (index) => _zero, - ), + (index) => List.generate(columns, (index) => _zero), ); for (var k = columns - 1; k >= 0; k--) { @@ -96,7 +116,7 @@ final class QRDecompositionComplex Q[k][k] = const Complex.fromReal(1); for (var j = k; j < columns; j++) { - if (matrixQR[k][k] != _zero) { + if (matrixQR[k][k].abs() > _epsilon) { var s = _zero; for (var i = k; i < rows; i++) { @@ -119,5 +139,22 @@ final class QRDecompositionComplex ]; } - Complex _complexSideLen(Complex a, Complex b) => (a.pow(2) + b.pow(2)).sqrt(); + /// Computes the norm of a complex number in a numerically stable way. + /// + /// This method computes sqrt(|a|² + |b|²) using a scaling approach to + /// prevent overflow and underflow when dealing with very large or very small + /// complex numbers. + /// + /// Returns the norm as a [Complex] number. + Complex _complexNorm(Complex a, Complex b) { + final aAbs = a.abs(); + final bAbs = b.abs(); + if (aAbs > bAbs) { + return a * Complex.fromReal(math.sqrt(1 + math.pow(bAbs / aAbs, 2))); + } else if (bAbs > 0) { + return b * Complex.fromReal(math.sqrt(math.pow(aAbs / bAbs, 2) + 1)); + } else { + return _zero; + } + } } diff --git a/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_decomposition.dart b/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_decomposition.dart index 5191339f..0e74ce6f 100644 --- a/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_decomposition.dart @@ -5,23 +5,42 @@ import 'package:equations/src/system/utils/matrix/decompositions/decomposition.d /// QR decomposition, also known as a QR factorization or QU factorization, is /// a decomposition of a matrix A into a product `A = QR` of: /// -/// - an orthogonal matrix Q; -/// +/// - an orthogonal matrix Q (where Q^T Q = I); /// - an upper triangular matrix R. +/// +/// QR decomposition is widely used for solving linear systems, least squares +/// problems, and computing eigenvalues. The decomposition is unique if the +/// matrix has full column rank and R has positive diagonal entries. +/// +/// The algorithm uses Householder reflections to compute the decomposition, +/// which provides good numerical stability. /// {@endtemplate} abstract base class QRDecomposition> extends Decomposition { - /// Creates a [QRDecomposition] object. - const QRDecomposition({ - required super.matrix, - }); + /// {@macro qr_decomposition_class_header} + /// + /// The [matrix] can be any rectangular matrix. For best results, the matrix + /// should have full column rank. + const QRDecomposition({required super.matrix}); - /// Computes the `Q` and `R` matrices of the QR decomposition algorithm. In - /// particular, this method returns the `Q` and `R` matrices of the + /// Computes the `Q` and `R` matrices of the QR decomposition algorithm. + /// + /// This method returns the matrices that satisfy the decomposition: /// /// - A = Q x R /// - /// relation. The returned list contains `Q` at index 0 and `R` at index 1. + /// where: + /// - Q is an orthogonal matrix (Q^T Q = I) + /// - R is an upper triangular matrix + /// + /// The returned list contains: + /// - `Q` at index 0 + /// - `R` at index 1 + /// + /// Returns a list of two matrices that satisfy the QR decomposition. + /// + /// Throws a [MatrixException] if the matrix is numerically singular or if + /// numerical issues occur during the decomposition. @override List decompose(); } diff --git a/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart b/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart index b66d6272..ed8c3fc4 100644 --- a/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart @@ -5,12 +5,32 @@ import 'package:equations/src/utils/math_utils.dart'; /// {@macro qr_decomposition_class_header} /// /// This class performs the QR decomposition on [RealMatrix] types. +/// +/// The implementation uses Householder reflections to compute the +/// decomposition. The algorithm is numerically stable and handles edge cases +/// such as zero columns and near-singular matrices. +/// +/// Example: +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 3, +/// columns: 2, +/// data: [ +/// [1, 2], +/// [3, 4], +/// [5, 6], +/// ], +/// ); +/// final decomposition = QRDecompositionReal(matrix: matrix); +/// final [Q, R] = decomposition.decompose(); +/// ``` final class QRDecompositionReal extends QRDecomposition with MathUtils { - /// Requires the [matrix] matrix to be decomposed. - const QRDecompositionReal({ - required super.matrix, - }); + /// Small value for numerical stability checks. + static const _epsilon = 1e-10; + + /// {@macro qr_decomposition_class_header} + const QRDecompositionReal({required super.matrix}); @override List decompose() { @@ -20,14 +40,14 @@ final class QRDecompositionReal extends QRDecomposition final diagonal = List.generate(columns, (index) => 0.0); for (var k = 0; k < columns; k++) { - // Compute 2-norm of k-th column. + // Compute 2-norm of k-th column var nrm = 0.0; for (var i = k; i < rows; i++) { nrm = hypot(nrm, matrixQR[i][k]); } - if (nrm != 0.0) { - // Form k-th Householder vector. + if (nrm > _epsilon) { + // Form k-th Householder vector if (matrixQR[k][k] < 0) { nrm = -nrm; } @@ -38,7 +58,7 @@ final class QRDecompositionReal extends QRDecomposition matrixQR[k][k] += 1.0; - // Apply transformation to remaining columns. + // Apply transformation to remaining columns for (var j = k + 1; j < columns; j++) { var s = 0.0; @@ -46,7 +66,7 @@ final class QRDecompositionReal extends QRDecomposition s += matrixQR[i][k] * matrixQR[i][j]; } - if (matrixQR[k][k] != 0) { + if (matrixQR[k][k] > _epsilon) { s = -s / matrixQR[k][k]; } @@ -69,17 +89,13 @@ final class QRDecompositionReal extends QRDecomposition for (var j = 0; j < columns; j++) { if (i < j) { R[i][j] = matrixQR[i][j]; - } else { - if (i == j) { - R[i][j] = diagonal[i]; - } else { - R[i][j] = 0.0; - } + } else if (i == j) { + R[i][j] = diagonal[i]; } } } - // Get Q + // Get Q through backward accumulation final Q = List>.generate( rows, (index) => List.generate(columns, (index) => 0.0), @@ -93,7 +109,7 @@ final class QRDecompositionReal extends QRDecomposition Q[k][k] = 1.0; for (var j = k; j < columns; j++) { - if (matrixQR[k][k] != 0) { + if (matrixQR[k][k] > _epsilon) { var s = 0.0; for (var i = k; i < rows; i++) { @@ -109,7 +125,6 @@ final class QRDecompositionReal extends QRDecomposition } } - // Returning Q and R return [ RealMatrix.fromData(rows: rows, columns: columns, data: Q), RealMatrix.fromData(rows: columns, columns: columns, data: R), diff --git a/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/single_value_decomposition.dart b/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/single_value_decomposition.dart index ebdeffda..04a46397 100644 --- a/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/single_value_decomposition.dart +++ b/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/single_value_decomposition.dart @@ -2,29 +2,56 @@ import 'package:equations/equations.dart'; import 'package:equations/src/system/utils/matrix/decompositions/decomposition.dart'; /// {@template svd_class_header} -/// Single Value Decomposition decomposition, also known as a SVD, is a -/// decomposition of a matrix A into a product `A = U x E x Vt` of: +/// Singular Value Decomposition (SVD) is a decomposition of a matrix A into +/// a product `A = U x E x V^T` of: /// -/// - a square unitary matrix U; +/// - a unitary matrix U (left singular vectors); +/// - a rectangular diagonal matrix E with non-negative singular values on +/// the diagonal (ordered from largest to smallest); +/// - a unitary matrix V (right singular vectors), where V^T is the transpose. /// -/// - a rectangular diagonal matrix E with positive values on the diagonal; +/// The algorithm follows these steps: /// -/// - a square unitary matrix V. +/// 1. Bidiagonalization of the input matrix using Householder reflections +/// 2. Generation of U matrix from accumulated transformations +/// 3. Generation of V matrix from accumulated transformations +/// 4. Iterative refinement of singular values using QR-like iterations +/// +/// Numerical stability is maintained using epsilon values and proper handling +/// of edge cases. The singular values are computed iteratively until +/// convergence. /// {@endtemplate} abstract base class SingleValueDecomposition> extends Decomposition { - /// Creates an [SingleValueDecomposition] object. - const SingleValueDecomposition({ - required super.matrix, - }); + /// {@macro svd_class_header} + /// + /// The [matrix] can be any rectangular matrix. SVD always exists for any + /// matrix, unlike some other decompositions. + const SingleValueDecomposition({required super.matrix}); - /// Computes the `E`, `U` and `V` matrices of the SVD algorithm. In particular - /// this method returns the `E`, `U` and `V` matrices of the + /// Computes the `E`, `U` and `V` matrices of the SVD algorithm. + /// + /// This method returns the matrices that satisfy the decomposition: + /// + /// - A = U x E x V^T + /// + /// where: + /// - U is a unitary matrix containing the left singular vectors + /// - E is a rectangular diagonal matrix with singular values on the diagonal + /// (ordered from largest to smallest) + /// - V is a unitary matrix containing the right singular vectors + /// - V^T is the transpose of V + /// + /// The returned list contains: + /// - `E` at index 0 (the singular value matrix) + /// - `U` at index 1 (left singular vectors) + /// - `V` at index 2 (right singular vectors, not transposed) /// - /// - A = U x E x Vt + /// Returns a list of three matrices that satisfy the SVD decomposition. /// - /// relation, where 'Vt' is the transposed of V. The returned list contains - /// `E` at index 0, `U` at index 1 and `V` at index 2. + /// Throws an [ArgumentError] if the matrix dimensions are invalid, or an + /// [Exception] if the SVD algorithm fails to converge or encounters + /// numerical issues. @override List decompose(); } diff --git a/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/complex_svd.dart b/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_complex.dart similarity index 68% rename from lib/src/system/utils/matrix/decompositions/singular_value_decomposition/complex_svd.dart rename to lib/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_complex.dart index 85dc1472..fd69bb39 100644 --- a/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/complex_svd.dart +++ b/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_complex.dart @@ -4,19 +4,54 @@ import 'package:equations/equations.dart'; import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/single_value_decomposition.dart'; import 'package:equations/src/utils/math_utils.dart'; -/// {@macro svd_class_header} +/// {@macro svd_class_header} /// /// This class performs the SVD procedure on [ComplexMatrix] types. +/// +/// The implementation handles complex numbers throughout the decomposition +/// process. The algorithm uses complex arithmetic for all operations and +/// properly handles complex singular values and vectors. +/// +/// The convergence criteria and numerical stability checks are adapted for +/// complex number operations. The algorithm includes a maximum iteration limit +/// to prevent infinite loops in pathological cases. +/// +/// Example: +/// ```dart +/// final matrix = ComplexMatrix.fromData( +/// rows: 2, +/// columns: 3, +/// data: [ +/// [Complex(1, 0), Complex(2, 1), Complex(3, -1)], +/// [Complex(4, 1), Complex(5, 0), Complex(6, 2)], +/// ], +/// ); +/// final decomposition = SVDComplex(matrix: matrix); +/// final [E, U, V] = decomposition.decompose(); +/// ``` final class SVDComplex extends SingleValueDecomposition with MathUtils { - /// Requires the [matrix] matrix to be decomposed. - const SVDComplex({ - required super.matrix, - }); + /// Epsilon value for numerical stability in complex operations. + static const _epsilon = 1e-10; + + /// Tiny value threshold for very small numbers. + static const _tiny = 1e-300; - /// Reduces the source matrix a to bidiagonal form. + /// Maximum number of iterations allowed for convergence. + static const _maxIterations = 1000; + + /// {@macro svd_class_header} + const SVDComplex({required super.matrix}); + + /// Reduces the source matrix to bidiagonal form using Householder + /// reflections. /// - /// This is required for the computation of `U` and `V`. + /// This is the first step of the SVD algorithm and is required for the + /// computation of `U` and `V`. The bidiagonal form simplifies the + /// subsequent iterative refinement of singular values. + /// + /// The method modifies the input matrices in place and populates the + /// arrays with the necessary transformation data. void _bidiagonalForm({ required List> sourceMatrix, required List> matrixU, @@ -37,19 +72,28 @@ final class SVDComplex extends SingleValueDecomposition arrayS[k] = complexHypot(arrayS[k], sourceMatrix[i][k]); } - if (arrayS[k] != const Complex.zero()) { + if (arrayS[k].abs() > _epsilon) { + // Handle sign based on complex number properties + if (sourceMatrix[k][k].real < 0 || + (sourceMatrix[k][k].real == 0 && + sourceMatrix[k][k].imaginary < 0)) { + arrayS[k] = -arrayS[k]; + } + // Dividing each by the k-th element of the values array. for (var i = k; i < matrix.rowCount; i++) { sourceMatrix[i][k] /= arrayS[k]; } sourceMatrix[k][k] += const Complex.fromReal(1); + } else { + throw Exception('Matrix is numerically singular'); } arrayS[k] = -arrayS[k]; } for (var j = k + 1; j < matrix.columnCount; j++) { // Applying the transformation making sure that s[k] is NOT zero. - if ((k < nct) && (arrayS[k] != const Complex.zero())) { + if ((k < nct) && (arrayS[k].abs() > _epsilon)) { var t = const Complex.zero(); for (var i = k; i < matrix.rowCount; i++) { t += sourceMatrix[i][k] * sourceMatrix[i][j]; @@ -81,17 +125,19 @@ final class SVDComplex extends SingleValueDecomposition arrayE[k] = complexHypot(arrayE[k], arrayE[i]); } - if (arrayE[k] != const Complex.zero()) { + if (arrayE[k].abs() > _epsilon) { for (var i = k + 1; i < matrix.columnCount; i++) { arrayE[i] /= arrayE[k]; } arrayE[k + 1] += const Complex.fromReal(1); + } else { + throw Exception('Matrix is numerically singular'); } arrayE[k] = -arrayE[k]; // Starting the transformation process. - if ((k + 1 < matrix.rowCount) && (arrayE[k] != const Complex.zero())) { + if ((k + 1 < matrix.rowCount) && (arrayE[k].abs() > _epsilon)) { for (var i = k + 1; i < matrix.rowCount; i++) { helperArray[i] = const Complex.zero(); } @@ -131,7 +177,12 @@ final class SVDComplex extends SingleValueDecomposition arrayE[p - 1] = const Complex.zero(); } - /// Generation of the `U` from a bidiagonal source. + /// Generates the `U` matrix from the bidiagonal transformation data. + /// + /// This method reconstructs the left singular vectors by accumulating the + /// Householder transformations applied during bidiagonalization. The + /// resulting matrix U is unitary (U^H U = I, where H denotes conjugate + /// transpose). void _generateU({ required List> matrixU, required List arrayS, @@ -139,7 +190,7 @@ final class SVDComplex extends SingleValueDecomposition final maxRowCol = max(matrix.rowCount, matrix.columnCount); final nct = min(matrix.rowCount - 1, matrix.columnCount); - // Generaton of U based on the previous transformations. Works with square + // Generation of U based on the previous transformations. Works with square // and rectangular matrices. for (var j = nct; j < maxRowCol; j++) { for (var i = 0; i < matrix.rowCount; i++) { @@ -152,7 +203,7 @@ final class SVDComplex extends SingleValueDecomposition } for (var k = nct - 1; k >= 0; k--) { - if (arrayS[k] != const Complex.zero()) { + if (arrayS[k].abs() > _epsilon) { for (var j = k + 1; j < maxRowCol; j++) { var t = const Complex.zero(); for (var i = k; i < matrix.rowCount; i++) { @@ -171,15 +222,22 @@ final class SVDComplex extends SingleValueDecomposition matrixU[i][k] = const Complex.zero(); } } else { + //coverage:ignore-start for (var i = 0; i < matrix.rowCount; i++) { matrixU[i][k] = const Complex.zero(); } matrixU[k][k] = const Complex.fromReal(1); + //coverage:ignore-end } } } - /// Generation of the `V` from a bidiagonal source. + /// Generates the `V` matrix from the bidiagonal transformation data. + /// + /// This method reconstructs the right singular vectors by accumulating the + /// Householder transformations applied during bidiagonalization. The + /// resulting matrix V is unitary (V^H V = I, where H denotes conjugate + /// transpose). void _generateV({ required List> matrixV, required List arrayE, @@ -189,7 +247,7 @@ final class SVDComplex extends SingleValueDecomposition // Generation of V based on the previous transformations. Works with square // and rectangular matrices. for (var k = matrix.columnCount - 1; k >= 0; k--) { - if ((k < nrt) && (arrayE[k] != const Complex.zero())) { + if ((k < nrt) && (arrayE[k].abs() > _epsilon)) { for (var j = k + 1; j < matrixV.first.length; j++) { var t = const Complex.zero(); for (var i = k + 1; i < matrix.columnCount; i++) { @@ -210,38 +268,46 @@ final class SVDComplex extends SingleValueDecomposition @override List decompose() { + // Input validation + if (matrix.rowCount == 0 || matrix.columnCount == 0) { + throw ArgumentError('Matrix dimensions must be positive'); + } + + // Cache matrix dimensions + final rowCount = matrix.rowCount; + final columnCount = matrix.columnCount; + final maxRowCol = max(rowCount, columnCount); + // This matrix as a list of lists (to easily alter data) final sourceMatrix = matrix.toListOfList(); - final maxRowCol = max(matrix.rowCount, matrix.columnCount); // Arrays for internal storage of U and V. final matrixU = List>.generate( - matrix.rowCount, - (_) => List.generate( - maxRowCol, - (_) => const Complex.zero(), - ), + rowCount, + (_) => List.generate(maxRowCol, (_) => const Complex.zero()), + growable: false, ); final matrixV = List>.generate( - matrix.columnCount, - (_) => List.generate( - matrix.columnCount, - (_) => const Complex.zero(), - ), + columnCount, + (_) => List.generate(columnCount, (_) => const Complex.zero()), + growable: false, ); // Array for internal storage of the singular values. final arrayS = List.generate( - min(matrix.rowCount + 1, matrix.columnCount), + min(rowCount + 1, columnCount), (_) => const Complex.zero(), + growable: false, ); final arrayE = List.generate( - matrix.columnCount, + columnCount, (_) => const Complex.zero(), + growable: false, ); final helperArray = List.generate( - matrix.rowCount, + rowCount, (_) => const Complex.zero(), + growable: false, ); // Setup 1: bidiagonal form @@ -255,28 +321,21 @@ final class SVDComplex extends SingleValueDecomposition ); // Setup 2: generating U - _generateU( - matrixU: matrixU, - arrayS: arrayS, - ); + _generateU(matrixU: matrixU, arrayS: arrayS); // Setup 3: generating V. - _generateV( - matrixV: matrixV, - arrayE: arrayE, - ); + _generateV(matrixV: matrixV, arrayE: arrayE); // === Computing singular values from here. === // - var p = min(matrix.columnCount, matrix.rowCount + 1); + var p = min(columnCount, rowCount + 1); final pp = p - 1; var step = 0; - - // Precision. - final eps = pow(2.0, -52.0) as double; - final tiny = pow(2.0, -966.0) as double; + var iterationCount = 0; // Main iteration loop for the singular values. - while (p > 0) { + while (p > 0 && iterationCount < _maxIterations) { + iterationCount++; + // The 'convergenceStatus' variable works along with 'index' to determine // when the iterations should stop. In particular: // @@ -294,8 +353,8 @@ final class SVDComplex extends SingleValueDecomposition break; } - final upper = tiny + - eps * (arrayS[index].real.abs() + arrayS[index + 1].real).abs(); + final upper = + _tiny + _epsilon * (arrayS[index].abs() + arrayS[index + 1].abs()); if (arrayE[index].abs() <= upper) { arrayE[index] = const Complex.zero(); break; @@ -311,9 +370,10 @@ final class SVDComplex extends SingleValueDecomposition if (ks == index) { break; } - final t = (ks != p ? arrayE[ks].abs() : 0) + + final t = + (ks != p ? arrayE[ks].abs() : 0) + (ks != index + 1 ? arrayE[ks - 1].abs() : 0); - if (arrayS[ks].abs() <= tiny + eps * t) { + if (arrayS[ks].abs() <= _tiny + _epsilon * t) { arrayS[ks] = const Complex.zero(); break; } @@ -331,7 +391,7 @@ final class SVDComplex extends SingleValueDecomposition index++; // Now that the convergence status is updated, we proceed with different - // srategies according with the flag. + // strategies according with the flag. switch (convergenceStatus) { case 1: var f = arrayE[p - 2]; @@ -345,13 +405,14 @@ final class SVDComplex extends SingleValueDecomposition f = -sn * arrayE[j - 1]; arrayE[j - 1] = cs * arrayE[j - 1]; } - for (var i = 0; i < matrix.columnCount; i++) { + for (var i = 0; i < columnCount; i++) { t = cs * matrixV[i][j] + sn * matrixV[i][p - 1]; matrixV[i][p - 1] = -sn * matrixV[i][j] + cs * matrixV[i][p - 1]; matrixV[i][j] = t; } } + //coverage:ignore-start case 2: var f = arrayE[index - 1]; arrayE[index - 1] = const Complex.zero(); @@ -362,23 +423,21 @@ final class SVDComplex extends SingleValueDecomposition arrayS[j] = t; f = -sn * arrayE[j]; arrayE[j] = cs * arrayE[j]; - for (var i = 0; i < matrix.rowCount; i++) { + for (var i = 0; i < rowCount; i++) { t = cs * matrixU[i][j] + sn * matrixU[i][index - 1]; matrixU[i][index - 1] = -sn * matrixU[i][j] + cs * matrixU[i][index - 1]; matrixU[i][j] = t; } } + //coverage:ignore-end case 3: // QR step with shifting final scaledValue = max( max( max( - max( - arrayS[p - 1].abs(), - arrayS[p - 2].abs(), - ), + max(arrayS[p - 1].abs(), arrayS[p - 2].abs()), arrayE[p - 2].abs(), ), arrayS[index].abs(), @@ -392,12 +451,13 @@ final class SVDComplex extends SingleValueDecomposition final epm1 = arrayE[p - 2] / scale; final sk = arrayS[index] / scale; final ek = arrayE[index] / scale; - final b = ((spm1 + sp) * (spm1 - sp) + epm1 * epm1) / + final b = + ((spm1 + sp) * (spm1 - sp) + epm1 * epm1) / const Complex.fromReal(2); final c = (sp * epm1) * (sp * epm1); var shift = const Complex.zero(); - if ((b != const Complex.zero()) | (c != const Complex.zero())) { + if ((b.abs() > _epsilon) || (c.abs() > _epsilon)) { shift = (b * b + c).sqrt(); shift = c / (b + shift); } @@ -416,7 +476,7 @@ final class SVDComplex extends SingleValueDecomposition arrayE[j] = cs * arrayE[j] - sn * arrayS[j]; g = sn * arrayS[j + 1]; arrayS[j + 1] = cs * arrayS[j + 1]; - for (var i = 0; i < matrix.columnCount; i++) { + for (var i = 0; i < columnCount; i++) { t = cs * matrixV[i][j] + sn * matrixV[i][j + 1]; matrixV[i][j + 1] = -sn * matrixV[i][j] + cs * matrixV[i][j + 1]; matrixV[i][j] = t; @@ -429,7 +489,7 @@ final class SVDComplex extends SingleValueDecomposition arrayS[j + 1] = -sn * arrayE[j] + cs * arrayS[j + 1]; g = sn * arrayE[j + 1]; arrayE[j + 1] = cs * arrayE[j + 1]; - for (var i = 0; i < matrix.rowCount; i++) { + for (var i = 0; i < rowCount; i++) { t = cs * matrixU[i][j] + sn * matrixU[i][j + 1]; matrixU[i][j + 1] = -sn * matrixU[i][j] + cs * matrixU[i][j + 1]; matrixU[i][j] = t; @@ -441,7 +501,7 @@ final class SVDComplex extends SingleValueDecomposition case 4: // Changing sign to singular values to make them positive. - if (arrayS[index] <= const Complex.zero()) { + if (arrayS[index].abs() <= _epsilon) { arrayS[index] = const Complex.zero(); for (var i = 0; i <= pp; i++) { matrixV[i][index] = -matrixV[i][index]; @@ -450,21 +510,21 @@ final class SVDComplex extends SingleValueDecomposition // Before returning E, U and V we need to rearrange the values. while (index < pp) { - if (arrayS[index] >= arrayS[index + 1]) { + if (arrayS[index].abs() >= arrayS[index + 1].abs()) { break; } var temp = arrayS[index]; arrayS[index] = arrayS[index + 1]; arrayS[index + 1] = temp; - if (index < matrix.columnCount - 1) { - for (var i = 0; i < matrix.columnCount; i++) { + if (index < columnCount - 1) { + for (var i = 0; i < columnCount; i++) { temp = matrixV[i][index + 1]; matrixV[i][index + 1] = matrixV[i][index]; matrixV[i][index] = temp; } } - if (index < matrix.rowCount - 1) { - for (var i = 0; i < matrix.rowCount; i++) { + if (index < rowCount - 1) { + for (var i = 0; i < rowCount; i++) { temp = matrixU[i][index + 1]; matrixU[i][index + 1] = matrixU[i][index]; matrixU[i][index] = temp; @@ -477,16 +537,20 @@ final class SVDComplex extends SingleValueDecomposition } } + if (iterationCount >= _maxIterations) { + //coverage:ignore-start + throw Exception('SVD did not converge within maximum iterations'); + //coverage:ignore-end + } + // Building the 'E' rectangular matrix, whose size is rowCount*columnCount. final sAsMatrix = List>.generate( - matrix.rowCount, - (_) => List.generate( - matrix.columnCount, - (_) => const Complex.zero(), - ), + rowCount, + (_) => List.generate(columnCount, (_) => const Complex.zero()), + growable: false, ); - for (var i = 0; i < matrix.rowCount; i++) { - for (var j = 0; j < matrix.columnCount; j++) { + for (var i = 0; i < rowCount; i++) { + for (var j = 0; j < columnCount; j++) { if (i == j) { sAsMatrix[i][j] = arrayS[i]; } else { @@ -498,18 +562,14 @@ final class SVDComplex extends SingleValueDecomposition // Returning E, U and V. return [ ComplexMatrix.fromData( - rows: matrix.rowCount, - columns: matrix.columnCount, + rows: rowCount, + columns: columnCount, data: sAsMatrix, ), + ComplexMatrix.fromData(rows: rowCount, columns: maxRowCol, data: matrixU), ComplexMatrix.fromData( - rows: matrix.rowCount, - columns: maxRowCol, - data: matrixU, - ), - ComplexMatrix.fromData( - rows: matrix.columnCount, - columns: matrix.columnCount, + rows: columnCount, + columns: columnCount, data: matrixV, ), ]; diff --git a/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/real_svd.dart b/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_real.dart similarity index 84% rename from lib/src/system/utils/matrix/decompositions/singular_value_decomposition/real_svd.dart rename to lib/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_real.dart index bcff582a..be884c4b 100644 --- a/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/real_svd.dart +++ b/lib/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_real.dart @@ -7,16 +7,38 @@ import 'package:equations/src/utils/math_utils.dart'; /// {@macro svd_class_header} /// /// This class performs the SVD procedure on [RealMatrix] types. +/// +/// The implementation is optimized for real-valued matrices and uses real +/// arithmetic throughout. The algorithm efficiently handles both square and +/// rectangular matrices, with special optimizations for common cases. +/// +/// Example: +/// ```dart +/// final matrix = RealMatrix.fromData( +/// rows: 2, +/// columns: 3, +/// data: [ +/// [1, 2, 3], +/// [4, 5, 6], +/// ], +/// ); +/// final decomposition = SVDReal(matrix: matrix); +/// final [E, U, V] = decomposition.decompose(); +/// ``` final class SVDReal extends SingleValueDecomposition with MathUtils { - /// Requires the [matrix] matrix to be decomposed. - const SVDReal({ - required super.matrix, - }); + /// {@macro svd_class_header} + const SVDReal({required super.matrix}); - /// Reduces the source matrix a to bidiagonal form. + /// Reduces the source matrix to bidiagonal form using Householder + /// reflections. + /// + /// This is the first step of the SVD algorithm and is required for the + /// computation of `U` and `V`. The bidiagonal form simplifies the + /// subsequent iterative refinement of singular values. /// - /// This is required for the computation of `U` and `V`. + /// The method modifies the input matrices in place and populates the + /// arrays with the necessary transformation data. void _bidiagonalForm({ required List> sourceMatrix, required List> matrixU, @@ -139,7 +161,11 @@ final class SVDReal extends SingleValueDecomposition arrayE[p - 1] = 0.0; } - /// Generation of the `U` from a bidiagonal source. + /// Generates the `U` matrix from the bidiagonal transformation data. + /// + /// This method reconstructs the left singular vectors by accumulating the + /// Householder transformations applied during bidiagonalization. The + /// resulting matrix U is orthogonal (U^T U = I). void _generateU({ required List> matrixU, required List arrayS, @@ -187,7 +213,11 @@ final class SVDReal extends SingleValueDecomposition } } - /// Generation of the `V` from a bidiagonal source. + /// Generates the `V` matrix from the bidiagonal transformation data. + /// + /// This method reconstructs the right singular vectors by accumulating the + /// Householder transformations applied during bidiagonalization. The + /// resulting matrix V is orthogonal (V^T V = I). void _generateV({ required List> matrixV, required List arrayE, @@ -218,6 +248,11 @@ final class SVDReal extends SingleValueDecomposition @override List decompose() { + // Input validation + if (matrix.rowCount == 0 || matrix.columnCount == 0) { + throw ArgumentError('Matrix dimensions must be positive'); + } + // This matrix as a list of lists (to easily alter data) final sourceMatrix = matrix.toListOfList(); final maxRowCol = max(matrix.rowCount, matrix.columnCount); @@ -225,10 +260,7 @@ final class SVDReal extends SingleValueDecomposition // Arrays for internal storage of U and V. final matrixU = List>.generate( matrix.rowCount, - (_) => List.generate( - maxRowCol, - (_) => 0, - ), + (_) => List.generate(maxRowCol, (_) => 0), ); final matrixV = List>.generate( matrix.columnCount, @@ -240,14 +272,8 @@ final class SVDReal extends SingleValueDecomposition min(matrix.rowCount + 1, matrix.columnCount), (_) => 0, ); - final arrayE = List.generate( - matrix.columnCount, - (_) => 0, - ); - final helperArray = List.generate( - matrix.rowCount, - (_) => 0, - ); + final arrayE = List.generate(matrix.columnCount, (_) => 0); + final helperArray = List.generate(matrix.rowCount, (_) => 0); // Setup 1: bidiagonal form _bidiagonalForm( @@ -260,16 +286,10 @@ final class SVDReal extends SingleValueDecomposition ); // Setup 2: generating U - _generateU( - matrixU: matrixU, - arrayS: arrayS, - ); + _generateU(matrixU: matrixU, arrayS: arrayS); // Setup 3: generating V. - _generateV( - matrixV: matrixV, - arrayE: arrayE, - ); + _generateV(matrixV: matrixV, arrayE: arrayE); // === Computing singular values from here. === // var p = min(matrix.columnCount, matrix.rowCount + 1); @@ -316,7 +336,8 @@ final class SVDReal extends SingleValueDecomposition if (ks == index) { break; } - final t = (ks != p ? arrayE[ks].abs() : 0.0) + + final t = + (ks != p ? arrayE[ks].abs() : 0.0) + (ks != index + 1 ? arrayE[ks - 1].abs() : 0.0); if (arrayS[ks].abs() <= tiny + eps * t) { arrayS[ks] = 0.0; @@ -357,6 +378,7 @@ final class SVDReal extends SingleValueDecomposition } } + //coverage:ignore-start case 2: var f = arrayE[index - 1]; arrayE[index - 1] = 0.0; @@ -374,16 +396,14 @@ final class SVDReal extends SingleValueDecomposition matrixU[i][j] = t; } } + //coverage:ignore-end case 3: // QR step with shifting final scale = max( max( max( - max( - arrayS[p - 1].abs(), - arrayS[p - 2].abs(), - ), + max(arrayS[p - 1].abs(), arrayS[p - 2].abs()), arrayE[p - 2].abs(), ), arrayS[index].abs(), diff --git a/lib/src/system/utils/matrix/real_matrix.dart b/lib/src/system/utils/matrix/real_matrix.dart index 9ea35054..39120ff4 100644 --- a/lib/src/system/utils/matrix/real_matrix.dart +++ b/lib/src/system/utils/matrix/real_matrix.dart @@ -1,13 +1,12 @@ import 'dart:math'; import 'package:equations/equations.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_real_decomposition.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_real.dart'; import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/real_svd.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_real.dart'; import 'package:equations/src/utils/math_utils.dart'; -/// A simple Dart implementation of an `m x n` matrix whose data type is -/// [double]. +/// A Dart implementation of an `MxM` matrix whose data type is [double]. /// /// ```dart /// final matrix = RealMatrix( @@ -25,23 +24,17 @@ import 'package:equations/src/utils/math_utils.dart'; /// columnCount: 6, /// ); /// -/// final value = matrix(2, 3); -/// final value = matrix.itemAt(2, 3); +/// final value1 = matrix(2, 3); +/// final value2 = matrix.itemAt(2, 3); /// ``` /// /// Both versions return the same value but the first one is less verbose and -/// preferred. In the example, `value` holds the value of the element at -/// position `(1, 3)` in the matrix. +/// preferred. In the example, `value1` holds the value of the element at +/// position `(2, 3)` in the matrix. base class RealMatrix extends Matrix with MathUtils { /// {@macro matrix_constructor_intro} - RealMatrix({ - required super.rows, - required super.columns, - super.identity, - }) : super( - defaultValue: 0, - identityOneValue: 1, - ); + RealMatrix({required super.rows, required super.columns, super.identity}) + : super(defaultValue: 0, identityOneValue: 1); /// {@macro matrix_fromData_constructor} RealMatrix.fromData({ @@ -62,9 +55,7 @@ base class RealMatrix extends Matrix with MathUtils { required super.rows, required super.columns, required super.diagonalValue, - }) : super.diagonal( - defaultValue: 0, - ); + }) : super.diagonal(defaultValue: 0); void _setDataAt(List flatMatrix, int row, int col, double value) => flatMatrix[columnCount * row + col] = value; @@ -142,18 +133,36 @@ base class RealMatrix extends Matrix with MathUtils { growable: false, ); - // Performing the multiplication - for (var i = 0; i < rowCount; i++) { - for (var j = 0; j < other.columnCount; j++) { - var sum = 0.0; - for (var k = 0; k < other.rowCount; k++) { - sum += this(i, k) * other(k, j); + // Cache dimensions and data for better performance + final n = rowCount; + final m = columnCount; + final p = other.columnCount; + final a = flattenData; + final b = other.flattenData; + + // Block multiplication for better cache locality + const blockSize = 32; // Adjust based on cache line size + for (var ii = 0; ii < n; ii += blockSize) { + final iEnd = (ii + blockSize < n) ? ii + blockSize : n; + for (var jj = 0; jj < p; jj += blockSize) { + final jEnd = (jj + blockSize < p) ? jj + blockSize : p; + for (var kk = 0; kk < m; kk += blockSize) { + final kEnd = (kk + blockSize < m) ? kk + blockSize : m; + + // Multiply blocks + for (var i = ii; i < iEnd; i++) { + for (var j = jj; j < jEnd; j++) { + var sum = 0.0; + for (var k = kk; k < kEnd; k++) { + sum += a[m * i + k] * b[p * k + j]; + } + flatMatrix[p * i + j] += sum; + } + } } - flatMatrix[other.columnCount * i + j] = sum; } } - // Building the new matrix return RealMatrix.fromFlattenedData( rows: rowCount, columns: other.columnCount, @@ -256,11 +265,7 @@ base class RealMatrix extends Matrix with MathUtils { // The cofactor matrix of an 1x1 matrix is always 1. if (rowCount == 1) { - return RealMatrix.fromFlattenedData( - rows: 1, - columns: 1, - data: [1], - ); + return RealMatrix.fromFlattenedData(rows: 1, columns: 1, data: [1]); } final source = List>.generate( @@ -340,19 +345,14 @@ base class RealMatrix extends Matrix with MathUtils { @override double trace() { - // Making sure that the matrix is squared if (!isSquareMatrix) { throw const MatrixException('The matrix is not square!'); } - // The trace value var trace = 0.0; - - // Computing the trace for (var i = 0; i < columnCount; ++i) { trace += this(i, i); } - return trace; } @@ -399,8 +399,6 @@ base class RealMatrix extends Matrix with MathUtils { // If it's a square matrix, we can use the LU decomposition which is faster if (isSquareMatrix) { final lower = luDecomposition().first; - - // Linearly independent columns var independentCols = 0; for (var i = 0; i < lower.rowCount; ++i) { @@ -414,8 +412,6 @@ base class RealMatrix extends Matrix with MathUtils { return independentCols; } - // If the matrix is rectangular and it's not 1x1, then use the "traditional" - // algorithm var rank = 0; final matrix = toListOfList(); @@ -456,34 +452,23 @@ base class RealMatrix extends Matrix with MathUtils { @override Algebraic characteristicPolynomial() { - // Making sure that the matrix is squared if (!isSquareMatrix) { throw const MatrixException( 'Eigenvalues can be computed on square matrices only!', ); } - // For 1x1 matrices, directly compute it if (rowCount == 1) { - return Linear.realEquation( - b: -this(0, 0), - ); + return Linear.realEquation(b: -this(0, 0)); } - // For 2x2 matries, use a direct formula which is faster if (rowCount == 2) { - return Quadratic.realEquation( - b: -trace(), - c: determinant(), - ); + return Quadratic.realEquation(b: -trace(), c: determinant()); } // For 3x3 matrices and bigger, use the Faddeev–LeVerrier algorithm var supportMatrix = this; var oldTrace = supportMatrix.trace(); - - // The coefficients of the characteristic polynomial. The coefficient of the - // highest degree is always 1. final coefficients = [1, -trace()]; for (var i = 1; i < rowCount; ++i) { @@ -504,27 +489,19 @@ base class RealMatrix extends Matrix with MathUtils { @override List eigenvalues() { - // Making sure that the matrix is squared if (!isSquareMatrix) { throw const MatrixException( 'Eigenvalues can be computed on square matrices only!', ); } - // From now on, we're sure that the matrix is square. If it's 1x1 or 2x2, - // computing the roots of the characteristic polynomial is faster and more - // precise. if (rowCount == 1 || rowCount == 2) { return characteristicPolynomial().solutions(); } // For 3x3 matrices and bigger, use the "eigendecomposition" algorithm. - final eigenDecomposition = EigendecompositionReal( - matrix: this, - ); + final eigenDecomposition = EigendecompositionReal(matrix: this); - // The 'D' matrix contains real and complex coefficients of the eigenvalues - // so we can ignore the other 2. final decomposition = eigenDecomposition.decompose()[1]; final eigenvalues = []; @@ -532,8 +509,6 @@ base class RealMatrix extends Matrix with MathUtils { // The real value is ALWAYS in the diagonal. final real = decomposition(i, i); - // The imaginary part can be either on the right or the left of the main - // diagonal, depending on the sign. if (i > 0 && i < (decomposition.rowCount - 1)) { // Values on the left and right of the diagonal. final pre = decomposition(i, i - 1); @@ -545,8 +520,6 @@ base class RealMatrix extends Matrix with MathUtils { eigenvalues.add(Complex(real, pre == 0 ? post : pre)); } } else { - // Here the loop is either at (0,0) or at the bottom of the diagonal so - // we need to check only one side. if (i == 0) { eigenvalues.add(Complex(real, decomposition(i, i + 1))); } else { @@ -560,40 +533,81 @@ base class RealMatrix extends Matrix with MathUtils { @override List luDecomposition() { - // Making sure that the matrix is squared if (!isSquareMatrix) { throw const MatrixException( 'LU decomposition only works with square matrices!', ); } + final n = rowCount; + const precision = 1.0e-10; + + final A = List.generate( + n * n, + (index) => this(index ~/ n, index % n), + growable: false, + ); + // Creating L and U matrices final L = List.generate( - rowCount * columnCount, + n * n, (_) => 0.0, growable: false, ); final U = List.generate( - rowCount * columnCount, + n * n, (_) => 0.0, growable: false, ); + final P = List.generate(n, (i) => i, growable: false); - // Computing L and U - for (var i = 0; i < rowCount; ++i) { - for (var k = i; k < rowCount; k++) { + for (var i = 0; i < n; ++i) { + var maxRow = i; + var maxVal = _getDataAt(A, i, i).abs(); + + for (var k = i + 1; k < n; k++) { + final val = _getDataAt(A, k, i).abs(); + if (val > maxVal) { + maxVal = val; + maxRow = k; + } + } + + if (maxVal <= precision) { + throw const MatrixException('Matrix is singular or nearly singular.'); + } + + if (maxRow != i) { + for (var j = 0; j < n; j++) { + final temp = _getDataAt(A, i, j); + _setDataAt(A, i, j, _getDataAt(A, maxRow, j)); + _setDataAt(A, maxRow, j, temp); + } + + for (var j = 0; j < i; j++) { + final temp = _getDataAt(L, i, j); + _setDataAt(L, i, j, _getDataAt(L, maxRow, j)); + _setDataAt(L, maxRow, j, temp); + } + + final tempP = P[i]; + P[i] = P[maxRow]; + P[maxRow] = tempP; + } + + // Compute U[i, k] for k >= i + for (var k = i; k < n; k++) { // Summation of L(i, j) * U(j, k) var sum = 0.0; for (var j = 0; j < i; j++) { sum += _getDataAt(L, i, j) * _getDataAt(U, j, k); } - // Evaluating U(i, k) - _setDataAt(U, i, k, this(i, k) - sum); + _setDataAt(U, i, k, _getDataAt(A, i, k) - sum); } - // Lower Triangular - for (var k = i; k < rowCount; k++) { + // Compute L[k, i] for k > i + for (var k = i; k < n; k++) { if (i == k) { _setDataAt(L, i, i, 1); } else { @@ -603,68 +617,97 @@ base class RealMatrix extends Matrix with MathUtils { sum += _getDataAt(L, k, j) * _getDataAt(U, j, i); } - // Evaluating L(k, i) - _setDataAt(L, k, i, (this(k, i) - sum) / _getDataAt(U, i, i)); + final uii = _getDataAt(U, i, i); + if (uii.abs() <= precision) { + throw const MatrixException( + 'Division by zero in LU decomposition. Matrix is singular.', + ); + } + _setDataAt(L, k, i, (_getDataAt(A, k, i) - sum) / uii); } } } + final pMatrix = List.generate( + n * n, + (_) => 0.0, + growable: false, + ); + for (var i = 0; i < n; i++) { + _setDataAt(pMatrix, i, P[i], 1); + } + return [ - RealMatrix.fromFlattenedData( - rows: rowCount, - columns: rowCount, - data: L, - ), - RealMatrix.fromFlattenedData( - rows: rowCount, - columns: rowCount, - data: U, - ), + RealMatrix.fromFlattenedData(rows: n, columns: n, data: L), + RealMatrix.fromFlattenedData(rows: n, columns: n, data: U), + RealMatrix.fromFlattenedData(rows: n, columns: n, data: pMatrix), ]; } @override List choleskyDecomposition() { - // Making sure that the matrix is squared if (!isSquareMatrix) { throw const MatrixException( 'LU decomposition only works with square matrices!', ); } - // Exit immediately because if [0,0] is a negative number, the algorithm - // cannot even start since the square root of a negative number in R is not - // allowed. if (this(0, 0) <= 0) { throw const SystemSolverException('The matrix is not positive-definite.'); } - // Creating L and Lt matrices - final L = List.generate( + final L = List.generate( rowCount * columnCount, (_) => 0.0, growable: false, ); - final transpL = List.generate( + final transpL = List.generate( rowCount * columnCount, (_) => 0.0, growable: false, ); + const blockSize = 32; - // Computing the L matrix so that A = L * Lt (where 'Lt' is L transposed) - for (var i = 0; i < rowCount; i++) { - for (var j = 0; j <= i; j++) { + for (var i = 0; i < rowCount; i += blockSize) { + final iEnd = (i + blockSize < rowCount) ? i + blockSize : rowCount; + + // Process diagonal block + for (var j = i; j < iEnd; j++) { + // Compute diagonal element var sum = 0.0; - if (j == i) { - for (var k = 0; k < j; k++) { - sum += _getDataAt(L, j, k) * _getDataAt(L, j, k); + for (var k = 0; k < j; k++) { + sum += L[columnCount * j + k] * L[columnCount * j + k]; + } + final diag = this(j, j) - sum; + if (diag <= 0) { + throw const SystemSolverException( + 'The matrix is not positive-definite.', + ); + } + L[columnCount * j + j] = sqrt(diag); + + // Compute elements below diagonal + for (var k = j + 1; k < iEnd; k++) { + sum = 0.0; + for (var p = 0; p < j; p++) { + sum += L[columnCount * k + p] * L[columnCount * j + p]; } - _setDataAt(L, j, j, sqrt(this(i, j) - sum)); - } else { - for (var k = 0; k < j; k++) { - sum += _getDataAt(L, i, k) * _getDataAt(L, j, k); + L[columnCount * k + j] = (this(k, j) - sum) / L[columnCount * j + j]; + } + } + + // Process remaining blocks + for (var j = iEnd; j < rowCount; j += blockSize) { + final jEnd = (j + blockSize < rowCount) ? j + blockSize : rowCount; + for (var k = i; k < iEnd; k++) { + for (var l = j; l < jEnd; l++) { + var sum = 0.0; + for (var p = 0; p < k; p++) { + sum += L[columnCount * l + p] * L[columnCount * k + p]; + } + L[columnCount * l + k] = + (this(l, k) - sum) / L[columnCount * k + k]; } - _setDataAt(L, i, j, (this(i, j) - sum) / _getDataAt(L, j, j)); } } } @@ -672,7 +715,7 @@ base class RealMatrix extends Matrix with MathUtils { // Computing Lt, the transposed version of L for (var i = 0; i < rowCount; i++) { for (var j = 0; j < rowCount; j++) { - _setDataAt(transpL, i, j, _getDataAt(L, j, i)); + transpL[columnCount * i + j] = L[columnCount * j + i]; } } @@ -709,13 +752,16 @@ base class RealMatrix extends Matrix with MathUtils { /// Computes the determinant of a 3x3 matrix. double _compute3x3Determinant(RealMatrix source) { - final x = source.flattenData.first * + final x = + source.flattenData.first * ((source.flattenData[4] * source.flattenData[8]) - (source.flattenData[5] * source.flattenData[7])); - final y = source.flattenData[1] * + final y = + source.flattenData[1] * ((source.flattenData[3] * source.flattenData[8]) - (source.flattenData[5] * source.flattenData[6])); - final z = source.flattenData[2] * + final z = + source.flattenData[2] * ((source.flattenData[3] * source.flattenData[7]) - (source.flattenData[4] * source.flattenData[6])); @@ -724,29 +770,39 @@ base class RealMatrix extends Matrix with MathUtils { /// Computes the determinant of a 4x4 matrix. double _compute4x4Determinant(RealMatrix source) { - final det2_01_01 = source.flattenData.first * source.flattenData[5] - + final det2_01_01 = + source.flattenData.first * source.flattenData[5] - source.flattenData[1] * source.flattenData[4]; - final det2_01_02 = source.flattenData.first * source.flattenData[6] - + final det2_01_02 = + source.flattenData.first * source.flattenData[6] - source.flattenData[2] * source.flattenData[4]; - final det2_01_03 = source.flattenData.first * source.flattenData[7] - + final det2_01_03 = + source.flattenData.first * source.flattenData[7] - source.flattenData[3] * source.flattenData[4]; - final det2_01_12 = source.flattenData[1] * source.flattenData[6] - + final det2_01_12 = + source.flattenData[1] * source.flattenData[6] - source.flattenData[2] * source.flattenData[5]; - final det2_01_13 = source.flattenData[1] * source.flattenData[7] - + final det2_01_13 = + source.flattenData[1] * source.flattenData[7] - source.flattenData[3] * source.flattenData[5]; - final det2_01_23 = source.flattenData[2] * source.flattenData[7] - + final det2_01_23 = + source.flattenData[2] * source.flattenData[7] - source.flattenData[3] * source.flattenData[6]; - final det3_201_012 = source.flattenData[8] * det2_01_12 - + final det3_201_012 = + source.flattenData[8] * det2_01_12 - source.flattenData[9] * det2_01_02 + source.flattenData[10] * det2_01_01; - final det3_201_013 = source.flattenData[8] * det2_01_13 - + final det3_201_013 = + source.flattenData[8] * det2_01_13 - source.flattenData[9] * det2_01_03 + source.flattenData[11] * det2_01_01; - final det3_201_023 = source.flattenData[8] * det2_01_23 - + final det3_201_023 = + source.flattenData[8] * det2_01_23 - source.flattenData[10] * det2_01_03 + source.flattenData[11] * det2_01_02; - final det3_201_123 = source.flattenData[9] * det2_01_23 - + final det3_201_123 = + source.flattenData[9] * det2_01_23 - source.flattenData[10] * det2_01_13 + source.flattenData[11] * det2_01_12; @@ -762,8 +818,7 @@ base class RealMatrix extends Matrix with MathUtils { // Computing the determinant only if the matrix is square if (!isSquareMatrix) { throw const MatrixException( - "Can't compute the determinant of this " - "matrix because it's not square.", + 'Cannot compute the determinant because the matrix is not square.', ); } @@ -791,7 +846,8 @@ base class RealMatrix extends Matrix with MathUtils { // determinant computation happens via LU decomposition. Look at this well // known relation: // - // det(A) = det(L x U) = det(L) x det(U) + // PA = LU, so det(A) = det(P)^(-1) * det(L) * det(U) + // where det(P) = (-1)^number_of_swaps // // In particular, the determinant of a lower triangular and an upper // triangular matrix is the product of the items in the diagonal. @@ -810,6 +866,48 @@ base class RealMatrix extends Matrix with MathUtils { prodU *= lu[1](i, i); } - return prodL * prodU; + // Compute determinant of permutation matrix P + // det(P) = sign of permutation = (-1)^number_of_swaps + // For a permutation matrix, we can compute the sign by finding cycles + final P = lu[2]; + + // Find the permutation vector: for each row i, find which column has 1 + final perm = List.generate(rowCount, (i) { + for (var j = 0; j < rowCount; j++) { + if (P(i, j) == 1.0) { + return j; + } + } + return i; // fallback (shouldn't happen) + }); + + // Compute sign of permutation by counting inversions + // or by decomposing into cycles (simpler: count cycles of even length) + final visited = List.generate(rowCount, (_) => false); + var sign = 1; + for (var i = 0; i < rowCount; i++) { + if (!visited[i] && perm[i] != i) { + // Found a cycle, count its length + var cycleLength = 0; + var j = i; + while (!visited[j]) { + visited[j] = true; + cycleLength++; + j = perm[j]; + } + // A cycle of length k has sign (-1)^(k-1) + if (cycleLength.isEven) { + sign = -sign; + } + } + } + final detP = sign.toDouble(); + + // det(A) = det(P)^(-1) * det(L) * det(U) = det(P) * det(L) * det(U) + // since det(P) = ±1, det(P)^(-1) = det(P) + return detP * prodL * prodU; } + + @override + bool isZero() => flattenData.every((value) => value == 0); } diff --git a/lib/src/system/utils/matrix_utils.dart b/lib/src/system/utils/matrix_utils.dart new file mode 100644 index 00000000..8898981a --- /dev/null +++ b/lib/src/system/utils/matrix_utils.dart @@ -0,0 +1,57 @@ +/// A mixin that contains utility methods for solving linear systems using +/// triangular matrices. +/// +/// This mixin provides efficient algorithms for forward and back substitution, +/// which are commonly used in matrix decomposition methods such as LU +/// decomposition, Cholesky decomposition, and Gaussian elimination. +mixin RealMatrixUtils { + /// Solves a system of linear equations using back substitution. + /// + /// Back substitution is an iterative process that solves equation matrices + /// in the form `Ux = b`, where `U` is an upper triangular matrix. This + /// algorithm solves the system by starting from the last row and working + /// backwards, using previously computed values to solve for the remaining + /// unknowns. + List backSubstitution( + List> source, + List vector, + ) { + final size = vector.length; + final solutions = List.generate(size, (_) => 0, growable: false); + + for (var i = size - 1; i >= 0; --i) { + solutions[i] = vector[i]; + for (var j = i + 1; j < size; ++j) { + solutions[i] = solutions[i] - source[i][j] * solutions[j]; + } + solutions[i] = solutions[i] / source[i][i]; + } + + return solutions; + } + + /// Solves a system of linear equations using forward substitution. + /// + /// Forward substitution is an iterative process that solves equation matrices + /// in the form `Lx = b`, where `L` is a lower triangular matrix. This + /// algorithm solves the system by starting from the first row and working + /// forwards, using previously computed values to solve for the remaining + /// unknowns. + List forwardSubstitution( + List> source, + List vector, + ) { + final size = vector.length; + final solutions = List.generate(size, (_) => 0, growable: false); + + for (var i = 0; i < size; ++i) { + solutions[i] = vector[i]; + for (var j = 0; j < i; ++j) { + solutions[i] = solutions[i] - source[i][j] * solutions[j]; + } + solutions[i] = solutions[i] / source[i][i]; + } + + return solutions; + } +} diff --git a/lib/src/utils/complex/complex.dart b/lib/src/utils/complex/complex.dart index 42c46f6f..1ab24902 100644 --- a/lib/src/utils/complex/complex.dart +++ b/lib/src/utils/complex/complex.dart @@ -2,10 +2,12 @@ import 'dart:math' as math; import 'package:equations/equations.dart'; +/// {@template complex} /// A Dart representation of a complex number in the form `a + bi` where `a` is /// the real part and `bi` is the imaginary (or complex) part. /// /// A [Complex] object is **immutable**. +/// {@endtemplate} final class Complex implements Comparable { /// The real part of the complex number. final double real; @@ -108,11 +110,14 @@ final class Complex implements Comparable { // // Instead, '>' and '<' are more reliable in terms of machine precision so // 0 is just a fallback. - if (abs() > other.abs()) { + final thisAbs = abs(); + final otherAbs = other.abs(); + + if (thisAbs > otherAbs) { return 1; } - if (abs() < other.abs()) { + if (thisAbs < otherAbs) { return -1; } @@ -123,11 +128,10 @@ final class Complex implements Comparable { Complex copyWith({ double? real, double? imaginary, - }) => - Complex( - real ?? this.real, - imaginary ?? this.imaginary, - ); + }) => Complex( + real ?? this.real, + imaginary ?? this.imaginary, + ); @override String toString() => _convertToString(); @@ -172,11 +176,14 @@ final class Complex implements Comparable { /// Converts this object into polar coordinates and wraps them in a new /// [PolarComplex] object. - PolarComplex toPolarCoordinates() => PolarComplex( - r: abs(), - phiRadians: phase(), - phiDegrees: _radToDeg(phase()), - ); + PolarComplex toPolarCoordinates() { + final phi = phase(); + return PolarComplex( + r: abs(), + phiRadians: phi, + phiDegrees: _radToDeg(phi), + ); + } /// Converts this complex number into a string. If [asFraction] is `true` then /// the real and the imaginary part are converted into fractions. @@ -236,15 +243,15 @@ final class Complex implements Comparable { /// Sums two complex numbers. Complex operator +(Complex other) => Complex( - real + other.real, - imaginary + other.imaginary, - ); + real + other.real, + imaginary + other.imaginary, + ); /// Subtracts two complex numbers. Complex operator -(Complex other) => Complex( - real - other.real, - imaginary - other.imaginary, - ); + real - other.real, + imaginary - other.imaginary, + ); /// The products of two complex numbers. Complex operator *(Complex other) { @@ -255,7 +262,13 @@ final class Complex implements Comparable { } /// Divides two complex numbers. - Complex operator /(Complex other) => this * other.reciprocal(); + Complex operator /(Complex other) { + final realNum = (real * other.real) + (imaginary * other.imaginary); + final imagNum = (imaginary * other.real) - (real * other.imaginary); + final den = other.real * other.real + other.imaginary * other.imaginary; + + return Complex(realNum / den, imagNum / den); + } /// Returns the negation of this complex number. Complex operator -() => negate; @@ -309,13 +322,7 @@ final class Complex implements Comparable { /// is the real part and `b` is the imaginary part. /// /// This is is the modulus/magnitude/absolute value of the complex number. - double abs() { - if ((real != 0) || (imaginary != 0)) { - return math.sqrt(real * real + imaginary * imaginary); - } - - return 0; - } + double abs() => math.sqrt(real * real + imaginary * imaginary); /// Converts rectangular coordinates to polar coordinates by computing an arc /// tangent of y/x in the range from -pi to pi. @@ -323,22 +330,25 @@ final class Complex implements Comparable { /// Calculates the _base-e_ exponential of a complex number z where _e_ is the /// Euler constant. - Complex exp() => Complex( - math.exp(real) * math.cos(imaginary), - math.exp(real) * math.sin(imaginary), - ); + Complex exp() { + final expReal = math.exp(real); + return Complex( + expReal * math.cos(imaginary), + expReal * math.sin(imaginary), + ); + } /// Calculates the sine of this complex number. Complex sin() => Complex( - math.sin(real) * _cosh(imaginary), - math.cos(real) * _sinh(imaginary), - ); + math.sin(real) * _cosh(imaginary), + math.cos(real) * _sinh(imaginary), + ); /// Calculates the cosine of this complex number. Complex cos() => Complex( - math.cos(real) * _cosh(imaginary), - -math.sin(real) * _sinh(imaginary), - ); + math.cos(real) * _cosh(imaginary), + -math.sin(real) * _sinh(imaginary), + ); /// Calculates the tangent of this complex number. Complex tan() => sin() / cos(); @@ -347,10 +357,28 @@ final class Complex implements Comparable { Complex cot() => cos() / sin(); /// Calculates the hyperbolic cosine. - double _cosh(num x) => (math.exp(x) + math.exp(-x)) / 2; + /// + /// Uses a more numerically stable computation for large values. + double _cosh(num x) { + if (x.abs() > 20) { + // For large values, exp(-x) becomes negligible, so we can simplify + return math.exp(x.abs()) / 2; + } + return (math.exp(x) + math.exp(-x)) / 2; + } /// Calculates the hyperbolic sine. - double _sinh(num x) => (math.exp(x) - math.exp(-x)) / 2; + /// + /// Uses a more numerically stable computation for large values. + double _sinh(num x) { + if (x.abs() > 20) { + // For large positive values, exp(-x) becomes negligible + // For large negative values, exp(x) becomes negligible + final sign = x >= 0 ? 1 : -1; + return sign * math.exp(x.abs()) / 2; + } + return (math.exp(x) - math.exp(-x)) / 2; + } /// Calculates the square root of this complex number. Complex sqrt() { diff --git a/lib/src/utils/complex/polar_complex.dart b/lib/src/utils/complex/polar_complex.dart index a81d21fa..6afd1910 100644 --- a/lib/src/utils/complex/polar_complex.dart +++ b/lib/src/utils/complex/polar_complex.dart @@ -1,8 +1,11 @@ import 'package:equations/equations.dart'; +/// {@template polar_complex} /// A wrapper class, returned by a [Complex] object, that represents a complex /// number in polar coordinates. +/// {@endtemplate} final class PolarComplex implements Comparable { + /// {@macro polar_complex} /// The absolute value/modulus of the complex number. final double r; @@ -12,8 +15,7 @@ final class PolarComplex implements Comparable { /// The 'phi' angle expressed in degrees. final double phiDegrees; - /// The angle [r] is required both in radians ([phiRadians]) and degrees. - /// ([phiDegrees]). + /// {@macro polar_complex} const PolarComplex({ required this.r, required this.phiRadians, @@ -21,7 +23,8 @@ final class PolarComplex implements Comparable { }); @override - String toString() => 'r = $r\n' + String toString() => + 'r = $r\n' 'phi (rad) = $phiRadians\n' 'phi (deg) = $phiDegrees'; @@ -73,10 +76,9 @@ final class PolarComplex implements Comparable { double? r, double? phiRadians, double? phiDegrees, - }) => - PolarComplex( - r: r ?? this.r, - phiDegrees: phiDegrees ?? this.phiDegrees, - phiRadians: phiRadians ?? this.phiRadians, - ); + }) => PolarComplex( + r: r ?? this.r, + phiDegrees: phiDegrees ?? this.phiDegrees, + phiRadians: phiRadians ?? this.phiRadians, + ); } diff --git a/lib/src/utils/exceptions/exceptions.dart b/lib/src/utils/exceptions/exceptions.dart index f83839a8..00a182e7 100644 --- a/lib/src/utils/exceptions/exceptions.dart +++ b/lib/src/utils/exceptions/exceptions.dart @@ -1,4 +1,6 @@ -/// Base class for exception objects in this package. +/// {@template equation_exception} +/// Base class for exception objects in the equations package. +/// {@endtemplate} abstract class EquationException implements Exception { /// The error message. final String message; @@ -15,7 +17,7 @@ abstract class EquationException implements Exception { /// always put before the actual error message. final String messagePrefix; - /// Requires the [message] to be associated to the error object. + /// {@macro equation_exception} const EquationException({ required this.message, required this.messagePrefix, diff --git a/lib/src/utils/exceptions/types/algebraic_exception.dart b/lib/src/utils/exceptions/types/algebraic_exception.dart index 98362cb8..7250ea1a 100644 --- a/lib/src/utils/exceptions/types/algebraic_exception.dart +++ b/lib/src/utils/exceptions/types/algebraic_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template algebraic_exception} /// Exception object thrown by [Algebraic]. +/// {@endtemplate} class AlgebraicException extends EquationException { - /// Represents an exception from the [Algebraic] class. + /// {@macro algebraic_exception} const AlgebraicException(String message) - : super( - message: message, - messagePrefix: 'AlgebraicException', - ); + : super( + message: message, + messagePrefix: 'AlgebraicException', + ); } diff --git a/lib/src/utils/exceptions/types/complex_exception.dart b/lib/src/utils/exceptions/types/complex_exception.dart index d5793637..d5aa2c4d 100644 --- a/lib/src/utils/exceptions/types/complex_exception.dart +++ b/lib/src/utils/exceptions/types/complex_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template complex_exception} /// Exception object thrown by [Complex]. +/// {@endtemplate} class ComplexException extends EquationException { - /// Represents an exception from the [Complex] class. + /// {@macro complex_exception} const ComplexException(String message) - : super( - message: message, - messagePrefix: 'ComplexException', - ); + : super( + message: message, + messagePrefix: 'ComplexException', + ); } diff --git a/lib/src/utils/exceptions/types/interpolation_exception.dart b/lib/src/utils/exceptions/types/interpolation_exception.dart index 53095d82..db1cdcd6 100644 --- a/lib/src/utils/exceptions/types/interpolation_exception.dart +++ b/lib/src/utils/exceptions/types/interpolation_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template interpolation_exception} /// Exception object thrown by [Interpolation]. +/// {@endtemplate} class InterpolationException extends EquationException { - /// Represents an exception from the [Interpolation] class. + /// {@macro interpolation_exception} const InterpolationException(String message) - : super( - message: message, - messagePrefix: 'InterpolationException', - ); + : super( + message: message, + messagePrefix: 'InterpolationException', + ); } diff --git a/lib/src/utils/exceptions/types/matrix_exception.dart b/lib/src/utils/exceptions/types/matrix_exception.dart index d4c98cc8..361d6245 100644 --- a/lib/src/utils/exceptions/types/matrix_exception.dart +++ b/lib/src/utils/exceptions/types/matrix_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template matrix_exception} /// Exception object thrown by [Matrix]. +/// {@endtemplate} class MatrixException extends EquationException { - /// Represents an exception from the [Matrix] class. + /// {@macro matrix_exception} const MatrixException(String message) - : super( - message: message, - messagePrefix: 'MatrixException', - ); + : super( + message: message, + messagePrefix: 'MatrixException', + ); } diff --git a/lib/src/utils/exceptions/types/nonlinear_exception.dart b/lib/src/utils/exceptions/types/nonlinear_exception.dart index 1885c0b2..d5b06f95 100644 --- a/lib/src/utils/exceptions/types/nonlinear_exception.dart +++ b/lib/src/utils/exceptions/types/nonlinear_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template nonlinear_exception} /// Exception object thrown by [NonLinear]. +/// {@endtemplate} class NonlinearException extends EquationException { - /// Represents an exception from the [NonLinear] class. + /// {@macro nonlinear_exception} const NonlinearException(String message) - : super( - message: message, - messagePrefix: 'NonlinearException', - ); + : super( + message: message, + messagePrefix: 'NonlinearException', + ); } diff --git a/lib/src/utils/exceptions/types/numerical_integration_exception.dart b/lib/src/utils/exceptions/types/numerical_integration_exception.dart index a7e90f72..700f6d4c 100644 --- a/lib/src/utils/exceptions/types/numerical_integration_exception.dart +++ b/lib/src/utils/exceptions/types/numerical_integration_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template numerical_integration_exception} /// Exception object thrown by [NumericalIntegration]. +/// {@endtemplate} class NumericalIntegrationException extends EquationException { - /// Represents an exception from the [NumericalIntegration] class. + /// {@macro numerical_integration_exception} const NumericalIntegrationException(String message) - : super( - message: message, - messagePrefix: 'NumericalIntegrationException', - ); + : super( + message: message, + messagePrefix: 'NumericalIntegrationException', + ); } diff --git a/lib/src/utils/exceptions/types/parser_exception.dart b/lib/src/utils/exceptions/types/parser_exception.dart index 86fdcba6..1d497b08 100644 --- a/lib/src/utils/exceptions/types/parser_exception.dart +++ b/lib/src/utils/exceptions/types/parser_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template expression_parser_exception} /// Exception object thrown by [ExpressionParser]. +/// {@endtemplate} class ExpressionParserException extends EquationException { - /// Represents an exception from the [ExpressionParser] class. + /// {@macro expression_parser_exception} const ExpressionParserException(String message) - : super( - message: message, - messagePrefix: 'ExpressionParserException', - ); + : super( + message: message, + messagePrefix: 'ExpressionParserException', + ); } diff --git a/lib/src/utils/exceptions/types/poly_long_division_exception.dart b/lib/src/utils/exceptions/types/poly_long_division_exception.dart index 8cc5d1aa..d531ca76 100644 --- a/lib/src/utils/exceptions/types/poly_long_division_exception.dart +++ b/lib/src/utils/exceptions/types/poly_long_division_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template polynomial_long_division_exception} /// Exception object thrown by [PolynomialLongDivision]. +/// {@endtemplate} class PolynomialLongDivisionException extends EquationException { - /// Represents an exception from the [PolynomialLongDivision] class. + /// {@macro polynomial_long_division_exception} const PolynomialLongDivisionException(String message) - : super( - message: message, - messagePrefix: 'PolynomialLongDivisionException', - ); + : super( + message: message, + messagePrefix: 'PolynomialLongDivisionException', + ); } diff --git a/lib/src/utils/exceptions/types/system_solver_exception.dart b/lib/src/utils/exceptions/types/system_solver_exception.dart index 68117e0c..7d5c1e73 100644 --- a/lib/src/utils/exceptions/types/system_solver_exception.dart +++ b/lib/src/utils/exceptions/types/system_solver_exception.dart @@ -1,11 +1,13 @@ import 'package:equations/equations.dart'; +/// {@template system_solver_exception} /// Exception object thrown by [SystemSolver]. +/// {@endtemplate} class SystemSolverException extends EquationException { - /// Represents an exception from the [SystemSolver] class. + /// {@macro system_solver_exception} const SystemSolverException(String message) - : super( - message: message, - messagePrefix: 'SystemSolverException', - ); + : super( + message: message, + messagePrefix: 'SystemSolverException', + ); } diff --git a/lib/src/utils/expression_parser.dart b/lib/src/utils/expression_parser.dart index 4c63a787..eb202fc6 100644 --- a/lib/src/utils/expression_parser.dart +++ b/lib/src/utils/expression_parser.dart @@ -7,6 +7,7 @@ import 'package:petitparser/petitparser.dart'; /// [ExpressionParser]. typedef _Evaluator = num Function(num value); +/// {@template expression_parser} /// Parses mathematical expressions with real numbers and the `x` variable (if /// any). The only allowed variable name is `x`: any other type of value isn't /// recognized. Some expressions examples are: @@ -34,14 +35,15 @@ typedef _Evaluator = num Function(num value); /// - csc(x) (cosecant of `x`) /// - sec(x) (secant of `x`) /// -/// An exception of type [ExpressionParserException] is thrown if the parsed is -/// malformed. This parser is also able to recognize some constants: +/// An exception of type [ExpressionParserException] is thrown if the expression +/// is malformed. This parser is also able to recognize some constants: /// /// - pi (pi, the ratio of the circumference on the diameter) /// - e (Euler's number) /// - sqrt2 (the square root of 2) /// - sqrt3 (the square root of 3) /// - G (Gauss constant) +/// {@endtemplate} final class ExpressionParser { /// Gauss constant. static const _g = 0.834626841674; @@ -49,138 +51,171 @@ final class ExpressionParser { /// Square root of 3. static const _sqrt3 = 1.7320508075688; - /// A "cached" instance of a parser to be used to evaluate expressions on a - /// given point. + /// A "cached" instance of a parser that is used to evaluate expressions. static final Parser<_Evaluator> _parser = () { final builder = ExpressionBuilder<_Evaluator>() - - // This primitive is fundamental as it recognizes real numbers from the - // input and parses them using 'parse'. + // This primitive is fundamental as it recognizes real numbers from + // the input and parses them using 'parse'. ..primitive( digit() .plus() .seq(char('.').seq(digit().plus()).optional()) .flatten() .trim() - .map((a) { - final number = num.parse(a); - - return (value) => number; - }), + .map( + (value) => + (_) => num.parse(value), + ), + ) + // Recognize the 'x' variable + ..primitive( + char('x').trim().map( + (_) => + (value) => value, + ), ) - - // Recognze the 'x' variable - ..primitive(char('x').trim().map((_) => (value) => value)) - // Constants - ..primitive(char('e').trim().map((_) => (value) => math.e)) - ..primitive(string('pi').trim().map((_) => (value) => math.pi)) - ..primitive(string('sqrt2').trim().map((_) => (value) => math.sqrt2)) - ..primitive(string('sqrt3').trim().map((_) => (value) => _sqrt3)) - ..primitive(string('G').trim().map((_) => (value) => _g)); + ..primitive( + char('e').trim().map( + (_) => + (value) => math.e, + ), + ) + ..primitive( + string('pi').trim().map( + (_) => + (value) => math.pi, + ), + ) + ..primitive( + string('sqrt2').trim().map( + (_) => + (value) => math.sqrt2, + ), + ) + ..primitive( + string('sqrt3').trim().map( + (_) => + (value) => _sqrt3, + ), + ) + ..primitive( + string('G').trim().map( + (_) => + (value) => _g, + ), + ); // Enable the parentheses builder.group() - ..wrapper(char('(').trim(), char(')').trim(), (_, a, __) => a) - + ..wrapper(char('(').trim(), char(')').trim(), (_, a, _) => a) // Adding various mathematical operators ..wrapper( string('sqrt(').trim(), char(')').trim(), - (_, a, __) => (value) => math.sqrt(a(value)), + (_, a, _) => + (value) => math.sqrt(a(value)), ) ..wrapper( string('abs(').trim(), char(')').trim(), - (_, a, __) => (value) => a(value).abs(), + (_, a, _) => + (value) => a(value).abs(), ) ..wrapper( string('sin(').trim(), char(')').trim(), - (_, a, __) => (value) => math.sin(a(value)), + (_, a, _) => + (value) => math.sin(a(value)), ) ..wrapper( string('cos(').trim(), char(')').trim(), - (_, a, __) => (value) => math.cos(a(value)), + (_, a, _) => + (value) => math.cos(a(value)), ) ..wrapper( string('tan(').trim(), char(')').trim(), - (_, a, __) => (value) => math.tan(a(value)), + (_, a, _) => + (value) => math.tan(a(value)), ) ..wrapper( string('log(').trim(), char(')').trim(), - (_, a, __) => (value) => math.log(a(value)), + (_, a, _) => + (value) => math.log(a(value)), ) ..wrapper( string('acos(').trim(), char(')').trim(), - (_, a, __) => (value) => math.acos(a(value)), + (_, a, _) => + (value) => math.acos(a(value)), ) ..wrapper( string('asin(').trim(), char(')').trim(), - (_, a, __) => (value) => math.asin(a(value)), + (_, a, _) => + (value) => math.asin(a(value)), ) ..wrapper( string('atan(').trim(), char(')').trim(), - (_, a, __) => (value) => math.atan(a(value)), + (_, a, _) => + (value) => math.atan(a(value)), ) ..wrapper( string('csc(').trim(), char(')').trim(), - (_, a, __) => (value) => 1 / math.sin(a(value)), + (_, a, _) => + (value) => 1 / math.sin(a(value)), ) ..wrapper( string('sec(').trim(), char(')').trim(), - (_, a, __) => (value) => 1 / math.cos(a(value)), + (_, a, _) => + (value) => 1 / math.cos(a(value)), ); // Defining operations among operators. builder.group().prefix( - char('-').trim(), - (_, a) => (value) => -a(value), - ); + char('-').trim(), + (_, a) => + (value) => -a(value), + ); builder.group().right( - char('^').trim(), - (a, _, b) => (value) => math.pow(a(value), b(value)), - ); + char('^').trim(), + (a, _, b) => + (value) => math.pow(a(value), b(value)), + ); builder.group() ..left( char('*').trim(), - (a, _, b) => (value) => a(value) * b(value), + (a, _, b) => + (value) => a(value) * b(value), ) ..left( char('/').trim(), - (a, _, b) => (value) => a(value) / b(value), + (a, _, b) => + (value) => a(value) / b(value), ); builder.group() ..left( char('+').trim(), - (a, _, b) => (value) => a(value) + b(value), + (a, _, b) => + (value) => a(value) + b(value), ) ..left( char('-').trim(), - (a, _, b) => (value) => a(value) - b(value), + (a, _, b) => + (value) => a(value) - b(value), ); // Build the parser return builder.build().end(); }(); - /// Builds a new expression parser that accepts strings with a single `x` - /// variable. For example, valid expressions are: - /// - /// - `2 + x` - /// - `3 * x - 6` - /// - `x^2 + cos(x / 2)` - /// - /// Note that `2*(1+3)` is **valid** while `2(1+3)` is **invalid**. You always - /// have to specify the `*` symbol to multiply two values. + /// {@macro expression_parser} const ExpressionParser(); /// Evaluates the mathematical [expression] and returns the result. This diff --git a/lib/src/utils/factorial.dart b/lib/src/utils/factorial.dart index 4cab2251..55f1162a 100644 --- a/lib/src/utils/factorial.dart +++ b/lib/src/utils/factorial.dart @@ -1,9 +1,14 @@ +/// {@template factorial} /// This class efficiently computes the factorial of a number using a cache. /// /// The factorial of a non-negative integer `n`, denoted by `n!`, is the product /// of all positive integers less than or equal to `n`. For example: /// /// - 5! = 5 * 4 * 3 * 2 * 1 = 120 +/// +/// If you want to compute the factorial of large values with more precision, +/// consider +/// {@endtemplate} final class Factorial { /// A cache with the most common factorial values. static const _factorialsCache = { @@ -30,12 +35,151 @@ final class Factorial { 20: 2432902008176640000, }; - /// Creates a [Factorial] object. + /// A cache with the most common big int factorial values. + static final _bigIntfactorialsCache = { + 0: BigInt.one, + 1: BigInt.one, + 2: BigInt.two, + 3: BigInt.from(6), + 4: BigInt.from(24), + 5: BigInt.from(120), + 6: BigInt.from(720), + 7: BigInt.from(5040), + 8: BigInt.from(40320), + 9: BigInt.from(362880), + 10: BigInt.from(3628800), + 11: BigInt.from(39916800), + 12: BigInt.from(479001600), + 13: BigInt.from(6227020800), + 14: BigInt.from(87178291200), + 15: BigInt.from(1307674368000), + 16: BigInt.from(20922789888000), + 17: BigInt.from(355687428096000), + 18: BigInt.from(6402373705728000), + 19: BigInt.from(121645100408832000), + 20: BigInt.from(2432902008176640000), + 21: BigInt.parse('51090942171709440000'), + 22: BigInt.parse('1124000727777607680000'), + 23: BigInt.parse('25852016738884976640000'), + 24: BigInt.parse('620448401733239439360000'), + 25: BigInt.parse('15511210043330985984000000'), + 26: BigInt.parse('403291461126605635584000000'), + 27: BigInt.parse('10888869450418352160768000000'), + 28: BigInt.parse('304888344611713860501504000000'), + 29: BigInt.parse('8841761993739701954543616000000'), + 30: BigInt.parse('265252859812191058636308480000000'), + }; + + /// Dynamic cache for computed int factorials. + static final _dynamicFactorialsCache = {}; + + /// Dynamic cache for computed BigInt factorials. + static final _dynamicBigIntFactorialsCache = {}; + + /// {@macro factorial} const Factorial(); - /// Efficiently computes the factorial of a number. + /// Efficiently computes the factorial of a number with [int] precision. + /// + /// - When [n] is greater than `20`, consider using [computeBigInt] if you + /// want more precision. + /// + /// - When [n] is less than or equal to `20`, this method executes in O(1) + /// time. + /// + /// - Computed values are cached dynamically for efficient repeated calls. + int compute(int n) { + // Check static cache first + if (_factorialsCache.containsKey(n)) { + return _factorialsCache[n]!; + } + + // Check dynamic cache + if (_dynamicFactorialsCache.containsKey(n)) { + return _dynamicFactorialsCache[n]!; + } + + // Find the highest cached value (static or dynamic) + int? cachedValue; + int? cachedKey; + + // Check static cache for highest value <= n + for (final key in _factorialsCache.keys) { + if (key <= n && (cachedKey == null || key > cachedKey)) { + cachedKey = key; + cachedValue = _factorialsCache[key]; + } + } + + // Check dynamic cache for highest value <= n + for (final key in _dynamicFactorialsCache.keys) { + if (key <= n && (cachedKey == null || key > cachedKey)) { + cachedKey = key; + cachedValue = _dynamicFactorialsCache[key]; + } + } + + // Start from the highest cached value and compute iteratively + var result = cachedValue ?? 1; + final start = (cachedKey ?? -1) + 1; + + // Iterative computation (avoids stack overflow) + for (var i = start; i <= n; i++) { + result *= i; + // Cache intermediate values for future use + _dynamicFactorialsCache[i] = result; + } + + return result; + } + + /// Efficiently computes the factorial of a number with [BigInt] precision. + /// + /// When [n] is less than or equal to `30`, this method executes in O(1) time. /// - /// When [n] is greater than `20`, values start to be approximated. - /// When [n] is less than or equal to `20`, this method executes in O(1) time. - int compute(int n) => _factorialsCache[n] ?? n * compute(n - 1); + /// Computed values are cached dynamically for efficient repeated calls. + BigInt computeBigInt(int n) { + // Check static cache first + if (_bigIntfactorialsCache.containsKey(n)) { + return _bigIntfactorialsCache[n]!; + } + + // Check dynamic cache + if (_dynamicBigIntFactorialsCache.containsKey(n)) { + return _dynamicBigIntFactorialsCache[n]!; + } + + // Find the highest cached value (static or dynamic) + BigInt? cachedValue; + int? cachedKey; + + // Check static cache for highest value <= n + for (final key in _bigIntfactorialsCache.keys) { + if (key <= n && (cachedKey == null || key > cachedKey)) { + cachedKey = key; + cachedValue = _bigIntfactorialsCache[key]; + } + } + + // Check dynamic cache for highest value <= n + for (final key in _dynamicBigIntFactorialsCache.keys) { + if (key <= n && (cachedKey == null || key > cachedKey)) { + cachedKey = key; + cachedValue = _dynamicBigIntFactorialsCache[key]; + } + } + + // Start from the highest cached value and compute iteratively + final start = (cachedKey ?? -1) + 1; + var result = cachedValue ?? BigInt.one; // coverage:ignore-line + + // Iterative computation (avoids stack overflow) + for (var i = start; i <= n; i++) { + result *= BigInt.from(i); + // Cache intermediate values for future use + _dynamicBigIntFactorialsCache[i] = result; + } + + return result; + } } diff --git a/pubspec.yaml b/pubspec.yaml index ad59bb23..79f05449 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,18 +1,18 @@ name: equations -description: An equation-solving library that also works with complex numbers and fractions. -version: 5.0.2 +description: An equation-solving library that supports complex numbers. +version: 6.0.0 repository: https://github.com/albertodev01/equations homepage: https://pub.dev/packages/equations environment: - sdk: ^3.1.0 + sdk: ^3.10.4 dependencies: - fraction: ^5.0.2 - petitparser: ^5.4.0 + fraction: ^5.0.5 + petitparser: ^7.0.1 dev_dependencies: - test: ^1.24.6 + test: ^1.28.0 topics: - equations diff --git a/test/algebraic/algebraic_test.dart b/test/algebraic/algebraic_test.dart deleted file mode 100644 index 56dff979..00000000 --- a/test/algebraic/algebraic_test.dart +++ /dev/null @@ -1,558 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group( - "Testing the public interface of 'Algebraic' which is shared with all " - 'of its concrete subclasses.', - () { - group("Testing the complex 'variant' of the 'from' method", () { - test( - "Making sure that a 'Constant' object is properly constructed when " - 'the length of the coefficients list is 1', - () { - final equation = Algebraic.from( - [const Complex(1, 0)], - ); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Linear' object is properly constructed when " - 'the length of the coefficients list is 12', - () { - final equation = Algebraic.from( - const [ - Complex(1, 0), - Complex(2, 0), - ], - ); - expect(equation, isA()); - - expect(equation[0], const Complex(1, 0)); - expect(equation[1], const Complex(2, 0)); - expect(equation.coefficient(1), const Complex(1, 0)); - expect(equation.coefficient(0), const Complex(2, 0)); - }, - ); - - test( - "Making sure that a 'Quadratic' object is properly constructed when " - 'the length of the coefficients list is 3', - () { - final equation = Algebraic.from( - const [ - Complex(1, 0), - Complex(2, 0), - Complex(3, 0), - ], - ); - - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Cubic' object is properly constructed when " - 'the length of the coefficients list is 4', - () { - final equation = Algebraic.from( - const [ - Complex(1, 0), - Complex(2, 0), - Complex(3, 0), - Complex(4, 0), - ], - ); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Quartic' object is properly constructed when " - 'the length of the coefficients list is 5', - () { - final equation = Algebraic.from( - const [ - Complex(1, 0), - Complex(2, 0), - Complex(3, 0), - Complex(4, 0), - Complex(5, 0), - ], - ); - - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Laguerre' object is properly constructed when " - 'the length of the coefficients list is 6', - () { - final equation = Algebraic.from( - const [ - Complex(1, 0), - Complex(2, 0), - Complex(3, 0), - Complex(4, 0), - Complex(5, 0), - Complex(6, 0), - ], - ); - - expect(equation, isA()); - }, - ); - }); - - // Tests with real numbers - group("Testing the real 'variant' of the 'from' method", () { - test( - "Making sure that a 'Constant' object is properly constructed when " - 'the length of the coefficients list is 1', - () { - final equation = Algebraic.fromReal([1]); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Linear' object is properly constructed when " - 'the length of the coefficients list is 12', - () { - final equation = Algebraic.fromReal( - [1, 2], - ); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Quadratic' object is properly constructed when " - 'the length of the coefficients list is 3', - () { - final equation = Algebraic.fromReal( - [1, 2, 3], - ); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Cubic' object is properly constructed when " - 'the length of the coefficients list is 4', - () { - final equation = Algebraic.fromReal( - [1, 2, 3, 4], - ); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Quartic' object is properly constructed when " - 'the length of the coefficients list is 5', - () { - final equation = Algebraic.fromReal( - [1, 2, 3, 4, 5], - ); - expect(equation, isA()); - }, - ); - - test( - "Making sure that a 'Laguerre' object is properly constructed when " - 'the length of the coefficients list is 6', - () { - final equation = Algebraic.fromReal( - [1, 2, 3, 4, 5, 6], - ); - expect(equation, isA()); - }, - ); - }); - - group('Testing the evaluation of the integral of a polynomial', () { - test( - "Making sure that that the integral of a 'Constant' instance is " - 'properly evaluated on the given upper and lower bounds.', - () { - final constant = Algebraic.from( - const [Complex(2, -5)], - ); - final integral = constant.evaluateIntegralOn(4, 5); - - expect(integral.real.round(), equals(2)); - expect(integral.imaginary.round(), equals(-5)); - }, - ); - - test( - "Making sure that that the integral of a 'Linear' instance is " - 'properly evaluated on the given upper and lower bounds.', - () { - // Real polynomial test - final realEq = Linear.realEquation( - a: -6, - b: 2, - ); - - final realRes = realEq.evaluateIntegralOn(2, 1); - expect(realRes.real, const MoreOrLessEquals(7, precision: 0)); - - // Complex polynomial test - final complexEq = Linear( - a: const Complex(4, -3), - ); - - final complexRes = complexEq.evaluateIntegralOn(0, 3); - - expect( - complexRes.real, - const MoreOrLessEquals(18, precision: 1.0e-1), - ); - expect( - complexRes.imaginary, - const MoreOrLessEquals(-13.5, precision: 1.0e-1), - ); - }, - ); - - test( - "Making sure that that the integral of a 'Quadratic' instance is " - 'properly evaluated on the given upper and lower bounds.', - () { - // Real polynomial test - final realEq = Quadratic.realEquation( - a: 2, - c: -5, - ); - - final realRes = realEq.evaluateIntegralOn(1, 3); - - expect( - realRes.real, - const MoreOrLessEquals(7.3, precision: 1.0e-1), - ); - - // Complex polynomial test - final complexEq = Quadratic( - a: const Complex(3, -5), - b: const Complex(1, 2), - c: const Complex.fromImaginary(4), - ); - - final complexRes = complexEq.evaluateIntegralOn(-1, 5); - - expect( - complexRes.real, - const MoreOrLessEquals(138, precision: 1.0e-1), - ); - expect( - complexRes.imaginary, - const MoreOrLessEquals(-162, precision: 1.0e-1), - ); - }, - ); - - test( - "Making sure that that the integral of a 'Cubic' instance is " - 'properly evaluated on the given upper and lower bounds.', - () { - // Real polynomial test - final realEq = Cubic.realEquation(c: 3, d: -5); - - final realRes = realEq.evaluateIntegralOn(1, 3); - expect(realRes.real.round(), equals(22)); - - // Complex polynomial test - final complexEq = Cubic( - a: const Complex(3, -5), - b: const Complex(1, 2), - c: const Complex.fromImaginary(4), - d: const Complex.fromReal(4), - ); - - final complexRes = complexEq.evaluateIntegralOn(-1, 5); - expect( - complexRes.real, - const MoreOrLessEquals(534, precision: 1.0e-1), - ); - expect( - complexRes.imaginary, - const MoreOrLessEquals(-648, precision: 1.0e-1), - ); - }, - ); - - test( - "Making sure that that the integral of a 'Quartic' instance is " - 'properly evaluated on the given upper and lower bounds.', - () { - // Real polynomial test - final realEq = - Quartic.realEquation(a: 3, b: -1, c: 4, d: 0.5, e: -2); - - final realRes = realEq.evaluateIntegralOn(2, -2); - expect( - realRes.real, - const MoreOrLessEquals(-51.73, precision: 1.0e-2), - ); - - // Complex polynomial test - final complexEq = Quartic( - a: const Complex.i(), - b: const Complex(-3, 5), - c: const Complex(4, 1), - d: -const Complex.i(), - ); - - final complexRes = complexEq.evaluateIntegralOn(0.5, 1.2); - expect( - complexRes.real, - const MoreOrLessEquals(0.629, precision: 1.0e-4), - ); - expect( - complexRes.imaginary, - const MoreOrLessEquals(2.9446, precision: 1.0e-4), - ); - }, - ); - }); - - group('Testing arithmetic operations on polynomials', () { - // Tests with complex numbers - test('Sum of two polynomials', () { - final complex1 = Algebraic.from( - const [ - Complex(-3, 10), - Complex.i(), - Complex.fromImaginary(6), - ], - ); - final complex2 = Algebraic.fromReal( - [1, 5], - ); - - final sum = complex1 + complex2; - final sumResult = Algebraic.from( - const [ - Complex(-3, 10), - Complex(1, 1), - Complex(5, 6), - ], - ); - - expect(sum, equals(sumResult)); - expect(sum, equals(complex2 + complex1)); - expect(sum, isA()); - }); - - test('Difference of two polynomials', () { - final complex1 = Algebraic.from( - const [ - Complex(-4, -7), - Complex(2, 3), - Complex.zero(), - ], - ); - final complex2 = Algebraic.from( - [ - const Complex(3, 6), - -const Complex.i(), - const Complex(7, -8), - const Complex(1, -3), - const Complex(5, 6), - ], - ); - - final diff = complex1 - complex2; - final diffResult = Algebraic.from( - [ - const Complex(-3, -6), - const Complex.i(), - const Complex(-11, 1), - const Complex(1, 6), - -const Complex(5, 6), - ], - ); - - expect(diff, equals(diffResult)); - expect(complex2 - complex1, equals(-diffResult)); - expect(diffResult, isA()); - }); - - test('Product of two polynomials', () { - final complex1 = Algebraic.from( - [ - Complex.fromImaginaryFraction(Fraction(6, 2)), - -const Complex.i(), - ], - ); - final complex2 = Algebraic.from( - const [ - Complex(4, 2), - Complex.fromImaginary(19), - Complex(9, -16), - Complex(-2, 3), - ], - ); - - final prod = complex1 * complex2; - final prodResult = Algebraic.from( - const [ - Complex(-6, 12), - Complex(-55, -4), - Complex(67, 27), - Complex(-25, -15), - Complex(3, 2), - ], - ); - - expect(prod, equals(prodResult)); - expect(prod, equals(complex2 * complex1)); - expect(prod, isA()); - }); - - test('Division of two polynomials', () { - final complex1 = Algebraic.from( - const [ - Complex.fromReal(1), - Complex(-3, -1), - Complex.fromReal(4), - ], - ); - final complex2 = Algebraic.from( - [ - const Complex.fromReal(1), - -const Complex.i(), - ], - ); - - final div = complex1 / complex2; - final divResult = AlgebraicDivision( - quotient: Algebraic.fromReal( - const [1, -3], - ), - remainder: Algebraic.from( - const [Complex(4, -3)], - ), - ); - - expect( - div.quotient, - equals( - Algebraic.fromReal( - const [1, -3], - ), - ), - ); - expect( - div.remainder, - equals( - Algebraic.from( - const [Complex(4, -3)], - ), - ), - ); - expect(div.quotient, isA()); - expect(div.remainder, isA()); - expect(div, equals(divResult)); - - const strResult = 'Q = 1x + -3\nR = (4 - 3i)'; - expect(div.toString(), strResult); - }); - - // Tests with real numbers - test('Sum of two polynomials', () { - final quadratic = Algebraic.fromReal( - [3, -2, 5], - ); - final linear = Algebraic.fromReal( - [4, -10], - ); - - final sum = quadratic + linear; - final sumResult = Algebraic.fromReal( - [3, 2, -5], - ); - - expect(sum, equals(sumResult)); - expect(sum, equals(linear + quadratic)); - expect(sum, isA()); - }); - - test('Difference of two polynomials', () { - final quadratic = Algebraic.fromReal( - [3, -2, 1], - ); - final quartic = Algebraic.fromReal( - [4, 6, 5, -3, 8], - ); - - final diff = quadratic - quartic; - final diffResult = Algebraic.fromReal( - [-4, -6, -2, 1, -7], - ); - - expect(diff, equals(diffResult)); - expect(quartic - quadratic, equals(-diffResult)); - expect(diffResult, isA()); - }); - - test('Product of two polynomials', () { - final linear = Algebraic.fromReal( - [2, -2], - ); - final cubic = Algebraic.fromReal( - [1, 0, -4, 5], - ); - - final prod = linear * cubic; - final prodResult = Algebraic.fromReal( - [2, -2, -8, 18, -10], - ); - - expect(prod, equals(prodResult)); - expect(prod, equals(cubic * linear)); - expect(prod, isA()); - }); - - test('Division of two polynomials', () { - final numerator = Algebraic.fromReal( - [1, -3, 2], - ); - final denominator = Algebraic.fromReal( - [1, 2], - ); - - final result = numerator / denominator; - - expect(result, isA()); - expect( - result.quotient, - equals( - Algebraic.fromReal( - [1, -5], - ), - ), - ); - expect( - result.remainder, - equals( - Algebraic.fromReal( - [12], - ), - ), - ); - expect(result.quotient, isA()); - expect(result.remainder, isA()); - }); - }); - }, - ); -} diff --git a/test/algebraic/cubic_test.dart b/test/algebraic/cubic_test.dart deleted file mode 100644 index 0a08d168..00000000 --- a/test/algebraic/cubic_test.dart +++ /dev/null @@ -1,239 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing 'Cubic' algebraic equations", () { - test("Making sure that a 'Cubic' object is properly constructed", () { - final equation = Cubic( - a: const Complex.fromReal(-1), - c: const Complex.fromReal(5), - d: const Complex.fromReal(-9), - ); - - // Checking properties - expect(equation.degree, equals(3)); - expect( - equation.derivative(), - Quadratic( - a: const Complex.fromReal(-3), - c: const Complex.fromReal(5), - ), - ); - expect(equation.isRealEquation, isTrue); - expect(equation.discriminant(), equals(const Complex.fromReal(-1687))); - expect( - equation.coefficients, - equals( - const [ - Complex.fromReal(-1), - Complex.zero(), - Complex.fromReal(5), - Complex.fromReal(-9), - ], - ), - ); - - // Making sure that coefficients can be accessed via index - expect(equation[0], equals(const Complex.fromReal(-1))); - expect(equation[1], equals(const Complex.zero())); - expect(equation[2], equals(const Complex.fromReal(5))); - expect(equation[3], equals(const Complex.fromReal(-9))); - - expect(() => equation[-1], throwsA(isA())); - - expect(equation.coefficient(3), equals(const Complex.fromReal(-1))); - expect(equation.coefficient(2), equals(const Complex.zero())); - expect(equation.coefficient(1), equals(const Complex.fromReal(5))); - expect(equation.coefficient(0), equals(const Complex.fromReal(-9))); - expect(equation.coefficient(4), isNull); - - // Converting to string - expect(equation.toString(), equals('f(x) = -1x^3 + 5x + -9')); - expect( - equation.toStringWithFractions(), - equals('f(x) = -1x^3 + 5x + -9'), - ); - - // Checking solutions - final solutions = equation.solutions(); - expect(solutions[2].real, const MoreOrLessEquals(1.42759826966)); - expect(solutions[2].imaginary, const MoreOrLessEquals(1.055514309999)); - expect(solutions[1].real, const MoreOrLessEquals(-2.855196539321)); - expect(solutions[1].imaginary.round(), isZero); - expect(solutions.first.real, const MoreOrLessEquals(1.42759826966)); - expect( - solutions.first.imaginary, - const MoreOrLessEquals(-1.055514309999), - ); - - // Evaluation - final eval = equation.realEvaluateOn(0.5); - expect(eval, Complex.fromRealFraction(Fraction(-53, 8))); - }); - - test( - "Making sure that a correct 'Cubic' instance is created from a list " - "of 'double' (real) values", - () { - final cubic = Cubic.realEquation(a: 5, b: 1, c: -6); - - expect(cubic.a, equals(const Complex.fromReal(5))); - expect(cubic.b, equals(const Complex.fromReal(1))); - expect(cubic.c, equals(const Complex.fromReal(-6))); - expect(cubic.d, equals(const Complex.zero())); - - // There must be an exception is the first coeff. is zero - expect( - () => Cubic.realEquation(a: 0), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that an exception is thrown if the coeff. of the ' - 'highest degree is zero', - () { - expect( - () => Cubic(a: const Complex.zero()), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly', () { - final fx = Cubic( - a: const Complex(2, -3), - b: Complex.fromImaginaryFraction(Fraction(6, 5)), - c: const Complex(5, -1), - d: const Complex(-9, -6), - ); - - final otherFx = Cubic( - a: const Complex(2, -3), - b: Complex.fromImaginaryFraction(Fraction(6, 5)), - c: const Complex(5, -1), - d: const Complex(-9, -6), - ); - - expect(fx, equals(otherFx)); - expect(otherFx, equals(fx)); - expect(fx == otherFx, isTrue); - expect(otherFx == fx, isTrue); - - expect( - fx, - equals( - Cubic( - a: const Complex(2, -3), - b: Complex.fromImaginaryFraction(Fraction(6, 5)), - c: const Complex(5, -1), - d: const Complex(-9, -6), - ), - ), - ); - expect( - Cubic( - a: const Complex(2, -3), - b: Complex.fromImaginaryFraction(Fraction(6, 5)), - c: const Complex(5, -1), - d: const Complex(-9, -6), - ), - equals(fx), - ); - - expect(fx.hashCode, equals(otherFx.hashCode)); - }); - - test("Making sure that 'copyWith' clones objects correctly", () { - final cubic = Cubic.realEquation(a: 7, c: 13); - - // Objects equality - expect(cubic, equals(cubic.copyWith())); - expect( - cubic, - equals( - cubic.copyWith( - a: const Complex(7, 0), - c: const Complex(13, 0), - ), - ), - ); - - // Objects inequality - expect(cubic == cubic.copyWith(b: const Complex.fromReal(7)), isFalse); - }); - - test('Batch tests', () { - final equations = [ - Cubic.realEquation( - a: 2, - b: 3, - c: -11, - d: -6, - ).solutions(), - Cubic( - a: const Complex.i(), - c: const Complex(-2, 5), - d: const Complex.fromReal(7), - ).solutions(), - Cubic.realEquation( - a: -4, - c: 8, - ).solutions(), - Cubic.realEquation( - b: 1, - c: 1, - d: 1, - ).solutions(), - Cubic( - a: const Complex.i(), - b: const Complex(5, -8), - ).solutions(), - ]; - - final solutions = >[ - const [ - Complex.fromReal(-3), - Complex.fromReal(2), - Complex.fromReal(-0.5), - ], - const [ - Complex(0.73338, 0.97815), - Complex(0.31133, -2.75745), - Complex(-1.04472, 1.77929), - ], - const [ - Complex.fromReal(1.41421), - Complex.fromReal(-1.41421), - Complex.zero(), - ], - const [ - Complex.fromReal(-1), - Complex.fromImaginary(-1), - Complex.i(), - ], - const [ - Complex.zero(), - Complex.zero(), - Complex(8, 5), - ], - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - equations[i][j].real, - MoreOrLessEquals(solutions[i][j].real, precision: 1.0e-5), - ); - expect( - equations[i][j].imaginary, - MoreOrLessEquals(solutions[i][j].imaginary, precision: 1.0e-5), - ); - } - } - }); - }); -} diff --git a/test/algebraic/durand_kerner_test.dart b/test/algebraic/durand_kerner_test.dart deleted file mode 100644 index 12705fef..00000000 --- a/test/algebraic/durand_kerner_test.dart +++ /dev/null @@ -1,401 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'DurandKerner' class for polynomial roots finding", () { - test( - "Making sure that a 'DurandKerner' object is properly constructed", - () { - final equation = DurandKerner( - coefficients: const [ - Complex.i(), - Complex.fromReal(3), - Complex(5, 6), - ], - ); - - // Checking properties - expect(equation.degree, equals(2)); - expect(equation.derivative(), isA()); - expect(equation.isRealEquation, isFalse); - expect(equation.discriminant(), const Complex(33, -20)); - expect( - equation.coefficients, - equals( - const [ - Complex.i(), - Complex.fromReal(3), - Complex(5, 6), - ], - ), - ); - - // Making sure that coefficients can be accessed via index - expect(equation[0], equals(const Complex.i())); - expect(equation[1], equals(const Complex.fromReal(3))); - expect(equation[2], equals(const Complex(5, 6))); - - expect(() => equation[-1], throwsA(isA())); - - expect(equation.coefficient(2), equals(const Complex.i())); - expect(equation.coefficient(1), equals(const Complex.fromReal(3))); - expect(equation.coefficient(0), equals(const Complex(5, 6))); - expect(equation.coefficient(3), isNull); - - // Converting to string - expect( - equation.toString(), - equals('f(x) = 1ix^2 + 3x + (5 + 6i)'), - ); - expect( - equation.toStringWithFractions(), - equals('f(x) = 1ix^2 + 3x + (5 + 6i)'), - ); - - // Checking solutions - final solutions = equation.solutions(); - - expect( - solutions[1].real, - const MoreOrLessEquals(-0.8357, precision: 1.0e-4), - ); - expect( - solutions[1].imaginary, - const MoreOrLessEquals(-1.4914, precision: 1.0e-4), - ); - expect( - solutions.first.real, - const MoreOrLessEquals(0.8357, precision: 1.0e-4), - ); - expect( - solutions.first.imaginary, - const MoreOrLessEquals(4.4914, precision: 1.0e-4), - ); - - // Evaluation - final eval = equation.realEvaluateOn(2); - expect(eval, equals(const Complex(11, 10))); - }, - ); - - test( - 'Making sure that, when the polynomial degree is 0 (so it is a simple ' - 'constant, the returned list is empty.', - () { - final noSolutions = DurandKerner.realEquation( - coefficients: [1], - ); - - expect(noSolutions.solutions().length, isZero); - }, - ); - - test( - "Making sure that a correct 'DurandKerner' instance is created from a" - " list of 'double' (real) values", - () { - final durandKerner = DurandKerner.realEquation( - coefficients: [1, 2, 3], - ); - - expect(durandKerner[0], equals(const Complex.fromReal(1))); - expect(durandKerner[1], equals(const Complex.fromReal(2))); - expect(durandKerner[2], equals(const Complex.fromReal(3))); - - // There must be an exception is the first coeff. is zero - expect( - () => DurandKerner.realEquation( - coefficients: [0, 3, 6], - ), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that an exception is thrown if the coefficient with the ' - 'highest degree is zero', - () { - expect( - () => DurandKerner( - coefficients: const [Complex.zero()], - ), - throwsA(isA()), - ); - }, - ); - - test('Making sure that derivatives types are correct.', () { - final polynomialDegree6 = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5, 6, 7], - ); - final polynomialDegree5 = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5, 6], - ); - final polynomialDegree4 = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5], - ); - final polynomialDegree3 = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4], - ); - final polynomialDegree2 = DurandKerner.realEquation( - coefficients: [1, 2, 3], - ); - final polynomialDegree1 = DurandKerner.realEquation( - coefficients: [1, 2], - ); - final polynomialDegree0 = DurandKerner.realEquation( - coefficients: [1], - ); - - expect(polynomialDegree6.derivative(), isA()); - expect(polynomialDegree5.derivative(), isA()); - expect(polynomialDegree4.derivative(), isA()); - expect(polynomialDegree3.derivative(), isA()); - expect(polynomialDegree2.derivative(), isA()); - expect(polynomialDegree1.derivative(), isA()); - expect(polynomialDegree0.derivative(), isA()); - }); - - test( - 'Making sure that the derivative of a polynomial whose degree is > 4' - ' are correctly computed.', - () { - final durandKerner1 = DurandKerner.realEquation( - coefficients: [2, 0, -2, 0, 7, 0], - ); - - expect( - durandKerner1.derivative(), - equals( - Algebraic.fromReal( - [10, 0, -6, 0, 7], - ), - ), - ); - expect( - durandKerner1.discriminant().real, - equals(29679104), - ); - expect( - durandKerner1.discriminant().imaginary, - isZero, - ); - - final durandKerner2 = DurandKerner.realEquation( - coefficients: [1, -5, 2, -2, 0, 7, 13], - ); - - expect( - durandKerner2.derivative(), - equals( - Algebraic.fromReal( - [6, -25, 8, -6, 0, 7], - ), - ), - ); - expect( - durandKerner2.discriminant().real.round(), - equals(1002484790644), - ); - expect( - durandKerner2.discriminant().imaginary, - isZero, - ); - }, - ); - - test('Making sure that objects comparison works properly', () { - final fx = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5], - ); - final otherFx = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5], - ); - - final notEqual = DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5], - initialGuess: List.generate(4, (_) => const Complex.zero()), - ); - - expect(fx, equals(otherFx)); - expect(fx == otherFx, isTrue); - expect(otherFx, equals(fx)); - expect(otherFx == fx, isTrue); - - expect( - fx, - equals( - DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5], - ), - ), - ); - expect( - DurandKerner.realEquation( - coefficients: [1, 2, 3, 4, 5], - ), - equals(fx), - ); - - expect(fx.hashCode, equals(otherFx.hashCode)); - - expect(fx == notEqual, isFalse); - expect(fx.hashCode == notEqual.hashCode, isFalse); - - expect( - DurandKerner( - coefficients: const [ - Complex(3, -2), - Complex.zero(), - Complex.fromReal(7), - ], - initialGuess: const [ - Complex(3, 2), - Complex.fromImaginary(8), - ], - ), - equals( - DurandKerner( - coefficients: const [ - Complex(3, -2), - Complex.zero(), - Complex.fromReal(7), - ], - initialGuess: const [ - Complex(3, 2), - Complex.fromImaginary(8), - ], - ), - ), - ); - }); - - test("Making sure that 'copyWith' clones objects correctly", () { - final durandKerner = DurandKerner.realEquation( - coefficients: [1, 2, 3], - ); - - // Objects equality - expect( - durandKerner, - equals(durandKerner.copyWith()), - ); - expect( - durandKerner, - equals( - durandKerner.copyWith( - maxSteps: 2000, - ), - ), - ); - - // Objects inequality - expect( - durandKerner == - durandKerner.copyWith( - maxSteps: 1, - ), - isFalse, - ); - }); - - test('Batch tests', () { - final equations = [ - DurandKerner.realEquation( - coefficients: [2, 3, -11, -6], - ).solutions(), - DurandKerner.realEquation( - coefficients: [1, -5, 2, -2, 0, 7, 13], - precision: 1.0e-15, - ).solutions(), - DurandKerner.realEquation( - coefficients: [2, 1, -2, 1, 7], - precision: 1.0e-15, - ).solutions(), - DurandKerner( - coefficients: const [ - Complex(3, -2), - Complex.zero(), - Complex.fromReal(7), - Complex.fromReal(-1), - ], - ).solutions(), - DurandKerner( - coefficients: const [ - Complex.fromReal(1), - Complex.zero(), - Complex.i(), - Complex.zero(), - Complex.zero(), - Complex(1, -6), - ], - ).solutions(), - DurandKerner.realEquation( - coefficients: [ - 1, - 2, - 1, - ], - initialGuess: const [ - Complex.fromReal(-2), - Complex.fromReal(-2), - ], - ).solutions(), - ]; - - const solutions = >[ - [ - Complex.fromReal(2), - Complex.fromReal(-3), - Complex.fromReal(-0.5), - ], - [ - Complex(-0.823, -0.5491), - Complex(0.2501, 1.3561), - Complex.fromReal(1.5048), - Complex(0.2501, -1.3561), - Complex.fromReal(4.6407), - Complex(-0.823, 0.5491), - ], - [ - Complex(-1.2215, 0.6934), - Complex(0.9715, 0.911), - Complex(0.9715, -0.911), - Complex(-1.2215, -0.6934), - ], - [ - Complex(0.1416, 0.0007), - Complex(-0.4731, 1.3384), - Complex(0.3314, -1.3391), - ], - [ - Complex(-0.7022, -1.1129), - Complex(1.2952, 0.3689), - Complex(1.0034, -1.2234), - Complex(-1.4083, 0.5424), - Complex(-0.1881, 1.425), - ], - [ - Complex.fromReal(-1), - Complex.fromReal(-1), - ], - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - expect( - equations[i][j].real, - MoreOrLessEquals(solutions[i][j].real, precision: 1.0e-4), - ); - expect( - equations[i][j].imaginary, - MoreOrLessEquals(solutions[i][j].imaginary, precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/algebraic/linear_test.dart b/test/algebraic/linear_test.dart deleted file mode 100644 index a20388e3..00000000 --- a/test/algebraic/linear_test.dart +++ /dev/null @@ -1,223 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing 'Linear' algebraic equations", () { - test("Making sure that a 'Linear' object is properly constructed", () { - final equation = Linear( - a: const Complex.fromReal(3), - b: Complex.fromRealFraction(Fraction(6, 5)), - ); - - // Checking properties - expect(equation.degree, equals(1)); - expect( - equation.derivative(), - equals( - Constant(a: const Complex.fromReal(3)), - ), - ); - expect(equation.isRealEquation, isTrue); - expect(equation.discriminant(), equals(const Complex.fromReal(1))); - expect( - equation.coefficients, - equals( - [ - const Complex.fromReal(3), - Complex.fromRealFraction(Fraction(6, 5)), - ], - ), - ); - - // Making sure that coefficients can be accessed via index - expect(equation[0], equals(const Complex.fromReal(3))); - expect(equation[1], equals(Complex.fromRealFraction(Fraction(6, 5)))); - - expect(() => equation[-1], throwsA(isA())); - - expect(equation.coefficient(1), equals(const Complex.fromReal(3))); - expect( - equation.coefficient(0), - equals(Complex.fromRealFraction(Fraction(6, 5))), - ); - expect(equation.coefficient(2), isNull); - - // Converting to string - expect(equation.toString(), equals('f(x) = 3x + 1.2')); - expect(equation.toStringWithFractions(), equals('f(x) = 3x + 6/5')); - - // Checking solutions - final solutions = equation.solutions(); - expect( - solutions.first.real, - const MoreOrLessEquals(-0.4, precision: 1.0e-1), - ); - expect(solutions.first.imaginary, isZero); - - // Evaluation - expect( - equation.realEvaluateOn(1), - equals(const Complex.fromReal(4.2)), - ); - expect( - equation.evaluateOn(const Complex(1, -3)), - equals(const Complex(4.2, -9)), - ); - }); - - test("Making sure that 'Linear' is properly printed with fractions", () { - // The equation - final equation = Linear( - a: const Complex(4, 7), - b: const Complex(5, 1), - ); - - // Its string representation - const equationStr = 'f(x) = (4 + 7i)x + (5 + 1i)'; - - // Making sure it's properly printed - expect(equation.toStringWithFractions(), equals(equationStr)); - }); - - test( - "Making sure that a correct 'Linear' instance is created from a " - "list of 'double' (real) values", - () { - final linear = Linear.realEquation(a: 5, b: 1); - - expect(linear.a, equals(const Complex.fromReal(5))); - expect(linear.b, equals(const Complex.fromReal(1))); - - // There must be an exception is the first coeff. is zero - expect( - () => Linear.realEquation(a: 0), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that an exception is thrown if the coeff. of the ' - 'highest degree is zero', - () { - expect( - () => Linear(a: const Complex.zero()), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly', () { - final fx = Linear( - a: const Complex(2, 3), - b: const Complex.i(), - ); - - expect( - fx, - equals( - Linear( - a: const Complex(2, 3), - b: const Complex.i(), - ), - ), - ); - expect( - Linear( - a: const Complex(2, 3), - b: const Complex.i(), - ), - equals(fx), - ); - expect( - fx == - Linear( - a: const Complex(2, 3), - b: const Complex.i(), - ), - isTrue, - ); - expect( - Linear( - a: const Complex(2, 3), - b: const Complex.i(), - ) == - fx, - isTrue, - ); - expect( - fx.hashCode, - equals( - Linear( - a: const Complex(2, 3), - b: const Complex.i(), - ).hashCode, - ), - ); - }); - - test("Making sure that 'copyWith' clones objects correctly", () { - final linear = Linear( - a: const Complex.i(), - b: const Complex(-3, 8), - ); - - // Objects equality - expect(linear, equals(linear.copyWith())); - expect( - linear, - equals( - linear.copyWith(a: const Complex.i(), b: const Complex(-3, 8)), - ), - ); - - // Objects inequality - expect(linear == linear.copyWith(b: const Complex.zero()), isFalse); - }); - - test('Batch tests', () { - final equations = [ - Linear.realEquation( - a: 2, - b: 3, - ).solutions(), - Linear( - a: const Complex.i(), - b: const Complex(4, -6), - ).solutions(), - Linear().solutions(), - Linear.realEquation( - a: -61, - b: -61, - ).solutions(), - Linear( - a: const Complex.i(), - b: -const Complex.i(), - ).solutions(), - ]; - - final solutions = >[ - const [Complex.fromReal(-3 / 2)], - const [Complex(6, 4)], - const [Complex.zero()], - const [Complex.fromReal(-1)], - const [Complex.fromReal(1)], - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - expect( - equations[i][j].real, - MoreOrLessEquals(solutions[i][j].real, precision: 1.0e-5), - ); - expect( - equations[i][j].imaginary, - MoreOrLessEquals(solutions[i][j].imaginary, precision: 1.0e-5), - ); - } - } - }); - }); -} diff --git a/test/algebraic/quadratic_test.dart b/test/algebraic/quadratic_test.dart deleted file mode 100644 index 0e4d6bd3..00000000 --- a/test/algebraic/quadratic_test.dart +++ /dev/null @@ -1,239 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing 'Quadratic' algebraic equations", () { - test("Making sure that a 'Quadratic' object is properly constructed", () { - final equation = Quadratic( - a: const Complex.fromReal(2), - b: const Complex.fromReal(-5), - c: Complex.fromRealFraction(Fraction(3, 2)), - ); - - // Checking properties - expect(equation.degree, equals(2)); - expect( - equation.derivative(), - Linear( - a: const Complex.fromReal(4), - b: const Complex.fromReal(-5), - ), - ); - expect(equation.isRealEquation, isTrue); - expect( - equation.discriminant(), - equals(const Complex.fromReal(13)), - ); - expect( - equation.coefficients, - equals( - [ - const Complex.fromReal(2), - const Complex.fromReal(-5), - Complex.fromRealFraction(Fraction(3, 2)), - ], - ), - ); - - // Making sure that coefficients can be accessed via index - expect(equation[0], equals(const Complex.fromReal(2))); - expect(equation[1], equals(const Complex.fromReal(-5))); - expect(equation[2], equals(Complex.fromRealFraction(Fraction(3, 2)))); - - expect(() => equation[-1], throwsA(isA())); - - expect(equation.coefficient(2), equals(const Complex.fromReal(2))); - expect(equation.coefficient(1), equals(const Complex.fromReal(-5))); - expect( - equation.coefficient(0), - equals(Complex.fromRealFraction(Fraction(3, 2))), - ); - expect(equation.coefficient(3), isNull); - - // Converting to string - expect(equation.toString(), equals('f(x) = 2x^2 + -5x + 1.5')); - expect( - equation.toStringWithFractions(), - equals('f(x) = 2x^2 + -5x + 3/2'), - ); - - // Checking solutions - final solutions = equation.solutions(); - expect(solutions.first.real, const MoreOrLessEquals(2.151387818866)); - expect(solutions.first.imaginary, isZero); - expect(solutions[1].real, const MoreOrLessEquals(0.348612181134)); - expect(solutions[1].imaginary, isZero); - - // Evaluation - final eval = equation.realEvaluateOn(Fraction(-2, 5).toDouble()); - expect(eval.real.toStringAsFixed(2), equals('3.82')); - expect(eval.imaginary.round(), isZero); - }); - - test( - 'Making sure that an exception is thrown if the coeff. of the ' - 'highest degree is zero', - () { - expect( - () => Quadratic( - a: const Complex.zero(), - b: const Complex.i(), - c: const Complex.fromReal(4), - ), - throwsA(isA()), - ); - }, - ); - - test( - "Making sure that a correct 'Quadratic' instance is created from a " - "list of 'double' (real) values", - () { - final quadratic = Quadratic.realEquation(a: -3, b: 2, c: 1); - - expect(quadratic.a, equals(const Complex.fromReal(-3))); - expect(quadratic.b, equals(const Complex.fromReal(2))); - expect(quadratic.c, equals(const Complex.fromReal(1))); - - // There must be an exception is the first coeff. is zero - expect( - () => Quadratic.realEquation(a: 0), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly', () { - final fx = Quadratic( - a: const Complex(2, 3), - b: const Complex.i(), - c: const Complex(-1, 0), - ); - - final otherFx = Quadratic( - a: const Complex(2, 3), - b: const Complex.i(), - c: const Complex(-1, 0), - ); - - expect(fx, equals(otherFx)); - expect(fx == otherFx, isTrue); - expect(otherFx, equals(fx)); - expect(otherFx == fx, isTrue); - - expect( - fx, - equals( - Quadratic( - a: const Complex(2, 3), - b: const Complex.i(), - c: const Complex(-1, 0), - ), - ), - ); - expect( - Quadratic( - a: const Complex(2, 3), - b: const Complex.i(), - c: const Complex(-1, 0), - ), - equals(fx), - ); - expect( - fx == - Quadratic( - a: const Complex(2, 3), - b: const Complex.i(), - c: const Complex(-1, 0), - ), - isTrue, - ); - expect( - Quadratic( - a: const Complex(2, 3), - b: const Complex.i(), - c: const Complex(-1, 0), - ) == - fx, - isTrue, - ); - - expect(fx.hashCode, equals(otherFx.hashCode)); - }); - - test("Making sure that 'copyWith' clones objects correctly", () { - final quadratic = Quadratic( - a: const Complex.i(), - b: const Complex(6, -1), - c: const Complex.i(), - ); - - // Objects equality - expect(quadratic, equals(quadratic.copyWith())); - expect( - quadratic, - equals( - quadratic.copyWith( - a: const Complex.i(), - b: const Complex(6, -1), - c: const Complex.i(), - ), - ), - ); - - // Objects inequality - expect(quadratic == quadratic.copyWith(b: const Complex.zero()), isFalse); - }); - - test('Batch tests', () { - final equations = [ - Quadratic.realEquation(a: -3, b: 1 / 5, c: 16).solutions(), - Quadratic.realEquation(b: 5, c: -4).solutions(), - Quadratic( - a: const Complex(3, 1), - b: const Complex(2, -7), - ).solutions(), - Quadratic().solutions(), - Quadratic.realEquation(a: 9, b: 6, c: -6).solutions(), - ]; - - final solutions = >[ - const [ - Complex.fromReal(-2.2763), - Complex.fromReal(2.3429), - ], - const [ - Complex.fromReal(0.7015), - Complex.fromReal(-5.7016), - ], - const [ - Complex.zero(), - Complex(0.1, 2.3), - ], - const [ - Complex.zero(), - Complex.zero(), - ], - const [ - Complex.fromReal(0.5485), - Complex.fromReal(-1.2153), - ], - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - expect( - equations[i][j].real, - MoreOrLessEquals(solutions[i][j].real, precision: 1.0e-4), - ); - expect( - equations[i][j].imaginary, - MoreOrLessEquals(solutions[i][j].imaginary, precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/algebraic/quartic_test.dart b/test/algebraic/quartic_test.dart deleted file mode 100644 index 8d98d0f4..00000000 --- a/test/algebraic/quartic_test.dart +++ /dev/null @@ -1,279 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing 'Quartic' algebraic equations", () { - test("Making sure that a 'Quartic' object is properly constructed", () { - final equation = Quartic.realEquation(a: 3, b: 6, d: 2, e: -1); - - // Checking properties - expect(equation.degree, equals(4)); - expect( - equation.derivative(), - Cubic( - a: const Complex.fromReal(12), - b: const Complex.fromReal(18), - d: const Complex.fromReal(2), - ), - ); - expect(equation.isRealEquation, isTrue); - expect(equation.discriminant(), equals(const Complex.fromReal(-70848))); - expect( - equation.coefficients, - equals( - const [ - Complex.fromReal(3), - Complex.fromReal(6), - Complex.zero(), - Complex.fromReal(2), - Complex.fromReal(-1), - ], - ), - ); - - // Making sure that coefficients can be accessed via index - expect(equation[0], equals(const Complex.fromReal(3))); - expect(equation[1], equals(const Complex.fromReal(6))); - expect(equation[2], equals(const Complex.zero())); - expect(equation[3], equals(const Complex.fromReal(2))); - expect(equation[4], equals(const Complex.fromReal(-1))); - - expect(() => equation[-1], throwsA(isA())); - - expect(equation.coefficient(4), equals(const Complex.fromReal(3))); - expect(equation.coefficient(3), equals(const Complex.fromReal(6))); - expect(equation.coefficient(2), equals(const Complex.zero())); - expect(equation.coefficient(1), equals(const Complex.fromReal(2))); - expect(equation.coefficient(0), equals(const Complex.fromReal(-1))); - expect(equation.coefficient(5), isNull); - - // Converting to string - expect( - equation.toString(), - equals('f(x) = 3x^4 + 6x^3 + 2x + -1'), - ); - expect( - equation.toStringWithFractions(), - equals('f(x) = 3x^4 + 6x^3 + 2x + -1'), - ); - - // Checking solutions - final solutions = equation.solutions(); - expect(solutions.first.real, const MoreOrLessEquals(-2.173571613806)); - expect(solutions.first.imaginary.round(), isZero); - expect(solutions[1].real, const MoreOrLessEquals(0.349518864775)); - expect(solutions[1].imaginary.round(), isZero); - expect(solutions[2].real, const MoreOrLessEquals(-0.087973625484)); - expect(solutions[2].imaginary, const MoreOrLessEquals(0.656527118533)); - expect(solutions[3].real, const MoreOrLessEquals(-0.087973625484)); - expect(solutions[3].imaginary, const MoreOrLessEquals(-0.656527118533)); - - // Evaluation - final eval = equation.realEvaluateOn(2); - expect(eval.real.round(), equals(99)); - expect(eval.imaginary.round(), isZero); - }); - - test( - 'Making sure that an exception is thrown if the coeff. of the highest' - ' degree is zero', - () { - expect( - () => Quartic(a: const Complex.zero()), - throwsA(isA()), - ); - }, - ); - - test( - "Making sure that a correct 'Quadratic' instance is created from a " - "list of 'double' (real) values", - () { - final quartic = Quartic.realEquation(a: -3, d: 8); - - expect(quartic.a, equals(const Complex.fromReal(-3))); - expect(quartic.d, equals(const Complex.fromReal(8))); - - // There must be an exception is the first coeff. is zero - expect( - () => Quartic.realEquation(a: 0), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly', () { - final fx = Quartic( - a: const Complex(3, -6), - b: const Complex.fromImaginary(-2), - c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), - d: const Complex.i(), - e: const Complex.fromReal(9), - ); - - final otherFx = Quartic( - a: const Complex(3, -6), - b: const Complex.fromImaginary(-2), - c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), - d: const Complex.i(), - e: const Complex.fromReal(9), - ); - - expect(fx, equals(otherFx)); - expect(fx == otherFx, isTrue); - expect(otherFx, equals(fx)); - expect(otherFx == fx, isTrue); - - expect( - fx, - equals( - Quartic( - a: const Complex(3, -6), - b: const Complex.fromImaginary(-2), - c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), - d: const Complex.i(), - e: const Complex.fromReal(9), - ), - ), - ); - expect( - Quartic( - a: const Complex(3, -6), - b: const Complex.fromImaginary(-2), - c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), - d: const Complex.i(), - e: const Complex.fromReal(9), - ), - equals(fx), - ); - expect( - fx == - Quartic( - a: const Complex(3, -6), - b: const Complex.fromImaginary(-2), - c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), - d: const Complex.i(), - e: const Complex.fromReal(9), - ), - isTrue, - ); - expect( - Quartic( - a: const Complex(3, -6), - b: const Complex.fromImaginary(-2), - c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), - d: const Complex.i(), - e: const Complex.fromReal(9), - ) == - fx, - isTrue, - ); - - expect(fx.hashCode, equals(otherFx.hashCode)); - }); - - test("Making sure that 'copyWith' clones objects correctly", () { - final quartic = Quartic.realEquation(c: 5, d: -6); - - // Objects equality - expect(quartic, equals(quartic.copyWith())); - expect( - quartic, - equals( - quartic.copyWith( - a: const Complex.fromReal(1), - b: const Complex.zero(), - c: const Complex.fromReal(5), - d: const Complex.fromReal(-6), - // ignore: prefer_const_constructors - e: Complex.zero(), - ), - ), - ); - - // Objects inequality - expect(quartic == quartic.copyWith(c: const Complex.zero()), isFalse); - }); - - test('Batch tests', () { - final equations = [ - Quartic.realEquation( - a: 2, - b: 1, - c: -2, - d: 1, - e: 7, - ).solutions(), - Quartic( - a: const Complex.fromReal(5), - b: const Complex(-5, 12), - d: const Complex.fromReal(1), - ).solutions(), - Quartic.realEquation( - a: 5, - b: 6, - d: -1, - ).solutions(), - Quartic( - a: const Complex(4, -7), - b: const Complex(2, 3), - d: const Complex.fromReal(2), - e: const Complex(10, 1), - ).solutions(), - Quartic( - a: const Complex.i(), - c: -const Complex.i(), - e: const Complex.fromReal(-3), - ).solutions(), - ]; - - final solutions = >[ - const [ - Complex(-1.22152, -0.69349), - Complex(-1.22152, 0.69349), - Complex(0.97152, -0.91106), - Complex(0.97152, 0.91106), - ], - const [ - Complex(-0.23979, -0.1419), - Complex.zero(), - Complex(0.21956, 0.16265), - Complex(1.02023, -2.42074), - ], - const [ - Complex.fromReal(-1), - Complex.fromReal(-0.55826), - Complex.zero(), - Complex.fromReal(0.35826), - ], - const [ - Complex(-0.85119, 0.37549), - Complex(-0.46831, -0.97907), - Complex(0.51992, 0.88058), - Complex(0.99958, -0.677), - ], - const [ - Complex(-1.39765, 0.42028), - Complex(-0.56196, -1.04527), - Complex(0.56196, 1.04527), - Complex(1.39765, -0.42028), - ], - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - expect( - equations[i][j].real, - MoreOrLessEquals(solutions[i][j].real, precision: 1.0e-5), - ); - expect( - equations[i][j].imaginary, - MoreOrLessEquals(solutions[i][j].imaginary, precision: 1.0e-5), - ); - } - } - }); - }); -} diff --git a/test/algebraic/types/algebraic_test.dart b/test/algebraic/types/algebraic_test.dart new file mode 100644 index 00000000..634d19fd --- /dev/null +++ b/test/algebraic/types/algebraic_test.dart @@ -0,0 +1,774 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('Algebraic', () { + group('from constructor (Complex variant)', () { + test('Constant', () { + final equation = Algebraic.from([const Complex(1, 0)]); + expect(equation, isA()); + }); + + test('Linear', () { + final equation = Algebraic.from(const [Complex(1, 0), Complex(2, 0)]); + expect(equation, isA()); + + expect(equation[0], const Complex(1, 0)); + expect(equation[1], const Complex(2, 0)); + expect(equation.coefficient(1), const Complex(1, 0)); + expect(equation.coefficient(0), const Complex(2, 0)); + }); + + test('Quadratic', () { + final equation = Algebraic.from(const [ + Complex(1, 0), + Complex(2, 0), + Complex(3, 0), + ]); + + expect(equation, isA()); + }); + + test('Cubic', () { + final equation = Algebraic.from(const [ + Complex(1, 0), + Complex(2, 0), + Complex(3, 0), + Complex(4, 0), + ]); + expect(equation, isA()); + }); + + test('Quartic', () { + final equation = Algebraic.from(const [ + Complex(1, 0), + Complex(2, 0), + Complex(3, 0), + Complex(4, 0), + Complex(5, 0), + ]); + + expect(equation, isA()); + }); + + test('Quintic (GenericAlgebraic)', () { + final equation = Algebraic.from(const [ + Complex(1, 0), + Complex(2, 0), + Complex(3, 0), + Complex(4, 0), + Complex(5, 0), + Complex(6, 0), + ]); + + expect(equation, isA()); + }); + }); + + // Tests with real numbers + group('from constructor (Real variant)', () { + test('Constant', () { + final equation = Algebraic.fromReal([1]); + expect(equation, isA()); + }); + + test('Linear', () { + final equation = Algebraic.fromReal([1, 2]); + expect(equation, isA()); + }); + + test('Quadratic', () { + final equation = Algebraic.fromReal([1, 2, 3]); + expect(equation, isA()); + }); + + test('Cubic', () { + final equation = Algebraic.fromReal([1, 2, 3, 4]); + expect(equation, isA()); + }); + + test('Qartic', () { + final equation = Algebraic.fromReal([1, 2, 3, 4, 5]); + expect(equation, isA()); + }); + + test('Quintic (GenericAlgebraic)', () { + final equation = Algebraic.fromReal([1, 2, 3, 4, 5, 6]); + expect(equation, isA()); + }); + }); + + group('Integral evaluation', () { + test('Constant', () { + final constant = Algebraic.from(const [Complex(2, -5)]); + final integral = constant.evaluateIntegralOn(4, 5); + + expect(integral.real.round(), equals(2)); + expect(integral.imaginary.round(), equals(-5)); + }); + + test('Linear', () { + // Real polynomial test + final realEq = Linear.realEquation(a: -6, b: 2); + + final realRes = realEq.evaluateIntegralOn(2, 1); + expect(realRes.real, const MoreOrLessEquals(7, precision: 0)); + + // Complex polynomial test + final complexEq = Linear(a: const Complex(4, -3)); + + final complexRes = complexEq.evaluateIntegralOn(0, 3); + + expect(complexRes.real, const MoreOrLessEquals(18, precision: 1.0e-1)); + expect( + complexRes.imaginary, + const MoreOrLessEquals(-13.5, precision: 1.0e-1), + ); + }); + + test('Quadratic', () { + // Real polynomial test + final realEq = Quadratic.realEquation(a: 2, c: -5); + + final realRes = realEq.evaluateIntegralOn(1, 3); + + expect(realRes.real, const MoreOrLessEquals(7.3, precision: 1.0e-1)); + + // Complex polynomial test + final complexEq = Quadratic( + a: const Complex(3, -5), + b: const Complex(1, 2), + c: const Complex.fromImaginary(4), + ); + + final complexRes = complexEq.evaluateIntegralOn(-1, 5); + + expect(complexRes.real, const MoreOrLessEquals(138, precision: 1.0e-1)); + expect( + complexRes.imaginary, + const MoreOrLessEquals(-162, precision: 1.0e-1), + ); + }); + + test('Cubic', () { + // Real polynomial test + final realEq = Cubic.realEquation(c: 3, d: -5); + + final realRes = realEq.evaluateIntegralOn(1, 3); + expect(realRes.real.round(), equals(22)); + + // Complex polynomial test + final complexEq = Cubic( + a: const Complex(3, -5), + b: const Complex(1, 2), + c: const Complex.fromImaginary(4), + d: const Complex.fromReal(4), + ); + + final complexRes = complexEq.evaluateIntegralOn(-1, 5); + expect(complexRes.real, const MoreOrLessEquals(534, precision: 1.0e-1)); + expect( + complexRes.imaginary, + const MoreOrLessEquals(-648, precision: 1.0e-1), + ); + }); + + test('Quartic', () { + // Real polynomial test + final realEq = Quartic.realEquation(a: 3, b: -1, c: 4, d: 0.5, e: -2); + + final realRes = realEq.evaluateIntegralOn(2, -2); + expect(realRes.real, const MoreOrLessEquals(-51.73, precision: 1.0e-2)); + + // Complex polynomial test + final complexEq = Quartic( + a: const Complex.i(), + b: const Complex(-3, 5), + c: const Complex(4, 1), + d: -const Complex.i(), + ); + + final complexRes = complexEq.evaluateIntegralOn(0.5, 1.2); + expect( + complexRes.real, + const MoreOrLessEquals(0.629, precision: 1.0e-4), + ); + expect( + complexRes.imaginary, + const MoreOrLessEquals(2.9446, precision: 1.0e-4), + ); + }); + }); + + group('Operators', () { + // Tests with complex numbers + group('Complex numbers', () { + test('Sum of two polynomials', () { + final complex1 = Algebraic.from(const [ + Complex(-3, 10), + Complex.i(), + Complex.fromImaginary(6), + ]); + final complex2 = Algebraic.fromReal([1, 5]); + + final sum = complex1 + complex2; + final sumResult = Algebraic.from(const [ + Complex(-3, 10), + Complex(1, 1), + Complex(5, 6), + ]); + + expect(sum, equals(sumResult)); + expect(sum, equals(complex2 + complex1)); + expect(sum, isA()); + }); + + test('Difference of two polynomials', () { + final complex1 = Algebraic.from(const [ + Complex(-4, -7), + Complex(2, 3), + Complex.zero(), + ]); + final complex2 = Algebraic.from([ + const Complex(3, 6), + -const Complex.i(), + const Complex(7, -8), + const Complex(1, -3), + const Complex(5, 6), + ]); + + final diff = complex1 - complex2; + final diffResult = Algebraic.from([ + const Complex(-3, -6), + const Complex.i(), + const Complex(-11, 1), + const Complex(1, 6), + -const Complex(5, 6), + ]); + + expect(diff, equals(diffResult)); + expect(complex2 - complex1, equals(-diffResult)); + expect(diffResult, isA()); + }); + + test('Product of two polynomials', () { + final complex1 = Algebraic.from([ + Complex.fromImaginaryFraction(Fraction(6, 2)), + -const Complex.i(), + ]); + final complex2 = Algebraic.from(const [ + Complex(4, 2), + Complex.fromImaginary(19), + Complex(9, -16), + Complex(-2, 3), + ]); + + final prod = complex1 * complex2; + final prodResult = Algebraic.from(const [ + Complex(-6, 12), + Complex(-55, -4), + Complex(67, 27), + Complex(-25, -15), + Complex(3, 2), + ]); + + expect(prod, equals(prodResult)); + expect(prod, equals(complex2 * complex1)); + expect(prod, isA()); + }); + + test('Division of two polynomials', () { + final complex1 = Algebraic.from(const [ + Complex.fromReal(1), + Complex(-3, -1), + Complex.fromReal(4), + ]); + final complex2 = Algebraic.from([ + const Complex.fromReal(1), + -const Complex.i(), + ]); + + final div = complex1 / complex2; + final divResult = ( + quotient: Algebraic.fromReal(const [1, -3]), + remainder: Algebraic.from(const [Complex(4, -3)]), + ); + + expect(div.quotient, equals(Algebraic.fromReal(const [1, -3]))); + expect(div.remainder, equals(Algebraic.from(const [Complex(4, -3)]))); + expect(div.quotient, isA()); + expect(div.remainder, isA()); + expect(div, equals(divResult)); + + expect( + div.toString(), + '(quotient: f(x) = 1x + -3, remainder: f(x) = (4 - 3i))', + ); + }); + }); + + group('Real numbers', () { + test('Sum of two polynomials', () { + final quadratic = Algebraic.fromReal([3, -2, 5]); + final linear = Algebraic.fromReal([4, -10]); + + final sum = quadratic + linear; + final sumResult = Algebraic.fromReal([3, 2, -5]); + + expect(sum, equals(sumResult)); + expect(sum, equals(linear + quadratic)); + expect(sum, isA()); + }); + + test('Difference of two polynomials', () { + final quadratic = Algebraic.fromReal([3, -2, 1]); + final quartic = Algebraic.fromReal([4, 6, 5, -3, 8]); + + final diff = quadratic - quartic; + final diffResult = Algebraic.fromReal([-4, -6, -2, 1, -7]); + + expect(diff, equals(diffResult)); + expect(quartic - quadratic, equals(-diffResult)); + expect(diffResult, isA()); + }); + + test('Product of two polynomials', () { + final linear = Algebraic.fromReal([2, -2]); + final cubic = Algebraic.fromReal([1, 0, -4, 5]); + + final prod = linear * cubic; + final prodResult = Algebraic.fromReal([2, -2, -8, 18, -10]); + + expect(prod, equals(prodResult)); + expect(prod, equals(cubic * linear)); + expect(prod, isA()); + }); + + test('Division of two polynomials', () { + final numerator = Algebraic.fromReal([1, -3, 2]); + final denominator = Algebraic.fromReal([1, 2]); + + final result = numerator / denominator; + + expect(result, isA()); + expect(result.quotient, equals(Algebraic.fromReal([1, -5]))); + expect(result.remainder, equals(Algebraic.fromReal([12]))); + expect(result.quotient, isA()); + expect(result.remainder, isA()); + }); + }); + }); + + group('Factorization', () { + test('Test 1', () { + final constant = Algebraic.fromReal([7]); + final factors = constant.factor(); + + expect(factors, hasLength(1)); + expect(factors.first, equals(Constant.realEquation(a: 7))); + }); + + test('Test 2', () { + final quadratic = Algebraic.fromReal([1, 0, -4]); + final factors = quadratic.factor(); + + expect(factors, hasLength(2)); + expect(factors.first, equals(Linear.realEquation(b: -2))); + expect(factors.last, equals(Linear.realEquation(b: 2))); + }); + + test('Test 3', () { + final cubic = Algebraic.fromReal([-2, 2, -35, 7]); + final factors = cubic.factor(); + + expect(factors, hasLength(3)); + expect( + (factors.first as Linear).b.real, + const MoreOrLessEquals(-0.3990708079262), + ); + expect( + (factors.first as Linear).b.imaginary, + const MoreOrLessEquals(-4.144831831735063), + ); + expect( + (factors[1] as Linear).b.real, + const MoreOrLessEquals(-0.20185838414741988), + ); + expect((factors[1] as Linear).b.imaginary.round(), isZero); + expect( + (factors.last as Linear).b.real, + const MoreOrLessEquals(-0.3990708079262891), + ); + expect( + (factors.last as Linear).b.imaginary, + const MoreOrLessEquals(4.144831831735063), + ); + }); + + test('Test 4', () { + final quartic = Algebraic.fromReal([1, -1, 0, 8, -8]); + final factors = quartic.factor(); + + expect(factors, hasLength(4)); + expect((factors.first as Linear).b.real, equals(2)); + expect((factors.first as Linear).b.imaginary.round(), isZero); + expect((factors[1] as Linear).b.real.round(), equals(-1)); + expect((factors[1] as Linear).b.imaginary.round(), isZero); + expect((factors[2] as Linear).b.real.round(), equals(-1)); + expect( + (factors[2] as Linear).b.imaginary, + const MoreOrLessEquals(-1.732050807568), + ); + expect((factors.last as Linear).b.real.round(), equals(-1)); + expect( + (factors.last as Linear).b.imaginary, + const MoreOrLessEquals(1.732050807568), + ); + }); + + test('Test 5', () { + final constant = Algebraic.from(const [Complex(6, -3)]); + final factors = constant.factor(); + + expect(factors, hasLength(1)); + expect(factors.first, equals(Constant(a: const Complex(6, -3)))); + }); + + test('Test 6', () { + final quadratic = Algebraic.from(const [ + Complex(-2, 3), + Complex.fromImaginary(-6), + Complex(8, 7), + ]); + final factors = quadratic.factor(); + + expect(factors, hasLength(2)); + expect( + (factors.first as Linear).b.real, + const MoreOrLessEquals(-1.7336396048891685), + ); + expect( + (factors.first as Linear).b.imaginary, + const MoreOrLessEquals(-0.6351453340137784), + ); + expect( + (factors.last as Linear).b.real, + const MoreOrLessEquals(0.3490242202737838), + ); + expect( + (factors.last as Linear).b.imaginary, + const MoreOrLessEquals(1.5582222570907014), + ); + }); + + test('Test 7', () { + // 2x² - 8 = 2(x² - 4) = 2(x - 2)(x + 2) + final quadratic = Algebraic.fromReal([2, 0, -8]); + final factors = quadratic.factor(); + + expect(factors, hasLength(2)); + expect(factors.first, equals(Linear.realEquation(b: -2))); + expect(factors.last, equals(Linear.realEquation(b: 2))); + }); + }); + + group('Inequalities', () { + test('Test 1', () { + final equation = Quartic( + a: const Complex.fromReal(2), + c: const Complex.fromReal(-3), + d: const Complex.fromReal(1), + ); + final solutions = equation.solveInequality( + inequalityType: AlgebraicInequalityType.greaterThan, + ); + + expect( + solutions.first, + isA() + .having( + (solution) => solution.value, + 'value', + const MoreOrLessEquals(-1.366025, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + expect( + solutions[1], + isA() + .having((solution) => solution.start.round(), 'start', isZero) + .having( + (solution) => solution.end, + 'end', + const MoreOrLessEquals(0.366025, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + expect( + solutions.last, + isA() + .having((solution) => solution.value, 'value', 1) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + }); + + test('Test 2', () { + final equation = Quartic( + a: const Complex.fromReal(2), + c: const Complex.fromReal(-3), + d: const Complex.fromReal(1), + ); + final solutions = equation.solveInequality( + inequalityType: AlgebraicInequalityType.greaterThanOrEqualTo, + ); + + expect( + solutions.first, + isA() + .having( + (solution) => solution.value, + 'value', + const MoreOrLessEquals(-1.366025, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + expect( + solutions[1], + isA() + .having((solution) => solution.start.round(), 'start', isZero) + .having( + (solution) => solution.end, + 'end', + const MoreOrLessEquals(0.366025, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + true, + ), + ); + expect( + solutions.last, + isA() + .having((solution) => solution.value, 'value', 1) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + true, + ), + ); + }); + + test('Test 3', () { + final equation = Quartic( + a: const Complex.fromReal(2), + c: const Complex.fromReal(-3), + d: const Complex.fromReal(1), + ); + final solutions = equation.solveInequality( + inequalityType: AlgebraicInequalityType.lessThan, + ); + + expect( + solutions.first, + isA() + .having( + (solution) => solution.start, + 'start', + const MoreOrLessEquals(-1.366025, precision: 1.0e-5), + ) + .having((solution) => solution.end.round(), 'end', isZero) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + expect( + solutions.last, + isA() + .having( + (solution) => solution.start, + 'start', + const MoreOrLessEquals(0.366025, precision: 1.0e-5), + ) + .having( + (solution) => solution.end, + 'end', + const MoreOrLessEquals(1, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + }); + + test('Test 4', () { + final equation = Quartic( + a: const Complex.fromReal(2), + c: const Complex.fromReal(-3), + d: const Complex.fromReal(1), + ); + final solutions = equation.solveInequality( + inequalityType: AlgebraicInequalityType.lessThanOrEqualTo, + ); + + expect( + solutions.first, + isA() + .having( + (solution) => solution.start, + 'start', + const MoreOrLessEquals(-1.366025, precision: 1.0e-5), + ) + .having((solution) => solution.end.round(), 'end', isZero) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + true, + ), + ); + expect( + solutions.last, + isA() + .having( + (solution) => solution.start, + 'start', + const MoreOrLessEquals(0.366025, precision: 1.0e-5), + ) + .having( + (solution) => solution.end, + 'end', + const MoreOrLessEquals(1, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + true, + ), + ); + }); + + test('Test 5', () { + expect( + () => + Cubic( + a: const Complex.fromReal(2), + c: const Complex(-3, 1), + d: const Complex.fromReal(1), + ).solveInequality( + inequalityType: AlgebraicInequalityType.greaterThan, + ), + throwsA(isA()), + ); + }); + + test('Test 6', () { + expect( + () => + Quadratic( + a: const Complex.fromReal(2), + b: const Complex.fromReal(1), + ).solveInequality( + inequalityType: AlgebraicInequalityType.lessThan, + precision: -0.001, + ), + throwsA(isA()), + ); + }); + + test('Test 7', () { + final solutions = Linear( + a: const Complex.fromReal(7), + b: const Complex.fromReal(12), + ).solveInequality(inequalityType: AlgebraicInequalityType.greaterThan); + + expect( + solutions.first, + isA() + .having( + (solution) => solution.value, + 'value', + const MoreOrLessEquals(-1.714285, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + false, + ), + ); + }); + + test('Test 8', () { + final solutions = + Linear( + a: const Complex.fromReal(7), + b: const Complex.fromReal(12), + ).solveInequality( + inequalityType: AlgebraicInequalityType.greaterThanOrEqualTo, + ); + + expect( + solutions.first, + isA() + .having( + (solution) => solution.value, + 'value', + const MoreOrLessEquals(-1.714285, precision: 1.0e-5), + ) + .having( + (solution) => solution.isInclusive, + 'isInclusive', + true, + ), + ); + }); + + test('Test 9', () { + final solutions = + Quadratic( + a: const Complex.fromReal(3), + b: const Complex.fromReal(5), + c: const Complex.fromReal(23), + ).solveInequality( + inequalityType: AlgebraicInequalityType.greaterThanOrEqualTo, + ); + + expect(solutions.first, isA()); + }); + + test('Test 10', () { + final solutions = + Quadratic( + a: const Complex.fromReal(3), + b: const Complex.fromReal(5), + c: const Complex.fromReal(23), + ).solveInequality( + inequalityType: AlgebraicInequalityType.lessThanOrEqualTo, + ); + + expect(solutions.length, isZero); + }); + }); + }); +} diff --git a/test/algebraic/constant_test.dart b/test/algebraic/types/constant_test.dart similarity index 69% rename from test/algebraic/constant_test.dart rename to test/algebraic/types/constant_test.dart index 2d1af251..d0ab3c47 100644 --- a/test/algebraic/constant_test.dart +++ b/test/algebraic/types/constant_test.dart @@ -2,28 +2,16 @@ import 'package:equations/equations.dart'; import 'package:test/test.dart'; void main() { - group("Testing 'Constant' algebraic equations", () { - test("Making sure that a 'Constant' object is properly constructed", () { - final equation = Constant( - a: const Complex(3, 7), - ); + group('Constant', () { + test('Object construction', () { + final equation = Constant(a: const Complex(3, 7)); // Checking properties expect(equation.degree, isZero); - expect( - equation.derivative(), - equals( - Constant(a: const Complex.zero()), - ), - ); + expect(equation.derivative(), equals(Constant(a: const Complex.zero()))); expect(equation.solutions().length, isZero); expect(equation.isRealEquation, isFalse); - expect( - equation.coefficients, - equals( - const [Complex(3, 7)], - ), - ); + expect(equation.coefficients, equals(const [Complex(3, 7)])); // Making sure that coefficients can be accessed via index expect(equation[0], equals(const Complex(3, 7))); @@ -45,16 +33,12 @@ void main() { expect(eval, equals(const Complex(3, 7))); }); - test( - "Making sure that a correct 'Constant' instance is created from a " - "list of 'double' (real) values", - () { - final constant = Constant.realEquation(a: 5); - expect(constant.a, equals(const Complex.fromReal(5))); - }, - ); + test('realEquation constructor', () { + final constant = Constant.realEquation(a: 5); + expect(constant.a, equals(const Complex.fromReal(5))); + }); - test('Making sure that in case of zero, the degree is -inf', () { + test('In case of zero, the degree is -inf', () { final equation = Constant(a: const Complex.zero()); expect(equation.degree, equals(double.negativeInfinity)); expect(equation.isRealEquation, isTrue); @@ -63,7 +47,7 @@ void main() { expect(eval, const Complex.zero()); }); - test('Making sure that objects comparison works properly', () { + test('Objects comparison', () { final fx = Constant(a: const Complex.fromReal(6)); expect(fx, equals(Constant(a: const Complex.fromReal(6)))); @@ -76,7 +60,7 @@ void main() { ); }); - test("Making sure that 'copyWith' clones objects correctly", () { + test('copyWith', () { final constant = Constant.realEquation(a: 7); // Objects equality diff --git a/test/algebraic/types/cubic_test.dart b/test/algebraic/types/cubic_test.dart new file mode 100644 index 00000000..9c9e4417 --- /dev/null +++ b/test/algebraic/types/cubic_test.dart @@ -0,0 +1,370 @@ +import 'dart:math'; + +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('Cubic', () { + test('Object construction', () { + final equation = Cubic( + a: const Complex.fromReal(-1), + c: const Complex.fromReal(5), + d: const Complex.fromReal(-9), + ); + + // Checking properties + expect(equation.degree, equals(3)); + expect( + equation.derivative(), + Quadratic(a: const Complex.fromReal(-3), c: const Complex.fromReal(5)), + ); + expect(equation.isRealEquation, isTrue); + expect(equation.discriminant(), equals(const Complex.fromReal(-1687))); + expect( + equation.coefficients, + equals(const [ + Complex.fromReal(-1), + Complex.zero(), + Complex.fromReal(5), + Complex.fromReal(-9), + ]), + ); + + // Making sure that coefficients can be accessed via index + expect(equation[0], equals(const Complex.fromReal(-1))); + expect(equation[1], equals(const Complex.zero())); + expect(equation[2], equals(const Complex.fromReal(5))); + expect(equation[3], equals(const Complex.fromReal(-9))); + + expect(() => equation[-1], throwsA(isA())); + + expect(equation.coefficient(3), equals(const Complex.fromReal(-1))); + expect(equation.coefficient(2), equals(const Complex.zero())); + expect(equation.coefficient(1), equals(const Complex.fromReal(5))); + expect(equation.coefficient(0), equals(const Complex.fromReal(-9))); + expect(equation.coefficient(4), isNull); + + // Converting to string + expect(equation.toString(), equals('f(x) = -1x^3 + 5x + -9')); + expect( + equation.toStringWithFractions(), + equals('f(x) = -1x^3 + 5x + -9'), + ); + + // Checking solutions + final solutions = equation.solutions(); + expect(solutions[2].real, const MoreOrLessEquals(1.42759826966)); + expect(solutions[2].imaginary, const MoreOrLessEquals(-1.05551430999854)); + expect(solutions[1].real, const MoreOrLessEquals(-2.855196539321)); + expect(solutions[1].imaginary.round(), isZero); + expect(solutions.first.real, const MoreOrLessEquals(1.42759826966)); + expect( + solutions.first.imaginary, + const MoreOrLessEquals(1.0555143099985407), + ); + + // Evaluation + final eval = equation.realEvaluateOn(0.5); + expect(eval, Complex.fromRealFraction(Fraction(-53, 8))); + }); + + test('realEquation constructor', () { + final cubic = Cubic.realEquation(a: 5, b: 1, c: -6); + + expect(cubic.a, equals(const Complex.fromReal(5))); + expect(cubic.b, equals(const Complex.fromReal(1))); + expect(cubic.c, equals(const Complex.fromReal(-6))); + expect(cubic.d, equals(const Complex.zero())); + + // There must be an exception is the first coeff. is zero + expect( + () => Cubic.realEquation(a: 0), + throwsA(isA()), + ); + }); + + test('Exception is thrown if the coeff. of the highest degree is zero', () { + expect( + () => Cubic(a: const Complex.zero()), + throwsA(isA()), + ); + }); + + test('Objects comparison works properly', () { + final fx = Cubic( + a: const Complex(2, -3), + b: Complex.fromImaginaryFraction(Fraction(6, 5)), + c: const Complex(5, -1), + d: const Complex(-9, -6), + ); + + final otherFx = Cubic( + a: const Complex(2, -3), + b: Complex.fromImaginaryFraction(Fraction(6, 5)), + c: const Complex(5, -1), + d: const Complex(-9, -6), + ); + + expect(fx, equals(otherFx)); + expect(otherFx, equals(fx)); + expect(fx == otherFx, isTrue); + expect(otherFx == fx, isTrue); + + expect( + fx, + equals( + Cubic( + a: const Complex(2, -3), + b: Complex.fromImaginaryFraction(Fraction(6, 5)), + c: const Complex(5, -1), + d: const Complex(-9, -6), + ), + ), + ); + expect( + Cubic( + a: const Complex(2, -3), + b: Complex.fromImaginaryFraction(Fraction(6, 5)), + c: const Complex(5, -1), + d: const Complex(-9, -6), + ), + equals(fx), + ); + + expect(fx.hashCode, equals(otherFx.hashCode)); + }); + + test('copyWith', () { + final cubic = Cubic.realEquation(a: 7, c: 13); + + // Objects equality + expect(cubic, equals(cubic.copyWith())); + expect( + cubic, + equals( + cubic.copyWith( + a: const Complex(7, 0), + c: const Complex(13, 0), + ), + ), + ); + + // Objects inequality + expect(cubic == cubic.copyWith(b: const Complex.fromReal(7)), isFalse); + }); + + test('Regression: Ax^3 + D case is correctly handled', () { + final cubic = Cubic.realEquation(d: -1).solutions(); + + expect(cubic.first, equals(const Complex(1, 0))); + expect(cubic[1], equals(Complex(-1 / 2, sqrt(3) / 2))); + expect(cubic.last, equals(Complex(-0.4999999999999995, -sqrt(3) / 2))); + }); + + test('Edge cases and numerical stability', () { + // Test very small coefficient + expect( + () => Cubic(a: const Complex.fromReal(1e-11)), + throwsA(isA()), + ); + + // Test zero coefficient + expect( + () => Cubic(a: const Complex.zero()), + throwsA(isA()), + ); + + // Test triple root case (discriminant near zero) + final tripleRoot = Cubic( + b: const Complex.fromReal(-3), + c: const Complex.fromReal(3), + d: const Complex.fromReal(-1), + ); + final tripleRootSolutions = tripleRoot.solutions(); + expect(tripleRootSolutions.length, 3); + expect(tripleRootSolutions[0], tripleRootSolutions[1]); + expect(tripleRootSolutions[1], tripleRootSolutions[2]); + + // Test double root case + final doubleRoot = Cubic( + b: const Complex.fromReal(-3), + c: const Complex.fromReal(3), + d: const Complex.fromReal(-1.0001), + ); + final doubleRootSolutions = doubleRoot.solutions(); + expect(doubleRootSolutions.length, 3); + expect(doubleRootSolutions[0], isNot(doubleRootSolutions[2])); + }); + + test('Depressed cubic case', () { + final depressed = Cubic(d: const Complex.fromReal(-8)); + final solutions = depressed.solutions(); + expect(solutions.length, 3); + + // Solutions should be 2, -1 + i*sqrt(3), -1 - i*sqrt(3) + expect(solutions[0].real, closeTo(2, 1e-10)); + expect(solutions[1].real, closeTo(-1, 1e-10)); + expect(solutions[1].imaginary, closeTo(sqrt(3), 1e-10)); + expect(solutions[2].real, closeTo(-1, 1e-10)); + expect(solutions[2].imaginary, closeTo(-sqrt(3), 1e-10)); + }); + + test('Large coefficients', () { + final large = Cubic( + a: const Complex.fromReal(10000000000), + b: const Complex.fromReal(100000000), + c: const Complex.fromReal(1000000), + d: const Complex.fromReal(10000), + ); + final solutions = large.solutions(); + expect(solutions.length, 3); + + // Verify that solutions are reasonable + for (final solution in solutions) { + expect(solution.abs(), lessThan(1e10)); + } + }); + + group('Solutions tests', () { + void verifyCubicSolutions( + Cubic equation, + List expectedSolutions, + ) { + final solutions = equation.solutions(); + expect(solutions.length, equals(3)); + + for (var i = 0; i < 3; ++i) { + expect( + solutions[i].real, + MoreOrLessEquals(expectedSolutions[i].real, precision: 1.0e-5), + ); + expect( + solutions[i].imaginary, + MoreOrLessEquals(expectedSolutions[i].imaginary, precision: 1.0e-5), + ); + } + } + + test('Test 1', () { + final equation = Cubic.realEquation(a: 2, b: 3, c: -11, d: -6); + verifyCubicSolutions(equation, const [ + Complex.fromReal(-0.5), + Complex.fromReal(2), + Complex.fromReal(-3), + ]); + }); + + test('Test 2', () { + final equation = Cubic( + a: const Complex.i(), + c: const Complex(-2, 5), + d: const Complex.fromReal(7), + ); + verifyCubicSolutions(equation, const [ + Complex(-1.04472, 1.77929), + Complex(0.31133, -2.75745), + Complex(0.73338, 0.97815), + ]); + }); + + test('Test 3', () { + final equation = Cubic.realEquation(a: -4, c: 8); + verifyCubicSolutions(equation, const [ + Complex.zero(), + Complex.fromReal(-1.41421), + Complex.fromReal(1.41421), + ]); + }); + + test('Test 4', () { + final equation = Cubic.realEquation(b: 1, c: 1, d: 1); + verifyCubicSolutions(equation, const [ + Complex.fromReal(-1), + Complex.fromImaginary(-1), + Complex.i(), + ]); + }); + + test('Test 5', () { + final equation = Cubic(a: const Complex.i(), b: const Complex(5, -8)); + verifyCubicSolutions(equation, const [ + Complex.zero(), + Complex.zero(), + Complex(8, 5), + ]); + }); + + test('Test 6', () { + final equation = Cubic( + a: const Complex.fromReal(5), + d: const Complex.fromReal(3), + ); + verifyCubicSolutions(equation, const [ + Complex(0.42172, 0.73043), + Complex.fromReal(-0.84343), + Complex(0.42172, -0.73043), + ]); + }); + + test('Test 7', () { + final equation = Cubic(a: const Complex(-6, 2), d: const Complex.i()); + verifyCubicSolutions(equation, const [ + Complex(0.43666, 0.31895), + Complex(-0.49455, 0.21869), + Complex(0.05788, -0.53763), + ]); + }); + + test('Test 8', () { + final equation = Cubic( + a: const Complex(1, 1), + d: const Complex(-1, -1), + ); + verifyCubicSolutions(equation, const [ + Complex(1, 0), + Complex(-0.5, 0.86603), + Complex(-0.4999999999999995, -0.86603), + ]); + }); + + test('Test 9', () { + final equation = Cubic( + a: const Complex(1, 1), + b: const Complex(-2, 1), + c: const Complex(1, -2), + d: const Complex(-1, 1), + ); + verifyCubicSolutions(equation, const [ + Complex(-0.76278, -1.44625), + Complex(0.95294, -0.52328), + Complex(0.30983, 0.46953), + ]); + }); + + test('Test 10', () { + final equation = Cubic.realEquation(b: -3, c: 3, d: -1); + verifyCubicSolutions(equation, const [ + Complex.fromReal(1), + Complex.fromReal(1), + Complex.fromReal(1), + ]); + }); + + test('Test 11: Double root case (d0.abs() >= epsilon)', () { + final equation = Cubic.realEquation( + b: -4, + c: 5, + d: -2, + ); + final solutions = equation.solutions(); + expect(solutions.length, equals(3)); + + final allSame = + solutions[0] == solutions[1] && solutions[1] == solutions[2]; + expect(allSame, isFalse, reason: 'Should not be a triple root'); + }); + }); + }); +} diff --git a/test/algebraic/types/generic_algebraic_test.dart b/test/algebraic/types/generic_algebraic_test.dart new file mode 100644 index 00000000..4cfee932 --- /dev/null +++ b/test/algebraic/types/generic_algebraic_test.dart @@ -0,0 +1,530 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('Generic Algebraic', () { + test('Object construction', () { + final equation = GenericAlgebraic( + coefficients: const [Complex.i(), Complex.fromReal(3), Complex(5, 6)], + ); + + // Checking properties + expect(equation.degree, equals(2)); + expect(equation.derivative(), isA()); + expect(equation.isRealEquation, isFalse); + expect(equation.discriminant(), const Complex(33, -20)); + expect( + equation.coefficients, + equals(const [Complex.i(), Complex.fromReal(3), Complex(5, 6)]), + ); + + // Making sure that coefficients can be accessed via index + expect(equation[0], equals(const Complex.i())); + expect(equation[1], equals(const Complex.fromReal(3))); + expect(equation[2], equals(const Complex(5, 6))); + + expect(() => equation[-1], throwsA(isA())); + + expect(equation.coefficient(2), equals(const Complex.i())); + expect(equation.coefficient(1), equals(const Complex.fromReal(3))); + expect(equation.coefficient(0), equals(const Complex(5, 6))); + expect(equation.coefficient(3), isNull); + + // Converting to string + expect(equation.toString(), equals('f(x) = 1ix^2 + 3x + (5 + 6i)')); + expect( + equation.toStringWithFractions(), + equals('f(x) = 1ix^2 + 3x + (5 + 6i)'), + ); + + // Checking solutions + final solutions = equation.solutions(); + + expect( + solutions.first.real, + const MoreOrLessEquals(-0.8357, precision: 1.0e-4), + ); + expect( + solutions.first.imaginary, + const MoreOrLessEquals(-1.4914, precision: 1.0e-4), + ); + expect( + solutions[1].real, + const MoreOrLessEquals(0.8357, precision: 1.0e-4), + ); + expect( + solutions[1].imaginary, + const MoreOrLessEquals(4.4914, precision: 1.0e-4), + ); + + // Evaluation + final eval = equation.realEvaluateOn(2); + expect(eval, equals(const Complex(11, 10))); + }); + + test('Constant polynomial', () { + final noSolutions = GenericAlgebraic.realEquation(coefficients: [1]); + + expect(noSolutions.solutions().length, isZero); + }); + + test('realEquation constructor', () { + final genericAlgebraic = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3], + ); + + expect(genericAlgebraic[0], equals(const Complex.fromReal(1))); + expect(genericAlgebraic[1], equals(const Complex.fromReal(2))); + expect(genericAlgebraic[2], equals(const Complex.fromReal(3))); + + // There must be an exception is the first coeff. is zero + expect( + () => GenericAlgebraic.realEquation(coefficients: [0, 3, 6]), + throwsA(isA()), + ); + }); + + test('Exception is thrown if the coeff. of the highest degree is zero', () { + expect( + () => GenericAlgebraic(coefficients: const [Complex.zero()]), + throwsA(isA()), + ); + }); + + test('Derivatives types', () { + final polynomialDegree6 = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3, 4, 5, 6, 7], + ); + final polynomialDegree5 = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3, 4, 5, 6], + ); + final polynomialDegree4 = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3, 4, 5], + ); + final polynomialDegree3 = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3, 4], + ); + final polynomialDegree2 = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3], + ); + final polynomialDegree1 = GenericAlgebraic.realEquation( + coefficients: [1, 2], + ); + final polynomialDegree0 = GenericAlgebraic.realEquation( + coefficients: [1], + ); + + expect(polynomialDegree6.derivative(), isA()); + expect(polynomialDegree5.derivative(), isA()); + expect(polynomialDegree4.derivative(), isA()); + expect(polynomialDegree3.derivative(), isA()); + expect(polynomialDegree2.derivative(), isA()); + expect(polynomialDegree1.derivative(), isA()); + expect(polynomialDegree0.derivative(), isA()); + }); + + test('Derivatives', () { + final genericAlgebraic1 = GenericAlgebraic.realEquation( + coefficients: [2, 0, -2, 0, 7, 0], + ); + + expect( + genericAlgebraic1.derivative(), + equals(Algebraic.fromReal([10, 0, -6, 0, 7])), + ); + expect(genericAlgebraic1.discriminant().real, equals(29679104)); + expect(genericAlgebraic1.discriminant().imaginary, isZero); + + final genericAlgebraic2 = GenericAlgebraic.realEquation( + coefficients: [1, -5, 2, -2, 0, 7, 13], + ); + + expect( + genericAlgebraic2.derivative(), + equals(Algebraic.fromReal([6, -25, 8, -6, 0, 7])), + ); + expect( + genericAlgebraic2.discriminant().real.round(), + equals(1002484790644), + ); + expect(genericAlgebraic2.discriminant().imaginary, isZero); + }); + + test('Objects comparison', () { + final fx = GenericAlgebraic.realEquation(coefficients: [1, 2, 3, 4, 5]); + final otherFx = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3, 4, 5], + ); + + final notEqual = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3, 4, 5], + initialGuess: List.generate(4, (_) => const Complex.zero()), + ); + + expect(fx, equals(otherFx)); + expect(fx == otherFx, isTrue); + expect(otherFx, equals(fx)); + expect(otherFx == fx, isTrue); + + expect( + fx, + equals(GenericAlgebraic.realEquation(coefficients: [1, 2, 3, 4, 5])), + ); + expect( + GenericAlgebraic.realEquation(coefficients: [1, 2, 3, 4, 5]), + equals(fx), + ); + + expect(fx.hashCode, equals(otherFx.hashCode)); + + expect(fx == notEqual, isFalse); + expect(fx.hashCode == notEqual.hashCode, isFalse); + + expect( + GenericAlgebraic( + coefficients: const [ + Complex(3, -2), + Complex.zero(), + Complex.fromReal(7), + ], + initialGuess: const [Complex(3, 2), Complex.fromImaginary(8)], + ), + equals( + GenericAlgebraic( + coefficients: const [ + Complex(3, -2), + Complex.zero(), + Complex.fromReal(7), + ], + initialGuess: const [Complex(3, 2), Complex.fromImaginary(8)], + ), + ), + ); + }); + + test('copyWith', () { + final genericAlgebraic = GenericAlgebraic.realEquation( + coefficients: [1, 2, 3], + ); + + // Objects equality + expect( + genericAlgebraic, + equals( + genericAlgebraic.copyWith(), + ), + ); + expect( + genericAlgebraic, + equals(genericAlgebraic.copyWith(maxSteps: 2000)), + ); + + // Objects inequality + expect( + genericAlgebraic == genericAlgebraic.copyWith(maxSteps: 1), + isFalse, + ); + }); + + test('Testing validation of coefficients', () { + // Test empty coefficients + expect( + () => GenericAlgebraic(coefficients: []), + throwsA(isA()), + ); + + // Test zero leading coefficient + expect( + () => GenericAlgebraic( + coefficients: const [Complex.zero(), Complex.fromReal(1)], + ), + throwsA(isA()), + ); + + // Test real equation with zero leading coefficient + expect( + () => GenericAlgebraic.realEquation(coefficients: [0, 1]), + throwsA(isA()), + ); + }); + + test('Convergence criteria', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.fromReal(-5), + Complex.fromReal(6), + ], + ); + + final solutions = equation.solutions(); + expect(solutions.length, equals(2)); + }); + + test('Root clustering for multiple roots', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.fromReal(-6), + Complex.fromReal(12), + Complex.fromReal(-8), + ], + ); + + final solutions = equation.solutions(); + expect(solutions.length, equals(3)); + + // All roots should be close to 2 + for (final solution in solutions) { + expect(solution.real.round(), equals(2)); + expect(solution.imaginary.round(), isZero); + } + }); + + test('Numerical stability', () { + // Test polynomial with very small coefficients + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1.0e-12), + Complex.fromReal(1.0e-13), + Complex.fromReal(1.0e-12), + ], + ); + + expect(equation.solutions, throwsA(isA())); + }); + + test('Custom initial guesses', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.fromReal(-5), + Complex.fromReal(6), + ], + initialGuess: const [Complex.fromReal(2.5), Complex.fromReal(2.5)], + ); + + final solutions = equation.solutions(); + expect(solutions.length, equals(2)); + }); + + test('Edge cases', () { + // Test with very high degree polynomial + final highDegree = GenericAlgebraic( + coefficients: List.generate(10, (i) => Complex.fromReal(i + 1)), + ); + expect(highDegree.solutions().length, equals(9)); + + // Test with very small precision + final smallPrecision = GenericAlgebraic( + coefficients: const [Complex.fromReal(1), Complex.fromReal(2)], + precision: 1.0e-20, + ); + expect(smallPrecision.solutions().length, equals(1)); + + // Test with very large maxSteps + final largeMaxSteps = GenericAlgebraic( + coefficients: const [Complex.fromReal(1), Complex.fromReal(2)], + maxSteps: 10000, + ); + expect(largeMaxSteps.solutions().length, equals(1)); + }); + + group('Solutions tests', () { + void verifyGenericAlgebraicSolutions( + GenericAlgebraic equation, + List expectedSolutions, + ) { + final solutions = equation.solutions(); + expect(solutions.length, equals(equation.coefficients.length - 1)); + + // Keep track of which expected solutions have been matched + final matchedExpected = List.filled( + expectedSolutions.length, + false, + ); + + // For each found solution + for (final solution in solutions) { + var foundMatch = false; + + // Try to match it with any unmatched expected solution + for (var i = 0; i < expectedSolutions.length; i++) { + if (!matchedExpected[i] && + MoreOrLessEquals( + expectedSolutions[i].real, + precision: 1.0e-5, + ).matches(solution.real, {}) && + MoreOrLessEquals( + expectedSolutions[i].imaginary, + precision: 1.0e-5, + ).matches(solution.imaginary, {})) { + matchedExpected[i] = true; + foundMatch = true; + break; + } + } + + // If no match was found, fail the test + expect( + foundMatch, + isTrue, + reason: 'Solution $solution did not match any expected solution', + ); + } + + // Verify all expected solutions were matched + expect( + matchedExpected.every((matched) => matched), + isTrue, + reason: 'Not all expected solutions were matched', + ); + } + + test('Test 1', () { + final equation = GenericAlgebraic.realEquation( + coefficients: [2, 3, -11, -6], + ); + verifyGenericAlgebraicSolutions(equation, const [ + Complex.fromReal(-3), + Complex.fromReal(-0.5), + Complex.fromReal(2), + ]); + }); + + test('Test 2', () { + final equation = GenericAlgebraic.realEquation( + coefficients: [1, -5, 2, -2, 0, 7, 13], + precision: 1.0e-15, + ); + verifyGenericAlgebraicSolutions(equation, const [ + Complex(-0.82299, 0.54911), + Complex(-0.82299, -0.54911), + Complex(0.25017, 1.35612), + Complex(0.25017, -1.35612), + Complex(1.50487, 0), + Complex(4.64077, 0), + ]); + }); + + test('Test 3', () { + final equation = GenericAlgebraic.realEquation( + coefficients: [2, 1, -2, 1, 7], + precision: 1.0e-15, + ); + verifyGenericAlgebraicSolutions(equation, const [ + Complex(-1.22152, 0.693491), + Complex(-1.22152, -0.693491), + Complex(0.97152, 0.91106), + Complex(0.97152, -0.91106), + ]); + }); + + test('Test 4', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex(3, -2), + Complex.zero(), + Complex.fromReal(7), + Complex.fromReal(-1), + ], + ); + verifyGenericAlgebraicSolutions(equation, const [ + Complex(-0.47308, 1.33835), + Complex(0.14162, 0.00079), + Complex(0.33146, -1.33914), + ]); + }); + + test('Test 5', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.zero(), + Complex.i(), + Complex.zero(), + Complex.zero(), + Complex(1, -6), + ], + ); + verifyGenericAlgebraicSolutions(equation, const [ + Complex(-1.40832, 0.54238), + Complex(-0.70223, -1.11291), + Complex(-0.18806, 1.42498), + Complex(1.00340, -1.22343), + Complex(1.29521, 0.36898), + ]); + }); + + test('Test 6', () { + final equation = GenericAlgebraic.realEquation( + coefficients: [12, 5, -8, 6, -3, 14, 22, -1, 4], + ); + verifyGenericAlgebraicSolutions(equation, const [ + Complex(-1.14661, -0.05096), + Complex(-1.14661, 0.05096), + Complex(-0.13933, 1.03116), + Complex(-0.13933, -1.03116), + Complex(0.06712, -0.40317), + Complex(0.06712, 0.40317), + Complex(1.01050, 0.61469), + Complex(1.01050, -0.61469), + ]); + }); + + test('Test 7: Initial guesses too close together', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.fromReal(-5), + Complex.fromReal(6), + ], + initialGuess: const [ + Complex.fromReal(2), + Complex.fromReal(2.0000001), // Very close to first guess + ], + ); + final solutions = equation.solutions(); + expect(solutions.length, equals(2)); + }); + + test('Test 8: Aberth guesses are very close', () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.fromReal(0.001), + Complex.fromReal(0.001), + Complex.fromReal(0.001), + ], + // Larger than typical spacing for small radius + minGuessDistance: 0.01, + ); + + final solutions = equation.solutions(); + expect(solutions.length, equals(3)); + }); + + test( + 'Test 9: Polynomial causing small radius', + () { + final equation = GenericAlgebraic( + coefficients: const [ + Complex.fromReal(1), + Complex.fromReal(0.0001), + Complex.fromReal(0.0001), + Complex.fromReal(0.0001), + Complex.fromReal(0.0001), + ], + // Larger than spacing for very small radius + minGuessDistance: 0.001, + ); + + final solutions = equation.solutions(); + expect(solutions.length, equals(4)); + }, + ); + }); + }); +} diff --git a/test/algebraic/types/linear_test.dart b/test/algebraic/types/linear_test.dart new file mode 100644 index 00000000..0c5e9827 --- /dev/null +++ b/test/algebraic/types/linear_test.dart @@ -0,0 +1,207 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('Linear', () { + test('Object construction', () { + final equation = Linear( + a: const Complex.fromReal(3), + b: Complex.fromRealFraction(Fraction(6, 5)), + ); + + // Checking properties + expect(equation.degree, equals(1)); + expect( + equation.derivative(), + equals(Constant(a: const Complex.fromReal(3))), + ); + expect(equation.isRealEquation, isTrue); + expect(equation.discriminant(), equals(const Complex.fromReal(1))); + expect( + equation.coefficients, + equals([ + const Complex.fromReal(3), + Complex.fromRealFraction(Fraction(6, 5)), + ]), + ); + + // Making sure that coefficients can be accessed via index + expect(equation[0], equals(const Complex.fromReal(3))); + expect(equation[1], equals(Complex.fromRealFraction(Fraction(6, 5)))); + + expect(() => equation[-1], throwsA(isA())); + + expect(equation.coefficient(1), equals(const Complex.fromReal(3))); + expect( + equation.coefficient(0), + equals(Complex.fromRealFraction(Fraction(6, 5))), + ); + expect(equation.coefficient(2), isNull); + + // Converting to string + expect(equation.toString(), equals('f(x) = 3x + 1.2')); + expect(equation.toStringWithFractions(), equals('f(x) = 3x + 6/5')); + + // Checking solutions + final solutions = equation.solutions(); + expect( + solutions.first.real, + const MoreOrLessEquals(-0.4, precision: 1.0e-1), + ); + expect(solutions.first.imaginary, isZero); + + // Evaluation + expect(equation.realEvaluateOn(1), equals(const Complex.fromReal(4.2))); + expect( + equation.evaluateOn(const Complex(1, -3)), + equals(const Complex(4.2, -9)), + ); + }); + + test('realEquation', () { + final linear = Linear.realEquation(a: 5, b: 1); + + expect(linear.a, equals(const Complex.fromReal(5))); + expect(linear.b, equals(const Complex.fromReal(1))); + + // There must be an exception is the first coeff. is zero + expect( + () => Linear.realEquation(a: 0), + throwsA(isA()), + ); + }); + + test('Exception is thrown if the coeff. of the highest degree is zero', () { + expect( + () => Linear(a: const Complex.zero()), + throwsA(isA()), + ); + }); + + test('Objects comparison works properly', () { + final fx = Linear(a: const Complex(2, 3), b: const Complex.i()); + + expect( + fx, + equals( + Linear( + a: const Complex(2, 3), + b: const Complex.i(), + ), + ), + ); + expect( + Linear( + a: const Complex(2, 3), + b: const Complex.i(), + ), + equals(fx), + ); + expect( + fx == Linear(a: const Complex(2, 3), b: const Complex.i()), + isTrue, + ); + expect( + Linear(a: const Complex(2, 3), b: const Complex.i()) == fx, + isTrue, + ); + expect( + fx.hashCode, + equals(Linear(a: const Complex(2, 3), b: const Complex.i()).hashCode), + ); + }); + + test('copyWith', () { + final linear = Linear(a: const Complex.i(), b: const Complex(-3, 8)); + + // Objects equality + expect( + linear, + equals(linear.copyWith()), + ); + expect( + linear, + equals( + linear.copyWith( + a: const Complex.i(), + b: const Complex(-3, 8), + ), + ), + ); + + // Objects inequality + expect(linear == linear.copyWith(b: const Complex.zero()), isFalse); + }); + + group('Solutions tests', () { + void verifyLinearSolutions( + Linear equation, + List expectedSolutions, + ) { + final solutions = equation.solutions(); + expect(solutions.length, equals(1)); + + expect( + solutions.first.real, + MoreOrLessEquals( + expectedSolutions.first.real, + precision: 1.0e-5, + ), + ); + expect( + solutions.first.imaginary, + MoreOrLessEquals( + expectedSolutions.first.imaginary, + precision: 1.0e-5, + ), + ); + } + + test('Test 1', () { + final equation = Linear.realEquation( + a: 2, + b: 3, + ); + verifyLinearSolutions(equation, const [ + Complex.fromReal(-3 / 2), + ]); + }); + + test('Test 2', () { + final equation = Linear( + a: const Complex.i(), + b: const Complex(4, -6), + ); + verifyLinearSolutions(equation, const [ + Complex(6, 4), + ]); + }); + + test('Test 3', () { + final equation = Linear(); + verifyLinearSolutions(equation, const [ + Complex.zero(), + ]); + }); + + test('Test 4', () { + final equation = Linear.realEquation(a: -61, b: -61); + verifyLinearSolutions(equation, const [ + Complex.fromReal(-1), + ]); + }); + + test('Test 4', () { + final equation = Linear( + a: const Complex.i(), + b: -const Complex.i(), + ); + verifyLinearSolutions(equation, const [ + Complex.fromReal(1), + ]); + }); + }); + }); +} diff --git a/test/algebraic/types/quadratic_test.dart b/test/algebraic/types/quadratic_test.dart new file mode 100644 index 00000000..5e1b0ba2 --- /dev/null +++ b/test/algebraic/types/quadratic_test.dart @@ -0,0 +1,298 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('Quadratic', () { + test('Object construction', () { + final equation = Quadratic( + a: const Complex.fromReal(2), + b: const Complex.fromReal(-5), + c: Complex.fromRealFraction(Fraction(3, 2)), + ); + + // Checking properties + expect(equation.degree, equals(2)); + expect( + equation.derivative(), + Linear(a: const Complex.fromReal(4), b: const Complex.fromReal(-5)), + ); + expect(equation.isRealEquation, isTrue); + expect(equation.discriminant(), equals(const Complex.fromReal(13))); + expect( + equation.coefficients, + equals([ + const Complex.fromReal(2), + const Complex.fromReal(-5), + Complex.fromRealFraction(Fraction(3, 2)), + ]), + ); + + // Making sure that coefficients can be accessed via index + expect(equation[0], equals(const Complex.fromReal(2))); + expect(equation[1], equals(const Complex.fromReal(-5))); + expect(equation[2], equals(Complex.fromRealFraction(Fraction(3, 2)))); + + expect(() => equation[-1], throwsA(isA())); + + expect(equation.coefficient(2), equals(const Complex.fromReal(2))); + expect(equation.coefficient(1), equals(const Complex.fromReal(-5))); + expect( + equation.coefficient(0), + equals(Complex.fromRealFraction(Fraction(3, 2))), + ); + expect(equation.coefficient(3), isNull); + + // Converting to string + expect(equation.toString(), equals('f(x) = 2x^2 + -5x + 1.5')); + expect( + equation.toStringWithFractions(), + equals('f(x) = 2x^2 + -5x + 3/2'), + ); + + // Checking solutions + final solutions = equation.solutions(); + expect(solutions.first.real, const MoreOrLessEquals(2.151387818866)); + expect(solutions.first.imaginary, isZero); + expect(solutions[1].real, const MoreOrLessEquals(0.348612181134)); + expect(solutions[1].imaginary, isZero); + + // Evaluation + final eval = equation.realEvaluateOn(Fraction(-2, 5).toDouble()); + expect(eval.real.toStringAsFixed(2), equals('3.82')); + expect(eval.imaginary.round(), isZero); + }); + + test('Exception is thrown if the coeff. of the highest degree is zero', () { + expect( + () => Quadratic( + a: const Complex.zero(), + b: const Complex.i(), + c: const Complex.fromReal(4), + ), + throwsA(isA()), + ); + }); + + test('realEquation', () { + final quadratic = Quadratic.realEquation(a: -3, b: 2, c: 1); + + expect(quadratic.a, equals(const Complex.fromReal(-3))); + expect(quadratic.b, equals(const Complex.fromReal(2))); + expect(quadratic.c, equals(const Complex.fromReal(1))); + + // There must be an exception is the first coeff. is zero + expect( + () => Quadratic.realEquation(a: 0), + throwsA(isA()), + ); + }); + + test('Objects comparison works properly', () { + final fx = Quadratic( + a: const Complex(2, 3), + b: const Complex.i(), + c: const Complex(-1, 0), + ); + + final otherFx = Quadratic( + a: const Complex(2, 3), + b: const Complex.i(), + c: const Complex(-1, 0), + ); + + expect(fx, equals(otherFx)); + expect(fx == otherFx, isTrue); + expect(otherFx, equals(fx)); + expect(otherFx == fx, isTrue); + + expect( + fx, + equals( + Quadratic( + a: const Complex(2, 3), + b: const Complex.i(), + c: const Complex(-1, 0), + ), + ), + ); + expect( + Quadratic( + a: const Complex(2, 3), + b: const Complex.i(), + c: const Complex(-1, 0), + ), + equals(fx), + ); + expect( + fx == + Quadratic( + a: const Complex(2, 3), + b: const Complex.i(), + c: const Complex(-1, 0), + ), + isTrue, + ); + expect( + Quadratic( + a: const Complex(2, 3), + b: const Complex.i(), + c: const Complex(-1, 0), + ) == + fx, + isTrue, + ); + + expect(fx.hashCode, equals(otherFx.hashCode)); + }); + + test('copyWith', () { + final quadratic = Quadratic( + a: const Complex.i(), + b: const Complex(6, -1), + c: const Complex.i(), + ); + + // Objects equality + expect(quadratic, equals(quadratic.copyWith())); + expect( + quadratic, + equals( + quadratic.copyWith( + a: const Complex.i(), + b: const Complex(6, -1), + c: const Complex.i(), + ), + ), + ); + + // Objects inequality + expect(quadratic == quadratic.copyWith(b: const Complex.zero()), isFalse); + }); + + group('Solutions tests', () { + void verifyQuadraticSolutions( + Quadratic equation, + List expectedSolutions, + ) { + final solutions = equation.solutions(); + expect(solutions.length, equals(2)); + + for (var i = 0; i < 2; ++i) { + expect( + solutions[i].real, + MoreOrLessEquals(expectedSolutions[i].real, precision: 1.0e-5), + ); + expect( + solutions[i].imaginary, + MoreOrLessEquals(expectedSolutions[i].imaginary, precision: 1.0e-5), + ); + } + } + + test('Test 1', () { + final equation = Quadratic.realEquation(a: -3, b: 1 / 5, c: 16); + verifyQuadraticSolutions(equation, const [ + Complex.fromReal(2.34297), + Complex.fromReal(-2.2763), + ]); + }); + + test('Test 2', () { + final equation = Quadratic.realEquation(b: 5, c: -4); + verifyQuadraticSolutions(equation, const [ + Complex.fromReal(0.70156), + Complex.fromReal(-5.70156), + ]); + }); + + test('Test 3', () { + final equation = Quadratic( + a: const Complex(3, 1), + b: const Complex(2, -7), + ); + verifyQuadraticSolutions(equation, const [ + Complex(0.09999, 2.3), + Complex.zero(), + ]); + }); + + test('Test 4', () { + final equation = Quadratic(); + verifyQuadraticSolutions(equation, const [ + Complex.zero(), + Complex.zero(), + ]); + }); + + test('Test 5', () { + final equation = Quadratic.realEquation(a: 9, b: 6, c: -6); + verifyQuadraticSolutions(equation, const [ + Complex.fromReal(0.54858), + Complex.fromReal(-1.21525), + ]); + }); + + test('Test 6', () { + final equation = Quadratic.realEquation(c: -1); + verifyQuadraticSolutions(equation, const [ + Complex.fromReal(1), + Complex.fromReal(-1), + ]); + }); + + test('Test 7', () { + final equation = Quadratic.realEquation(c: 1); + verifyQuadraticSolutions(equation, const [ + Complex.fromImaginary(1), + Complex.fromImaginary(-1), + ]); + }); + + test('Test 8', () { + final equation = Quadratic( + a: const Complex(1, 1), + b: const Complex(-2, 1), + c: const Complex(1, -1), + ); + verifyQuadraticSolutions(equation, const [ + Complex(0.63755, 0.05634), + Complex(-0.13755, -1.55634), + ]); + }); + + test('Test 9', () { + final equation = Quadratic.realEquation(b: -2, c: 1); + verifyQuadraticSolutions(equation, const [ + Complex.fromReal(1), + Complex.fromReal(1), + ]); + }); + + test('Test 10', () { + final equation = Quadratic( + a: const Complex.fromReal(1e-10), + b: const Complex.fromReal(1e-8), + c: const Complex.fromReal(1e-6), + ); + verifyQuadraticSolutions(equation, const [ + Complex(-49.99999, 86.60254), + Complex(-50, -86.60254), + ]); + }); + + test('Test 11', () { + final equation = Quadratic.realEquation( + a: 10000000000, + b: 100000000, + c: 1000000, + ); + verifyQuadraticSolutions(equation, const [ + Complex(-0.00499, 0.00866), + Complex(-0.005, -0.00866), + ]); + }); + }); + }); +} diff --git a/test/algebraic/types/quartic_test.dart b/test/algebraic/types/quartic_test.dart new file mode 100644 index 00000000..170b4250 --- /dev/null +++ b/test/algebraic/types/quartic_test.dart @@ -0,0 +1,474 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('Quartic', () { + test('Object construction', () { + final equation = Quartic.realEquation(a: 3, b: 6, d: 2, e: -1); + + // Checking properties + expect(equation.degree, equals(4)); + expect( + equation.derivative(), + Cubic( + a: const Complex.fromReal(12), + b: const Complex.fromReal(18), + d: const Complex.fromReal(2), + ), + ); + expect(equation.isRealEquation, isTrue); + expect(equation.discriminant(), equals(const Complex.fromReal(-70848))); + expect( + equation.coefficients, + equals(const [ + Complex.fromReal(3), + Complex.fromReal(6), + Complex.zero(), + Complex.fromReal(2), + Complex.fromReal(-1), + ]), + ); + + // Making sure that coefficients can be accessed via index + expect(equation[0], equals(const Complex.fromReal(3))); + expect(equation[1], equals(const Complex.fromReal(6))); + expect(equation[2], equals(const Complex.zero())); + expect(equation[3], equals(const Complex.fromReal(2))); + expect(equation[4], equals(const Complex.fromReal(-1))); + + expect(() => equation[-1], throwsA(isA())); + + expect(equation.coefficient(4), equals(const Complex.fromReal(3))); + expect(equation.coefficient(3), equals(const Complex.fromReal(6))); + expect(equation.coefficient(2), equals(const Complex.zero())); + expect(equation.coefficient(1), equals(const Complex.fromReal(2))); + expect(equation.coefficient(0), equals(const Complex.fromReal(-1))); + expect(equation.coefficient(5), isNull); + + // Converting to string + expect(equation.toString(), equals('f(x) = 3x^4 + 6x^3 + 2x + -1')); + expect( + equation.toStringWithFractions(), + equals('f(x) = 3x^4 + 6x^3 + 2x + -1'), + ); + + // Checking solutions + final solutions = equation.solutions(); + expect(solutions.first.real, const MoreOrLessEquals(-2.173571613806)); + expect(solutions.first.imaginary.round(), isZero); + expect(solutions[1].real, const MoreOrLessEquals(0.349518864775)); + expect(solutions[1].imaginary.round(), isZero); + expect(solutions[2].real, const MoreOrLessEquals(-0.087973625484)); + expect(solutions[2].imaginary, const MoreOrLessEquals(0.656527118533)); + expect(solutions[3].real, const MoreOrLessEquals(-0.087973625484)); + expect(solutions[3].imaginary, const MoreOrLessEquals(-0.656527118533)); + + // Evaluation + final eval = equation.realEvaluateOn(2); + expect(eval.real.round(), equals(99)); + expect(eval.imaginary.round(), isZero); + }); + + test('Exception is thrown if the coeff. of the highest degree is zero', () { + expect( + () => Quartic(a: const Complex.zero()), + throwsA(isA()), + ); + }); + + test('realEquation', () { + final quartic = Quartic.realEquation(a: -3, d: 8); + + expect(quartic.a, equals(const Complex.fromReal(-3))); + expect(quartic.d, equals(const Complex.fromReal(8))); + + // There must be an exception is the first coeff. is zero + expect( + () => Quartic.realEquation(a: 0), + throwsA(isA()), + ); + }); + + test('Objects comparison works properly', () { + final fx = Quartic( + a: const Complex(3, -6), + b: const Complex.fromImaginary(-2), + c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), + d: const Complex.i(), + e: const Complex.fromReal(9), + ); + + final otherFx = Quartic( + a: const Complex(3, -6), + b: const Complex.fromImaginary(-2), + c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), + d: const Complex.i(), + e: const Complex.fromReal(9), + ); + + expect(fx, equals(otherFx)); + expect(fx == otherFx, isTrue); + expect(otherFx, equals(fx)); + expect(otherFx == fx, isTrue); + + expect( + fx, + equals( + Quartic( + a: const Complex(3, -6), + b: const Complex.fromImaginary(-2), + c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), + d: const Complex.i(), + e: const Complex.fromReal(9), + ), + ), + ); + expect( + Quartic( + a: const Complex(3, -6), + b: const Complex.fromImaginary(-2), + c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), + d: const Complex.i(), + e: const Complex.fromReal(9), + ), + equals(fx), + ); + expect( + fx == + Quartic( + a: const Complex(3, -6), + b: const Complex.fromImaginary(-2), + c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), + d: const Complex.i(), + e: const Complex.fromReal(9), + ), + isTrue, + ); + expect( + Quartic( + a: const Complex(3, -6), + b: const Complex.fromImaginary(-2), + c: Complex.fromFraction(Fraction(1, 2), Fraction(1, 5)), + d: const Complex.i(), + e: const Complex.fromReal(9), + ) == + fx, + isTrue, + ); + + expect(fx.hashCode, equals(otherFx.hashCode)); + }); + + test('copyWith', () { + final quartic = Quartic.realEquation(c: 5, d: -6); + + // Objects equality + expect(quartic, equals(quartic.copyWith())); + expect( + quartic, + equals( + quartic.copyWith( + a: const Complex.fromReal(1), + b: const Complex.zero(), + c: const Complex.fromReal(5), + d: const Complex.fromReal(-6), + // Not adding `const` to run the test with a different object + // ignore: prefer_const_constructors + e: Complex.zero(), + ), + ), + ); + + // Objects inequality + expect(quartic == quartic.copyWith(c: const Complex.zero()), isFalse); + }); + + group('Solutions tests', () { + void verifyQuarticSolutions( + Quartic equation, + List expectedSolutions, + ) { + final solutions = equation.solutions(); + expect(solutions.length, equals(4)); + + for (var i = 0; i < 4; ++i) { + expect( + solutions[i].real, + MoreOrLessEquals(expectedSolutions[i].real, precision: 1.0e-5), + ); + expect( + solutions[i].imaginary, + MoreOrLessEquals(expectedSolutions[i].imaginary, precision: 1.0e-5), + ); + } + } + + test('Test 1', () { + verifyQuarticSolutions( + Quartic.realEquation(a: 2, b: 1, c: -2, d: 1, e: 7), + const [ + Complex(-1.22152, -0.69349), + Complex(-1.22152, 0.69349), + Complex(0.97152, -0.91106), + Complex(0.97152, 0.91106), + ], + ); + }); + + test('Test 2', () { + verifyQuarticSolutions( + Quartic( + a: const Complex.fromReal(5), + b: const Complex(-5, 12), + d: const Complex.fromReal(1), + ), + const [ + Complex(-0.23979, -0.1419), + Complex.zero(), + Complex(0.21956, 0.16265), + Complex(1.02023, -2.42074), + ], + ); + }); + + test('Test 3', () { + verifyQuarticSolutions(Quartic.realEquation(a: 5, b: 6, d: -1), const [ + Complex.fromReal(-1), + Complex.fromReal(-0.55826), + Complex.zero(), + Complex.fromReal(0.35826), + ]); + }); + + test('Test 4', () { + verifyQuarticSolutions( + Quartic( + a: const Complex(4, -7), + b: const Complex(2, 3), + d: const Complex.fromReal(2), + e: const Complex(10, 1), + ), + const [ + Complex(-0.85119, 0.37549), + Complex(-0.46831, -0.97907), + Complex(0.51992, 0.88058), + Complex(0.99958, -0.677), + ], + ); + }); + + test('Test 5', () { + verifyQuarticSolutions( + Quartic( + a: const Complex.i(), + c: -const Complex.i(), + e: const Complex.fromReal(-3), + ), + const [ + Complex(1.39765, -0.42028), + Complex(-1.39765, 0.42028), + Complex(0.56196, 1.04527), + Complex(-0.56196, -1.04527), + ], + ); + }); + + test('Test 6', () { + verifyQuarticSolutions( + Quartic.realEquation(b: -10, c: 35, d: -50, e: 24), + const [ + Complex.fromReal(1), + Complex.fromReal(2), + Complex.fromReal(3), + Complex.fromReal(4), + ], + ); + }); + + test('Test 7', () { + verifyQuarticSolutions(Quartic.realEquation(c: 2, e: 1), const [ + Complex(0, 1), + Complex(0, -1), + Complex(0, -1), + Complex(0, 1), + ]); + }); + + test('Test 8', () { + verifyQuarticSolutions(Quartic.realEquation(c: -5, e: 4), const [ + Complex.fromReal(2), + Complex.fromReal(-2), + Complex.fromReal(1), + Complex.fromReal(-1), + ]); + }); + + test('Test 9', () { + verifyQuarticSolutions(Quartic.realEquation(), const [ + Complex.zero(), + Complex.zero(), + Complex.zero(), + Complex.zero(), + ]); + }); + + test('Test 10', () { + verifyQuarticSolutions(Quartic(), const [ + Complex.zero(), + Complex.zero(), + Complex.zero(), + Complex.zero(), + ]); + }); + + test('Test 11', () { + expect( + () => Quartic.realEquation(a: 100000000000), + throwsA(isA()), + ); + }); + + test('Test 12', () { + verifyQuarticSolutions(Quartic(a: const Complex(-4, 15)), const [ + Complex.zero(), + Complex.zero(), + Complex.zero(), + Complex.zero(), + ]); + }); + + test('Test 13', () { + verifyQuarticSolutions(Quartic.realEquation(a: 523), const [ + Complex.zero(), + Complex.zero(), + Complex.zero(), + Complex.zero(), + ]); + }); + + test('Test 14', () { + verifyQuarticSolutions( + Quartic(a: const Complex(2, 1), e: const Complex(9, 3).negate), + const [ + Complex(1.43428, -0.05090), + Complex(0.05090, 1.43428), + Complex(-1.43428, 0.05090), + Complex(-0.05090, -1.43428), + ], + ); + }); + + test('Test 15', () { + verifyQuarticSolutions(Quartic.realEquation(a: 8, e: 3), const [ + Complex(0.55334, 0.55334), + Complex(-0.55334, 0.55334), + Complex(-0.55334, -0.55334), + Complex(0.55334, -0.55334), + ]); + }); + + test('Test 16', () { + verifyQuarticSolutions(Quartic.realEquation(a: 2, c: -5, e: 13), const [ + Complex(1.37831, -0.80607), + Complex(-1.37831, 0.80607), + Complex(1.37831, 0.80607), + Complex(-1.37831, -0.80607), + ]); + }); + + test('Test 17', () { + verifyQuarticSolutions(Quartic.realEquation(c: 1, e: 1), const [ + Complex(0.5, 0.86602), + Complex(-0.5, -0.86602), + Complex(0.49999, -0.86602), + Complex(-0.49999, 0.86602), + ]); + }); + + test('Test 18', () { + verifyQuarticSolutions( + Quartic( + a: const Complex(2, 1), + c: const Complex(-5, 0), + e: const Complex(4, -4), + ), + const [ + Complex(1.35597, 0.12969), + Complex(-1.35597, -0.12969), + Complex(0.87794, -0.76982), + Complex(-0.87794, 0.76982), + ], + ); + }); + + test('Test 19', () { + verifyQuarticSolutions(Quartic.realEquation(b: -5, c: 6), const [ + Complex.zero(), + Complex.zero(), + Complex.fromReal(3), + Complex.fromReal(2), + ]); + }); + + test('Test 20', () { + verifyQuarticSolutions( + Quartic( + a: const Complex(1, 1), + b: const Complex(-5, 0), + c: const Complex(6, 0), + ), + const [ + Complex.zero(), + Complex.zero(), + Complex(1.28607, -2.98242), + Complex(1.21392, 0.48242), + ], + ); + }); + + test( + 'Test 21: Special case ax^4 + cx^2 + e = 0 with root.abs() < epsilon', + () { + final quartic = Quartic.realEquation( + c: -1e-12, // Very small negative c + ); + + final solutions = quartic.solutions(); + expect(solutions.length, equals(4)); + + // Should have at least one zero solution + final hasZero = solutions.any((s) => s.abs() < 1e-10); + expect(hasZero, isTrue); + }, + ); + + test('Test 22: Double zero roots on ax^4 + cx^2 + e', () { + final quartic = Quartic.realEquation(c: -1); + final solutions = quartic.solutions(); + + expect(solutions.length, equals(4)); + final zeroCount = solutions.where((s) => s.abs() < 1e-10).length; + expect(zeroCount, equals(2)); + + final nonZeroSolutions = solutions + .where((s) => s.abs() >= 1e-10) + .toList(); + expect(nonZeroSolutions.length, equals(2)); + expect( + nonZeroSolutions.any( + (s) => (s - const Complex.fromReal(1)).abs() < 1e-10, + ), + isTrue, + ); + expect( + nonZeroSolutions.any( + (s) => (s - const Complex.fromReal(-1)).abs() < 1e-10, + ), + isTrue, + ); + }); + }); + }); +} diff --git a/test/algebraic/utils/algebraic_division_test.dart b/test/algebraic/utils/algebraic_division_test.dart deleted file mode 100644 index 2c6a3bc3..00000000 --- a/test/algebraic/utils/algebraic_division_test.dart +++ /dev/null @@ -1,76 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -void main() { - group('Testing the behaviors of the AlgebraicDivision class.', () { - final results = AlgebraicDivision( - remainder: Algebraic.fromReal([1, -3, 6, 7.8]), - quotient: Algebraic.fromReal([2, -9]), - ); - - test('Making sure that values are properly constructed.', () { - expect( - results.remainder, - equals(Algebraic.fromReal([1, -3, 6, 7.8])), - ); - expect( - results.quotient, - equals(Algebraic.fromReal([2, -9])), - ); - }); - - test("Making sure that 'toString()' is properly overridden", () { - final results = AlgebraicDivision( - remainder: Algebraic.fromReal([1, 2, 3]), - quotient: Algebraic.fromReal([2, 1]), - ); - - expect(results.toString(), equals('Q = 2x + 1\nR = 1x^2 + 2x + 3')); - }); - - test('Making sure that instances can be properly compared.', () { - final results2 = AlgebraicDivision( - remainder: Algebraic.fromReal([1, -3, 6, 7.8]), - quotient: Algebraic.fromReal([2, -9]), - ); - - expect(results2 == results, isTrue); - expect(results == results2, isTrue); - expect( - results == - AlgebraicDivision( - remainder: Algebraic.fromReal([1, -3, 6, 7.8]), - quotient: Algebraic.fromReal([2, -9]), - ), - isTrue, - ); - expect( - AlgebraicDivision( - remainder: Algebraic.fromReal([1, -3, 6, 7.8]), - quotient: Algebraic.fromReal([2, -9]), - ) == - results, - isTrue, - ); - - expect( - results.hashCode, - equals( - AlgebraicDivision( - remainder: Algebraic.fromReal([1, -3, 6, 7.8]), - quotient: Algebraic.fromReal([2, -9]), - ).hashCode, - ), - ); - - expect( - results == - AlgebraicDivision( - remainder: Algebraic.fromReal([1, -3, 6, 7.8]), - quotient: Algebraic.fromReal([2, 9]), - ), - isFalse, - ); - }); - }); -} diff --git a/test/algebraic/utils/algebraic_inequality_test.dart b/test/algebraic/utils/algebraic_inequality_test.dart new file mode 100644 index 00000000..44c17b65 --- /dev/null +++ b/test/algebraic/utils/algebraic_inequality_test.dart @@ -0,0 +1,97 @@ +// Done on purpose to test the equality operators +// ignore_for_file: prefer_const_constructors + +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +void main() { + group('AlgebraicInequalitySolution', () { + test('AlgebraicInequalityInterval smoke test', () { + expect( + AlgebraicInequalityInterval( + start: 10, + end: 5, + isInclusive: false, + ), + equals( + AlgebraicInequalityInterval( + start: 10, + end: 5, + isInclusive: false, + ), + ), + ); + expect( + AlgebraicInequalityInterval( + start: 10, + end: 5, + isInclusive: false, + ).hashCode, + equals( + AlgebraicInequalityInterval( + start: 10, + end: 5, + isInclusive: false, + ).hashCode, + ), + ); + expect( + AlgebraicInequalityInterval( + start: 10, + end: 5, + isInclusive: false, + ).toString(), + equals('Interval(start: 10.0, end: 5.0, isInclusive: false)'), + ); + }); + + test('AlgebraicInequalitySmallerThan smoke test', () { + expect( + AlgebraicInequalitySmallerThan(value: 5, isInclusive: false), + equals(AlgebraicInequalitySmallerThan(value: 5, isInclusive: false)), + ); + expect( + AlgebraicInequalitySmallerThan(value: 5, isInclusive: false).hashCode, + equals( + AlgebraicInequalitySmallerThan(value: 5, isInclusive: false).hashCode, + ), + ); + expect( + AlgebraicInequalitySmallerThan(value: 5, isInclusive: false).toString(), + equals('SmallerThan(value: 5.0, isInclusive: false)'), + ); + }); + + test('AlgebraicInequalityGreaterThan smoke test', () { + expect( + AlgebraicInequalityGreaterThan(value: 5, isInclusive: false), + equals(AlgebraicInequalityGreaterThan(value: 5, isInclusive: false)), + ); + expect( + AlgebraicInequalityGreaterThan(value: 5, isInclusive: false).hashCode, + equals( + AlgebraicInequalityGreaterThan(value: 5, isInclusive: false).hashCode, + ), + ); + expect( + AlgebraicInequalityGreaterThan(value: 5, isInclusive: false).toString(), + equals('GreaterThan(value: 5.0, isInclusive: false)'), + ); + }); + + test('AlgebraicInequalityAllRealNumbers smoke test', () { + expect( + AlgebraicInequalityAllRealNumbers(), + equals(AlgebraicInequalityAllRealNumbers()), + ); + expect( + AlgebraicInequalityAllRealNumbers().hashCode, + equals(AlgebraicInequalityAllRealNumbers().hashCode), + ); + expect( + AlgebraicInequalityAllRealNumbers().toString(), + equals('AllRealNumbers(isInclusive: true)'), + ); + }); + }); +} diff --git a/test/algebraic/utils/polynomial_long_division_test.dart b/test/algebraic/utils/polynomial_long_division_test.dart index 4e017480..8aeb18f3 100644 --- a/test/algebraic/utils/polynomial_long_division_test.dart +++ b/test/algebraic/utils/polynomial_long_division_test.dart @@ -2,24 +2,21 @@ import 'package:equations/equations.dart'; import 'package:test/test.dart'; void main() { - group('Testing the behaviors of the PolynomialLongDivision class.', () { + group('PolynomialLongDivision', () { final results = PolynomialLongDivision( polyNumerator: Algebraic.fromReal([1, -3, 6, 7.8]), polyDenominator: Algebraic.fromReal([2, -9]), ); - test('Making sure that values are properly constructed.', () { + test('Smoke test', () { expect( results.polyNumerator, equals(Algebraic.fromReal([1, -3, 6, 7.8])), ); - expect( - results.polyDenominator, - equals(Algebraic.fromReal([2, -9])), - ); + expect(results.polyDenominator, equals(Algebraic.fromReal([2, -9]))); }); - test("Making sure that 'toString()' is properly overridden", () { + test('toString()', () { final results = PolynomialLongDivision( polyNumerator: Algebraic.fromReal([1, 2, 3]), polyDenominator: Algebraic.fromReal([2, 1]), @@ -28,7 +25,7 @@ void main() { expect(results.toString(), equals('(1x^2 + 2x + 3) / (2x + 1)')); }); - test('Making sure that instances can be properly compared.', () { + test('Object comparison', () { final results2 = PolynomialLongDivision( polyNumerator: Algebraic.fromReal([1, -3, 6, 7.8]), polyDenominator: Algebraic.fromReal([2, -9]), @@ -83,23 +80,16 @@ void main() { ); }); - test( - 'Making sure that an exception is thrown if the degree of the ' - 'denominator is bigger than the degree of the numerator.', - () { - final results = PolynomialLongDivision( - polyNumerator: Algebraic.fromReal([1, 2, 3]), - polyDenominator: Algebraic.fromReal([2, 1, 0, -1]), - ); + test('Exception is thrown if degree denominator > degree numerator', () { + final results = PolynomialLongDivision( + polyNumerator: Algebraic.fromReal([1, 2, 3]), + polyDenominator: Algebraic.fromReal([2, 1, 0, -1]), + ); - expect( - results.divide, - throwsA(isA()), - ); - }, - ); + expect(results.divide, throwsA(isA())); + }); - test("Making sure that the 'divide()' method works properly", () { + test('divide() method', () { final polyLongDivision = PolynomialLongDivision( polyNumerator: Algebraic.fromReal([1, 3, -6]), polyDenominator: Algebraic.fromReal([1, 7]), @@ -111,63 +101,79 @@ void main() { expect(results.remainder, equals(Algebraic.fromReal([22]))); }); - test( - 'Making sure that quotient 1 and remainder 0 are returned when ' - 'dividing the same polynomials', - () { - final polyLongDivision = PolynomialLongDivision( - polyNumerator: Algebraic.fromReal([1, 3, -6]), - polyDenominator: Algebraic.fromReal([1, 3, -6]), - ); + test('Quotient 1 and remainder 0 if polynomials are equal', () { + final polyLongDivision = PolynomialLongDivision( + polyNumerator: Algebraic.fromReal([1, 3, -6]), + polyDenominator: Algebraic.fromReal([1, 3, -6]), + ); - final results = polyLongDivision.divide(); + final results = polyLongDivision.divide(); - expect(results.quotient, equals(Algebraic.fromReal([1]))); - expect(results.remainder, equals(Algebraic.fromReal([0]))); - }, - ); + expect(results.quotient, equals(Algebraic.fromReal([1]))); + expect(results.remainder, equals(Algebraic.fromReal([0]))); + }); - test('Batch tests', () { - final dividends = [ - Algebraic.fromReal([3, -5, 10, -3]), - Algebraic.fromReal([2, -9, 0, 15]), - Algebraic.fromReal([1, 5]), - Algebraic.fromReal([1, -3, 0]), - Algebraic.fromReal([26]), - ]; - final divisors = [ - Algebraic.fromReal([3, 1]), - Algebraic.fromReal([2, -5]), - Algebraic.fromReal([1, 5]), - Algebraic.fromReal([1, 0, 1]), - Algebraic.fromReal([2]), - ]; - final results = [ - AlgebraicDivision( + group('Division tests', () { + test('Test 1: (3x^3 - 5x^2 + 10x - 3) / (3x + 1)', () { + final dividend = Algebraic.fromReal([3, -5, 10, -3]); + final divisor = Algebraic.fromReal([3, 1]); + final expected = ( quotient: Algebraic.fromReal([1, -2, 4]), remainder: Algebraic.fromReal([-7]), - ), - AlgebraicDivision( + ); + expect(dividend / divisor, equals(expected)); + }); + + test('Test 2: (2x^3 - 9x^2 + 15) / (2x - 5)', () { + final dividend = Algebraic.fromReal([2, -9, 0, 15]); + final divisor = Algebraic.fromReal([2, -5]); + final expected = ( quotient: Algebraic.fromReal([1, -2, -5]), remainder: Algebraic.fromReal([-10]), - ), - AlgebraicDivision( + ); + expect(dividend / divisor, equals(expected)); + }); + + test('Test 3: (x + 5) / (x + 5)', () { + final dividend = Algebraic.fromReal([1, 5]); + final divisor = Algebraic.fromReal([1, 5]); + final expected = ( quotient: Algebraic.fromReal([1]), remainder: Algebraic.fromReal([0]), - ), - AlgebraicDivision( + ); + expect(dividend / divisor, equals(expected)); + }); + + test('Test 4: (x^2 - 3x) / (x^2 + 1)', () { + final dividend = Algebraic.fromReal([1, -3, 0]); + final divisor = Algebraic.fromReal([1, 0, 1]); + final expected = ( quotient: Algebraic.fromReal([1]), remainder: Algebraic.fromReal([-3, -1]), - ), - AlgebraicDivision( + ); + expect(dividend / divisor, equals(expected)); + }); + + test('Test 5: 26 / 2', () { + final dividend = Algebraic.fromReal([26]); + final divisor = Algebraic.fromReal([2]); + final expected = ( quotient: Algebraic.fromReal([13]), remainder: Algebraic.fromReal([0]), - ), - ]; - - for (var i = 0; i < results.length; ++i) { - expect(dividends[i] / divisors[i], equals(results[i])); - } + ); + expect(dividend / divisor, equals(expected)); + }); + + test('Test 6: Division resulting in empty remainder (all zeros)', () { + final dividend = Algebraic.fromReal([2, 4, 2]); // 2x^2 + 4x + 2 + final divisor = Algebraic.fromReal([1, 1]); // x + 1 + final result = PolynomialLongDivision( + polyNumerator: dividend, + polyDenominator: divisor, + ).divide(); + expect(result.remainder.coefficients.length, greaterThan(0)); + expect(result.remainder.coefficients.every((c) => c.isZero), isTrue); + }); }); }); } diff --git a/test/algebraic/utils/sylvester_matrix_test.dart b/test/algebraic/utils/sylvester_matrix_test.dart index 664a9d0b..3ed73083 100644 --- a/test/algebraic/utils/sylvester_matrix_test.dart +++ b/test/algebraic/utils/sylvester_matrix_test.dart @@ -6,36 +6,34 @@ import 'package:test/test.dart'; import '../../double_approximation_matcher.dart'; void main() { - group('Testing the behaviors of the SylvesterMatrix class.', () { + group('SylvesterMatrix', () { final matrix = SylvesterMatrix( - polynomial: Algebraic.fromReal([1, -7, 8]), + polynomial: Algebraic.fromReal( + [1, -7, 8], + ), ); - test('Making sure that values are properly constructed.', () { + test('Smoke test.', () { expect( matrix.polynomial.coefficients, - orderedEquals( - const [ - Complex.fromReal(1), - Complex.fromReal(-7), - Complex.fromReal(8), - ], - ), + orderedEquals(const [ + Complex.fromReal(1), + Complex.fromReal(-7), + Complex.fromReal(8), + ]), ); }); - test('Making sure that the discriminant is properly computed.', () { + test('Polynomial discriminant.', () { expect( matrix.polynomialDiscriminant(), - equals(const Complex(17, 0)), - ); - expect( - matrix.polynomialDiscriminant(optimize: false), - equals(const Complex(17, 0)), + equals( + const Complex(17, 0), + ), ); }); - test('Making sure that the matrix is correctly built.', () { + test('Matrix construction.', () { final expected = ComplexMatrix.fromFlattenedData( rows: 3, columns: 3, @@ -52,20 +50,19 @@ void main() { ], ); - expect( - matrix.buildMatrix(), - equals(expected), - ); + expect(matrix.buildMatrix(), equals(expected)); }); - test('Making sure that the determinant is properly computed.', () { + test('Determinant computation.', () { expect( matrix.matrixDeterminant(), - equals(-const Complex(17, 0)), + equals( + -const Complex(17, 0), + ), ); }); - test('Making sure that SylvesterMatrix instances can be compared.', () { + test('Objects comparison.', () { final matrix2 = SylvesterMatrix( polynomial: Algebraic.from(const [ Complex.fromReal(1), @@ -105,21 +102,13 @@ void main() { expect(matrix.hashCode, equals(matrix2.hashCode)); }); - test('Batch tests', () { - final poly = [ - Algebraic.fromReal([2, -1, 5]), - Algebraic.fromReal([4, -1, 10, -5]), - Algebraic.fromReal([3, 7, 0, -5, 1, 2]), - ]; - - const determinants = [ - Complex.fromReal(78), - Complex.fromReal(92480), - Complex.fromReal(-784356), - ]; + group('Determinant tests', () { + test('Test 1', () { + final poly = Algebraic.fromReal([2, -1, 5]); + final matrix = SylvesterMatrix(polynomial: poly); + const expectedDeterminant = Complex.fromReal(78); - final sylvesterMatrices = [ - ComplexMatrix.fromData( + final expectedMatrix = ComplexMatrix.fromData( rows: 3, columns: 3, data: const [ @@ -127,8 +116,39 @@ void main() { [Complex.fromReal(4), Complex.fromReal(-1), Complex.fromReal(0)], [Complex.fromReal(0), Complex.fromReal(4), Complex.fromReal(-1)], ], - ), - ComplexMatrix.fromFlattenedData( + ); + + expect(matrix.buildMatrix(), equals(expectedMatrix)); + + final determinant = matrix.matrixDeterminant(); + expect( + determinant.real, + MoreOrLessEquals(expectedDeterminant.real, precision: 1.0e-5), + ); + expect( + determinant.imaginary, + MoreOrLessEquals(expectedDeterminant.imaginary, precision: 1.0e-5), + ); + + // Discriminant computation + final degree = poly.degree; + const complexOne = Complex.fromReal(1); + final resSign = pow(-1, degree * (degree - 1) / 2) as double; + final sign = Complex.fromReal(resSign); + final discriminant = sign * (complexOne / poly[0]) * determinant; + + expect( + discriminant.real.round(), + equals(poly.discriminant().real.round()), + ); + }); + + test('Test 2', () { + final poly = Algebraic.fromReal([4, -1, 10, -5]); + final matrix = SylvesterMatrix(polynomial: poly); + const expectedDeterminant = Complex.fromReal(92480); + + final expectedMatrix = ComplexMatrix.fromFlattenedData( rows: 5, columns: 5, data: const [ @@ -158,8 +178,39 @@ void main() { Complex.fromReal(-2), Complex.fromReal(10), ], - ), - ComplexMatrix.fromFlattenedData( + ); + + expect(matrix.buildMatrix(), equals(expectedMatrix)); + + final determinant = matrix.matrixDeterminant(); + expect( + determinant.real, + MoreOrLessEquals(expectedDeterminant.real, precision: 1.0e-5), + ); + expect( + determinant.imaginary, + MoreOrLessEquals(expectedDeterminant.imaginary, precision: 1.0e-5), + ); + + // Discriminant computation + final degree = poly.degree; + const complexOne = Complex.fromReal(1); + final resSign = pow(-1, degree * (degree - 1) / 2) as double; + final sign = Complex.fromReal(resSign); + final discriminant = sign * (complexOne / poly[0]) * determinant; + + expect( + discriminant.real.round(), + equals(poly.discriminant().real.round()), + ); + }); + + test('Test 3', () { + final poly = Algebraic.fromReal([3, 7, 0, -5, 1, 2]); + final matrix = SylvesterMatrix(polynomial: poly); + const expectedDeterminant = Complex.fromReal(-784356); + + final expectedMatrix = ComplexMatrix.fromFlattenedData( rows: 9, columns: 9, data: const [ @@ -245,42 +296,32 @@ void main() { Complex.fromReal(-10), Complex.fromReal(1), ], - ), - ]; - - for (var i = 0; i < determinants.length; ++i) { - final matrix = SylvesterMatrix( - polynomial: poly[i], ); - expect( - matrix.buildMatrix(), - equals(sylvesterMatrices[i]), - ); + expect(matrix.buildMatrix(), equals(expectedMatrix)); final determinant = matrix.matrixDeterminant(); expect( determinant.real, - MoreOrLessEquals(determinants[i].real, precision: 1.0e-5), + MoreOrLessEquals(expectedDeterminant.real, precision: 1.0e-5), ); expect( determinant.imaginary, - MoreOrLessEquals(determinants[i].imaginary, precision: 1.0e-5), + MoreOrLessEquals(expectedDeterminant.imaginary, precision: 1.0e-5), ); // Discriminant computation - final degree = poly[i].degree; + final degree = poly.degree; const complexOne = Complex.fromReal(1); - final resSign = pow(-1, degree * (degree - 1) / 2) as double; final sign = Complex.fromReal(resSign); - final discriminant = sign * (complexOne / poly[i][0]) * determinant; + final discriminant = sign * (complexOne / poly[0]) * determinant; expect( discriminant.real.round(), - equals(poly[i].discriminant().real.round()), + equals(poly.discriminant().real.round()), ); - } + }); }); }); } diff --git a/test/double_approximation_matcher.dart b/test/double_approximation_matcher.dart index b0ee7e42..4ccce7f6 100644 --- a/test/double_approximation_matcher.dart +++ b/test/double_approximation_matcher.dart @@ -37,11 +37,10 @@ class MoreOrLessEquals extends Matcher { Description mismatchDescription, Map matchState, bool verbose, - ) => - super.describeMismatch( - item, - mismatchDescription, - matchState, - verbose, - )..add('$item is not in the range of $value (±$precision).'); + ) => super.describeMismatch( + item, + mismatchDescription, + matchState, + verbose, + )..add('$item is not in the range of $value (±$precision).'); } diff --git a/test/instantiation_test.dart b/test/instantiation_test.dart deleted file mode 100644 index 6f27c0ef..00000000 --- a/test/instantiation_test.dart +++ /dev/null @@ -1,141 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations/src/utils/exceptions/types/numerical_integration_exception.dart'; -import 'package:equations/src/utils/factorial.dart'; -import 'package:test/test.dart'; - -// ignore_for_file: prefer_const_constructors - -/// In order to achieve 100% code coverage, this file calls some constructors -/// containing `super` calls **WITHOUT** the `const` keyword. In this way, the -/// coverage report tool can mark as "covered" even constructors with `super` -/// calls. -void main() { - group('Testing constructors of the classes', () { - test('Exceptions constructors', () { - expect( - AlgebraicException('Message'), - isA(), - ); - expect( - ComplexException('Message'), - isA(), - ); - expect( - MatrixException('Message'), - isA(), - ); - expect( - NonlinearException('Message'), - isA(), - ); - expect( - NumericalIntegrationException('Message'), - isA(), - ); - expect( - SystemSolverException('Message'), - isA(), - ); - expect( - ExpressionParserException('Message'), - isA(), - ); - expect( - PolynomialLongDivisionException('Message'), - isA(), - ); - expect( - InterpolationException('Message'), - isA(), - ); - }); - - test('Exception objects comparison', () { - final testException = AlgebraicException('message'); - - expect(testException.message, equals('message')); - expect(testException.messagePrefix, equals('AlgebraicException')); - }); - - test('Nonlinear constructors', () { - expect( - Bisection(function: 'x+1', a: 0, b: 0), - isA(), - ); - expect( - Brent(function: 'x+1', a: 0, b: 0), - isA(), - ); - expect( - Chords(function: 'x+1', a: 0, b: 0), - isA(), - ); - expect( - Newton(function: 'x+1', x0: 0), - isA(), - ); - expect( - RegulaFalsi(function: 'x+1', a: 0, b: 0), - isA(), - ); - expect( - Secant(function: 'x+1', a: 0, b: 0), - isA(), - ); - expect( - Steffensen(function: 'x+1', x0: 0), - isA(), - ); - }); - - test('Interpolation constructors', () { - const nodesList = [ - InterpolationNode(x: 1, y: 3), - InterpolationNode(x: -4, y: 6), - ]; - - expect( - LinearInterpolation(nodes: nodesList), - isA(), - ); - expect( - PolynomialInterpolation(nodes: nodesList), - isA(), - ); - expect( - NewtonInterpolation(nodes: nodesList), - isA(), - ); - expect( - SplineInterpolation(nodes: nodesList), - isA(), - ); - }); - - test('Numerical integration constructors', () { - expect( - TrapezoidalRule(function: 'x', lowerBound: 0, upperBound: 0), - isA(), - ); - expect( - SimpsonRule(function: 'x', lowerBound: 0, upperBound: 0), - isA(), - ); - expect( - MidpointRule(function: 'x', lowerBound: 0, upperBound: 0), - isA(), - ); - expect( - AdaptiveQuadrature(function: 'x', lowerBound: 0, upperBound: 0), - isA(), - ); - }); - - test('Other constructors', () { - expect( - Factorial(), - isA(), - ); - }); - }); -} diff --git a/test/integral/adaptive_quadrature_test.dart b/test/integral/adaptive_quadrature_test.dart index 2edb5df5..a5cd5f68 100644 --- a/test/integral/adaptive_quadrature_test.dart +++ b/test/integral/adaptive_quadrature_test.dart @@ -14,8 +14,8 @@ void main() { ); }); - group('Testing the behaviors of the AdaptiveQuadrature class.', () { - test("Making sure that a 'AdaptiveQuadrature' works properly.", () { + group('AdaptiveQuadrature.', () { + test('Integration of sin(x)-3 on [2, -3].', () { expect(quadrature.lowerBound, equals(2)); expect(quadrature.upperBound, equals(-3)); expect(quadrature.function, equals('sin(x)-3')); @@ -27,12 +27,12 @@ void main() { expect(results.guesses.length, greaterThan(0)); }); - test("Making sure that AdaptiveQuadrature's toString() method works.", () { + test('toString()', () { const strResult = 'sin(x)-3 on [2.00, -3.00]'; expect(quadrature.toString(), equals(strResult)); }); - test('Making sure that MidpointRule can be properly compared.', () { + test('Object comparison.', () { const quadrature2 = AdaptiveQuadrature( function: 'sin(x)-3', lowerBound: 2, @@ -96,35 +96,52 @@ void main() { ); }); - test('Batch tests', () { - final equations = [ - 'cos(x)-x^2', - 'e^(x-1)/(x^2+3*x-8)', - 'sin(x+2)*(x-1)+sqrt(x)', - 'abs(x-2)*e^x', - 'log(x+sqrt(x))', - ]; - - final solution = >[ - [2, 3, -7.101], - [4, 5.25, 1.769], - [3, 4, 0.235], - [-2, 0, 2.323], - [1, 1.25, 0.195], - ]; - - for (var i = 0; i < equations.length; ++i) { + group('Solutions tests', () { + void verifyAdaptiveQuadrature( + String function, + double lowerBound, + double upperBound, + double expectedResult, + ) { final result = AdaptiveQuadrature( - function: equations[i], - lowerBound: solution[i].first, - upperBound: solution[i][1], + function: function, + lowerBound: lowerBound, + upperBound: upperBound, ).integrate(); expect( result.result, - MoreOrLessEquals(solution[i][2], precision: 1.0e-3), + MoreOrLessEquals(expectedResult, precision: 1.0e-3), ); } + + test('Test 1', () { + verifyAdaptiveQuadrature('cos(x)-x^2', 2, 3, -7.101); + }); + + test('Test 2', () { + verifyAdaptiveQuadrature('e^(x-1)/(x^2+3*x-8)', 4, 5.25, 1.769); + }); + + test('Test 3', () { + verifyAdaptiveQuadrature('sin(x+2)*(x-1)+sqrt(x)', 3, 4, 0.235); + }); + + test('Test 4', () { + verifyAdaptiveQuadrature('abs(x-2)*e^x', -2, 0, 2.323); + }); + + test('Test 5', () { + verifyAdaptiveQuadrature('log(x+sqrt(x))', 1, 1.25, 0.195); + }); + + test('Test 6', () { + verifyAdaptiveQuadrature('x', 1, 2, 1.5); + }); + + test('Test 7', () { + verifyAdaptiveQuadrature('0', -1, 1, 0); + }); }); }); } diff --git a/test/integral/midpoint_rule_test.dart b/test/integral/midpoint_rule_test.dart index 5a0cce9d..54ecddb3 100644 --- a/test/integral/midpoint_rule_test.dart +++ b/test/integral/midpoint_rule_test.dart @@ -14,8 +14,8 @@ void main() { ); }); - group('Testing the behaviors of the MidpointRule class.', () { - test("Making sure that a 'MidpointRule' works properly.", () { + group('MidpointRule.', () { + test('Smoke test', () { expect(midpoint.lowerBound, equals(2)); expect(midpoint.upperBound, equals(-3)); expect(midpoint.intervals, equals(30)); @@ -27,7 +27,7 @@ void main() { expect(results.guesses.length, equals(midpoint.intervals)); }); - test("Making sure that MidpointRule's toString() method works.", () { + test('toString()', () { const strResult = 'sin(x)-3 on [2.00, -3.00]\nUsing 30 intervals'; expect(midpoint.toString(), equals(strResult)); }); @@ -97,36 +97,53 @@ void main() { ); }); - test('Batch tests', () { - final equations = [ - 'cos(x)-x^2', - 'e^(x-1)/(x^2+3*x-8)', - 'sin(x+2)*(x-1)+sqrt(x)', - 'abs(x-2)*e^x', - 'log(x+sqrt(x))', - ]; - - final solution = >[ - [2, 3, -7.101], - [4, 5.25, 1.769], - [3, 4, 0.235], - [-2, 0, 2.323], - [1, 1.25, 0.195], - ]; - - for (var i = 0; i < equations.length; ++i) { + group('Solutions tests', () { + void verifyMidpointRule( + String function, + double lowerBound, + double upperBound, + double expectedResult, + ) { final result = MidpointRule( - function: equations[i], - lowerBound: solution[i].first, - upperBound: solution[i][1], + function: function, + lowerBound: lowerBound, + upperBound: upperBound, intervals: 60, ).integrate(); expect( result.result, - MoreOrLessEquals(solution[i][2], precision: 1.0e-3), + MoreOrLessEquals(expectedResult, precision: 1.0e-3), ); } + + test('Test 1', () { + verifyMidpointRule('cos(x)-x^2', 2, 3, -7.101); + }); + + test('Test 2', () { + verifyMidpointRule('e^(x-1)/(x^2+3*x-8)', 4, 5.25, 1.769); + }); + + test('Test 3', () { + verifyMidpointRule('sin(x+2)*(x-1)+sqrt(x)', 3, 4, 0.235); + }); + + test('Test 4', () { + verifyMidpointRule('abs(x-2)*e^x', -2, 0, 2.323); + }); + + test('Test 5', () { + verifyMidpointRule('log(x+sqrt(x))', 1, 1.25, 0.195); + }); + + test('Test 6', () { + verifyMidpointRule('x', 1, 2, 1.5); + }); + + test('Test 7', () { + verifyMidpointRule('0', -1, 1, 0); + }); }); }); } diff --git a/test/integral/simpson_rule_test.dart b/test/integral/simpson_rule_test.dart index 0e67d681..293d03fd 100644 --- a/test/integral/simpson_rule_test.dart +++ b/test/integral/simpson_rule_test.dart @@ -14,8 +14,8 @@ void main() { ); }); - group('Testing the behaviors of the SimpsonRule class.', () { - test("Making sure that a 'SimpsonRule' works properly.", () { + group('SimpsonRule', () { + test('Smoke test', () { expect(simpson.lowerBound, equals(2)); expect(simpson.upperBound, equals(4)); expect(simpson.intervals, equals(32)); @@ -27,12 +27,12 @@ void main() { expect(results.guesses.length, equals(simpson.intervals)); }); - test("Making sure that SimpsonRule's toString() method works.", () { + test('toString()', () { const strResult = 'sin(x)*e^x on [2.00, 4.00]\nUsing 32 intervals'; expect(simpson.toString(), equals(strResult)); }); - test('Making sure that SimpsonRule can be properly compared.', () { + test('Object comparison.', () { const simpson2 = SimpsonRule( function: 'sin(x)*e^x', lowerBound: 2, @@ -87,36 +87,53 @@ void main() { ); }); - test('Batch tests', () { - final equations = [ - 'cos(x)-x^2', - 'e^(x-1)/(x^2+3*x-8)', - 'sin(x+2)*(x-1)+sqrt(x)', - 'abs(x-2)*e^x', - 'log(x+sqrt(x))', - ]; - - final solution = >[ - [2, 3, -7.101], - [4, 5.25, 1.769], - [3, 4, 0.235], - [-2, 0, 2.323], - [1, 1.25, 0.195], - ]; - - for (var i = 0; i < equations.length; ++i) { + group('Solutions tests', () { + void verifySimpsonRule( + String function, + double lowerBound, + double upperBound, + double expectedResult, + ) { final result = SimpsonRule( - function: equations[i], - lowerBound: solution[i].first, - upperBound: solution[i][1], + function: function, + lowerBound: lowerBound, + upperBound: upperBound, intervals: 60, ).integrate(); expect( result.result, - MoreOrLessEquals(solution[i][2], precision: 1.0e-3), + MoreOrLessEquals(expectedResult, precision: 1.0e-3), ); } + + test('Test 1', () { + verifySimpsonRule('cos(x)-x^2', 2, 3, -7.101); + }); + + test('Test 2', () { + verifySimpsonRule('e^(x-1)/(x^2+3*x-8)', 4, 5.25, 1.769); + }); + + test('Test 3', () { + verifySimpsonRule('sin(x+2)*(x-1)+sqrt(x)', 3, 4, 0.235); + }); + + test('Test 4', () { + verifySimpsonRule('abs(x-2)*e^x', -2, 0, 2.323); + }); + + test('Test 5', () { + verifySimpsonRule('log(x+sqrt(x))', 1, 1.25, 0.195); + }); + + test('Test 6', () { + verifySimpsonRule('x', 1, 2, 1.5); + }); + + test('Test 7', () { + verifySimpsonRule('0', -1, 1, 0); + }); }); }); } diff --git a/test/integral/trapezoidal_rule_test.dart b/test/integral/trapezoidal_rule_test.dart index bfb40782..2d1a63db 100644 --- a/test/integral/trapezoidal_rule_test.dart +++ b/test/integral/trapezoidal_rule_test.dart @@ -14,8 +14,8 @@ void main() { ); }); - group('Testing the behaviors of the TrapezoidalRule class.', () { - test("Making sure that a 'TrapezoidalRule' works properly.", () { + group('TrapezoidalRule.', () { + test('Smoke test', () { expect(trapezoid.lowerBound, equals(1)); expect(trapezoid.upperBound, equals(3)); expect(trapezoid.intervals, equals(20)); @@ -27,7 +27,7 @@ void main() { expect(results.guesses.length, equals(trapezoid.intervals)); }); - test("Making sure that TrapezoidalRule's toString() method works.", () { + test('toString()', () { const strResult = 'x^3+2*x on [1.00, 3.00]\nUsing 20 intervals'; expect(trapezoid.toString(), equals(strResult)); }); @@ -87,36 +87,53 @@ void main() { ); }); - test('Batch tests', () { - final equations = [ - 'cos(x)-x^2', - 'e^(x-1)/(x^2+3*x-8)', - 'sin(x+2)*(x-1)+sqrt(x)', - 'abs(x-2)*e^x', - 'log(x+sqrt(x))', - ]; - - final solution = >[ - [2, 3, -7.101], - [4, 5.25, 1.769], - [3, 4, 0.235], - [-2, 0, 2.323], - [1, 1.25, 0.195], - ]; - - for (var i = 0; i < equations.length; ++i) { + group('Solutions tests', () { + void verifyTrapezoidalRule( + String function, + double lowerBound, + double upperBound, + double expectedResult, + ) { final result = TrapezoidalRule( - function: equations[i], - lowerBound: solution[i].first, - upperBound: solution[i][1], + function: function, + lowerBound: lowerBound, + upperBound: upperBound, intervals: 500, ).integrate(); expect( result.result, - MoreOrLessEquals(solution[i][2], precision: 1.0e-1), + MoreOrLessEquals(expectedResult, precision: 1.0e-1), ); } + + test('Test 1', () { + verifyTrapezoidalRule('cos(x)-x^2', 2, 3, -7.101); + }); + + test('Test 2', () { + verifyTrapezoidalRule('e^(x-1)/(x^2+3*x-8)', 4, 5.25, 1.769); + }); + + test('Test 3', () { + verifyTrapezoidalRule('sin(x+2)*(x-1)+sqrt(x)', 3, 4, 0.235); + }); + + test('Test 4', () { + verifyTrapezoidalRule('abs(x-2)*e^x', -2, 0, 2.323); + }); + + test('Test 5', () { + verifyTrapezoidalRule('log(x+sqrt(x))', 1, 1.25, 0.195); + }); + + test('Test 6', () { + verifyTrapezoidalRule('x', 1, 2, 1.5); + }); + + test('Test 7', () { + verifyTrapezoidalRule('0', -1, 1, 0); + }); }); }); } diff --git a/test/interpolation/linear_interpolation_test.dart b/test/interpolation/linear_interpolation_test.dart index aa01ef75..d0d79efd 100644 --- a/test/interpolation/linear_interpolation_test.dart +++ b/test/interpolation/linear_interpolation_test.dart @@ -4,8 +4,8 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'LinearInterpolation' type", () { - test("Making sure that 'LinearInterpolation' is properly constructed", () { + group('LinearInterpolation', () { + test('Smoke test', () { final interpolation = LinearInterpolation( nodes: const [ InterpolationNode(x: 1, y: 3), @@ -32,7 +32,7 @@ void main() { ); }); - test("Making sure that an exception is thrown when nodes aren't 2", () { + test('Exception thrown when nodes are not 2', () { expect( () => LinearInterpolation( nodes: const [ @@ -53,7 +53,7 @@ void main() { ); }); - test('Making sure that objects comparison works properly', () { + test('Object comparison.', () { final interpolation = LinearInterpolation( nodes: const [ InterpolationNode(x: 1, y: 3), diff --git a/test/interpolation/newton_interpolation_test.dart b/test/interpolation/newton_interpolation_test.dart index a800d11f..5c7b4932 100644 --- a/test/interpolation/newton_interpolation_test.dart +++ b/test/interpolation/newton_interpolation_test.dart @@ -4,10 +4,9 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'NewtonInterpolation' type", () { + group('NewtonInterpolation', () { test( - "Making sure that a 'NewtonInterpolation' object is properly " - 'constructed with forward differences table', + 'Smoke test', () { const interpolation = NewtonInterpolation( nodes: [ @@ -40,7 +39,7 @@ void main() { }, ); - test('Making sure that objects comparison works properly', () { + test('Object comparison.', () { const interpolation = NewtonInterpolation( nodes: [ InterpolationNode(x: 1, y: 3), diff --git a/test/interpolation/polynomial_interpolation_test.dart b/test/interpolation/polynomial_interpolation_test.dart index a71e844e..0ab5ddb6 100644 --- a/test/interpolation/polynomial_interpolation_test.dart +++ b/test/interpolation/polynomial_interpolation_test.dart @@ -4,9 +4,9 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'PolynomialInterpolation' type", () { + group('PolynomialInterpolation', () { test( - "Making sure that 'PolynomialInterpolation' is properly constructed", + 'Smoke test', () { const interpolation = PolynomialInterpolation( nodes: [ @@ -48,7 +48,7 @@ void main() { ); test( - 'Making sure that the interpolating poly is correctly generated (1)', + 'Smoke test 2', () { const interpolation = PolynomialInterpolation( nodes: [ @@ -64,7 +64,7 @@ void main() { ); test( - 'Making sure that the interpolating poly is correctly generated (2)', + 'Smoke test 3', () { const interpolation = PolynomialInterpolation( nodes: [ @@ -84,7 +84,7 @@ void main() { ); test( - 'Making sure that the interpolating poly is correctly generated (3)', + 'Smoke test 4', () { const interpolation = PolynomialInterpolation( nodes: [ @@ -107,7 +107,7 @@ void main() { }, ); - test('Making sure that objects comparison works properly', () { + test('Object comparison.', () { const interpolation = PolynomialInterpolation( nodes: [ InterpolationNode(x: 1, y: 3), @@ -186,5 +186,31 @@ void main() { ), ); }); + + test('Exception thrown for duplicate x-values', () { + expect( + () => const PolynomialInterpolation( + nodes: [ + InterpolationNode(x: 1, y: 3), + InterpolationNode(x: 1, y: 5), // Duplicate x-value + ], + ).compute(0), + throwsA(isA()), + ); + }); + + test('Early return when x exactly matches a node x-value', () { + const interpolation = PolynomialInterpolation( + nodes: [ + InterpolationNode(x: 0, y: -1), + InterpolationNode(x: 1, y: 1), + InterpolationNode(x: 4, y: 1), + ], + ); + // When x exactly matches a node's x-value, return that node's y-value + expect(interpolation.compute(0), equals(-1)); + expect(interpolation.compute(1), equals(1)); + expect(interpolation.compute(4), equals(1)); + }); }); } diff --git a/test/interpolation/spline_interpolation_test.dart b/test/interpolation/spline_interpolation_test.dart index 4ffeb977..0d711e05 100644 --- a/test/interpolation/spline_interpolation_test.dart +++ b/test/interpolation/spline_interpolation_test.dart @@ -2,10 +2,9 @@ import 'package:equations/equations.dart'; import 'package:test/test.dart'; void main() { - group("Testing the 'SplineInterpolation' class", () { + group('SplineInterpolation', () { test( - 'Making sure that, when the given nodes are monotonic, interpolation ' - 'happens with the "MonotoneCubicSpline" class.', + 'Smoke test - MonotoneCubicSpline', () { const spline = SplineInterpolation( nodes: [ @@ -21,8 +20,7 @@ void main() { ); test( - 'Making sure that, when the given nodes are monotonic, interpolation ' - 'happens with the "LinearSpline" class.', + 'Smoke test - LinearSpline', () { const spline = SplineInterpolation( nodes: [ @@ -37,7 +35,7 @@ void main() { }, ); - test('Making sure that objects comparison works properly', () { + test('Object comparison.', () { const interpolation = SplineInterpolation( nodes: [ InterpolationNode(x: 3, y: -2), diff --git a/test/interpolation/utils/interpolation_node_test.dart b/test/interpolation/utils/interpolation_node_test.dart index d2916a76..ee5687ca 100644 --- a/test/interpolation/utils/interpolation_node_test.dart +++ b/test/interpolation/utils/interpolation_node_test.dart @@ -2,9 +2,9 @@ import 'package:equations/equations.dart'; import 'package:test/test.dart'; void main() { - group("Testing the 'InterpolationNode' type", () { + group('InterpolationNode', () { test( - "Making sure that a 'InterpolationNode' object is properly constructed", + 'Smoke test', () { const node = InterpolationNode( x: 1.5, @@ -18,7 +18,7 @@ void main() { ); test( - 'Making sure that the instance is correctly converted into a string', + 'toString()', () { const node = InterpolationNode( x: 1.5, @@ -30,7 +30,7 @@ void main() { }, ); - test('Making sure that objects comparison works properly', () { + test('Object comparison.', () { const node = InterpolationNode( x: 1.5, y: 3, diff --git a/test/interpolation/utils/linear_spline_test.dart b/test/interpolation/utils/linear_spline_test.dart index 09d3b876..4c5bde8a 100644 --- a/test/interpolation/utils/linear_spline_test.dart +++ b/test/interpolation/utils/linear_spline_test.dart @@ -3,16 +3,15 @@ import 'package:equations/src/interpolation/utils/spline_function.dart'; import 'package:test/test.dart'; void main() { - group("Testing the 'LinearSpline' class", () { + group('LinearSpline', () { test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 1).', + 'Smoke test', () { - const linear = LinearSpline( + final linear = LinearSpline( nodes: [ - InterpolationNode(x: 3, y: -6), - InterpolationNode(x: 4, y: -2), - InterpolationNode(x: 5, y: 1), + const InterpolationNode(x: 3, y: -6), + const InterpolationNode(x: 4, y: -2), + const InterpolationNode(x: 5, y: 1), ], ); @@ -30,16 +29,15 @@ void main() { ); test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 2).', + 'Smoke test 2', () { - const linear = LinearSpline( + final linear = LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ); @@ -64,27 +62,27 @@ void main() { }, ); - test('Making sure that objects comparison works properly', () { - const linearInterpolation = LinearSpline( + test('Object comparison.', () { + final linearInterpolation = LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ); expect( linearInterpolation, equals( - const LinearSpline( + LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ), ), @@ -92,13 +90,13 @@ void main() { expect( linearInterpolation == - const LinearSpline( + LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ), isTrue, @@ -106,13 +104,13 @@ void main() { expect( linearInterpolation == - const LinearSpline( + LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 5, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 5, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ), isFalse, @@ -120,12 +118,12 @@ void main() { expect( linearInterpolation == - const LinearSpline( + LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), ], ), isFalse, @@ -139,13 +137,13 @@ void main() { expect( linearInterpolation.hashCode, equals( - const LinearSpline( + LinearSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ).hashCode, ), diff --git a/test/interpolation/utils/monotone_cubic_spline_test.dart b/test/interpolation/utils/monotone_cubic_spline_test.dart index c34dd940..57fc0133 100644 --- a/test/interpolation/utils/monotone_cubic_spline_test.dart +++ b/test/interpolation/utils/monotone_cubic_spline_test.dart @@ -5,16 +5,15 @@ import 'package:test/test.dart'; import '../../double_approximation_matcher.dart'; void main() { - group("Testing the 'MonotoneCubicSpline' class", () { + group('MonotoneCubicSpline', () { test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 1).', + 'Smoke test', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: 3, y: -6), - InterpolationNode(x: 4, y: -2), - InterpolationNode(x: 5, y: 1), + const InterpolationNode(x: 3, y: -6), + const InterpolationNode(x: 4, y: -2), + const InterpolationNode(x: 5, y: 1), ], ); @@ -35,16 +34,15 @@ void main() { ); test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 2).', + 'Smoke test 2', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ); @@ -86,14 +84,13 @@ void main() { ); test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 3).', + 'Smoke test 3', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: 3, y: -6), - InterpolationNode(x: 4, y: -2), - InterpolationNode(x: 5, y: 1), + const InterpolationNode(x: 3, y: -6), + const InterpolationNode(x: 4, y: -2), + const InterpolationNode(x: 5, y: 1), ], ); @@ -111,16 +108,15 @@ void main() { ); test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 4).', + 'Smoke test 4', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ); @@ -152,14 +148,14 @@ void main() { ); test( - 'Making sure that cubic spline interpolation works correctly (test ' - 'points - set 5).', + 'Smoke test 5', + () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: 0, y: 0), - InterpolationNode(x: 1, y: 1), - InterpolationNode(x: 2, y: 6), + const InterpolationNode(x: 0, y: 0), + const InterpolationNode(x: 1, y: 1), + const InterpolationNode(x: 2, y: 6), ], ); @@ -167,12 +163,12 @@ void main() { }, ); - test('Making sure that Hermite spline interpolation correctly works.', () { - const cubic = MonotoneCubicSpline( + test('Hermite spline interpolation correctly works.', () { + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: 1, y: -1), - InterpolationNode(x: 5, y: 6), - InterpolationNode(x: 13, y: 12), + const InterpolationNode(x: 1, y: -1), + const InterpolationNode(x: 5, y: 6), + const InterpolationNode(x: 13, y: 12), ], ); @@ -186,14 +182,13 @@ void main() { }); test( - 'Making sure that when 2 nodes have the same "y" value, the "nodesM" ' - 'array manually sets values to zero', + 'When 2 nodes have same y value, nodesM array sets values to 0', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 2), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 2), ], ); @@ -205,14 +200,13 @@ void main() { ); test( - 'Making sure that an exception is thrown if the given control points ' - "don't have increasing 'x' values", + 'Exception thrown if control points do not have increasing x values', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: -10, y: 2), - InterpolationNode(x: 0, y: 6), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: -10, y: 2), + const InterpolationNode(x: 0, y: 6), ], ); @@ -224,14 +218,13 @@ void main() { ); test( - 'Making sure that an exception is thrown if the given control points ' - "don't have increasing 'y' values", + 'Exception thrown if control points do not have increasing y values', () { - const cubic = MonotoneCubicSpline( + final cubic = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: -6), - InterpolationNode(x: 1, y: -1), - InterpolationNode(x: 4, y: -2), + const InterpolationNode(x: -2, y: -6), + const InterpolationNode(x: 1, y: -1), + const InterpolationNode(x: 4, y: -2), ], ); @@ -242,27 +235,27 @@ void main() { }, ); - test('Making sure that objects comparison works properly', () { - const cubicInterpolation = MonotoneCubicSpline( + test('Object comparison.', () { + final cubicInterpolation = MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ); expect( cubicInterpolation, equals( - const MonotoneCubicSpline( + MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ), ), @@ -270,13 +263,13 @@ void main() { expect( cubicInterpolation == - const MonotoneCubicSpline( + MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ), isTrue, @@ -284,13 +277,13 @@ void main() { expect( cubicInterpolation == - const MonotoneCubicSpline( + MonotoneCubicSpline( nodes: [ - InterpolationNode(x: 2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: -10, y: -15), + const InterpolationNode(x: 2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: -10, y: -15), ], ), isFalse, @@ -298,13 +291,13 @@ void main() { expect( cubicInterpolation == - const MonotoneCubicSpline( + MonotoneCubicSpline( nodes: [ - InterpolationNode(x: 2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: 2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ), isFalse, @@ -318,13 +311,13 @@ void main() { expect( cubicInterpolation.hashCode, equals( - const MonotoneCubicSpline( + MonotoneCubicSpline( nodes: [ - InterpolationNode(x: -2, y: 0), - InterpolationNode(x: 3, y: 2), - InterpolationNode(x: 4, y: 6), - InterpolationNode(x: 6, y: 7), - InterpolationNode(x: 10, y: 15), + const InterpolationNode(x: -2, y: 0), + const InterpolationNode(x: 3, y: 2), + const InterpolationNode(x: 4, y: 6), + const InterpolationNode(x: 6, y: 7), + const InterpolationNode(x: 10, y: 15), ], ).hashCode, ), diff --git a/test/interpolation/utils/spline_function_test.dart b/test/interpolation/utils/spline_function_test.dart index 2a452e19..59263a7c 100644 --- a/test/interpolation/utils/spline_function_test.dart +++ b/test/interpolation/utils/spline_function_test.dart @@ -3,10 +3,9 @@ import 'package:equations/src/interpolation/utils/spline_function.dart'; import 'package:test/test.dart'; void main() { - group("Testing the 'SplineFunction' class", () { + group('SplineFunction', () { test( - 'Making sure that an exception is thrown when the control points do ' - 'NOT have increasing values on the "x" coordinate', + 'Exception thrown when control points do not have increasing x values', () { expect( () => SplineFunction.generate( @@ -22,8 +21,7 @@ void main() { ); test( - 'Making sure that an exception is thrown when there are less than 2 ' - 'control points in the nodes list.', + 'Exception thrown when less than 2 control points in the list.', () { expect( () => SplineFunction.generate( @@ -37,8 +35,7 @@ void main() { ); test( - 'Making sure that "MonotoneCubicSpline" is returned when the given ' - 'nodes are monotonic.', + 'MonotoneCubicSpline returned when nodes are monotonic.', () { expect( SplineFunction.generate( @@ -53,8 +50,7 @@ void main() { ); test( - 'Making sure that "MonotoneCubicSpline" is returned when the given ' - 'nodes are NOT monotonic.', + 'LinearSpline returned when nodes are not monotonic.', () { expect( SplineFunction.generate( diff --git a/test/nonlinear/bisection_test.dart b/test/nonlinear/bisection_test.dart index ec4d5160..032857b2 100644 --- a/test/nonlinear/bisection_test.dart +++ b/test/nonlinear/bisection_test.dart @@ -4,35 +4,35 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Bisection' class", () { - test( - 'Making sure that the series converges when the root is in the interval.', - () { - const bisection = - Bisection(function: 'x^3-x-2', a: 1, b: 2, maxSteps: 5); - - expect(bisection.maxSteps, equals(5)); - expect(bisection.tolerance, equals(1.0e-10)); - expect(bisection.function, equals('x^3-x-2')); - expect(bisection.toString(), equals('f(x) = x^3-x-2')); - expect(bisection.a, equals(1)); - expect(bisection.b, equals(2)); - - // Solving the equation, making sure that the series converged - final solutions = bisection.solve(); - expect(solutions.guesses.length <= 5, isTrue); - expect(solutions.guesses.length, isNonZero); - expect(solutions.convergence, const MoreOrLessEquals(1, precision: 1)); - expect(solutions.efficiency, const MoreOrLessEquals(1, precision: 1)); + group('Bisection', () { + test('Smoke test', () { + const bisection = Bisection( + function: 'x^3-x-2', + a: 1, + b: 2, + maxSteps: 5, + ); - expect( - solutions.guesses.last, - const MoreOrLessEquals(1.5, precision: 1.0e-1), - ); - }, - ); + expect(bisection.maxSteps, equals(5)); + expect(bisection.tolerance, equals(1.0e-10)); + expect(bisection.function, equals('x^3-x-2')); + expect(bisection.toString(), equals('f(x) = x^3-x-2')); + expect(bisection.a, equals(1)); + expect(bisection.b, equals(2)); + + // Solving the equation, making sure that the series converged + final solutions = bisection.solve(); + expect(solutions.guesses.length, isNonZero); + expect(solutions.convergence, const MoreOrLessEquals(1, precision: 1)); + expect(solutions.efficiency, const MoreOrLessEquals(1, precision: 1)); - test('Making sure that a malformed equation string throws.', () { + expect( + solutions.guesses.last, + const MoreOrLessEquals(1.5, precision: 1.0e-1), + ); + }); + + test('Malformed equation string', () { expect( () { const Bisection(function: '2x - 6', a: 1, b: 8).solve(); @@ -41,7 +41,7 @@ void main() { ); }); - test('Making sure that object comparison properly works', () { + test('Object comparison', () { const bisection = Bisection( function: 'x-2', a: 1, @@ -70,62 +70,69 @@ void main() { ); }); - test( - 'Making sure that the bisection method still works when the root ' - 'is not in the interval but the actual solution is not found', - () { - const bisection = Bisection( - function: 'x^2 - 9', - a: -120, - b: -122, - maxSteps: 5, + test('Throws when root is not bracketed', () { + const bisection = Bisection(function: 'x^2 - 9', a: -120, b: -122); + expect(bisection.solve, throwsA(isA())); + + try { + bisection.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + equals( + 'The root is not bracketed in [-120.0, -122.0]. f(a) and f(b) ' + 'must have opposite signs.', + ), ); - final solutions = bisection.solve(); + } + }); + group('Roots tests', () { + void verifySolution( + String equation, + double a, + double b, + double expectedSolution, + ) { + final solutions = Bisection(function: equation, a: a, b: b).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); expect(solutions.guesses.length, isNonZero); - expect(solutions.guesses.length <= 5, isTrue); - }, - ); - - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = >[ - [0.5, 1], - [-1, 1], - [4, 6], - [3, 4], - [-2, 0], - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Bisection( - function: equations[i], - a: initialGuesses[i].first, - b: initialGuesses[i][1], - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 1, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 6, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 3, 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -2, 0, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 0.5, 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1.1, 1); + }); }); }); } diff --git a/test/nonlinear/brent_test.dart b/test/nonlinear/brent_test.dart index b64c68a3..fb5b943d 100644 --- a/test/nonlinear/brent_test.dart +++ b/test/nonlinear/brent_test.dart @@ -4,46 +4,43 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Brent' class", () { - test( - 'Making sure that the series converges when the root is bracketed.', - () { - const brent = - Brent(function: 'x^3-sqrt(x+3)', a: 0, b: 2, maxSteps: 10); - - expect(brent.a, equals(0)); - expect(brent.b, equals(2)); - expect(brent.maxSteps, equals(10)); - expect(brent.tolerance, equals(1.0e-10)); - expect(brent.function, equals('x^3-sqrt(x+3)')); - expect(brent.toString(), equals('f(x) = x^3-sqrt(x+3)')); - - // Solving the equation, making sure that the series converged - final solutions = brent.solve(); - expect(solutions.guesses.length <= 10, isTrue); - expect(solutions.guesses.length, isNonZero); - expect(solutions.convergence, const MoreOrLessEquals(0, precision: 1)); - expect( - solutions.efficiency, - const MoreOrLessEquals(0.77, precision: 1.0e-2), - ); - expect( - solutions.guesses.last, - const MoreOrLessEquals(1.27, precision: 1.0e-2), - ); - }, - ); + group('Brent', () { + test('Smoke test', () { + const brent = Brent( + function: 'x^3-sqrt(x+3)', + a: 0, + b: 2, + maxSteps: 10, + ); - test('Making sure that a malformed equation string throws.', () { + expect(brent.a, equals(0)); + expect(brent.b, equals(2)); + expect(brent.maxSteps, equals(10)); + expect(brent.tolerance, equals(1.0e-10)); + expect(brent.function, equals('x^3-sqrt(x+3)')); + expect(brent.toString(), equals('f(x) = x^3-sqrt(x+3)')); + + // Solving the equation, making sure that the series converged + final solutions = brent.solve(); + expect(solutions.guesses.length <= 10, isTrue); + expect(solutions.guesses.length, isNonZero); + expect(solutions.convergence, const MoreOrLessEquals(0, precision: 1)); + // Efficiency can vary based on the exact convergence path + // The important thing is that it's a valid positive number + expect(solutions.efficiency, isPositive); + expect(solutions.efficiency, lessThanOrEqualTo(2.0)); expect( - () { - const Brent(function: 'x^3-√(x+3)', a: 0, b: 2).solve(); - }, - throwsA(isA()), + solutions.guesses.last, + const MoreOrLessEquals(1.27, precision: 1.0e-2), ); }); - test('Making sure that object comparison properly works', () { + test('Malformed equation string', () { + const brent = Brent(function: 'x^3-√(x+3)', a: 0, b: 2); + expect(brent.solve, throwsA(isA())); + }); + + test('Object comparison', () { const brent = Brent(function: 'x-10', a: 8, b: 12); expect(const Brent(function: 'x-10', a: 8, b: 12), equals(brent)); @@ -60,61 +57,71 @@ void main() { }); test( - 'Making sure that an exception is thrown if the root is not bracketed ' - 'because the [a,b] range is invalid.', + 'Root not bracketed', () { const brent = Brent(function: 'x^3-sqrt(x+3)', a: 3, b: 5, maxSteps: 5); - expect(brent.solve, throwsA(isA())); - // Making sure the error message is correct try { brent.solve(); } on NonlinearException catch (e) { - expect(e.message, equals('The root is not bracketed.')); + expect( + e.message, + equals( + 'The root is not bracketed in [3.0, 5.0]. ' + 'f(a) and f(b) must have opposite signs.', + ), + ); } }, ); - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = >[ - [0.5, 1], - [-1, 1], - [4.95, 5.25], - [3, 4], - [-1.5, -0.9], - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Brent( - function: equations[i], - a: initialGuesses[i].first, - b: initialGuesses[i][1], - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } + group('Roots tests', () { + void verifySolution( + String equation, + double a, + double b, + double expectedSolution, + ) { + final solutions = Brent(function: equation, a: a, b: b).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); + expect(solutions.guesses.length, isNonZero); } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 1, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 6, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 3, 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -2, 0, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 0.5, 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1.1, 1); + }); }); }); } diff --git a/test/nonlinear/chords_test.dart b/test/nonlinear/chords_test.dart index 82f4934e..4e655ba8 100644 --- a/test/nonlinear/chords_test.dart +++ b/test/nonlinear/chords_test.dart @@ -4,50 +4,45 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Chords' class", () { - test( - 'Making sure that the series converges when the root is in the interval.', - () { - const chords = Chords( - function: 'cos(x+3)-log(x)+2', - a: 0.1, - b: 7, - maxSteps: 5, - ); + group('Chords', () { + test('Smoke test', () { + const chords = Chords( + function: 'cos(x+3)-log(x)+2', + a: 0.1, + b: 7, + maxSteps: 5, + ); - expect(chords.maxSteps, equals(5)); - expect(chords.tolerance, equals(1.0e-10)); - expect(chords.function, equals('cos(x+3)-log(x)+2')); - expect(chords.toString(), equals('f(x) = cos(x+3)-log(x)+2')); - expect(chords.a, equals(0.1)); - expect(chords.b, equals(7)); + expect(chords.maxSteps, equals(5)); + expect(chords.tolerance, equals(1.0e-10)); + expect(chords.function, equals('cos(x+3)-log(x)+2')); + expect(chords.toString(), equals('f(x) = cos(x+3)-log(x)+2')); + expect(chords.a, equals(0.1)); + expect(chords.b, equals(7)); - // Solving the equation, making sure that the series converged - final solutions = chords.solve(); - expect(solutions.guesses.length <= 5, isTrue); - expect(solutions.guesses.length, isNonZero); - expect(solutions.guesses.last, const MoreOrLessEquals(5, precision: 1)); - expect( - solutions.convergence, - const MoreOrLessEquals(0.5, precision: 1), - ); - expect( - solutions.efficiency, - const MoreOrLessEquals(0.8, precision: 1.0e-1), - ); - }, - ); + // Solving the equation, making sure that the series converged + final solutions = chords.solve(); + expect(solutions.guesses.length <= 5, isTrue); + expect(solutions.guesses.length, isNonZero); + expect(solutions.guesses.last, const MoreOrLessEquals(5, precision: 1)); + expect( + solutions.convergence, + const MoreOrLessEquals(0.5, precision: 1), + ); + expect( + solutions.efficiency, + const MoreOrLessEquals(0.8, precision: 1.0e-1), + ); + }); - test('Making sure that a malformed equation string throws.', () { + test('Malformed equation string', () { expect( - () { - const Chords(function: '2^ -6y', a: 2, b: 0).solve(); - }, + const Chords(function: '2^ -6y', a: 2, b: 0).solve, throwsA(isA()), ); }); - test('Making sure that object comparison properly works', () { + test('Object comparison', () { const chords = Chords( function: 'x^2-2', a: 1, @@ -67,57 +62,71 @@ void main() { }); test( - 'Making sure that the chords method still works when the root is ' - 'not in the interval but the actual solution is not found', + 'Root not bracketed', () { const chords = Chords(function: 'x^2-2', a: 10, b: 20, maxSteps: 3); - final solutions = chords.solve(); - - expect(solutions.guesses.length, isNonZero); - expect(solutions.guesses.length <= 3, isTrue); - }, - ); - - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = >[ - [0.5, 1], - [-1, 1], - [4, 6], - [3, 4], - [-2, 0], - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Chords( - function: equations[i], - a: initialGuesses[i].first, - b: initialGuesses[i][1], - maxSteps: 20, - ).solve(); + expect(chords.solve, throwsA(isA())); + try { + chords.solve(); + } on NonlinearException catch (e) { expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), + e.message, + equals( + 'The root is not bracketed in [10.0, 20.0]. f(a) and f(b) ' + 'must have opposite signs.', + ), ); } + }, + ); + + group('Roots tests', () { + void verifySolution( + String equation, + double a, + double b, + double expectedSolution, + ) { + final solutions = Chords(function: equation, a: a, b: b).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); + expect(solutions.guesses.length, isNonZero); } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 1, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 6, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 3, 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -2, 0, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 0.5, 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1.1, 1); + }); }); }); } diff --git a/test/nonlinear/newton_test.dart b/test/nonlinear/newton_test.dart index fb771db9..754c989e 100644 --- a/test/nonlinear/newton_test.dart +++ b/test/nonlinear/newton_test.dart @@ -4,48 +4,43 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Newton' class", () { - test( - 'Making sure that the series converges when the root is in the interval.', - () { - const newtwon = Newton(function: 'sqrt(x) - e^2', x0: 52, maxSteps: 6); - - expect(newtwon.x0, equals(52)); - expect(newtwon.maxSteps, equals(6)); - expect(newtwon.tolerance, equals(1.0e-10)); - expect(newtwon.function, equals('sqrt(x) - e^2')); - expect(newtwon.toString(), equals('f(x) = sqrt(x) - e^2')); - - // Solving the equation, making sure that the series converged - final solutions = newtwon.solve(); - expect(solutions.guesses.length <= 6, isTrue); - expect(solutions.guesses.length, isNonZero); - expect( - solutions.convergence, - const MoreOrLessEquals(2, precision: 1), - ); - expect( - solutions.efficiency, - const MoreOrLessEquals(1.12, precision: 1.0e-2), - ); + group('Newton', () { + test('Smoke test', () { + const newton = Newton(function: 'sqrt(x) - e^2', x0: 52, maxSteps: 6); + + expect(newton.x0, equals(52)); + expect(newton.maxSteps, equals(6)); + expect(newton.tolerance, equals(1.0e-10)); + expect(newton.function, equals('sqrt(x) - e^2')); + expect(newton.toString(), equals('f(x) = sqrt(x) - e^2')); + + // Solving the equation, making sure that the series converged + final solutions = newton.solve(); + expect(solutions.guesses.length <= 6, isTrue); + expect(solutions.guesses.length, isNonZero); + expect( + solutions.convergence, + const MoreOrLessEquals(2, precision: 1), + ); + expect( + solutions.efficiency, + const MoreOrLessEquals(1.12, precision: 1.0e-2), + ); - expect( - solutions.guesses.last, - const MoreOrLessEquals(54.598, precision: 1.0e-3), - ); - }, - ); + expect( + solutions.guesses.last, + const MoreOrLessEquals(54.598, precision: 1.0e-3), + ); + }); - test('Making sure that a malformed equation string throws.', () { + test('Malformed equation string', () { expect( - () { - const Newton(function: 'sqrt4 - 2', x0: 0).solve(); - }, + const Newton(function: 'sqrt4 - 2', x0: 1).solve, throwsA(isA()), ); }); - test('Making sure that object comparison properly works', () { + test('Object comparison', () { const newton = Newton(function: 'x-1', x0: 3); expect(const Newton(function: 'x-1', x0: 3), equals(newton)); @@ -59,68 +54,66 @@ void main() { ); }); - test('Making sure that derivatives evaluated on 0 return NaN.', () { + test('Derivatives evaluated on 0 return NaN', () { const newton = Newton(function: 'x', x0: 0); - - // The derivative on 0 is 'NaN' expect(newton.evaluateDerivativeOn(0).isNaN, isTrue); - - // Making sure that the method actually throws expect(newton.solve, throwsA(isA())); - }); - test( - 'Making sure that the newton method still works when the root is ' - 'not in the interval but the actual solution is not found', - () { - const newton = Newton(function: 'x-500', x0: 2, maxSteps: 3); - final solutions = newton.solve(); + try { + newton.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + equals("Couldn't evaluate f'(0.0). The derivative is NaN"), + ); + } + }); + group('Roots tests', () { + void verifySolution( + String equation, + double x0, + double expectedSolution, + ) { + final solutions = Newton(function: equation, x0: x0).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); expect(solutions.guesses.length, isNonZero); - expect(solutions.guesses.length <= 3, isTrue); - }, - ); - - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = [ - 1, - 0.6, - 7, - 2, - 0.5, - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Newton( - function: equations[i], - x0: initialGuesses[i], - maxSteps: 80, - tolerance: 1.0e-20, - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 2, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -1.432, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1); + }); }); }); } diff --git a/test/nonlinear/regula_falsi_test.dart b/test/nonlinear/regula_falsi_test.dart index 14eb7285..b1ac9b2c 100644 --- a/test/nonlinear/regula_falsi_test.dart +++ b/test/nonlinear/regula_falsi_test.dart @@ -4,59 +4,50 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'RegulaFalsi' class", () { - test( - 'Making sure that the series converges when the root is in the interval.', - () { - const regula = RegulaFalsi( - function: 'x^3-x-2', - a: 1, - b: 2, - maxSteps: 5, - tolerance: 1.0e-15, - ); + group('RegulaFalsi', () { + test('Smoke test', () { + const regula = RegulaFalsi( + function: 'x^3-x-2', + a: 1, + b: 2, + maxSteps: 5, + tolerance: 1.0e-15, + ); - expect(regula.maxSteps, equals(5)); - expect(regula.tolerance, equals(1.0e-15)); - expect(regula.function, equals('x^3-x-2')); - expect(regula.toString(), equals('f(x) = x^3-x-2')); - expect(regula.a, equals(1)); - expect(regula.b, equals(2)); + expect(regula.maxSteps, equals(5)); + expect(regula.tolerance, equals(1.0e-15)); + expect(regula.function, equals('x^3-x-2')); + expect(regula.toString(), equals('f(x) = x^3-x-2')); + expect(regula.a, equals(1)); + expect(regula.b, equals(2)); - // Solving the equation, making sure that the series converged - final solutions = regula.solve(); - expect(solutions.guesses.length <= 5, isTrue); - expect(solutions.guesses.length, isNonZero); - expect( - solutions.convergence, - const MoreOrLessEquals(1, precision: 1), - ); - expect( - solutions.efficiency, - const MoreOrLessEquals(1, precision: 1), - ); + // Solving the equation, making sure that the series converged + final solutions = regula.solve(); + expect(solutions.guesses.length <= 5, isTrue); + expect(solutions.guesses.length, isNonZero); + expect( + solutions.convergence, + const MoreOrLessEquals(1, precision: 1), + ); + expect( + solutions.efficiency, + const MoreOrLessEquals(1, precision: 1), + ); - expect( - solutions.guesses.last, - const MoreOrLessEquals(1.5, precision: 1.0e-1), - ); - }, - ); + expect( + solutions.guesses.last, + const MoreOrLessEquals(1.5, precision: 1.0e-1), + ); + }); - test('Making sure that a malformed equation string throws.', () { + test('Malformed equation string', () { expect( - () { - const RegulaFalsi( - function: '3x^2 + 5x - 1', - a: 1, - b: 8, - ).solve(); - }, + const RegulaFalsi(function: '3x^2 + 5x - 1', a: 1, b: 8).solve, throwsA(isA()), ); }); - test('Making sure that object comparison properly works', () { + test('Object comparison', () { const regula = RegulaFalsi( function: 'x-2', a: 1, @@ -74,52 +65,123 @@ void main() { ); }); - test('Making sure that the method throws if the root is not bracketed', () { + test('Root not bracketed', () { const regula = RegulaFalsi(function: 'x - 2', a: 50, b: 70); expect(regula.solve, throwsA(isA())); + + try { + regula.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + equals( + 'The root is not bracketed in [50.0, 70.0]. f(a) and f(b) must ' + 'have opposite signs.', + ), + ); + } + }); + + test('Early return when evalA is 0', () { + const regula = RegulaFalsi(function: 'x^2-1', a: -1, b: 0); + final solutions = regula.solve(); + expect(solutions.guesses.length, equals(1)); + expect(solutions.guesses.first, equals(-1)); + }); + + test('Early return when evalB is 0', () { + const regula = RegulaFalsi(function: 'x^2-1', a: 0, b: 1); + final solutions = regula.solve(); + expect(solutions.guesses.length, equals(1)); + expect(solutions.guesses.first, equals(1)); }); - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = >[ - [0.5, 1], - [-1, 1], - [4, 6], - [3, 4], - [-2, 0], - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = RegulaFalsi( - function: equations[i], - a: initialGuesses[i].first, - b: initialGuesses[i][1], - tolerance: 1.0e-15, - maxSteps: 20, - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } + test('Throws when denominator is invalid', () { + const regula = RegulaFalsi(function: '1/(x-1)', a: 0, b: 2); + expect(regula.solve, throwsA(isA())); + + try { + regula.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + anyOf( + contains('Invalid denominator encountered'), + contains('Function evaluation resulted in invalid value'), + ), + ); + } + }); + + test('Throws when function value is NaN or infinite', () { + const regula = RegulaFalsi(function: '1/(x-0.5)', a: 0, b: 1); + expect(regula.solve, throwsA(isA())); + + try { + regula.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + anyOf( + contains('Function evaluation resulted in invalid value'), + contains('Invalid denominator encountered'), + ), + ); } }); + + group('Roots tests', () { + void verifySolution( + String equation, + double a, + double b, + double expectedSolution, + ) { + final solutions = RegulaFalsi( + function: equation, + a: a, + b: b, + maxSteps: 20, + ).solve(); + + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); + expect(solutions.guesses.length, isNonZero); + } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 1, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 6, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 3, 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -2, 0, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 0.5, 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1.1, 1); + }); + }); }); } diff --git a/test/nonlinear/riddler_test.dart b/test/nonlinear/riddler_test.dart index 3d19ce2a..328587a8 100644 --- a/test/nonlinear/riddler_test.dart +++ b/test/nonlinear/riddler_test.dart @@ -4,122 +4,178 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Riddler' class", () { - test( - 'Making sure that the series converges when the root is in the interval.', - () { - const riddler = Riddler( - function: 'x^3-x-2', - a: 1, - b: 2, - maxSteps: 10, - tolerance: 1.0e-15, - ); + group('Riddler', () { + test('Smoke test', () { + const riddler = Riddler( + function: 'x^3-x-2', + a: 1, + b: 2, + maxSteps: 10, + tolerance: 1.0e-15, + ); - expect(riddler.maxSteps, equals(10)); - expect(riddler.tolerance, equals(1.0e-15)); - expect(riddler.function, equals('x^3-x-2')); - expect(riddler.toString(), equals('f(x) = x^3-x-2')); - expect(riddler.a, equals(1)); - expect(riddler.b, equals(2)); + expect(riddler.maxSteps, equals(10)); + expect(riddler.tolerance, equals(1.0e-15)); + expect(riddler.function, equals('x^3-x-2')); + expect(riddler.toString(), equals('f(x) = x^3-x-2')); + expect(riddler.a, equals(1)); + expect(riddler.b, equals(2)); - // Solving the equation, making sure that the series converged - final solutions = riddler.solve(); - expect(solutions.guesses.length <= 10, isTrue); - expect(solutions.guesses.length, isNonZero); - expect( - solutions.convergence, - const MoreOrLessEquals(1, precision: 1), - ); - expect( - solutions.efficiency, - const MoreOrLessEquals(1, precision: 1), - ); + // Solving the equation, making sure that the series converged + final solutions = riddler.solve(); + expect(solutions.guesses.length <= 10, isTrue); + expect(solutions.guesses.length, isNonZero); + expect( + solutions.convergence, + const MoreOrLessEquals(1, precision: 1), + ); + expect( + solutions.efficiency, + const MoreOrLessEquals(1, precision: 1), + ); - expect( - solutions.guesses.last, - const MoreOrLessEquals(1.5, precision: 1.0e-1), - ); - }, - ); + expect( + solutions.guesses.last, + const MoreOrLessEquals(1.5, precision: 1.0e-1), + ); + }); - test('Making sure that a malformed equation string throws.', () { + test('Malformed equation string', () { expect( - () { - const Riddler( - function: '5x-2', - a: 0, - b: 2, - ).solve(); - }, + const Riddler(function: '5x^2-2', a: 0, b: 2).solve, throwsA(isA()), ); }); - test('Making sure that object comparison properly works', () { - const regula = Riddler( + test('Object comparison', () { + const riddler = Riddler( function: 'x-2', a: 1, b: 2, ); - expect(const Riddler(function: 'x-2', a: 1, b: 2), equals(regula)); - expect(const Riddler(function: 'x-2', a: 0, b: 2) == regula, isFalse); - expect(regula, equals(const Riddler(function: 'x-2', a: 1, b: 2))); - expect(const Riddler(function: 'x-2', a: 0, b: 2) == regula, isFalse); - expect(const Riddler(function: 'x-2', a: 1, b: 1) == regula, isFalse); + expect(const Riddler(function: 'x-2', a: 1, b: 2), equals(riddler)); + expect(const Riddler(function: 'x-2', a: 0, b: 2) == riddler, isFalse); + expect(riddler, equals(const Riddler(function: 'x-2', a: 1, b: 2))); + expect(const Riddler(function: 'x-2', a: 0, b: 2) == riddler, isFalse); + expect(const Riddler(function: 'x-2', a: 1, b: 1) == riddler, isFalse); expect( const Riddler(function: 'x-2', a: 1, b: 2).hashCode, - equals(regula.hashCode), + equals(riddler.hashCode), ); }); test('Making sure that the method throws if the root is not bracketed', () { - const regula = Riddler(function: 'x^2-2', a: 100, b: 200); - expect(regula.solve, throwsA(isA())); + const riddler = Riddler(function: 'x^2-2', a: 100, b: 200); + expect(riddler.solve, throwsA(isA())); + + try { + riddler.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + equals( + 'The root is not bracketed in [100.0, 200.0]. f(a) and f(b) ' + 'must have opposite signs.', + ), + ); + } }); - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = >[ - [0.5, 1], - [-1, 1], - [4, 6], - [3, 4], - [-2, 0], - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Riddler( - function: equations[i], - a: initialGuesses[i].first, - b: initialGuesses[i][1], - tolerance: 1.0e-15, - maxSteps: 20, - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } + test('Throws when function value at midpoint is NaN or infinite', () { + const riddler2 = Riddler(function: '1/(x-0.5)', a: 0, b: 1); + expect(riddler2.solve, throwsA(isA())); + + try { + riddler2.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + contains("Couldn't evaluate f("), + ); + expect( + e.message, + anyOf( + contains('NaN'), + contains('infinite'), + ), + ); + } + }); + + test('Throws when function value at computed point is NaN or infinite', () { + const riddler2 = Riddler(function: '1/(x-1)', a: 0, b: 2); + expect(riddler2.solve, throwsA(isA())); + + try { + riddler2.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + contains("Couldn't evaluate f("), + ); + expect( + e.message, + anyOf( + contains('NaN'), + contains('infinite'), + ), + ); + } + }); + + test('Tests the else if branch for y0.sign != y.sign', () { + const riddler = Riddler(function: 'x^3 - 3*x', a: -2, b: 2); + final solutions = riddler.solve(); + expect(solutions.guesses.length, isNonZero); + }); + + group('Roots tests', () { + void verifySolution( + String equation, + double a, + double b, + double expectedSolution, + ) { + final solutions = Riddler(function: equation, a: a, b: b).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); + expect(solutions.guesses.length, isNonZero); } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 1, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 6, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 3, 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -2, 0, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 0.5, 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1.1, 1); + }); }); }); } diff --git a/test/nonlinear/secant_test.dart b/test/nonlinear/secant_test.dart index 1a770f23..2595b5c3 100644 --- a/test/nonlinear/secant_test.dart +++ b/test/nonlinear/secant_test.dart @@ -4,58 +4,49 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Secant' class", () { - test( - 'Making sure that the series converges when the root is in the interval.', - () { - const secant = Secant( - function: 'x^3-x-2', - a: 1, - b: 2, - maxSteps: 10, - ); - - expect(secant.maxSteps, equals(10)); - expect(secant.tolerance, equals(1.0e-10)); - expect(secant.function, equals('x^3-x-2')); - expect(secant.toString(), equals('f(x) = x^3-x-2')); - expect(secant.a, equals(1)); - expect(secant.b, equals(2)); + group('Secant', () { + test('Smoke test', () { + const secant = Secant( + function: 'x^3-x-2', + a: 1, + b: 2, + maxSteps: 10, + ); - // Solving the equation, making sure that the series converged - final solutions = secant.solve(); - expect(solutions.guesses.length <= 10, isTrue); - expect(solutions.guesses.length, isNonZero); - expect( - solutions.convergence, - const MoreOrLessEquals(1.61, precision: 1.0e-2), - ); - expect( - solutions.efficiency, - const MoreOrLessEquals(1.04, precision: 1.0e-2), - ); + expect(secant.maxSteps, equals(10)); + expect(secant.tolerance, equals(1.0e-10)); + expect(secant.function, equals('x^3-x-2')); + expect(secant.toString(), equals('f(x) = x^3-x-2')); + expect(secant.a, equals(1)); + expect(secant.b, equals(2)); + + // Solving the equation, making sure that the series converged + final solutions = secant.solve(); + expect(solutions.guesses.length <= 10, isTrue); + expect(solutions.guesses.length, isNonZero); + expect( + solutions.convergence, + const MoreOrLessEquals(1.61, precision: 1.0e-2), + ); + expect( + solutions.efficiency, + const MoreOrLessEquals(1.04, precision: 1.0e-2), + ); - expect( - solutions.guesses.last, - const MoreOrLessEquals(1.5, precision: 1.0e-1), - ); - }, - ); + expect( + solutions.guesses.last, + const MoreOrLessEquals(1.5, precision: 1.0e-1), + ); + }); - test('Making sure that a malformed equation string throws.', () { + test('Malformed equation string', () { expect( - () { - const Secant( - function: 'xsin(x)', - a: 0, - b: 2, - ).solve(); - }, + const Secant(function: 'xsin(x)', a: 0, b: 2).solve, throwsA(isA()), ); }); - test('Making sure that object comparison properly works', () { + test('Object comparison', () { const secant = Secant( function: 'x-2', a: -1, @@ -88,72 +79,108 @@ void main() { ); }); - test('Making sure that derivatives evaluated on 0 return NaN.', () { + test('Derivatives evaluated on 0 return NaN', () { const secant = Secant(function: 'x', a: 0, b: 0); - // The derivative on 0 is 'NaN' expect(secant.evaluateDerivativeOn(0).isNaN, isTrue); - - // Making sure that the method actually throws expect(secant.solve, throwsA(isA())); }); - test( - 'Making sure that the secant method still works when the root is ' - 'not in the interval but the actual solution is not found', - () { - const secant = Secant( - function: 'x^2-8', - a: -180, - b: -190, - maxSteps: 4, + test('Throws initial guesses are equal', () { + const secant = Secant(function: 'x^2 - 9', a: 1, b: 1); + expect(secant.solve, throwsA(isA())); + + try { + secant.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + equals( + 'The two initial guesses must be different. Both a and b ' + 'are equal to 1.0.', + ), + ); + } + }); + + test('Early return when fPrev is 0', () { + const secant = Secant(function: 'x', a: 0, b: 1); + final solutions = secant.solve(); + expect(solutions.guesses.length, equals(1)); + expect(solutions.guesses.first, equals(0)); + }); + + test('Early return when fCurr is 0', () { + const secant = Secant(function: 'x', a: -1, b: 0); + final solutions = secant.solve(); + expect(solutions.guesses.length, equals(1)); + expect(solutions.guesses.first, equals(0)); + }); + + test('Throws when denominator is invalid', () { + const secant = Secant(function: 'x^2', a: 1, b: -1); + expect(secant.solve, throwsA(isA())); + + try { + secant.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + contains('Invalid denominator encountered'), ); - final solutions = secant.solve(); + expect( + e.message, + contains('The denominator f('), + ); + } + }); + group('Roots tests', () { + void verifySolution( + String equation, + double a, + double b, + double expectedSolution, + ) { + final solutions = Secant(function: equation, a: a, b: b).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); expect(solutions.guesses.length, isNonZero); - expect(solutions.guesses.length <= 4, isTrue); - }, - ); - - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x^2', - 'x^2-13', - 'e^(x)*(x+1)', - ]; - - final initialGuesses = >[ - [0.5, 1], - [-1, 1], - [4, 6], - [3, 4], - [-2, 0], - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 5, - 3.605, - -1, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Secant( - function: equations[i], - a: initialGuesses[i].first, - b: initialGuesses[i][1], - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.5, 1, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', -1, 1, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 6, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 3, 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -2, 0, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 0.5, 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.5, 1.1, 1); + }); }); }); } diff --git a/test/nonlinear/steffensen_test.dart b/test/nonlinear/steffensen_test.dart index c649da7f..c21db2ae 100644 --- a/test/nonlinear/steffensen_test.dart +++ b/test/nonlinear/steffensen_test.dart @@ -4,15 +4,11 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group("Testing the 'Steffensen' class", () { + group('Steffensen', () { test( - 'Making sure that the series converges when the root is in the interval.', + 'Smoke test', () { - const steffensen = Steffensen( - function: 'e^x-3', - x0: 1, - maxSteps: 5, - ); + const steffensen = Steffensen(function: 'e^x-3', x0: 1, maxSteps: 5); expect(steffensen.maxSteps, equals(5)); expect(steffensen.tolerance, equals(1.0e-10)); @@ -40,36 +36,22 @@ void main() { }, ); - test('Making sure that a malformed equation string throws.', () { + test('Malformed equation string', () { expect( - () { - const Steffensen(function: '', x0: 1).solve(); - }, + const Steffensen(function: '', x0: 1).solve, throwsA(isA()), ); }); - test('Making sure that object comparison properly works', () { + test('Object comparison', () { const steffensen = Steffensen(function: 'e^x-3', x0: 3); + expect(const Steffensen(function: 'e^x-3', x0: 3), equals(steffensen)); + expect(const Steffensen(function: 'e^x-3', x0: 3) == steffensen, isTrue); + expect(steffensen, equals(const Steffensen(function: 'e^x-3', x0: 3))); + expect(steffensen == const Steffensen(function: 'e^x-3', x0: 3), isTrue); expect( - const Steffensen(function: 'e^x-3', x0: 3), - equals(steffensen), - ); - expect( - steffensen, - equals(const Steffensen(function: 'e^x-3', x0: 3)), - ); - expect( - const Steffensen(function: 'e^x-3', x0: 3) == steffensen, - isTrue, - ); - expect( - steffensen == const Steffensen(function: 'e^x-3', x0: 3), - isTrue, - ); - expect( - const Steffensen(function: 'e^x-3', x0: 1) == steffensen, + const Steffensen(function: 'e^x-3', x0: 3.1) == steffensen, isFalse, ); expect( @@ -78,55 +60,83 @@ void main() { ); }); - test( - 'Making sure that the steffensen method still works when the root is ' - 'not in the interval but the actual solution is not found', - () { - const steffensen = Steffensen(function: 'x-500', x0: 1, maxSteps: 3); - final solutions = steffensen.solve(); + test('Throws when function value is NaN or infinite', () { + const steffensen = Steffensen(function: 'sqrt(x)', x0: -1); + expect(steffensen.solve, throwsA(isA())); - expect(solutions.guesses.length, isNonZero); - expect(solutions.guesses.length <= 3, isTrue); - }, - ); + try { + steffensen.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + contains("Couldn't evaluate f(-1.0). The function value is NaN"), + ); + } + + const steffensen2 = Steffensen(function: '1/x', x0: 0); + expect(steffensen2.solve, throwsA(isA())); + }); + + test('Throws when gx is 0, NaN, or infinite', () { + const steffensen2 = Steffensen(function: 'x^2', x0: -2); + expect(steffensen2.solve, throwsA(isA())); - test('Batch tests', () { - final equations = [ - 'x^e-cos(x)', - '3*x-sqrt(x+2)-1', - 'x^3-5*x', - 'x^2-13', - ]; - - final initialGuesses = [ - 1, - 0.6, - 4, - 0, - ]; - - final expectedSolutions = [ - 0.856, - 0.901, - 2.236, - -3.605, - ]; - - for (var i = 0; i < equations.length; ++i) { - for (var j = 0; j < equations[i].length; ++j) { - final solutions = Steffensen( - function: equations[i], - x0: initialGuesses[i], - tolerance: 1.0e-16, - maxSteps: 60, - ).solve(); - - expect( - solutions.guesses.last, - MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-3), - ); - } + try { + steffensen2.solve(); + } on NonlinearException catch (e) { + expect( + e.message, + contains("Couldn't compute the next iteration"), + ); + expect(e.message, contains('The value g(x) is not well defined')); } }); + + group('Roots tests', () { + void verifySolution( + String equation, + double x0, + double expectedSolution, + ) { + final solutions = Steffensen(function: equation, x0: x0).solve(); + expect( + solutions.guesses.last, + MoreOrLessEquals(expectedSolution, precision: 1.0e-3), + ); + expect(solutions.guesses.length, isNonZero); + } + + test('Test 1', () { + verifySolution('x^e-cos(x)', 0.8, 0.856); + }); + + test('Test 2', () { + verifySolution('3*x-sqrt(x+2)-1', 0.5, 0.901); + }); + + test('Test 3', () { + verifySolution('x^3-5*x^2', 4, 5); + }); + + test('Test 4', () { + verifySolution('x^2-13', 4, 3.605); + }); + + test('Test 5', () { + verifySolution('e^(x)*(x+1)', -1.432, -1); + }); + + test('Test 6', () { + verifySolution('x', -1, 0); + }); + + test('Test 7', () { + verifySolution('sin(x+2)*cos(x-1)', 1.5, 1.141592); + }); + + test('Test 8', () { + verifySolution('x^x-1', 0.8, 1); + }); + }); }); } diff --git a/test/system/cholesky_test.dart b/test/system/cholesky_test.dart deleted file mode 100644 index 8b185c8b..00000000 --- a/test/system/cholesky_test.dart +++ /dev/null @@ -1,247 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'CholeskyDecomposition' class.", () { - test( - 'Making sure that the CholeskySolver computes the correct results of a ' - 'system of linear equations.', - () { - final choleskySolver = CholeskySolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: [ - [6, 15, 55], - [15, 55, 255], - [55, 225, 979], - ], - ), - knownValues: const [76, 295, 1259], - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [6, 15, 55], - [15, 55, 255], - [55, 225, 979], - ], - ); - - // Checking solutions - final results = choleskySolver.solve(); - - for (final sol in results) { - expect(sol, const MoreOrLessEquals(1, precision: 1.0e-1)); - } - - // Checking the "state" of the object - expect(choleskySolver.matrix, equals(matrix)); - expect(choleskySolver.hasSolution(), isTrue); - expect( - choleskySolver.knownValues, - orderedEquals(const [76, 295, 1259]), - ); - expect(choleskySolver.precision, equals(1.0e-10)); - expect(choleskySolver.size, equals(3)); - }, - ); - - test('Making sure that the string conversion works properly.', () { - final solver = CholeskySolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [-6, 15, 55], - [15, 55, 255], - [55, 225, 979], - ], - ), - knownValues: const [76, 295, 1259], - ); - - const toString = '[-6.0, 15.0, 55.0]\n' - '[15.0, 55.0, 255.0]\n' - '[55.0, 225.0, 979.0]'; - const toStringAugmented = '[-6.0, 15.0, 55.0 | 76.0]\n' - '[15.0, 55.0, 255.0 | 295.0]\n' - '[55.0, 225.0, 979.0 | 1259.0]'; - - expect(solver.toString(), equals(toString)); - expect(solver.toStringAugmented(), equals(toStringAugmented)); - }); - - test( - 'Making sure that an exception is thrown when the square root of a ' - 'negative number is found while Cholesky-decomposing the matrix.', - () { - final solver = CholeskySolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [-6, 15, 55], - [15, 55, 255], - [55, 225, 979], - ], - ), - knownValues: const [76, 295, 1259], - ); - - expect(solver.solve, throwsA(isA())); - }, - ); - - test( - 'Making sure that the matrix is square because this method is only ' - "able to solve systems of 'N' equations in 'N' variables.", - () { - expect( - () => CholeskySolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [1, 2, 3], - [4, 5, 6], - ], - ), - knownValues: [7, 8], - ), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that the matrix is square AND the dimension of the ' - 'known values vector also matches the size of the matrix.', - () { - expect( - () => CholeskySolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [7, 8, 9], - ), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly.', () { - final cholesky = CholeskySolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - final cholesky2 = CholeskySolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - final different = CholeskySolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, -2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - expect(cholesky, equals(cholesky2)); - expect(cholesky == cholesky2, isTrue); - expect(cholesky2, equals(cholesky)); - expect(cholesky2 == cholesky, isTrue); - expect(cholesky.hashCode, equals(cholesky2.hashCode)); - expect(cholesky == different, isFalse); - expect(cholesky.hashCode == different.hashCode, isFalse); - }); - - test('Batch tests', () { - final systems = [ - CholeskySolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [25, 15, -5], - [15, 18, 0], - [-5, 0, 11], - ], - ), - knownValues: [35, 33, 6], - ).solve(), - CholeskySolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [4, 12, -16], - [12, 37, -43], - [-16, -43, 98], - ], - ), - knownValues: [9, 1, 0], - ).solve(), - CholeskySolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 1], - [0, 2, 0], - [1, 0, 3], - ], - ), - knownValues: [6, 5, -2], - ).solve(), - ]; - - const solutions = >[ - [1, 1, 1], - [430.6944, -118.2222, 18.4444], - [10, 2.5, -4], - ]; - - for (var i = 0; i < systems.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - systems[i][j], - MoreOrLessEquals(solutions[i][j], precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/system/gauss_seidel_test.dart b/test/system/gauss_seidel_test.dart deleted file mode 100644 index 4fef497f..00000000 --- a/test/system/gauss_seidel_test.dart +++ /dev/null @@ -1,190 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'GaussSeidelSolver' class.", () { - test( - 'Making sure that the sor iterative method works properly with a ' - 'well formed matrix.', - () { - final gaussSeidel = GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ), - knownValues: [-1, 7, -7], - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ); - - // Checking the "state" of the object - expect(gaussSeidel.matrix, equals(matrix)); - expect(gaussSeidel.knownValues, orderedEquals([-1, 7, -7])); - expect(gaussSeidel.maxSteps, equals(30)); - expect(gaussSeidel.precision, equals(1.0e-10)); - expect(gaussSeidel.size, equals(3)); - expect(gaussSeidel.hasSolution(), isTrue); - - // Solutions - expect(gaussSeidel.determinant(), equals(20)); - - final solutions = gaussSeidel.solve(); - expect(solutions.first, const MoreOrLessEquals(1, precision: 1.0e-2)); - expect(solutions[1], const MoreOrLessEquals(2, precision: 1.0e-2)); - expect(solutions[2], const MoreOrLessEquals(-2, precision: 1.0e-2)); - }, - ); - - test('Making sure that the string conversion works properly.', () { - final solver = GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ), - knownValues: const [-1, 7, -7], - ); - - const toString = '[3.0, -1.0, 1.0]\n' - '[-1.0, 3.0, -1.0]\n' - '[1.0, -1.0, 3.0]'; - const toStringAugmented = '[3.0, -1.0, 1.0 | -1.0]\n' - '[-1.0, 3.0, -1.0 | 7.0]\n' - '[1.0, -1.0, 3.0 | -7.0]'; - - expect(solver.toString(), equals(toString)); - expect(solver.toStringAugmented(), equals(toStringAugmented)); - }); - - test( - 'Making sure that the matrix is squared AND the dimension of the ' - 'known values vector also matches the size of the matrix.', - () { - expect( - () => GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 2], - [4, 5], - ], - ), - knownValues: [7, 8, 9], - ), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly.', () { - final gaussSeidel = GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 2], - [4, 5], - ], - ), - knownValues: [0, -6], - ); - - final gaussSeidel2 = GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 2], - [4, 5], - ], - ), - knownValues: [0, -6], - ); - - expect(gaussSeidel, equals(gaussSeidel2)); - expect(gaussSeidel == gaussSeidel2, isTrue); - expect(gaussSeidel2, equals(gaussSeidel)); - expect(gaussSeidel2 == gaussSeidel, isTrue); - expect(gaussSeidel.hashCode, equals(gaussSeidel2.hashCode)); - }); - - test('Batch tests', () { - final systems = [ - GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: [ - [25, 15, -5], - [15, 18, 0], - [-5, 0, 11], - ], - ), - knownValues: [35, 33, 6], - ).solve(), - GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: [ - [1, 0, 1], - [0, 2, 0], - [1, 0, 3], - ], - ), - knownValues: [6, 5, -2], - ).solve(), - GaussSeidelSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: [ - [1, 0, 0], - [0, 1, 0], - [0, 0, 1], - ], - ), - knownValues: [5, -2, 3], - ).solve(), - ]; - - const solutions = >[ - [1, 1, 1], - [10, 2.5, -4], - [5, -2, 3], - ]; - - for (var i = 0; i < systems.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - systems[i][j], - MoreOrLessEquals(solutions[i][j], precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/system/gauss_test.dart b/test/system/gauss_test.dart deleted file mode 100644 index 5ccc4067..00000000 --- a/test/system/gauss_test.dart +++ /dev/null @@ -1,266 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'GaussianElimination' class.", () { - test( - 'Making sure that the gaussian elimination works properly with a ' - 'well formed matrix. Trying with a 3x3 matrix.', - () { - final gauss = GaussianElimination( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 2, -2], - [2, -2, 1], - [1, -1, 2], - ], - ), - knownValues: [-5, -5, -1], - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 2, -2], - [2, -2, 1], - [1, -1, 2], - ], - ); - - // Checking the "state" of the object - expect(gauss.matrix, equals(matrix)); - expect(gauss.knownValues, orderedEquals([-5, -5, -1])); - expect(gauss.precision, equals(1.0e-10)); - expect(gauss.size, equals(3)); - expect(gauss.hasSolution(), isTrue); - - // Solutions - expect(gauss.solve(), unorderedEquals([-3, 0, 1])); - expect(gauss.determinant(), equals(-9)); - }, - ); - - test('Making sure that the string conversion works properly.', () { - final solver = GaussianElimination( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 2, -2], - [2, -2, 1], - [1, -1, 2], - ], - ), - knownValues: const [-1, 7, -7], - ); - - const toString = '[1.0, 2.0, -2.0]\n' - '[2.0, -2.0, 1.0]\n' - '[1.0, -1.0, 2.0]'; - const toStringAugmented = '[1.0, 2.0, -2.0 | -1.0]\n' - '[2.0, -2.0, 1.0 | 7.0]\n' - '[1.0, -1.0, 2.0 | -7.0]'; - - expect(solver.toString(), equals(toString)); - expect(solver.toStringAugmented(), equals(toStringAugmented)); - }); - - test( - 'Making sure that the gaussian elimination works properly with a ' - 'well formed matrix. Trying with a 2x2 matrix.', - () { - final gauss = GaussianElimination( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [3, -2], - [1, -2], - ], - ), - knownValues: [4, -8], - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [3, -2], - [1, -2], - ], - ); - - // Checking the "state" of the object - expect(gauss.matrix, equals(matrix)); - expect(gauss.knownValues, orderedEquals([4, -8])); - expect(gauss.precision, equals(1.0e-10)); - expect(gauss.size, equals(2)); - - // Solutions - expect(gauss.solve(), unorderedEquals([6, 7])); - expect(gauss.determinant(), equals(-4)); - - expect(gauss.knownValues, orderedEquals(const [4, -8])); - }, - ); - - test('Making sure that a singular matrices throw an exception.', () { - final gauss = GaussianElimination( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [-1, -1], - [1, 1], - ], - ), - knownValues: [-1 / 2, 2], - ); - - // Solutions - expect(gauss.determinant(), equals(0)); - expect(gauss.solve, throwsA(isA())); - }); - - test( - 'Making sure that the matrix is squared because this method is only ' - "able to solve systems of 'N' equations in 'N' variables.", - () { - expect( - () => GaussianElimination( - matrix: RealMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [1, 2, 3], - [4, 5, 6], - ], - ), - knownValues: [7, 8], - ), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that the matrix is square AND the dimension of the ' - 'known values vector also matches the size of the matrix.', - () { - expect( - () => GaussianElimination( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [4, 5], - ], - ), - knownValues: [7, 8, 9], - ), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly.', () { - final gauss = GaussianElimination( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - final gauss2 = GaussianElimination( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - expect(gauss, equals(gauss2)); - expect(gauss == gauss2, isTrue); - expect(gauss2, equals(gauss)); - expect(gauss2 == gauss, isTrue); - expect(gauss.hashCode, equals(gauss2.hashCode)); - }); - - test('Batch tests', () { - final systems = [ - GaussianElimination( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [25, 15, -5], - [15, 18, 0], - [-5, 0, 11], - ], - ), - knownValues: [35, 33, 6], - ).solve(), - GaussianElimination( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 1], - [0, 2, 0], - [1, 0, 3], - ], - ), - knownValues: [6, 5, -2], - ).solve(), - GaussianElimination( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 0], - [0, 1, 0], - [0, 0, 1], - ], - ), - knownValues: [5, -2, 3], - ).solve(), - ]; - - const solutions = >[ - [1, 1, 1], - [10, 2.5, -4], - [5, -2, 3], - ]; - - for (var i = 0; i < systems.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - systems[i][j], - MoreOrLessEquals(solutions[i][j], precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/system/jacobi_test.dart b/test/system/jacobi_test.dart deleted file mode 100644 index 7391f5d6..00000000 --- a/test/system/jacobi_test.dart +++ /dev/null @@ -1,221 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'JacobiSolver' class.", () { - test( - 'Making sure that the jacobi iterative method works properly with a ' - 'well formed matrix.', - () { - final jacobi = JacobiSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [2, 1], - [5, 7], - ], - ), - knownValues: [11, 13], - x0: [1, 1], - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [2, 1], - [5, 7], - ], - ); - - // Checking the "state" of the object - expect(jacobi.matrix, equals(matrix)); - expect(jacobi.knownValues, orderedEquals([11, 13])); - expect(jacobi.x0, orderedEquals([1, 1])); - expect(jacobi.maxSteps, equals(30)); - expect(jacobi.precision, equals(1.0e-10)); - expect(jacobi.size, equals(2)); - expect(jacobi.hasSolution(), isTrue); - - // Solutions - expect(jacobi.determinant(), equals(9)); - - final solutions = jacobi.solve(); - expect( - solutions.first, - const MoreOrLessEquals(7.11, precision: 1.0e-2), - ); - expect( - solutions[1], - const MoreOrLessEquals(-3.22, precision: 1.0e-2), - ); - }, - ); - - test('Making sure that the string conversion works properly.', () { - final solver = JacobiSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [2, 1], - [5, 7], - ], - ), - knownValues: [11, 13], - x0: [1, 1], - ); - - const toString = '[2.0, 1.0]\n' - '[5.0, 7.0]'; - const toStringAugmented = '[2.0, 1.0 | 11.0]\n' - '[5.0, 7.0 | 13.0]'; - - expect(solver.toString(), equals(toString)); - expect(solver.toStringAugmented(), equals(toStringAugmented)); - }); - - test( - 'Making sure that the matrix is squared AND the dimension of the ' - 'known values vector also matches the size of the matrix.', - () { - expect( - () => JacobiSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [4, 5], - ], - ), - knownValues: [7, 8, 9], - x0: [1, 2], - ), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that an exception is thrown when the length of the ' - 'initial vector is different from the size of the NxN matrix.', - () { - expect( - () => JacobiSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [4, 5], - ], - ), - knownValues: [7, 8], - x0: [], - ), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly.', () { - final jacobi = JacobiSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - x0: [1, 2], - ); - - final jacobi2 = JacobiSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - x0: [1, 2], - ); - - expect(jacobi, equals(jacobi2)); - expect(jacobi == jacobi2, isTrue); - expect(jacobi2, equals(jacobi)); - expect(jacobi2 == jacobi, isTrue); - expect(jacobi2.hashCode, jacobi.hashCode); - }); - - test('Batch tests', () { - final systems = [ - JacobiSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [25, 15, -5], - [15, 18, 0], - [-5, 0, 11], - ], - ), - knownValues: [35, 33, 6], - x0: [3, 1, -1], - ).solve(), - JacobiSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 1], - [0, 2, 0], - [1, 0, 3], - ], - ), - knownValues: [6, 5, -2], - x0: [0, 0, 0], - ).solve(), - JacobiSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 0], - [0, 1, 0], - [0, 0, 1], - ], - ), - knownValues: [5, -2, 3], - x0: [3, 3, 3], - ).solve(), - ]; - - const solutions = >[ - [1, 1, 1], - [10, 2.5, -4], - [5, -2, 3], - ]; - - for (var i = 0; i < systems.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - systems[i][j].round(), - solutions[i][j].round(), - ); - } - } - }); - }); -} diff --git a/test/system/lu_test.dart b/test/system/lu_test.dart deleted file mode 100644 index 7d730165..00000000 --- a/test/system/lu_test.dart +++ /dev/null @@ -1,206 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'LUSolver' class.", () { - test( - 'Making sure that the LUSolver computes the correct results of a ' - 'system of linear equations.', - () { - final luSolver = LUSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [7, -2, 1], - [14, -7, -3], - [-7, 11, 18], - ], - ), - knownValues: const [12, 17, 5], - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [7, -2, 1], - [14, -7, -3], - [-7, 11, 18], - ], - ); - - // Checking solutions - final results = luSolver.solve(); - expect(results, unorderedEquals([-1, 4, 3])); - - // Checking the "state" of the object - expect(luSolver.matrix, equals(matrix)); - expect(luSolver.knownValues, orderedEquals([12, 17, 5])); - expect(luSolver.precision, equals(1.0e-10)); - expect(luSolver.size, equals(3)); - expect(luSolver.hasSolution(), isTrue); - }, - ); - - test('Making sure that the string conversion works properly.', () { - final solver = LUSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [7, -2, 1], - [14, -7, -3], - [-7, 11, 18], - ], - ), - knownValues: const [12, 17, 5], - ); - - const toString = '[7.0, -2.0, 1.0]\n' - '[14.0, -7.0, -3.0]\n' - '[-7.0, 11.0, 18.0]'; - const toStringAugmented = '[7.0, -2.0, 1.0 | 12.0]\n' - '[14.0, -7.0, -3.0 | 17.0]\n' - '[-7.0, 11.0, 18.0 | 5.0]'; - - expect(solver.toString(), equals(toString)); - expect(solver.toStringAugmented(), equals(toStringAugmented)); - }); - - test('Making sure that objects comparison works properly.', () { - final lu = LUSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - final lu2 = LUSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - ); - - expect(lu, equals(lu2)); - expect(lu == lu2, isTrue); - expect(lu2, equals(lu)); - expect(lu2 == lu, isTrue); - expect(lu.hashCode, equals(lu2.hashCode)); - }); - - test( - 'Making sure that the matrix is squared because this method is only ' - "able to solve systems of 'N' equations in 'N' variables.", - () { - expect( - () => LUSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [1, 2, 0], - [3, 4, -6], - ], - ), - knownValues: const [12, 17], - ), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that the matrix is squared AND the dimension of the ' - 'known values vector also matches the size of the matrix.', - () { - expect( - () => LUSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: const [12, 17, 5], - ), - throwsA(isA()), - ); - }, - ); - - test('Batch tests', () { - final systems = [ - LUSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [25, 15, -5], - [15, 18, 0], - [-5, 0, 11], - ], - ), - knownValues: [35, 33, 6], - ).solve(), - LUSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 1], - [0, 2, 0], - [1, 0, 3], - ], - ), - knownValues: [6, 5, -2], - ).solve(), - LUSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 0, 0], - [0, 1, 0], - [0, 0, 1], - ], - ), - knownValues: [5, -2, 3], - ).solve(), - ]; - - const solutions = >[ - [1, 1, 1], - [10, 2.5, -4], - [5, -2, 3], - ]; - - for (var i = 0; i < systems.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - systems[i][j], - MoreOrLessEquals(solutions[i][j], precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/system/sor_test.dart b/test/system/sor_test.dart deleted file mode 100644 index 576bf611..00000000 --- a/test/system/sor_test.dart +++ /dev/null @@ -1,220 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:test/test.dart'; - -import '../double_approximation_matcher.dart'; - -void main() { - group("Testing the 'SORSolver' class.", () { - test( - 'Making sure that the sor iterative method works properly with a' - ' well formed matrix.', - () { - final sor = SORSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ), - knownValues: [-1, 7, -7], - w: 1.25, - ); - - // This is needed because we want to make sure that the "original" - // matrix doesn't get side effects from the calculations (i.e. row - // swapping). - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ); - - // Checking the "state" of the object - expect(sor.matrix, equals(matrix)); - expect(sor.knownValues, orderedEquals([-1, 7, -7])); - expect(sor.w, equals(1.25)); - expect(sor.maxSteps, equals(30)); - expect(sor.precision, equals(1.0e-10)); - expect(sor.size, equals(3)); - expect(sor.hasSolution(), isTrue); - - // Solutions - expect(sor.determinant(), equals(20)); - - final solutions = sor.solve(); - expect(solutions.first, const MoreOrLessEquals(1, precision: 1.0e-2)); - expect(solutions[1], const MoreOrLessEquals(2, precision: 1.0e-2)); - expect(solutions[2], const MoreOrLessEquals(-2, precision: 1.0e-2)); - }, - ); - - test('Making sure that the string conversion works properly.', () { - final solver = SORSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ), - knownValues: [-1, 7, -7], - w: 1.25, - ); - - const toString = '[3.0, -1.0, 1.0]\n' - '[-1.0, 3.0, -1.0]\n' - '[1.0, -1.0, 3.0]'; - const toStringAugmented = '[3.0, -1.0, 1.0 | -1.0]\n' - '[-1.0, 3.0, -1.0 | 7.0]\n' - '[1.0, -1.0, 3.0 | -7.0]'; - - expect(solver.toString(), equals(toString)); - expect(solver.toStringAugmented(), equals(toStringAugmented)); - }); - - test( - 'Making sure that the matrix is square.', - () { - expect( - () => SORSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [1, 2, 4], - [3, 4, 0], - ], - ), - knownValues: [7, 8, 9], - w: 2, - ), - throwsA(isA()), - ); - }, - ); - - test( - 'Making sure that the matrix is square AND the dimension of the ' - 'known values vector also matches the size of the matrix.', - () { - expect( - () => SORSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [7, 8, 9], - w: 2, - ), - throwsA(isA()), - ); - }, - ); - - test('Making sure that objects comparison works properly.', () { - final sor = SORSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - w: 2, - ); - - final sor2 = SORSolver( - matrix: RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 2], - [3, 4], - ], - ), - knownValues: [0, -6], - w: 2, - ); - - expect(sor, equals(sor2)); - expect(sor == sor2, isTrue); - expect(sor2, equals(sor)); - expect(sor2 == sor, isTrue); - expect(sor.hashCode, equals(sor2.hashCode)); - }); - - test('Batch tests', () { - final systems = [ - SORSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ), - knownValues: [-1, 7, -7], - w: 1.25, - ).solve(), - SORSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [4, -2, 0], - [-2, 6, -5], - [0, -5, 11], - ], - ), - knownValues: [8, -29, 43], - w: 1.2, - ).solve(), - SORSolver( - matrix: RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [3, -1, 1], - [-1, 3, -1], - [1, -1, 3], - ], - ), - knownValues: [-1, 7, -7], - w: 1.65, - ).solve(), - ]; - - const solutions = >[ - [1, 2, -2], - [1, -2, 3], - [1, 2, -2], - ]; - - for (var i = 0; i < systems.length; ++i) { - for (var j = 0; j < 2; ++j) { - expect( - systems[i][j], - MoreOrLessEquals(solutions[i][j], precision: 1.0e-4), - ); - } - } - }); - }); -} diff --git a/test/system/types/cholesky_test.dart b/test/system/types/cholesky_test.dart new file mode 100644 index 00000000..1b8c367f --- /dev/null +++ b/test/system/types/cholesky_test.dart @@ -0,0 +1,310 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('CholeskySolver', () { + test('Smoke test', () { + final choleskySolver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [6, 15, 55], + [15, 55, 255], + [55, 225, 979], + ], + ), + knownValues: const [76, 295, 1259], + ); + + // This is needed because we want to make sure that the "original" + // matrix doesn't get side effects from the calculations (i.e. row + // swapping). + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [6, 15, 55], + [15, 55, 255], + [55, 225, 979], + ], + ); + + final results = choleskySolver.solve(); + + for (final sol in results) { + expect(sol, const MoreOrLessEquals(1, precision: 1.0e-1)); + } + + // Checking the "state" of the object + expect(choleskySolver.matrix, equals(matrix)); + expect(choleskySolver.hasSolution(), isTrue); + expect( + choleskySolver.knownValues, + orderedEquals(const [76, 295, 1259]), + ); + expect(choleskySolver.precision, equals(1.0e-10)); + expect(choleskySolver.size, equals(3)); + }); + + test('String conversion', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [-6, 15, 55], + [15, 55, 255], + [55, 225, 979], + ], + ), + knownValues: const [76, 295, 1259], + ); + + const toString = + '[-6.0, 15.0, 55.0]\n' + '[15.0, 55.0, 255.0]\n' + '[55.0, 225.0, 979.0]'; + const toStringAugmented = + '[-6.0, 15.0, 55.0 | 76.0]\n' + '[15.0, 55.0, 255.0 | 295.0]\n' + '[55.0, 225.0, 979.0 | 1259.0]'; + + expect(solver.toString(), equals(toString)); + expect(solver.toStringAugmented(), equals(toStringAugmented)); + }); + + test('Throws exception if the matrix is not positive definite', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [-6, 15, 55], + [15, 55, 255], + [55, 225, 979], + ], + ), + knownValues: const [76, 295, 1259], + ); + + expect(solver.solve, throwsA(isA())); + }); + + test('Throws exception if the matrix is not square', () { + expect( + () => CholeskySolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 3, + data: const [ + [1, 2, 3], + [4, 5, 6], + ], + ), + knownValues: [7, 8], + ), + throwsA(isA()), + ); + }); + + test('Throws exception if vector and matrix have different sizes', () { + expect( + () => CholeskySolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [7, 8, 9], + ), + throwsA(isA()), + ); + }); + + test('Object comparison', () { + final cholesky = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + final cholesky2 = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + final different = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, -2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + expect(cholesky, equals(cholesky2)); + expect(cholesky == cholesky2, isTrue); + expect(cholesky2, equals(cholesky)); + expect(cholesky2 == cholesky, isTrue); + expect(cholesky.hashCode, equals(cholesky2.hashCode)); + expect(cholesky == different, isFalse); + expect(cholesky.hashCode == different.hashCode, isFalse); + }); + + group('Solver tests', () { + void verifySolutions( + CholeskySolver solver, + List expectedSolutions, + ) { + final solutions = solver.solve(); + for (var i = 0; i < solutions.length; ++i) { + expect( + solutions[i], + MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-1), + ); + } + } + + test('Test 1', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [25, 15, -5], + [15, 18, 0], + [-5, 0, 11], + ], + ), + knownValues: [35, 33, 6], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 2', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 12, -16], + [12, 37, -43], + [-16, -43, 98], + ], + ), + knownValues: [9, 1, 0], + ); + + verifySolutions(solver, [430.6944, -118.2222, 18.4444]); + }); + + test('Test 3', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 1], + [0, 2, 0], + [1, 0, 3], + ], + ), + knownValues: [6, 5, -2], + ); + + verifySolutions(solver, [10, 2.5, -4]); + }); + + test('Test 4', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 2], + [2, 3], + ], + ), + knownValues: [10, 7], + ); + + verifySolutions(solver, [2, 1]); + }); + + test('Test 5', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [9, 3, 0, 0], + [3, 4, 1, 0], + [0, 1, 5, 2], + [0, 0, 2, 6], + ], + ), + knownValues: [12, 8, 8, 8], + ); + + verifySolutions(solver, [1, 1, 1, 1]); + }); + + test('Test 6', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [2.5, 1.0, 0.5], + [1.0, 3.0, 1.5], + [0.5, 1.5, 4.0], + ], + ), + knownValues: [4.0, 5.5, 6.0], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 7', () { + final solver = CholeskySolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 1, 0], + [1, 3, 1], + [0, 1, 2], + ], + ), + knownValues: [-1, 5, 3], + ); + + verifySolutions(solver, [-0.67, 1.67, 0.67]); + }); + }); + }); +} diff --git a/test/system/types/gauss_seidel_test.dart b/test/system/types/gauss_seidel_test.dart new file mode 100644 index 00000000..5a9ee73e --- /dev/null +++ b/test/system/types/gauss_seidel_test.dart @@ -0,0 +1,293 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('GaussSeidelSolver', () { + test('Smoke test', () { + final gaussSeidel = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ), + knownValues: [-1, 7, -7], + ); + + // This is needed because we want to make sure that the "original" + // matrix doesn't get side effects from the calculations (i.e. row + // swapping). + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ); + + expect(gaussSeidel.matrix, equals(matrix)); + expect(gaussSeidel.knownValues, orderedEquals([-1, 7, -7])); + expect(gaussSeidel.maxSteps, equals(30)); + expect(gaussSeidel.precision, equals(1.0e-10)); + expect(gaussSeidel.size, equals(3)); + expect(gaussSeidel.hasSolution(), isTrue); + + expect(gaussSeidel.determinant(), equals(20)); + + final solutions = gaussSeidel.solve(); + expect(solutions.first, const MoreOrLessEquals(1, precision: 1.0e-2)); + expect(solutions[1], const MoreOrLessEquals(2, precision: 1.0e-2)); + expect(solutions[2], const MoreOrLessEquals(-2, precision: 1.0e-2)); + }); + + test('String conversion test', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ), + knownValues: const [-1, 7, -7], + ); + + const toString = + '[3.0, -1.0, 1.0]\n' + '[-1.0, 3.0, -1.0]\n' + '[1.0, -1.0, 3.0]'; + const toStringAugmented = + '[3.0, -1.0, 1.0 | -1.0]\n' + '[-1.0, 3.0, -1.0 | 7.0]\n' + '[1.0, -1.0, 3.0 | -7.0]'; + + expect(solver.toString(), equals(toString)); + expect(solver.toStringAugmented(), equals(toStringAugmented)); + }); + + test('Matrix validation test', () { + expect( + () => GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [4, 5], + ], + ), + knownValues: [7, 8, 9], + ), + throwsA(isA()), + ); + }); + + test('Equality test', () { + final gaussSeidel = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [4, 5], + ], + ), + knownValues: [0, -6], + ); + + final gaussSeidel2 = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [4, 5], + ], + ), + knownValues: [0, -6], + ); + + expect(gaussSeidel, equals(gaussSeidel2)); + expect(gaussSeidel == gaussSeidel2, isTrue); + expect(gaussSeidel2, equals(gaussSeidel)); + expect(gaussSeidel2 == gaussSeidel, isTrue); + expect(gaussSeidel.hashCode, equals(gaussSeidel2.hashCode)); + }); + + group('Solver tests', () { + void verifySolutions( + GaussSeidelSolver solver, + List expectedSolutions, + ) { + final solutions = solver.solve(); + for (var i = 0; i < solutions.length; ++i) { + expect( + solutions[i], + MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-1), + ); + } + } + + test('Test 1', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [25, 15, -5], + [15, 18, 0], + [-5, 0, 11], + ], + ), + knownValues: [35, 33, 6], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 2', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 1], + [0, 2, 0], + [1, 0, 3], + ], + ), + knownValues: [6, 5, -2], + ); + + verifySolutions(solver, [10, 2.5, -4]); + }); + + test('Test 3', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 0], + [0, 1, 0], + [0, 0, 1], + ], + ), + knownValues: [5, -2, 3], + ); + + verifySolutions(solver, [5, -2, 3]); + }); + + test('Test 4', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], + [1, 3], + ], + ), + knownValues: [5, 4], + ); + + verifySolutions(solver, [1, 1]); + }); + + test('Test 5', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, -1, 0], + [-1, 4, -1], + [0, -1, 4], + ], + ), + knownValues: [2, 6, 2], + ); + + verifySolutions(solver, [1, 2, 1]); + }); + + test('Test 6', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [6, 1, 0], + [1, 6, 1], + [0, 1, 6], + ], + ), + knownValues: [7, 8, 7], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 7', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [3, 1], + [1, 3], + ], + ), + knownValues: [-2, -4], + ); + + verifySolutions(solver, [-0.25, -1.25]); + }); + + test('Test 8', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [4, 1, 0, 0], + [1, 4, 1, 0], + [0, 1, 4, 1], + [0, 0, 1, 4], + ], + ), + knownValues: [5, 6, 6, 5], + ); + + verifySolutions(solver, [1, 1, 1, 1]); + }); + + test('Test 9', () { + final solver = GaussSeidelSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 1, 0], + [1, 3, 1], + [0, 1, 2], + ], + ), + knownValues: [-1, 5, 3], + ); + + verifySolutions(solver, [-0.67, 1.67, 0.67]); + }); + }); + }); +} diff --git a/test/system/types/gauss_test.dart b/test/system/types/gauss_test.dart new file mode 100644 index 00000000..a07bca22 --- /dev/null +++ b/test/system/types/gauss_test.dart @@ -0,0 +1,323 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('GaussianElimination', () { + test('Smoke test', () { + final gauss = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 2, -2], + [2, -2, 1], + [1, -1, 2], + ], + ), + knownValues: [-5, -5, -1], + ); + + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 2, -2], + [2, -2, 1], + [1, -1, 2], + ], + ); + + expect(gauss.matrix, equals(matrix)); + expect(gauss.knownValues, orderedEquals([-5, -5, -1])); + expect(gauss.precision, equals(1.0e-10)); + expect(gauss.size, equals(3)); + expect(gauss.hasSolution(), isTrue); + + final solutions = gauss.solve(); + expect(solutions, unorderedEquals([-3, 0, 1])); + expect(gauss.determinant(), equals(-9)); + }); + + test('String conversion test', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 2, -2], + [2, -2, 1], + [1, -1, 2], + ], + ), + knownValues: const [-1, 7, -7], + ); + + const toString = + '[1.0, 2.0, -2.0]\n' + '[2.0, -2.0, 1.0]\n' + '[1.0, -1.0, 2.0]'; + const toStringAugmented = + '[1.0, 2.0, -2.0 | -1.0]\n' + '[2.0, -2.0, 1.0 | 7.0]\n' + '[1.0, -1.0, 2.0 | -7.0]'; + + expect(solver.toString(), equals(toString)); + expect(solver.toStringAugmented(), equals(toStringAugmented)); + }); + + test('Matrix validation test', () { + expect( + () => GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [4, 5], + ], + ), + knownValues: [7, 8, 9], + ), + throwsA(isA()), + ); + }); + + test('Singular matrix test', () { + final gauss = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [-1, -1], + [1, 1], + ], + ), + knownValues: [-1 / 2, 2], + ); + + expect(gauss.determinant(), equals(0)); + expect(gauss.solve, throwsA(isA())); + }); + + test('Matrix validation test', () { + expect( + () => GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [4, 5], + ], + ), + knownValues: [7, 8, 9], + ), + throwsA(isA()), + ); + }); + + test('Equality test', () { + final gauss = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + final gauss2 = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + expect(gauss, equals(gauss2)); + expect(gauss == gauss2, isTrue); + expect(gauss2, equals(gauss)); + expect(gauss2 == gauss, isTrue); + expect(gauss.hashCode, equals(gauss2.hashCode)); + }); + + group('Solver tests', () { + void verifySolutions( + GaussianElimination solver, + List expectedSolutions, + ) { + final solutions = solver.solve(); + + // For Gaussian elimination, solutions might be in any order + expect(solutions.length, equals(expectedSolutions.length)); + for (var i = 0; i < solutions.length; ++i) { + expect( + solutions[i], + MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-1), + ); + } + } + + test('Test 1', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [25, 15, -5], + [15, 18, 0], + [-5, 0, 11], + ], + ), + knownValues: [35, 33, 6], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 2', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 1], + [0, 2, 0], + [1, 0, 3], + ], + ), + knownValues: [6, 5, -2], + ); + + verifySolutions(solver, [10, 2.5, -4]); + }); + + test('Test 3', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 0], + [0, 1, 0], + [0, 0, 1], + ], + ), + knownValues: [5, -2, 3], + ); + + verifySolutions(solver, [5, -2, 3]); + }); + + test('Test 4', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [2, 1], + [1, 2], + ], + ), + knownValues: [5, 4], + ); + + verifySolutions(solver, [2, 1]); + }); + + test('Test 5', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [2, 1, 0], + [1, 2, 1], + [0, 1, 2], + ], + ), + knownValues: [3, 4, 3], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 6', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [3, 1], + [1, 3], + ], + ), + knownValues: [5, 7], + ); + + verifySolutions(solver, [1, 2]); + }); + + test('Test 7', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [1, 0, 0, 0], + [0, 2, 0, 0], + [0, 0, 3, 0], + [0, 0, 0, 4], + ], + ), + knownValues: [1, 4, 9, 16], + ); + + verifySolutions(solver, [1, 2, 3, 4]); + }); + + test('Test 8', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 2, 1], + [2, 5, 2], + [1, 2, 6], + ], + ), + knownValues: [7, 9, 9], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 9', () { + final solver = GaussianElimination( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 1, 0], + [1, 3, 1], + [0, 1, 2], + ], + ), + knownValues: [-1, 5, 3], + ); + + verifySolutions(solver, [-0.67, 1.67, 0.67]); + }); + }); + }); +} diff --git a/test/system/types/jacobi_test.dart b/test/system/types/jacobi_test.dart new file mode 100644 index 00000000..7cbd5164 --- /dev/null +++ b/test/system/types/jacobi_test.dart @@ -0,0 +1,368 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('JacobiSolver', () { + test('Smoke test', () { + final jacobi = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [2, 1], + [5, 7], + ], + ), + knownValues: [11, 13], + x0: [1, 1], + ); + + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [2, 1], + [5, 7], + ], + ); + + expect(jacobi.matrix, equals(matrix)); + expect(jacobi.knownValues, orderedEquals([11, 13])); + expect(jacobi.x0, orderedEquals([1, 1])); + expect(jacobi.maxSteps, equals(30)); + expect(jacobi.precision, equals(1.0e-10)); + expect(jacobi.size, equals(2)); + expect(jacobi.hasSolution(), isTrue); + + expect(jacobi.determinant(), equals(9)); + + final solutions = jacobi.solve(); + expect(solutions.first, const MoreOrLessEquals(7.11, precision: 1.0e-2)); + expect(solutions[1], const MoreOrLessEquals(-3.22, precision: 1.0e-2)); + }); + + test('String conversion test', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [2, 1], + [5, 7], + ], + ), + knownValues: [11, 13], + x0: [1, 1], + ); + + const toString = + '[2.0, 1.0]\n' + '[5.0, 7.0]'; + const toStringAugmented = + '[2.0, 1.0 | 11.0]\n' + '[5.0, 7.0 | 13.0]'; + + expect(solver.toString(), equals(toString)); + expect(solver.toStringAugmented(), equals(toStringAugmented)); + }); + + test('Matrix validation test', () { + expect( + () => JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [4, 5], + ], + ), + knownValues: [7, 8, 9], + x0: [1, 2], + ), + throwsA(isA()), + ); + }); + + test('Initial vector validation test', () { + expect( + () => JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [4, 5], + ], + ), + knownValues: [7, 8], + x0: [], + ), + throwsA(isA()), + ); + }); + + test('Equality test', () { + final jacobi = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + x0: [1, 2], + ); + + final jacobi2 = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + x0: [1, 2], + ); + + expect(jacobi, equals(jacobi2)); + expect(jacobi == jacobi2, isTrue); + expect(jacobi2, equals(jacobi)); + expect(jacobi2 == jacobi, isTrue); + expect(jacobi2.hashCode, jacobi.hashCode); + }); + + test('Diagonal dominance check', () { + final diagonallyDominant = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], // |4| > |1| + [1, 5], // |5| > |1| + ], + ), + knownValues: [7, 8], + x0: [1, 2], + ); + + final notDiagonallyDominant = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], // |1| < |2| + [3, 4], + ], + ), + knownValues: [7, 8], + x0: [1, 2], + ); + + expect(diagonallyDominant.isDiagonallyDominant(), isTrue); + expect(notDiagonallyDominant.isDiagonallyDominant(), isFalse); + }); + + test('Residual norm computation', () { + final jacobi = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], + [1, 3], + ], + ), + knownValues: [5, 4], + x0: [1, 1], + ); + + final solution = jacobi.solve(); + final residualNorm = jacobi.computeResidualNorm(solution); + + expect(residualNorm, lessThan(1e-8)); + }); + + test('Throws exception for zero diagonal elements', () { + expect( + () => JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [0, 1], + [1, 3], + ], + ), + knownValues: [5, 4], + x0: [1, 1], + ), + throwsA(isA()), + ); + }); + + group('Solver tests', () { + void verifySolutions( + JacobiSolver solver, + List expectedSolutions, + ) { + final solutions = solver.solve(); + for (var i = 0; i < solutions.length; ++i) { + expect( + solutions[i], + MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-1), + ); + } + } + + test('Test 1', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [25, 15, -5], + [15, 18, 0], + [-5, 0, 11], + ], + ), + knownValues: [35, 33, 6], + x0: [3, 1, -1], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 2', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 1], + [0, 2, 0], + [1, 0, 3], + ], + ), + knownValues: [6, 5, -2], + x0: [0, 0, 0], + ); + + verifySolutions(solver, [10, 2.5, -4]); + }); + + test('Test 3', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 0], + [0, 1, 0], + [0, 0, 1], + ], + ), + knownValues: [5, -2, 3], + x0: [3, 3, 3], + ); + + verifySolutions(solver, [5, -2, 3]); + }); + + test('Test 4', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], + [1, 3], + ], + ), + knownValues: [5, 4], + x0: [1, 1], + ); + + verifySolutions(solver, [1, 1]); + }); + + test('Test 5', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [5, 1, 0], + [1, 5, 1], + [0, 1, 5], + ], + ), + knownValues: [6, 7, 6], + x0: [0, 0, 0], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 6', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [3, 1], + [1, 3], + ], + ), + knownValues: [5, 7], + x0: [0, 0], + ); + + verifySolutions(solver, [1, 2]); + }); + + test('Test 7', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [6, 1, 0], + [1, 6, 1], + [0, 1, 6], + ], + ), + knownValues: [7, 8, 7], + x0: [0, 0, 0], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 8', () { + final solver = JacobiSolver( + matrix: RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [4, 1, 0, 0], + [1, 4, 1, 0], + [0, 1, 4, 1], + [0, 0, 1, 4], + ], + ), + knownValues: [5, 6, 6, 5], + x0: [0, 0, 0, 0], + ); + + verifySolutions(solver, [1, 1, 1, 1]); + }); + }); + }); +} diff --git a/test/system/types/lu_test.dart b/test/system/types/lu_test.dart new file mode 100644 index 00000000..2d16532f --- /dev/null +++ b/test/system/types/lu_test.dart @@ -0,0 +1,337 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('LUSolver', () { + test('Smoke test', () { + final luSolver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [7, -2, 1], + [14, -7, -3], + [-7, 11, 18], + ], + ), + knownValues: const [12, 17, 5], + ); + + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [7, -2, 1], + [14, -7, -3], + [-7, 11, 18], + ], + ); + + final results = luSolver.solve(); + expect( + results.map((e) => e.roundToDouble()), + unorderedEquals([-1, 4, 3]), + ); + + expect(luSolver.matrix, equals(matrix)); + expect(luSolver.knownValues, orderedEquals([12, 17, 5])); + expect(luSolver.precision, equals(1.0e-10)); + expect(luSolver.size, equals(3)); + expect(luSolver.hasSolution(), isTrue); + }); + + test('String conversion test', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [7, -2, 1], + [14, -7, -3], + [-7, 11, 18], + ], + ), + knownValues: const [12, 17, 5], + ); + + const toString = + '[7.0, -2.0, 1.0]\n' + '[14.0, -7.0, -3.0]\n' + '[-7.0, 11.0, 18.0]'; + const toStringAugmented = + '[7.0, -2.0, 1.0 | 12.0]\n' + '[14.0, -7.0, -3.0 | 17.0]\n' + '[-7.0, 11.0, 18.0 | 5.0]'; + + expect(solver.toString(), equals(toString)); + expect(solver.toStringAugmented(), equals(toStringAugmented)); + }); + + test('Equality test', () { + final lu = LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + final lu2 = LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + ); + + expect(lu, equals(lu2)); + expect(lu == lu2, isTrue); + expect(lu2, equals(lu)); + expect(lu2 == lu, isTrue); + expect(lu.hashCode, equals(lu2.hashCode)); + }); + + test('Matrix validation test', () { + expect( + () => LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 3, + data: const [ + [1, 2, 0], + [3, 4, -6], + ], + ), + knownValues: const [12, 17], + ), + throwsA(isA()), + ); + expect( + () => LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: const [12, 17, 5], + ), + throwsA(isA()), + ); + }); + + test('Singular matrix test', () { + final luSolver = LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [-1, -1], + [1, 1], + ], + ), + knownValues: [-1 / 2, 2], + ); + + // The matrix has determinant = 0, so it should throw an exception + expect(luSolver.determinant(), equals(0)); + expect(luSolver.solve, throwsA(isA())); + }); + + group('Solver tests', () { + void verifySolutions( + LUSolver solver, + List expectedSolutions, + ) { + final solutions = solver.solve(); + for (var i = 0; i < solutions.length; ++i) { + expect( + solutions[i], + MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-1), + ); + } + } + + test('Test 1', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [25, 15, -5], + [15, 18, 0], + [-5, 0, 11], + ], + ), + knownValues: [35, 33, 6], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 2', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 1], + [0, 2, 0], + [1, 0, 3], + ], + ), + knownValues: [6, 5, -2], + ); + + verifySolutions(solver, [10, 2.5, -4]); + }); + + test('Test 3', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 0, 0], + [0, 1, 0], + [0, 0, 1], + ], + ), + knownValues: [5, -2, 3], + ); + + verifySolutions(solver, [5, -2, 3]); + }); + + test('Test 4', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [2, 1], + [1, 2], + ], + ), + knownValues: [5, 4], + ); + + verifySolutions(solver, [2, 1]); + }); + + test('Test 5', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 2, 1], + [2, 5, 2], + [1, 2, 6], + ], + ), + knownValues: [7, 9, 9], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 6', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [3, 1], + [1, 3], + ], + ), + knownValues: [5, 7], + ); + + verifySolutions(solver, [1, 2]); + }); + + test('Test 7', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [1, 0, 0, 0], + [0, 2, 0, 0], + [0, 0, 3, 0], + [0, 0, 0, 4], + ], + ), + knownValues: [1, 4, 9, 16], + ); + + verifySolutions(solver, [1, 2, 3, 4]); + }); + + test('Test 8', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, 1, 0], + [1, 3, 1], + [0, 1, 3], + ], + ), + knownValues: [4, 5, 4], + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 9', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 1, 0], + [1, 3, 1], + [0, 1, 2], + ], + ), + knownValues: [-1, 5, 3], + ); + + verifySolutions(solver, [-0.67, 1.67, 0.67]); + }); + + test('Test 10', () { + final solver = LUSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [0, 2, 1], + [1, 1, 1], + [2, 3, 4], + ], + ), + knownValues: [5, 6, 13], + ); + + verifySolutions(solver, [4, 3, -1]); + }); + }); + }); +} diff --git a/test/system/types/sor_test.dart b/test/system/types/sor_test.dart new file mode 100644 index 00000000..fb705e9a --- /dev/null +++ b/test/system/types/sor_test.dart @@ -0,0 +1,427 @@ +import 'package:equations/equations.dart'; +import 'package:test/test.dart'; + +import '../../double_approximation_matcher.dart'; + +void main() { + group('SORSolver', () { + test('Smoke test', () { + final sor = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ), + knownValues: [-1, 7, -7], + w: 1.25, + ); + + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ); + + expect(sor.matrix, equals(matrix)); + expect(sor.knownValues, orderedEquals([-1, 7, -7])); + expect(sor.w, equals(1.25)); + expect(sor.maxSteps, equals(30)); + expect(sor.precision, equals(1.0e-10)); + expect(sor.size, equals(3)); + expect(sor.hasSolution(), isTrue); + + expect(sor.determinant(), equals(20)); + + final solutions = sor.solve(); + expect(solutions.first, const MoreOrLessEquals(1, precision: 1.0e-2)); + expect(solutions[1], const MoreOrLessEquals(2, precision: 1.0e-2)); + expect(solutions[2], const MoreOrLessEquals(-2, precision: 1.0e-2)); + }); + + test('String conversion test', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ), + knownValues: [-1, 7, -7], + w: 1.25, + ); + + const toString = + '[3.0, -1.0, 1.0]\n' + '[-1.0, 3.0, -1.0]\n' + '[1.0, -1.0, 3.0]'; + const toStringAugmented = + '[3.0, -1.0, 1.0 | -1.0]\n' + '[-1.0, 3.0, -1.0 | 7.0]\n' + '[1.0, -1.0, 3.0 | -7.0]'; + + expect(solver.toString(), equals(toString)); + expect(solver.toStringAugmented(), equals(toStringAugmented)); + }); + + test('Matrix validation test', () { + expect( + () => SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 3, + data: const [ + [1, 2, 4], + [3, 4, 0], + ], + ), + knownValues: [7, 8, 9], + w: 1.5, + ), + throwsA(isA()), + ); + }); + + test('Matrix validation test', () { + expect( + () => SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [7, 8, 9], + w: 1.5, + ), + throwsA(isA()), + ); + }); + + test('Equality test', () { + final sor = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + w: 1, + ); + + final sor2 = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [0, -6], + w: 1, + ); + + expect(sor, equals(sor2)); + expect(sor == sor2, isTrue); + expect(sor2, equals(sor)); + expect(sor2 == sor, isTrue); + expect(sor.hashCode, equals(sor2.hashCode)); + }); + + test('Validation tests', () { + // Test invalid relaxation factor + expect( + () => SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [7, 8], + w: 0, // Invalid: w <= 0 + ), + throwsA(isA()), + ); + + expect( + () => SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ), + knownValues: [7, 8], + w: 2, // Invalid: w >= 2 + ), + throwsA(isA()), + ); + + // Test zero diagonal elements + expect( + () => SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [0, 2], // Zero diagonal element + [3, 4], + ], + ), + knownValues: [7, 8], + w: 1.5, + ), + throwsA(isA()), + ); + }); + + test('Diagonal dominance check', () { + final diagonallyDominant = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], // |4| > |1| + [1, 5], // |5| > |1| + ], + ), + knownValues: [7, 8], + w: 1.5, + ); + + final notDiagonallyDominant = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], // |1| < |2| + [3, 4], + ], + ), + knownValues: [7, 8], + w: 1.5, + ); + + expect(diagonallyDominant.isDiagonallyDominant(), isTrue); + expect(notDiagonallyDominant.isDiagonallyDominant(), isFalse); + }); + + test('Residual norm computation', () { + final sor = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], + [1, 3], + ], + ), + knownValues: [5, 4], + w: 1.5, + ); + + final solution = sor.solve(); + final residualNorm = sor.computeResidualNorm(solution); + + // The residual should be small for a good solution + expect(residualNorm, lessThan(1e-8)); + }); + + group('Solver tests', () { + void verifySolutions( + SORSolver solver, + List expectedSolutions, + ) { + final solutions = solver.solve(); + for (var i = 0; i < solutions.length; ++i) { + expect( + solutions[i], + MoreOrLessEquals(expectedSolutions[i], precision: 1.0e-1), + ); + } + } + + test('Test 1', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ), + knownValues: [-1, 7, -7], + w: 1.25, + ); + + verifySolutions(solver, [1, 2, -2]); + }); + + test('Test 2', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, -2, 0], + [-2, 6, -5], + [0, -5, 11], + ], + ), + knownValues: [8, -29, 43], + w: 1.2, + ); + + verifySolutions(solver, [1, -2, 3]); + }); + + test('Test 3', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [3, -1, 1], + [-1, 3, -1], + [1, -1, 3], + ], + ), + knownValues: [-1, 7, -7], + w: 1.65, + ); + + verifySolutions(solver, [1, 2, -2]); + }); + + test('Test 4', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [4, 1], + [1, 3], + ], + ), + knownValues: [5, 4], + w: 1.5, + ); + + verifySolutions(solver, [1, 1]); + }); + + test('Test 5', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, -1, 0], + [-1, 4, -1], + [0, -1, 4], + ], + ), + knownValues: [2, 6, 2], + w: 1.3, + ); + + verifySolutions(solver, [1, 2, 1]); + }); + + test('Test 6', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [3, 1], + [1, 3], + ], + ), + knownValues: [5, 7], + w: 1.4, + ); + + verifySolutions(solver, [1, 2]); + }); + + test('Test 7', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [5, 1, 0], + [1, 5, 1], + [0, 1, 5], + ], + ), + knownValues: [6, 7, 6], + w: 1.2, + ); + + verifySolutions(solver, [1, 1, 1]); + }); + + test('Test 8', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [4, 1, 0, 0], + [1, 4, 1, 0], + [0, 1, 4, 1], + [0, 0, 1, 4], + ], + ), + knownValues: [5, 6, 6, 5], + w: 1.3, + ); + + verifySolutions(solver, [1, 1, 1, 1]); + }); + + test('Test 9', () { + final solver = SORSolver( + matrix: RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [4, 1, 0], + [1, 3, 1], + [0, 1, 2], + ], + ), + knownValues: [-1, 5, 3], + w: 1.5, + ); + + verifySolutions(solver, [-0.67, 1.67, 0.67]); + }); + }); + }); +} diff --git a/test/system/utils/complex_matrix_test.dart b/test/system/utils/complex_matrix_test.dart index 70f63c28..904ad659 100644 --- a/test/system/utils/complex_matrix_test.dart +++ b/test/system/utils/complex_matrix_test.dart @@ -1,22 +1,20 @@ import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_complex.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_complex.dart'; import 'package:test/test.dart'; import '../../double_approximation_matcher.dart'; void main() { - group("Testing the constructors of the 'ComplexMatrix' class", () { - test('Making sure that a new matrix is initialized with 0s.', () { - final matrix = ComplexMatrix( - columns: 5, - rows: 3, - ); + group('ComplexMatrix', () { + test('Smoke test', () { + final matrix = ComplexMatrix(columns: 5, rows: 3); - // Checking the sizes expect(matrix.rowCount, equals(3)); expect(matrix.columnCount, equals(5)); expect(matrix.isSquareMatrix, isFalse); - // Checking the content of the matrix for (var i = 0; i < matrix.rowCount; ++i) { for (var j = 0; j < matrix.columnCount; ++j) { expect(matrix(i, j), equals(const Complex.zero())); @@ -25,233 +23,194 @@ void main() { } }); - test( - 'Making sure that an exception is thrown when the user tries to ' - 'build a matrix whose row or column count is zero.', - () { - expect( - () => ComplexMatrix( - columns: 0, - rows: 2, - ), - throwsA(isA()), - ); - }, - ); + test('Exception thrown for zero row/column count', () { + expect( + () => ComplexMatrix(columns: 0, rows: 2), + throwsA(isA()), + ); + }); - test( - "Making sure that the matrix can correctly be 'flattened' and converted" - " into a list of 'double' values.", - () { - final matrix = ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex(1, 2), Complex(3, 4)], - [Complex(5, 6), Complex(7, 8)], - ], - ); + test('Matrix flattened to list of double values', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 2), Complex(3, 4)], + [Complex(5, 6), Complex(7, 8)], + ], + ); - // Checking the sizes - final flattenedMatrix = matrix.toList(); + // Checking the sizes + final flattenedMatrix = matrix.toList(); - expect(flattenedMatrix.length, equals(4)); - expect( - flattenedMatrix, - orderedEquals(const [ - Complex(1, 2), - Complex(3, 4), - Complex(5, 6), - Complex(7, 8), - ]), - ); - }, - ); + expect(flattenedMatrix.length, equals(4)); + expect( + flattenedMatrix, + orderedEquals(const [ + Complex(1, 2), + Complex(3, 4), + Complex(5, 6), + Complex(7, 8), + ]), + ); + }); - test( - "Making sure that the matrix can correctly be created from a 'flattened'" - ' list of values.', - () { - final matrix = ComplexMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: const [ - Complex(1, 2), - Complex(3, 4), - Complex(5, 6), - Complex(7, 8), - ], - ); + test('Matrix created from flattened list', () { + final matrix = ComplexMatrix.fromFlattenedData( + rows: 2, + columns: 2, + data: const [ + Complex(1, 2), + Complex(3, 4), + Complex(5, 6), + Complex(7, 8), + ], + ); - expect(matrix.rowCount * matrix.columnCount, equals(4)); - expect( - matrix, - equals( - ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex(1, 2), Complex(3, 4)], - [Complex(5, 6), Complex(7, 8)], - ], - ), + expect(matrix.rowCount * matrix.columnCount, equals(4)); + expect( + matrix, + equals( + ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 2), Complex(3, 4)], + [Complex(5, 6), Complex(7, 8)], + ], ), - ); - }, - ); + ), + ); + }); - test( - 'Making sure that a diagonal, square matrix is correctly build with ' - 'the given value in the diagonal', - () { - final matrix = ComplexMatrix.diagonal( - rows: 3, - columns: 3, - diagonalValue: const Complex(6, 2), - ); + test('Diagonal square matrix built with given value', () { + final matrix = ComplexMatrix.diagonal( + rows: 3, + columns: 3, + diagonalValue: const Complex(6, 2), + ); - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(const Complex(6, 2))); - } else { - expect(matrix(i, j), equals(const Complex.zero())); - } + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(const Complex(6, 2))); + } else { + expect(matrix(i, j), equals(const Complex.zero())); } } + } - const stringRepresentation = '[6 + 2i, 0i, 0i]\n' - '[0i, 6 + 2i, 0i]\n' - '[0i, 0i, 6 + 2i]'; + const stringRepresentation = + '[6 + 2i, 0i, 0i]\n' + '[0i, 6 + 2i, 0i]\n' + '[0i, 0i, 6 + 2i]'; - expect('$matrix', equals(stringRepresentation)); - }, - ); + expect('$matrix', equals(stringRepresentation)); + }); - test( - 'Making sure that a diagonal, non square matrix is correctly build ' - 'with the given value in the diagonal', - () { - final matrix = ComplexMatrix.diagonal( - rows: 3, - columns: 5, - diagonalValue: const Complex(6, 2), - ); + test('Diagonal non-square matrix built with given value', () { + final matrix = ComplexMatrix.diagonal( + rows: 3, + columns: 5, + diagonalValue: const Complex(6, 2), + ); - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(const Complex(6, 2))); - } else { - expect(matrix(i, j), equals(const Complex.zero())); - } + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(const Complex(6, 2))); + } else { + expect(matrix(i, j), equals(const Complex.zero())); } } + } - const stringRepresentation = '[6 + 2i, 0i, 0i, 0i, 0i]\n' - '[0i, 6 + 2i, 0i, 0i, 0i]\n' - '[0i, 0i, 6 + 2i, 0i, 0i]'; + const stringRepresentation = + '[6 + 2i, 0i, 0i, 0i, 0i]\n' + '[0i, 6 + 2i, 0i, 0i, 0i]\n' + '[0i, 0i, 6 + 2i, 0i, 0i]'; - expect('$matrix', equals(stringRepresentation)); - }, - ); + expect('$matrix', equals(stringRepresentation)); + }); - test( - 'Making sure that a diagonal, non square matrix is correctly build ' - 'with the given value in the diagonal', - () { - final matrix = ComplexMatrix.diagonal( - rows: 6, - columns: 2, - diagonalValue: const Complex(6, 2), - ); + test('Diagonal non-square matrix built with given value', () { + final matrix = ComplexMatrix.diagonal( + rows: 6, + columns: 2, + diagonalValue: const Complex(6, 2), + ); - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(const Complex(6, 2))); - } else { - expect(matrix(i, j), equals(const Complex.zero())); - } + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(const Complex(6, 2))); + } else { + expect(matrix(i, j), equals(const Complex.zero())); } } + } - const stringRepresentation = '[6 + 2i, 0i]\n' - '[0i, 6 + 2i]\n' - '[0i, 0i]\n' - '[0i, 0i]\n' - '[0i, 0i]\n' - '[0i, 0i]'; + const stringRepresentation = + '[6 + 2i, 0i]\n' + '[0i, 6 + 2i]\n' + '[0i, 0i]\n' + '[0i, 0i]\n' + '[0i, 0i]\n' + '[0i, 0i]'; - expect('$matrix', equals(stringRepresentation)); - }, - ); + expect('$matrix', equals(stringRepresentation)); + }); - test( - 'Making sure that a diagonal of a single element is correctly built', - () { - final matrix = RealMatrix.diagonal( - rows: 1, - columns: 1, - diagonalValue: 31, - ); + test('Single element diagonal', () { + final matrix = RealMatrix.diagonal( + rows: 1, + columns: 1, + diagonalValue: 31, + ); - expect(matrix(0, 0), equals(31)); - expect('$matrix', equals('[31.0]')); - }, - ); + expect(matrix(0, 0), equals(31)); + expect('$matrix', equals('[31.0]')); + }); - test( - 'Making sure that an exception is thrown when the matrix is being built ' - 'from a list but the sizes are wrong', - () { - expect( - () => ComplexMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: const [Complex(1, 2), Complex(1, 1)], - ), - throwsA(isA()), - ); - }, - ); + test('Exception thrown for wrong list sizes', () { + expect( + () => ComplexMatrix.fromFlattenedData( + rows: 2, + columns: 2, + data: const [Complex(1, 2), Complex(1, 1)], + ), + throwsA(isA()), + ); + }); - test( - 'Making sure that the identity matrix is filled with 0s except for ' - 'its diagonal, which must contain all 1s.', - () { - final matrix = ComplexMatrix(columns: 3, rows: 3, identity: true); + test('Identity matrix filled with zeros except diagonal ones', () { + final matrix = ComplexMatrix(columns: 3, rows: 3, identity: true); - // Checking the sizes - expect(matrix.rowCount, equals(3)); - expect(matrix.columnCount, equals(3)); + // Checking the sizes + expect(matrix.rowCount, equals(3)); + expect(matrix.columnCount, equals(3)); - // Checking the content of the matrix - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(const Complex(1, 0))); - } else { - expect(matrix(i, j), equals(const Complex.zero())); - } - expect(matrix(i, j), equals(matrix.itemAt(i, j))); + // Checking the content of the matrix + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(const Complex(1, 0))); + } else { + expect(matrix(i, j), equals(const Complex.zero())); } + expect(matrix(i, j), equals(matrix.itemAt(i, j))); } - }, - ); + } + }); - test( - 'Making sure that an exception is thrown when the user tries to ' - 'build an identity matrix with a non-squared entry.', - () { - expect( - () => ComplexMatrix(columns: 3, rows: 5, identity: true), - throwsA(isA()), - ); - }, - ); + test('Exception thrown for non-square identity matrix', () { + expect( + () => ComplexMatrix(columns: 3, rows: 5, identity: true), + throwsA(isA()), + ); + }); - test("Making sure that 'toString()' works as expected.", () { + test('toString() works as expected', () { final matrix = ComplexMatrix.fromData( columns: 2, rows: 2, @@ -265,70 +224,61 @@ void main() { expect(matrix.toString(), equals(expected)); }); - test( - 'Making sure that a matrix is properly built from a list of lists ' - 'entries.', - () { - final matrix = ComplexMatrix.fromData( - columns: 2, - rows: 2, - data: const [ - [Complex(1, 2), Complex(3, 4)], - [Complex(5, 6), Complex(7, 8)], - ], - ); - - // Checking the sizes - expect(matrix.rowCount, equals(2)); - expect(matrix.columnCount, equals(2)); - - // Checking the content of the matrix - expect(matrix(0, 0), equals(const Complex(1, 2))); - expect(matrix(0, 1), equals(const Complex(3, 4))); - expect(matrix(1, 0), equals(const Complex(5, 6))); - expect(matrix(1, 1), equals(const Complex(7, 8))); - }, - ); - }); - - group("Testing equality of 'ComplexMatrix' objects", () { - test('Making sure that objects comparison works properly.', () { - final matrix = ComplexMatrix( + test('Matrix built from list of lists', () { + final matrix = ComplexMatrix.fromData( columns: 2, rows: 2, + data: const [ + [Complex(1, 2), Complex(3, 4)], + [Complex(5, 6), Complex(7, 8)], + ], ); - // Equality tests - expect(ComplexMatrix(columns: 2, rows: 2), equals(matrix)); - expect(matrix, equals(ComplexMatrix(columns: 2, rows: 2))); - expect(ComplexMatrix(columns: 2, rows: 2) == matrix, isTrue); - expect(matrix == ComplexMatrix(columns: 2, rows: 2), isTrue); - expect( - ComplexMatrix(columns: 2, rows: 2).hashCode, - equals(matrix.hashCode), - ); + // Checking the sizes + expect(matrix.rowCount, equals(2)); + expect(matrix.columnCount, equals(2)); - // Inequality tests - expect( - ComplexMatrix(columns: 2, rows: 2, identity: true) == matrix, - isFalse, - ); - expect( - ComplexMatrix(columns: 2, rows: 1).hashCode == matrix.hashCode, - isFalse, - ); - expect( - matrix == ComplexMatrix(columns: 2, rows: 2, identity: true), - isFalse, - ); - expect( - ComplexMatrix(columns: 2, rows: 1).hashCode == matrix.hashCode, - isFalse, - ); + // Checking the content of the matrix + expect(matrix(0, 0), equals(const Complex(1, 2))); + expect(matrix(0, 1), equals(const Complex(3, 4))); + expect(matrix(1, 0), equals(const Complex(5, 6))); + expect(matrix(1, 1), equals(const Complex(7, 8))); }); }); - group('Testing operation on matrices (+, *, - and /)', () { + test('Equality test', () { + final matrix = ComplexMatrix(columns: 2, rows: 2); + + // Equality tests + expect(ComplexMatrix(columns: 2, rows: 2), equals(matrix)); + expect(matrix, equals(ComplexMatrix(columns: 2, rows: 2))); + expect(ComplexMatrix(columns: 2, rows: 2) == matrix, isTrue); + expect(matrix == ComplexMatrix(columns: 2, rows: 2), isTrue); + expect( + ComplexMatrix(columns: 2, rows: 2).hashCode, + equals(matrix.hashCode), + ); + + // Inequality tests + expect( + ComplexMatrix(columns: 2, rows: 2, identity: true) == matrix, + isFalse, + ); + expect( + ComplexMatrix(columns: 2, rows: 1).hashCode == matrix.hashCode, + isFalse, + ); + expect( + matrix == ComplexMatrix(columns: 2, rows: 2, identity: true), + isFalse, + ); + expect( + ComplexMatrix(columns: 2, rows: 1).hashCode == matrix.hashCode, + isFalse, + ); + }); + + group('Operators', () { /* * A = | i 3-8i | * | 4+7i 0 | @@ -355,7 +305,7 @@ void main() { ], ); - test('Making sure that operator+ works properly.', () { + test('operator+', () { final matrixSum = ComplexMatrix.fromData( columns: 2, rows: 2, @@ -367,7 +317,7 @@ void main() { expect(matrixA + matrixB, equals(matrixSum)); }); - test('Making sure that operator+ works on rectangular matrices too.', () { + test('operator+ on rectangular matrices', () { final matrixA = ComplexMatrix.fromData( columns: 2, rows: 3, @@ -404,7 +354,7 @@ void main() { ); }); - test('Making sure that operator- works properly.', () { + test('operator-', () { final matrixSub = ComplexMatrix.fromData( columns: 2, rows: 2, @@ -416,7 +366,7 @@ void main() { expect(matrixA - matrixB, equals(matrixSub)); }); - test('Making sure that operator- works on rectangular matrices too.', () { + test('operator- on rectangular matrices', () { final matrixA = ComplexMatrix.fromData( columns: 2, rows: 3, @@ -453,7 +403,7 @@ void main() { ); }); - test('Making sure that operator* works properly.', () { + test('operator*', () { final matrixProd = ComplexMatrix.fromData( columns: 2, rows: 2, @@ -465,7 +415,7 @@ void main() { expect(matrixA * matrixB, equals(matrixProd)); }); - test('Making sure that operator* works on rectangular matrices too.', () { + test('operator* on rectangular matrices', () { final matrixA = ComplexMatrix.fromData( columns: 2, rows: 2, @@ -496,14 +446,12 @@ void main() { expect(matrixA * matrixB, equals(matrixMul)); }); - test('Making sure that operator/ works properly.', () { + test('operator/', () { final divResult = matrixA / matrixB; - // Comparing members one by one due to machine precision issues expect(divResult(0, 0), equals(const Complex(0, 1 / 5))); expect(divResult(1, 1), equals(const Complex.zero())); - // Value at [1, 0] expect( divResult(1, 0).real, const MoreOrLessEquals(7 / 6, precision: 1.0e-3), @@ -513,7 +461,6 @@ void main() { const MoreOrLessEquals(-2 / 3, precision: 1.0e-3), ); - // Value at [0, 1] expect( divResult(0, 1).real, const MoreOrLessEquals(-29 / 50, precision: 1.0e-3), @@ -524,7 +471,7 @@ void main() { ); }); - test('Making sure that operator/ works on rectangular matrices too.', () { + test('operator/ on rectangular matrices', () { final matrixA = ComplexMatrix.fromData( columns: 2, rows: 3, @@ -562,7 +509,7 @@ void main() { }); test( - 'operator+, operator- and operator/ on matrices of different sizes fails', + 'operator+, operator- and operator/ on different sized matrices', () { final otherMatrix = ComplexMatrix.fromFlattenedData( rows: 1, @@ -570,42 +517,27 @@ void main() { data: const [Complex.i()], ); - expect( - () => matrixA + otherMatrix, - throwsA(isA()), - ); + expect(() => matrixA + otherMatrix, throwsA(isA())); - expect( - () => matrixA - otherMatrix, - throwsA(isA()), - ); + expect(() => matrixA - otherMatrix, throwsA(isA())); - expect( - () => matrixA / otherMatrix, - throwsA(isA()), - ); + expect(() => matrixA / otherMatrix, throwsA(isA())); }, ); - test( - 'operator* fails if rows and columns have no matching sizes', - () { - final otherMatrix = ComplexMatrix.fromFlattenedData( - rows: 1, - columns: 2, - data: const [Complex.i(), Complex(2, 1)], - ); + test('operator* fails on non-matching sizes', () { + final otherMatrix = ComplexMatrix.fromFlattenedData( + rows: 1, + columns: 2, + data: const [Complex.i(), Complex(2, 1)], + ); - expect( - () => matrixA * otherMatrix, - throwsA(isA()), - ); - }, - ); + expect(() => matrixA * otherMatrix, throwsA(isA())); + }); }); - group('Testing the computation of the determinant.', () { - test('Making sure that the determinant of an 1*1 matrix is correct.', () { + group('Determinant', () { + test('Determinant of 1x1 matrix', () { final matrix = ComplexMatrix.fromData( columns: 1, rows: 1, @@ -616,7 +548,7 @@ void main() { expect(matrix.determinant(), equals(const Complex(4, 7))); }); - test('Making sure that the determinant of a 2*2 matrix is correct.', () { + test('Determinant of 2x2 matrix', () { final matrix = ComplexMatrix.fromData( columns: 2, rows: 2, @@ -628,7 +560,7 @@ void main() { expect(matrix.determinant(), equals(const Complex(-1265, -3075))); }); - test('Making sure that the determinant of a 3*3 matrix is correct.', () { + test('Determinant of 3x3 matrix', () { final matrix = ComplexMatrix.fromData( columns: 3, rows: 3, @@ -641,7 +573,7 @@ void main() { expect(matrix.determinant(), equals(const Complex(-602, -463))); }); - test('Making sure that the determinant of a 4*4 matrix is correct.', () { + test('Determinant of 4x4 matrix', () { final matrix = ComplexMatrix.fromData( columns: 4, rows: 4, @@ -655,7 +587,7 @@ void main() { expect(matrix.determinant(), equals(const Complex(-5444, -802))); }); - test('Making sure that the determinant of a 5*5 matrix is correct.', () { + test('Determinant of 5x5 matrix', () { final matrix = ComplexMatrix.fromData( columns: 5, rows: 5, @@ -705,173 +637,248 @@ void main() { }); }); - group('Testing operations on matrices.', () { - test( - 'Making sure that the LU decomposition properly works on a square ' - 'matrix of a given dimension.', - () { - final matrix = ComplexMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [Complex.fromReal(1), Complex.fromReal(2), Complex.fromReal(3)], - [Complex.fromReal(4), Complex.fromReal(5), Complex.fromReal(6)], - [Complex.fromReal(7), Complex.fromReal(8), Complex.fromReal(9)], - ], - ); + group('API', () { + test('LU decomposition on square matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2), Complex.fromReal(3)], + [Complex.fromReal(4), Complex.fromReal(5), Complex.fromReal(6)], + [Complex.fromReal(7), Complex.fromReal(8), Complex.fromReal(9)], + ], + ); - // Decomposition - final lu = matrix.luDecomposition(); - expect(lu.length, equals(2)); - - // Checking L - final L = lu.first; - expect(L.rowCount, equals(matrix.rowCount)); - expect(L.columnCount, equals(matrix.columnCount)); - expect(L.isSquareMatrix, isTrue); - expect( - L.flattenData, - orderedEquals( - const [ - Complex.fromReal(1), - Complex.zero(), - Complex.zero(), - Complex.fromReal(4), - Complex.fromReal(1), - Complex.zero(), - Complex.fromReal(7), - Complex.fromReal(2), - Complex.fromReal(1), - ], - ), - ); + // Decomposition + final lu = matrix.luDecomposition(); + expect(lu.length, equals(2)); - // Checking U - final U = lu[1]; - expect(U.rowCount, equals(matrix.rowCount)); - expect(U.columnCount, equals(matrix.columnCount)); - expect(U.isSquareMatrix, isTrue); - expect( - U.flattenData, - orderedEquals( - const [ - Complex.fromReal(1), - Complex.fromReal(2), - Complex.fromReal(3), - Complex.zero(), - Complex.fromReal(-3), - Complex.fromReal(-6), - Complex.zero(), - Complex.zero(), - Complex.zero(), - ], - ), - ); - }, - ); + // Checking L + final L = lu.first; + expect(L.rowCount, equals(matrix.rowCount)); + expect(L.columnCount, equals(matrix.columnCount)); + expect(L.isSquareMatrix, isTrue); + expect( + L.flattenData, + orderedEquals(const [ + Complex.fromReal(1), + Complex.zero(), + Complex.zero(), + Complex.fromReal(4), + Complex.fromReal(1), + Complex.zero(), + Complex.fromReal(7), + Complex.fromReal(2), + Complex.fromReal(1), + ]), + ); + + // Checking U + final U = lu[1]; + expect(U.rowCount, equals(matrix.rowCount)); + expect(U.columnCount, equals(matrix.columnCount)); + expect(U.isSquareMatrix, isTrue); + expect( + U.flattenData, + orderedEquals(const [ + Complex.fromReal(1), + Complex.fromReal(2), + Complex.fromReal(3), + Complex.zero(), + Complex.fromReal(-3), + Complex.fromReal(-6), + Complex.zero(), + Complex.zero(), + Complex.zero(), + ]), + ); + }); - test( - "Making sure that the LU decomposition properly doesn't work when " - 'the matrix is not square.', - () { - final matrix = ComplexMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [Complex.fromReal(1), Complex.fromReal(2), Complex.fromReal(3)], - [Complex.fromReal(4), Complex.fromReal(5), Complex.fromReal(6)], - ], - ); + test('LU decomposition fails on non-square matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 3, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2), Complex.fromReal(3)], + [Complex.fromReal(4), Complex.fromReal(5), Complex.fromReal(6)], + ], + ); - // Decomposition - expect(matrix.luDecomposition, throwsA(isA())); - }, - ); + // Decomposition + expect(matrix.luDecomposition, throwsA(isA())); + }); + + test('Cholesky decomposition on square matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [Complex.fromReal(25), Complex.fromReal(15), Complex.fromReal(-5)], + [Complex.fromReal(15), Complex.fromReal(18), Complex.fromReal(0)], + [Complex.fromReal(-5), Complex.fromReal(0), Complex.fromReal(11)], + ], + ); + + // Decomposition + final cholesky = matrix.choleskyDecomposition(); + expect(cholesky.length, equals(2)); + + // Checking L + final L = cholesky.first; + expect( + L.flattenData, + orderedEquals(const [ + Complex.fromReal(5), + Complex.zero(), + Complex.zero(), + Complex.fromReal(3), + Complex.fromReal(3), + Complex.zero(), + Complex.fromReal(-1), + Complex.fromReal(1), + Complex.fromReal(3), + ]), + ); + expect(L.rowCount, equals(matrix.rowCount)); + expect(L.columnCount, equals(matrix.columnCount)); + expect(L.isSquareMatrix, isTrue); + + // Checking Lt + final transposedL = cholesky[1]; + expect( + transposedL.flattenData, + orderedEquals(const [ + Complex.fromReal(5), + Complex.fromReal(3), + Complex.fromReal(-1), + Complex.zero(), + Complex.fromReal(3), + Complex.fromReal(1), + Complex.zero(), + Complex.zero(), + Complex.fromReal(3), + ]), + ); + expect(transposedL.rowCount, equals(matrix.rowCount)); + expect(transposedL.columnCount, equals(matrix.columnCount)); + expect(transposedL.isSquareMatrix, isTrue); + }); + + test('Cholesky decomposition fails on non-square matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 2, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2)], + [Complex.fromReal(3), Complex.fromReal(4)], + [Complex.fromReal(5), Complex.fromReal(6)], + ], + ); + + // Decomposition + expect(matrix.choleskyDecomposition, throwsA(isA())); + }); test( - 'Making sure that Cholesky decomposition properly works on a square ' - 'matrix of a given dimension.', + 'Cholesky decomposition on large matrix to trigger block processing', () { + final data = >[]; + for (var i = 0; i < 40; i++) { + final row = []; + for (var j = 0; j < 40; j++) { + if (i == j) { + row.add(Complex.fromReal(40.0 + i)); + } else { + row.add(const Complex.fromReal(0.1)); + } + } + data.add(row); + } + final matrix = ComplexMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [Complex.fromReal(25), Complex.fromReal(15), Complex.fromReal(-5)], - [Complex.fromReal(15), Complex.fromReal(18), Complex.fromReal(0)], - [Complex.fromReal(-5), Complex.fromReal(0), Complex.fromReal(11)], - ], + rows: 40, + columns: 40, + data: data, ); - // Decomposition final cholesky = matrix.choleskyDecomposition(); expect(cholesky.length, equals(2)); - // Checking L - final L = cholesky.first; - expect( - L.flattenData, - orderedEquals( - const [ - Complex.fromReal(5), - Complex.zero(), - Complex.zero(), - Complex.fromReal(3), - Complex.fromReal(3), - Complex.zero(), - Complex.fromReal(-1), - Complex.fromReal(1), - Complex.fromReal(3), - ], - ), - ); - expect(L.rowCount, equals(matrix.rowCount)); - expect(L.columnCount, equals(matrix.columnCount)); - expect(L.isSquareMatrix, isTrue); - - // Checking Lt - final transposedL = cholesky[1]; - expect( - transposedL.flattenData, - orderedEquals( - const [ - Complex.fromReal(5), - Complex.fromReal(3), - Complex.fromReal(-1), - Complex.zero(), - Complex.fromReal(3), - Complex.fromReal(1), - Complex.zero(), - Complex.zero(), - Complex.fromReal(3), - ], - ), - ); - expect(transposedL.rowCount, equals(matrix.rowCount)); - expect(transposedL.columnCount, equals(matrix.columnCount)); - expect(transposedL.isSquareMatrix, isTrue); + // Verify L * L^T = original matrix + final L = cholesky[0]; + final lt = cholesky[1]; + final reconstructed = L * lt; + + for (var i = 0; i < 40; i++) { + for (var j = 0; j < 40; j++) { + expect( + reconstructed(i, j).real, + MoreOrLessEquals(matrix(i, j).real, precision: 1.0e-5), + ); + expect( + reconstructed(i, j).imaginary, + MoreOrLessEquals(matrix(i, j).imaginary, precision: 1.0e-5), + ); + } + } }, ); - test( - "Making sure that the Cholesky decomposition properly doesn't work " - 'when the matrix is not square.', - () { - final matrix = ComplexMatrix.fromData( - rows: 3, - columns: 2, - data: const [ - [Complex.fromReal(1), Complex.fromReal(2)], - [Complex.fromReal(3), Complex.fromReal(4)], - [Complex.fromReal(5), Complex.fromReal(6)], - ], - ); + test('qrDecomposition', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2)], + [Complex.fromReal(3), Complex.fromReal(4)], + ], + ); - // Decomposition - expect(matrix.choleskyDecomposition, throwsA(isA())); - }, - ); + expect( + matrix.qrDecomposition(), + orderedEquals( + QRDecompositionComplex(matrix: matrix).decompose(), + ), + ); + }); + + test('svdDecomposition', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2)], + [Complex.fromReal(3), Complex.fromReal(4)], + ], + ); + + expect( + matrix.singleValueDecomposition(), + orderedEquals( + SVDComplex(matrix: matrix).decompose(), + ), + ); + }); + + test('eigenDecomposition', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2)], + [Complex.fromReal(3), Complex.fromReal(4)], + ], + ); + + expect( + matrix.eigenDecomposition(), + orderedEquals( + EigendecompositionComplex(matrix: matrix).decompose(), + ), + ); + }); - test('Making sure that the transposed view is correct', () { + test('transposedValue', () { final matrix = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -887,7 +894,42 @@ void main() { expect(matrix.transposedValue(1, 1), equals(const Complex.fromReal(4))); }); - test('Making sure that the transposed matrix is correct (2x2)', () { + test('Zero matrix multiplication optimization', () { + final zeroMatrix1 = ComplexMatrix(rows: 2, columns: 3); + final zeroMatrix2 = ComplexMatrix(rows: 3, columns: 2); + final result = zeroMatrix1 * zeroMatrix2; + + expect(result.rowCount, equals(2)); + expect(result.columnCount, equals(2)); + expect(result.isZero(), isTrue); + + // Test with one zero matrix (first operand is zero) + final nonZeroMatrix = ComplexMatrix.fromData( + rows: 3, + columns: 2, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2)], + [Complex.fromReal(3), Complex.fromReal(4)], + [Complex.fromReal(5), Complex.fromReal(6)], + ], + ); + final result2 = zeroMatrix1 * nonZeroMatrix; + expect(result2.isZero(), isTrue); + + // Test with one zero matrix (second operand is zero) + final nonZeroMatrix2 = ComplexMatrix.fromData( + rows: 2, + columns: 3, + data: const [ + [Complex.fromReal(1), Complex.fromReal(2), Complex.fromReal(3)], + [Complex.fromReal(4), Complex.fromReal(5), Complex.fromReal(6)], + ], + ); + final result3 = nonZeroMatrix2 * zeroMatrix2; + expect(result3.isZero(), isTrue); + }); + + test('Transposed matrix is correct (2x2)', () { final matrix = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -905,7 +947,7 @@ void main() { expect(transposed(1, 1), equals(const Complex.fromReal(4))); }); - test('Making sure that the transposed matrix is correct (1x3)', () { + test('Transposed matrix is correct (1x3)', () { final matrix = ComplexMatrix.fromData( rows: 1, columns: 3, @@ -920,7 +962,7 @@ void main() { expect(transposed(2, 0), equals(const Complex.zero())); }); - test('Making sure that minors are correctly generated', () { + test('Minors correctly generated', () { final matrix = ComplexMatrix.fromData( rows: 3, columns: 3, @@ -935,42 +977,32 @@ void main() { final minor1 = matrix.minor(0, 0); expect( minor1.flattenData, - orderedEquals( - const [ - Complex.i(), - Complex.zero(), - Complex.fromReal(6), - Complex(-3, 7), - ], - ), + orderedEquals(const [ + Complex.i(), + Complex.zero(), + Complex.fromReal(6), + Complex(-3, 7), + ]), ); // Removing (1; 2) final minor2 = matrix.minor(1, 2); expect( minor2.flattenData, - orderedEquals( - const [ - Complex(4, -5), - Complex(-1, 10), - Complex(2, 1), - Complex.fromReal(6), - ], - ), + orderedEquals(const [ + Complex(4, -5), + Complex(-1, 10), + Complex(2, 1), + Complex.fromReal(6), + ]), ); // Errors - expect( - () => matrix.minor(-1, 2), - throwsA(isA()), - ); - expect( - () => matrix.minor(11, 2), - throwsA(isA()), - ); + expect(() => matrix.minor(-1, 2), throwsA(isA())); + expect(() => matrix.minor(11, 2), throwsA(isA())); }); - test('Making sure that the cofactor matrix is correctly computed', () { + test('cofactorMatrix', () { final matrixSize2 = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -1014,41 +1046,33 @@ void main() { expect(matrixSize3.cofactorMatrix(), equals(cofactorMatrixSize3)); }); - test( - 'Making sure that the cofactor matrix is NOT computed if the source ' - 'matrix is NOT square', - () { - final matrix = ComplexMatrix.fromData( - rows: 2, - columns: 1, - data: const [ - [Complex.i()], - [Complex.fromImaginary(3)], - ], - ); + test('Cofactor matrix not computed for non-square matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 1, + data: const [ + [Complex.i()], + [Complex.fromImaginary(3)], + ], + ); - expect(matrix.cofactorMatrix, throwsA(isA())); - }, - ); + expect(matrix.cofactorMatrix, throwsA(isA())); + }); - test( - 'Making sure that the inverse matrix is NOT computed if the source ' - 'matrix is NOT square', - () { - final matrix = ComplexMatrix.fromData( - rows: 2, - columns: 1, - data: const [ - [Complex.i()], - [Complex.fromImaginary(3)], - ], - ); + test('Inverse matrix not computed for non-square matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 1, + data: const [ + [Complex.i()], + [Complex.fromImaginary(3)], + ], + ); - expect(matrix.inverse, throwsA(isA())); - }, - ); + expect(matrix.inverse, throwsA(isA())); + }); - test('Making sure that the inverse of a 2x2 matrix is correct', () { + test('inverse of 2x2 matrix', () { final matrix = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -1092,7 +1116,7 @@ void main() { ); }); - test('Making sure that the inverse of a matrix is correct', () { + test('inverse', () { final matrix = ComplexMatrix.fromData( rows: 3, columns: 3, @@ -1107,77 +1131,50 @@ void main() { matrix(0, 0).real, const MoreOrLessEquals(0.159091, precision: 1.0e-6), ); - expect( - matrix(0, 0).imaginary, - isZero, - ); + expect(matrix(0, 0).imaginary, isZero); expect( matrix(0, 1).real, const MoreOrLessEquals(-0.068181, precision: 1.0e-6), ); - expect( - matrix(0, 1).imaginary, - isZero, - ); + expect(matrix(0, 1).imaginary, isZero); expect( matrix(0, 2).real, const MoreOrLessEquals(0.159091, precision: 1.0e-6), ); - expect( - matrix(0, 2).imaginary, - isZero, - ); + expect(matrix(0, 2).imaginary, isZero); expect( matrix(1, 0).real, const MoreOrLessEquals(-0.681818, precision: 1.0e-6), ); - expect( - matrix(1, 0).imaginary, - isZero, - ); + expect(matrix(1, 0).imaginary, isZero); expect( matrix(1, 1).real, const MoreOrLessEquals(-0.136364, precision: 1.0e-6), ); - expect( - matrix(1, 1).imaginary, - isZero, - ); + expect(matrix(1, 1).imaginary, isZero); expect( matrix(1, 2).real, const MoreOrLessEquals(0.318182, precision: 1.0e-6), ); - expect( - matrix(1, 2).imaginary, - isZero, - ); + expect(matrix(1, 2).imaginary, isZero); expect( matrix(2, 0).real, const MoreOrLessEquals(-0.090909, precision: 1.0e-6), ); - expect( - matrix(2, 0).imaginary, - isZero, - ); + expect(matrix(2, 0).imaginary, isZero); expect( matrix(2, 1).real, const MoreOrLessEquals(0.181818, precision: 1.0e-6), ); - expect( - matrix(2, 1).imaginary, - isZero, - ); + expect(matrix(2, 1).imaginary, isZero); expect( matrix(2, 2).real, const MoreOrLessEquals(-0.090909, precision: 1.0e-6), ); - expect( - matrix(2, 2).imaginary, - isZero, - ); + expect(matrix(2, 2).imaginary, isZero); }); - test('Making sure that the trace is correctly computed', () { + test('trace', () { final matrix = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -1190,7 +1187,7 @@ void main() { expect(matrix.trace(), equals(const Complex(2, -5))); }); - test('Making sure that symmetric matrices are correctly identified.', () { + test('isSymmetric', () { final symmetric = ComplexMatrix.fromData( rows: 3, columns: 3, @@ -1216,7 +1213,7 @@ void main() { expect(notSymmetric.isSymmetric(), isFalse); }); - test('Making sure that diagonal matrices are correctly identified.', () { + test('isDiagonal', () { final diagonal = ComplexMatrix.fromData( rows: 3, columns: 3, @@ -1253,7 +1250,7 @@ void main() { expect(notDiagonal.isDiagonal(), isFalse); }); - test('Making sure that identity matrices are correctly identified.', () { + test('isIdentity', () { final diagonal = ComplexMatrix.fromData( rows: 3, columns: 3, @@ -1281,7 +1278,7 @@ void main() { expect(notDiagonal.isIdentity(), isFalse); }); - test('Making sure that identity matrix is only computed when square.', () { + test('Identity matrix only computed when square', () { final identity = ComplexMatrix.fromData( rows: 2, columns: 3, @@ -1294,7 +1291,7 @@ void main() { expect(identity.isIdentity, throwsA(isA())); }); - test('Making sure that the rank can correctly be computed.', () { + test('rank', () { final rank = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -1350,7 +1347,7 @@ void main() { expect(rectangularRank2.rank(), equals(1)); }); - test('Making sure that the trace only computed on square matrices', () { + test('trace only computed on square matrices', () { final matrix = ComplexMatrix.fromData( rows: 2, columns: 3, @@ -1363,7 +1360,7 @@ void main() { expect(matrix.trace, throwsA(isA())); }); - test('Making sure that eigenvalues can be computed (1x1 matrices)', () { + test('eigenvalues for 1x1 matrices', () { final matrix = ComplexMatrix.fromData( rows: 1, columns: 1, @@ -1378,7 +1375,7 @@ void main() { expect(eigenvalues.first, equals(const Complex.fromReal(-16))); }); - test('Making sure that eigenvalues can be computed (2x2 matrices)', () { + test('eigenvalues for 2x2 matrices', () { final matrix = ComplexMatrix.fromData( rows: 2, columns: 2, @@ -1409,7 +1406,7 @@ void main() { ); }); - test('Making sure that eigenvalues can be computed (3x3 matrices)', () { + test('eigenvalues for 3x3 matrices', () { final matrix = ComplexMatrix.fromData( rows: 3, columns: 3, @@ -1431,10 +1428,7 @@ void main() { eigenvalues[1].real, const MoreOrLessEquals(-2.4328, precision: 1.0e-4), ); - expect( - eigenvalues[2].real, - const MoreOrLessEquals(3, precision: 1.0e-4), - ); + expect(eigenvalues[2].real, const MoreOrLessEquals(3, precision: 1.0e-4)); expect( eigenvalues.first.imaginary, const MoreOrLessEquals(0.0889, precision: 1.0e-4), @@ -1443,13 +1437,10 @@ void main() { eigenvalues[1].imaginary, const MoreOrLessEquals(0.911, precision: 1.0e-4), ); - expect( - eigenvalues[2].imaginary, - isZero, - ); + expect(eigenvalues[2].imaginary, isZero); }); - test('Batch tests - Minors', () { + test('minors', () { final source = [ ComplexMatrix.fromData( rows: 3, @@ -1567,7 +1558,7 @@ void main() { ); }); - test('Batch tests - Cofactor matrix', () { + test('cofactorMatrix', () { final source = [ ComplexMatrix.fromData( rows: 3, @@ -1644,7 +1635,7 @@ void main() { expect(source[i], equals(cofactorMatrices[i])); } }); - test('Batch tests - Inverse matrix', () { + test('inverse', () { final source = [ ComplexMatrix.fromData( rows: 3, @@ -1731,7 +1722,7 @@ void main() { } }); - test('Batch tests - Rank of a matrix', () { + test('rank', () { final source = [ ComplexMatrix.fromData( rows: 3, @@ -1777,20 +1768,14 @@ void main() { ).rank(), ]; - final ranks = [ - 3, - 1, - 2, - 2, - 1, - ]; + final ranks = [3, 1, 2, 2, 1]; for (var i = 0; i < source.length; ++i) { expect(source[i], equals(ranks[i])); } }); - test('Batch tests - Characteristic polynomial', () { + test('characteristicPolynomial', () { final polynomials = [ ComplexMatrix.fromData( rows: 3, @@ -1857,43 +1842,33 @@ void main() { ]; final expectedSolutions = [ - Algebraic.from( - [ - const Complex.fromReal(1), - const Complex(-7, 2), - const Complex(-17, -16), - const Complex(191, 46), - ], - ), - Algebraic.from( - [ - const Complex.fromReal(1), - const Complex(-7, -2), - const Complex(-75, 17), - const Complex(293, -72), - const Complex(1898, -27), - ], - ), - Algebraic.from( - [ - const Complex.fromReal(1), - const Complex.fromReal(-5), - const Complex(2, -6), - ], - ), - Algebraic.from( - [ - const Complex.fromReal(1), - -const Complex.fromReal(14), - ], - ), - Algebraic.from( - [ - const Complex.fromReal(1), - -const Complex.fromReal(5), - const Complex.fromReal(69), - ], - ), + Algebraic.from([ + const Complex.fromReal(1), + const Complex(-7, 2), + const Complex(-17, -16), + const Complex(191, 46), + ]), + Algebraic.from([ + const Complex.fromReal(1), + const Complex(-7, -2), + const Complex(-75, 17), + const Complex(293, -72), + const Complex(1898, -27), + ]), + Algebraic.from([ + const Complex.fromReal(1), + const Complex.fromReal(-5), + const Complex(2, -6), + ]), + Algebraic.from([ + const Complex.fromReal(1), + -const Complex.fromReal(14), + ]), + Algebraic.from([ + const Complex.fromReal(1), + -const Complex.fromReal(5), + const Complex.fromReal(69), + ]), ]; for (var i = 0; i < polynomials.length; ++i) { @@ -1918,7 +1893,7 @@ void main() { } }); - test('Batch tests - Eigenvalues', () { + test('eigenvalues', () { final eigenvalues = [ ComplexMatrix.fromData( rows: 2, @@ -2006,13 +1981,8 @@ void main() { Complex(7.1789, -0.9473), Complex(-6.5891, 2.4743), ], - const [ - Complex(4, -2), - ], - const [ - Complex(1, 1), - Complex(-1, 1), - ], + const [Complex(4, -2)], + const [Complex(1, 1), Complex(-1, 1)], const [ Complex(-0.1837, -0.2127), Complex(3.6609, -3.0358), diff --git a/test/system/utils/decompositions/eigendecomposition/eigendecomposition_complex_test.dart b/test/system/utils/decompositions/eigendecomposition/eigendecomposition_complex_test.dart new file mode 100644 index 00000000..48f9fd18 --- /dev/null +++ b/test/system/utils/decompositions/eigendecomposition/eigendecomposition_complex_test.dart @@ -0,0 +1,259 @@ +import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_complex.dart'; +import 'package:test/test.dart'; + +void main() { + group('EigendecompositionComplex', () { + test('Equality tests', () { + final complex = EigendecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ); + + expect( + EigendecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ), + equals(complex), + ); + + expect( + complex, + equals( + EigendecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ), + ), + ); + + expect( + EigendecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ).hashCode, + equals(complex.hashCode), + ); + }); + + test('Decomposition of 1x1 matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex(2, 3)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(1)); + expect(result[0].columnCount, equals(1)); + expect(result[1].rowCount, equals(1)); + expect(result[1].columnCount, equals(1)); + expect(result[2].rowCount, equals(1)); + expect(result[2].columnCount, equals(1)); + }); + + test('Decomposition of 2x2 symmetric matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 0), Complex(2, 0)], + [Complex(2, 0), Complex(1, 0)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + expect(result[2].rowCount, equals(2)); + expect(result[2].columnCount, equals(2)); + }); + + test('Decomposition of 2x2 non-symmetric matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 1), Complex(2, 1)], + [Complex(3, 1), Complex(4, 1)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + expect(result[2].rowCount, equals(2)); + expect(result[2].columnCount, equals(2)); + }); + + test('Decomposition of 3x3 symmetric matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [Complex(1, 0), Complex(2, 0), Complex(3, 0)], + [Complex(2, 0), Complex(4, 0), Complex(5, 0)], + [Complex(3, 0), Complex(5, 0), Complex(6, 0)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(3)); + expect(result[0].columnCount, equals(3)); + expect(result[1].rowCount, equals(3)); + expect(result[1].columnCount, equals(3)); + expect(result[2].rowCount, equals(3)); + expect(result[2].columnCount, equals(3)); + }); + + test('Decomposition of 3x3 non-symmetric matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [Complex(1, 1), Complex(2, 1), Complex(3, 1)], + [Complex(4, 1), Complex(5, 1), Complex(6, 1)], + [Complex(7, 1), Complex(8, 1), Complex(9, 1)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(3)); + expect(result[0].columnCount, equals(3)); + expect(result[1].rowCount, equals(3)); + expect(result[1].columnCount, equals(3)); + expect(result[2].rowCount, equals(3)); + expect(result[2].columnCount, equals(3)); + }); + + test('Decomposition of matrix with zero elements', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.zero(), Complex.zero()], + [Complex.zero(), Complex.zero()], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + expect(result[2].rowCount, equals(2)); + expect(result[2].columnCount, equals(2)); + }); + + test('Decomposition of matrix with complex conjugate eigenvalues', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(0, 1), Complex(1, 0)], + [Complex(-1, 0), Complex(0, -1)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + expect(result[2].rowCount, equals(2)); + expect(result[2].columnCount, equals(2)); + }); + + test('Decomposition of matrix with repeated eigenvalues', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(2, 0), Complex(0, 0)], + [Complex(0, 0), Complex(2, 0)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + expect(result[2].rowCount, equals(2)); + expect(result[2].columnCount, equals(2)); + }); + + test('Decomposition of matrix with ill-conditioned eigenvalues', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1e-10, 0), Complex(1, 0)], + [Complex(1, 0), Complex(10000000000, 0)], + ], + ); + + final decomposition = EigendecompositionComplex(matrix: matrix); + final result = decomposition.decompose(); + + expect(result.length, equals(3)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + expect(result[2].rowCount, equals(2)); + expect(result[2].columnCount, equals(2)); + }); + }); +} diff --git a/test/system/utils/decompositions/eigendecomposition/eigendecomposition_real_test.dart b/test/system/utils/decompositions/eigendecomposition/eigendecomposition_real_test.dart new file mode 100644 index 00000000..f344306f --- /dev/null +++ b/test/system/utils/decompositions/eigendecomposition/eigendecomposition_real_test.dart @@ -0,0 +1,357 @@ +import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_real.dart'; +import 'package:test/test.dart'; + +void main() { + group('EigenDecomposition', () { + test('Equality tests', () { + final real = EigendecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ); + + expect( + EigendecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ), + equals(real), + ); + expect( + real, + equals( + EigendecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ), + ), + ); + + expect( + EigendecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ).hashCode, + equals(real.hashCode), + ); + }); + + test('decompose() with symmetric matrix', () { + // Test case 1: Simple 2x2 symmetric matrix + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [4, 1], + [1, 3], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + + test('decompose() with non-symmetric matrix', () { + // Test case 2: 2x2 non-symmetric matrix + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [3, 4], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + final rounded = RealMatrix.fromFlattenedData( + rows: 2, + columns: 2, + data: reconstructed.flattenData.map((e) => e.round() * 1.0).toList(), + ); + expect(matrix, equals(rounded)); + }); + + test('decompose() with 3x3 symmetric matrix', () { + // Test case 3: 3x3 symmetric matrix + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [2, -1, 0], + [-1, 2, -1], + [0, -1, 2], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 3); + expect(result[0].columnCount, 3); + expect(result[1].rowCount, 3); + expect(result[1].columnCount, 3); + expect(result[2].rowCount, 3); + expect(result[2].columnCount, 3); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + final rounded = RealMatrix.fromFlattenedData( + rows: 3, + columns: 3, + data: reconstructed.flattenData.map((e) => e.roundToDouble()).toList(), + ); + expect(matrix, equals(rounded)); + }); + + test('decompose() with 3x3 non-symmetric matrix', () { + // Test case 4: 3x3 non-symmetric matrix + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [1, 2, 3], + [4, 5, 6], + [7, 8, 9], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 3); + expect(result[0].columnCount, 3); + expect(result[1].rowCount, 3); + expect(result[1].columnCount, 3); + expect(result[2].rowCount, 3); + expect(result[2].columnCount, 3); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + final rounded = RealMatrix.fromFlattenedData( + rows: 3, + columns: 3, + data: reconstructed.flattenData.map((e) => e.roundToDouble()).toList(), + ); + expect(matrix, equals(rounded)); + }); + + test('decompose() with matrix having complex eigenvalues', () { + // Test case 5: Matrix with complex eigenvalues + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [0, -1], + [1, 0], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + + test('decompose() with matrix having repeated eigenvalues', () { + // Test case 6: Matrix with repeated eigenvalues + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [2, 0], + [0, 2], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + + test('decompose() with matrix having zero eigenvalues', () { + // Test case 7: Matrix with zero eigenvalues + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [0, 0], + [0, 0], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + + test('decompose() with matrix having negative eigenvalues', () { + // Test case 8: Matrix with negative eigenvalues + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [-1, 0], + [0, -2], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + + test('decompose() with matrix having mixed eigenvalues', () { + // Test case 9: Matrix with mixed eigenvalues (positive, negative, zero) + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [1, 0, 0], + [0, -1, 0], + [0, 0, 0], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 3); + expect(result[0].columnCount, 3); + expect(result[1].rowCount, 3); + expect(result[1].columnCount, 3); + expect(result[2].rowCount, 3); + expect(result[2].columnCount, 3); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + + test('decompose() with matrix having complex conjugate eigenvalues', () { + // Test case 10: Matrix with complex conjugate eigenvalues + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, -2], + [2, 1], + ], + ); + + final decomposition = EigendecompositionReal(matrix: matrix); + final result = decomposition.decompose(); + + // Verify result contains 3 matrices: V, D, V^-1 + expect(result.length, 3); + expect(result[0].rowCount, 2); + expect(result[0].columnCount, 2); + expect(result[1].rowCount, 2); + expect(result[1].columnCount, 2); + expect(result[2].rowCount, 2); + expect(result[2].columnCount, 2); + + // Verify A = VDV^-1 + final reconstructed = result[0] * result[1] * result[2]; + expect(reconstructed, equals(matrix)); + }); + }); +} diff --git a/test/system/utils/decompositions/eigendecomposition_test.dart b/test/system/utils/decompositions/eigendecomposition_test.dart deleted file mode 100644 index 8c5336cb..00000000 --- a/test/system/utils/decompositions/eigendecomposition_test.dart +++ /dev/null @@ -1,514 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_complex_decomposition.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigen_real_decomposition.dart'; -import 'package:test/test.dart'; - -import '../../../double_approximation_matcher.dart'; - -void main() { - group('EigenDecomposition class', () { - test('Equality tests', () { - final real = EigendecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ); - - final complex = EigendecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ); - - expect( - EigendecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ), - equals(real), - ); - expect( - real, - equals( - EigendecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ), - ), - ); - - expect( - EigendecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ).hashCode, - equals(real.hashCode), - ); - - expect( - EigendecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ), - equals(complex), - ); - - expect( - complex, - equals( - EigendecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ), - ), - ); - - expect( - EigendecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ).hashCode, - equals(complex.hashCode), - ); - }); - - group('Real values', () { - test('Making sure that EigendecompositionReal works properly', () { - final sourceMatrix = RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 0], - [1, 3], - ], - ); - - final realEigen = EigendecompositionReal( - matrix: sourceMatrix, - ); - - final results = realEigen.decompose(); - final matrixV = results.first; - final matrixD = results[1]; - final matrixVinverse = results[2]; - - // Matrices must be square - expect(matrixV.isSquareMatrix, isTrue); - expect(matrixD.isSquareMatrix, isTrue); - expect(matrixVinverse.isSquareMatrix, isTrue); - - // Testing V - expect( - matrixV(0, 0), - const MoreOrLessEquals(-0.8944, precision: 1.0e-4), - ); - expect( - matrixV(0, 1), - const MoreOrLessEquals(0, precision: 1.0e-4), - ); - expect( - matrixV(1, 0), - const MoreOrLessEquals(0.4472, precision: 1.0e-4), - ); - expect( - matrixV(1, 1), - const MoreOrLessEquals(-1.118, precision: 1.0e-4), - ); - - // Testing D - expect( - matrixD(0, 0), - const MoreOrLessEquals(1, precision: 1.0e-4), - ); - expect( - matrixD(0, 1), - const MoreOrLessEquals(0, precision: 1.0e-4), - ); - expect( - matrixD(1, 0), - const MoreOrLessEquals(0, precision: 1.0e-4), - ); - expect( - matrixD(1, 1), - const MoreOrLessEquals(3, precision: 1.0e-4), - ); - - // Testing V' - expect( - matrixVinverse(0, 0), - const MoreOrLessEquals(-1.118, precision: 1.0e-4), - ); - expect( - matrixVinverse(0, 1), - const MoreOrLessEquals(0, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 0), - const MoreOrLessEquals(-0.4472, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 1), - const MoreOrLessEquals(-0.8944, precision: 1.0e-4), - ); - - // Making sure that V x D x V' = A - final matrixA = matrixV * matrixD * matrixVinverse; - expect(matrixA(0, 0), const MoreOrLessEquals(1, precision: 1.0e-1)); - expect(matrixA(0, 1), const MoreOrLessEquals(0, precision: 1.0e-1)); - expect(matrixA(1, 0), const MoreOrLessEquals(1, precision: 1.0e-1)); - expect(matrixA(1, 1), const MoreOrLessEquals(3, precision: 1.0e-1)); - - // Smoke on the RealMatrix method - expect(sourceMatrix.eigenDecomposition(), orderedEquals(results)); - expect(sourceMatrix.toString(), equals(realEigen.toString())); - }); - }); - - group('Complex values', () { - test('Making sure that EigendecompositionComplex works properly', () { - final sourceMatrix = ComplexMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [Complex.i(), Complex(5, 1), Complex.fromReal(4)], - [ - Complex.fromImaginary(-1), - Complex.fromReal(3), - Complex.fromReal(1), - ], - [Complex(4, 6), Complex.fromReal(2), Complex.zero()], - ], - ); - - final realEigen = EigendecompositionComplex( - matrix: sourceMatrix, - ); - - final results = realEigen.decompose(); - final matrixV = results.first; - final matrixD = results[1]; - final matrixVinverse = results[2]; - - // Matrices must be square - expect(matrixV.isSquareMatrix, isTrue); - expect(matrixD.isSquareMatrix, isTrue); - expect(matrixVinverse.isSquareMatrix, isTrue); - - // Testing V - expect( - matrixV(0, 0).real, - const MoreOrLessEquals(0.4887, precision: 1.0e-4), - ); - expect( - matrixV(0, 0).imaginary, - const MoreOrLessEquals(-0.2566, precision: 1.0e-4), - ); - expect( - matrixV(0, 1).real, - const MoreOrLessEquals(-0.6217, precision: 1.0e-4), - ); - expect( - matrixV(0, 1).imaginary, - const MoreOrLessEquals(0.0618, precision: 1.0e-4), - ); - expect( - matrixV(0, 2).real, - const MoreOrLessEquals(0.6812, precision: 1.0e-4), - ); - expect( - matrixV(0, 2).imaginary, - const MoreOrLessEquals(-0.3559, precision: 1.0e-4), - ); - expect( - matrixV(1, 0).real, - const MoreOrLessEquals(0.1659, precision: 1.0e-4), - ); - expect( - matrixV(1, 0).imaginary, - const MoreOrLessEquals(0.0479, precision: 1.0e-4), - ); - expect( - matrixV(1, 1).real, - const MoreOrLessEquals(-0.0873, precision: 1.0e-4), - ); - expect( - matrixV(1, 1).imaginary, - const MoreOrLessEquals(0.2067, precision: 1.0e-4), - ); - expect( - matrixV(1, 2).real, - const MoreOrLessEquals(-1.0084, precision: 1.0e-4), - ); - expect( - matrixV(1, 2).imaginary, - const MoreOrLessEquals(-0.4072, precision: 1.0e-4), - ); - expect( - matrixV(2, 0).real, - const MoreOrLessEquals(-0.9048, precision: 1.0e-4), - ); - expect( - matrixV(2, 0).imaginary, - const MoreOrLessEquals(-0.1298, precision: 1.0e-4), - ); - expect( - matrixV(2, 1).real, - const MoreOrLessEquals(-0.6862, precision: 1.0e-4), - ); - expect( - matrixV(2, 1).imaginary, - const MoreOrLessEquals(-0.3137, precision: 1.0e-4), - ); - expect( - matrixV(2, 2).real, - const MoreOrLessEquals(1.4771, precision: 1.0e-4), - ); - expect( - matrixV(2, 2).imaginary, - const MoreOrLessEquals(0.4958, precision: 1.0e-4), - ); - - // Testing D - expect( - matrixD(0, 0).real, - const MoreOrLessEquals(-4.4551, precision: 1.0e-4), - ); - expect( - matrixD(0, 0).imaginary, - const MoreOrLessEquals(-1.5725, precision: 1.0e-4), - ); - expect( - matrixD(0, 1), - equals(const Complex.zero()), - ); - expect( - matrixD(0, 2), - equals(const Complex.zero()), - ); - expect( - matrixD(1, 0), - equals(const Complex.zero()), - ); - expect( - matrixD(1, 1).real, - const MoreOrLessEquals(5.3472, precision: 1.0e-4), - ); - expect( - matrixD(1, 1).imaginary, - const MoreOrLessEquals(2.0285, precision: 1.0e-4), - ); - expect( - matrixD(1, 2), - equals(const Complex.zero()), - ); - expect( - matrixD(2, 0), - equals(const Complex.zero()), - ); - expect( - matrixD(2, 1), - equals(const Complex.zero()), - ); - expect( - matrixD(2, 2).real, - const MoreOrLessEquals(2.1079, precision: 1.0e-4), - ); - expect( - matrixD(2, 2).imaginary, - const MoreOrLessEquals(0.544, precision: 1.0e-4), - ); - - // Testing V' - expect( - matrixVinverse(0, 0).real, - const MoreOrLessEquals(0.7957, precision: 1.0e-4), - ); - expect( - matrixVinverse(0, 0).imaginary, - const MoreOrLessEquals(0.3337, precision: 1.0e-4), - ); - expect( - matrixVinverse(0, 1).real, - const MoreOrLessEquals(-0.3699, precision: 1.0e-4), - ); - expect( - matrixVinverse(0, 1).imaginary, - const MoreOrLessEquals(-0.2475, precision: 1.0e-4), - ); - expect( - matrixVinverse(0, 2).real, - const MoreOrLessEquals(-0.6381, precision: 1.0e-4), - ); - expect( - matrixVinverse(0, 2).imaginary, - const MoreOrLessEquals(-0.0188, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 0).real, - const MoreOrLessEquals(-0.6382, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 0).imaginary, - const MoreOrLessEquals(-0.3462, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 1).real, - const MoreOrLessEquals(-1.5117, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 1).imaginary, - const MoreOrLessEquals(0.3704, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 2).real, - const MoreOrLessEquals(-0.7274, precision: 1.0e-4), - ); - expect( - matrixVinverse(1, 2).imaginary, - const MoreOrLessEquals(0.0862, precision: 1.0e-4), - ); - expect( - matrixVinverse(2, 0).real, - const MoreOrLessEquals(0.2046, precision: 1.0e-4), - ); - expect( - matrixVinverse(2, 0).imaginary, - const MoreOrLessEquals(-0.0907, precision: 1.0e-4), - ); - expect( - matrixVinverse(2, 1).real, - const MoreOrLessEquals(-0.9865, precision: 1.0e-4), - ); - expect( - matrixVinverse(2, 1).imaginary, - const MoreOrLessEquals(-0.0019, precision: 1.0e-4), - ); - expect( - matrixVinverse(2, 2).real, - const MoreOrLessEquals(-0.1165, precision: 1.0e-4), - ); - expect( - matrixVinverse(2, 2).imaginary, - const MoreOrLessEquals(-0.143, precision: 1.0e-4), - ); - - // Making sure that V x D x V' = A - final matrixA = matrixV * matrixD * matrixVinverse; - expect( - matrixA(0, 0).real, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(0, 0).imaginary, - const MoreOrLessEquals(1, precision: 1.0e-1), - ); - expect( - matrixA(0, 1).real, - const MoreOrLessEquals(5, precision: 1.0e-1), - ); - expect( - matrixA(0, 1).imaginary, - const MoreOrLessEquals(1, precision: 1.0e-1), - ); - expect( - matrixA(0, 2).real, - const MoreOrLessEquals(4, precision: 1.0e-1), - ); - expect( - matrixA(0, 2).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(1, 0).real, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(1, 0).imaginary, - const MoreOrLessEquals(-1, precision: 1.0e-1), - ); - expect( - matrixA(1, 1).real, - const MoreOrLessEquals(3, precision: 1.0e-1), - ); - expect( - matrixA(1, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(1, 2).real, - const MoreOrLessEquals(1, precision: 1.0e-1), - ); - expect( - matrixA(1, 2).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(2, 0).real, - const MoreOrLessEquals(4, precision: 1.0e-1), - ); - expect( - matrixA(2, 0).imaginary, - const MoreOrLessEquals(6, precision: 1.0e-1), - ); - expect( - matrixA(2, 1).real, - const MoreOrLessEquals(2, precision: 1.0e-1), - ); - expect( - matrixA(2, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(2, 2).real, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(2, 2).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - - // Smoke on the RealMatrix method - expect(sourceMatrix.eigenDecomposition(), orderedEquals(results)); - expect(sourceMatrix.toString(), equals(realEigen.toString())); - }); - }); - }); -} diff --git a/test/system/utils/decompositions/qr_decomposition/qr_complex_decomposition_test.dart b/test/system/utils/decompositions/qr_decomposition/qr_complex_decomposition_test.dart new file mode 100644 index 00000000..638680e7 --- /dev/null +++ b/test/system/utils/decompositions/qr_decomposition/qr_complex_decomposition_test.dart @@ -0,0 +1,206 @@ +import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart'; +import 'package:test/test.dart'; + +void main() { + group('QRDecompositionComplex', () { + test('Equality tests', () { + final complex = QRDecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ); + + expect( + complex, + equals( + QRDecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ), + ), + ); + + expect( + QRDecompositionComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.i()], + ], + ), + ).hashCode, + equals(complex.hashCode), + ); + }); + + test('Decomposition of 1x1 matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex(2, 1)], + ], + ); + + final qr = QRDecompositionComplex(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(1)); + expect(result[0].columnCount, equals(1)); + expect(result[1].rowCount, equals(1)); + expect(result[1].columnCount, equals(1)); + + // Verify Q*R = A + final product = result[0] * result[1]; + expect(product(0, 0).real, closeTo(matrix(0, 0).real, 1e-10)); + expect(product(0, 0).imaginary, closeTo(matrix(0, 0).imaginary, 1e-10)); + }); + + test('Decomposition of 2x2 matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 1), Complex(2, -1)], + [Complex(3, 2), Complex(4, 0)], + ], + ); + + final qr = QRDecompositionComplex(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + + // Verify Q*R = A + final product = result[0] * result[1]; + for (var i = 0; i < 2; i++) { + for (var j = 0; j < 2; j++) { + expect( + product(i, j).real.round(), + closeTo(matrix(i, j).real.round(), 1e-10), + ); + expect( + product(i, j).imaginary.round(), + closeTo(matrix(i, j).imaginary.round(), 1e-10), + ); + } + } + }); + + test('Throws on singular matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 1), Complex(2, 2)], + [Complex(2, 2), Complex(4, 4)], // Linearly dependent column + ], + ); + + final qr = QRDecompositionComplex(matrix: matrix); + expect(qr.decompose, throwsA(isA())); + }); + + test('Decomposition with zero matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.zero(), Complex.zero()], + [Complex.zero(), Complex.zero()], + ], + ); + + final qr = QRDecompositionComplex(matrix: matrix); + expect(qr.decompose, throwsA(isA())); + }); + + test('Decomposition with pure imaginary numbers', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.i(), Complex(0, 2)], + [Complex(0, 3), Complex(0, 4)], + ], + ); + + final qr = QRDecompositionComplex(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + + // Verify Q*R = A + final product = result[0] * result[1]; + for (var i = 0; i < 2; i++) { + for (var j = 0; j < 2; j++) { + expect(product(i, j).real, closeTo(matrix(i, j).real, 1e-10)); + expect( + product(i, j).imaginary, + closeTo(matrix(i, j).imaginary, 1e-10), + ); + } + } + }); + + test( + 'Decomposition with large real values to trigger aAbs > bAbs branch', + () { + final matrix = ComplexMatrix.fromData( + rows: 4, + columns: 2, + data: const [ + [Complex(1000, 0), Complex(200, 0)], + [Complex(1, 0), Complex(400, 0)], + [Complex(1, 0), Complex(600, 0)], + [Complex(1, 0), Complex(800, 0)], + ], + ); + + final qr = QRDecompositionComplex(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(4)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + + // Verify Q*R = A + final product = result[0] * result[1]; + for (var i = 0; i < 4; i++) { + for (var j = 0; j < 2; j++) { + expect( + product(i, j).real, + closeTo(matrix(i, j).real, 1e-8), + ); + expect( + product(i, j).imaginary, + closeTo(matrix(i, j).imaginary, 1e-8), + ); + } + } + }, + ); + }); +} diff --git a/test/system/utils/decompositions/qr_decomposition/qr_real_decomposition_test.dart b/test/system/utils/decompositions/qr_decomposition/qr_real_decomposition_test.dart new file mode 100644 index 00000000..4078c192 --- /dev/null +++ b/test/system/utils/decompositions/qr_decomposition/qr_real_decomposition_test.dart @@ -0,0 +1,206 @@ +import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart'; +import 'package:test/test.dart'; + +void main() { + group('QRDecompositionReal', () { + test('Equality tests', () { + final real = QRDecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ); + + expect( + QRDecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ), + equals(real), + ); + + expect( + real, + equals( + QRDecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ), + ), + ); + + expect( + QRDecompositionReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ).hashCode, + equals(real.hashCode), + ); + }); + + test('1x1 matrix decomposition', () { + final matrix = RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [2], + ], + ); + + final qr = QRDecompositionReal(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(1)); + expect(result[0].columnCount, equals(1)); + expect(result[1].rowCount, equals(1)); + expect(result[1].columnCount, equals(1)); + + // Q should be orthogonal (Q^T * Q = I) + final qTq = result[0].transpose() * result[0]; + expect(qTq(0, 0), closeTo(1, 1e-10)); + }); + + test('2x2 matrix decomposition', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [3, 4], + ], + ); + + final qr = QRDecompositionReal(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(2)); + expect(result[0].columnCount, equals(2)); + expect(result[1].rowCount, equals(2)); + expect(result[1].columnCount, equals(2)); + + // Q should be orthogonal (Q^T * Q = I) + final qTq = result[0].transpose() * result[0]; + expect(qTq(0, 0), closeTo(1, 1e-10)); + expect(qTq(0, 1), closeTo(0, 1e-10)); + expect(qTq(1, 0), closeTo(0, 1e-10)); + expect(qTq(1, 1), closeTo(1, 1e-10)); + + // R should be upper triangular + expect(result[1](1, 0), closeTo(0, 1e-10)); + + // Verify A = QR + final reconstructed = result[0] * result[1]; + expect(reconstructed(0, 0), closeTo(matrix(0, 0), 1e-10)); + expect(reconstructed(0, 1), closeTo(matrix(0, 1), 1e-10)); + expect(reconstructed(1, 0), closeTo(matrix(1, 0), 1e-10)); + expect(reconstructed(1, 1), closeTo(matrix(1, 1), 1e-10)); + }); + + test('3x3 matrix decomposition', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: [ + [1, 2, 3], + [4, 5, 6], + [7, 8, 9], + ], + ); + + final qr = QRDecompositionReal(matrix: matrix); + final result = qr.decompose(); + + expect(result.length, equals(2)); + expect(result[0].rowCount, equals(3)); + expect(result[0].columnCount, equals(3)); + expect(result[1].rowCount, equals(3)); + expect(result[1].columnCount, equals(3)); + + // Q should be orthogonal (Q^T * Q = I) + final qTq = result[0].transpose() * result[0]; + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 3; j++) { + expect(qTq(i, j), closeTo(i == j ? 1 : 0, 1e-10)); + } + } + + // R should be upper triangular + for (var i = 1; i < 3; i++) { + for (var j = 0; j < i; j++) { + expect(result[1](i, j), closeTo(0, 1e-10)); + } + } + + // Verify A = QR + final reconstructed = result[0] * result[1]; + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 3; j++) { + expect(reconstructed(i, j), closeTo(matrix(i, j), 1e-10)); + } + } + }); + + test('Matrix with zero column', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [0, 1], + [0, 2], + ], + ); + + final qr = QRDecompositionReal(matrix: matrix); + final result = qr.decompose(); + + // Verify A = QR + final reconstructed = result[0] * result[1]; + expect(reconstructed(0, 0), closeTo(matrix(0, 0), 1e-10)); + expect(reconstructed(0, 1), closeTo(matrix(0, 1), 1e-10)); + expect(reconstructed(1, 0), closeTo(matrix(1, 0), 1e-10)); + expect(reconstructed(1, 1), closeTo(matrix(1, 1), 1e-10)); + }); + + test('Matrix with negative values', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [-1, -2], + [-3, -4], + ], + ); + + final qr = QRDecompositionReal(matrix: matrix); + final result = qr.decompose(); + + // Verify A = QR + final reconstructed = result[0] * result[1]; + expect(reconstructed(0, 0), closeTo(matrix(0, 0), 1e-10)); + expect(reconstructed(0, 1), closeTo(matrix(0, 1), 1e-10)); + expect(reconstructed(1, 0), closeTo(matrix(1, 0), 1e-10)); + expect(reconstructed(1, 1), closeTo(matrix(1, 1), 1e-10)); + }); + }); +} diff --git a/test/system/utils/decompositions/qr_decomposition_test.dart b/test/system/utils/decompositions/qr_decomposition_test.dart deleted file mode 100644 index 65884beb..00000000 --- a/test/system/utils/decompositions/qr_decomposition_test.dart +++ /dev/null @@ -1,376 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_complex_decomposition.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart'; -import 'package:test/test.dart'; - -import '../../../double_approximation_matcher.dart'; - -void main() { - group('QRDecomposition class', () { - test('Equality tests', () { - final real = QRDecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ); - - final complex = QRDecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ); - - expect( - QRDecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ), - equals(real), - ); - - expect( - real, - equals( - QRDecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ), - ), - ); - - expect( - QRDecompositionReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ).hashCode, - equals(real.hashCode), - ); - - expect( - complex, - equals( - QRDecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ), - ), - ); - - expect( - QRDecompositionComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ).hashCode, - equals(complex.hashCode), - ); - }); - - group('Real values', () { - test('Making sure that QRDecompositionReal works properly - Test 1', () { - final sourceMatrix = RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 2], - [3, 4], - ], - ); - - final realQR = QRDecompositionReal( - matrix: sourceMatrix, - ); - - final results = realQR.decompose(); - final matrixQ = results.first; - final matrixR = results[1]; - - // Matrices must be square - expect(matrixQ.isSquareMatrix, isTrue); - expect(matrixR.isSquareMatrix, isTrue); - - // Testing Q - expect( - matrixQ(0, 0), - const MoreOrLessEquals(-0.3162, precision: 1.0e-4), - ); - expect( - matrixQ(0, 1), - const MoreOrLessEquals(0.9486, precision: 1.0e-4), - ); - expect( - matrixQ(1, 0), - const MoreOrLessEquals(-0.9486, precision: 1.0e-4), - ); - expect( - matrixQ(1, 1), - const MoreOrLessEquals(-0.3162, precision: 1.0e-4), - ); - - // Testing R - expect( - matrixR(0, 0), - const MoreOrLessEquals(-3.1622, precision: 1.0e-4), - ); - expect( - matrixR(0, 1), - const MoreOrLessEquals(-4.4271, precision: 1.0e-4), - ); - expect( - matrixR(1, 0), - const MoreOrLessEquals(0, precision: 1.0e-4), - ); - expect( - matrixR(1, 1), - const MoreOrLessEquals(0.6324, precision: 1.0e-4), - ); - - // Making sure that Q * R = A - final matrixA = matrixQ * matrixR; - expect(matrixA(0, 0), const MoreOrLessEquals(1, precision: 1.0e-1)); - expect(matrixA(0, 1), const MoreOrLessEquals(2, precision: 1.0e-1)); - expect(matrixA(1, 0), const MoreOrLessEquals(3, precision: 1.0e-1)); - expect(matrixA(1, 1), const MoreOrLessEquals(4, precision: 1.0e-1)); - - // Smoke on the RealMatrix method - expect(sourceMatrix.qrDecomposition(), orderedEquals(results)); - expect(sourceMatrix.toString(), equals(realQR.toString())); - }); - - test('Making sure that QRDecompositionReal works properly - Test 2', () { - final realQR = QRDecompositionReal( - matrix: RealMatrix.fromData( - rows: 4, - columns: 3, - data: [ - [1, -1, 4], - [1, 4, -2], - [1, 4, 2], - [1, -1, 0], - ], - ), - ); - - final results = realQR.decompose(); - final matrixQ = results.first; - final matrixR = results[1]; - - // Matrices must be square - expect(matrixQ.rowCount, equals(4)); - expect(matrixQ.columnCount, equals(3)); - expect(matrixR.rowCount, equals(3)); - expect(matrixR.columnCount, equals(3)); - - // Testing Q - expect(matrixQ(0, 0), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(0, 1), const MoreOrLessEquals(0.5, precision: 0.1)); - expect(matrixQ(0, 2), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(1, 0), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(1, 1), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(1, 2), const MoreOrLessEquals(0.5, precision: 0.1)); - expect(matrixQ(2, 0), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(2, 1), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(2, 2), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(3, 0), const MoreOrLessEquals(-0.5, precision: 0.1)); - expect(matrixQ(3, 1), const MoreOrLessEquals(0.5, precision: 0.1)); - expect(matrixQ(3, 2), const MoreOrLessEquals(0.5, precision: 0.1)); - - // Testing R - expect(matrixR(0, 0), const MoreOrLessEquals(-2, precision: 0.1)); - expect(matrixR(0, 1), const MoreOrLessEquals(-3, precision: 0.1)); - expect(matrixR(0, 2), const MoreOrLessEquals(-2, precision: 0.1)); - expect(matrixR(1, 0), const MoreOrLessEquals(0, precision: 0.1)); - expect(matrixR(1, 1), const MoreOrLessEquals(-5, precision: 0.1)); - expect(matrixR(1, 2), const MoreOrLessEquals(2, precision: 0.1)); - expect(matrixR(2, 0), const MoreOrLessEquals(0, precision: 0.1)); - expect(matrixR(2, 1), const MoreOrLessEquals(0, precision: 0.1)); - expect(matrixR(2, 2), const MoreOrLessEquals(-4, precision: 0.1)); - - final realMatrix = RealMatrix.fromData( - rows: 4, - columns: 3, - data: [ - [1, -1, 4], - [1, 4, -2], - [1, 4, 2], - [1, -1, 0], - ], - ); - - expect(realMatrix.qrDecomposition(), orderedEquals(results)); - }); - }); - - group('Complex values', () { - test('Making sure that QRDecompositionComplex works properly', () { - final sourceMatrix = ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex.fromReal(1), Complex.i()], - [Complex.fromReal(3), Complex.fromReal(4)], - ], - ); - - final complexQR = QRDecompositionComplex( - matrix: sourceMatrix, - ); - - final results = complexQR.decompose(); - final matrixQ = results.first; - final matrixR = results[1]; - - // Matrices must be square - expect(matrixQ.isSquareMatrix, isTrue); - expect(matrixR.isSquareMatrix, isTrue); - - // Testing Q - expect( - matrixQ(0, 0).real, - const MoreOrLessEquals(-0.3162, precision: 1.0e-4), - ); - expect( - matrixQ(0, 1).real, - const MoreOrLessEquals(0.9486, precision: 1.0e-4), - ); - expect( - matrixQ(1, 0).real, - const MoreOrLessEquals(-0.9486, precision: 1.0e-4), - ); - expect( - matrixQ(1, 1).real, - const MoreOrLessEquals(-0.3162, precision: 1.0e-4), - ); - expect( - matrixQ(0, 0).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixQ(0, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixQ(1, 0).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixQ(1, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - - // Testing R - expect( - matrixR(0, 0).real, - const MoreOrLessEquals(-3.1622, precision: 1.0e-4), - ); - expect( - matrixR(0, 1).real, - const MoreOrLessEquals(-3.7947, precision: 1.0e-4), - ); - expect( - matrixR(1, 0).real, - const MoreOrLessEquals(0, precision: 1.0e-4), - ); - expect( - matrixR(1, 1).real, - const MoreOrLessEquals(-1.2649, precision: 1.0e-4), - ); - expect( - matrixR(0, 0).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixR(0, 1).imaginary, - const MoreOrLessEquals(-0.3162, precision: 1.0e-4), - ); - expect( - matrixR(1, 0).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixR(1, 1).imaginary, - const MoreOrLessEquals(0.9486, precision: 1.0e-4), - ); - - // Making sure that Q * R = A - final matrixA = matrixQ * matrixR; - expect( - matrixA(0, 0).real, - const MoreOrLessEquals(1, precision: 1.0e-1), - ); - expect( - matrixA(0, 1).real, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(1, 0).real, - const MoreOrLessEquals(3, precision: 1.0e-1), - ); - expect( - matrixA(1, 1).real, - const MoreOrLessEquals(4, precision: 1.0e-1), - ); - expect( - matrixA(0, 0).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(0, 1).imaginary, - const MoreOrLessEquals(1, precision: 1.0e-1), - ); - expect( - matrixA(1, 0).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - expect( - matrixA(1, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-1), - ); - - final complexMatrix = ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex.fromReal(1), Complex.i()], - [Complex.fromReal(3), Complex.fromReal(4)], - ], - ); - - expect(complexMatrix.qrDecomposition(), orderedEquals(results)); - expect(sourceMatrix.toString(), equals(complexQR.toString())); - }); - }); - }); -} diff --git a/test/system/utils/decompositions/single_value_decomposition_test.dart b/test/system/utils/decompositions/single_value_decomposition_test.dart deleted file mode 100644 index 389442cb..00000000 --- a/test/system/utils/decompositions/single_value_decomposition_test.dart +++ /dev/null @@ -1,963 +0,0 @@ -import 'package:equations/equations.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/complex_svd.dart'; -import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/real_svd.dart'; -import 'package:test/test.dart'; - -import '../../../double_approximation_matcher.dart'; - -void main() { - group('SingleValueDecomposition class', () { - test('Equality tests', () { - final real = SVDReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ); - - final complex = SVDComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ); - - expect( - SVDReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ), - equals(real), - ); - - expect( - real, - equals( - SVDReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ), - ), - ); - - expect( - SVDReal( - matrix: RealMatrix.fromData( - rows: 1, - columns: 1, - data: [ - [1], - ], - ), - ).hashCode, - equals(real.hashCode), - ); - - expect( - SVDComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ), - equals(complex), - ); - - expect( - complex, - equals( - SVDComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ), - ), - ); - - expect( - SVDComplex( - matrix: ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.i()], - ], - ), - ).hashCode, - equals(complex.hashCode), - ); - }); - - group('Real values', () { - test('Making sure that SVD decomposition works on a square matrix', () { - final matrix = RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [1, 5], - [7, -3], - ], - ); - - // Decomposition - final svd = matrix.singleValueDecomposition(); - expect(svd.length, equals(3)); - - // Checking E - final E = svd.first; - expect(E.isSquareMatrix, isTrue); - expect( - E(0, 0), - const MoreOrLessEquals(7.73877, precision: 1.0e-5), - ); - expect( - E(0, 1), - isZero, - ); - expect( - E(1, 0), - isZero, - ); - expect( - E(1, 1), - const MoreOrLessEquals(4.91034, precision: 1.0e-5), - ); - - // Checking U - final U = svd[1]; - expect(U.isSquareMatrix, isTrue); - expect( - U(0, 0), - const MoreOrLessEquals(-0.22975, precision: 1.0e-5), - ); - expect( - U(0, 1), - const MoreOrLessEquals(0.97324, precision: 1.0e-5), - ); - expect( - U(1, 0), - const MoreOrLessEquals(0.97324, precision: 1.0e-5), - ); - expect( - U(1, 1), - const MoreOrLessEquals(0.229753, precision: 1.0e-5), - ); - - // Checking V - final V = svd[2]; - expect(V.isSquareMatrix, isTrue); - expect( - V(0, 0), - const MoreOrLessEquals(0.85065, precision: 1.0e-5), - ); - expect( - V(0, 1), - const MoreOrLessEquals(0.52573, precision: 1.0e-5), - ); - expect( - V(1, 0), - const MoreOrLessEquals(-0.52573, precision: 1.0e-5), - ); - expect( - V(1, 1), - const MoreOrLessEquals(0.85065, precision: 1.0e-5), - ); - - // Making sure that U x E x Vt (where Vt is V transposed) equals to the - // starting matrix - final original = U * E * V.transpose(); - - expect( - original(0, 0), - const MoreOrLessEquals(1, precision: 1.0e-5), - ); - expect( - original(0, 1), - const MoreOrLessEquals(5, precision: 1.0e-5), - ); - expect( - original(1, 0), - const MoreOrLessEquals(7, precision: 1.0e-5), - ); - expect( - original(1, 1), - const MoreOrLessEquals(-3, precision: 1.0e-5), - ); - }); - - test( - 'Making sure that SVD decomposition works on a non-square matrix', - () { - final matrix = RealMatrix.fromData( - rows: 3, - columns: 2, - data: const [ - [3, -5], - [4, 9], - [-2, 1], - ], - ); - - // Decomposition - final svd = matrix.singleValueDecomposition(); - expect(svd.length, equals(3)); - - // Checking E - final E = svd.first; - expect(E.isSquareMatrix, isFalse); - expect(E.rowCount, equals(3)); - expect(E.columnCount, equals(2)); - expect( - E(0, 0), - const MoreOrLessEquals(10.55376, precision: 1.0e-5), - ); - expect( - E(0, 1), - isZero, - ); - expect( - E(1, 0), - isZero, - ); - expect( - E(1, 1), - const MoreOrLessEquals(4.96165, precision: 1.0e-5), - ); - expect( - E(2, 0), - isZero, - ); - expect( - E(2, 1), - isZero, - ); - - // Checking U - final U = svd[1]; - expect(U.isSquareMatrix, isTrue); - expect( - U(0, 0), - const MoreOrLessEquals(0.397763, precision: 1.0e-5), - ); - expect( - U(0, 1), - const MoreOrLessEquals(-0.815641, precision: 1.0e-5), - ); - expect( - U(0, 2), - const MoreOrLessEquals(0.420135, precision: 1.0e-5), - ); - expect( - U(1, 0), - const MoreOrLessEquals(-0.916139, precision: 1.0e-5), - ); - expect( - U(1, 1), - const MoreOrLessEquals(-0.377915, precision: 1.0e-5), - ); - expect( - U(1, 2), - const MoreOrLessEquals(0.133679, precision: 1.0e-5), - ); - expect( - U(2, 0), - const MoreOrLessEquals(-0.04974, precision: 1.0e-5), - ); - expect( - U(2, 1), - const MoreOrLessEquals(0.43807, precision: 1.0e-5), - ); - expect( - U(2, 2), - const MoreOrLessEquals(0.89756, precision: 1.0e-5), - ); - - // Checking V - final V = svd[2]; - expect(V.isSquareMatrix, isTrue); - expect( - V(0, 0), - const MoreOrLessEquals(-0.22473, precision: 1.0e-5), - ); - expect( - V(0, 1), - const MoreOrLessEquals(-0.97442, precision: 1.0e-5), - ); - expect( - V(1, 0), - const MoreOrLessEquals(-0.97442, precision: 1.0e-5), - ); - expect( - V(1, 1), - const MoreOrLessEquals(0.22473, precision: 1.0e-5), - ); - - // Making sure that U x E x Vt (where Vt is V transposed) equals to - // the starting matrix - final original = U * E * V.transpose(); - - expect( - original(0, 0), - const MoreOrLessEquals(3, precision: 1.0e-5), - ); - expect( - original(0, 1), - const MoreOrLessEquals(-5, precision: 1.0e-5), - ); - expect( - original(1, 0), - const MoreOrLessEquals(4, precision: 1.0e-5), - ); - expect( - original(1, 1), - const MoreOrLessEquals(9, precision: 1.0e-5), - ); - expect( - original(2, 0), - const MoreOrLessEquals(-2, precision: 1.0e-5), - ); - expect( - original(2, 1), - const MoreOrLessEquals(1, precision: 1.0e-5), - ); - }, - ); - - test( - 'Making sure that the SVD algorithm does NOT throw exceptions with ' - 'particular matrices.', - () { - expect( - RealMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [3, -5, 1], - [4, -3, 9], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [-3, 0], - [0, -3], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - RealMatrix.fromData( - rows: 2, - columns: 4, - data: const [ - [0, 3, -5, 1], - [4, 0, -3, 9], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - RealMatrix.fromData( - rows: 3, - columns: 6, - data: const [ - [0, 3, -5, 1, 0, -1], - [4, 0, -3, 9, 0, 0], - [4, 5, 0, -1, -2, 1], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - RealMatrix.fromData( - rows: 5, - columns: 5, - data: const [ - [-1, 0, 0, 0, 1], - [0, -1, 0, 1, 0], - [0, 0, 1, 0, 0], - [0, 1, 0, -1, 0], - [1, 0, 0, 0, -1], - ], - ).singleValueDecomposition(), - isA>(), - ); - - // Small values precision - expect( - RealMatrix.fromData( - rows: 5, - columns: 4, - data: const [ - [0, 0, 1.0e-4, 4], - [0, 0, 0, 0], - [0, 0, 1.0e-6, 0], - [0, 5, 0, 0], - [0, 0, 1.0e-4, 0], - ], - ).singleValueDecomposition(), - isA>(), - ); - - // Zeroes - final zeroes = RealMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [0, 0], - [0, 0], - ], - ); - final zeroesSvd = zeroes.singleValueDecomposition(); - - expect( - zeroesSvd.first, - RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [0, 0, 0, 0], - ), - ); - expect( - zeroesSvd[1], - RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [1, 0, 0, 1], - ), - ); - expect( - zeroesSvd[2], - RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [-1, 0, 0, -1], - ), - ); - expect( - zeroesSvd.first * zeroesSvd[1] * zeroesSvd[2].transpose(), - equals(zeroes), - ); - - // Single element - final special1x1 = RealMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [8], - ], - ).singleValueDecomposition(); - - expect(special1x1.first(0, 0), equals(8)); - expect(special1x1[1](0, 0), equals(1)); - expect(special1x1[2](0, 0), equals(1)); - }, - ); - }); - - group('Complex values', () { - test('Making sure that SVD decomposition works on a square matrix', () { - final matrix = ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex.fromReal(1), Complex.fromReal(5)], - [Complex.fromReal(7), Complex.fromReal(-3)], - ], - ); - - // Decomposition - final svd = matrix.singleValueDecomposition(); - expect(svd.length, equals(3)); - - // Checking E - final E = svd.first; - expect(E.isSquareMatrix, isTrue); - expect( - E(0, 0).real, - const MoreOrLessEquals(-7.73877, precision: 1.0e-5), - ); - expect( - E(0, 1).real, - isZero, - ); - expect( - E(1, 0).real, - isZero, - ); - expect( - E(1, 1).real, - const MoreOrLessEquals(-4.91034, precision: 1.0e-5), - ); - - // Checking U - final U = svd[1]; - expect(U.isSquareMatrix, isTrue); - expect( - U(0, 0).real, - const MoreOrLessEquals(0.22975, precision: 1.0e-5), - ); - expect( - U(0, 1).real, - const MoreOrLessEquals(-0.97324, precision: 1.0e-5), - ); - expect( - U(1, 0).real, - const MoreOrLessEquals(-0.97324, precision: 1.0e-5), - ); - expect( - U(1, 1).real, - const MoreOrLessEquals(-0.229753, precision: 1.0e-5), - ); - - // Checking V - final V = svd[2]; - expect(V.isSquareMatrix, isTrue); - expect( - V(0, 0).real, - const MoreOrLessEquals(0.85065, precision: 1.0e-5), - ); - expect( - V(0, 1).real, - const MoreOrLessEquals(0.52573, precision: 1.0e-5), - ); - expect( - V(1, 0).real, - const MoreOrLessEquals(-0.52573, precision: 1.0e-5), - ); - expect( - V(1, 1).real, - const MoreOrLessEquals(0.85065, precision: 1.0e-5), - ); - - // Making sure that U x E x Vt (where Vt is V transposed) equals to the - // starting matrix - final original = U * E * V.transpose(); - - expect( - original(0, 0).real, - const MoreOrLessEquals(1, precision: 1.0e-5), - ); - expect( - original(0, 1).real, - const MoreOrLessEquals(5, precision: 1.0e-5), - ); - expect( - original(1, 0).real, - const MoreOrLessEquals(7, precision: 1.0e-5), - ); - expect( - original(1, 1).real, - const MoreOrLessEquals(-3, precision: 1.0e-5), - ); - }); - - test( - 'Making sure that SVD decomposition works on a non-square matrix', - () { - final matrix = ComplexMatrix.fromData( - rows: 3, - columns: 2, - data: const [ - [Complex.fromReal(3), Complex.fromReal(-5)], - [Complex.fromReal(4), Complex.fromReal(9)], - [Complex.fromReal(-2), Complex.fromReal(1)], - ], - ); - - // Decomposition - final svd = matrix.singleValueDecomposition(); - expect(svd.length, equals(3)); - - // Checking E - final E = svd.first; - expect(E.isSquareMatrix, isFalse); - expect(E.rowCount, equals(3)); - expect(E.columnCount, equals(2)); - expect( - E(0, 0).real, - const MoreOrLessEquals(-10.55376, precision: 1.0e-5), - ); - expect( - E(0, 1).real, - isZero, - ); - expect( - E(1, 0).real, - isZero, - ); - expect( - E(1, 1).real, - const MoreOrLessEquals(-4.96165, precision: 1.0e-5), - ); - expect( - E(2, 0).real, - isZero, - ); - expect( - E(2, 1).real, - isZero, - ); - - // Checking U - final U = svd[1]; - expect(U.isSquareMatrix, isTrue); - expect( - U(0, 0).real, - const MoreOrLessEquals(0.397763, precision: 1.0e-5), - ); - expect( - U(0, 1).real, - const MoreOrLessEquals(0.815641, precision: 1.0e-5), - ); - expect( - U(0, 2).real, - const MoreOrLessEquals(0.420135, precision: 1.0e-5), - ); - expect( - U(1, 0).real, - const MoreOrLessEquals(-0.916139, precision: 1.0e-5), - ); - expect( - U(1, 1).real, - const MoreOrLessEquals(0.377915, precision: 1.0e-5), - ); - expect( - U(1, 2).real, - const MoreOrLessEquals(0.133679, precision: 1.0e-5), - ); - expect( - U(2, 0).real, - const MoreOrLessEquals(-0.04974, precision: 1.0e-5), - ); - expect( - U(2, 1).real, - const MoreOrLessEquals(-0.43807, precision: 1.0e-5), - ); - expect( - U(2, 2).real, - const MoreOrLessEquals(0.89756, precision: 1.0e-5), - ); - - // Checking V - final V = svd[2]; - expect(V.isSquareMatrix, isTrue); - expect( - V(0, 0).real, - const MoreOrLessEquals(0.22473, precision: 1.0e-5), - ); - expect( - V(0, 1).real, - const MoreOrLessEquals(-0.97442, precision: 1.0e-5), - ); - expect( - V(1, 0).real, - const MoreOrLessEquals(0.97442, precision: 1.0e-5), - ); - expect( - V(1, 1).real, - const MoreOrLessEquals(0.22473, precision: 1.0e-5), - ); - - // Making sure that U x E x Vt (where Vt is V transposed) equals to - // the starting matrix - final original = U * E * V.transpose(); - - expect( - original(0, 0).real, - const MoreOrLessEquals(3, precision: 1.0e-5), - ); - expect( - original(0, 1).real, - const MoreOrLessEquals(-5, precision: 1.0e-5), - ); - expect( - original(1, 0).real, - const MoreOrLessEquals(4, precision: 1.0e-5), - ); - expect( - original(1, 1).real, - const MoreOrLessEquals(9, precision: 1.0e-5), - ); - expect( - original(2, 0).real, - const MoreOrLessEquals(-2, precision: 1.0e-5), - ); - expect( - original(2, 1).real, - const MoreOrLessEquals(1, precision: 1.0e-5), - ); - }, - ); - - test( - 'Making sure that the SVD algorithm does NOT throw exceptions with ' - 'particular matrices.', - () { - expect( - ComplexMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [ - Complex.fromReal(3), - Complex.fromReal(-5), - Complex.fromReal(1), - ], - [ - Complex.fromReal(4), - Complex.fromReal(-3), - Complex.fromReal(9), - ], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex.fromReal(-3), Complex.i()], - [Complex.i(), Complex.fromReal(-3)], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - ComplexMatrix.fromData( - rows: 2, - columns: 4, - data: const [ - [ - Complex.zero(), - Complex.fromReal(3), - Complex.fromReal(-5), - Complex.fromReal(1), - ], - [ - Complex.fromReal(4), - Complex.zero(), - Complex.fromReal(-3), - Complex.fromReal(9), - ], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - ComplexMatrix.fromData( - rows: 3, - columns: 6, - data: const [ - [ - Complex.zero(), - Complex.fromReal(3), - Complex.fromReal(-5), - Complex.fromReal(1), - Complex.zero(), - Complex.fromReal(-1), - ], - [ - Complex.fromReal(4), - Complex.zero(), - Complex.fromReal(-3), - Complex.fromReal(9), - Complex.zero(), - Complex.zero(), - ], - [ - Complex.fromReal(4), - Complex.fromReal(5), - Complex.zero(), - Complex.fromReal(-1), - Complex.fromReal(-2), - Complex.fromReal(1), - ], - ], - ).singleValueDecomposition(), - isA>(), - ); - - expect( - ComplexMatrix.fromData( - rows: 5, - columns: 5, - data: const [ - [ - Complex.fromReal(-1), - Complex.zero(), - Complex.fromReal(1.0e-5), - Complex.zero(), - Complex.i(), - ], - [ - Complex.zero(), - Complex.fromReal(-1), - Complex.zero(), - Complex.i(), - Complex.zero(), - ], - [ - Complex.zero(), - Complex.zero(), - Complex.i(), - Complex.zero(), - Complex.zero(), - ], - [ - Complex.zero(), - Complex.i(), - Complex.zero(), - Complex.fromReal(-1), - Complex.zero(), - ], - [ - Complex.i(), - Complex.zero(), - Complex.zero(), - Complex.zero(), - Complex.fromReal(-1), - ], - ], - ).singleValueDecomposition(), - isA>(), - ); - - // Small values precision - expect( - ComplexMatrix.fromData( - rows: 5, - columns: 4, - data: const [ - [ - Complex.fromReal(1), - Complex.fromReal(1), - Complex.fromReal(0), - Complex.fromReal(1.0e-8), - ], - [ - Complex.zero(), - Complex.zero(), - Complex.zero(), - Complex.zero(), - ], - [ - Complex.zero(), - Complex.zero(), - Complex.fromReal(1.0e-6), - Complex.zero(), - ], - [ - Complex.zero(), - Complex.fromReal(1), - Complex.fromReal(2), - Complex.zero(), - ], - [ - Complex.zero(), - Complex.zero(), - Complex.fromReal(1.0e-10), - Complex.zero(), - ], - ], - ).singleValueDecomposition(), - isA>(), - ); - - // Complex entries - final complexSvd = ComplexMatrix.fromData( - rows: 2, - columns: 2, - data: const [ - [Complex.i(), Complex(2, 0)], - [Complex(7, 1), Complex.fromReal(6)], - ], - ).singleValueDecomposition(); - - final matrix = - complexSvd[1] * complexSvd.first * complexSvd[2].transpose(); - expect( - matrix(0, 0).real, - const MoreOrLessEquals(0, precision: 1.0e-5), - ); - expect( - matrix(0, 0).imaginary, - const MoreOrLessEquals(1, precision: 1.0e-5), - ); - expect( - matrix(0, 1).real, - const MoreOrLessEquals(2, precision: 1.0e-5), - ); - expect( - matrix(0, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-5), - ); - expect( - matrix(1, 0).real, - const MoreOrLessEquals(7, precision: 1.0e-5), - ); - expect( - matrix(1, 0).imaginary, - const MoreOrLessEquals(1, precision: 1.0e-5), - ); - expect( - matrix(1, 1).real, - const MoreOrLessEquals(6, precision: 1.0e-5), - ); - expect( - matrix(1, 1).imaginary, - const MoreOrLessEquals(0, precision: 1.0e-5), - ); - - // Single element - final special1x1 = ComplexMatrix.fromData( - rows: 1, - columns: 1, - data: const [ - [Complex.fromReal(3)], - ], - ).singleValueDecomposition(); - - expect(special1x1.first(0, 0), equals(const Complex.fromReal(3))); - expect(special1x1[1](0, 0), equals(const Complex.fromReal(1))); - expect(special1x1[2](0, 0), equals(const Complex.fromReal(1))); - }, - ); - }); - }); -} diff --git a/test/system/utils/decompositions/singular_value_decomposition/svd_complex_test.dart b/test/system/utils/decompositions/singular_value_decomposition/svd_complex_test.dart new file mode 100644 index 00000000..893e9163 --- /dev/null +++ b/test/system/utils/decompositions/singular_value_decomposition/svd_complex_test.dart @@ -0,0 +1,550 @@ +import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_complex.dart'; +import 'package:test/test.dart'; + +import '../../../../double_approximation_matcher.dart'; + +void main() { + group('SVDComplex class', () { + test('Equality tests', () { + final svd1 = SVDComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.fromReal(1)], + ], + ), + ); + + final svd2 = SVDComplex( + matrix: ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.fromReal(1)], + ], + ), + ); + + expect(svd1, equals(svd2)); + expect(svd1.hashCode, equals(svd2.hashCode)); + }); + + test('Empty matrix throws ArgumentError', () { + expect( + () => SVDComplex( + matrix: ComplexMatrix.fromData( + rows: 0, + columns: 0, + data: const [], + ), + ).decompose(), + throwsArgumentError, + ); + }); + + test('1x1 matrix decomposition', () { + final matrix = ComplexMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [Complex.fromReal(5)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // E matrix + expect(svd[0](0, 0).real, equals(5)); + expect(svd[0](0, 0).imaginary, equals(0)); + expect(svd[0].rowCount, equals(1)); + expect(svd[0].columnCount, equals(1)); + + // U matrix + expect(svd[1](0, 0).real, equals(1)); + expect(svd[1](0, 0).imaginary, equals(0)); + expect(svd[1].rowCount, equals(1)); + expect(svd[1].columnCount, equals(1)); + + // V matrix + expect(svd[2](0, 0).real, equals(1)); + expect(svd[2](0, 0).imaginary, equals(0)); + expect(svd[2].rowCount, equals(1)); + expect(svd[2].columnCount, equals(1)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect(reconstructed(0, 0).real, equals(5)); + expect(reconstructed(0, 0).imaginary, equals(0)); + }); + + test('2x2 matrix with complex values', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.i(), Complex.fromReal(2)], + [Complex(7, 1), Complex.fromReal(6)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed(0, 0).real, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + expect( + reconstructed(0, 0).imaginary, + const MoreOrLessEquals(1, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).real, + const MoreOrLessEquals(2, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).imaginary, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).real, + const MoreOrLessEquals(7, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).imaginary, + const MoreOrLessEquals(1, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).real, + const MoreOrLessEquals(6, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).imaginary, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + }); + + test('3x2 matrix with complex values', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 2, + data: const [ + [Complex(1, 1), Complex(2, -1)], + [Complex(3, 2), Complex(4, -2)], + [Complex(5, 3), Complex(6, -3)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify dimensions + expect(svd[0].rowCount, equals(3)); + expect(svd[0].columnCount, equals(2)); + expect(svd[1].rowCount, equals(3)); + expect(svd[1].columnCount, equals(3)); + expect(svd[2].rowCount, equals(2)); + expect(svd[2].columnCount, equals(2)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 2; j++) { + expect( + reconstructed(i, j).real, + MoreOrLessEquals(matrix(i, j).real, precision: 1.0e-5), + ); + expect( + reconstructed(i, j).imaginary, + MoreOrLessEquals(matrix(i, j).imaginary, precision: 1.0e-5), + ); + } + } + }); + + test('Matrix with zero values', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.zero(), Complex.zero()], + [Complex.zero(), Complex.zero()], + ], + ); + + expect(matrix.singleValueDecomposition, throwsA(isA())); + }); + + test('Matrix with very small values', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1e-10, 1e-12), Complex(1e-14, 1e-16)], + [Complex(1e-18, 1e-20), Complex(1e-22, 1e-24)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed(0, 0).real, + const MoreOrLessEquals(1e-10, precision: 1.0e-5), + ); + expect( + reconstructed(0, 0).imaginary, + const MoreOrLessEquals(1e-12, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).real, + const MoreOrLessEquals(1e-14, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).imaginary, + const MoreOrLessEquals(1e-16, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).real, + const MoreOrLessEquals(1e-18, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).imaginary, + const MoreOrLessEquals(1e-20, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).real, + const MoreOrLessEquals(1e-22, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).imaginary, + const MoreOrLessEquals(1e-24, precision: 1.0e-5), + ); + }); + + test('Symmetric complex matrix', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [Complex(1, 1), Complex(2, -1), Complex(3, 2)], + [Complex(2, -1), Complex(4, 2), Complex(5, -2)], + [Complex(3, 2), Complex(5, -2), Complex(6, 3)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 3; j++) { + expect( + reconstructed(i, j).real, + MoreOrLessEquals(matrix(i, j).real, precision: 1.0e-5), + ); + expect( + reconstructed(i, j).imaginary, + MoreOrLessEquals(matrix(i, j).imaginary, precision: 1.0e-5), + ); + } + } + }); + + test('Matrix with repeated complex values', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [Complex(1, 1), Complex(1, 1), Complex(1, 1)], + [Complex(1, 1), Complex(1, 1), Complex(1, 1)], + [Complex(1, 1), Complex(1, 1), Complex(1, 1)], + ], + ); + + expect(matrix.singleValueDecomposition, throwsA(isA())); + }); + + test('Matrix with pure imaginary values', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex.i(), Complex(0, 2)], + [Complex(0, 3), Complex(0, 4)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed(0, 0).real, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + expect( + reconstructed(0, 0).imaginary, + const MoreOrLessEquals(1, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).real, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).imaginary, + const MoreOrLessEquals(2, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).real, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).imaginary, + const MoreOrLessEquals(3, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).real, + const MoreOrLessEquals(0, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).imaginary, + const MoreOrLessEquals(4, precision: 1.0e-5), + ); + }); + + test('Matrix with mixed real and imaginary values', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [Complex(1, 2), Complex(3, 4)], + [Complex(5, 6), Complex(7, 8)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed(0, 0).real, + const MoreOrLessEquals(1, precision: 1.0e-5), + ); + expect( + reconstructed(0, 0).imaginary, + const MoreOrLessEquals(2, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).real, + const MoreOrLessEquals(3, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1).imaginary, + const MoreOrLessEquals(4, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).real, + const MoreOrLessEquals(5, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0).imaginary, + const MoreOrLessEquals(6, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).real, + const MoreOrLessEquals(7, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1).imaginary, + const MoreOrLessEquals(8, precision: 1.0e-5), + ); + }); + + test('Matrix that triggers numerically singular exception', () { + final matrix = ComplexMatrix.fromData( + rows: 3, + columns: 4, + data: const [ + [Complex(1, 0), Complex(1, 0), Complex(1e-15, 0), Complex(1e-15, 0)], + [Complex(1, 0), Complex(1, 0), Complex(1e-15, 0), Complex(1e-15, 0)], + [Complex(1, 0), Complex(1, 0), Complex(1e-15, 0), Complex(1e-15, 0)], + ], + ); + + expect( + () => SVDComplex(matrix: matrix).decompose(), + throwsA(isA()), + ); + }); + + test('Matrix with very small singular value', () { + final matrix = ComplexMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [Complex(1, 0), Complex(0, 0), Complex(0, 0), Complex(1e-12, 0)], + [Complex(0, 0), Complex(1, 0), Complex(0, 0), Complex(1e-12, 0)], + [Complex(0, 0), Complex(0, 0), Complex(1, 0), Complex(1e-12, 0)], + [Complex(0, 0), Complex(0, 0), Complex(0, 0), Complex(1e-12, 0)], + ], + ); + + try { + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 4; i++) { + for (var j = 0; j < 4; j++) { + expect( + reconstructed(i, j).real, + MoreOrLessEquals(matrix(i, j).real, precision: 1.0e-5), + ); + } + } + } on Exception catch (e) { + expect(e, isA()); + } + }); + + test('Wide matrix (more columns than rows) to trigger edge cases', () { + final matrix = ComplexMatrix.fromData( + rows: 2, + columns: 4, + data: const [ + [Complex(1, 0), Complex(2, 0), Complex(3, 0), Complex(4, 0)], + [Complex(5, 0), Complex(6, 0), Complex(7, 0), Complex(8, 0)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + expect(svd[0].rowCount, equals(2)); + expect(svd[0].columnCount, equals(4)); + expect(svd[1].rowCount, equals(2)); + expect(svd[1].isSquareMatrix, isFalse); + expect(svd[2].rowCount, equals(4)); + expect(svd[2].columnCount, equals(4)); + + final uSubmatrix = ComplexMatrix.fromData( + rows: svd[1].rowCount, + columns: svd[1].rowCount, + data: List.generate( + svd[1].rowCount, + (i) => List.generate( + svd[1].rowCount, + (j) => svd[1](i, j), + ), + ), + ); + + final reconstructed = uSubmatrix * svd[0] * svd[2].transpose(); + for (var i = 0; i < 2; i++) { + for (var j = 0; j < 4; j++) { + expect( + reconstructed(i, j).real, + MoreOrLessEquals(matrix(i, j).real, precision: 1.0e-5), + ); + expect( + reconstructed(i, j).imaginary, + MoreOrLessEquals(matrix(i, j).imaginary, precision: 1.0e-5), + ); + } + } + }); + + test('Tall matrix (more rows than columns) to trigger edge cases', () { + final matrix = ComplexMatrix.fromData( + rows: 4, + columns: 2, + data: const [ + [Complex(1, 0), Complex(2, 0)], + [Complex(3, 0), Complex(4, 0)], + [Complex(5, 0), Complex(6, 0)], + [Complex(7, 0), Complex(8, 0)], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + expect(svd[0].rowCount, equals(4)); + expect(svd[0].columnCount, equals(2)); + expect(svd[1].rowCount, equals(4)); + expect(svd[1].columnCount, equals(4)); + expect(svd[2].rowCount, equals(2)); + expect(svd[2].columnCount, equals(2)); + }); + + test('Matrix to trigger case 2 convergence branch', () { + final matrix = ComplexMatrix.fromData( + rows: 5, + columns: 5, + data: const [ + [ + Complex(10, 0), + Complex(1, 0), + Complex(0, 0), + Complex(0, 0), + Complex(0, 0), + ], + [ + Complex(1, 0), + Complex(10, 0), + Complex(1, 0), + Complex(0, 0), + Complex(0, 0), + ], + [ + Complex(0, 0), + Complex(1, 0), + Complex(10, 0), + Complex(1, 0), + Complex(0, 0), + ], + [ + Complex(0, 0), + Complex(0, 0), + Complex(1, 0), + Complex(10, 0), + Complex(1, 0), + ], + [ + Complex(0, 0), + Complex(0, 0), + Complex(0, 0), + Complex(1, 0), + Complex(10, 0), + ], + ], + ); + + final svd = SVDComplex(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 5; i++) { + for (var j = 0; j < 5; j++) { + expect( + reconstructed(i, j).real, + MoreOrLessEquals(matrix(i, j).real, precision: 1.0e-4), + ); + expect( + reconstructed(i, j).imaginary, + MoreOrLessEquals(matrix(i, j).imaginary, precision: 1.0e-4), + ); + } + } + }); + }); +} diff --git a/test/system/utils/decompositions/singular_value_decomposition/svd_real_test.dart b/test/system/utils/decompositions/singular_value_decomposition/svd_real_test.dart new file mode 100644 index 00000000..2060e11e --- /dev/null +++ b/test/system/utils/decompositions/singular_value_decomposition/svd_real_test.dart @@ -0,0 +1,390 @@ +import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_real.dart'; +import 'package:test/test.dart'; + +import '../../../../double_approximation_matcher.dart'; + +void main() { + group('SVDReal class', () { + test('Equality tests', () { + final svd1 = SVDReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ); + + final svd2 = SVDReal( + matrix: RealMatrix.fromData( + rows: 1, + columns: 1, + data: [ + [1], + ], + ), + ); + + expect(svd1, equals(svd2)); + expect(svd1.hashCode, equals(svd2.hashCode)); + }); + + test('Empty matrix throws ArgumentError', () { + expect( + () => SVDReal( + matrix: RealMatrix.fromData(rows: 0, columns: 0, data: []), + ).decompose(), + throwsArgumentError, + ); + }); + + test('1x1 matrix decomposition', () { + final matrix = RealMatrix.fromData( + rows: 1, + columns: 1, + data: const [ + [5], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // E matrix + expect(svd[0](0, 0), equals(5)); + expect(svd[0].rowCount, equals(1)); + expect(svd[0].columnCount, equals(1)); + + // U matrix + expect(svd[1](0, 0), equals(1)); + expect(svd[1].rowCount, equals(1)); + expect(svd[1].columnCount, equals(1)); + + // V matrix + expect(svd[2](0, 0), equals(1)); + expect(svd[2].rowCount, equals(1)); + expect(svd[2].columnCount, equals(1)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect(reconstructed(0, 0), equals(5)); + }); + + test('2x2 matrix decomposition with negative values', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [-1, 2], + [3, -4], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed(0, 0), + const MoreOrLessEquals(-1, precision: 1.0e-5), + ); + expect(reconstructed(0, 1), const MoreOrLessEquals(2, precision: 1.0e-5)); + expect(reconstructed(1, 0), const MoreOrLessEquals(3, precision: 1.0e-5)); + expect( + reconstructed(1, 1), + const MoreOrLessEquals(-4, precision: 1.0e-5), + ); + }); + + test('3x2 matrix decomposition', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 2, + data: const [ + [1, 2], + [3, 4], + [5, 6], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify dimensions + expect(svd[0].rowCount, equals(3)); + expect(svd[0].columnCount, equals(2)); + expect(svd[1].rowCount, equals(3)); + expect(svd[1].columnCount, equals(3)); + expect(svd[2].rowCount, equals(2)); + expect(svd[2].columnCount, equals(2)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 2; j++) { + expect( + reconstructed(i, j), + MoreOrLessEquals(matrix(i, j), precision: 1.0e-5), + ); + } + } + }); + + test('Matrix with zero values', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [0, 0], + [0, 0], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect(reconstructed(0, 0), equals(0)); + expect(reconstructed(0, 1), equals(0)); + expect(reconstructed(1, 0), equals(0)); + expect(reconstructed(1, 1), equals(0)); + }); + + test('Matrix with very small values', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1e-10, 1e-12], + [1e-14, 1e-16], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed(0, 0), + const MoreOrLessEquals(1e-10, precision: 1.0e-5), + ); + expect( + reconstructed(0, 1), + const MoreOrLessEquals(1e-12, precision: 1.0e-5), + ); + expect( + reconstructed(1, 0), + const MoreOrLessEquals(1e-14, precision: 1.0e-5), + ); + expect( + reconstructed(1, 1), + const MoreOrLessEquals(1e-16, precision: 1.0e-5), + ); + }); + + test('Matrix with large values', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1e10, 1e12], + [1e14, 1e16], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + expect( + reconstructed.toString(), + equals(''' +[9999999999.994453, 999999999999.4453] +[100000000000000.0, 10000000000000000.0]'''), + ); + }); + + test('Symmetric matrix decomposition', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 2, 3], + [2, 4, 5], + [3, 5, 6], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 3; j++) { + expect( + reconstructed(i, j), + MoreOrLessEquals(matrix(i, j), precision: 1.0e-5), + ); + } + } + }); + + test('Matrix with repeated values', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 1, 1], + [1, 1, 1], + [1, 1, 1], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 3; i++) { + for (var j = 0; j < 3; j++) { + expect( + reconstructed(i, j), + const MoreOrLessEquals(1, precision: 1.0e-5), + ); + } + } + }); + + test('Wide matrix (more columns than rows) to trigger rowCount < p', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 4, + data: const [ + [1, 2, 3, 4], + [5, 6, 7, 8], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + expect(svd[0].rowCount, equals(2)); + expect(svd[0].columnCount, equals(4)); + expect(svd[1].rowCount, equals(2)); + expect(svd[1].columnCount, equals(4)); + expect(svd[2].rowCount, equals(4)); + expect(svd[2].columnCount, equals(4)); + }); + + test('Tall matrix (more rows than columns) to trigger edge cases', () { + final matrix = RealMatrix.fromData( + rows: 4, + columns: 2, + data: const [ + [1, 2], + [3, 4], + [5, 6], + [7, 8], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + expect(svd[0].rowCount, equals(4)); + expect(svd[0].columnCount, equals(2)); + expect(svd[1].rowCount, equals(4)); + expect(svd[1].columnCount, equals(4)); + expect(svd[2].rowCount, equals(2)); + expect(svd[2].columnCount, equals(2)); + }); + + test('Large square matrix to trigger various SVD edge cases', () { + final matrix = RealMatrix.fromData( + rows: 5, + columns: 5, + data: const [ + [1, 2, 3, 4, 5], + [6, 7, 8, 9, 10], + [11, 12, 13, 14, 15], + [16, 17, 18, 19, 20], + [21, 22, 23, 24, 25], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 5; i++) { + for (var j = 0; j < 5; j++) { + expect( + reconstructed(i, j), + MoreOrLessEquals(matrix(i, j), precision: 1.0e-4), + ); + } + } + }); + + test('Matrix to trigger case 2 convergence branch and sorting', () { + final matrix = RealMatrix.fromData( + rows: 4, + columns: 4, + data: const [ + [1, 2, 3, 4], + [5, 6, 7, 8], + [9, 10, 11, 12], + [13, 14, 15, 16], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 4; i++) { + for (var j = 0; j < 4; j++) { + expect( + reconstructed(i, j), + MoreOrLessEquals(matrix(i, j), precision: 1.0e-4), + ); + } + } + }); + + test('Matrix to trigger negative shift branch', () { + final matrix = RealMatrix.fromData( + rows: 5, + columns: 5, + data: const [ + [10, 1, 0, 0, 0], + [1, 10, 1, 0, 0], + [0, 1, 10, 1, 0], + [0, 0, 1, 10, 1], + [0, 0, 0, 1, 10], + ], + ); + + final svd = SVDReal(matrix: matrix).decompose(); + expect(svd.length, equals(3)); + + // Verify U * E * V^T = original matrix + final reconstructed = svd[1] * svd[0] * svd[2].transpose(); + for (var i = 0; i < 5; i++) { + for (var j = 0; j < 5; j++) { + expect( + reconstructed(i, j), + MoreOrLessEquals(matrix(i, j), precision: 1.0e-4), + ); + } + } + }); + }); +} diff --git a/test/system/utils/real_matrix_test.dart b/test/system/utils/real_matrix_test.dart index aa387ef7..16a09cf4 100644 --- a/test/system/utils/real_matrix_test.dart +++ b/test/system/utils/real_matrix_test.dart @@ -1,15 +1,15 @@ import 'package:equations/equations.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/eigenvalue_decomposition/eigendecomposition_real.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/qr_decomposition/qr_real_decomposition.dart'; +import 'package:equations/src/system/utils/matrix/decompositions/singular_value_decomposition/svd_real.dart'; import 'package:test/test.dart'; import '../../double_approximation_matcher.dart'; void main() { - group("Testing the constructors of the 'RealMatrix' class", () { - test('Making sure that a new matrix is initialized with 0s.', () { - final matrix = RealMatrix( - columns: 5, - rows: 3, - ); + group('RealMatrix', () { + test('Smoke test', () { + final matrix = RealMatrix(columns: 5, rows: 3); // Checking the sizes expect(matrix.rowCount, equals(3)); @@ -25,217 +25,184 @@ void main() { } }); - test( - 'Making sure that an exception is thrown when the user tries to ' - 'build a matrix whose row or column count is zero.', - () { - expect( - () => RealMatrix(columns: 0, rows: 2), - throwsA(isA()), - ); - }, - ); + test('Matrix validation test', () { + expect( + () => RealMatrix(columns: 0, rows: 2), + throwsA(isA()), + ); - test( - 'Making sure that the identity matrix is filled with 0s except for ' - 'its diagonal, which must contain all 1s.', - () { - final matrix = RealMatrix(columns: 3, rows: 3, identity: true); + expect( + () => RealMatrix(columns: 2, rows: 2, identity: true)(12, 1), + throwsA(isA()), + ); - // Checking the sizes - expect(matrix.rowCount, equals(3)); - expect(matrix.columnCount, equals(3)); + expect( + () => RealMatrix(columns: 2, rows: 2, identity: true)(1, 12), + throwsA(isA()), + ); + }); - // Checking the content of the matrix - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(1)); - } else { - expect(matrix(i, j), isZero); - } - expect(matrix(i, j), equals(matrix.itemAt(i, j))); + test('isZero', () { + final matrix = RealMatrix(columns: 2, rows: 2); + expect(matrix.isZero(), isTrue); + }); + + test('Identity matrix has all zeroes except for the diagonal', () { + final matrix = RealMatrix(columns: 3, rows: 3, identity: true); + + // Checking the sizes + expect(matrix.rowCount, equals(3)); + expect(matrix.columnCount, equals(3)); + + // Checking the content of the matrix + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(1)); + } else { + expect(matrix(i, j), isZero); } + expect(matrix(i, j), equals(matrix.itemAt(i, j))); } - }, - ); + } + }); - test( - 'Making sure that an exception is thrown when the user tries to ' - 'build an identity matrix with a non-squared entry.', - () { - expect( - () => RealMatrix(columns: 3, rows: 5, identity: true), - throwsA(isA()), - ); - }, - ); + test('Exception is thrown if identity matrix is non-square.', () { + expect( + () => RealMatrix(columns: 3, rows: 5, identity: true), + throwsA(isA()), + ); + }); - test( - "Making sure that the matrix can correctly be 'flattened' and converted" - " into a list of 'double' values.", - () { - final matrix = RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 2], - [3, 4], - ], - ); + test('Matrix can be flattened into a list of doubles.', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [3, 4], + ], + ); - // Checking the sizes - final flattenedMatrix = matrix.toList(); + // Checking the sizes + final flattenedMatrix = matrix.toList(); - expect(flattenedMatrix.length, equals(4)); - expect(flattenedMatrix, orderedEquals([1, 2, 3, 4])); - }, - ); + expect(flattenedMatrix.length, equals(4)); + expect(flattenedMatrix, orderedEquals([1, 2, 3, 4])); + }); - test( - "Making sure that the matrix can correctly be created from a 'flattened' " - 'list of values.', - () { - final matrix = RealMatrix.fromFlattenedData( - rows: 2, - columns: 2, - data: [1, 2, 3, 4], - ); + test('Matrix can be created from a flattened list of values.', () { + final matrix = RealMatrix.fromFlattenedData( + rows: 2, + columns: 2, + data: [1, 2, 3, 4], + ); - expect(matrix.rowCount * matrix.columnCount, equals(4)); - expect( - matrix, - equals( - RealMatrix.fromData( - rows: 2, - columns: 2, - data: [ - [1, 2], - [3, 4], - ], - ), + expect(matrix.rowCount * matrix.columnCount, equals(4)); + expect( + matrix, + equals( + RealMatrix.fromData( + rows: 2, + columns: 2, + data: [ + [1, 2], + [3, 4], + ], ), - ); - }, - ); + ), + ); + }); - test( - 'Making sure that a diagonal, square matrix is correctly build with ' - 'the given value in the diagonal', - () { - final matrix = RealMatrix.diagonal( - rows: 3, - columns: 3, - diagonalValue: 8, - ); + test('Diagonal matrix can be created.', () { + final matrix = RealMatrix.diagonal(rows: 3, columns: 3, diagonalValue: 8); - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(8)); - } else { - expect(matrix(i, j), isZero); - } + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(8)); + } else { + expect(matrix(i, j), isZero); } } + } - const stringRepresentation = '[8.0, 0.0, 0.0]\n' - '[0.0, 8.0, 0.0]\n' - '[0.0, 0.0, 8.0]'; + const stringRepresentation = + '[8.0, 0.0, 0.0]\n' + '[0.0, 8.0, 0.0]\n' + '[0.0, 0.0, 8.0]'; - expect('$matrix', equals(stringRepresentation)); - }, - ); + expect('$matrix', equals(stringRepresentation)); + }); - test( - 'Making sure that a diagonal, non square matrix is correctly build ' - 'with the given value in the diagonal', - () { - final matrix = RealMatrix.diagonal( - rows: 3, - columns: 5, - diagonalValue: 8, - ); + test('Diagonal non square matrix is created wit the given value', () { + final matrix = RealMatrix.diagonal(rows: 3, columns: 5, diagonalValue: 8); - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(8)); - } else { - expect(matrix(i, j), isZero); - } + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(8)); + } else { + expect(matrix(i, j), isZero); } } + } - const stringRepresentation = '[8.0, 0.0, 0.0, 0.0, 0.0]\n' - '[0.0, 8.0, 0.0, 0.0, 0.0]\n' - '[0.0, 0.0, 8.0, 0.0, 0.0]'; + const stringRepresentation = + '[8.0, 0.0, 0.0, 0.0, 0.0]\n' + '[0.0, 8.0, 0.0, 0.0, 0.0]\n' + '[0.0, 0.0, 8.0, 0.0, 0.0]'; - expect('$matrix', equals(stringRepresentation)); - }, - ); + expect('$matrix', equals(stringRepresentation)); + }); - test( - 'Making sure that a diagonal, non square matrix is correctly build ' - 'with the given value in the diagonal', - () { - final matrix = RealMatrix.diagonal( - rows: 6, - columns: 2, - diagonalValue: 1, - ); + test('Diagonal, non square matrix', () { + final matrix = RealMatrix.diagonal(rows: 6, columns: 2, diagonalValue: 1); - for (var i = 0; i < matrix.rowCount; ++i) { - for (var j = 0; j < matrix.columnCount; ++j) { - if (i == j) { - expect(matrix(i, j), equals(1)); - } else { - expect(matrix(i, j), isZero); - } + for (var i = 0; i < matrix.rowCount; ++i) { + for (var j = 0; j < matrix.columnCount; ++j) { + if (i == j) { + expect(matrix(i, j), equals(1)); + } else { + expect(matrix(i, j), isZero); } } + } - const stringRepresentation = '[1.0, 0.0]\n' - '[0.0, 1.0]\n' - '[0.0, 0.0]\n' - '[0.0, 0.0]\n' - '[0.0, 0.0]\n' - '[0.0, 0.0]'; + const stringRepresentation = + '[1.0, 0.0]\n' + '[0.0, 1.0]\n' + '[0.0, 0.0]\n' + '[0.0, 0.0]\n' + '[0.0, 0.0]\n' + '[0.0, 0.0]'; - expect('$matrix', equals(stringRepresentation)); - }, - ); + expect('$matrix', equals(stringRepresentation)); + }); - test( - 'Making sure that a diagonal of a single element is correctly built', - () { - final matrix = RealMatrix.diagonal( - rows: 1, - columns: 1, - diagonalValue: 31, - ); + test('Diagonal of a single element', () { + final matrix = RealMatrix.diagonal( + rows: 1, + columns: 1, + diagonalValue: 31, + ); - expect(matrix(0, 0), equals(31)); - expect('$matrix', equals('[31.0]')); - }, - ); + expect(matrix(0, 0), equals(31)); + expect('$matrix', equals('[31.0]')); + }); - test( - 'Making sure that an exception is thrown when the matrix is being built ' - 'from a list but the sizes are wrong', - () { - expect( - () => RealMatrix.fromFlattenedData( - rows: 6, - columns: 2, - data: [1, 2, 3, 4], - ), - throwsA(isA()), - ); - }, - ); + test('Exception if sizes and array length do not match', () { + expect( + () => RealMatrix.fromFlattenedData( + rows: 6, + columns: 2, + data: [1, 2, 3, 4], + ), + throwsA(isA()), + ); + }); - test("Making sure that 'toString()' works as expected.", () { + test('String conversion test', () { final matrix = RealMatrix.fromData( columns: 3, rows: 3, @@ -246,50 +213,44 @@ void main() { ], ); - const expected = '[1.0, 2.0, 3.0]\n' + const expected = + '[1.0, 2.0, 3.0]\n' '[4.0, 5.0, 6.0]\n' '[7.0, 8.0, 9.0]'; expect(matrix.toString(), equals(expected)); }); - test( - 'Making sure that a matrix is properly built from a list of lists ' - 'entries.', - () { - final matrix = RealMatrix.fromData( - columns: 3, - rows: 3, - data: const [ - [1, 2, 3], - [4, 5, 6], - [7, 8, 9], - ], - ); + test('Matrix creation from list of lists', () { + final matrix = RealMatrix.fromData( + columns: 3, + rows: 3, + data: const [ + [1, 2, 3], + [4, 5, 6], + [7, 8, 9], + ], + ); - // Checking the sizes - expect(matrix.rowCount, equals(3)); - expect(matrix.columnCount, equals(3)); - - // Checking the content of the matrix - expect(matrix(0, 0), equals(1)); - expect(matrix(0, 1), equals(2)); - expect(matrix(0, 2), equals(3)); - expect(matrix(1, 0), equals(4)); - expect(matrix(1, 1), equals(5)); - expect(matrix(1, 2), equals(6)); - expect(matrix(2, 0), equals(7)); - expect(matrix(2, 1), equals(8)); - expect(matrix(2, 2), equals(9)); - }, - ); + // Checking the sizes + expect(matrix.rowCount, equals(3)); + expect(matrix.columnCount, equals(3)); + + // Checking the content of the matrix + expect(matrix(0, 0), equals(1)); + expect(matrix(0, 1), equals(2)); + expect(matrix(0, 2), equals(3)); + expect(matrix(1, 0), equals(4)); + expect(matrix(1, 1), equals(5)); + expect(matrix(1, 2), equals(6)); + expect(matrix(2, 0), equals(7)); + expect(matrix(2, 1), equals(8)); + expect(matrix(2, 2), equals(9)); + }); }); - group("Testing equality of 'RealMatrix' objects", () { - test('Making sure that objects comparison works properly.', () { - final matrix = RealMatrix( - columns: 2, - rows: 2, - ); + group('Equality', () { + test('Objects comparison works properly.', () { + final matrix = RealMatrix(columns: 2, rows: 2); // Equality tests expect(RealMatrix(columns: 2, rows: 2), equals(matrix)); @@ -299,18 +260,8 @@ void main() { expect(RealMatrix(columns: 2, rows: 2).hashCode, equals(matrix.hashCode)); expect( - RealMatrix.fromFlattenedData( - rows: 1, - columns: 1, - data: [5.0], - ), - equals( - RealMatrix.fromFlattenedData( - rows: 1, - columns: 1, - data: [5.0], - ), - ), + RealMatrix.fromFlattenedData(rows: 1, columns: 1, data: [5.0]), + equals(RealMatrix.fromFlattenedData(rows: 1, columns: 1, data: [5.0])), ); expect( @@ -331,7 +282,7 @@ void main() { }); }); - group("Testing operators on 'RealMatrix' (+, *, - and /)", () { + group('Operators', () { /* * A = | 2 6 | * | -5 0 | @@ -358,7 +309,7 @@ void main() { ], ); - test('Making sure that operator+ works properly.', () { + test('operator+', () { final matrixSum = RealMatrix.fromData( columns: 2, rows: 2, @@ -370,7 +321,7 @@ void main() { expect(matrixA + matrixB, equals(matrixSum)); }); - test('Making sure that operator+ works on rectangular matrices too.', () { + test('operator+ on rectangular matrices', () { final matrixA = RealMatrix.fromData( columns: 2, rows: 3, @@ -407,7 +358,7 @@ void main() { ); }); - test('Making sure that operator- works properly.', () { + test('operator-', () { final matrixSub = RealMatrix.fromData( columns: 2, rows: 2, @@ -419,7 +370,7 @@ void main() { expect(matrixA - matrixB, equals(matrixSub)); }); - test('Making sure that operator- works on rectangular matrices too.', () { + test('operator- on rectangular matrices', () { final matrixA = RealMatrix.fromData( columns: 2, rows: 3, @@ -456,7 +407,7 @@ void main() { ); }); - test('Making sure that operator* works properly.', () { + test('operator*', () { final matrixMul = RealMatrix.fromData( columns: 2, rows: 2, @@ -468,7 +419,7 @@ void main() { expect(matrixA * matrixB, equals(matrixMul)); }); - test('Making sure that operator* works on rectangular matrices too.', () { + test('operator* on rectangular matrices', () { final matrixA = RealMatrix.fromData( columns: 2, rows: 2, @@ -499,7 +450,7 @@ void main() { expect(matrixA * matrixB, equals(matrixMul)); }); - test('Making sure that operator/ works properly.', () { + test('operator/', () { final matrixDiv = RealMatrix.fromData( columns: 2, rows: 2, @@ -511,7 +462,7 @@ void main() { expect(matrixA / matrixB, equals(matrixDiv)); }); - test('Making sure that operator/ works on rectangular matrices too.', () { + test('operator/ on rectangular matrices', () { final matrixA = RealMatrix.fromData( columns: 2, rows: 3, @@ -549,7 +500,7 @@ void main() { }); test( - 'operator+, operator- and operator/ on matrices of different sizes fails', + 'operator+, operator- and operator/ on different sized matrices', () { final otherMatrix = RealMatrix.fromFlattenedData( rows: 1, @@ -557,42 +508,27 @@ void main() { data: [1], ); - expect( - () => matrixA + otherMatrix, - throwsA(isA()), - ); + expect(() => matrixA + otherMatrix, throwsA(isA())); - expect( - () => matrixA - otherMatrix, - throwsA(isA()), - ); + expect(() => matrixA - otherMatrix, throwsA(isA())); - expect( - () => matrixA / otherMatrix, - throwsA(isA()), - ); + expect(() => matrixA / otherMatrix, throwsA(isA())); }, ); - test( - 'operator* fails if rows and columns have no matching sizes', - () { - final otherMatrix = RealMatrix.fromFlattenedData( - rows: 1, - columns: 2, - data: [1, 3], - ); + test('operator* on different sized matrices', () { + final otherMatrix = RealMatrix.fromFlattenedData( + rows: 1, + columns: 2, + data: [1, 3], + ); - expect( - () => matrixA * otherMatrix, - throwsA(isA()), - ); - }, - ); + expect(() => matrixA * otherMatrix, throwsA(isA())); + }); }); - group('Testing the computation of the determinant.', () { - test('Making sure that the determinant of an 1*1 matrix is correct.', () { + group('Determinant', () { + test('Determinant of a 1x1 matrix', () { final matrix = RealMatrix.fromData( columns: 1, rows: 1, @@ -603,7 +539,7 @@ void main() { expect(matrix.determinant(), equals(-5)); }); - test('Making sure that the determinant of a 2*2 matrix is correct.', () { + test('Determinant of a 2x2 matrix', () { final matrix = RealMatrix.fromData( columns: 2, rows: 2, @@ -615,7 +551,7 @@ void main() { expect(matrix.determinant(), equals(78)); }); - test('Making sure that the determinant of a 3*3 matrix is correct.', () { + test('Determinant of a 3x3 matrix', () { final matrix = RealMatrix.fromData( columns: 3, rows: 3, @@ -628,7 +564,7 @@ void main() { expect(matrix.determinant(), equals(-45)); }); - test('Making sure that the determinant of a 4*4 matrix is correct.', () { + test('Determinant of a 4x4 matrix', () { final matrix = RealMatrix.fromData( columns: 4, rows: 4, @@ -642,148 +578,253 @@ void main() { expect(matrix.determinant(), equals(271)); }); - test( - 'Making sure that the determinant of a 5*5 (or greater) matrix is ' - 'correct.', - () { - final matrix = RealMatrix.fromData( - columns: 5, - rows: 5, - data: [ - [2, -1, 13, 4, 1], - [11, 0, 5, 1, 7], - [6, -4, 7, 2, -6], - [1, 0, -3, -6, 9], - [7, 0, 3, -4, 1], - ], - ); - expect( - matrix.determinant(), - const MoreOrLessEquals(-28398, precision: 0.1), - ); - }, - ); + test('Determinant of a 5x5 (or greater) matrix', () { + final matrix = RealMatrix.fromData( + columns: 5, + rows: 5, + data: [ + [2, -1, 13, 4, 1], + [11, 0, 5, 1, 7], + [6, -4, 7, 2, -6], + [1, 0, -3, -6, 9], + [7, 0, 3, -4, 1], + ], + ); + expect( + matrix.determinant(), + const MoreOrLessEquals(-28398, precision: 0.1), + ); + }); }); - group('Testing operations on matrices.', () { - test( - 'Making sure that the LU decomposition properly works on a square ' - 'matrix of a given dimension.', - () { - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [1, 2, 3], - [4, 5, 6], - [7, 8, 9], - ], - ); + group('API', () { + test('LU decomposition on square matrix', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [1, 2, 3], + [4, 5, 6], + [7, 8, 9], + ], + ); - // Decomposition - final lu = matrix.luDecomposition(); - expect(lu.length, equals(2)); - - // Checking L - final L = lu.first; - expect(L.rowCount, equals(matrix.rowCount)); - expect(L.columnCount, equals(matrix.columnCount)); - expect(L.isSquareMatrix, isTrue); - expect( - L.flattenData, - orderedEquals([1, 0, 0, 4, 1, 0, 7, 2, 1]), - ); + // Decomposition + final lu = matrix.luDecomposition(); + expect(lu.length, equals(3)); // Now returns [L, U, P] + + // Checking L + final L = lu[0]; + expect(L.rowCount, equals(matrix.rowCount)); + expect(L.columnCount, equals(matrix.columnCount)); + expect(L.isSquareMatrix, isTrue); + // L should be lower triangular with 1s on diagonal + for (var i = 0; i < L.rowCount; i++) { + expect(L(i, i), equals(1.0)); + for (var j = i + 1; j < L.columnCount; j++) { + expect(L(i, j), equals(0.0)); + } + } - // Checking U - final U = lu[1]; - expect(U.rowCount, equals(matrix.rowCount)); - expect(U.columnCount, equals(matrix.columnCount)); - expect(U.isSquareMatrix, isTrue); - expect( - U.flattenData, - orderedEquals([1, 2, 3, 0, -3, -6, 0, 0, 0]), - ); - }, - ); + // Checking U + final U = lu[1]; + expect(U.rowCount, equals(matrix.rowCount)); + expect(U.columnCount, equals(matrix.columnCount)); + expect(U.isSquareMatrix, isTrue); + // U should be upper triangular + for (var i = 0; i < U.rowCount; i++) { + for (var j = 0; j < i; j++) { + expect(U(i, j), equals(0.0)); + } + } - test( - "Making sure that the LU decomposition doesn't work when the matrix " - 'is not square.', - () { - final matrix = RealMatrix.fromData( - rows: 2, - columns: 3, - data: const [ - [1, 2, 3], - [4, 5, 6], - ], - ); + // Checking P (permutation matrix) + final P = lu[2]; + expect(P.rowCount, equals(matrix.rowCount)); + expect(P.columnCount, equals(matrix.columnCount)); + expect(P.isSquareMatrix, isTrue); + // P should be a permutation matrix (each row and column has one 1) + for (var i = 0; i < P.rowCount; i++) { + var rowSum = 0.0; + var colSum = 0.0; + for (var j = 0; j < P.columnCount; j++) { + rowSum += P(i, j); + colSum += P(j, i); + expect(P(i, j) == 0.0 || P(i, j) == 1.0, isTrue); + } + expect(rowSum, equals(1.0)); + expect(colSum, equals(1.0)); + } - // Decomposition - expect(matrix.luDecomposition, throwsA(isA())); - }, - ); + // Verify PA = LU (with pivoting, we have PA = LU) + final pA = P * matrix; + final luMatrix = L * U; + for (var i = 0; i < pA.rowCount; i++) { + for (var j = 0; j < pA.columnCount; j++) { + expect( + pA(i, j), + MoreOrLessEquals(luMatrix(i, j), precision: 1.0e-10), + ); + } + } + }); + + test('LU decomposition on non-square matrix', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 3, + data: const [ + [1, 2, 3], + [4, 5, 6], + ], + ); + + // Decomposition + expect(matrix.luDecomposition, throwsA(isA())); + }); + + test('Cholesky decomposition on square matrix', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 3, + data: const [ + [25, 15, -5], + [15, 18, 0], + [-5, 0, 11], + ], + ); + + // Decomposition + final cholesky = matrix.choleskyDecomposition(); + expect(cholesky.length, equals(2)); + + // Checking L + final L = cholesky.first; + expect( + L.flattenData, + orderedEquals([5, 0, 0, 3, 3, 0, -1, 1, 3]), + ); + expect(L.rowCount, equals(matrix.rowCount)); + expect(L.columnCount, equals(matrix.columnCount)); + expect(L.isSquareMatrix, isTrue); + + // Checking Lt + final transposedL = cholesky[1]; + expect( + transposedL.flattenData, + orderedEquals([5, 3, -1, 0, 3, 1, 0, 0, 3]), + ); + expect(transposedL.rowCount, equals(matrix.rowCount)); + expect(transposedL.columnCount, equals(matrix.columnCount)); + expect(transposedL.isSquareMatrix, isTrue); + }); + + test('Cholesky decomposition on non-square matrix', () { + final matrix = RealMatrix.fromData( + rows: 3, + columns: 2, + data: const [ + [1, 2], + [3, 4], + [5, 6], + ], + ); + + // Decomposition + expect(matrix.choleskyDecomposition, throwsA(isA())); + }); test( - 'Making sure that Cholesky decomposition properly works on a square ' - 'matrix of a given dimension.', + 'Cholesky decomposition on large matrix to trigger block processing', () { - final matrix = RealMatrix.fromData( - rows: 3, - columns: 3, - data: const [ - [25, 15, -5], - [15, 18, 0], - [-5, 0, 11], - ], - ); + final data = >[]; + for (var i = 0; i < 40; i++) { + final row = []; + for (var j = 0; j < 40; j++) { + if (i == j) { + row.add(40.0 + i); + } else { + row.add(0.1); + } + } + data.add(row); + } + + final matrix = RealMatrix.fromData(rows: 40, columns: 40, data: data); - // Decomposition final cholesky = matrix.choleskyDecomposition(); expect(cholesky.length, equals(2)); - // Checking L - final L = cholesky.first; - expect( - L.flattenData, - orderedEquals([5, 0, 0, 3, 3, 0, -1, 1, 3]), - ); - expect(L.rowCount, equals(matrix.rowCount)); - expect(L.columnCount, equals(matrix.columnCount)); - expect(L.isSquareMatrix, isTrue); - - // Checking Lt - final transposedL = cholesky[1]; - expect( - transposedL.flattenData, - orderedEquals([5, 3, -1, 0, 3, 1, 0, 0, 3]), - ); - expect(transposedL.rowCount, equals(matrix.rowCount)); - expect(transposedL.columnCount, equals(matrix.columnCount)); - expect(transposedL.isSquareMatrix, isTrue); + final L = cholesky[0]; + final lt = cholesky[1]; + final reconstructed = L * lt; + + for (var i = 0; i < 40; i++) { + for (var j = 0; j < 40; j++) { + expect( + reconstructed(i, j), + MoreOrLessEquals(matrix(i, j), precision: 1.0e-5), + ); + } + } }, ); - test( - "Making sure that the Cholesky decomposition doesn't work when the " - 'matrix is not square.', - () { - final matrix = RealMatrix.fromData( - rows: 3, - columns: 2, - data: const [ - [1, 2], - [3, 4], - [5, 6], - ], - ); + test('qrDecomposition', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ); - // Decomposition - expect(matrix.choleskyDecomposition, throwsA(isA())); - }, - ); + expect( + matrix.qrDecomposition(), + orderedEquals( + QRDecompositionReal(matrix: matrix).decompose(), + ), + ); + }); - test('Making sure that the transposed view is correct', () { + test('svdDecomposition', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ); + + expect( + matrix.singleValueDecomposition(), + orderedEquals( + SVDReal(matrix: matrix).decompose(), + ), + ); + }); + + test('eigenDecomposition', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 2, + data: const [ + [1, 2], + [3, 4], + ], + ); + + expect( + matrix.eigenDecomposition(), + orderedEquals( + EigendecompositionReal(matrix: matrix).decompose(), + ), + ); + }); + + test('transposedValue', () { final matrix = RealMatrix.fromData( rows: 2, columns: 3, @@ -801,7 +842,7 @@ void main() { expect(matrix.transposedValue(2, 1), equals(8)); }); - test('Making sure that the transposed of a square matri is correct', () { + test('transpose on square matrix', () { final matrix = RealMatrix.fromData( rows: 2, columns: 2, @@ -818,7 +859,7 @@ void main() { expect(transposed(1, 1), equals(4)); }); - test('Making sure that the transposed of a rectang. matrix is correct', () { + test('transpose on rectangular matrix', () { final matrix = RealMatrix.fromData( rows: 2, columns: 3, @@ -837,7 +878,7 @@ void main() { expect(transposed(2, 1), equals(8)); }); - test('Making sure that minors are correctly generated', () { + test('minors', () { final matrix = RealMatrix.fromData( rows: 3, columns: 3, @@ -850,34 +891,18 @@ void main() { // Removing (0; 0) final minor1 = matrix.minor(0, 0); - expect( - minor1.flattenData, - orderedEquals( - [5, 6, 1, 2], - ), - ); + expect(minor1.flattenData, orderedEquals([5, 6, 1, 2])); // Removing (1; 2) final minor2 = matrix.minor(1, 2); - expect( - minor2.flattenData, - orderedEquals( - [2, 3, 1, 1], - ), - ); + expect(minor2.flattenData, orderedEquals([2, 3, 1, 1])); // Errors - expect( - () => matrix.minor(-1, 2), - throwsA(isA()), - ); - expect( - () => matrix.minor(11, 2), - throwsA(isA()), - ); + expect(() => matrix.minor(-1, 2), throwsA(isA())); + expect(() => matrix.minor(11, 2), throwsA(isA())); }); - test('Making sure that the cofactor matrix is correctly computed', () { + test('cofactorMatrix', () { final matrixSize2 = RealMatrix.fromData( rows: 2, columns: 2, @@ -921,41 +946,33 @@ void main() { expect(matrixSize3.cofactorMatrix(), equals(cofactorMatrixSize3)); }); - test( - 'Making sure that the cofactor matrix is NOT computed if the source ' - 'matrix is NOT square', - () { - final matrix = RealMatrix.fromData( - rows: 2, - columns: 1, - data: const [ - [2], - [8], - ], - ); + test('cofactorMatrix on non-square matrix', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 1, + data: const [ + [2], + [8], + ], + ); - expect(matrix.cofactorMatrix, throwsA(isA())); - }, - ); + expect(matrix.cofactorMatrix, throwsA(isA())); + }); - test( - 'Making sure that the inverse matrix is NOT computed if the source ' - 'matrix is NOT square', - () { - final matrix = RealMatrix.fromData( - rows: 2, - columns: 1, - data: const [ - [2], - [8], - ], - ); + test('inverse on non-square matrix', () { + final matrix = RealMatrix.fromData( + rows: 2, + columns: 1, + data: const [ + [2], + [8], + ], + ); - expect(matrix.inverse, throwsA(isA())); - }, - ); + expect(matrix.inverse, throwsA(isA())); + }); - test('Making sure that the inverse of a 2x2 matrix is correct', () { + test('inverse of a 2x2 matrix', () { final matrix = RealMatrix.fromData( rows: 2, columns: 2, @@ -969,21 +986,12 @@ void main() { matrix(0, 0), const MoreOrLessEquals(-0.214286, precision: 1.0e-6), ); - expect( - matrix(0, 1), - const MoreOrLessEquals(0.142857, precision: 1.0e-6), - ); - expect( - matrix(1, 0), - const MoreOrLessEquals(0.071428, precision: 1.0e-6), - ); - expect( - matrix(1, 1), - const MoreOrLessEquals(0.285714, precision: 1.0e-6), - ); + expect(matrix(0, 1), const MoreOrLessEquals(0.142857, precision: 1.0e-6)); + expect(matrix(1, 0), const MoreOrLessEquals(0.071428, precision: 1.0e-6)); + expect(matrix(1, 1), const MoreOrLessEquals(0.285714, precision: 1.0e-6)); }); - test('Making sure that the inverse of a matrix is correct', () { + test('inverse', () { final matrix = RealMatrix.fromData( rows: 3, columns: 3, @@ -994,18 +1002,12 @@ void main() { ], ).inverse(); - expect( - matrix(0, 0), - const MoreOrLessEquals(0.159091, precision: 1.0e-6), - ); + expect(matrix(0, 0), const MoreOrLessEquals(0.159091, precision: 1.0e-6)); expect( matrix(0, 1), const MoreOrLessEquals(-0.068181, precision: 1.0e-6), ); - expect( - matrix(0, 2), - const MoreOrLessEquals(0.159091, precision: 1.0e-6), - ); + expect(matrix(0, 2), const MoreOrLessEquals(0.159091, precision: 1.0e-6)); expect( matrix(1, 0), const MoreOrLessEquals(-0.681818, precision: 1.0e-6), @@ -1014,25 +1016,19 @@ void main() { matrix(1, 1), const MoreOrLessEquals(-0.136364, precision: 1.0e-6), ); - expect( - matrix(1, 2), - const MoreOrLessEquals(0.318182, precision: 1.0e-6), - ); + expect(matrix(1, 2), const MoreOrLessEquals(0.318182, precision: 1.0e-6)); expect( matrix(2, 0), const MoreOrLessEquals(-0.090909, precision: 1.0e-6), ); - expect( - matrix(2, 1), - const MoreOrLessEquals(0.181818, precision: 1.0e-6), - ); + expect(matrix(2, 1), const MoreOrLessEquals(0.181818, precision: 1.0e-6)); expect( matrix(2, 2), const MoreOrLessEquals(-0.090909, precision: 1.0e-6), ); }); - test('Making sure that the trace is correctly computed', () { + test('trace', () { final matrix = RealMatrix.fromData( rows: 2, columns: 2, @@ -1045,7 +1041,7 @@ void main() { expect(matrix.trace(), equals(11)); }); - test('Making sure that the trace only computed on square matrices', () { + test('trace only computed on square matrices', () { final matrix = RealMatrix.fromData( rows: 2, columns: 3, @@ -1058,7 +1054,7 @@ void main() { expect(matrix.trace, throwsA(isA())); }); - test('Making sure that symmetric matrices are correctly identified.', () { + test('isSymmetric', () { final symmetric = RealMatrix.fromData( rows: 3, columns: 3, @@ -1084,7 +1080,7 @@ void main() { expect(notSymmetric.isSymmetric(), isFalse); }); - test('Making sure that diagonal matrices are correctly identified.', () { + test('isDiagonal', () { final diagonal = RealMatrix.fromData( rows: 3, columns: 3, @@ -1121,7 +1117,7 @@ void main() { expect(notDiagonal.isDiagonal(), isFalse); }); - test('Making sure that identity matrices are correctly identified.', () { + test('isIdentity', () { final diagonal = RealMatrix.fromData( rows: 3, columns: 3, @@ -1149,7 +1145,7 @@ void main() { expect(notDiagonal.isIdentity(), isFalse); }); - test('Making sure that identity matrix is only computed when square.', () { + test('isIdentity only computed on square matrices', () { final identity = RealMatrix.fromData( rows: 3, columns: 2, @@ -1163,7 +1159,7 @@ void main() { expect(identity.isIdentity, throwsA(isA())); }); - test('Making sure that the rank can correctly be computed.', () { + test('rank', () { final rank = RealMatrix.fromData( rows: 2, columns: 2, @@ -1219,7 +1215,7 @@ void main() { expect(rectangularRank2.rank(), equals(1)); }); - test('Making sure that eigenvalues can be computed (1x1 matrices)', () { + test('eigenvalues for 1x1 matrices', () { final matrix = RealMatrix.fromData( rows: 1, columns: 1, @@ -1234,7 +1230,7 @@ void main() { expect(eigenvalues.first, equals(const Complex.fromReal(-16))); }); - test('Making sure that eigenvalues can be computed (2x2 matrices)', () { + test('eigenvalues for 2x2 matrices', () { final matrix = RealMatrix.fromData( rows: 2, columns: 2, @@ -1255,17 +1251,11 @@ void main() { eigenvalues[1].real, const MoreOrLessEquals(2.2679, precision: 1.0e-4), ); - expect( - eigenvalues.first.imaginary, - isZero, - ); - expect( - eigenvalues[1].imaginary, - isZero, - ); + expect(eigenvalues.first.imaginary, isZero); + expect(eigenvalues[1].imaginary, isZero); }); - test('Making sure that eigenvalues can be computed (3x3 matrices)', () { + test('eigenvalues for 3x3 matrices', () { final matrix = RealMatrix.fromData( rows: 3, columns: 3, @@ -1287,10 +1277,7 @@ void main() { eigenvalues[1].real, const MoreOrLessEquals(-1.1168, precision: 1.0e-4), ); - expect( - eigenvalues[2].real, - const MoreOrLessEquals(0, precision: 1.0e-4), - ); + expect(eigenvalues[2].real, const MoreOrLessEquals(0, precision: 1.0e-4)); expect( eigenvalues.first.imaginary, const MoreOrLessEquals(0, precision: 1.0e-4), @@ -1305,7 +1292,7 @@ void main() { ); }); - test('Batch tests - Minors', () { + test('minors', () { final source = [ RealMatrix.fromData( rows: 3, @@ -1398,7 +1385,7 @@ void main() { ); }); - test('Batch tests - Cofactor matrix', () { + test('cofactorMatrix', () { final source = [ RealMatrix.fromData( rows: 3, @@ -1476,7 +1463,7 @@ void main() { } }); - test('Batch tests - Inverse matrix', () { + test('inverse', () { final source = [ RealMatrix.fromData( rows: 3, @@ -1559,7 +1546,7 @@ void main() { } }); - test('Batch tests - Rank of a matrix', () { + test('rank', () { final source = [ RealMatrix.fromData( rows: 3, @@ -1605,20 +1592,14 @@ void main() { ).rank(), ]; - final ranks = [ - 3, - 1, - 2, - 2, - 1, - ]; + final ranks = [3, 1, 2, 2, 1]; for (var i = 0; i < source.length; ++i) { expect(source[i], equals(ranks[i])); } }); - test('Batch tests - Characteristic polynomial', () { + test('characteristicPolynomial', () { final polynomials = [ RealMatrix.fromData( rows: 3, @@ -1695,7 +1676,7 @@ void main() { } }); - test('Batch tests - Eigenvalues', () { + test('eigenvalues', () { final eigenvalues = [ RealMatrix.fromData( rows: 2, @@ -1760,10 +1741,7 @@ void main() { ]; final expected = >[ - const [ - Complex.fromReal(3), - Complex.fromReal(-2), - ], + const [Complex.fromReal(3), Complex.fromReal(-2)], const [ Complex.fromReal(11.8062), Complex.fromReal(-13.8062), @@ -1775,18 +1753,13 @@ void main() { Complex.fromReal(13.8824), Complex.zero(), ], - const [ - Complex.fromReal(16), - ], + const [Complex.fromReal(16)], const [ Complex.fromReal(11.6784), Complex(3.6607, 2.257), Complex(3.6607, -2.257), ], - const [ - Complex(1, -1), - Complex(1, 1), - ], + const [Complex(1, -1), Complex(1, 1)], const [ Complex.fromReal(-4.9095), Complex.fromReal(-2.4546), diff --git a/test/utils/complex/complex_test.dart b/test/utils/complex/complex_test.dart index 4f97841e..ffceb055 100644 --- a/test/utils/complex/complex_test.dart +++ b/test/utils/complex/complex_test.dart @@ -6,8 +6,8 @@ import 'package:test/test.dart'; import '../../double_approximation_matcher.dart'; void main() { - group('Testing constructors', () { - test('Making sure that the default constructor works as expected', () { + group('Constructors', () { + test('Default constructor', () { const complex = Complex(-2, 6); expect(complex.real, -2); @@ -15,7 +15,7 @@ void main() { }); test( - 'Making sure that real numbers are properly converted into complex ones.', + 'fromReal()', () { expect(const Complex.fromReal(7).real, equals(7)); expect(const Complex.fromReal(7).imaginary, isZero); @@ -25,7 +25,7 @@ void main() { }, ); - test("Making sure that named constructor for '0' and 'i' work.", () { + test('fromImaginary()', () { const zero = Complex.zero(); expect(zero.real, isZero); expect(zero.imaginary, isZero); @@ -36,8 +36,7 @@ void main() { }); test( - 'Making sure that const Complex objects are properly built from Fraction ' - 'objects', + 'fromFraction()', () { final fromFraction = Complex.fromFraction( Fraction(3, 5), @@ -92,7 +91,7 @@ void main() { }, ); - test('Polar coordinates conversions', () { + test('fromPolar()', () { // From polar final fromPolar = Complex.fromPolar( r: 2, @@ -147,7 +146,7 @@ void main() { ); }); - test('Printing values', () { + test('toString()', () { expect('${const Complex(-2, 6)}', equals('-2 + 6i')); expect('${const Complex(-2, -6)}', equals('-2 - 6i')); expect('${const Complex(-2.1, 6.3)}', equals('-2.1 + 6.3i')); @@ -231,8 +230,8 @@ void main() { }); }); - group('Testing objects equality', () { - test('Making sure that complex comparison is made via cross product', () { + group('Object comparison', () { + test('Object comparison', () { expect(const Complex(3, 12) == const Complex(3, 12), isTrue); expect(const Complex(3, 12) == const Complex(3, 12), isTrue); expect(const Complex(-3, -12) == const Complex(6, 13), isFalse); @@ -249,8 +248,7 @@ void main() { }); test( - "Making sure that 'compareTo' returns 1, -1 or 0 according with the " - 'natural sorting', + 'compareTo()', () { expect(const Complex(2, 1).compareTo(const Complex(3, 7)), equals(-1)); expect(const Complex(3, 7).compareTo(const Complex(2, 1)), equals(1)); @@ -258,7 +256,17 @@ void main() { }, ); - test("Making sure that 'copyWith' clones objects correctly", () { + test('Ordering operators', () { + const five = Complex.fromReal(5); + const ten = Complex.fromReal(10); + + expect(five > ten, isFalse); + expect(five >= ten, isFalse); + expect(five < ten, isTrue); + expect(five <= ten, isTrue); + }); + + test('copyWith()', () { const complex = Complex(8, -11); // Objects equality @@ -270,9 +278,9 @@ void main() { }); }); - group('Testing the API of the const Complex class', () { + group('API', () { test( - 'Making sure that the conjugate changes the sign of the imaginary part', + 'conjugate()', () { expect( const Complex(3, 7).conjugate(), @@ -285,7 +293,7 @@ void main() { }, ); - test('Making sure that the reciprocal is actually 1/(a + bi)', () { + test('reciprocal()', () { expect( const Complex(2, 1).reciprocal(), equals(const Complex(0.4, -0.2)), @@ -302,7 +310,7 @@ void main() { }); test( - "Making sure that modulus (or 'magnitude'/'absolute value') is correct", + 'abs()', () { expect( const Complex(3, 7).abs(), @@ -311,7 +319,7 @@ void main() { }, ); - test('Making sure that the exponential works properly', () { + test('exp()', () { final value = const Complex(3, 7).exp(); // e^(3 + 7i) expect( value.real, @@ -334,8 +342,7 @@ void main() { }); test( - 'Making sure that sine, cosine, tangent and cotangents work properly on' - ' const Complex', + 'sin(), cos(), tan() and cot()', () { const i = Complex.i(); @@ -360,7 +367,30 @@ void main() { }, ); - test('Making sure that the n-th root of the complex number is correct', () { + test( + 'sin() and cos() with large imaginary values (x.abs() > 20)', + () { + const largeImag = Complex(0, 25); + final sinLarge = largeImag.sin(); + final cosLarge = largeImag.cos(); + + expect(sinLarge.real.isFinite, isTrue); + expect(sinLarge.imaginary.isFinite, isTrue); + expect(cosLarge.real.isFinite, isTrue); + expect(cosLarge.imaginary.isFinite, isTrue); + + const largeNegImag = Complex(0, -25); + final sinLargeNeg = largeNegImag.sin(); + final cosLargeNeg = largeNegImag.cos(); + + expect(sinLargeNeg.real.isFinite, isTrue); + expect(sinLargeNeg.imaginary.isFinite, isTrue); + expect(cosLargeNeg.real.isFinite, isTrue); + expect(cosLargeNeg.imaginary.isFinite, isTrue); + }, + ); + + test('nthRoot()', () { final sqrt = const Complex(5, 1).sqrt(); expect( sqrt.real, @@ -403,8 +433,7 @@ void main() { }); test( - "Making sure that the 'nthRoot' method also works when the phase is " - 'negative', + 'nthRoot() when the phase is negative', () { const negativePhase = Complex(-0.5, -1); final negativePhaseRoot = negativePhase.nthRoot(2); @@ -423,7 +452,7 @@ void main() { }, ); - test("Making sure that the 'power' operation properly works", () { + test('pow()', () { final pow1 = const Complex(2, 7).pow(4); expect(pow1.real.round(), equals(1241)); expect(pow1.imaginary.round(), equals(-2520)); @@ -438,8 +467,8 @@ void main() { }); }); - group('Testing complex numbers operators', () { - test('Making sure that the sum between two complex numbers is correct', () { + group('Operators', () { + test('opearator +', () { final value = const Complex(3, -5) + const Complex(-8, 13); expect(value.real, equals(-5)); expect(value.imaginary, equals(8)); @@ -451,7 +480,7 @@ void main() { }); test( - 'Making sure that the difference between two complex numbers is correct', + 'operator -', () { final value = const Complex(3, -5) - const Complex(-8, 13); expect(value.real, equals(11)); @@ -465,7 +494,7 @@ void main() { ); test( - 'Making sure that the product between two complex numbers is correct', + 'operator *', () { final value = const Complex(3, -5) * const Complex(-8, 13); expect(value.real, equals(41)); @@ -478,18 +507,8 @@ void main() { }, ); - test('Making sure that complex objects are properly compared', () { - const five = Complex.fromReal(5); - const ten = Complex.fromReal(10); - - expect(five > ten, isFalse); - expect(five >= ten, isFalse); - expect(five < ten, isTrue); - expect(five <= ten, isTrue); - }); - test( - 'Making sure that the quotient between two complex numbers is correct', + 'operator /', () { final value = const Complex(3, -5) / const Complex(-8, 13); final realValue = Fraction(-89, 233).toDouble(); @@ -503,14 +522,19 @@ void main() { final v2 = const Complex.fromReal(5) / const Complex.fromImaginary(-16); expect(v2.real, equals(0)); expect(v2.imaginary, equals(0.3125)); + + final v3 = const Complex(-1, -3) / const Complex(4, 1); + expect(v3.real, equals(-7 / 17)); + expect(v3.imaginary, equals(-11 / 17)); }, ); - test('Making sure that the negation works properly.', () { + test('operator -()', () { const value = Complex(3, -5); - expect(-value, equals(const Complex(-3, 5))); - expect(-(-value), equals(value)); + + final negative = -value; + expect(-negative, equals(value)); }); }); } diff --git a/test/utils/complex/polar_complex_test.dart b/test/utils/complex/polar_complex_test.dart index 09e34e6e..98fd5c87 100644 --- a/test/utils/complex/polar_complex_test.dart +++ b/test/utils/complex/polar_complex_test.dart @@ -2,21 +2,22 @@ import 'package:equations/equations.dart'; import 'package:test/test.dart'; void main() { - group('Testing the behaviors of the PolarComplex class.', () { + group('PolarComplex', () { const polar = PolarComplex( r: 10, phiRadians: 2 * 3.14, phiDegrees: 360, ); - test('Making that PolarComplex values are properly constructed.', () { + test('Smoke test', () { expect(polar.r, equals(10)); expect(polar.phiRadians, equals(2 * 3.14)); expect(polar.phiDegrees, equals(360)); }); - test('Making that PolarComplex is properly converted into a string.', () { - const strResult = 'r = 10.0\n' + test('toString()', () { + const strResult = + 'r = 10.0\n' 'phi (rad) = 6.28\n' 'phi (deg) = 360.0'; @@ -26,7 +27,7 @@ void main() { ); }); - test('Making that PolarComplex can be properly compared.', () { + test('Object comparison.', () { const polar2 = PolarComplex( r: -4, phiRadians: 3.14, @@ -77,7 +78,7 @@ void main() { expect(polar2.compareTo(polar2), equals(0)); }); - test('Making sure that copyWith clones objects correctly', () { + test('copyWith()', () { const polarComplex = PolarComplex( r: 9, phiRadians: 1, diff --git a/test/utils/exceptions_test.dart b/test/utils/exceptions_test.dart index f16922eb..04f88020 100644 --- a/test/utils/exceptions_test.dart +++ b/test/utils/exceptions_test.dart @@ -3,8 +3,8 @@ import 'package:equations/src/utils/exceptions/types/numerical_integration_excep import 'package:test/test.dart'; void main() { - group('Testing the correctness of exception objects', () { - test('Making sure that equality comparison works for exceptions', () { + group('Exceptions', () { + test('Object comparison.', () { const complexException = ComplexException('Message'); const algebraicException = AlgebraicException('Message'); const nonlinearException = NonlinearException('Message'); @@ -232,7 +232,7 @@ void main() { ); }); - test('Making sure "ComplexException" prints the correct message', () { + test('ComplexException toString()', () { const exception = ComplexException('Exception message'); expect( @@ -245,7 +245,7 @@ void main() { ); }); - test('Making sure "AlgebraicException" prints the correct message', () { + test('AlgebraicException toString()', () { const exception = AlgebraicException('Exception message'); expect(exception.message, 'Exception message'); @@ -255,7 +255,7 @@ void main() { ); }); - test('Making sure "NonlinearException" prints the correct message', () { + test('NonlinearException toString()', () { const exception = NonlinearException('Exception message'); expect(exception.message, 'Exception message'); @@ -266,7 +266,7 @@ void main() { }); test( - 'Making sure "ExpressionParserException" prints the correct message', + 'ExpressionParserException toString()', () { const exception = ExpressionParserException('Exception message'); @@ -278,7 +278,7 @@ void main() { }, ); - test('Making sure "MatrixException" prints the correct message', () { + test('MatrixException toString()', () { const exception = MatrixException('Exception message'); expect(exception.message, 'Exception message'); @@ -288,7 +288,7 @@ void main() { ); }); - test('Making sure "SystemSolverException" prints the correct message', () { + test('SystemSolverException toString()', () { const exception = SystemSolverException('Exception message'); expect(exception.message, 'Exception message'); @@ -299,7 +299,7 @@ void main() { }); test( - 'Making sure "NumericalIntegrationException" prints the correct message', + 'NumericalIntegrationException toString()', () { const exception = NumericalIntegrationException('Exception message'); @@ -312,8 +312,7 @@ void main() { ); test( - 'Making sure "PolynomialLongDivisionException" prints the correct ' - 'message', + 'PolynomialLongDivisionException toString()', () { const exception = PolynomialLongDivisionException('Exception message'); @@ -325,7 +324,7 @@ void main() { }, ); - test('Making sure "InterpolationException" prints the correct message', () { + test('InterpolationException toString()', () { const exception = InterpolationException('Exception message'); expect(exception.message, 'Exception message'); diff --git a/test/utils/expression_parser_test.dart b/test/utils/expression_parser_test.dart index 9d61f12c..3c6d1626 100644 --- a/test/utils/expression_parser_test.dart +++ b/test/utils/expression_parser_test.dart @@ -6,8 +6,8 @@ import 'package:test/test.dart'; import '../double_approximation_matcher.dart'; void main() { - group('Testing the correctness of exception objects', () { - test("Making sure that 'ExpressionParser' works with real numbers.", () { + group('ExpressionParser', () { + test('Smoke test', () { const parser = ExpressionParser(); expect(parser.evaluate('5*3-4'), equals(11)); @@ -29,11 +29,18 @@ void main() { parser.evaluate('G'), const MoreOrLessEquals(0.8346268416, precision: 1.0e-10), ); + expect( + parser.evaluate('sqrt2'), + const MoreOrLessEquals(1.41421356237, precision: 1.0e-10), + ); + expect( + parser.evaluate('sqrt3'), + const MoreOrLessEquals(1.7320508075688, precision: 1.0e-10), + ); }); test( - "Making sure that 'ExpressionParser' throws when 'evaluate' has the " - "'x' variable in the string.", + 'Exception thrown when evaluate has x variable in the string.', () { const parser = ExpressionParser(); @@ -48,7 +55,7 @@ void main() { }, ); - test("Making sure that 'ExpressionParser' works with functions.", () { + test('Smoke test - functions', () { const parser = ExpressionParser(); expect( @@ -102,8 +109,7 @@ void main() { }); test( - "Making sure that 'ExpressionParser' correctly recognizes with the 'x'" - ' variable.', + 'Smoke test - x variable', () { const parser = ExpressionParser(); @@ -113,14 +119,13 @@ void main() { ); test( - "Making sure that 'ExpressionParser' works with the 'x' variable " - "even if 'x' is not present.", + 'Smoke test - x variable even if not present', () { expect(const ExpressionParser().evaluateOn('6*3 + 4', 0), equals(22)); }, ); - test("Making sure that the 'String' extension method works correctly.", () { + test('String extension method works correctly.', () { expect('6*3 + 4'.isRealFunction, isTrue); expect('6*3 + 4'.isNumericalExpression, isTrue); expect('e*x - pi'.isRealFunction, isTrue); @@ -130,7 +135,6 @@ void main() { expect('cos(pi) - 18 * 6'.isNumericalExpression, isTrue); expect('0'.isNumericalExpression, isTrue); expect('e^(2 + pi)'.isNumericalExpression, isTrue); - expect('2x+6'.isRealFunction, isFalse); expect(''.isRealFunction, isFalse); expect('x'.isNumericalExpression, isFalse); diff --git a/test/utils/factorial_test.dart b/test/utils/factorial_test.dart index 89ac1e12..729e5d3c 100644 --- a/test/utils/factorial_test.dart +++ b/test/utils/factorial_test.dart @@ -3,52 +3,158 @@ import 'package:test/test.dart'; void main() { late final Factorial factorial; - late final Map values; + + final values = { + 0: 1, + 1: 1, + 2: 2, + 3: 6, + 4: 24, + 5: 120, + 6: 720, + 7: 5040, + 8: 40320, + 9: 362880, + 10: 3628800, + 11: 39916800, + 12: 479001600, + 13: 6227020800, + 14: 87178291200, + 15: 1307674368000, + 16: 20922789888000, + 17: 355687428096000, + 18: 6402373705728000, + 19: 121645100408832000, + 20: 2432902008176640000, + }; + + final bigIntValues = { + 0: BigInt.one, + 1: BigInt.one, + 2: BigInt.two, + 3: BigInt.from(6), + 4: BigInt.from(24), + 5: BigInt.from(120), + 6: BigInt.from(720), + 7: BigInt.from(5040), + 8: BigInt.from(40320), + 9: BigInt.from(362880), + 10: BigInt.from(3628800), + 11: BigInt.from(39916800), + 12: BigInt.from(479001600), + 13: BigInt.from(6227020800), + 14: BigInt.from(87178291200), + 15: BigInt.from(1307674368000), + 16: BigInt.from(20922789888000), + 17: BigInt.from(355687428096000), + 18: BigInt.from(6402373705728000), + 19: BigInt.from(121645100408832000), + 20: BigInt.from(2432902008176640000), + 21: BigInt.parse('51090942171709440000'), + 22: BigInt.parse('1124000727777607680000'), + 23: BigInt.parse('25852016738884976640000'), + 24: BigInt.parse('620448401733239439360000'), + 25: BigInt.parse('15511210043330985984000000'), + 26: BigInt.parse('403291461126605635584000000'), + 27: BigInt.parse('10888869450418352160768000000'), + 28: BigInt.parse('304888344611713860501504000000'), + 29: BigInt.parse('8841761993739701954543616000000'), + 30: BigInt.parse('265252859812191058636308480000000'), + }; setUpAll(() { factorial = const Factorial(); - - values = { - 0: 1, - 1: 1, - 2: 2, - 3: 6, - 4: 24, - 5: 120, - 6: 720, - 7: 5040, - 8: 40320, - 9: 362880, - 10: 3628800, - 11: 39916800, - 12: 479001600, - 13: 6227020800, - 14: 87178291200, - 15: 1307674368000, - 16: 20922789888000, - 17: 355687428096000, - 18: 6402373705728000, - 19: 121645100408832000, - 20: 2432902008176640000, - }; }); - group("Testing the 'Factorial' class", () { - test("Making sure that 'compute' works properly", () { + group('Factorial', () { + test('compute()', () { for (final entry in values.entries) { expect(factorial.compute(entry.key), equals(entry.value)); } }); + test('computeBigInt()', () { + for (final entry in bigIntValues.entries) { + expect(factorial.computeBigInt(entry.key), equals(entry.value)); + } + }); + test( - "Making sure that 'compute' works with value bigger than 21 but the " - 'result is not exact', + 'compute() with value bigger than 21 but the result is not exact', () { final value = factorial.compute(21); expect( value.toStringAsExponential(), equals('-4.249290049419215e+18'), ); + + // Check that the value is cached + final value2 = factorial.compute(21); + expect( + value2.toStringAsExponential(), + equals('-4.249290049419215e+18'), + ); + }, + ); + + test( + 'computeBigInt() with value bigger than 31', + () { + final value = factorial.computeBigInt(31); + expect( + value.toString(), + equals('8222838654177922817725562880000000'), + ); + + // Check that the value is cached + final value2 = factorial.computeBigInt(31); + expect( + value2.toString(), + equals('8222838654177922817725562880000000'), + ); + }, + ); + + test( + 'compute() and computeBigInt() return the same values', + () { + final bigEntries = bigIntValues.entries.toList(); + final entries = values.entries.toList(); + + for (var i = 0; i < entries.length; ++i) { + expect(entries[i].key, equals(bigEntries[i].key)); + expect(entries[i].value, equals(bigEntries[i].value.toInt())); + } + }, + ); + + test( + 'compute() with dynamic cache', + () { + final value1 = factorial.compute(25); + expect(value1, isNotNull); + + final value2 = factorial.compute(25); + expect(value2, equals(value1)); + + final value3 = factorial.compute(26); + expect(value3, isNotNull); + expect(value3, equals(value1 * 26)); + }, + ); + + test( + 'computeBigInt() with dynamic cache', + () { + final value1 = factorial.computeBigInt(31); + expect(value1, isNotNull); + + final value2 = factorial.computeBigInt(31); + expect(value2, equals(value1)); + + final value3 = factorial.computeBigInt(32); + expect(value3, isNotNull); + expect(value3, equals(value1 * BigInt.from(32))); }, ); }); diff --git a/test/utils/math_utils_test.dart b/test/utils/math_utils_test.dart index 5225baec..256f157d 100644 --- a/test/utils/math_utils_test.dart +++ b/test/utils/math_utils_test.dart @@ -15,15 +15,15 @@ void main() { demo = const Demo(); }); - group("Testing the 'MathUtils' mixin", () { - test("Making sure that the 'hypot' method works correctly", () { + group('MathUtils', () { + test('hypot()', () { expect(demo.hypot(0, 0), isZero); expect(demo.hypot(0, 8), equals(8)); expect(demo.hypot(8, 0), equals(8)); expect(demo.hypot(3, 4), equals(5)); }); - test("Making sure that the 'complexHypot' method works correctly", () { + test('complexHypot()', () { expect( demo.complexHypot(const Complex.zero(), const Complex.zero()), equals(const Complex.zero()),