Skip to content

Added an algorithm to calculate the present value of cash flows - #8700

Merged
cclauss merged 18 commits into
TheAlgorithms:masterfrom
sahilg13:master
Apr 30, 2023
Merged

Added an algorithm to calculate the present value of cash flows#8700
cclauss merged 18 commits into
TheAlgorithms:masterfrom
sahilg13:master

Conversation

@sahilg13

@sahilg13sahilg13 commented Apr 29, 2023

Copy link
Copy Markdown
Contributor

Describe your change:

I added a financial algorithm that calculates the present value of a stream of yearly cash flows at a given discount rate.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@algorithms-keeperalgorithms-keeperBot added the tests are failing Do not merge until tests pass label Apr 29, 2023
@algorithms-keeperalgorithms-keeperBot added the require tests Tests [doctest/unittest/pytest] are required label Apr 29, 2023
algorithms-keeper[bot]
algorithms-keeperBot reviewed Apr 29, 2023
View reviewed changes

@algorithms-keeperalgorithms-keeperBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

Comment threadfinancial/present_value.py Outdated
from typing import list, tuple


def present_value(discount_rate: float, cash_flows: list[float]) -> tuple[float, str]:

@algorithms-keeperalgorithms-keeperBotApr 29, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file financial/present_value.py, please provide doctest for the function present_value

@algorithms-keeperalgorithms-keeperBot added the awaiting reviews This PR is ready to be reviewed label Apr 29, 2023
@algorithms-keeperalgorithms-keeperBot removed the require tests Tests [doctest/unittest/pytest] are required label Apr 29, 2023
@algorithms-keeperalgorithms-keeperBot removed the tests are failing Do not merge until tests pass label Apr 29, 2023
rohan472000
rohan472000 suggested changes Apr 30, 2023
View reviewed changes
Comment threadfinancial/present_value.py
Comment threadfinancial/present_value.py
@algorithms-keeperalgorithms-keeperBot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Apr 30, 2023
@rohan472000

rohan472000 commented Apr 30, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

To get your PR merged kindly ask a review from @cclauss as he has write access.

@sahilg13

sahilg13 commented Apr 30, 2023

Copy link
Copy Markdown
ContributorAuthor

@cclauss Hi! If you could please review and merge this PR that would be great!

cclauss
cclauss reviewed Apr 30, 2023
View reviewed changes
Comment threadfinancial/present_value.py Outdated
cclauss
cclauss reviewed Apr 30, 2023
View reviewed changes
Comment threadfinancial/present_value.py Outdated
cclauss
cclauss reviewed Apr 30, 2023
View reviewed changes
Comment threadfinancial/present_value.py Outdated
@sahilg13@cclauss
Update financial/present_value.py
c0afee8
Committed first suggestion
Co-authored-by: Christian Clauss <cclauss@me.com>
sahilg13and others added 3 commits April 30, 2023 13:15
@sahilg13@cclauss
Update financial/present_value.py
682b743
Committed second suggestion
Co-authored-by: Christian Clauss <cclauss@me.com>
@sahilg13@cclauss
Update financial/present_value.py
0299cfb
Committed third suggestion
Co-authored-by: Christian Clauss <cclauss@me.com>
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
ae23ac6
for more information, see https://pre-commit.ci
@algorithms-keeperalgorithms-keeperBot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Apr 30, 2023
@sahilg13
sahilg13 requested a review from cclaussApril 30, 2023 17:20
@sahilg13

sahilg13 commented Apr 30, 2023

Copy link
Copy Markdown
ContributorAuthor

@cclauss Thank you for your improvements. I have committed the suggested changes and I am ready for another review.

@cclauss
cclauss enabled auto-merge (squash) April 30, 2023 17:28
cclauss
cclauss reviewed Apr 30, 2023
View reviewed changes
Comment threadfinancial/present_value.py Outdated
Comment threadfinancial/present_value.py Outdated
algorithms-keeper[bot]
algorithms-keeperBot reviewed Apr 30, 2023
View reviewed changes

@algorithms-keeperalgorithms-keeperBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

Comment threadfinancial/present_value.py
@@ -0,0 +1,41 @@
"""

@algorithms-keeperalgorithms-keeperBotApr 30, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

An error occured while parsing the file: financial/present_value.py

Traceback (mostrecentcalllast):
File"/opt/render/project/src/algorithms_keeper/parser/python_parser.py", line145, inparsereports=lint_file(
^^^^^^^^^^libcst._exceptions.ParserSyntaxError: SyntaxError @ 1:1.tokenizererror: unterminatedtriple-quotedstringliteral
"""
^

@cclauss
cclauss merged commit c4dcc44 into TheAlgorithms:masterApr 30, 2023
@algorithms-keeperalgorithms-keeperBot removed the awaiting reviews This PR is ready to be reviewed label Apr 30, 2023
tianyizheng02 pushed a commit to tianyizheng02/Python that referenced this pull request May 29, 2023
@sahilg13@pre-commit-ci
@cclauss@tianyizheng02
Added an algorithm to calculate the present value of cash flows (TheA…
a354342
…lgorithms#8700)
* Added an algorithm to calculate the present value of cash flows
* added doctest and reference
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Resolving deprecation issues with typing module
* Fixing argument type checks and adding doctest case
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Fixing failing doctest case by requiring less precision due to floating point inprecision
* Updating return type
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Added test cases for more coverage
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Make improvements based on Rohan's suggestions
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Update financial/present_value.py
Committed first suggestion
Co-authored-by: Christian Clauss <cclauss@me.com>
* Update financial/present_value.py
Committed second suggestion
Co-authored-by: Christian Clauss <cclauss@me.com>
* Update financial/present_value.py
Committed third suggestion
Co-authored-by: Christian Clauss <cclauss@me.com>
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
@isidroasisidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclausscclausscclauss approved these changes
+2 more reviewers
@algorithms-keeperalgorithms-keeper[bot]algorithms-keeper[bot] left review comments
@rohan472000rohan472000rohan472000 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

tests are failingDo not merge until tests pass

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sahilg13@rohan472000@cclauss