ruby-gr 0.0.13 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2f6f44a5b2198487a5b2735ab2dcd33f1b7ce0176a2763ee50a2866273021a
-  data.tar.gz: 0073dd18c710ad1107e73b5a365f55f03f746398f33a0cd59211194d940ddee2
+  metadata.gz: 46a782911565b4128622399489e47d79e7ced0d3880d9c5c5adacdae7fa24709
+  data.tar.gz: e89d9c7e5a5ae0bf53352f3afb71fd1206c9a0e7aa5a3ba83504457fa5689b7d
 SHA512:
-  metadata.gz: 205f75736354151eda828e200ff746e8bd69a8825476f9e7da02aafef6baf360904a8097edf27b12579b4e956821e142b83da9603d3d150b5b32b5f3e08e4214
-  data.tar.gz: c7ddc7fd1949b22008f030ace9d3299ce38d6fa80553a27b5c3a3b74441d3376d1a15abc21b9753c5f38296f71981cd019373a2ab09fce5ab43eb413cb58107a
+  metadata.gz: 21a8aeb6c49da80f87bb764ba149ffa8c7e7bffa3ed171002d1c6963537b9f0b500a96f77eac6876c8c3a8af9601aad6c8a79dfd4e0aea6d7d356adfc59b04db
+  data.tar.gz: 99a2e4204e8eef936979895183d86003860e2b9b356a24bc0f132793177459fa8fc782cf8bdd4ac4c2a29fca6e77aff41d7501123e84917172009bc5b5907547

data/LICENSE.txt

@@ -20,3 +20,27 @@ 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.
+
+The Fiddley module is:
+
+Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -50,9 +50,51 @@ GR.plot(x, y)
 ## Examples
 
 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)
+
+## Features
+
+#### GR::Plot
+
+A simple, matlab-style API.
+
+```ruby
+require 'gr/plot'
+```
+
+`plot` `step` `scatter` `stem` `histogram` `contour` `contourf` `hexbin` `heatmap` `wireframe` `surface` `plot3` `scatter3` `imshow` `isosurface` `polar` `polarhist` `polarheatmap` `trisurf` `tricont` `shade` `volume`
+
+#### GR
+
+```ruby
+require 'gr'
+```
+
+#### GR3
+
+```ruby
+require 'gr3'
+```
+
+## Documentation
+
+- [GR Framework](https://gr-framework.org/)
+- [GR.rb API Documentation](https://rubydoc.info/gems/ruby-gr)
 
 ## GR Installation
 
+### Official binary release
+
+Download the [latest release](https://github.com/sciapp/gr/releases).
+
+Set environment variable GRDIR.
+
+```sh
+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
 
 ```sh
@@ -65,16 +107,25 @@ Set environment variable GRDIR.
 export GRDIR=$(brew --prefix libgr)
 ```
 
-### Mac Linux Windows
+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).
 
-Download the [latest release](https://github.com/sciapp/gr/releases).
+### Red data tools repository
 
-Set environment variable GRDIR.
+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.
 
-```sh
-export GRDIR="your/path/to/gr"
-```
+## Backend for Charty
+
+GR.rb will be the default backend for [Charty](https://github.com/red-data-tools/charty).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/red-data-tools/GR.rb.
+* Report bugs
+* Fix bugs and submit pull requests
+* Write, clarify, or fix documentation
+* Suggest or add new features
+* Create visualization library based on GR.rb
+
+## Acknowledgements
+
+We would like to thank Josef Heinen, the creator of [GR.jl](https://github.com/jheinen/GR.jl), Florian Rhiem, the creator of  [python-gr](https://github.com/sciapp/python-gr), and [GR](https://github.com/sciapp/gr) developers.
+

data/lib/gr.rb

@@ -2,41 +2,47 @@
 
 # OverView of GR.rb
 #
-#                            +--------------------+
-#     +-------------------+  | GR3 module         |
-#     | GR module         |  | +----------------+ |
-#     | +---------------+ |  | | GR3::FFI       | |
-#     | | GR::FFI       | |  | | +    libGR3.so | |
-#     | | +   libGR.so  | |  | +----------------+ |
-#     | +---------------+ |  |   | define_method  |
-#     |   | define_method |  | +----------------+ |
-#     | +---------------+ |  | | | GR3::GR3Base | |
-#     | | | GR::GRBase  | |  | | v  (Private)   | |
-#     | | v  (Private)  | |  | +++--------------+ |
-#     | +++-------------+ |  |  | Extend          |
-#     |  | Extend         |  |  v        +------+ |
-#     |  v                |  |           |Check | |
-#     |                   |  |        <--+Error | |
-#     +-------+-----------+  |           +------+ |
-#             ^              +---------+----------+
-#             |  +------------------+  ^
-#      Extend |  | GRCommons module |  | Extend
-#             |  | +--------------+ |  |
-#             |  | |    Fiddley   | |  |
-#             |  | +--------------+ |  |
-#             |  | +--------------+ |  |
-#             +----+ CommonUtils  +----+
-#             |  | +--------------+ |  |
-#             |  | +--------------+ |  |
-#             +----+    Version   +----+
-#             |  | +--------------+ |
-#             |  | +--------------+ |
-#             +----+JupyterSupport| |
-#                | +--------------+ |
-#                +------------------+
+#  +--------------------+  +--------------------+
+#  | GR module          |  | GR3 module         |
+#  | +----------------+ |  | +----------------+ |
+#  | | GR::FFI        | |  | | GR3::FFI       | |
+#  | | +   libGR.so   | |  | | +    libGR3.so | |
+#  | +----------------+ |  | +----------------+ |
+#  |   | define_method  |  |   | define_method  |
+#  | +----------------+ |  | +----------------+ |
+#  | | | GR::GRBase   | |  | | | GR3::GR3Base | |
+#  | | v  (Pri^ate)   | |  | | v  (Pri^ate)   | |
+#  | +++--------------+ |  | +++--------------+ |
+#  |  | Extend          |  |  | Extend          |
+#  |  v                 |  |  v       +-------+ |
+#  |      +-----------+ |  |          | Check | |
+#  |      | GR::Plot  | |  |       <--+ Error | |
+#  |      +-----------+ |  |          +-------+ |
+#  +--------------------+  +----------+---------+
+#            ^                        ^
+#            |  +------------------+  |
+#     Extend |  | GRCommons module |  | Extend
+#            |  | +--------------+ |  |
+#            |  | |    Fiddley   | |  |
+#            |  | +--------------+ |  |
+#            |  | +--------------+ |  |
+#            +----+ CommonUtils  +----+
+#            |  | +--------------+ |  |
+#            |  | +--------------+ |  |
+#            +----+    Version   +----+
+#            |  | +--------------+ |
+#            |  | +--------------+ |
+#            +----+JupyterSupport| |
+#               | +--------------+ |
+#               +------------------+
+#
+# (You can edit the above AA diagram with http://asciiflow.com/))
+#
+# Fiddley is Ruby-FFI compatible API layer for Fiddle.
 #
 # The GR module works without Numo::Narrray.
-
+# GR3 and GR::Plot depends on numo-narray.
+#
 # This is a procedural interface to the GR plotting library,
 # https://github.com/sciapp/gr
 module GR
@@ -46,20 +52,24 @@ module GR
     attr_accessor :ffi_lib
   end
 
-  raise Error, 'Please set env variable GRDIR' unless ENV['GRDIR']
-
   # Platforms |  path
   # Windows   |  bin/libgr.dll
   # MacOSX    |  lib/libGR.so (NOT .dylib)
   # Ubuntu    |  lib/libGR.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/libgr.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/libGR.so', ENV['GRDIR'])
   end
 
-  # Change the default encoding to UTF-8
+  # Change the default encoding to UTF-8.
   ENV['GKS_ENCODING'] ||= 'utf8'
 
   require_relative 'gr_commons/gr_commons'
@@ -67,16 +77,19 @@ module GR
   require_relative 'gr/ffi'
   require_relative 'gr/grbase'
 
+  # `inquiry` methods etc. are defined here.
+  extend GRCommons::GRCommonUtils
+
+  # Support for Jupyter Notebook / Lab.
   extend GRCommons::JupyterSupport
 
-  # `double` is the default type in GR
+  # `double` is the default type in GR.
   # A Ruby array or NArray passed to GR method is automatically converted to
-  # a FFI::MemoryPointer in the GRBase class.
+  # a Fiddley::MemoryPointer in the GRBase class.
   extend GRBase
 
   # Now you can see a lot of methods just calling super here.
-  # Why? Do they really need?
-  # Yes. They are written to help the yard generate the documentation.
+  # They are written to help the yard generate the documentation.
   class << self
     def initgr(*)
       super
@@ -230,6 +243,9 @@ module GR
     # @param dimx [Integer] X dimension of the color index array
     # @param dimy [Integer] Y dimension of the color index array
     # @param color [Array, NArray] Color index array
+    # The values for `x` and `y` are in world coordinates. `x` must contain
+    # `dimx` + 1 elements and `y` must contain `dimy` + 1 elements. The elements
+    # i and i+1 are respectively the edges of the i-th cell in X and Y direction.
     def nonuniformcellarray(x, y, dimx, dimy, color)
       raise ArgumentError unless x.length == dimx + 1 && y.length == dimy + 1
 
@@ -529,6 +545,13 @@ module GR
       super
     end
 
+    # Gets the current text color index.
+    # This function gets the color of text output primitives.
+    # @return [Integer] color The text color index (COLOR < 1256)
+    def inqtextcolorind
+      inquiry_int { |pt| super(pt) }
+    end
+
     # Set the current character height.
     # @param height [Numeric] Text height value
     # `setcharheight` defines the height of subsequent text output primitives. Text height
@@ -1399,12 +1422,14 @@ module GR
 
     # @return [Integer]
     def readimage(path)
+      # Feel free to make a pull request if you catch a mistake
+      # or you have an idea to improve it.
       data = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INTPTR_T)
       w, h = inquiry [:int, :int] do |width, height|
         # data is a pointer of a pointer
         super(path, width, height, data.ref)
       end
-      d = data.to_str(w * h * 4).unpack('L*') # UINT8
+      d = data.to_str(w * h * Fiddle::SIZEOF_INT).unpack('L*') # UInt32
       [w, h, d]
     end
 
@@ -1560,6 +1585,26 @@ module GR
       super
     end
 
+    def delaunay(x, y)
+      # Feel free to make a pull request if you catch a mistake
+      # or you have an idea to improve it.
+      npoints = equal_length(x, y)
+      triangles = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INTPTR_T)
+      dim = 3
+      n_tri = inquiry_int do |ntri|
+        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
+        # Ruby  : 0-based indexing
+        # Julia : 1-based indexing
+        tri = tri.each_slice(3).to_a
+        [n_tri, tri]
+      else
+        0
+      end
+    end
+
     # Reduces the number of points of the x and y array.
     def reducepoints(xd, yd, n)
       nd = equal_length(xd, yd)
@@ -1760,31 +1805,32 @@ module GR
       end
     end
 
-    # Draw paths using given vertices and path codes.
+    # Draw paths using the given vertices and path codes.
     # @param x [Array, NArray] A list containing the X coordinates
     # @param y [Array, NArray] A list containing the Y coordinates
-    # @param codes [String] Path codes
+    # @param codes [String] A list containing the path codes
     #  The following path codes are recognized:
     #  * M, m
-    #    * moveto           x, y
+    #    * moveto                      x, y
     #  * L, l
-    #    * lineto           x, y
+    #    * lineto                      x, y
     #  * Q, q
-    #    * quadratic Bézier x1, y1  x2, y2
+    #    * quadratic Bézier            x1, x2  y1, y2
     #  * C, c
-    #    * cubic Bézier     x1, y1  x2, y2  x3, y3
-    #  * R, r
-    #    * rectangle        w, h
+    #    * cubic Bézier                x1, x2, x3  y1, y2, y3
     #  * A, a
-    #    * arc              w, h  a1, a2
+    #    * arc                         rx, a1, reserved  ry, a2, reserved
     #  * Z
-    #    * closepath        -
+    #    * close path                  -
+    #  * s
+    #    * stroke                      -
     #  * s
-    #    * stroke           -
+    #    * close path and stroke       -
     #  * f
-    #    * fill             -
-    # The values for `x` and `y` are in normalized device coordinates.
-    # The `codes` describe several patch primitives that can be used to create compound paths.
+    #    * close path and fill         -
+    #  * F
+    #    * close path, fill and stroke -
+    # See https://gr-framework.org/python-gr.html#gr.path for more details.
     def path(x, y, codes)
       n = equal_length(x, y)
       super(n, x, y, codes)
@@ -1850,7 +1896,7 @@ module GR
       end
     end
 
-    # Set the far and near clipping plane for perspective projection and the 
+    # Set the far and near clipping plane for perspective projection and the
     # vertical field ov view.
     # Switches projection type to perspective.
     # @param near_plane [Numeric] distance to near clipping plane
@@ -1886,7 +1932,7 @@ module GR
       end
     end
 
-    # Interface for interaction with the rotation of the model. 
+    # Interface for interaction with the rotation of the model.
     # For this a virtual Arcball is used.
     # @param start_mouse_pos_x [Numeric] x component of the start mouse position
     # @param start_mouse_pos_y [Numeric] y component of the start mouse position
@@ -1913,6 +1959,58 @@ module GR
         super(*pts)
       end
     end
+
+    # Set the scale factor for each axis. A one means no scale.
+    # All factor have to be != 0.
+    # @param x_axis_scale [Numeric] factor for scaling the x-axis
+    # @param y_axis_scale [Numeric] factor for scaling the y-axis
+    # @param z_axis_scale [Numeric] factor for scaling the z-axis
+    def setscalefactors3d(*)
+      super
+    end
+
+    # Returns the scale factors for each axis.
+    def inqscalefactors3d
+      inquiry %i[double double double] do |*opts|
+        super(*opts)
+      end
+    end
+
+    # Set the camera for orthographic or perspective projection.
+    # The center of the 3d window is used as the focus point and the camera is
+    # positioned relative to it, using camera distance, rotation and tilt similar
+    # to gr_setspace. This function can be used if the user prefers spherical
+    # coordinates to setting the camera position directly, but has reduced
+    # functionality in comparison to GR.settransformationparameters,
+    # GR.setperspectiveprojection and GR.setorthographicprojection.
+    # @param phi [Numeric] azimuthal angle of the spherical coordinates
+    # @param theta [Numeric] polar angle of the spherical coordinates
+    # @param fov [Numeric] vertical field of view (0 or NaN for orthographic projection)
+    # @param camera_distance [Numeric] distance between the camera and the focus point
+    #   (0 or NaN for the radius of the object's smallest bounding sphere)
+    def setspace3d(*)
+      super
+    end
+
+    def text3d(*)
+      super
+    end
+
+    def inqtext3d(x, y, z, string, axis)
+      inquiry [{ double: 16 }, { double: 16 }] do |tbx, tby|
+        super(x, y, z, string, axis, tbx, tby)
+      end
+    end
+
+    def settextencoding(*)
+      super
+    end
+
+    def inqtextencoding
+      inquiry_int do |encoding|
+        super(encoding)
+      end
+    end
   end
 
   ASF_BUNDLED    = 0
@@ -2131,6 +2229,9 @@ module GR
   XFORM_CUBIC     = 4
   XFORM_EQUALIZED = 5
 
+  ENCODING_LATIN1 = 300
+  ENCODING_UTF8 = 301
+
   UPSAMPLE_VERTICAL_DEFAULT     = 0x00000000
   UPSAMPLE_HORIZONTAL_DEFAULT   = 0x00000000
   DOWNSAMPLE_VERTICAL_DEFAULT   = 0x00000000
@@ -2147,4 +2248,21 @@ module GR
   UPSAMPLE_HORIZONTAL_LANCZOS   = 0x00000300
   DOWNSAMPLE_VERTICAL_LANCZOS   = 0x00030000
   DOWNSAMPLE_HORIZONTAL_LANCZOS = 0x03000000
+
+  RESAMPLE_DEFAULT =
+    (UPSAMPLE_VERTICAL_DEFAULT | UPSAMPLE_HORIZONTAL_DEFAULT |
+     DOWNSAMPLE_VERTICAL_DEFAULT | DOWNSAMPLE_HORIZONTAL_DEFAULT)
+  RESAMPLE_NEAREST =
+    (UPSAMPLE_VERTICAL_NEAREST | UPSAMPLE_HORIZONTAL_NEAREST |
+     DOWNSAMPLE_VERTICAL_NEAREST | DOWNSAMPLE_HORIZONTAL_NEAREST)
+  RESAMPLE_LINEAR =
+    (UPSAMPLE_VERTICAL_LINEAR | UPSAMPLE_HORIZONTAL_LINEAR |
+     DOWNSAMPLE_VERTICAL_LINEAR | DOWNSAMPLE_HORIZONTAL_LINEAR)
+  RESAMPLE_LANCZOS =
+    (UPSAMPLE_VERTICAL_LANCZOS | UPSAMPLE_HORIZONTAL_LANCZOS |
+     DOWNSAMPLE_VERTICAL_LANCZOS | DOWNSAMPLE_HORIZONTAL_LANCZOS)
+
+  PROJECTION_DEFAULT = 0
+  PROJECTION_ORTHOGRAPHIC = 1
+  PROJECTION_PERSPECTIVE = 2
 end