y_petri 2.1.16 → 2.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faa600d44898af726d1c1fa7fe8e7e1304713539
-  data.tar.gz: b9037c0ba92671423c1b7625b2d82a83a6411fb0
+  metadata.gz: 2328ba306b41ea9642ef62fca6a3636d4d095d41
+  data.tar.gz: 3c6681ef9997d219fa94451dcc5af1e67e3e643b
 SHA512:
-  metadata.gz: 6b7be8d04a04a33505f903d2b173e715621d0be2b9a0c136b22d8fccc7a47174cf5dbb09dcb1fb66f540ec600cebd95aef06d23c28fc7a043f18ebb8bf9ac3cb
-  data.tar.gz: e443882ed004b50a4b2e8727961a0ab0101ac9d21e29ec67a48bd8a009545f5ce08bf3878133a1c50ba04bace33fcb602ef59715847cf2610a5203cc53f6186c
+  metadata.gz: 229068a2726963c754dc2cb29c1a0403975dad8699469659ea94c1f13dce35e4ee52e3f6e7ffbbe3b88aae0f769e40767115c0d8b9c16f4628f7aad37584ced7
+  data.tar.gz: 165e17b35a5f4573a4eb6b36003d62d48223dd7ef75e262c03646fc3102d7ba6d79ed21907b307a9465b05a862ba079b8049a9bb955f30284d432805b6740342

data/lib/y_petri.rb

@@ -1,15 +1,5 @@
 # encoding: utf-8
 
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/array/extract_options'
-require 'active_support/inflector'
-
-# The following are the Ruby libraries used by YPetri:
-require 'gnuplot'                      # used for graph visualization
-require 'csv'                          # not used at the moment
-require 'graphviz'                     # used for Petri net visualization
-require 'pp'                           # usef for pretty
-
 # The following are the YSupport components used by YPetri:
 require 'y_support/local_object'       # object aware of its creation scope
 require 'y_support/respond_to'         # Symbol#~@ + RespondTo#===
@@ -22,6 +12,17 @@ require 'y_support/stdlib_ext/matrix'  # matrix extensions
 require 'y_support/abstract_algebra'   # 
 require 'y_support/kde'                # popup file with kioclient
 
+# ActiveSupport components:
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/inflector'
+
+# The following are the Ruby libraries used by YPetri:
+require 'gnuplot'                      # used for graph visualization
+require 'csv'                          # not used at the moment
+require 'graphviz'                     # used for Petri net visualization
+require 'pp'                           # usef for pretty
+
 require_relative 'y_petri/version'
 require_relative 'y_petri/fixed_assets'
 require_relative 'y_petri/world'

data/lib/y_petri/net/data_set.rb

@@ -100,8 +100,8 @@ class YPetri::Net::DataSet < Hash
          end
     reduced_features = net.State.features *args
     rf_Record = reduced_features.Record
-    reduced_features.new_dataset( type: type ).tap do |dataset|
-      ( events >> records ).each_pair do |event, record|
+    reduced_features.new_dataset( type: type ).tap { |dataset|
+      ( events >> records ).each_pair { |event, record|
         absent_features = reduced_features - features()
         if absent_features.empty? then # it is a subset
           line = reduced_features.map { |feature| record.fetch feature }
@@ -132,8 +132,8 @@ class YPetri::Net::DataSet < Hash
           end
         end
         dataset.update event => rf_Record.load( line )
-      end
-    end
+      }
+    }
   end
 
   # Returns a subset of this dataset with only the specified marking features
@@ -237,4 +237,19 @@ class YPetri::Net::DataSet < Hash
       end
     end
   end
+
+  # Returns a string briefly discribing the dataset.
+  # 
+  def to_s
+    "#<DataSet: " +
+      "#{keys.size} records, " +
+      "features: #{features}" +
+      ">"
+  end
+
+  # Inspect string of the instance.
+  # 
+  def inspect
+    to_s
+  end
 end # YPetri::Net::Dataset

data/lib/y_petri/net/state/feature/delta.rb

@@ -6,6 +6,8 @@ class YPetri::Net::State::Feature::Delta < YPetri::Net::State::Feature
   attr_reader :place, :transitions, :step
 
   class << self
+    # Customization of the Class#parametrize method.
+    # 
     def parametrize *args
       Class.instance_method( :parametrize ).bind( self ).( *args ).tap do |ç|
         # First, prepare the hash of instances.
@@ -83,6 +85,11 @@ class YPetri::Net::State::Feature::Delta < YPetri::Net::State::Feature
     alias of new
   end
 
+  # The constructor of a delta feature takes one ordered argument (place
+  # identifier), and one named argument, +:transitions+, expecting an array
+  # of transition identifiers, whose contribution is taken into account in
+  # this delta feature.
+  # 
   def initialize place, transitions: net.tt
     @place = net.place( place )
     @transitions = net.transitions( transitions )
@@ -119,11 +126,21 @@ class YPetri::Net::State::Feature::Delta < YPetri::Net::State::Feature
     ! timed?
   end
 
+  # A string briefly describing this delta feature.
+  # 
   def to_s
     place.name
   end
 
+  # Label for the delta feature (to use in graphics etc.)
+  # 
   def label
     "Δ:#{place.name}:#{transitions.size}tt"
   end
+
+  # Inspect string of the delta feature.
+  # 
+  def inspect
+    "<Feature::Delta Δ:#{place.name || place}:#{transitions.size}tt>"
+  end
 end # class YPetri::Net::State::Feature::Delta

data/lib/y_petri/net/state/feature/firing.rb

@@ -6,6 +6,8 @@ class YPetri::Net::State::Feature::Firing < YPetri::Net::State::Feature
   attr_reader :transition
 
   class << self
+    # Customization of the Class#parametrize method.
+    # 
     def parametrize *args
       Class.instance_method( :parametrize ).bind( self ).( *args ).tap do |ç|
         ç.instance_variable_set( :@instances,
@@ -38,15 +40,23 @@ class YPetri::Net::State::Feature::Firing < YPetri::Net::State::Feature
       instances[ id ]
     end
 
+    # Alias of #new method.
+    # 
     def of id
       new id
     end
   end
 
+  # The constructor of a marking feature takes exactly one argument (transition
+  # identifier).
+  # 
   def initialize transition
     @transition = net.transition( transition )
   end
 
+  # Extracts the receiver marking feature from the argument. This can be
+  # typically a simulation instance.
+  # 
   def extract_from arg, **nn
     case arg
     when YPetri::Simulation then
@@ -56,7 +66,21 @@ class YPetri::Net::State::Feature::Firing < YPetri::Net::State::Feature
     end
   end
 
+  # A string briefly describing the firing feature.
+  # 
+  def to_s
+    label
+  end
+
+  # Label for the firing feature (to use in the graphics etc.)
+  # 
   def label
     "F:#{transition.name}"
   end
+
+  # Inspect string of the firing feature.
+  # 
+  def inspect
+    "<Feature::Firing of #{transition}>"
+  end
 end # YPetri::Net::State::Feature::Firing

data/lib/y_petri/net/state/feature/flux.rb

@@ -6,6 +6,8 @@ class YPetri::Net::State::Feature::Flux < YPetri::Net::State::Feature
   attr_reader :transition
 
   class << self
+    # Customization of the Class#parametrize method.
+    # 
     def parametrize *args
       Class.instance_method( :parametrize ).bind( self ).( *args ).tap do |ç|
         ç.instance_variable_set( :@instances,
@@ -38,15 +40,23 @@ class YPetri::Net::State::Feature::Flux < YPetri::Net::State::Feature
       instances[ id ]
     end
 
+    # Alias of #new method.
+    # 
     def of transition_id
       new transition_id
     end
   end
 
+  # The constructor of a marking feature takes exactly one argument (transition
+  # identifier).
+  # 
   def initialize id
     @transition = net.transition( id.is_a?( Flux ) ? id.transition : id )
   end
 
+  # Extracts the receiver marking feature from the argument. This can be
+  # typically a simulation instance.
+  # 
   def extract_from arg, **nn
     case arg
     when YPetri::Simulation then
@@ -56,7 +66,21 @@ class YPetri::Net::State::Feature::Flux < YPetri::Net::State::Feature
     end
   end
 
+  # A string briefly describing the flux feature.
+  # 
+  def to_s
+    label
+  end
+
+  # Label for the flux feature (to use in the graphics etc.)
+  # 
   def label
     "Φ:#{transition.name}"
   end
+
+  # Inspect string of the flux feature.
+  # 
+  def inspect
+    "<Feature::Flux of #{transition}>"
+  end
 end # class YPetri::Net::State::Feature::Flux

data/lib/y_petri/net/state/feature/gradient.rb

@@ -6,6 +6,8 @@ class YPetri::Net::State::Feature::Gradient < YPetri::Net::State::Feature
   attr_reader :place, :transitions
 
   class << self
+    # Customization of the Class#parametrize method.
+    # 
     def parametrize *args
       Class.instance_method( :parametrize ).bind( self ).( *args ).tap do |ç|
         # First, prepare the hash of instances.
@@ -45,21 +47,28 @@ class YPetri::Net::State::Feature::Gradient < YPetri::Net::State::Feature
 
     alias __new__ new
 
+    # Constructor #new is redefined to use instance cache.
+    # 
     def new *args
       return instances[ *args ] if args.size == 1
       instances[ args ]
     end
-
-    def of *args
-      new *args
-    end
+    alias of new
   end
 
+  # The constructor of a gradient feature takes one ordered argument (place
+  # identifier), and one named argument, +:transitions+, expecting an array
+  # of transition identifiers, whose contribution is taken into account in
+  # this gradient feature.
+  # 
   def initialize *id
     @place = net.place id.fetch( 0 )
     @transitions = net.transitions id.fetch( 1 ).fetch( :transitions )
   end
 
+  # Extracts the receiver gradient feature from the argument. This can be
+  # typically a simulation instance.
+  # 
   def extract_from arg, **nn
     case arg
     when YPetri::Simulation then
@@ -69,11 +78,21 @@ class YPetri::Net::State::Feature::Gradient < YPetri::Net::State::Feature
     end
   end
 
+  # A string briefly describing the gradient feature.
+  # 
   def to_s
-    place.name
+    label
   end
 
+  # Label for the gradient feature (to use in graphics etc.)
+  # 
   def label
     "∂:#{place.name}:#{transitions.size}tt"
   end
+
+  # Inspect string of the gradient feature.
+  # 
+  def inspect
+    "<Feature::Gradient ∂:#{place.name || place}:#{transitions.size}tt>"
+  end
 end # class YPetri::Net::State::Feature::Gradient

data/lib/y_petri/net/state/feature/marking.rb

@@ -6,6 +6,8 @@ class YPetri::Net::State::Feature::Marking < YPetri::Net::State::Feature
   attr_reader :place
 
   class << self
+    # Customization of the Class#parametrize method.
+    # 
     def parametrize *args
       Class.instance_method( :parametrize ).bind( self ).( *args ).tap do |ç|
         ç.instance_variable_set( :@instances,
@@ -37,15 +39,23 @@ class YPetri::Net::State::Feature::Marking < YPetri::Net::State::Feature
       instances[ id ]
     end
 
+    # Alias of #new method.
+    # 
     def of id
       new id
     end
   end
 
+  # The constructor of a marking feature takes exactly one argument (place
+  # identifier).
+  # 
   def initialize place
     @place = net.place( place )
   end
 
+  # Extracts the receiver marking feature from the argument. This can be
+  # typically a simulation instance.
+  # 
   def extract_from arg, **nn
     case arg
     when YPetri::Simulation then
@@ -55,11 +65,21 @@ class YPetri::Net::State::Feature::Marking < YPetri::Net::State::Feature
     end
   end
 
+  # A string briefly describing the marking feature.
+  # 
   def to_s
-    place.name
+    "m:#{label}"
   end
 
+  # Label for the marking feature (to use in graphics etc.)
+  # 
   def label
     ":#{place.name}"
   end
+
+  # Inspect string of the marking feature.
+  # 
+  def inspect
+    "<Feature::Marking of #{place}>"
+  end
 end # YPetri::Net::State::Feature::Marking

data/lib/y_petri/net/state/features.rb

@@ -279,4 +279,18 @@ class YPetri::Net::State::Features < Array
       end
     end
   end
+
+  # Returns a string briefly describing the feature set.
+  # 
+  def to_s
+    group_by( &:type )
+      .map { |feature_type, ff| "#{feature_type}: #{ff.size}" }
+      .join ', '
+  end
+
+  # Inspect string of the instance.
+  # 
+  def inspect
+    "#<Features: #{to_s}>"
+  end
 end # YPetri::Net::State::Features

data/lib/y_petri/version.rb

@@ -1,4 +1,4 @@
 module YPetri
-  VERSION = "2.1.16"
+  VERSION = "2.1.17"
   DEBUG = false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y_petri
 version: !ruby/object:Gem::Version
-  version: 2.1.16
+  version: 2.1.17
 platform: ruby
 authors:
 - boris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: y_support