ruby-gr 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2f6f44a5b2198487a5b2735ab2dcd33f1b7ce0176a2763ee50a2866273021a
-  data.tar.gz: 0073dd18c710ad1107e73b5a365f55f03f746398f33a0cd59211194d940ddee2
+  metadata.gz: cbb0e07aec1fa9f4377df0a4c6c0765802f56ca299975970716b86d8aebf2273
+  data.tar.gz: 61a995043b20ba81623a96f45ca4689a9be49e8a5451497bc997cbbdee412361
 SHA512:
-  metadata.gz: 205f75736354151eda828e200ff746e8bd69a8825476f9e7da02aafef6baf360904a8097edf27b12579b4e956821e142b83da9603d3d150b5b32b5f3e08e4214
-  data.tar.gz: c7ddc7fd1949b22008f030ace9d3299ce38d6fa80553a27b5c3a3b74441d3376d1a15abc21b9753c5f38296f71981cd019373a2ab09fce5ab43eb413cb58107a
+  metadata.gz: 168285500cbd4c3a343001f3ad7649d03f37155da471546796569bf107018bd83d9c0b9af5c2a9c58b03b49163fc211f24156037abefc4f7bab459d4f1ed488a
+  data.tar.gz: da487fbc4d174d079b550e7fd2539defb66a4a9981c3af2b8d518e84f97dcc0bfecf52e83e9271817e2fe149252ef735b23132b33aa95a587009343951ad9d26

data/lib/gr.rb

@@ -36,7 +36,7 @@
 #                +------------------+
 #
 # The GR module works without Numo::Narrray.
-
+#
 # This is a procedural interface to the GR plotting library,
 # https://github.com/sciapp/gr
 module GR
@@ -1850,7 +1850,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 +1886,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

data/lib/gr/ffi.rb

@@ -3,7 +3,9 @@
 require 'fiddle/import'
 
 module GR
-  # FFI Wrapper module for GR
+  # FFI Wrapper module for GR.
+  # The functions for GR are listed here.
+  # Add functions here when a new version of GR is released.
   module FFI
     extend Fiddle::Importer
 
@@ -16,8 +18,7 @@ module GR
     extend GRCommons::Extern
 
     # https://github.com/sciapp/gr/blob/master/lib/gr/gr.h
-    # Order is important.
-
+    # keep same order
     try_extern 'void gr_initgr(void)'
     try_extern 'void gr_opengks(void)'
     try_extern 'void gr_closegks(void)'

data/lib/gr/plot.rb

@@ -8,7 +8,9 @@ autoload :GR3, 'gr3'
 require 'numo/narray'
 
 module GR
-  class Plot # should be Figure ?
+  # This class offers a simple, matlab-style API built on top of the GR package.
+  # The class name Plot may be changed in the future.
+  class Plot
     # Why is the Plot class NOT object-oriented?
     #
     # Because the code here is mainly ported from GR.jl.
@@ -36,10 +38,10 @@ module GR
 
     # Keyword options conform to GR.jl.
     KW_ARGS = %i[accelerate algorithm alpha backgroundcolor barwidth baseline
-                 clabels color colormap figsize 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
+                 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
 
     @@last_plot = nil
     def self.last_plot
@@ -397,11 +399,9 @@ module GR
     end
 
     def plot_polar(θ, ρ)
-      ρ = Numo::DFloat.cast(ρ) if ρ.is_a? Array
       window = kvs[:window]
-      rmin = window[2]
-      rmax = window[3]
-      ρ = (ρ - rmin) / (rmax - rmin)
+      rmax = window[3].to_f
+      ρ = ρ.map { |i| i / rmax }
       n = ρ.length
       x = []
       y = []
@@ -664,21 +664,18 @@ module GR
             GR.fillrect(x[i], x[i + 1], ymin, y[i])
           end
 
-        # when :polarhist
-        #   xmin, xmax = x.minmax
-        #   ymax = kvs[:window][3]
-        #   ρ = y.map { |i| 2 * (i.to_f / ymax - 0.5) }
-        #   θ = x.map { |i| 2 * Math::PI * (i.to_f - xmin) / (xmax - xmin) }
-        #   ρ.length.times do |i|
-        #     GR.setfillcolorind(989)
-        #     GR.setfillintstyle(GR::INTSTYLE_SOLID)
-        #     GR.fillarea([0, ρ[i] * Math.cos(θ[i]), ρ[i] * Math.cos(θ[i + 1])],
-        #                 [0, ρ[i] * Math.sin(θ[i]), ρ[i] * Math.sin(θ[i + 1])])
-        #     GR.setfillcolorind(1)
-        #     GR.setfillintstyle(GR::INTSTYLE_HOLLOW)
-        #     GR.fillarea([0, ρ[i] * Math.cos(θ[i]), ρ[i] * Math.cos(θ[i + 1])],
-        #                 [0, ρ[i] * Math.sin(θ[i]), ρ[i] * Math.sin(θ[i + 1])])
-        #   end
+        when :polarhist
+          ymax = kvs[:window][3].to_f
+          ρ = y.map { |i| i / ymax }
+          θ = x.map { |i| i * 180 / Math::PI }
+          (1...ρ.length).each do |i|
+            GR.setfillcolorind(989)
+            GR.setfillintstyle(GR::INTSTYLE_SOLID)
+            GR.fillarc(-ρ[i], ρ[i], -ρ[i], ρ[i], θ[i - 1], θ[i])
+            GR.setfillcolorind(1)
+            GR.setfillintstyle(GR::INTSTYLE_HOLLOW)
+            GR.fillarc(-ρ[i], ρ[i], -ρ[i], ρ[i], θ[i - 1], θ[i])
+          end
 
         when :polarheatmap
           w, h = z.shape
@@ -1163,14 +1160,14 @@ module GR
       create_plot(:stem, *args)
     end
 
-    # def polarhistogram(x, kv = {})
-    #   plt = GR::Plot.new(x, kv)
-    #   plt.kvs[:kind] = :polarhist
-    #   nbins = plt.kvs[:nbins] || 0
-    #   x, y = hist(x, nbins)
-    #   plt.args = [[x, y, nil, nil, '']]
-    #   plt.plot_data
-    # end
+    def polarhistogram(x, kv = {})
+      plt = GR::Plot.new(x, kv)
+      plt.kvs[:kind] = :polarhist
+      nbins = plt.kvs[:nbins] || 0
+      x, y = hist(x, nbins)
+      plt.args = [[x, y, nil, nil, '']]
+      plt.plot_data
+    end
 
     # Draw a heatmap.
     def heatmap(*args)

data/lib/gr3.rb

@@ -81,7 +81,7 @@ module GR3
   # a FFI::MemoryPointer in the GR3Base class.
   extend GR3Base
 
-  # This module is for adding error checking to all methods in GR3
+  # This module is for adding error checking to all methods in GR3.
   module CheckError
     def geterror
       line = GRCommons::Fiddley::MemoryPointer.new(:int)

data/lib/gr3/ffi.rb

@@ -3,7 +3,9 @@
 require 'fiddle/import'
 
 module GR3
-  # FFI Wrapper module for GR3
+  # FFI Wrapper module for GR3.
+  # The functions for GR3 are listed here.
+  # Add functions here when a new version of GR is released.
   module FFI
     extend Fiddle::Importer
 
@@ -16,8 +18,7 @@ module GR3
     extend GRCommons::Extern
 
     # https://github.com/sciapp/gr/blob/master/lib/gr3/gr3.h
-    # Order is important.
-
+    # keep same order
     try_extern 'int gr3_init(int *attrib_list)'
     try_extern 'void gr3_free(void *pointer)'
     try_extern 'void gr3_terminate(void)'

data/lib/gr_commons/define_methods.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module GRCommons
-  # This module adds methods to the GRBase and GR3Base modules.
+  # This module provides a way to add FFI methods to the GRBase and GR3Base modules.
   module DefineMethods
     private
 
     def define_ffi_methods(ffi_class, prefix: '', default_type: :double)
       ffi_class.ffi_methods.each do |method|
-        # delete_prefix (Ruby >= 2.5)
+        # Use delete_prefix (Ruby >= 2.5)
         method_name = method.to_s.sub(/^#{prefix}/, '')
 
         # FIXME: Refactoring required

data/lib/gr_commons/extern.rb

@@ -5,9 +5,10 @@ module GRCommons
   module Extern
     attr_reader :ffi_methods
 
+    # Improved extern method.
     # 1. Ignore functions that cannot be attached.
-    #    For compatiblity with older versions of GR.
     # 2. Available function (names) are stored in @ffi_methods.
+    # For compatiblity with older versions of GR.
     def try_extern(signature, *opts)
       @ffi_methods ||= []
       begin

data/lib/gr_commons/fiddley.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-# Fiddley v0.0.8
-# https://github.com/unak/fiddley
-#
-# Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
-#
-# Released under the 2-Clause BSD License.
-
-# NOTE: kojix2 added, removed, and modified several methods.
-
 require 'fiddle/import'
 
 module GRCommons
-  # Ruby-FFI compatible API layer for Fiddle.
+  # Fiddley v0.0.8
+  # https://github.com/unak/fiddley
+  #
+  # Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
+  #
+  # Released under the 2-Clause BSD License.
+  #
+  # NOTE: This module is only part of the original code.
+  # kojix2 adds, deletes, and modifies several methods.
   module Fiddley
     # NOTE: GR.rb supports 2.4 +. Unpack 1 does not work under 2.3.
 

data/lib/gr_commons/gr_commons.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Module with common code for GR, GR3
+# Module with common code for GR, GR3.
 module GRCommons
 end
 

data/lib/gr_commons/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-01 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler