finqir 0.1.0__tar.gz

finqir-0.1.0/LICENSE.txt

@@ -0,0 +1,203 @@
+                    Copyright 2017 IBM and its contributors
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 IBM and its contributors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

finqir-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE.txt
+include requirements.txt
+include finqir/py.typed
+recursive-include finqir *.txt
+graft test
+prune docs
+prune tools
+prune tutorials
+global-exclude *.py[co] .DS_Store

finqir-0.1.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: finqir
+Version: 0.1.0
+Summary: Structured quantum-finance modeling and compilation for Qiskit
+Author: FinQIR Contributors
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://bilgin-kocak.github.io/finqir/
+Project-URL: Issues, https://github.com/bilgin-kocak/finqir/issues
+Project-URL: Repository, https://github.com/bilgin-kocak/finqir
+Keywords: finance,optimization,portfolio,qaoa,qiskit,quantum computing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: certifi
+Requires-Dist: fastdtw>=0.3.4
+Requires-Dist: nasdaq-data-link>=1.0.4
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.0
+Requires-Dist: psutil>=5
+Requires-Dist: qiskit<3,>=2.5.2
+Requires-Dist: qiskit-algorithms<0.5,>=0.4.0
+Requires-Dist: qiskit-optimization<0.8,>=0.7.0
+Requires-Dist: scipy>=1.11
+Requires-Dist: urllib3
+Requires-Dist: yfinance>=0.2.66
+Provides-Extra: test
+Requires-Dist: coverage>=7; extra == "test"
+Requires-Dist: ddt!=1.7.0,>=1.6; extra == "test"
+Requires-Dist: qiskit-aer>=0.17; extra == "test"
+Requires-Dist: stestr>=4; extra == "test"
+Requires-Dist: tomli>=2; extra == "test"
+Provides-Extra: dev
+Requires-Dist: black[jupyter]>=24.10; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: pylint>=3.2; extra == "dev"
+Requires-Dist: Sphinx>=7; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Requires-Dist: types-certifi; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: jupyter-sphinx; extra == "docs"
+Requires-Dist: matplotlib>=3.8; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: pylatexenc>=1.4; extra == "docs"
+Requires-Dist: qiskit-sphinx-theme>=1.16; extra == "docs"
+Requires-Dist: reno>=4; extra == "docs"
+Requires-Dist: Sphinx>=7; extra == "docs"
+Requires-Dist: sphinx-design>=0.6; extra == "docs"
+Requires-Dist: sphinxcontrib-spelling; extra == "docs"
+Dynamic: license-file
+
+# FinQIR
+
+**Financial Quantum Intermediate Representation**
+
+FinQIR is an independent, Apache-2.0-licensed Python toolkit for structured
+quantum-finance modeling, compilation, and optimization on Qiskit. It is built
+for finance engineers who need recognizable financial concepts and quantum
+engineers who need inspectable mappings, constraints, circuits, and results.
+
+> [!IMPORTANT]
+> FinQIR is an independent community project. It is not an IBM product and is
+> not affiliated with or endorsed by IBM or the Qiskit project.
+
+FinQIR begins with useful portfolio, pricing, probability-distribution, and
+market-data components derived from the Apache-licensed Qiskit Finance project.
+Its roadmap adds structured portfolio problems, traceable financial mappings,
+finance-aware compilation passes, constraint-preserving QAOA, and reproducible
+benchmarks.
+
+## Installation
+
+After the first PyPI release, install FinQIR with:
+
+```bash
+pip install finqir
+```
+
+Until then, install the development version from source:
+
+```bash
+git clone https://github.com/bilgin-kocak/finqir.git
+cd finqir
+python -m pip install -e ".[test,dev]"
+```
+
+FinQIR 0.1 targets Python 3.10 or newer and Qiskit 2.5.2.
+
+## Example
+
+```python
+import numpy as np
+
+from finqir.applications.optimization import PortfolioOptimization
+
+problem = PortfolioOptimization(
+    expected_returns=np.array([0.10, 0.08, 0.12]),
+    covariances=np.array(
+        [
+            [0.10, 0.02, 0.03],
+            [0.02, 0.08, 0.01],
+            [0.03, 0.01, 0.09],
+        ]
+    ),
+    risk_factor=0.5,
+    budget=2,
+)
+
+quadratic_program = problem.to_quadratic_program()
+print(quadratic_program.prettyprint())
+```
+
+## Planned structured API
+
+The design and implementation roadmap cover:
+
+- `StructuredPortfolioProblem` with named financial constraints;
+- binary, integer, unary, domain-wall, and fixed-cardinality mappings;
+- finance-aware problem and circuit compilation passes;
+- constraint-preserving QAOA mixers;
+- conflict-graph portfolios and constrained MIS problems;
+- multi-period rebalancing, risk, pricing, and benchmarking extensions.
+
+These APIs are roadmap items and are not part of the initial package foundation.
+See the [approved design](docs/superpowers/specs/2026-09-04-structured-quantum-finance-design.md)
+and [implementation plan](docs/superpowers/plans/2026-09-04-structured-quantum-finance.md).
+
+## Development
+
+```bash
+python -m pip install -e ".[test,dev]"
+python -m unittest discover -s test -v
+python -m build
+python -m twine check dist/*
+```
+
+## Project history and license
+
+FinQIR is an independent derivative of
+[Qiskit Finance](https://github.com/qiskit-community/qiskit-finance). Existing
+copyright notices are retained in derived files. New FinQIR work is released
+under the same [Apache License 2.0](LICENSE.txt).
+
+FinQIR is research software. It does not provide investment advice and must not
+be treated as a guarantee of financial performance or quantum advantage.

finqir-0.1.0/README.md

@@ -0,0 +1,94 @@
+# FinQIR
+
+**Financial Quantum Intermediate Representation**
+
+FinQIR is an independent, Apache-2.0-licensed Python toolkit for structured
+quantum-finance modeling, compilation, and optimization on Qiskit. It is built
+for finance engineers who need recognizable financial concepts and quantum
+engineers who need inspectable mappings, constraints, circuits, and results.
+
+> [!IMPORTANT]
+> FinQIR is an independent community project. It is not an IBM product and is
+> not affiliated with or endorsed by IBM or the Qiskit project.
+
+FinQIR begins with useful portfolio, pricing, probability-distribution, and
+market-data components derived from the Apache-licensed Qiskit Finance project.
+Its roadmap adds structured portfolio problems, traceable financial mappings,
+finance-aware compilation passes, constraint-preserving QAOA, and reproducible
+benchmarks.
+
+## Installation
+
+After the first PyPI release, install FinQIR with:
+
+```bash
+pip install finqir
+```
+
+Until then, install the development version from source:
+
+```bash
+git clone https://github.com/bilgin-kocak/finqir.git
+cd finqir
+python -m pip install -e ".[test,dev]"
+```
+
+FinQIR 0.1 targets Python 3.10 or newer and Qiskit 2.5.2.
+
+## Example
+
+```python
+import numpy as np
+
+from finqir.applications.optimization import PortfolioOptimization
+
+problem = PortfolioOptimization(
+    expected_returns=np.array([0.10, 0.08, 0.12]),
+    covariances=np.array(
+        [
+            [0.10, 0.02, 0.03],
+            [0.02, 0.08, 0.01],
+            [0.03, 0.01, 0.09],
+        ]
+    ),
+    risk_factor=0.5,
+    budget=2,
+)
+
+quadratic_program = problem.to_quadratic_program()
+print(quadratic_program.prettyprint())
+```
+
+## Planned structured API
+
+The design and implementation roadmap cover:
+
+- `StructuredPortfolioProblem` with named financial constraints;
+- binary, integer, unary, domain-wall, and fixed-cardinality mappings;
+- finance-aware problem and circuit compilation passes;
+- constraint-preserving QAOA mixers;
+- conflict-graph portfolios and constrained MIS problems;
+- multi-period rebalancing, risk, pricing, and benchmarking extensions.
+
+These APIs are roadmap items and are not part of the initial package foundation.
+See the [approved design](docs/superpowers/specs/2026-09-04-structured-quantum-finance-design.md)
+and [implementation plan](docs/superpowers/plans/2026-09-04-structured-quantum-finance.md).
+
+## Development
+
+```bash
+python -m pip install -e ".[test,dev]"
+python -m unittest discover -s test -v
+python -m build
+python -m twine check dist/*
+```
+
+## Project history and license
+
+FinQIR is an independent derivative of
+[Qiskit Finance](https://github.com/qiskit-community/qiskit-finance). Existing
+copyright notices are retained in derived files. New FinQIR work is released
+under the same [Apache License 2.0](LICENSE.txt).
+
+FinQIR is research software. It does not provide investment advice and must not
+be treated as a guarantee of financial performance or quantum advantage.

finqir-0.1.0/finqir/VERSION.txt

@@ -0,0 +1 @@
+0.1.0

finqir-0.1.0/finqir/__init__.py

@@ -0,0 +1,53 @@
+# This file is derived from Qiskit Finance for use in FinQIR.
+#
+# (C) Copyright IBM 2019, 2024.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+"""
+=============================================
+FinQIR module (:mod:`finqir`)
+=============================================
+
+.. currentmodule:: finqir
+
+This is the FinQIR module. It has applications based on
+`Amplitude Estimation
+<https://qiskit-community.github.io/qiskit-algorithms/apidocs/qiskit_algorithms.html#amplitude-estimators>`__
+and optimization using
+`Qiskit Optimization <https://qiskit-community.github.io/qiskit-optimization/>`__,
+some library circuits useful for finance applications,
+and data providers which supply a source of financial data.
+
+.. autosummary::
+   :toctree: ../stubs/
+   :nosignatures:
+
+    FinQIRError
+
+In addition to standard Python errors the FinQIR module will raise this error
+if circumstances are that it cannot proceed to completion.
+
+Submodules
+==========
+
+.. autosummary::
+   :toctree:
+
+   applications
+   circuit
+   data_providers
+
+"""
+
+from .version import __version__
+from .exceptions import FinQIRError
+
+__title__ = "FinQIR"
+
+__all__ = ["__title__", "__version__", "FinQIRError"]

finqir-0.1.0/finqir/applications/__init__.py

@@ -0,0 +1,61 @@
+# This file is derived from Qiskit Finance for use in FinQIR.
+#
+# (C) Copyright IBM 2020, 2023.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+Finance applications (:mod:`finqir.applications`)
+=========================================================
+
+.. currentmodule:: finqir.applications
+
+FinQIR ready-made applications.
+
+Optimization Applications
+-------------------------
+
+.. autosummary::
+   :toctree: ../stubs/
+   :nosignatures:
+
+   PortfolioOptimization
+   PortfolioDiversification
+
+Estimation Applications
+-----------------------
+
+.. autosummary::
+   :toctree: ../stubs/
+   :nosignatures:
+
+   EstimationApplication
+   EuropeanCallDelta
+   EuropeanCallPricing
+   FixedIncomePricing
+
+
+"""
+
+from .estimation import (
+    EstimationApplication,
+    EuropeanCallDelta,
+    EuropeanCallPricing,
+    FixedIncomePricing,
+)
+from .optimization import PortfolioOptimization, PortfolioDiversification
+
+__all__ = [
+    "PortfolioOptimization",
+    "PortfolioDiversification",
+    "EstimationApplication",
+    "EuropeanCallDelta",
+    "EuropeanCallPricing",
+    "FixedIncomePricing",
+]

finqir-0.1.0/finqir/applications/estimation/__init__.py

@@ -0,0 +1,26 @@
+# This file is derived from Qiskit Finance for use in FinQIR.
+#
+# (C) Copyright IBM 2019, 2023.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+
+"""Estimation applications for finance"""
+
+from .estimation_application import EstimationApplication
+from .european_call_delta import EuropeanCallDelta
+from .european_call_pricing import EuropeanCallPricing
+from .fixed_income_pricing import FixedIncomePricing
+
+__all__ = [
+    "EstimationApplication",
+    "EuropeanCallDelta",
+    "EuropeanCallPricing",
+    "FixedIncomePricing",
+]

finqir-0.1.0/finqir/applications/estimation/estimation_application.py

@@ -0,0 +1,44 @@
+# This file is derived from Qiskit Finance for use in FinQIR.
+#
+# (C) Copyright IBM 2018, 2023.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""An abstract class for estimation application classes."""
+
+from abc import ABC, abstractmethod
+
+from qiskit_algorithms import (
+    EstimationProblem,
+    AmplitudeEstimatorResult,
+)
+
+
+class EstimationApplication(ABC):
+    """
+    An abstract class for estimation applications
+    """
+
+    @abstractmethod
+    def to_estimation_problem(self) -> EstimationProblem:
+        """Convert a problem instance into a
+        :class:`qiskit_algorithms.EstimationProblem`
+        """
+        pass
+
+    @abstractmethod
+    def interpret(self, result: AmplitudeEstimatorResult) -> float:
+        """Convert the calculation result of the problem
+        (:class:`qiskit_algorithms.AmplitudeEstimatorResult`)
+        to the answer of the problem.
+
+        Args:
+            result: The calculated result of the problem
+        """
+        pass