heapify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51a7513b7e04e069205261a19182ffef3bfa703acd31a30c32a7341ecd4b935b
+  data.tar.gz: 64b1ddace129544cca479eba4b856081efcf788dd93afabb156e2f9a0c3eaaea
+SHA512:
+  metadata.gz: c14ea46042ae6eb1de1d4bd98632ff8ed543c6a21f3f008f54c63d32ba64d2bccdfb69561a3d8361fdf7266238453945731c36d7e287e554a82a6e8d1b1da59d
+  data.tar.gz: 1f6c21864c04be6f3bf03f2d8ce3a9fa4c1ec00563338c7565f98a7ad26efd22190f4a55a020d95c6e4537a737cfa6c0b5153cd904bdd2bf90a61006bc7c125a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at garrison.jensen@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Garrison Jensen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Heapify
+
+Inspired by Python's heapq module, Heapify is a Ruby library that provides methods to transform an array into a min heap. A min heap is a binary tree where the parent node is less than or equal to its children.
+
+The API below differs from textbook heap algorithms in two aspects: (a) We use zero-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Ruby uses zero-based indexing. (b) Our pop method returns the smallest item, not the largest (called a “min heap” in textbooks; a “max heap” is more common in texts because of its suitability for in-place sorting).
+
+These two make it possible to view the heap as a regular Ruby list without surprises: heap[0] is the smallest item, and heap.sort maintains the heap invariant!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heapify'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install heapify
+```
+
+## Usage
+
+Heapify extends the Array class with the following methods:
+
+### `heapify`
+
+Transforms an array into a heap in-place. It has a time complexity of O(n) and a space complexity of O(1).
+
+```ruby
+array = [4, 1, 3, 2, 16, 9, 10, 14, 8, 7]
+heap = array.heapify
+# heap => [1, 2, 3, 4, 7, 9, 10, 14, 8, 16]
+```
+
+### `heap_push(val)`
+
+This method adds an element to the heap. It has a time complexity of O(log n) and a space complexity of O(1).
+
+```ruby
+array = [4, 1, 3, 2, 16, 9, 10, 14, 8, 7]
+array.heapify
+array.heap_push(5)
+# array => [1, 2, 3, 4, 5, 9, 10, 14, 8, 7, 16]
+```
+
+### `heap_pop`
+
+This method removes the smallest element from the heap and returns it. It has a time complexity of O(log n) and a space complexity of O(1).
+
+```ruby
+array = [4, 1, 3, 2, 16, 9, 10, 14, 8, 7]
+array.heapify
+array.heap_pop
+# => 1
+# array => [2, 4, 3, 7, 16, 9, 10, 14, 8]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/garrisonj/heapify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Heapify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/garrisonj/heapify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/heapify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Heapify
+  VERSION = "0.1.0"
+end

data/lib/heapify.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "heapify/version"
+
+module Heapify
+  # Provides a heapify method for arrays. It also provides methods for adding and removing elements from the heap.
+  module ArrayExtension
+    # Transforms an array into a heap, in-place, in linear time.
+    #
+    # @return [Array] The heapified array.
+    def heapify
+      (size / 2).downto(0) do |i|
+        heapify_down(i)
+      end
+      self
+    end
+
+    # Add an element to the heap.
+    #
+    # O(log n) time complexity.
+    #
+    # @param val [Object] The value to be added to the heap.
+    # @return [void]
+    def heap_push(val)
+      self << val
+      heapify_up(size - 1)
+    end
+
+    # Remove the minimum element from the heap.
+    #
+    # O(log n) time complexity.
+    #
+    # @return [Object, nil] The minimum element from the heap, or nil if the heap is empty.
+    def heap_pop
+      return if empty?
+
+      swap(0, size - 1)
+      min = pop
+      heapify_down(0)
+      min
+    end
+
+    private
+
+    def heapify_down(index)
+      left = 2 * index + 1
+      right = 2 * index + 2
+      smallest = index
+
+      smallest = left if left < size && self[left] < self[smallest]
+      smallest = right if right < size && self[right] < self[smallest]
+
+      return if smallest == index
+
+      swap(index, smallest)
+      heapify_down(smallest)
+    end
+
+    def heapify_up(index)
+      parent = (index - 1) / 2
+
+      return if index.zero? || self[parent] <= self[index]
+
+      swap(index, parent)
+      heapify_up(parent)
+    end
+
+    def swap(index1, index2)
+      self[index1], self[index2] = self[index2], self[index1]
+    end
+  end
+end
+
+Array.include Heapify::ArrayExtension

data/sig/heapify.rbs

@@ -0,0 +1,4 @@
+module Heapify
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: heapify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garrison Jensen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-24 00:00:00.000000000 Z
+dependencies: []
+description: Heapify is a gem that provides a heapify method for arrays. It also provides
+  methods for adding and removing elements from the heap.
+email:
+- garrison.jensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/heapify.rb
+- lib/heapify/version.rb
+- sig/heapify.rbs
+homepage: https://www.github.com/garrisonJ/heapify
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.github.com/garrisonJ/heapify
+  source_code_uri: https://www.github.com/garrisonJ/heapify
+  changelog_uri: https://www.github.com/garrisonJ/heapify/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Heapify is a gem that provides a heapify method for arrays.
+test_files: []