ruby-gr 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07da9fb7d76476cb7598eac022e5a1b5e4004af6e0bdd0e87d1acd817f36abc7
-  data.tar.gz: 87961c4df97b188a7c5fbd77a9e0ac993a6190ddc9e3fc2f9c30b2c7e88c19cb
+  metadata.gz: 29a78c0f4c5e3ab3afdc4245ab4dd6d9ce7d6c4f38638901a93487e366c219c6
+  data.tar.gz: 72f3fb64d9508c28338214583b185c041362f3e8b31a138ab9990cba4669b27a
 SHA512:
-  metadata.gz: bb5d8869e80d488a5b2076eb80125136f27f18b4e352066ba1c5260b343440b7474ace25d708464c827954c1f02f47c682e83eff0b3e0a47d0374b58bc74ad09
-  data.tar.gz: 677a4c8839974102a3d4ac618f41cd06b23e4c7d7d68f70110efb7f838c1689588fc00f8c462eabfe724c7fe7a639319bd83728d047901ddd9013bba3c3db029
+  metadata.gz: e0b0766224a375477115ff004467b4b5196689bff28846efabd31f078bd7f36d00a5f736e088f0a8333327d9eb6f8d80e398365e79d26e99f6303e2975b66c1c
+  data.tar.gz: 69dbc6bc3859bad4e3d67c2d2131b48c41c659e79c2f9b8b0f3250fb15cb94a3c29cc0b10c217fd1b354784ac969f2d82d9be256f59e5f0224d4d597b94ea131

data/README.md

@@ -22,28 +22,22 @@
 ![face](https://i.imgur.com/uLCKi2r.png)
 ![shade](https://i.imgur.com/VJmS3EQ.png)
 
-:bar_chart:  [GR framework](https://github.com/sciapp/gr) - the graphics library for visualization - for Ruby
+:bar_chart:  [GR framework](https://github.com/sciapp/gr) - powerful visualization library - for Ruby
 
 ## Installation
 
 GR.rb supports Ruby 2.4+.
 
-[Install GR](#gr-installation).
-
-Set environment variable GRDIR, if you have not already done. 
+First, [install GR](#gr-installation). Next, set environment variable `GRDIR`. 
 
 ```sh
 export GRDIR="/your/path/to/gr"
 ```
 
-Add this line to your application's Gemfile:
-
 ```sh
-gem 'ruby-gr'
+gem install ruby-gr
 ```
 
-GR3 and GR::Plot require [numo-narray](https://github.com/ruby-numo/numo-narray).
-
 ## Quick Start
 
 <p align="center">
@@ -81,15 +75,15 @@ GR.plot(
 )
 ```
 
-Save to PNG file.
+Save in PNG format.
 
 ```ruby
 GR.savefig("figure.png")
 ```
 
-## Features
+## API Overview
 
-There are two layers to the GR.rb API. 
+There are two different approaches to plotting with GR.rb. One way is to call Matlab-like APIs. The other is to call GR/GR3 native functions. We are planning to prepare a more object-oriented interface based on [GRUtils.jl](https://github.com/heliosdrm/GRUtils.jl) in the future.
 
 #### GR::Plot - A simple, matlab-style API. 
 
@@ -126,6 +120,8 @@ List of vailable functions. See [GR.rb Wiki](https://github.com/red-data-tools/G
 
 #### GR - A module for calling native GR functions.
 
+2-D Plots and common 3-D Plots.
+
 ```ruby
 require 'gr'
 
@@ -136,6 +132,8 @@ GR.setwindow(0.0, 20.0, 0.0, 20.0)
 
 #### GR3 - A module for calling native GR3 functions.
 
+Complex 3D scenes.
+
 ```ruby
 require 'gr3'
 
@@ -143,8 +141,6 @@ require 'gr3'
 GR3.cameralookat(-3, 2, -2, 0, 0, 0, 0, 0, -1)
 ```
 
-* GR.rb can be used in Jupyter Notebook.
-
 ## Documentation
 
 - [GR.rb Wiki](https://github.com/red-data-tools/GR.rb/wiki)
@@ -167,26 +163,26 @@ export GRDIR="your/path/to/gr"
 
 ### Using your package manager
 
-* The third party GR packages for Mac, Linux and Windows (for advanced users) are available.
-* If you find problems, please report to the [issue](https://github.com/red-data-tools/GR.rb/issues).
+* The third party GR packages for Mac, Linux and Windows are available (for advanced users).
+* If you find any problem, please report the issue [here](https://github.com/red-data-tools/GR.rb/issues).
 
-#### Mac: Homebrew
+#### Mac - Homebrew
 
 ```sh
 brew install libgr
 ```
 
-Set environment variable GRDIR.
+Set environment variable `GRDIR`.
 
 ```sh
 export GRDIR=$(brew --prefix libgr)
 ```
 
-#### Linux: APT Yum
+#### Linux - APT Yum
 
 [packages.red-data-tools.org](https://github.com/red-data-tools/packages.red-data-tools.org) provides `libgr-dev` and `libgr3-dev`.
 
-#### Windows: MSYS2
+#### Windows - MSYS2
 
 If you are using Rubyinstaller, pacman will automatically install [mingw-w64-gr](https://packages.msys2.org/base/mingw-w64-gr) when the gem is installed.
 

data/lib/gr/plot.rb

@@ -38,59 +38,58 @@ module GR
 
     # Keyword options conform to GR.jl.
     KW_ARGS = %i[accelerate algorithm alpha ax backgroundcolor barwidth baseline
-                 clabels clear clim color colormap crange figsize horizontal
+                 clabels clear clim color colormap crange figsize grid horizontal
                  isovalue kind label labels levels location nbins ratio rotation
                  scale size spec subplot tilt title update xaxis xflip xform
-                 xlabel xlim xlog xrange yaxis yflip ylabel ylim ylog zflip
-                 yrange viewport vp where window zaxis zlabel zlim zlog zrange].freeze
+                 xlabel xlim xlog xrange xticks yaxis yflip ylabel ylim ylog
+                 zflip yrange yticks viewport vp where window zaxis zlabel zlim
+                 zlog zrange zticks].freeze
 
     @last_plot = nil
     class << self
       attr_accessor :last_plot
     end
 
-    def initialize(*args)
-      @kvs = if args[-1].is_a? Hash
-               args.pop
-             else
-               {}
-             end
+    attr_accessor :args, :kvs, :scheme
+
+    def initialize(*raw_args)
+      @kvs = raw_args.last.is_a?(Hash) ? raw_args.pop : {}
+      @args = plot_args(raw_args) # method name is the same as Julia/Python
+
       # Check keyword options.
-      @kvs.each_key do |k|
-        warn "Unknown keyword: #{k}" unless KW_ARGS.include? k
-      end
+      kvs.each_key { |k| warn "Unknown keyword: #{k}" unless KW_ARGS.include? k }
 
       # label(singular form) is a original keyword arg which GR.jl does not have.
-      @kvs[:labels] = [@kvs[:label]] if @kvs[:label] && @kvs[:labels].nil?
-
-      @args = plot_args(args) # method name is the same as Julia/Python
-      @kvs[:size] ||= [600, 450]
-      @kvs[:ax] = false if @kvs[:ax].nil?
-      @kvs[:subplot] ||= [0, 1, 0, 1]
-      @kvs[:clear] = true if @kvs[:clear].nil?
-      @kvs[:update] = true if @kvs[:update].nil?
-      @scheme = 0
+      kvs[:labels] ||= [kvs[:label]] if kvs.has_key? :label
+
+      # Don't use || because we need to tell `false` from `nil`
+      kvs[:size]    = [600, 450]   unless kvs.has_key? :size
+      kvs[:ax]      = false        unless kvs.has_key? :ax
+      kvs[:subplot] = [0, 1, 0, 1] unless kvs.has_key? :subplot
+      kvs[:clear]   = true         unless kvs.has_key? :clear
+      kvs[:update]  = true         unless kvs.has_key? :update
+
+      @scheme     = 0
       @background = 0xffffff
-      @handle = nil
+      # @handle     = nil           # This variable will be used in gr_meta
+
       self.class.last_plot = self
     end
-    attr_accessor :args, :kvs, :scheme
 
     def set_viewport(kind, subplot)
       mwidth, mheight, width, height = GR.inqdspsize
-      if kvs[:figsize]
-        w = 0.0254 * width * kvs[:figsize][0] / mwidth
-        h = 0.0254 * height * kvs[:figsize][1] / mheight
-      else
-        dpi = width / mwidth * 0.0254
-        if dpi > 200
-          w, h = kvs[:size].map { |x| x * dpi / 100 }
-        else
-          w, h = kvs[:size]
-        end
-      end
-      viewport = [0, 0, 0, 0]
+      dpi = width / mwidth * 0.0254
+      w, h = if kvs[:figsize]
+               [(0.0254 * width  * kvs[:figsize][0] / mwidth),
+                (0.0254 * height * kvs[:figsize][1] / mheight)]
+             elsif dpi > 200
+               kvs[:size].map { |i| i * dpi / 100 }
+             else
+               kvs[:size]
+             end
+
       vp = subplot.clone
+
       if w > h
         ratio = h / w.to_f
         msize = mwidth * w / width
@@ -106,6 +105,7 @@ module GR
         vp[0] *= ratio
         vp[1] *= ratio
       end
+
       if %i[wireframe surface plot3 scatter3 trisurf volume].include?(kind)
         extent = [vp[1] - vp[0], vp[3] - vp[2]].min
         vp1 = 0.5 * (vp[0] + vp[1] - extent)
@@ -115,10 +115,12 @@ module GR
       else
         vp1, vp2, vp3, vp4 = vp
       end
-      viewport[0] = vp1 + 0.125 * (vp2 - vp1)
-      viewport[1] = vp1 + 0.925 * (vp2 - vp1)
-      viewport[2] = vp3 + 0.125 * (vp4 - vp3)
-      viewport[3] = vp3 + 0.925 * (vp4 - vp3)
+
+      viewport = [vp1 + 0.125 * (vp2 - vp1),
+                  vp1 + 0.925 * (vp2 - vp1),
+                  vp3 + 0.125 * (vp4 - vp3),
+                  vp3 + 0.925 * (vp4 - vp3)]
+
       if %i[contour contourf hexbin heatmap nonuniformheatmap polarheatmap
             surface trisurf volume].include?(kind)
         viewport[1] -= 0.1
@@ -132,11 +134,11 @@ module GR
         end
       end
 
-      GR.setviewport(viewport[0], viewport[1], viewport[2], viewport[3])
+      GR.setviewport(*viewport)
 
       kvs[:viewport] = viewport
-      kvs[:vp] = vp
-      kvs[:ratio] = ratio
+      kvs[:vp]       = vp
+      kvs[:ratio]    = ratio
 
       if kvs[:backgroundcolor]
         GR.savestate
@@ -166,14 +168,15 @@ module GR
     def set_window(kind)
       scale = 0
       unless %i[polar polarhist polarheatmap].include?(kind)
-        scale |= GR::OPTION_X_LOG if kvs[:xlog]
-        scale |= GR::OPTION_Y_LOG if kvs[:ylog]
-        scale |= GR::OPTION_Z_LOG if kvs[:zlog]
+        scale |= GR::OPTION_X_LOG  if kvs[:xlog]
+        scale |= GR::OPTION_Y_LOG  if kvs[:ylog]
+        scale |= GR::OPTION_Z_LOG  if kvs[:zlog]
         scale |= GR::OPTION_FLIP_X if kvs[:xflip]
         scale |= GR::OPTION_FLIP_Y if kvs[:yflip]
         scale |= GR::OPTION_FLIP_Z if kvs[:zflip]
       end
       kvs[:scale] = scale
+
       if kvs.has_key?(:panzoom)
         xmin, xmax, ymin, ymax = GR.panzoom(*kvs[:panzoom])
         kvs[:xrange] = [xmin, xmax]
@@ -185,65 +188,74 @@ module GR
       major_count = %i[wireframe surface plot3 scatter3 polar polarhist
                        polarheatmap trisurf volume].include?(kind) ? 2 : 5
 
+      kvs[:xticks] = [kvs[:xticks], major_count] if kvs[:xticks].is_a? Numeric
+      kvs[:yticks] = [kvs[:yticks], major_count] if kvs[:yticks].is_a? Numeric
+      kvs[:zticks] = [kvs[:zticks], major_count] if kvs[:zticks].is_a? Numeric
+
       xmin, xmax = kvs[:xrange]
-      if (scale & GR::OPTION_X_LOG) == 0
-        xmin, xmax = GR.adjustlimits(xmin, xmax) unless kvs.has_key?(:xlim) || kvs.has_key?(:panzoom)
-        if kvs.has_key?(:xticks)
-          xtick, majorx = kvs[:xticks]
-        else
-          majorx = major_count
-          xtick = GR.tick(xmin, xmax) / majorx
-        end
-      else
-        xtick = majorx = 1
+      if %i[heatmap polarheatmap].include?(kind) && kvs.has_key?(:xlim)
+        xmin -= 0.5
+        xmax += 0.5
       end
-      xorg = if (scale & GR::OPTION_FLIP_X) == 0
-               [xmin, xmax]
-             else
-               [xmax, xmin]
-             end
+      xtick, majorx = if (scale & GR::OPTION_X_LOG) == 0
+                        unless %i[heatmap polarheatmap].include?(kind)
+                          unless kvs.has_key?(:xlim)
+                            xmin, xmax = GR.adjustlimits(xmin, xmax) unless kvs[:panzoom]
+                          end
+                        end
+                        if kvs.has_key?(:xticks)
+                          kvs[:xticks]
+                        else
+                          [GR.tick(xmin, xmax) / major_count, major_count]
+                        end
+                      else
+                        [1, 1]
+                      end
+      xorg = (scale & GR::OPTION_FLIP_X) == 0 ? [xmin, xmax] : [xmax, xmin]
       kvs[:xaxis] = xtick, xorg, majorx
 
       ymin, ymax = kvs[:yrange]
-      if kind == :hist && !kvs.has_key?(:ylim)
-        ymin = (scale & GR::OPTION_Y_LOG) == 0 ? 0 : 1
+      if %i[heatmap polarheatmap].include?(kind) && kvs.has_key?(:ylim)
+        ymin -= 0.5
+        ymax += 0.5
       end
-      if (scale & GR::OPTION_Y_LOG) == 0
-        ymin, ymax = GR.adjustlimits(ymin, ymax) unless kvs.has_key?(:ylim) || kvs.has_key?(:panzoom)
-        if kvs.has_key?(:yticks)
-          ytick, majory = kvs[:yticks]
-        else
-          majory = major_count
-          ytick = GR.tick(ymin, ymax) / majory
+      if kind == :hist
+        if kvs[:horizontal] && !kvs.has_key?(:xlim)
+          xmin = (scale & GR::OPTION_X_LOG) == 0 ? 0 : 1
+        elsif !kvs.has_key?(:ylim)
+          ymin = (scale & GR::OPTION_Y_LOG) == 0 ? 0 : 1
         end
-      else
-        ytick = majory = 1
       end
-      yorg = if (scale & GR::OPTION_FLIP_Y) == 0
-               [ymin, ymax]
-             else
-               [ymax, ymin]
-             end
+      ytick, majory = if (scale & GR::OPTION_Y_LOG) == 0
+                        unless %i[heatmap polarheatmap].include?(kind)
+                          unless kvs.has_key?(:ylim)
+                            ymin, ymax = GR.adjustlimits(ymin, ymax) unless kvs[:panzoom]
+                          end
+                        end
+                        if kvs.has_key?(:yticks)
+                          kvs[:yticks]
+                        else
+                          [GR.tick(ymin, ymax) / major_count, major_count]
+                        end
+                      else
+                        [1, 1]
+                      end
+      yorg = (scale & GR::OPTION_FLIP_Y) == 0 ? [ymin, ymax] : [ymax, ymin]
       kvs[:yaxis] = ytick, yorg, majory
 
       if %i[wireframe surface plot3 scatter3 trisurf volume].include?(kind)
         zmin, zmax = kvs[:zrange]
-        if (scale & GR::OPTION_Z_LOG) == 0
-          zmin, zmax = GR.adjustlimits(zmin, zmax) if kvs.has_key?(:zlim)
-          if kvs.has_key?(:zticks)
-            ztick, majorz = kvs[:zticks]
-          else
-            majorz = major_count
-            ztick = GR.tick(zmin, zmax) / majorz
-          end
-        else
-          ztick = majorz = 1
-        end
-        zorg = if (scale & GR::OPTION_FLIP_Z) == 0
-                 [zmin, zmax]
-               else
-                 [zmax, zmin]
-               end
+        ztick, majorz = if (scale & GR::OPTION_Z_LOG) == 0
+                          zmin, zmax = GR.adjustlimits(zmin, zmax) if kvs.has_key?(:zlim)
+                          if kvs.has_key?(:zticks)
+                            kvs[:zticks]
+                          else
+                            [GR.tick(zmin, zmax) / major_count, major_count]
+                          end
+                        else
+                          [1, 1]
+                        end
+        zorg = (scale & GR::OPTION_FLIP_Z) == 0 ? [zmin, zmax] : [zmax, zmin]
         kvs[:zaxis] = ztick, zorg, majorz
       end
 
@@ -255,7 +267,7 @@ module GR
       end
       if %i[wireframe surface plot3 scatter3 trisurf volume].include?(kind)
         rotation = kvs[:rotation] || 40
-        tilt = kvs[:tilt] || 70
+        tilt     = kvs[:tilt]     || 70
         GR.setspace(zmin, zmax, rotation, tilt)
       end
 
@@ -655,14 +667,26 @@ module GR
           GR.polymarker(x, y)
 
         when :hist
-          ymin = kvs[:window][2]
-          y.length.times do |i|
-            GR.setfillcolorind(989)
-            GR.setfillintstyle(GR::INTSTYLE_SOLID)
-            GR.fillrect(x[i], x[i + 1], ymin, y[i])
-            GR.setfillcolorind(1)
-            GR.setfillintstyle(GR::INTSTYLE_HOLLOW)
-            GR.fillrect(x[i], x[i + 1], ymin, y[i])
+          if kvs[:horizontal]
+            xmin = kvs[:window][0]
+            x.length.times do |i|
+              GR.setfillcolorind(989)
+              GR.setfillintstyle(GR::INTSTYLE_SOLID)
+              GR.fillrect(xmin, x[i], y[i], y[i + 1])
+              GR.setfillcolorind(1)
+              GR.setfillintstyle(GR::INTSTYLE_HOLLOW)
+              GR.fillrect(xmin, x[i], y[i], y[i + 1])
+            end
+          else
+            ymin = kvs[:window][2]
+            y.length.times do |i|
+              GR.setfillcolorind(989)
+              GR.setfillintstyle(GR::INTSTYLE_SOLID)
+              GR.fillrect(x[i], x[i + 1], ymin, y[i])
+              GR.setfillcolorind(1)
+              GR.setfillintstyle(GR::INTSTYLE_HOLLOW)
+              GR.fillrect(x[i], x[i + 1], ymin, y[i])
+            end
           end
 
         when :polarhist
@@ -1057,7 +1081,8 @@ module GR
       args.each do |x, y, z, c|
         if x
           if scale & GR::OPTION_X_LOG != 0
-            x.map! { |v| v > 0 ? v : Float::NAN }
+            # duck typing for NArray
+            x = x.map { |v| v > 0 ? v : Float::NAN }
           end
           x0, x1 = x.minmax
           xmin = [x0, xmin].min
@@ -1068,7 +1093,7 @@ module GR
         end
         if y
           if scale & GR::OPTION_Y_LOG != 0
-            y.map! { |v| v > 0 ? v : Float::NAN }
+            y = y.map { |v| v > 0 ? v : Float::NAN }
           end
           y0, y1 = y.minmax
           ymin = [y0, ymin].min
@@ -1079,7 +1104,7 @@ module GR
         end
         if z
           if scale & GR::OPTION_Z_LOG != 0
-            z.map! { |v| v > 0 ? v : Float::NAN }
+            z = z.map { |v| v > 0 ? v : Float::NAN }
           end
           z0, z1 = z.minmax
           zmin = [z0, zmin].min
@@ -1293,11 +1318,15 @@ module GR
     end
 
     # (Plot) Draw a histogram.
-    def histogram(x, kv = {})
-      create_plot(:hist, x, kv) do |plt|
+    def histogram(series, kv = {})
+      create_plot(:hist, series, kv) do |plt|
         nbins = plt.kvs[:nbins] || 0
-        x, y = hist(x, nbins)
-        plt.args = [[x, y, nil, nil, '']]
+        x, y = hist(series, nbins)
+        plt.args = if kv[:horizontal]
+                     [[y, x, nil, nil, '']]
+                   else
+                     [[x, y, nil, nil, '']]
+                   end
       end
     end
 
@@ -1323,7 +1352,7 @@ module GR
     end
 
     # Set current subplot index.
-    def subplot(nr, nc, p)
+    def subplot(nr, nc, p, kv = {})
       xmin = 1
       xmax = 0
       ymin = 1
@@ -1342,7 +1371,7 @@ module GR
         # The policy of clearing when p[0]==1 is controversial
         clear: p[0] == 1,
         update: p[-1] == nr * nc
-      }
+      }.merge kv
     end
 
     # (Plot) Save the current figure to a file.

data/lib/gr_commons/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GRCommons
-  VERSION = '0.0.19'
+  VERSION = '0.0.20'
 end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: histogram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: histogram
+  name: numo-narray
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: numo-narray
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="