numo-gnuplot 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e865eb2bf31c1edbd04ceddc258b75df8aab368
-  data.tar.gz: ee119b110229d70d890b908b568aaa785fda9fbd
+  metadata.gz: 8bad6abaa98a0a9d7359396665513a4c5d89dd67
+  data.tar.gz: 24b90ba847429a8af4b6afe4c8c57ef77ac286fc
 SHA512:
-  metadata.gz: c31f7b733ecaa2a41cbb650338657177e781d2a42653c951999f3c2ef2f4d933eeecfe1f244369b764d183e937072687fee4a3c22ea28933dda993c3ee72a64a
-  data.tar.gz: 4d2b967320a263878a2db1d263bdb19cb9cdc440a2b67d72e36f127705ba69218bdab5205b3ec0ee0a9093c6bfea6ca5ffdaf288f636ed7a1ff8e297e3df3c0f
+  metadata.gz: 7eb740ca2acb363b8b876f3e5e70bb815f4cbcd417a76b7e61c1190807fd19cbacb1b3f9b9671d0163f3898aa6d351346b86de0087c8093e7a4a8d83e4326d2b
+  data.tar.gz: dee61360f7deac2c128747a71584ef290edf417cc9e32adb8a83cec2e341cff77ba4003a819736004acc4a6e0eb29fdac04e1fa6334b137a0437f2c1c5806027

data/README.md

@@ -1,10 +1,12 @@
 # Numo::Gnuplot : Gnuplot interface for Ruby
 
 * Alpha version under development.
-* [GitHub site](https://github.com/masa16/numo-gnuplot)
+* [GitHub site](https://github.com/ruby-numo/gnuplot)
+* [RubyGems site](https://rubygems.org/gems/numo-gnuplot)
+* [API doc](http://www.rubydoc.info/gems/numo-gnuplot/Numo/Gnuplot)
 
-Although there are many [other Gnuplot interface libraries for Ruby](https://github.com/masa16/numo-gnuplot#related-work),
-none of them have so simple interface as to obtain an XY data plot by just typing:
+Although there are many [other Gnuplot interface libraries for Ruby](https://github.com/ruby-numo/gnuplot#related-work),
+none of them have so simple interface as to show an XY data plot by just typing:
 
     plot x,y
 
@@ -44,16 +46,16 @@ require "numo/gnuplot"
 
 ```ruby
 gp = Numo::Gnuplot.new
-gp.set title:"First Example"
-gp.plot "sin(x)"
+gp.set title:"Example Plot"
+gp.plot "sin(x)",w:"lines"
 ```
 
-* You can avoid receiver.
+* You can omit receiver.
 
 ```ruby
 Numo::Gnuplot.new.instance_eval do
-  set title:"Second Example"
-  plot "sin(x)"
+  set title:"Example Plot"
+  plot "sin(x)",w:"lines"
 end
 ```
 
@@ -61,18 +63,25 @@ end
 
 ```ruby
 Numo.gnuplot do
-  set title:"Third Example"
-  plot "sin(x)"
+  set title:"Example Plot"
+  plot "sin(x)",w:"lines"
 end
 ```
 
+* In these examples, the following command lines are send to Gnuplot.
+
+```
+set title "Example Plot"
+plot sin(x) w lines
+```
+
 * Interactive plotting with IRB:
 
 ```
 $ irb -r numo/gnuplot
 irb(main):001:0> pushb Numo.gnuplot
-irb(gnuplot):002:0> set t:"Forth Example"
-irb(gnuplot):003:0> plot "sin(x)"
+irb(gnuplot):002:0> set t:"Example Plot"
+irb(gnuplot):003:0> plot "sin(x)",w:"lines"
 ```
 
 * Plotting X-Y data.
@@ -116,9 +125,9 @@ x = Numo::DFloat[-n..n]/n*10
 
 Numo.gnuplot do
   set title:"multiple data series"
-  # separate by Hash
+  # place next data after option Hash
   plot x,NM.sin(x), {w:'points',t:'sin(x)'}, x,x*NM.sin(x),{w:"lines",t:'x*sin(x)'}
-  # or separate into Array
+  # or place data and options in Array
   # plot [x,NM.sin(x), w:'points',t:'sin(x)'], [x,x*NM.sin(x),w:"lines",t:'x*sin(x)']
   # (here last item in each Array should be Hash in order to distinguish from array data)
   gets
@@ -144,6 +153,42 @@ Numo.gnuplot do
 end
 ```
 
+## Gnuplot methods
+
+Numo::Gnuplot class methods succeeded from Gnuplot commands:
+
+* clear
+* exit
+* help(topic)
+* load(filename)
+* pause(*args)
+* plot(*args)
+* quit
+* reflesh
+* replot
+* reset(option)
+* set(*options)
+* show(option)
+* splot(*args)
+* unset(*options)
+
+Numo::Gnuplot class methods renamed from Gnuplot commands:
+
+* raise_plot(plot_window) -- 'raise' command
+* lower_plot(plot_window) -- 'lower' command
+
+Numo::Gnuplot-specific methods:
+
+* debug_off  -- turn off debug print
+* debug_on  -- turn on debug print
+* output(filename,*opts) -- output current plot to file. This invokes the next commands;
+```ruby
+set terminal:[ext,*opts], output:filename; refresh
+```
+* var(name) -- returns variable content in the Gnuplot context.
+
+See [API doc](http://www.rubydoc.info/gems/numo-gnuplot/Numo/Gnuplot) for more.
+
 ## Related Work
 
 * [Ruby Gnuplot](https://github.com/rdp/ruby_gnuplot/tree/master)
@@ -154,4 +199,4 @@ end
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/[USERNAME]/numo-gnuplot.
+https://github.com/ruby-numo/gnuplot.

data/examples/all.rb

@@ -1,17 +1,22 @@
 require "numo/gnuplot"
+#require_relative "../lib/numo/gnuplot"
 
 gp = Numo.gnuplot
+#gp.debug_on
 
-puts "mouse/key on window to continue"
-Dir.glob("ex*.rb") do |frb|
+puts "enter key to continue"
+
+files = Dir.glob("ex*.rb").sort
+files.each do |frb|
   gp.reset
+  puts "*** "+frb+" ***"
   load frb
-  gp.pause mouse:"any"
+  gets
 end
 
 gp.set term:"png"
 
-Dir.glob("ex*.rb") do |frb|
+files.each do |frb|
   fimg = File.basename(frb,".rb")+".png"
   gp.reset
   gp.set output:fimg

data/examples/ex006.rb

@@ -0,0 +1,15 @@
+# X-Y data plot from file
+fn = "tmp.dat"
+open(fn,"w") do |f|
+  100.times do |i|
+    x = i*0.1
+    f.printf("%g %g\n", x, Math.sin(x))
+  end
+end
+
+Numo.gnuplot do
+  set title:"X-Y data plot from file"
+  # if 'using' option is given,
+  # the first string argument is regarded as a data file.
+  plot fn, using:[1,2], w:'lines', t:'sin(x)'
+end

data/examples/ex010.rb

@@ -1,7 +1,7 @@
 require "numo/narray"
 
 # 3D plot of 2D data with Numo::NArray
-n = 60
+n = 120
 x = (Numo::DFloat.new(1,n).seq/n-0.5)*30
 y = (Numo::DFloat.new(n,1).seq/n-0.5)*30
 r = Numo::NMath.sqrt(x**2+y**2) + 1e-10
@@ -9,6 +9,5 @@ z = Numo::NMath.sin(r)/r
 
 Numo.gnuplot do
   set title:'3D plot of 2D data'
-  set dgrid3d:[60,60]
   splot z, w:'pm3d', t:'sin(r)/r'
 end

data/lib/numo/gnuplot.rb

@@ -11,7 +11,7 @@ module Numo
 
 class Gnuplot
 
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
   POOL = []
   DATA_FORMAT = "%.5g"
 
@@ -23,13 +23,17 @@ class Gnuplot
 
   def initialize(gnuplot_command="gnuplot")
     @history = []
+    @debug = false
+    unless system("which "+gnuplot_command)
+      kernel_raise GnuplotError,"Gnuplot command not found"
+    end
     @iow = IO.popen(gnuplot_command+" 2>&1","w+")
     @ior = @iow
     @gnuplot_version = send_cmd("print GPVAL_VERSION")[0].chomp
-    @debug = false
   end
 
   attr_reader :history
+  attr_reader :last_message
   attr_reader :gnuplot_version
 
   # draw 2D functions and data.
@@ -45,11 +49,11 @@ class Gnuplot
   end
 
   def _plot_splot(cmd,args)
-    contents = parse_plot_args(args)
+    contents = parse_plot_args(cmd,args)
     r = contents.shift.map{|x|"[#{x.begin}:#{x.end}] "}.join
     c = contents.map{|x| x.cmd_str}.join(",")
     d = contents.map{|x| x.data_str}.join
-    run "#{cmd} #{r}#{c}\n#{d}"
+    run "#{cmd} #{r}#{c}", d
     nil
   end
   private :_plot_splot
@@ -225,8 +229,8 @@ class Gnuplot
     "gnuplot"
   end
 
-  def run(s)
-    res = send_cmd(s)
+  def run(s,data=nil)
+    res = send_cmd(s,data)
     if !res.empty?
       if res.size > 7
         msg = "\n"+res[0..5].join("")+" :\n"
@@ -239,27 +243,28 @@ class Gnuplot
   end
   private :run
 
-  def send_cmd(s)
+  def send_cmd(s,data=nil)
     puts "<"+s if @debug
     @iow.puts s
+    @iow.puts data
     @iow.flush
     @iow.puts "print '_end_of_cmd_'"
     @iow.flush
     @history << s
-    res = []
+    @last_message = []
     while line=@ior.gets
       puts ">"+line if @debug
       break if /^_end_of_cmd_$/ =~ line
-      res << line
+      @last_message << line
     end
-    res # = res.chomp.strip
+    @last_message
   end
   private :send_cmd
 
-  def parse_plot_args(args)
-    list = [[]]
-    item = PlotItem.new
-    list << item
+  def parse_plot_args(cmd,args)
+    cPlotItem = (cmd == "plot") ? PlotItem : SPlotItem
+    list = [[],cPlotItem.new] # first item is range
+    item = list.last
     args.each do |arg|
       case arg
       when Range
@@ -270,23 +275,17 @@ class Gnuplot
         elsif PlotItem.is_data(arg)
           item << arg
         else
-          if list.last.empty?
-            list.pop
-          end
-          item = PlotItem.new(*arg)
-          list << item
+          list.pop if list.last.empty?
+          list << item = cPlotItem.new(*arg) # next PlotItem
         end
       when Hash
         item << arg
-        item = PlotItem.new
-        list << item
+        list << item = cPlotItem.new # next PlotItem
       else
         item << arg
       end
     end
-    if list.last.empty?
-      list.pop
-    end
+    list.pop if list.last.empty?
     return list
   end
   private :parse_plot_args
@@ -383,7 +382,11 @@ class Gnuplot
         when FalseClass
           nil
         when Array
-          "#{k} #{OptsToS.new(*v)}"
+          if /^#{k}/ =~ "using"
+            "#{k} #{v.join(':')}"
+          else
+            "#{k} #{OptsToS.new(*v)}"
+          end
         else
           "#{k} #{OptsToS.new(v)}"
         end
@@ -406,10 +409,10 @@ class Gnuplot
         end
       elsif defined?(Numo::NArray)
         return true if a.kind_of?(Numo::NArray)
-      elsif defined?(NArray)
-        return true if a.kind_of?(NArray)
-      elsif defined?(NMatrix)
-        return true if a.kind_of?(NMatix)
+      elsif defined?(::NArray)
+        return true if a.kind_of?(::NArray)
+      elsif defined?(::NMatrix)
+        return true if a.kind_of?(::NMatix)
       end
       false
     end
@@ -433,38 +436,37 @@ class Gnuplot
         elsif @items.first.kind_of? String
           @function = @items.first
           @options = @items[1..-1]
+          if (o=@items.last).kind_of? Hash
+            if o.any?{|k,v| /^#{k}/ =~ "using"}
+              # @function is data file
+              @function = "'#{@function}'"
+            end
+          end
         else
-          @data = []
+          data = []
           @options = []
           @items.each do |x|
             if PlotItem.is_data(x)
-              @data << x
+              data << x
             else
               @options << x
             end
           end
-          if @data.size==1
-            a = @data[0]
-            if a.respond_to?(:shape)
-              if a.shape.size == 2
-                @matrix = true
-              end
-            end
-          end
+          @data = parse_data(data)
         end
       end
     end
 
+    def parse_data(data)
+      PlotData.new(*data)
+    end
+
     def cmd_str
       parse_items
       if @function
         "%s %s" % [@function, OptsToS.new(*@options)]
       else
-        if @matrix
-          "'-' matrix %s" % OptsToS.new(*@options)
-        else
-          "'-' %s" % OptsToS.new(*@options)
-        end
+        "%s %s" % [@data.cmd_str, OptsToS.new(*@options)]
       end
     end
 
@@ -473,38 +475,114 @@ class Gnuplot
       if @function
         nil
       else
-        if @matrix
-          data2d_to_s(@data[0])+"\ne\n"
+        @data.data_str
+      end
+    end
+
+  end # PlotItem
+
+
+  # @private
+  class SPlotItem < PlotItem  # :nodoc: all
+    def parse_data(data)
+      if data.size == 1
+        if data[0].respond_to?(:shape)
+          SPlotArray.new(*data)
         else
-          data1d_to_s(@data)+"e\n"
+          PlotData.new(*data)
         end
+      else
+        SPlotRecord.new(*data)
       end
     end
+  end
+
 
+  # @private
+  class PlotData  # :nodoc: all
     def data_format
       @data_format || DATA_FORMAT
     end
 
-    def data_format=(s)
-      @data_format = s
+    def initialize(*data)
+      @data = data.map{|a| a.flatten}
+      @n = @data.map{|a| a.size}.min
+      @text = false
     end
 
-    def data1d_to_s(a)
-      n = a.map{|e| e.size}.min
-      f = ([data_format]*a.size).join(" ")+"\n"
-      s = ""
-      n.times{|i| s << f % a.map{|e| e[i]}}
-      s
+    def cmd_str
+      if @text
+        "'-'"
+      else
+        "'-' binary record=#{@n} format='%float64'"
+      end
     end
 
-    def data2d_to_s(a)
-      f = data_format
-      s = ""
-      a.to_a.each do |b|
-        s << b.map{|e| f%e}.join(" ")+"\n"
+    def data_str
+      if @text
+        f = ([data_format]*@data.size).join(" ")+"\n"
+        s = ""
+        @n.times{|i| s << f % @data.map{|a| a[i]}}
+        s+"\ne"
+      elsif defined? Numo::NArray
+        m = @data.size
+        x = Numo::DFloat.zeros(@n,m)
+        m.times{|i| x[true,i] = @data[i][0...@n]}
+        x.to_string
+      else
+        s = []
+        @n.times{|i| s.concat @data.map{|a| a[i]}}
+        s.pack("d*")
       end
-      s
     end
-  end # PlotItem
+  end
+
+  # @private
+  class SPlotRecord < PlotData  # :nodoc: all
+    def initialize(*data)
+      @shape = data.last.shape
+      super
+    end
+
+    def cmd_str
+      if @text
+        "'-'"
+      else
+        "'-' binary record=(#{@shape[1]},#{@shape[0]}) format='%float64' using 1:2:3"
+      end
+    end
+  end
+
+  # @private
+  class SPlotArray < PlotData  # :nodoc: all
+    def initialize(data)
+      @data = data
+    end
+
+    def cmd_str
+      if @text
+        "'-' matrix"
+      else
+        s = @data.shape
+        "'-' binary array=(#{s[1]},#{s[0]}) format='%float64'"
+      end
+    end
+
+    def data_str
+      if @text
+        f = data_format
+        s = ""
+        a.each do |b|
+          s << b.map{|e| f%e}.join(" ")+"\n"
+        end
+        s+"\ne"
+      elsif defined? Numo::NArray
+        Numo::DFloat.cast(@data).to_string
+      else
+        @data.to_a.flatten.pack("d*")
+      end
+    end
+  end
+
 end # Numo::Gnuplot
 end

data/numo-gnuplot.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Gnuplot interface for Ruby.}
   spec.description   = %q{Gnuplot interface for Ruby with simple and similar inteface with Gnuplot.}
-  spec.homepage      = "https://github.com/masa16/numo-gnuplot"
+  spec.homepage      = "https://github.com/ruby-numo/gnuplot"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-gnuplot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Masahiro TANAKA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,12 +56,13 @@ files:
 - examples/ex003.rb
 - examples/ex004.rb
 - examples/ex005.rb
+- examples/ex006.rb
 - examples/ex010.rb
 - examples/ex011.rb
 - lib/numo/gnuplot.rb
 - numo-gnuplot.gemspec
 - setup.rb
-homepage: https://github.com/masa16/numo-gnuplot
+homepage: https://github.com/ruby-numo/gnuplot
 licenses: []
 metadata: {}
 post_install_message: