numplot 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d354b2cc2c06f15dfb5130ea2ee5c48f1f157f2
-  data.tar.gz: 04ddb3b2c06dc8f02b43d9920b019df571abc151
+  metadata.gz: cdbe4f92ef197a8a2d1a10ef3a349209c40cda37
+  data.tar.gz: 5464bd3ae6a2871a484d46fd059eb5e719e20a14
 SHA512:
-  metadata.gz: 7aad96c6901b48822dcc03bc3ae5dd6bc2f0c90e5662c3dab090295d553096e9a08321e56b050bbdac9586f0265646a66ee885b6a5045c033bb213e1d768a444
-  data.tar.gz: e9acde2f4a6165047da57a44de4f223a751a89c084d284fe7508f2467fffcf81ee598d64897f812517483a95c749976b94fa0decbd22813d3f3597b81156867d
+  metadata.gz: cac8b0b03249cc8d1fcf580751c0c7f5d0e1f99a8d7d5bb7ec36ed480c42473fb5d220367dd6d20b8022d472e85fd5e9de38bed0bd5e970f861a78a0aa94fd09
+  data.tar.gz: 7ea8b225b4d3cfd3d14670266e95ad6735a431f99946920386b455d628939ab7e5411e44ef65edbf290df02ad9272e6081cfa8e2edd4aa0b93e421611bb8cb80

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2013, Ippei Obayashi
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* 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 HOLDER 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

@@ -0,0 +1,29 @@
+# NumPlot
+
+This library is a wrapper library of the gnuplot command.
+
+## Install
+
+* Install gnuplot command
+* gem install numplot
+
+## Usage
+In your scirpt,
+
+  require 'numplot'
+
+and use NumPlot module. 
+Please see {file:sample/sample1.rb} as an example.
+
+## URLs
+* [bitbucket repository](https://bitbucket.org/ohai/numplot)
+
+## Author
+Ippei Obayashi <ohai@kmc.gr.jp>
+
+## Copyright
+Copyright (c) 2013, Ippei Obayashi
+All rights reserved.
+
+The software is licensed under the BSD 2-Clause License.
+Please see the {file:LICENSE} for more information.

data/lib/numplot.rb

@@ -17,17 +17,31 @@ module NumPlot
     def convert_range(range)
       case range
       when String then range
-      when Range then "[#{range.begin}:#{range.end}]"
+      when Range then range_pair(range.begin, range.end)
       when Array
         if range.size != 2
           raise TypeError, "Cannot convert #{range.inspect} to gnuplot's range"
         end
-        "[#{range[0]}:#{range[1]}]"
+        range_pair(range[0], range[1])
       else
         raise TypeError, "Cannot convert #{range.inspect} to gnuplot's range"
       end
     end
 
+    # Convert a pair of lower and upper bounds to the gnuplot "range"
+    # parmameter stirng.
+    # This method is used for converting ranges and arrays of two elements
+    # into strings.
+    def range_pair(lower, upper)
+      "[#{range_bound(lower)}:#{range_bound(upper)}]"
+    end
+    
+    def range_bound(x)
+      return "" if Float === x && x.infinite?
+      return "" if x.nil?
+      x.to_s
+    end
+    
     def convert_color(color)
       case color
       when RGB then color.to_gnuplot_string
@@ -49,8 +63,22 @@ module NumPlot
     def quote(str)
       "\"#{str}\""
     end
-  end
 
+    def escape_label(s)
+      s.gsub(/[\^_\{\}@&\\~]/){|s| "\\#{s}"}
+    end
+
+    def quote_label(s, enhanced)
+      return "'#{s.text}'" if s.kind_of?(EnhancedText)
+        
+      if enhanced
+        "'#{escape_label(s)}'"
+      else
+        "\"#{s}\""
+      end
+    end
+  end
+  
   # The class representing colors in gnuplot.
   #
   # You can use three types of color specifications like the following
@@ -210,7 +238,7 @@ module NumPlot
   #   plotter = NumPlot::Plotter.new
   #   # Set parameters
   #   plotter.set("term", "png")
-  #   plotter.set("output", "\"sin.png\"") # Need to quote 
+  #   plotter.output("sin.png")
   #   plotter.xrange -2.0 .. 2.0
   #   # Set datasets
   #   plotter.datasets << NumPlot::Dataset.rows(data, title: "sin(x)", with: line)
@@ -280,14 +308,16 @@ module NumPlot
     #   @overload $0(range, *opts)
     #     Set $0 parameter.
     #     You can specify the range with one of three styles.
+    #
     #     * a string such as: "[-1.0:1.0]" or "[:2.0]"
     #     * a range such as: -1.0 .. 1.0 or -Float::INFINITY .. 2.0
     #     * an array such as: [-1.0, 1.0] or [nil, 2.0]
+    #
     #     You can also specify the following options as args:
-    #     * "reverse"
-    #     * "no reverse"
-    #     * "writeback"
-    #     * "no writeback"
+    #
+    #     * reverse: or noreverse: true or false 
+    #     * writeback: or nowriteback: true or false
+    #
     #     @param range[String,Range,Array] the range of x axis
     #     @param opts[Array<String>] options
     #     @return [self]
@@ -316,15 +346,29 @@ module NumPlot
     # @!visibility private
     RANGE_OPTIONS = [YesNoOption[:reverse], YesNoOption[:writeback]]
 
+    # Enable an enhanced text mode of gnuplot.
+    def enable_enhanced_text_mode
+      @enhanced = true
+      set("termoption", "enhanced")
+    end
+
+    # Disable an enhanced text mode of gnuplot.
+    def disable_enhanced_text_mode
+      @enhanced = false
+      set("termoption", "noenhanced")
+    end
+    
     # @!macro [new] label
     #   @overload $0(label, opts={})
     #     Set $0 parameter.
     #     You can specify the following options as a hash:
-    #     * offset: OFFSET
-    #     * font: FONT
-    #     * textcolor: COLOR (tc: is also available)
-    #     * enhanced: true OR noenhanced: true
+    #
+    #     * offset: the label is moved by the given offset
+    #     * font: font info {Font}
+    #     * textcolor: color {RGB} (tc: is also available)
+    #     * enhanced: or noenhanced: true or false
     #     * rotate: (TODO: FIX IT) OR  norotate: true
+    #
     #     @param label[String] label string
     #     @param opts[{Symbol => Object}] options
     #     @return [self]
@@ -341,16 +385,29 @@ module NumPlot
     def y2label(*args); _label("y2label", *args); end
     
     def _label(type, *args)
-      set(type, LabelParser.parse(*args))
+      set(type, LabelParser.parse(@enhanced, *args))
     end
     private :_label
 
+    # Set output target.
+    # You can specify target file name.
+    # @param fname[String,nil] name of target file
+    # @return [void]
+    def output(fname)
+      if fname.nil?
+        set("output")
+      else
+        set("output", "\"#{fname}\"")
+      end
+    end
+    
     # Plot given datasets with given parameters.
     # @overload plot(opts={})
     #   Open a gnuplot process and write commands and data to the process.
     #   You get the result of plotting on a window or an image file
     #   
     #   You can specify the following options:
+    #
     #   * :persist - Add -persist to gnuplot command.
     #     The default value is true.
     #   * :waiting - Wait a gnuplot process to be terminate.
@@ -390,7 +447,7 @@ module NumPlot
       @commands.each{|cmd| pr.puts(cmd) }
       pr.write(@plot_command)
       pr.write(" ")
-      pr.write(@datasets.map{|e| e.to_plot_arg }.join(", "))
+      pr.write(@datasets.map{|e| e.to_plot_arg(@enhanced) }.join(", "))
       pr.write("\n")
       pr.write(@datasets.map{|e| e.to_plot_dataset }.compact.join("e\n"))
     end
@@ -400,6 +457,7 @@ module NumPlot
   # The dataset class plotted by {Plotter}.
   # 
   # You can construct a dataset object using one of the following three methods:
+  #
   # * {.columns}: construct a dataset from columns
   # * {.rows}: construct a dataset from rows
   # * {.histogram}: construct a histogram dataset
@@ -410,12 +468,14 @@ module NumPlot
   # The dataset object is registered to {Plotter} object using
   # {Plotter#add_dataset}.
   # 
-  # == Parameters for a dataset
+  # # Parameters for a dataset
+  #
   # When you call {.columns}, {.rows}, or {.histogram},
   # you can give some parameters to determine the style of 
   # plotting.
   # The parameters are as follows. If you know the details
   # of these parameters, please read the gnuplot documents.
+  #
   # * title: "TITLE" or notitle: true
   # * with: "points", "dots", etc.
   # * axis:
@@ -476,31 +536,51 @@ module NumPlot
       new(data.map(&:to_a), opts)
     end
 
-
+    # Construct a dataset object from a sequence of sequences of rows
+    #
+    # If your data is like
+    #   [[[x00, y00] [x01, y01], ... ], [[x10, y10], [x11, y11], ...], ..]
+    # you should use this method.
+    # 
+    # You can give some parameters as a hash
+    # to set a plotting style. Please see
+    # {Dataset} for details.
+    # @param data[Enumerable<Enumerable<Numeric>>] 
+    # @param opts[{Symbol => object}] options
+    # @return [Dataset]
+    def self.lines(data, opts={})
+      data = data.map{|lines|
+        lines.to_a + [[]]
+      }.flatten(1)
+      p data
+      new(data, opts)
+    end
+    
     # Construct a histogram dataset object.
     #
     # You need to give some parameters to construct a histogram.
+    #
     # * dim: the dimension of your data, now only 1-dim data is supported
     #   (default is 1)
     # * binsize: the bin size (required, Numeric)
-    # * base: the coordinate of a left side of a bin (default is 0.0).
+    # * base: the coordinate of a center of a bin (default is 0.0).
     #   If binsize = 1.0 and base = 0.0, the bins are
-    #   ..., [-1.0, 0.0), [0.0, 1.0), ... .
-    #   If binsize = 1.0 and base = 0.5, the bins are
     #   ..., [-1.5, -0.5), [-0.5, 0.5), [0.5, 1.5), ... .
+    #   If binsize = 1.0 and base = 0.5, the bins are
+    #   ..., [-1.0, 0.0), [0.0, 1.0), ... .
     # * histogram_style: You can choose one of the following normalization
     #   scheme:
-    #   * :count  not normalized
-    #   * :ratio  normailized to the number of data points
-    #   * :density normalized to (the number of data points)*(binsize).
-    #     You choose this option if you want to show the probability density
-    #     function from the data.
+    #     * :count  not normalized
+    #     * :ratio  normailized to the number of data points
+    #     * :density normalized to (the number of data points)*(binsize).
+    #        You choose this option if you want to show the probability density
+    #        function from the data.
     # * cumulative: construct a cumulative histogram if true.
     #   If the cumulative option is true, the meaning of
     #   histogram_style option is changed.
-    #   * :count not normalized
-    #   * :ratio, :density normalized by the number of data, this means that
-    #     the maximum value of a cumulative histogram is normalized to 1.
+    #     * :count not normalized
+    #     * :ratio, :density normalized by the number of data, this means that
+    #       the maximum value of a cumulative histogram is normalized to 1.
     # 
     # You can also give some other parameters to determine
     # a plotting style. See {Dataset} for details.
@@ -583,7 +663,8 @@ module NumPlot
     # Return a stirng for gnuplot's "plot" or "splot" like "'-' with dots"
     # @return [String] 
     # @!visibility private
-    def to_plot_arg
+    def to_plot_arg(in_enhanced_mode)
+      @opts[:_in_enhanced_text_mode] = in_enhanced_mode
       ret = "'-'"
       OPTIONS.each do |opt|
         ret << opt.plot_arg(@opts)
@@ -600,13 +681,15 @@ module NumPlot
 
     # @!visibility private
     class Title
+      include Conversion
+      
       def plot_arg(h)
         if h[:notitle]
           " notitle"
         elsif h.has_key?(:title)
-          " title \'#{h[:title]}\'"
+          " title #{quote_label(h[:title], h[:_in_enhanced_text_mode])}"
         else
-          ""
+          " notitle"
         end
       end
     end
@@ -633,7 +716,7 @@ module NumPlot
 
   # @!visibility private
   class LabelParser
-    def self.parse(*args)
+    def self.parse(enhanced, *args)
       if Hash === args.last
         opts = args.pop
       else
@@ -645,7 +728,7 @@ module NumPlot
       raise ArgumentError, "Unknown label argument #{args.inspect}" if !args.empty?
       raise ArgumentError, "No label text" if label.nil?
       
-      gnuplot_string = Conversion.quote(label)
+      gnuplot_string = Conversion.quote_label(label, enhanced)
       
       OPTIONS.each do |opt|
         gnuplot_string << opt.plot_arg(opts)
@@ -662,6 +745,28 @@ module NumPlot
                BoolOption[:norotate],
               ]
   end
-  
 
+  # Represents "enhanced text" in enhanced text mode
+  # All unmarked texts are handled as "non enhanced text" and
+  # all special characters are escaped in enhanced text mode.
+  class EnhancedText
+    # Create an EnhancedText object.
+    #
+    # You can use the short-cut method {NumPlot#ET}.
+    def initialize(text)
+      @text = text
+    end
+
+    # @return [String] a text
+    attr_reader :text
+  end
+
+  # Mark a text as "enhanced text" in enhanced text mode
+  #
+  # @return [EnhancedText]
+  # @param text[String] an text handled by "enhanced text mode"
+  def ET(text)
+    EnhancedText.new(text)
+  end
+  module_function :ET
 end

data/sample/sample1.rb

@@ -22,7 +22,7 @@ plotter <<
 normal_random_dist = Array.new(10000){ rand_normal }
 plotter <<
   NumPlot::Dataset.histo(normal_random_dist,
-                         binsize: 0.1, histogram_style: :density,
+                         binsize: 0.07, histogram_style: :density,
                          title: "a normal distribution")
 
 plotter.xrange(-1.0 .. 1.0)

data/test/test_conversion.rb

@@ -0,0 +1,23 @@
+require 'numplot'
+
+require 'test-unit'
+
+class TestConversion < Test::Unit::TestCase
+  include NumPlot
+
+  def test_convert_range
+    inf = Float::INFINITY
+    assert_equal("[1:2]", Conversion.convert_range([1,2]))
+    assert_equal("[1:2]", Conversion.convert_range(1..2))
+    assert_equal("[1:2]", Conversion.convert_range(1...2))
+    assert_equal("[:]", Conversion.convert_range(-inf .. inf))
+    assert_equal("[2.0:]", Conversion.convert_range(2.0 .. inf))
+    assert_equal("[:2.0]", Conversion.convert_range([nil, 2.0]))
+    assert_equal("[:2.0]", Conversion.convert_range([-inf, 2.0]))
+  end
+
+  def test_escape_label
+    assert_equal('\{\{/Symbol q\}\_n\}\^r\~a\{.8-\}',
+                 Conversion.escape_label("{{/Symbol q}_n}^r~a{.8-}"))
+  end
+end

data/test/test_labelparser.rb

@@ -6,9 +6,11 @@ class TestRGB < Test::Unit::TestCase
   include NumPlot
   
   def test_s_parse
-    assert_equal("\"foo\"", LabelParser.parse("foo"))
+    assert_equal("\"foo\"", LabelParser.parse(false, "foo"))
     assert_equal("\"foo\" offset 32 font \"bar,14\"",
-                 LabelParser.parse("foo", offset: 32, font: Font["bar",14]))
-                  
+                 LabelParser.parse(false, "foo", offset: 32, font: Font["bar",14]))
+    assert_equal("'foo'", LabelParser.parse(true, "foo"))
+    assert_equal("'x\\_y'", LabelParser.parse(true, "x_y"))
+    assert_equal("'x_y'", LabelParser.parse(true, ET("x_y")))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numplot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Ippei Obayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -35,12 +35,16 @@ files:
 - lib/numplot/option.rb
 - sample/sample1.rb
 - test/run_test.rb
+- test/test_conversion.rb
 - test/test_labelparser.rb
 - test/test_options.rb
 - test/test_plotter.rb
 - test/test_rgb.rb
+- README.md
+- LICENSE
 homepage: http://www.kmc.gr.jp
-licenses: []
+licenses:
+- 2-clause BSDL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -58,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: An wrapper for gnuplot
 test_files: []
-has_rdoc: