Skip to content

Add Fixed Point Iteration and Modified Newton-Raphson Methods #12341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 14 commits into from

Conversation

akshat3144
Copy link

@akshat3144 akshat3144 commented Oct 31, 2024

Describe your change:

This pull request adds two numerical analysis algorithms:

Fixed Point Iteration Method:
An iterative method to find an approximate solution to the equation ( f(x) = 0 ) by rewriting it in the form ( x = g(x) ).
Includes implementation with docstrings, type hints, and doctests.

Modified Newton-Raphson Method:
An iterative method that modifies the standard Newton-Raphson method to improve convergence when the root has multiplicity greater than one.
Includes implementation with docstrings, type hints, and doctests.

Both algorithms are placed in the appropriate directory with filenames in lowercase without spaces or dashes.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 31, 2024
@algorithms-keeper algorithms-keeper bot added require descriptive names This PR needs descriptive function and/or variable names require type hints https://docs.python.org/3/library/typing.html labels Oct 31, 2024
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

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.

"""


def fixed_point_iteration(g, x0, tol=1e-7, max_iter=1000):

Choose a reason for hiding this comment

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

Please provide return type hint for the function: fixed_point_iteration. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: g

Please provide descriptive name for the parameter: g

Please provide type hint for the parameter: x0

Please provide type hint for the parameter: tol

Please provide type hint for the parameter: max_iter


if __name__ == "__main__":

def g(x):

Choose a reason for hiding this comment

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

Please provide return type hint for the function: g. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide descriptive name for the function: g

Please provide type hint for the parameter: x

Please provide descriptive name for the parameter: x



def modified_newton_raphson(
f: Callable[[float], float],

Choose a reason for hiding this comment

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

Please provide descriptive name for the parameter: f

if __name__ == "__main__":
import math

def f(x):

Choose a reason for hiding this comment

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

Please provide return type hint for the function: f. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide descriptive name for the function: f

Please provide type hint for the parameter: x

Please provide descriptive name for the parameter: x

def f(x):
return x**3 - 2 * x - 5

def f_prime(x):

Choose a reason for hiding this comment

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

Please provide return type hint for the function: f_prime. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: x

Please provide descriptive name for the parameter: x

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 31, 2024
@algorithms-keeper algorithms-keeper bot removed require descriptive names This PR needs descriptive function and/or variable names require type hints https://docs.python.org/3/library/typing.html labels Oct 31, 2024
@cclauss
Copy link
Member

cclauss commented Nov 1, 2024

Closing tests_are_failing PRs to prepare for Hacktoberfest

@cclauss cclauss closed this Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants