numo-gnuplot 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e87eaed8bca276f54c5fe06d2e009ceeb3a5355a
-  data.tar.gz: 6f26b92d3cb90a633703b4392dbd0adb60ff070b
+  metadata.gz: e8bcac7c2ba2e8b6312acd20b52748afd86ddeb2
+  data.tar.gz: c246dfd861b0a58a83a0b3a41f5868de6b4b4c29
 SHA512:
-  metadata.gz: 2c6aaed522a0cdd5386afc91a40f26c3d51030d5aa31b3f9f3e535febf0abd6895aea67be8bdede43774ffae97d8b4f7590b93098b12854de12b4bb0b8a5b0b8
-  data.tar.gz: e6d06e0c9b00554eb7194b5284ea2c2c5f960810a2dfb3a652e6006028c95ea88f57f1b2ffd50688465cd1a1ce1517dcc308f0fc3416d219879825b31d8cc04b
+  metadata.gz: 16c972884c66c7ea7e85714ea53eb2482f4907eeed485d6287c1f251c06dd4031adf7bfc76d10ff059d8242ef15d63ad961e9d66c140d996b3cdb85c8e4e8080
+  data.tar.gz: a9408c167e56b22303cc77bb9b363be2b672f09031ea5465077918c8a40f3607f7153c02db739b390aad61ad62cf76888b20a98a0a98b9e831d06c886a0ab673

data/README.md

@@ -5,6 +5,8 @@
 * [RubyGems site](https://rubygems.org/gems/numo-gnuplot)
 * [API doc](http://www.rubydoc.info/gems/numo-gnuplot/Numo/Gnuplot)
 
+* Visit [Demo page](https://github.com/ruby-numo/numo-gnuplot-demo).
+
 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:
 
@@ -178,6 +180,7 @@ Numo::Gnuplot class methods succeeded from Gnuplot commands:
 
 * clear
 * exit
+* fit(*args)
 * help(topic)
 * load(filename)
 * pause(*args)
@@ -190,6 +193,7 @@ Numo::Gnuplot class methods succeeded from Gnuplot commands:
 * show(option)
 * splot(*args)
 * unset(*options)
+* update(*files)
 
 Numo::Gnuplot class methods renamed from Gnuplot commands:
 
@@ -198,11 +202,13 @@ Numo::Gnuplot class methods renamed from Gnuplot commands:
 
 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;
+* debug_off  -- turn off debug print.
+* debug_on  -- turn on debug print.
+* run(command_line) -- send command-line string to Gnuplot directly.
+* output(filename,[term,*opts]) -- output current plot to file. If term is omitted, an extension in filename is regarded as a term name. This invokes the next commands;
 ```ruby
-set terminal:[ext,*opts], output:filename; refresh
+set terminal:[term,*opts]
+set output:filename; refresh
 ```
 * var(name) -- returns variable content in the Gnuplot context.
 

data/examples/Rakefile

@@ -0,0 +1,3 @@
+require "rake/clean"
+
+CLEAN.include %w[*.png tmp.dat]

data/examples/all.rb

@@ -4,7 +4,7 @@ require "numo/gnuplot"
 gp = Numo.gnuplot
 #gp.debug_on
 
-puts "enter key to continue"
+puts "Hit enter key to continue"
 
 files = Dir.glob("ex*.rb").sort
 files.each do |frb|

data/examples/ex011.rb

@@ -12,11 +12,11 @@ x += df.zeros(n,1)
 y += df.zeros(1,n)
 
 Numo.gnuplot do
-  set title:'3D plot of XYZ data',
-      palette:{rgbformula:[22,13,-31]},
-      dgrid3d:[60,60],
-      xlabel:'x',
-      ylabel:'y',
-      zlabel:'sin(r)/r'
+  set title:'3D plot of XYZ data'
+  set palette:{rgbformula:[22,13,-31]}
+  set dgrid3d:[60,60]
+  set xlabel:'x'
+  set ylabel:'y'
+  set zlabel:'sin(r)/r'
   splot x,y,z, w:'pm3d', t:'sin(r)/r'
 end

data/lib/numo/gnuplot.rb

@@ -14,19 +14,20 @@ module Numo
   end
   module_function :noteplot
 
+  class GnuplotError < StandardError; end
+
 class Gnuplot
 
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
   POOL = []
   DATA_FORMAT = "%.7g"
 
-  class GnuplotError < StandardError; end
-
   def self.default
     POOL[0] ||= self.new
   end
 
   class NotePlot
+
     def initialize(&block)
       if block.nil?
         raise ArgumentError,"block is needed"
@@ -40,7 +41,8 @@ class Gnuplot
       # output SVG to tmpfile
       gp = Gnuplot.default
       gp.reset
-      gp.set terminal:'svg', output:tempfile_svg.path
+      gp.set terminal:'svg'
+      gp.output:tempfile_svg.path
       gp.instance_eval(&@block)
       gp.unset 'output'
       svg = File.read(tempfile_svg.path)
@@ -73,19 +75,20 @@ class Gnuplot
 
   # draw 2D functions and data.
   def plot(*args)
-    _plot_splot("plot",args)
+    contents = parse_plot_args(PlotItem,args)
+    _plot_splot("plot",contents)
     nil
   end
 
   # draws 2D projections of 3D surfaces and data.
   def splot(*args)
-    _plot_splot("splot",args)
+    contents = parse_plot_args(SPlotItem,args)
+    _plot_splot("splot",contents)
     nil
   end
 
-  def _plot_splot(cmd,args)
-    contents = parse_plot_args(cmd,args)
-    r = contents.shift.map{|x|"[#{x.begin}:#{x.end}] "}.join
+  def _plot_splot(cmd,contents)
+    r = contents.shift.map{|x| "#{x} "}.join
     c = contents.map{|x| x.cmd_str}.join(",")
     d = contents.map{|x| x.data_str}.join
     run "#{cmd} #{r}#{c}", d
@@ -94,37 +97,49 @@ class Gnuplot
   private :_plot_splot
 
   # replot is not recommended, use refresh
-  def replot
-    run "replot\n#{@last_data}"
+  def replot(arg=nil)
+    run "replot #{arg}\n#{@last_data}"
+    nil
+  end
+
+  # The `fit` command can fit a user-supplied expression to a set of
+  # data points (x,z) or (x,y,z), using an implementation of the
+  # nonlinear least-squares (NLLS) Marquardt-Levenberg algorithm.
+  def fit(*args)
+    range, items = parse_fit_args(args)
+    r = range.map{|x| "#{x} "}.join
+    c = items.cmd_str
+    puts send_cmd("fit #{r}#{c}")
     nil
   end
 
+  # This command writes the current values of the fit parameters into
+  # the given file, formatted as an initial-value file (as described
+  # in the `fit`section).  This is useful for saving the current
+  # values for later use or for restarting a converged or stopped fit.
+  def update(*filenames)
+    puts send_cmd("update "+filenames.map{|f| OptArg.squote(f)}.join(" "))
+  end
+
+  # This command prepares a statistical summary of the data in one or
+  # two columns of a file.
+  def stats(filename,*args)
+    fn = OptArg.squote(filename)
+    opt = OptArg.parse(*args)
+    puts send_cmd "stats #{fn} #{opt}"
+  end
+
   # The `set` command is used to set _lots_ of options.
   def set(*args)
-    _set_unset("set",args)
+    run "set #{OptArg.parse(*args)}"
     nil
   end
 
   # The `unset` command is used to return to their default state.
   def unset(*args)
-    _set_unset("unset",args)
-    nil
-  end
-
-  def _set_unset(cmd,args)
-    args.each do |a|
-      case a
-      when Hash
-        a.each do |k,v|
-          run "#{cmd} #{OptArg.parse_kv(k,v)}"
-        end
-      else
-        run "#{cmd} #{a}"
-      end
-    end
+    run "unset #{OptArg.parse(*args)}"
     nil
   end
-  private :_set_unset
 
   # The `help` command displays built-in help.
   def help(s=nil)
@@ -132,8 +147,8 @@ class Gnuplot
   end
 
   # The `show` command shows their settings.
-  def show(x)
-    puts send_cmd "show #{x}"
+  def show(*args)
+    puts send_cmd "show #{OptArg.parse(*args)}"
   end
 
   #  The `reset` command causes all graph-related options that can be
@@ -156,7 +171,7 @@ class Gnuplot
 
   # The `load` command executes each line of the specified input file.
   def load(filename)
-    send_cmd "load '#{filename}'"
+    run "load #{OptArg.squote(filename)}"
     nil
   end
 
@@ -215,16 +230,19 @@ class Gnuplot
 
   # output current plot to file with terminal setting from extension
   # (not Gnuplot command)
-  def output(filename,*opts)
-    if /\.(\w+)$/ =~ filename
-      ext = $1
-      ext = KNOWN_EXT[ext]||ext
-      set terminal:[ext,*opts], output:filename
-      refresh
-      unset :terminal, :output
-    else
+  def output(filename,term=nil,*opts)
+    if term.nil? && /\.(\w+)$/ =~ filename
+      term = $1
+    end
+    term = KNOWN_EXT[term] || term
+    if term.nil?
       kernel_raise GnuplotError,"file extension is not given"
     end
+    set terminal:[term,*opts]
+    set output:filename
+    refresh
+    unset :terminal
+    unset :output
   end
 
 
@@ -238,13 +256,17 @@ class Gnuplot
     @debug = false
   end
 
+  # send command-line string to Gnuplot directly
+  def send(cmd)
+    puts send_cmd(cmd)
+  end
+
   #other_commands = %w[
   #  bind
   #  call
   #  cd
   #  do
   #  evaluate
-  #  fit
   #  history
   #  if
   #  print
@@ -252,10 +274,8 @@ class Gnuplot
   #  reread
   #  save
   #  shell
-  #  stats
   #  system
   #  test
-  #  update
   #  while
   #]
 
@@ -269,16 +289,20 @@ class Gnuplot
   def run(s,data=nil)
     res = send_cmd(s,data)
     if !res.empty?
-      if res.size > 7
-        msg = "\n"+res[0..5].join("")+" :\n"
+      if res.size < 7
+        if res.all?{|x| /^\s*(line \d+: )?warning:/i =~ x}
+          $stderr.puts res.join.strip
+          return nil
+        else
+          msg = "\n"+res.join.strip
+        end
       else
-        msg = "\n"+res.join("")
+        msg = "\n"+res[0..5].join.strip+"\n :\n"
       end
       kernel_raise GnuplotError,msg
     end
     nil
   end
-  private :run
 
   def send_cmd(s,data=nil)
     puts "<"+s if @debug
@@ -290,25 +314,39 @@ class Gnuplot
     @history << s
     @last_message = []
     while line=@ior.gets
-      puts ">"+line if @debug
       break if /^_end_of_cmd_$/ =~ line
+      puts ">"+line if @debug
       @last_message << line
     end
     @last_message
   end
   private :send_cmd
 
-  def parse_plot_args(cmd,args)
-    cPlotItem = (cmd == "plot") ? PlotItem : SPlotItem
-    list = [[],cPlotItem.new] # first item is range
-    item = list.last
+  def parse_plot_args(cPlotItem,args)
+    range = []
+    while !args.empty?
+      case a = args.first
+      when Range
+        range << range_to_s(args.shift)
+      when String
+        if /^\[.*\]$/ =~ a
+          range << args.shift
+        else
+          break
+        end
+      else
+        break
+      end
+    end
+    item = cPlotItem.new # first item is range
+    list = [range,item]
     args.each do |arg|
       case arg
       when Range
-        list.first << arg
+        list.first << range_to_s(arg)
       when Array
         if arg.all?{|e| e.kind_of?(Range)}
-          list.first.concat(arg)
+          arg.each{|e| list.first << range_to_s(e)}
         elsif PlotItem.is_data(arg)
           item << arg
         else
@@ -318,6 +356,9 @@ class Gnuplot
       when Hash
         item << arg
         list << item = cPlotItem.new # next PlotItem
+      when String
+        list.pop if list.last.empty?
+        list << item = cPlotItem.new(arg) # next PlotItem
       else
         item << arg
       end
@@ -327,27 +368,102 @@ class Gnuplot
   end
   private :parse_plot_args
 
+  def range_to_s(*a)
+    case a.size
+    when 1
+      a = a[0]
+      "[#{a.first}:#{a.last}]"
+    when 2
+      "[#{a[0]}:#{a[1]}]"
+    else
+      raise ArgumetError,"wrong number of argument"
+    end
+  end
+  private :range_to_s
+
+  def parse_fit_args(args)
+    range = []
+    while !args.empty?
+      case a = args.first
+      when Range
+        range << range_to_s(args.shift)
+      when String
+        if /^\[.*\]$/ =~ a
+          range << args.shift
+        else
+          break
+        end
+      else
+        break
+      end
+    end
+    items = FitItem.new(args.shift, args.shift)
+    args.each do |arg|
+      case arg
+      when Range
+        range << range_to_s(arg)
+      when Array
+        if arg.all?{|e| e.kind_of?(Range)}
+          arg.each{|e| range << range_to_s(e)}
+        else
+          items << arg
+        end
+      else
+        items << arg
+      end
+    end
+    return [range,items]
+  end
+  private :parse_fit_args
+
 
   # @private
   module OptArg # :nodoc: all
 
     module_function
 
+    def from_symbol(s)
+      s = s.to_s
+      if /^(.*)_(noquote|nq)$/ =~ s
+        s = $1
+      end
+      s.tr('_',' ')
+    end
+
     def parse(*opts)
       sep = ","
-      opts.map do |opt|
-        sep = " " if !opt.kind_of?(Numeric)
+      a = []
+      while opt = opts.shift
+        if !opt.kind_of?(Numeric)
+          sep = " "
+        end
         case opt
+        when Symbol
+          a << from_symbol(opt)
+          case opt
+          when :label
+            if opts.first.kind_of?(Integer)
+              a << opts.shift.to_s
+            end
+            if opts.first.kind_of?(String)
+              a << OptArg.quote(opts.shift)
+            end
+          when NEED_QUOTE
+            if opts.first.kind_of?(String)
+              a << OptArg.quote(opts.shift)
+            end
+          end
         when Array
-          opt.map{|v| "#{parse(*v)}"}.join(sep)
+          a << parse(*opt)
         when Hash
-          opt.map{|k,v| parse_kv(k,v)}.compact.join(" ")
+          a << opt.map{|k,v| parse_kv(k,v)}.compact.join(" ")
         when Range
-          "[#{opt.begin}:#{opt.end}]"
+          a << "[#{opt.begin}:#{opt.end}]"
         else
-          opt.to_s
+          a << opt.to_s
         end
-      end.join(sep)
+      end
+      a.join(sep)
     end
 
     NEED_QUOTE = %w[
@@ -357,21 +473,16 @@ class Gnuplot
       commentschars
       dashtype
       decimalsign
-      dt
-      font
+      file
       fontpath
       format
-      format_cb
-      format_x
-      format_x2
-      format_xy
-      format_y
-      format_y2
-      format_z
       locale
       logfile
       missing
+      name
+      newhistogram
       output
+      prefix
       print
       rgb
       separator
@@ -383,52 +494,96 @@ class Gnuplot
       y2label
       ylabel
       zlabel
-      cb
-      x
       xy
-      x2
-      y
-      y2
-      z
+    ]
+    NONEED_QUOTE = %w[
+      for
+      log
+      smooth
     ]
 
     def NEED_QUOTE.===(k)
+      k = $1 if /_([^_]+)$/ =~ k
       re = /^#{k}/
+      return false if NONEED_QUOTE.any?{|q| re =~ q}
       any?{|q| re =~ q}
     end
 
-    def parse_kv(k,v)
-      case k.to_sym
+    def quote(s)
+      case s
+      when String
+        if /^'(.*)'$/ =~ s || /^"(.*)"$/ =~ s
+          s = $1
+        end
+        s.inspect
+      else
+        s
+      end
+    end
+
+    def squote(s)
+      case s
+      when String
+        if /^'.*'$/ =~ s || /^".*"$/ =~ s
+          s
+        else
+          "'#{s}'"
+        end
+      else
+        s
+      end
+    end
+
+    def parse_kv(s,v)
+      k = from_symbol(s)
+      case s.to_sym
       when :at
         case v
         when String
           "#{k} #{v}" # not quote
         when Array
-          "#{k} #{v.map{|x|(x.kind_of? String) ? x.inspect : x.to_s}.join(",")}"
+          "#{k} #{v.map{|x| x.to_s}.join(",")}"
         else
           "#{k} #{parse(v)}"
         end
       when :label
         case v
         when String
-          "#{k} #{v.inspect}"
+          "#{k} #{OptArg.quote(v)}"
         when Array
           if v[0].kind_of?(Integer) && v[1].kind_of?(String)
-            "#{k} #{parse(v[0],v[1].inspect,*v[2..-1])}"
+            "#{k} #{parse(v[0],OptArg.quote(v[1]),*v[2..-1])}"
           elsif v[0].kind_of?(String)
-            "#{k} #{parse(v[0].inspect,*v[1..-1])}"
+            "#{k} #{parse(OptArg.quote(v[0]),*v[1..-1])}"
           else
             "#{k} #{parse(*v)}"
           end
+        when TrueClass
+          k
         else
           "#{k} #{parse(v)}"
         end
       when NEED_QUOTE
         case v
         when String
-          "#{k.to_s.sub(/_/,' ')} #{v.inspect}"
+          "#{k} #{OptArg.quote(v)}"
+        when TrueClass
+          k
+        when NilClass
+          nil
+        when FalseClass
+          nil
         when Array
-          "#{k} #{v[0].inspect} #{parse(*v[1..-1])}"
+          case v[0]
+          when String
+            if v.size == 1
+              "#{k} #{OptArg.quote(v[0])}"
+            else
+              "#{k} #{OptArg.quote(v[0])} #{parse(*v[1..-1])}"
+            end
+          else
+            "#{k} #{parse(*v)}"
+          end
         else
           "#{k} #{parse(v)}"
         end
@@ -437,14 +592,17 @@ class Gnuplot
         when String
           "#{k} #{v}"
         when TrueClass
-          "#{k}"
+          k
         when NilClass
           nil
         when FalseClass
           nil
         when Array
-          if /^#{k}/ =~ "using"
+          re = /^#{k}/
+          if re =~ "using" || re =~ "every"
             "#{k} #{v.join(':')}"
+          elsif v.empty?
+            k
           else
             "#{k} #{parse(*v)}"
           end
@@ -501,7 +659,7 @@ class Gnuplot
           if (o=@items.last).kind_of? Hash
             if o.any?{|k,v| /^#{k}/ =~ "using"}
               # @function is data file
-              @function = "'#{@function}'"
+              @function = OptArg.squote(@function)
             end
           end
         else
@@ -514,7 +672,11 @@ class Gnuplot
               @options << x
             end
           end
-          @data = parse_data(data)
+          if data.empty?
+            @function = ''
+          else
+            @data = parse_data(data)
+          end
         end
       end
     end
@@ -544,6 +706,27 @@ class Gnuplot
   end # PlotItem
 
 
+  # @private
+  class FitItem # :nodoc: all
+    def initialize(expression,datafile)
+      @expression = expression
+      @datafile = datafile
+      @items = []
+    end
+
+    def <<(item)
+      @items << item
+    end
+
+    def empty?
+      @items.empty?
+    end
+
+    def cmd_str
+      "%s %s %s" % [@expression, OptArg.squote(@datafile), OptArg.parse(*@items)]
+    end
+  end
+
   # @private
   class SPlotItem < PlotItem  # :nodoc: all
     def parse_data(data)
@@ -567,6 +750,9 @@ class Gnuplot
     end
 
     def initialize(*data)
+      if data.empty?
+        raise ArgumentError,"no data"
+      end
       @data = data.map{|a| a.flatten}
       @n = @data.map{|a| a.size}.min
       @text = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-gnuplot
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Masahiro TANAKA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/Rakefile
 - examples/all.rb
 - examples/ex001.rb
 - examples/ex002.rb