year_array 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 744393a48cc68b046935934fd50d9a59e438deaf
-  data.tar.gz: 2cb25cf70a31c9cc53e84b6f7f6b56209366f034
+  metadata.gz: c27523e5e7447a43332ad62a3517e894820d2712
+  data.tar.gz: 32b5b4a5adb89ada3f6887396977dfc8452db7f1
 SHA512:
-  metadata.gz: 29b79db8685253ca6b727bea4d8763b59b99d0c6b584a04ea6d04031779795b897ab8538a6cae6209d7439faa30f1bb59ba75eebfa6d07fb0542b60d7b964a54
-  data.tar.gz: 14b81ad5a0b1f4fb53f1eff7956b660044326f94cea23e292acb7131708f304dd2e9b91eded2f2726d0a4a85b4d2904f19bb551c2dfa2e1406e2d3243eb6834e
+  metadata.gz: b81a27c4fcb70ca838631b66db478136fae3feed76ab0bb1e6b0916d1d6ff9cb53e1a87a1289d6abd541609d291628bb3396eadd8b6e9eae6f7c2398a068d425
+  data.tar.gz: e822933a5c707124e1a0c0d895d8951b1e985951c018ada4ab4ae70be647d0ca5f5a788799efe0d30f31525630cb6a20c03fd36c73f695ac72850d9f811a8e78

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.travis.yml

@@ -1,7 +1,9 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.2.10
   - 2.3.7
+  - 2.4.4
   - 2.5.1
-  - jruby
+  - jruby-9.1.17.0
 before_install: gem install bundler -v 1.16.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    year_array (0.1.1)
+    year_array (0.1.4)
       activesupport (~> 4.2)
 
 GEM
@@ -46,6 +46,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
+    memory_profiler (0.9.10)
     method_source (0.9.0)
     minitest (5.11.3)
     nenv (0.3.0)
@@ -94,6 +95,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   coveralls (~> 0.8)
   guard-rspec (~> 4.7)
+  memory_profiler (~> 0.9)
   rake (~> 10.0)
   rspec (~> 3.0)
   year_array!

data/README.md

@@ -4,9 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/iwan/year_array/badge.svg?branch=master)](https://coveralls.io/github/iwan/year_array?branch=master)
 
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/year_array`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+It's basically a wrapper to an array in order to manage, do some calculation and check on 8760 (or 8784) hourly values related to a year.
 
 ## Installation
 
@@ -26,7 +24,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initialize
+
+```ruby
+arr = Yarray.new(2018)
+arr.to_s   => "start_time: 2018-01-01 00:00:00 +0100, arr: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, ..., 0.0]"
+```
+will initialize the array to zero.
+
+Otherwise pass the init value:
+```ruby
+arr = Yarray.new(2018, value: 1.0)
+arr.to_s   => "start_time: 2018-01-01 00:00:00 +0100, arr: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, ..., 0.0]"
+```
+You can also pass an init array:
+```ruby
+arr = Yarray.new(2018, arr: [0.0, 1.0, 2, 3])
+arr.to_s   => "start_time: 2018-01-01 00:00:00 +0100, arr: [0.0, 1.0, 2.0, 3.0, 0.0, 0.0, 0.0, ..., 0.0]"
+```
+The array will be truncated or filled with zero values in order to reach the correct number of hours in year.
+
+### Functions
+```ruby
+ya1 = Yarray.new(2018, value: 1.0)
+ya2 = Yarray.new(2018, value: 2.0)
+
+ya1.size   # => 8760
+ya1.year   # => 2018
+
+# Operations on each element of array
+
+# The result will be stored in a new yarray object (more memory expensive):
+ya1 + ya2
+ya1 - ya2
+ya1 * ya2
+ya1 / ya2
+
+# The operation will be computed in the caller ya1:
+ya1.add(ya2)
+ya1.subtract(ya2)
+ya1.multiply(ya2)
+ya1.divide(ya2)
+
+
+Yarray.min(ya1, ya2)   # return a Yarray object where each value is the minimum between value of ya1 and ya2
+Yarray.max(ya1, ya2)   # return a Yarray object where each value is the maximum between value of ya1 and ya2
+
+ya1.any_positive?
+ya1.any_negative?
+
+ya1.any do |v|
+  v > 100
+end
+
+```
+
 
 ## Development
 

data/lib/year_array/version.rb

@@ -1,3 +1,3 @@
 module YearArray
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/year_array/yarray.rb

@@ -19,6 +19,31 @@ module YearArray
       @start_time.year
     end
 
+    def add(other)
+      raise_error_on_misalignment other
+      @arr.each_with_index{|v, i| @arr[i]=v+other.arr[i]}
+      self
+    end
+
+    def subtract(other)
+      raise_error_on_misalignment other
+      @arr.each_with_index{|v, i| @arr[i]=v-other.arr[i]}
+      self
+    end
+
+    def multiply(other)
+      raise_error_on_misalignment other
+      @arr.each_with_index{|v, i| @arr[i]=v*other.arr[i]}
+      self
+    end
+
+    def divide(other)
+      raise_error_on_misalignment other
+      @arr.each_with_index{|v, i| @arr[i]=v/other.arr[i]}
+      self
+    end
+
+
     def +(other)
       raise_error_on_misalignment other
       a = Arr.new(size){ |i| arr[i]+other.arr[i] }

data/lib/year_array.rb

@@ -3,12 +3,10 @@ require 'active_support/core_ext/time/calculations'
 require 'active_support/core_ext/numeric/time'
 require 'active_support/core_ext/hash'
 
-
 require "year_array/version"
 require "year_array/exceptions"
 require "year_array/arr"
 require "year_array/time_helpers"
 require "year_array/yarray"
 
-
 include YearArray

data/year_array.gemspec

@@ -9,19 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Iwan Buetti"]
   spec.email         = ["iwan.buetti@gmail.com"]
 
-  spec.summary       = "Just a class to manage array of hourly numerical values related to a year"
+  spec.summary       = "Just an array wrapper to manage 8760 (or 8784) hourly values related to a year"
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/iwan/year_array"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -36,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_dependency "activesupport", "~> 4.2"
   spec.add_development_dependency 'coveralls', "~> 0.8"
+  spec.add_development_dependency 'memory_profiler', "~> 0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: year_array
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Iwan Buetti
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: 
 email:
 - iwan.buetti@gmail.com
@@ -145,5 +159,6 @@ rubyforge_project:
 rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
-summary: Just a class to manage array of hourly numerical values related to a year
+summary: Just an array wrapper to manage 8760 (or 8784) hourly values related to a
+  year
 test_files: []