ruby-gr 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b317ddec0fec1377dc02ab3df429656bf7ae1a4056ed039b3814b344be362e59
-  data.tar.gz: ed039b4fbac3b8e391039343924d8e8fdfe3cd2c72a8d5c6705d29170fc69809
+  metadata.gz: 51cba5fbff46f2beca8d4343580d583390daa5ae65308af59bc5353385c181ae
+  data.tar.gz: b7a9fed2d87f74dde366032c2589a71aeabafa142d1499cdaacf7b3ba0b150b0
 SHA512:
-  metadata.gz: 40828455aaed63f0eea89ec1eebc31c7c4f2a1a49e3e3b874cc80b08336cda2da5fad15f02c475ab4187ea18c7b996e2d5fbcfcdad61cbc01d53e2704af4b3fe
-  data.tar.gz: 8ebe911013ea044d6feca9e36dbf6a97d9d54e465b19659f06254c2b4e41414a398e5788770000301e03d0e06f6181e5d546cc582671816961a1ae3efc390f52
+  metadata.gz: 1a31d16e878229021a6f02403766b1d7be0d0c161261e92d5f1d2a19b5c4146bade5f17ef4f03784b6212845d0af089a21c41dc258fee194dedf1943fd649303
+  data.tar.gz: 741bb5fbfafd7a0422d5d0b528545112a9e84b2c20baa396d2ef51e6a0692083a0124db0e70cd82763e725e1169f18ce5a2dcc6ec1cec9deadecdff3042f023b

data/README.md

@@ -37,6 +37,82 @@ GR.axes(tick, tick, 0, 0, 1, 1, -0.001)
 GR.updatews
 ```
 
+## Examples
+Have a look in the [`examples`](https://github.com/kojix2/GR.rb/tree/master/examples) directory for some simple examples. 
+
+griddata.rb
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/5798442/68080405-1b3e3580-fe3e-11e9-9f71-592ca2826bcb.png">
+</p>
+
+```ruby
+require 'gr'
+require 'numo/narray'
+
+DFloat = Numo::DFloat
+
+xd = -2 + DFloat.new(100).rand * 4
+yd = -2 + DFloat.new(100).rand * 4
+zd = xd * Numo::NMath.exp(-xd * xd - yd * yd)
+
+h = -0.5 + DFloat.new(20).seq / 19.0
+
+GR.setviewport(0.1, 0.95, 0.1, 0.95)
+GR.setwindow(-2.0, 2.0, -2.0, 2.0)
+GR.setspace(-0.5, 0.5, 0, 90)
+GR.setmarkersize(1.0)
+GR.setmarkertype(-1)
+GR.setcharheight(0.024)
+GR.settextalign(2, 0)
+GR.settextfontprec(3, 0)
+
+x, y, z = GR.gridit(xd, yd, zd, 200, 200)
+GR.surface(x, y, z, 5)
+GR.contour(x, y, h, z, 0)
+GR.polymarker(xd, yd)
+GR.axes(0.25, 0.25, -2, -2, 2, 2, 0.01)
+
+GR.updatews
+```
+
+clifford_attractor.rb
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/5798442/68080387-baaef880-fe3d-11e9-9435-f998eaca79da.png">
+</p>
+
+```ruby
+require 'gr'
+
+include Math
+
+n = 100_000_000
+x0 = 0
+y0 = 0
+a = -1.3
+b = -1.3
+c = -1.8
+d = -1.9
+dθ = 0.007
+
+x = [x0]
+y = [y0]
+θ = 0.007
+
+n.times do |i|
+  x <<  (sin(a * y[i]) + c * cos(a * x[i])) * cos(θ)
+  y <<  (sin(b * x[i]) + d * cos(b * y[i])) * cos(θ)
+  θ += dθ
+end
+
+GR.setviewport(0, 1, 0, 1)
+GR.setwindow(-3, 3, -3, 3)
+GR.setcolormap(8)
+GR.shadepoints(x, y, dims: [480, 480], xform: 5)
+GR.updatews
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/GR.rb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/GR.rb.

data/lib/gr.rb

@@ -1,5 +1,37 @@
 # frozen_string_literal: true
 
+# 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
+#         |  | +--------------+ |  |
+#         +----+ CommonUtils  +----+
+#         |  | +--------------+ |  |
+#         |  | +--------------+ |  |
+#         +----+    Version   +----+
+#         |  | +--------------+ |
+#         |  | +--------------+ |
+#         +----+JupyterSupport| |
+#            | +--------------+ |
+#            +------------------+
+
 require 'ffi'
 
 module GR
@@ -30,11 +62,11 @@ module GR
   require_relative 'gr/grbase'
 
   extend GRCommons::JupyterSupport
-  extend GRBase
 
   # `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.
+  extend GRBase
 
   class << self
     def initgr(*)
@@ -623,6 +655,7 @@ module GR
     #    *    Flip Y-axis
     #  * 32 : OPTION_FLIP_Z
     #    *    Flip Z-axis
+    # @return [Integer]
     # `setscale` defines the current transformation according to the given scale
     # specification which may be or'ed together using any of the above options. GR uses
     # these options for all subsequent output primitives until another value is provided.
@@ -769,6 +802,7 @@ module GR
     # @param zmax [Numeric] Maximum value for the Z-axis.
     # @param rotation [Integer] Angle for the rotation of the X axis, in degrees.
     # @param tilt [integer] Viewing angle of the Z axis in degrees.
+    # @return [Integer]
     # `setspace` establishes the limits of an abstract Z-axis and defines the angles for
     # rotation and for the viewing angle (tilt) of a simulated three-dimensional graph,
     # used for mapping corresponding output primitives into the current window.
@@ -790,6 +824,7 @@ module GR
     # @param x [Numeric] The X coordinate of starting position of the text string
     # @param y [Numeric] The Y coordinate of starting position of the text string
     # @param string [String] The text to be drawn
+    # @return [Integer]
     #
     # The values for X and Y are in normalized device coordinates.
     # The attributes that control the appearance of text are text font and precision,
@@ -1082,6 +1117,7 @@ module GR
       super(npoints, x, y, z, nlevels, levels)
     end
 
+    # @return [Integer]
     def hexbin(x, y, nbins)
       n = x.length
       super(n, x, y, nbins)
@@ -1117,6 +1153,7 @@ module GR
       end
     end
 
+    # @return [Integer]
     def inqcolorfromrgb(*)
       super
     end
@@ -1127,20 +1164,30 @@ module GR
       end
     end
 
+    # @return [Numeric]
     def tick(*)
       super
     end
 
+    # @return [Integer]
     def validaterange(*)
       super
     end
 
-    def adjustlimits(*)
-      super
+    def adjustlimits(amin, amax)
+      inquiry %i[double double] do |pamin, pamax|
+        pamin.write_double amin
+        pamax.write_double amax
+        super(pamin, pamax)
+      end
     end
 
-    def adjustrange(*)
-      super
+    def adjustrange(amin, amax)
+      inquiry %i[double double] do |pamin, pamax|
+        pamin.write_double amin
+        pamax.write_double amax
+        super(pamin, pamax)
+      end
     end
 
     # Open and activate a print device.
@@ -1337,7 +1384,7 @@ module GR
       super
     end
 
-    # readimage
+    # @return [Integer]
     def readimage(path)
       w, h, d = inquiry [:int, :int, :pointer] do |width, height, data|
         # data is a pointer of a pointer
@@ -1368,6 +1415,7 @@ module GR
       super(xmin, xmax, ymin, ymax, width, height, uint(data), model)
     end
 
+    # @return [Integer]
     def importgraphics(*)
       super
     end
@@ -1414,10 +1462,12 @@ module GR
       super
     end
 
+    # @return [String]
     def getgraphics(*)
       super
     end
 
+    # @return [Integer]
     def drawgraphics(*)
       super
     end
@@ -1460,6 +1510,7 @@ module GR
       end
     end
 
+    # @return [Numeric]
     def precision(*)
       super
     end
@@ -1468,6 +1519,7 @@ module GR
       super
     end
 
+    # @return [Integer]
     def inqregenflags(*)
       super
     end
@@ -1488,6 +1540,7 @@ module GR
       super
     end
 
+    # @return [Integer]
     def uselinespec(*)
       super
     end
@@ -1570,6 +1623,7 @@ module GR
     end
 
     # Returns the combined version strings of the GR runtime.
+    # @return [String]
     def version
       super.read_string
     end

data/lib/gr/ffi.rb

@@ -83,7 +83,7 @@ module GR
     attach_function :gr_closeseg, %i[], :void
     attach_function :gr_emergencyclosegks, %i[], :void
     attach_function :gr_updategks, %i[], :void
-    attach_function :gr_setspace, %i[double double int int], :void
+    attach_function :gr_setspace, %i[double double int int], :int
     attach_function :gr_inqspace, %i[pointer pointer pointer pointer], :void
     attach_function :gr_textext, %i[double double string], :int
     attach_function :gr_inqtextext, %i[double double string pointer pointer], :void
@@ -144,14 +144,14 @@ module GR
     attach_function :gr_moveselection, %i[double double], :void
     attach_function :gr_resizeselection, %i[int double double], :void
     attach_function :gr_inqbbox, %i[pointer pointer pointer pointer], :void
-    attach_function :gr_precision, %i[], :void
+    attach_function :gr_precision, %i[], :double
     attach_function :gr_setregenflags, %i[int], :void
-    attach_function :gr_inqregenflags, %i[], :void
+    attach_function :gr_inqregenflags, %i[], :int
     attach_function :gr_savestate, %i[], :void
     attach_function :gr_restorestate, %i[], :void
     attach_function :gr_selectcontext, %i[int], :void
     attach_function :gr_destroycontext, %i[int], :void
-    attach_function :gr_uselinespec, %i[string], :void
+    attach_function :gr_uselinespec, %i[string], :int
     # attach_function :gr_delaunay, %i[int pointer pointer pointer pointer], :void
     attach_function :gr_reducepoints, %i[int pointer pointer int pointer pointer], :void
     attach_function :gr_trisurface, %i[int pointer pointer pointer], :void

data/lib/gr3.rb

@@ -1,5 +1,37 @@
 # frozen_string_literal: true
 
+# 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
+#         |  | +--------------+ |  |
+#         +----+ CommonUtils  +----+
+#         |  | +--------------+ |  |
+#         |  | +--------------+ |  |
+#         +----+    Version   +----+
+#         |  | +--------------+ |
+#         |  | +--------------+ |
+#         +----+JupyterSupport| |
+#            | +--------------+ |
+#            +------------------+
+
 require 'ffi'
 
 module GR3
@@ -29,22 +61,35 @@ module GR3
   require_relative 'gr3/ffi'
   require_relative 'gr3/gr3base'
 
-  extend GRCommons::JupyterSupport
-  extend GR3Base
-
   # `float` is the default type in GR3
   # A Ruby array or NArray passed to GR3 method is automatically converted to
   # a FFI::MemoryPointer in the GR3Base class.
+  extend GR3Base
 
+  # This module is for adding error checking to all methods in GR3
   module CheckError
+    def geterror
+      line = ::FFI::MemoryPointer.new(:int)
+      file = ::FFI::MemoryPointer.new(:pointer)
+      e = super(1, line, file)
+      return [0, nil, nil] if e == 0
+
+      line = line.read_int
+      file = file.read_pointer.read_string
+      [e, line, file]
+    end
+
     FFI.ffi_methods.each do |method|
       method_name = method.to_s.sub(/^gr3_/, '')
       next if method_name == 'geterror'
 
       define_method(method_name) do |*args|
         values = super(*args)
-        GR3Base.check_error
-        values
+        e, line, file = geterror
+        if e != 0
+          mesg = FFI.gr3_geterrorstring(e)
+          raise "GR3 error #{file} #{line} #{mesg}"
+        end
       end
     end
   end
@@ -52,6 +97,7 @@ module GR3
 
   class << self
     # This method initializes the gr3 context.
+    # @return [Integer]
     def gr3_init(*)
       super
     end
@@ -65,10 +111,10 @@ module GR3
       super
     end
 
+    # @!method geterror
     # This function returns information on the most recent GR3 error.
-    def geterror(*)
-      super
-    end
+    # @return [Integer]
+    # @note This method is defined in the CheckError module.
 
     # This function allows the user to find out how his commands are rendered.
     # If gr3 is initialized, a string in the format:
@@ -76,16 +122,19 @@ module GR3
     # For example `"gr3 - GLX - GL_ARB_framebuffer_object - 2.1 Mesa 7.10.2 - Software Rasterizer"`
     # might be returned on a Linux system (using GLX) with an available GL_ARB_framebuffer_object implementation.
     # If gr3 is not initialized `"Not initialized"` is returned.
+    # @return [String]
     def getrenderpathstring(*)
       super
     end
 
     # This function returns a string representation of a given error code.
+    # @return [String]
     def geterrorstring(*)
       super
     end
 
     # This function clears the draw list.
+    # @return [Integer]
     def clear(*)
       super
     end
@@ -104,11 +153,12 @@ module GR3
 
     # Set rendering quality
     # @param quality [] The quality to set
+    # @return [Integer]
     def setquality(*)
       super
     end
 
-    # getimage
+    # @return [Integer]
     def getimage(width, height, use_alpha = true)
       bpp = use_alpha ? 4 : 3
       inquiry(uint8: width * height * bpp) do |bitmap|
@@ -116,15 +166,18 @@ module GR3
       end
     end
 
+    # @return [Integer]
     def export(*)
       super
     end
 
+    # @return [Integer]
     def drawimage(*)
       super
     end
 
     # createmesh_nocopy
+    # @return [Integer]
     def createmesh_nocopy(_n, vertices, normals, colors)
       inquiry_int do |mesh|
         super(mesh, vertices, normals, colors)
@@ -138,6 +191,7 @@ module GR3
     # @param normals [Array, NArray] the vertex normals
     # @param colors [Array, NArray] the vertex colors,
     #  they should be white (1,1,1) if you want to change the color for each drawn mesh
+    # @return [Integer]
     def createmesh(n, vertices, normals, colors)
       inquiry_int do |mesh|
         super(mesh, n, vertices, normals, colors)
@@ -145,6 +199,7 @@ module GR3
     end
 
     # This function creates a mesh from vertex position, normal and color data.
+    # @return [Integer]
     def createindexedmesh_nocopy(num_vertices, vertices, normals, colors, num_indices, indices)
       inquiry_int do |mesh|
         super(mesh, num_vertices, vertices, normals, colors, num_indices, indices)
@@ -161,6 +216,7 @@ module GR3
     #  they should be white (1,1,1) if you want to change the color for each drawn mesh
     # @param num_indices [Integer] the number of indices in the mesh (three times the number of triangles)
     # @param indices [Array, NArray] the index array (vertex indices for each triangle)
+    # @return [Integer]
     def createindexedmesh(num_vertices, vertices, normals, colors, num_indices, indices)
       inquiry_int do |mesh|
         super(mesh, num_vertices, vertices, normals, colors, num_indices, indices)
@@ -208,11 +264,13 @@ module GR3
     #  It must be greater than 0 and less than 180.
     # @param zNear [Numeric] The distance to the near clipping plane.
     # @param zFar [Numeric] The distance to the far clipping plane.
+    # @return [Integer]
     def setcameraprojectionparameters(*)
       super
     end
 
     # Get the projection parameters.
+    # @return [Integer]
     def getcameraprojectionparameters(*)
       super
     end
@@ -231,6 +289,7 @@ module GR3
       super
     end
 
+    # @return [Integer]
     def createheightmapmesh(*)
       super
     end
@@ -262,6 +321,7 @@ module GR3
       super
     end
 
+    # @return [Integer]
     def selectid(*)
       super
     end
@@ -275,6 +335,7 @@ module GR3
     end
 
     # the current projection type: GR3_PROJECTION_PERSPECTIVE or GR3_PROJECTION_PARALLEL
+    # @return [Integer]
     def getprojectiontype(*)
       super
     end
@@ -291,6 +352,7 @@ module GR3
     # @param step [Array] voxel sizes in each direction
     # @param offset [Array] coordinate origin in each direction
     # @param isolevel [Integer] isovalue at which the surface will be created
+    # @return [Integer]
     def createisosurfacemesh(grid, step, offset, isolevel)
       args = _preprocess_createslicemesh(grid, step, offset)
       grid = args.shift
@@ -320,6 +382,7 @@ module GR3
     #    *    color the surface according to the current gr colormap
     #  * 16 : GR3_SURFACE_GRZSHADED
     #    *    like GR3_SURFACE_GRCOLOR, but use the z-value directly as color index
+    # @return [Integer]
     def createsurfacemesh(nx, ny, px, py, pz, option = 0)
       inquiry_int do |mesh|
         super(mesh, nx, ny, px, py, pz, option)
@@ -372,6 +435,7 @@ module GR3
     # @param num_steps [Integer] the number of steps between each point, allowing for a more smooth tube
     # @param num_segments [Integer] the number of segments each ring of the tube consists of,
     #  e.g. 3 would yield a triangular tube
+    # @return [Integer]
     def drawtubemesh(n, points, colors, radii, num_steps = 10, num_segments = 20)
       super(n, points, colors, radii, num_steps, num_segments)
     end
@@ -385,6 +449,7 @@ module GR3
     # @param radii [Array, NArray] the desired tube radius at each point
     # @param num_steps [Integer] the number of steps between each point, allowing for a more smooth tube
     # @param num_segments [Integer] the number of segments each ring of the tube consists of, e.g. 3 would yield a triangular tube
+    # @return [Integer]
     def createtubemesh(n, points, colors, radii, num_steps = 10, num_segments = 20)
       inquiry_uint do |mesh| # mesh should be Int?
         super(mesh, n, points, colors, radii, num_steps, num_segments)

data/lib/gr3/ffi.rb

@@ -3,7 +3,7 @@
 require 'ffi'
 
 module GR3
-  # FFI Wrapper module for GR
+  # FFI Wrapper module for GR3
   module FFI
     extend ::FFI::Library
 

data/lib/gr3/gr3base.rb

@@ -6,16 +6,6 @@ module GR3
     define_ffi_methods(FFI,
                        prefix: 'gr3_',
                        default_type: :float)
-
-    def self.check_error
-      line = ::FFI::MemoryPointer.new(:int)
-      file = ::FFI::MemoryPointer.new(:string, 100)
-      e = FFI.gr3_geterror(1, line, file)
-      return if e == 0
-
-      mesg = FFI.gr3_geterrorstring(e)
-      raise "GR3 error #{file} #{line} #{mesg}"
-    end
   end
   private_constant :GR3Base
 

data/lib/gr_commons/gr_common_utils.rb

@@ -48,10 +48,6 @@ module GRCommons
       pt.write_array_of_float data
     end
 
-    def narray?(data)
-      defined?(Numo::NArray) && data.is_a?(Numo::NArray)
-    end
-
     def inquiry_int(&block)
       inquiry(:int, &block)
     end
@@ -100,6 +96,10 @@ module GRCommons
         pt.send("read_#{type}")
       end
     end
+
+    def narray?(data)
+      defined?(Numo::NArray) && data.is_a?(Numo::NArray)
+    end
   end
 end
 

data/lib/gr_commons/jupyter_support.rb

@@ -4,24 +4,28 @@ module GRCommons
   # Jupyter Notebook and Jpyter Lab.
   module JupyterSupport
     if defined?(IRuby) && IRuby.respond_to?(:display)
+
+      # Sets the environment variable when the module is extended.
       def self.extended(_obj)
         require 'tmpdir'
         ENV['GKSwstype'] = 'svg'
-        # May be extended to both GR3 and GR
         ENV['GKS_FILEPATH'] = Dir::Tmpname.create('plot-') {}
       end
 
+      # Display your plot in Jupyter Notebook / Lab
       def show
         emergencyclosegks
         sleep 0.5
-        case ENV['GKSwstype']
+        type = ENV['GKSwstype']
+        case type
         when 'svg'
           data = File.read(ENV['GKS_FILEPATH'] + '.svg')
           IRuby.display(data, mime: 'image/svg+xml')
-        when 'mov', 'mp4', 'webm'
+        when 'webm', 'ogg', 'mp4', 'mov'
           require 'base64'
-          data = File.binread(ENV['GKS_FILEPATH'] + '.' + ENV['GKSwstype'])
-          IRuby.display("<video controls autoplay type=\"video/mp4\" src=\"data:video/mp4;base64,#{Base64.encode64(data)}\">", mime: 'text/html')
+          data = File.binread(ENV['GKS_FILEPATH'] + '.' + type)
+          IRuby.display("<video controls autoplay type=\"video/#{type}\" src=\"data:video/#{type};base64,#{Base64.encode64(data)}\">",
+                        mime: 'text/html')
         end
         nil
       end

data/lib/gr_commons/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-02 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi