golden_section_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e4f72e5544fb200d771bc4a3eedb4f16c6f6d4d79294876af139677b53c5848
+  data.tar.gz: 2a1859b64bbd1df7ebd0ef9aae02f744e581472d5e2ebd1322742007ba5e74ad
+SHA512:
+  metadata.gz: e37a3b4973b77ef09dbafdc23510b00b444ffaff3bf2a9548f867a99302bf51e3badf263b80cb81511148a153688305050241cd50fa9b4f21424df651a4c1986
+  data.tar.gz: c520abdede84e7e6d6f0ccc2b6d9bc1844963c769e6ec95b26775b41bc388da4d72041091d9ab5c70f7eda00cd8c580419e169ae6cd5499c8c825fd3487d3592

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6.7', '2.7.3', '3.0.1']
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install --jobs 4 --retry 3
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wendelscardua@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in golden_section_search.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    golden_section_search (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  golden_section_search!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Wendel Scardua
+
+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,57 @@
+[![CI Status](https://github.com/wendelscardua/golden_section_search/workflows/CI/badge.svg?branch=main)](https://github.com/wendelscardua/golden_section_search/actions?query=workflow%3ACI+branch%3Amain)
+[![Gem Version](https://badge.fury.io/rb/golden_section_search.svg)](https://badge.fury.io/rb/golden_section_search)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/wendelscardua/golden_section_search)
+
+# GoldenSectionSearch
+
+Compute a local minimum / maximum of an arbitrary function
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'golden_section_search'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install golden_section_search
+
+## Usage
+
+To find a local minimum of a function defined by a proc, between `left_value` and `right_value`, with some `tolerance`:
+
+```ruby
+GoldenSectionSearch.find_minimum(proc, left_value, right_value, tolerance)
+```
+
+For finding a maximum value instead:
+
+```ruby
+GoldenSectionSearch.find_maximum(proc, left_value, right_value, tolerance)
+```
+
+Tolerance can be omitted, the default value being `1.0e-5`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wendelscardua/golden_section_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wendelscardua/golden_section_search/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GoldenSectionSearch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wendelscardua/golden_section_search/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "golden_section_search"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/golden_section_search.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/golden_section_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "golden_section_search"
+  spec.version       = GoldenSectionSearch::VERSION
+  spec.authors       = ["Wendel Scardua"]
+  spec.email         = ["wendelscardua@gmail.com"]
+
+  spec.summary       = %q{Find local minimum/maximum of a function.}
+  spec.description   = %q{Find local minimum/maximum of an arbitrary function described by a proc.}
+  spec.homepage      = "https://github.com/wendelscardua/golden_section_search"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wendelscardua/golden_section_search"
+  spec.metadata["changelog_uri"] = "https://github.com/wendelscardua/golden_section_search/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/golden_section_search/version.rb

@@ -0,0 +1,3 @@
+module GoldenSectionSearch
+  VERSION = "0.1.0"
+end

data/lib/golden_section_search.rb

@@ -0,0 +1,37 @@
+require "golden_section_search/version"
+
+module GoldenSectionSearch
+  GOLDEN_RATIO = (Math.sqrt(5) + 1) / 2
+
+  def self.find_minimum(function, left_value, right_value, tolerance = 1.0e-5)
+    middle_left_value = right_value - (right_value - left_value) / GOLDEN_RATIO
+    middle_right_value = left_value + (right_value - left_value) / GOLDEN_RATIO
+    while (right_value - left_value).abs > tolerance
+      if function.call(middle_left_value) < function.call(middle_right_value)
+        right_value = middle_right_value
+      else
+        left_value = middle_left_value
+      end
+      middle_left_value = right_value - (right_value - left_value) / GOLDEN_RATIO
+      middle_right_value = left_value + (right_value - left_value) / GOLDEN_RATIO
+    end
+
+    (left_value + right_value) / 2
+  end
+
+  def self.find_maximum(function, left_value, right_value, tolerance = 1.0e-5)
+    middle_left_value = right_value - (right_value - left_value) / GOLDEN_RATIO
+    middle_right_value = left_value + (right_value - left_value) / GOLDEN_RATIO
+    while (right_value - left_value).abs > tolerance
+      if function.call(middle_left_value) > function.call(middle_right_value)
+        right_value = middle_right_value
+      else
+        left_value = middle_left_value
+      end
+      middle_left_value = right_value - (right_value - left_value) / GOLDEN_RATIO
+      middle_right_value = left_value + (right_value - left_value) / GOLDEN_RATIO
+    end
+
+    (left_value + right_value) / 2
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: golden_section_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wendel Scardua
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies: []
+description: Find local minimum/maximum of an arbitrary function described by a proc.
+email:
+- wendelscardua@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- golden_section_search.gemspec
+- lib/golden_section_search.rb
+- lib/golden_section_search/version.rb
+homepage: https://github.com/wendelscardua/golden_section_search
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wendelscardua/golden_section_search
+  source_code_uri: https://github.com/wendelscardua/golden_section_search
+  changelog_uri: https://github.com/wendelscardua/golden_section_search/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Find local minimum/maximum of a function.
+test_files: []