ruby-gr 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a782911565b4128622399489e47d79e7ced0d3880d9c5c5adacdae7fa24709
-  data.tar.gz: e89d9c7e5a5ae0bf53352f3afb71fd1206c9a0e7aa5a3ba83504457fa5689b7d
+  metadata.gz: 07da9fb7d76476cb7598eac022e5a1b5e4004af6e0bdd0e87d1acd817f36abc7
+  data.tar.gz: 87961c4df97b188a7c5fbd77a9e0ac993a6190ddc9e3fc2f9c30b2c7e88c19cb
 SHA512:
-  metadata.gz: 21a8aeb6c49da80f87bb764ba149ffa8c7e7bffa3ed171002d1c6963537b9f0b500a96f77eac6876c8c3a8af9601aad6c8a79dfd4e0aea6d7d356adfc59b04db
-  data.tar.gz: 99a2e4204e8eef936979895183d86003860e2b9b356a24bc0f132793177459fa8fc782cf8bdd4ac4c2a29fca6e77aff41d7501123e84917172009bc5b5907547
+  metadata.gz: bb5d8869e80d488a5b2076eb80125136f27f18b4e352066ba1c5260b343440b7474ace25d708464c827954c1f02f47c682e83eff0b3e0a47d0374b58bc74ad09
+  data.tar.gz: 677a4c8839974102a3d4ac618f41cd06b23e4c7d7d68f70110efb7f838c1689588fc00f8c462eabfe724c7fe7a639319bd83728d047901ddd9013bba3c3db029

data/README.md

@@ -6,9 +6,21 @@
 [![Gitter Chat](https://badges.gitter.im/red-data-tools/en.svg)](https://gitter.im/red-data-tools/en)
 [![Docs Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://rubydoc.info/gems/ruby-gr)
 
-<p align="center">
-  <img src="https://user-images.githubusercontent.com/5798442/70857099-13d57600-1f2c-11ea-8f3c-7d81065f13a5.png">
-</p>
+![rdatasets-1](https://i.imgur.com/XEQ6wKs.png)
+![stem](https://i.imgur.com/3w0Ejrm.png)
+![histogram](https://i.imgur.com/xUdoA2s.png)
+![barplot](https://i.imgur.com/52bOFKE.png)
+![scatter3](https://i.imgur.com/yTTVetQ.png)
+![volume](https://i.imgur.com/CuRN6oC.png)
+![griddata](https://i.imgur.com/58HdYDo.png)
+![2darray](https://i.imgur.com/aKR2FJG.png)
+![2dpolararray](https://i.imgur.com/cmSrxvS.png)
+![hexbin](https://i.imgur.com/unWhQHr.png)
+![rdatasets-2](https://i.imgur.com/ZPit2F5.png)
+![rdatasets-3](https://i.imgur.com/TbNoxwy.png)
+![surface](https://i.imgur.com/sWdaHme.png)
+![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
 
@@ -47,43 +59,101 @@ y = [0.3, 0.5, 0.4, 0.2, 0.6, 0.7]
 GR.plot(x, y)
 ```
 
-## Examples
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/5798442/84570709-242ab880-adca-11ea-9099-3a6b3418bf19.png">
+</p>
+
+```ruby
+require 'gr/plot'
+
+x  = Numo::DFloat.linspace(0, 10, 101)
+y1 = Numo::NMath.sin(x)
+y2 = Numo::NMath.cos(x)
+
+GR.plot(
+  [x, y1, 'bo'], [x, y2, 'g*'],
+  title:    "Multiple plot example",
+  xlabel:   "x",
+  ylabel:   "y",
+  ylim:     [-1.2, 1.2],
+  labels:   ["sin(x)", "cos(x)"],
+  location: 11
+)
+```
+
+Save to PNG file.
 
-Have a look in the [`examples`](https://github.com/red-data-tools/GR.rb/tree/master/examples) directory. 
-* [Example Gallery](https://github.com/red-data-tools/GR.rb/wiki/1.-Example-gallery)
+```ruby
+GR.savefig("figure.png")
+```
 
 ## Features
 
-#### GR::Plot
+There are two layers to the GR.rb API. 
 
-A simple, matlab-style API.
+#### GR::Plot - A simple, matlab-style API. 
 
 ```ruby
 require 'gr/plot'
+GR.plot(x, y)
 ```
 
-`plot` `step` `scatter` `stem` `histogram` `contour` `contourf` `hexbin` `heatmap` `wireframe` `surface` `plot3` `scatter3` `imshow` `isosurface` `polar` `polarhist` `polarheatmap` `trisurf` `tricont` `shade` `volume`
-
-#### GR
+List of vailable functions. See [GR.rb Wiki](https://github.com/red-data-tools/GR.rb/wiki) for details.
+
+[`plot`](../../wiki/Plotting-functions#plot)
+[`step`](../../wiki/Plotting-functions#step)
+[`plot3`](../../wiki/Plotting-functions#plot3)
+[`polar`](../../wiki/Plotting-functions#polar)
+[`scatter`](../../wiki/Plotting-functions#scatter)
+[`scatter3`](../../wiki/Plotting-functions#scatter3)
+[`stem`](../../wiki/Plotting-functions#stem)
+[`barplot`](../../wiki/Plotting-functions#barplot)
+[`histogram`](../../wiki/Plotting-functions#histogram)
+[`polarhistogram`](../../wiki/Plotting-functions#polarhistogram)
+[`hexbin`](../../wiki/Plotting-functions#hexbin)
+[`contour`](../../wiki/Plotting-functions#contour)
+[`contourf`](../../wiki/Plotting-functions#contourf)
+[`tricont`](../../wiki/Plotting-functions#tricont)
+[`surface`](../../wiki/Plotting-functions#surface)
+[`trisurf`](../../wiki/Plotting-functions#trisurf)
+[`wireframe`](../../wiki/Plotting-functions#wireframe)
+[`volume`](../../wiki/Plotting-functions#volume)
+[`heatmap`](../../wiki/Plotting-functions#heatmap)
+[`polarheatmap`](../../wiki/Plotting-functions#polarheatmap)
+[`shade`](../../wiki/Plotting-functions#shade)
+[`imshow`](../../wiki/Plotting-functions#imshow)
+[`isosurface`](../../wiki/Plotting-functions#isosurface)
+
+#### GR - A module for calling native GR functions.
 
 ```ruby
 require 'gr'
+
+# For example
+GR.setviewport(0.1, 0.9, 0.1, 0.9)
+GR.setwindow(0.0, 20.0, 0.0, 20.0)
 ```
 
-#### GR3
+#### GR3 - A module for calling native GR3 functions.
 
 ```ruby
 require 'gr3'
+
+# For example
+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)
 - [GR Framework](https://gr-framework.org/)
 - [GR.rb API Documentation](https://rubydoc.info/gems/ruby-gr)
 
 ## GR Installation
 
-### Official binary release
+### Installing an official release (recommended)
 
 Download the [latest release](https://github.com/sciapp/gr/releases).
 
@@ -95,7 +165,12 @@ export GRDIR="your/path/to/gr"
 
 * macOS Catalina and macOS Mojave: See the "How to open an app that hasn’t been notarized or is from an unidentified developer" section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491) in the Apple documentation.
 
-### Homebrew
+### 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).
+
+#### Mac: Homebrew
 
 ```sh
 brew install libgr
@@ -107,11 +182,13 @@ Set environment variable GRDIR.
 export GRDIR=$(brew --prefix libgr)
 ```
 
-If you fail to build libgr using homebrew, Please feel free to [send us your feedback](https://github.com/red-data-tools/GR.rb/issues).
+#### 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`.
 
-### Red data tools repository
+#### Windows: MSYS2
 
-Red data tools provides [packages](https://github.com/red-data-tools/packages.red-data-tools.org ) related to our project including `libgr-dev` and `libgr3-dev` for advanced users.
+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.
 
 ## Backend for Charty
 

data/lib/gr.rb

@@ -1595,10 +1595,10 @@ module GR
         super(npoints, x, y, ntri, triangles.ref)
       end
       if n_tri > 0
-        tri = triangles.to_str(3 * n_tri * Fiddle::SIZEOF_INT).unpack('l*') # Int32
+        tri = triangles.to_str(dim * n_tri * Fiddle::SIZEOF_INT).unpack('l*') # Int32
         # Ruby  : 0-based indexing
         # Julia : 1-based indexing
-        tri = tri.each_slice(3).to_a
+        tri = tri.each_slice(dim).to_a
         [n_tri, tri]
       else
         0

data/lib/gr/plot.rb

@@ -37,11 +37,12 @@ module GR
                    volume].freeze # the name might be changed in the future.
 
     # Keyword options conform to GR.jl.
-    KW_ARGS = %i[accelerate algorithm alpha backgroundcolor barwidth baseline
-                 clabels color colormap figsize horizontal isovalue label labels
-                 levels location nbins rotation size tilt title where xflip
-                 xform xlabel xlim xlog yflip ylabel ylim ylog zflip zlabel zlim
-                 zlog clim subplot].freeze
+    KW_ARGS = %i[accelerate algorithm alpha ax backgroundcolor barwidth baseline
+                 clabels clear clim color colormap crange figsize 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
 
     @last_plot = nil
     class << self
@@ -181,12 +182,8 @@ module GR
         minmax
       end
 
-      major_count = if %i[wireframe surface plot3 scatter3 polar polarhist
-                          polarheatmap trisurf volume].include?(kind)
-                      2
-                    else
-                      5
-                    end
+      major_count = %i[wireframe surface plot3 scatter3 polar polarhist
+                       polarheatmap trisurf volume].include?(kind) ? 2 : 5
 
       xmin, xmax = kvs[:xrange]
       if (scale & GR::OPTION_X_LOG) == 0
@@ -272,7 +269,7 @@ module GR
       ratio = kvs[:ratio]
       xtick, xorg, majorx = kvs[:xaxis]
       ytick, yorg, majory = kvs[:yaxis]
-      drawgrid = kvs[:grid] || true
+      drawgrid = kvs.has_key?(:grid) ? kvs[:grid] : true
       xtick = 10 if kvs[:scale] & GR::OPTION_X_LOG != 0
       ytick = 10 if kvs[:scale] & GR::OPTION_Y_LOG != 0
       GR.setlinecolorind(1)
@@ -293,8 +290,8 @@ module GR
       else
         if %i[heatmap nonuniformheatmap shade].include?(kind)
           ticksize = -ticksize
-        else
-          drawgrid && GR.grid(xtick, ytick, 0, 0, majorx, majory)
+        elsif drawgrid
+          GR.grid(xtick, ytick, 0, 0, majorx, majory)
         end
         if kvs.has_key?(:xticklabels) || kvs.has_key?(:yticklabels)
           fx = if kvs.has_key?(:xticklabels)
@@ -686,9 +683,10 @@ module GR
           cmap = colormap
           cmin, cmax = kvs[:zrange]
           data = z.map { |i| normalize_color(i, cmin, cmax) }
-          colors = data.map { |i| 1000 + i * 255 }
-          # if kvs[:xflip]
-          # if kvs[;yflip]
+          data.reverse(axis: 0) if kvs[:xflip]
+          data.reverse(axis: 1) if kvs[:yflip]
+          colors = data * 255 + 1000
+          colors = colors.transpose # Julia is column major
           GR.polarcellarray(0, 0, 0, 360, 0, 1, w, h, colors)
           draw_polar_axes
           kvs[:zrange] = [cmin, cmax]
@@ -1281,9 +1279,8 @@ module GR
     def barplot(labels, heights, kv = {})
       labels = labels.map(&:to_s)
       wc, hc = barcoordinates(heights)
-      horizontal = kv[:horizontal] || false
       create_plot(:bar, labels, heights, kv) do |plt|
-        if horizontal
+        if kv[:horizontal]
           plt.args = [[hc, wc, nil, nil, '']]
           plt.kvs[:yticks] = [1, 1]
           plt.kvs[:yticklabels] = labels
@@ -1342,6 +1339,7 @@ module GR
       end
       {
         subplot: [xmin, xmax, ymin, ymax],
+        # The policy of clearing when p[0]==1 is controversial
         clear: p[0] == 1,
         update: p[-1] == nr * nc
       }

data/lib/gr_commons/version.rb

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

data/lib/grm.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GRM
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :ffi_lib
+  end
+
+  # Platforms |  path
+  # Windows   |  bin/libGRM.dll
+  # MacOSX    |  lib/libGRM.so (NOT .dylib)
+  # Ubuntu    |  lib/libGRM.so
+  if Object.const_defined?(:RubyInstaller)
+    ENV['GRDIR'] ||= [
+      RubyInstaller::Runtime.msys2_installation.msys_path,
+      RubyInstaller::Runtime.msys2_installation.mingwarch
+    ].join(File::ALT_SEPARATOR)
+    self.ffi_lib = File.expand_path('bin/libGRM.dll', ENV['GRDIR'])
+    RubyInstaller::Runtime.add_dll_directory(File.dirname(ffi_lib))
+  else
+    raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
+
+    self.ffi_lib = File.expand_path('lib/libGRM.so', ENV['GRDIR'])
+  end
+
+  # change the default encoding to UTF-8.
+  ENV['GKS_ENCODING'] ||= 'utf8'
+
+  require_relative 'gr_commons/gr_commons'
+  require_relative 'grm/version'
+  require_relative 'grm/ffi'
+  require_relative 'grm/grmbase'
+
+  # `inquiry` methods etc. are defined here.
+  extend GRCommons::GRCommonUtils
+
+  # `XXX` is the default type in GR.
+  # A Ruby array or NArray passed to GR method is automatically converted to
+  # a Fiddley::MemoryPointer in the GRBase class.
+  extend GRMBase
+
+  class << self
+  end
+end

data/lib/grm/ffi.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'fiddle/import'
+
+module GRM
+  # FFI Wrapper module for GRM.
+  # The functions for GRM are listed here.
+  # Add functions here when a new version of GR is released.
+  module FFI
+    extend Fiddle::Importer
+
+    begin
+      dlload GRM.ffi_lib
+    rescue LoadError
+      raise LoadError, 'Could not find GR Framework'
+    end
+
+    extend GRCommons::Extern
+
+    # Currently, the declarations of GRM functions are distributed in several
+    # header files.
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/args.h
+
+    try_extern 'grm_args_t *grm_args_new(void)'
+    try_extern 'void grm_args_delete(grm_args_t *args)'
+    # Fiddle does not currently support variable-length arguments in C.
+    try_extern 'int grm_args_push(grm_args_t *args, const char *key, const char *value_format, ...)'
+    try_extern 'int grm_args_push_buf(grm_args_t *args, const char *key, const char *value_format, const void *buffer, int apply_padding)'
+    try_extern 'int grm_args_contains(const grm_args_t *args, const char *keyword)'
+    try_extern 'void grm_args_clear(grm_args_t *args)'
+    try_extern 'void grm_args_remove(grm_args_t *args, const char *key)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/dump.h
+    try_extern 'void grm_dump(const grm_args_t *args, FILE *f)'
+    try_extern 'void grm_dump_json(const grm_args_t *args, FILE *f)'
+    try_extern 'char *grm_dump_json_str(void)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/event.h
+    # grm_event_type_t is an enum.
+    # In the original fiddley, there is code for an enum.
+    # But GR's fiddley doesn't have it.
+    # try_extern 'int grm_register(grm_event_type_t type, grm_event_callback_t callback)'
+    # try_extern 'int grm_unregister(grm_event_type_t type)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/interaction.h
+    try_extern 'int grm_input(const grm_args_t *input_args)'
+    # try_extern 'int grm_get_box(const int x1, const int y1, const int x2, const int y2, const int keep_aspect_ratio, int *x, int *y, int *w, int *h)'
+    # try_extern 'grm_tooltip_info_t *grm_get_tooltip(const int, const int)'
+
+    # https://github.com/sciapp/gr/blob/master/lib/grm/net.h
+    # try_extern 'void *grm_open(int is_receiver, const char *name, unsigned int id,
+    #                            const char *(*custom_recv)(const char *, unsigned int),
+    #                            int (*custom_send)(const char *, unsigned int, const char *))
+    try_extern 'grm_args_t *grm_recv(const void *p, grm_args_t *args)'
+    # Fiddle does not currently support variable-length arguments in C.
+    try_extern 'int grm_send(const void *p, const char *data_desc, ...)'
+    try_extern 'int grm_send_buf(const void *p, const char *data_desc, const void *buffer, int apply_padding)'
+    try_extern 'int grm_send_ref(const void *p, const char *key, char format, const void *ref, int len)'
+    try_extern 'int grm_send_args(const void *p, const grm_args_t *args)'
+    try_extern 'void grm_close(const void *p)'
+  end
+end

data/lib/grm/grmbase.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GRM
+  # This module automatically converts Ruby arrays and Numo::Narray into
+  # Fiddley::MemoryPointer.
+  module GRMBase
+    extend GRCommons::DefineMethods
+    define_ffi_methods(FFI,
+                       prefix: 'grm_',
+                       default_type: :float) # FIXME!
+  end
+  private_constant :GRMBase
+end

data/lib/grm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GRM
+  VERSION = GRCommons::VERSION
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,10 @@ files:
 - lib/gr_commons/gr_commons.rb
 - lib/gr_commons/jupyter_support.rb
 - lib/gr_commons/version.rb
+- lib/grm.rb
+- lib/grm/ffi.rb
+- lib/grm/grmbase.rb
+- lib/grm/version.rb
 homepage: https://github.com/red-data-tools/GR.rb
 licenses:
 - MIT