Skip to content

Added Fibonacci_Heap for DSA #9285

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 8 commits into from
Closed

Added Fibonacci_Heap for DSA #9285

wants to merge 8 commits into from

Conversation

imSanko
Copy link
Contributor

@imSanko imSanko commented Oct 1, 2023

Describe your change:

Added the Fibonacci heap in the DSA section

  • 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 description above includes the issue number(s) with a closing keyword: "Fixes Adding Fibonacci Heap data structure implementation codes #9095".

@algorithms-keeper algorithms-keeper bot added require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 1, 2023
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.

@@ -0,0 +1,101 @@
class FibonacciNode:
def __init__(self, key):

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: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: key

self.parent = None

class FibonacciHeap:
def __init__(self):

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: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

class FibonacciNode:
def init(self, key) -> None:
self.key = key
self.children = []
self.marked = False
self.degree = 0
self.parent = None

class FibonacciHeap:
def init(self) -> None:
self.trees = []
self.least = None
self.count = 0

self.least = None
self.count = 0

def insert(self, key):

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: insert. If the function does not return a value, please provide the type hint as: def function() -> None:

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

Please provide type hint for the parameter: key

if self.least is None or key < self.least.key:
self.least = new_node

def extract_min(self):

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: extract_min. If the function does not return a value, please provide the type hint as: def function() -> None:

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

self.consolidate()
return min_node.key

def consolidate(self):

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: consolidate. If the function does not return a value, please provide the type hint as: def function() -> None:

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


self.trees = [node for node in degree_counts if node is not None]

def link(self, node1, node2):

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: link. If the function does not return a value, please provide the type hint as: def function() -> None:

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

Please provide type hint for the parameter: node1

Please provide type hint for the parameter: node2

node1.degree += 1
node2.marked = False

def decrease_key(self, node, new_key):

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: decrease_key. If the function does not return a value, please provide the type hint as: def function() -> None:

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

Please provide type hint for the parameter: node

Please provide type hint for the parameter: new_key

self.cut(node, parent)
self.cascading_cut(parent)

def cut(self, node, parent):

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: cut. If the function does not return a value, please provide the type hint as: def function() -> None:

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

Please provide type hint for the parameter: node

Please provide type hint for the parameter: parent

node.parent = None
node.marked = False

def cascading_cut(self, node):

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: cascading_cut. If the function does not return a value, please provide the type hint as: def function() -> None:

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

Please provide type hint for the parameter: node

Copy link
Contributor Author

Choose a reason for hiding this comment

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

class FibonacciNode:
def init(self, key) -> None:
self.key = key
self.children = []
self.marked = False
self.degree = 0
self.parent = None

class FibonacciHeap:
def init(self) -> None:
self.trees = []
self.least = None
self.count = 0

# ... (other methods)

def cascading_cut(self, node: FibonacciNode) -> None:
    """
    Perform cascading cuts to handle marked nodes and maintain heap properties.

    :param node: The node on which cascading cuts are applied.
    """
    parent = node.parent
    if parent is not None:
        if not node.marked:
            node.marked = True
        else:
            self.cut(node, parent)
            self.cascading_cut(parent)

self.cut(node, parent)
self.cascading_cut(parent)

def update_least(self):

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: update_least. If the function does not return a value, please provide the type hint as: def function() -> None:

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

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 1, 2023
Copy link
Contributor Author

@imSanko imSanko left a comment

Choose a reason for hiding this comment

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

Added reviews

self.parent = None

class FibonacciHeap:
def __init__(self):
Copy link
Contributor Author

Choose a reason for hiding this comment

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

class FibonacciNode:
def init(self, key) -> None:
self.key = key
self.children = []
self.marked = False
self.degree = 0
self.parent = None

class FibonacciHeap:
def init(self) -> None:
self.trees = []
self.least = None
self.count = 0

node.parent = None
node.marked = False

def cascading_cut(self, node):
Copy link
Contributor Author

Choose a reason for hiding this comment

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

class FibonacciNode:
def init(self, key) -> None:
self.key = key
self.children = []
self.marked = False
self.degree = 0
self.parent = None

class FibonacciHeap:
def init(self) -> None:
self.trees = []
self.least = None
self.count = 0

# ... (other methods)

def cascading_cut(self, node: FibonacciNode) -> None:
    """
    Perform cascading cuts to handle marked nodes and maintain heap properties.

    :param node: The node on which cascading cuts are applied.
    """
    parent = node.parent
    if parent is not None:
        if not node.marked:
            node.marked = True
        else:
            self.cut(node, parent)
            self.cascading_cut(parent)

@algorithms-keeper algorithms-keeper bot added the require descriptive names This PR needs descriptive function and/or variable names label Oct 2, 2023
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.

@@ -0,0 +1,101 @@
class FibonacciNode:
def __init__(self, key):

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: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: key



class FibonacciHeap:
def __init__(self):

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: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:

self.least = None
self.count = 0

def insert(self, key):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function insert

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

Please provide type hint for the parameter: key

if self.least is None or key < self.least.key:
self.least = new_node

def extract_min(self):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function extract_min

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

self.consolidate()
return min_node.key

def consolidate(self):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function consolidate

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

node.parent = None
node.marked = False

def cascading_cut(self, node):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function cascading_cut

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

Please provide type hint for the parameter: node

self.cut(node, parent)
self.cascading_cut(parent)

def update_least(self):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function update_least

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

@@ -0,0 +1,28 @@
import numpy as np

def metropolis_hastings(target_distribution, proposal_distribution, num_samples, initial_state):

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 dynamic_programming/Metropolis_Hasting.py, please provide doctest for the function metropolis_hastings

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

Please provide type hint for the parameter: target_distribution

Please provide type hint for the parameter: proposal_distribution

Please provide type hint for the parameter: num_samples

Please provide type hint for the parameter: initial_state


return samples[1:]

def target_distribution(x):

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 dynamic_programming/Metropolis_Hasting.py, please provide doctest for the function target_distribution

Please provide return type hint for the function: target_distribution. 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

def target_distribution(x):
return np.exp(-x**2 / 2) / np.sqrt(2 * np.pi)

def proposal_distribution(x):

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 dynamic_programming/Metropolis_Hasting.py, please provide doctest for the function proposal_distribution

Please provide return type hint for the function: proposal_distribution. 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 tests are failing Do not merge until tests pass label Oct 2, 2023
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.

@@ -0,0 +1,101 @@
class FibonacciNode:
def __init__(self, key):

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: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide type hint for the parameter: key



class FibonacciHeap:
def __init__(self):

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: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:

self.least = None
self.count = 0

def insert(self, key):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function insert

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

Please provide type hint for the parameter: key

if self.least is None or key < self.least.key:
self.least = new_node

def extract_min(self):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function extract_min

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

self.consolidate()
return min_node.key

def consolidate(self):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function consolidate

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

node.parent = None
node.marked = False

def cascading_cut(self, node):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function cascading_cut

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

Please provide type hint for the parameter: node

self.cut(node, parent)
self.cascading_cut(parent)

def update_least(self):

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 data_structures/heap/fibonacci_heap.py, please provide doctest for the function update_least

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

@@ -0,0 +1,28 @@
import numpy as np

def metropolis_hastings(target_distribution, proposal_distribution, num_samples, initial_state):

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 data_structures/heap/metropolish_hasting.py, please provide doctest for the function metropolis_hastings

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

Please provide type hint for the parameter: target_distribution

Please provide type hint for the parameter: proposal_distribution

Please provide type hint for the parameter: num_samples

Please provide type hint for the parameter: initial_state


return samples[1:]

def target_distribution(x):

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 data_structures/heap/metropolish_hasting.py, please provide doctest for the function target_distribution

Please provide return type hint for the function: target_distribution. 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

def target_distribution(x):
return np.exp(-x**2 / 2) / np.sqrt(2 * np.pi)

def proposal_distribution(x):

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 data_structures/heap/metropolish_hasting.py, please provide doctest for the function proposal_distribution

Please provide return type hint for the function: proposal_distribution. 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 tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Oct 2, 2023
@tianyizheng02
Copy link
Contributor

Do not contribute multiple algorithms in one PR. Why did you check the checkbox if you didn't follow the instructions?

  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.

@tianyizheng02 tianyizheng02 added invalid multiple algorithms not allowed Multiple algorithms in a single PR are not allowed labels Oct 2, 2023
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 invalid multiple algorithms not allowed Multiple algorithms in a single PR are not allowed require descriptive names This PR needs descriptive function and/or variable names require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html tests are failing Do not merge until tests pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding Fibonacci Heap data structure implementation codes
2 participants