array_arithmetic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19d3fc33ed00ad3be2395498f6a347d2591311e5
+  data.tar.gz: 7096f3eeed87c320573d357e502ce4808a7411b9
+SHA512:
+  metadata.gz: 9c18284274a084b7d2274ffe1fcbcbbd41f885512994e85d7f3b1af35c03c52198434706d40f3503e16dc8fa9b0f55d0245b240af9be861787cbbcd2c011d416
+  data.tar.gz: 517520ae5139fd5b72f10cf0506bc000c2ecac7feeb36a9098399bef25095f2545b0e480230be829b4268a1b0d6ab70bd99a102b5afb61744d1f30b84abb0496

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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in array_arithmetic.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    array_arithmetic (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  array_arithmetic!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 C.J. Adeszko
+
+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,132 @@
+# Array_Arithmetic
+
+[![Build Status](https://travis-ci.com/CJAdeszko/array_arithmetic.svg?branch=master)](https://travis-ci.com/CJAdeszko/array_arithmetic)
+
+Array_Arithmetic provides users the ability to perform common math functions on entire arrays in Ruby. This gem provides methods for the following math functions:
+
+  - Addition
+  - Subtraction
+  - Multiplication
+  - Division
+  - Remainders
+  - Exponents
+  - Square
+  - Square root
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'array_arithmetic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install array_arithmetic
+
+## Usage
+
+The `array_arithmetic` gem provides the following methods for use:
+
+  - add()
+  - subtract()
+  - multiply()
+  - divide()
+  - remainder()
+  - exponent()
+  - square()
+  - square_root()
+
+To use a method within your code, simply include the module at the top of the file:
+
+```ruby
+include ArrayArithmetic
+```
+
+Then, you are able to call methods as follows:
+
+```ruby
+arr_one = [1, 2, 3, 4, 5]
+arr_two = [9, 8, 7, 6, 5]
+
+add(arr_one, arr_two)
+#returns [10, 10, 10, 10, 10]
+
+subtract(arr_one, arr_two)
+#returns [-8, -6, -4, -2, 0]
+
+multiply(arr_one, arr_two)
+#returns [9, 16, 21, 24, 25]
+
+exponent(arr_one, arr_two)
+#returns [1, 256, 2187, 4096, 3125]
+```
+
+Note that both the `divide` and `remainder` methods return values as a float, and have an optional third argument `sig_dig`, which defaults to 2. If desired, an integer can be passed as a third argument to the method to change the number of significant digits the method returns:
+
+```ruby
+arr_one = [1, 2, 3, 4, 5]
+arr_two = [9, 8, 7, 6, 5]
+
+divide(arr_one, arr_two)
+#returns [0.11, 0.25, 0.43, 0.67, 1.0]
+
+divide(arr_one, arr_two, 4)
+#returns [0.1111, 0.25, 0.4286, 0.6667, 1.0]
+
+remainder(arr_one, arr_two)
+#returns [1.0, 2.0, 3.0, 4.0, 0.0]
+
+remainder(arr_one, 0.405, 4)
+#returns [0.19, 0.38, 0.165, 0.355, 0.14]
+```
+
+Note that both the `square` and `square_root` methods take in only one array as an argument.
+
+```ruby  
+arr_one = [1, 2, 3, 4, 5]
+arr_two = [9, 8, 7, 6, 5]
+
+square(arr_one)
+#returns [1, 4, 9, 16, 25]
+
+square_root(arr_two)
+#returns [3.0, 2.8284271247461903, 2.6457513110645907, 2.449489742783178, 2.23606797749979]
+```
+
+If arrays of unequal length are passed into any method, the values of shorter of the two arrays are recycled so that an array matching the length of the longer array is returned:
+
+```ruby
+arr_one = [1, 2, 3, 4, 5]
+arr_two = [9, 8, 7, 6, 5, 4, 3, 2, 1]
+
+#arr_one values are recycled making arr_one = [1, 2, 3, 4, 5, 1, 2, 3, 4]
+
+add(arr_one, arr_two)
+#returns [10, 10, 10, 10, 10, 5, 5, 5, 5]
+```
+
+Additionally, note that the first argument passed to any of the methods MUST be an array, otherwise, the method will raise an error. However, the second argument can be either an array or a single number which will be used in the methods calculations:
+
+```ruby
+arr_one = [1, 2, 3, 4, 5]
+
+multiply(arr_one, 5)
+#returns [5, 10, 15, 20, 25]
+
+divide(arr_one, 0.5)
+#returns [2.0, 4.0, 6.0, 8.0, 10.0]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CJAdeszko/array_arithmetic.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/array_arithmetic.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "array_arithmetic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "array_arithmetic"
+  spec.version       = ArrayArithmetic::VERSION
+  spec.authors       = ["C.J. Adeszko"]
+
+  spec.summary       = "Provides users with methods for performing common math functions on arrays."
+  spec.homepage      = "https://github.com/CJAdeszko/array_arithmetic"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = "https://github.com/CJAdeszko/array_arithmetic"
+  spec.metadata["source_code_uri"] = "https://github.com/CJAdeszko/array_arithmetic"
+  spec.metadata["documentation_uri"] = "https://github.com/CJAdeszko/array_arithmetic"
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "array_arithmetic"
+
+# 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/lib/array_arithmetic.rb

@@ -0,0 +1,226 @@
+require "array_arithmetic/version"
+
+module ArrayArithmetic
+  class Error < StandardError; end
+
+  #Return an argument as an array for use with arithmetic methods
+  def make_array(arg)
+    return [arg]
+  end
+
+  #Takes in two arrays of unequal length passed to the arithmetic method
+  #Recycles values from the shorter array
+  #Returns an array containing two arrays of equal length
+  def update_array_length(arr_one, arr_two)
+    if arr_one.length < arr_two.length
+      adjusted_arr_one = []
+      arr_two.each_with_index do |value, index|
+        if arr_one.length == 1
+          adjusted_arr_one << arr_one[0]
+        elsif index >= arr_one.length
+          adjusted_arr_one << arr_one[index - arr_one.length]
+        else
+          adjusted_arr_one << arr_one[index]
+        end
+      end
+      return adjusted_arr_one, arr_two
+    elsif arr_one.length > arr_two.length
+      adjusted_arr_two = []
+      arr_one.each_with_index do |value, index|
+        if arr_two.length == 1
+          adjusted_arr_two << arr_two[0]
+        elsif index >= arr_two.length
+          adjusted_arr_two << arr_two[index - arr_two.length]
+        else
+          adjusted_arr_two << arr_two[index]
+        end
+      end
+      return arr_one, adjusted_arr_two
+    end
+  end
+
+
+  #Adds the values of corresponding indices of two arrays
+  def add(arr_one, arr_two)
+    raise ArgumentError, 'First argument is not an array' unless arr_one.is_a? Array
+
+    result = []
+
+    if arr_two.class != Array
+      arr_two = make_array(arr_two)
+    end
+
+    if arr_one.length != arr_two.length
+      length_matched_arrays = update_array_length(arr_one, arr_two)
+
+      length_matched_arrays[0].each_with_index do |value, index|
+        result << value + length_matched_arrays[1][index]
+      end
+    else
+      arr_one.each_with_index do |value, index|
+        result << value + arr_two[index]
+      end
+    end
+
+    return result
+  end
+
+
+  #Subtracts the values of corresponding indices of two arrays
+  def subtract(arr_one, arr_two)
+    raise ArgumentError, 'First argument is not an array' unless arr_one.is_a? Array
+
+    result = []
+
+    if arr_two.class != Array
+      arr_two = make_array(arr_two)
+    end
+
+    if arr_one.length != arr_two.length
+      length_matched_arrays = update_array_length(arr_one, arr_two)
+
+      length_matched_arrays[0].each_with_index do |value, index|
+        result << value - length_matched_arrays[1][index]
+      end
+    else
+      arr_one.each_with_index do |value, index|
+        result << value - arr_two[index]
+      end
+    end
+
+    return result
+  end
+
+
+  #Multiplies the values of corresponding indices of two arrays
+  def multiply(arr_one, arr_two)
+    raise ArgumentError, 'First argument is not an array' unless arr_one.is_a? Array
+
+    result = []
+
+    if arr_two.class != Array
+      arr_two = make_array(arr_two)
+    end
+
+    if arr_one.length != arr_two.length
+      length_matched_arrays = update_array_length(arr_one, arr_two)
+
+      length_matched_arrays[0].each_with_index do |value, index|
+        result << value * length_matched_arrays[1][index]
+      end
+    else
+      arr_one.each_with_index do |value, index|
+        result << value * arr_two[index]
+      end
+    end
+
+    return result
+  end
+
+
+  #Divides the values of corresponding indices of two arrays
+  #Returns values as a float
+  def divide(arr_one, arr_two, sig_dig=2)
+    raise ArgumentError, 'First argument is not an array' unless arr_one.is_a? Array
+
+    result = []
+
+    if arr_two.class != Array
+      arr_two = make_array(arr_two)
+    end
+
+    if arr_one.length != arr_two.length
+      length_matched_arrays = update_array_length(arr_one, arr_two)
+
+      length_matched_arrays[0].each_with_index do |value, index|
+        if length_matched_arrays[1][index] == 0
+          result << "Divide by 0 error"
+        else
+          result << (value.to_f / length_matched_arrays[1][index]).round(sig_dig)
+        end
+      end
+    else
+      arr_one.each_with_index do |value, index|
+        if arr_two[index] == 0
+          result << "Divide by 0 error"
+        else
+          result << (value.to_f / arr_two[index]).round(sig_dig)
+        end
+      end
+    end
+
+    return result
+  end
+
+
+  #Calculates the remainder of corresponding inidices of two arrays
+  def remainder(arr_one, arr_two, sig_dig=2)
+    raise ArgumentError, 'First argument is not an array' unless arr_one.is_a? Array
+
+    result = []
+
+    if arr_two.class != Array
+      arr_two = make_array(arr_two)
+    end
+
+    if arr_one.length != arr_two.length
+      length_matched_arrays = update_array_length(arr_one, arr_two)
+
+      length_matched_arrays[0].each_with_index do |value, index|
+        if length_matched_arrays[1][index] == 0
+          result << "Divide by 0 error"
+        else
+          result << (value.to_f % length_matched_arrays[1][index]).round(sig_dig)
+        end
+      end
+    else
+      arr_one.each_with_index do |value, index|
+        if arr_two[index] == 0
+          result << "Divide by 0 error"
+        else
+          result << (value.to_f % arr_two[index]).round(sig_dig)
+        end
+      end
+    end
+
+    return result
+  end
+
+
+  #Raises the values of arr_one to the power of the value at corresponding indices in arr_two
+  def exponent(arr_one, arr_two)
+    raise ArgumentError, 'First argument is not an array' unless arr_one.is_a? Array
+
+    result = []
+
+    if arr_two.class != Array
+      arr_two = make_array(arr_two)
+    end
+
+    if arr_one.length != arr_two.length
+      length_matched_arrays = update_array_length(arr_one, arr_two)
+
+      length_matched_arrays[0].each_with_index do |value, index|
+        result << value ** length_matched_arrays[1][index]
+      end
+    else
+      arr_one.each_with_index do |value, index|
+        result << value ** arr_two[index]
+      end
+    end
+
+    return result
+  end
+
+
+  #Squares the values of an array
+  def square(array)
+    return exponent(array, 2)
+  end
+
+
+  #Returns the square root of each value of an array
+  def square_root(array)
+    return exponent(array, 0.5)
+  end
+end

data/lib/array_arithmetic/version.rb

@@ -0,0 +1,3 @@
+module ArrayArithmetic
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: array_arithmetic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- C.J. Adeszko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- array_arithmetic-0.1.0.gem
+- array_arithmetic.gemspec
+- bin/console
+- bin/setup
+- lib/array_arithmetic.rb
+- lib/array_arithmetic/version.rb
+homepage: https://github.com/CJAdeszko/array_arithmetic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CJAdeszko/array_arithmetic
+  source_code_uri: https://github.com/CJAdeszko/array_arithmetic
+  documentation_uri: https://github.com/CJAdeszko/array_arithmetic
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Provides users with methods for performing common math functions on arrays.
+test_files: []