y_petri 2.1.3 → 2.1.6

data/lib/y_petri/simulation/transitions/access.rb

@@ -14,88 +14,132 @@ class YPetri::Simulation::Transitions
     end
     alias include_transition? includes_transition?
 
-    # Transition of the simulation (belonging to the net).
+    # Net's transition.
     # 
     def t( id )
       transitions( id ).source
     end
 
-    # Transitions of the simulation (belonging to the net).
+    # Net's transitions.
     # 
     def tt( ids=nil )
       transitions( ids ).sources
     end
 
-    # Free places of the simulation (belonging to the net).
+    # Net's *ts* transitions.
     # 
     def ts_tt( ids=nil )
       ts_transitions( ids ).sources
     end
 
-    # Free places of the simulation (belonging to the net).
+    # Net's *tS* transitions.
     # 
     def tS_tt( ids=nil )
       tS_transitions( ids ).sources
     end
 
-    # Free places of the simulation (belonging to the net).
+
+    # Net's *Ts* transitions.
     # 
     def Ts_tt( ids=nil )
       Ts_transitions( ids ).sources
     end
 
-    # Free places of the simulation (belonging to the net).
+    # Net's *TS* transitions.
     # 
     def TS_tt( ids=nil )
       TS_transitions( ids ).sources
     end
 
-    # Transitions' names. Arguments, if any, are treated as in +#tranistions+ method.
+    # Net's *A* transitions.
+    # 
+    def A_tt( ids=nil )
+      A_transitions( ids ).sources
+    end
+
+    # Net's *S* transitions.
+    # 
+    def S_tt( ids=nil )
+      S_transitions( ids ).sources
+    end
+
+    # Net's *s* (non-stoichiometric) transitions.
+    # 
+    def s_tt( ids=nil )
+      s_transitions( ids ).sources
+    end
+
+    # Net's *T* transitions.
+    # 
+    def T_tt( ids=nil )
+      T_transitions( ids ).sources
+    end
+
+    # Net's *t* (timeless) transitions.
+    # 
+    def t_tt ids=nil
+      return transitions.t if ids.nil?
+      transitions.t.subset( ids )
+    end
+
+    # Names of specified transitions.
     # 
     def tn ids=nil
-      transitions( ids ).names
+      tt( ids ).names
     end
 
-    # Names of *ts* transitions. Arguments are handled as with +#ts_transitions+.
+    # Names of specified *ts* transitions.
     # 
     def nts ids=nil
-      ts_transitions( ids ).names( true )
+      ts_tt( ids ).names( true )
     end
 
-    # Names of *tS* transitions. Arguments are handled as with +#tS_transitions+.
+    # Names of specified *tS* transitions.
     # 
     def ntS ids=nil
-      tS_transitions( ids ).names( true )
+      tS_tt( ids ).names( true )
     end
 
-    # Names of *Ts* transitions. Arguments are handled as with +#tS_transitions+.
+    # Names of specified *Ts* transitions.
     # 
     def nTs ids=nil
-      Ts_transitions( ids ).names( true )
+      Ts_tt( ids ).names( true )
     end
 
-    # Names of *TS* transitions. Arguments are handled as with +#TS_transitions+.
+    # Names of specified *TS* transitions.
     # 
     def nTS ids=nil
-      TS_transitions( ids ).names( true )
+      TS_tt( ids ).names( true )
     end
 
-    # Names of *A* transitions. Arguments are handled as with +#A_transitions+.
+    # Names of specified *A* transitions.
     # 
     def nA ids=nil
-      A_transitions( ids ).names( true )
+      A_tt( ids ).names( true )
     end
 
-    # Names of *S* transitions. Arguments are handled as with +#S_transitions+.
+    # Names of specified *S* transitions.
     # 
     def nS ids=nil
-      S_transitions( ids ).names( true )
+      S_tt( ids ).names( true )
     end
 
-    # Names of *s* transitions. Arguments are handled as with +#s_transitions+.
+    # Names of specified *s* transitions.
     # 
     def ns ids=nil
-      s_transitions( ids ).names( true )
+      s_tt( ids ).names( true )
+    end
+
+    # Names of specified *T* transitions.
+    # 
+    def nT ids=nil
+      T_tt( ids ).names( true )
+    end
+
+    # Names of specified *t* transitions.
+    # 
+    def nt ids=nil
+      t_tt( ids ).names( true )
     end
 
     protected
@@ -132,7 +176,7 @@ class YPetri::Simulation::Transitions
     # 
     def ts_transitions ids=nil
       return transitions.ts if ids.nil?
-      transitions.ts.subset( ids )
+      transitions.ts.subset( transitions ids )
     end
 
     # Simulation's *tS* transitions. If arguments are given, they must identify
@@ -140,7 +184,7 @@ class YPetri::Simulation::Transitions
     # 
     def tS_transitions ids=nil
       return transitions.tS if ids.nil?
-      transitions.tS.subset( ids )
+      transitions.tS.subset( transitions ids )
     end
 
     # Simulation's *Ts* transitions. If arguments are given, they must identify
@@ -148,7 +192,7 @@ class YPetri::Simulation::Transitions
     # 
     def Ts_transitions ids=nil
       return transitions.Ts if ids.nil?
-      transitions.Ts.subset( ids )
+      transitions.Ts.subset( transitions ids )
     end
 
     # Simulation's *TS* transitions. If arguments are given, they must identify
@@ -156,7 +200,7 @@ class YPetri::Simulation::Transitions
     # 
     def TS_transitions ids=nil
       return transitions.TS if ids.nil?
-      transitions.TS.subset( ids )
+      transitions.TS.subset( transitions ids )
     end
 
     # Simulation's *A* transitions. If arguments are given, they must identify
@@ -164,7 +208,15 @@ class YPetri::Simulation::Transitions
     # 
     def A_transitions ids=nil
       return transitions.A if ids.nil?
-      transitions.A.subset( ids )
+      transitions.A.subset( transitions ids )
+    end
+
+    # Simulation's *a* transitions. If argument are given, they must identify
+    # *a* transitions, and are treated as in +#transitions+ method.
+    # 
+    def a_transitions ids=nil
+      return transitions.a if ids.nil?
+      transitions.a.subset( transitions ids )
     end
 
     # Simulation's *S* transitions. If arguments are given, they must identify
@@ -172,7 +224,7 @@ class YPetri::Simulation::Transitions
     # 
     def S_transitions ids=nil
       return transitions.S if ids.nil?
-      transitions.S.subset( ids )
+      transitions.S.subset( transitions ids )
     end
 
     # Simulation's *s* transitions. If arguments are given, they must identify
@@ -180,7 +232,23 @@ class YPetri::Simulation::Transitions
     # 
     def s_transitions ids=nil
       return transitions.s if ids.nil?
-      transitions.s.subset( ids )
+      transitions.s.subset( transitions ids )
+    end
+
+    # Simulation's *T* transitions. If arguments are given, they must identify
+    # *T* transitions, and are treated as in +#transitions+ method.
+    # 
+    def T_transitions ids=nil
+      return transitions.T if ids.nil?
+      transitions.T.subset( transitions ids )
+    end
+
+    # Simulation's *t* transitions. If arguments are given, they must identify
+    # *t* transitions, and are treated as in +#transitions+ method.
+    # 
+    def t_transitions ids=nil
+      return transitions.t if ids.nil?
+      transitions.t.subset( transitions ids )
     end
   end # Access
 end # class YPetri::Simulation::Transitions

data/lib/y_petri/simulation.rb

@@ -35,12 +35,12 @@ require_relative 'simulation/timed'
 # to be specified. Both come as hashes:
 # 
 class YPetri::Simulation
-  include Places::Access
-  include Transitions::Access
-  include Elements::Access
-  include InitialMarking::Access
-  include MarkingClamps::Access
-  include MarkingVector::Access
+  ★ Places::Access                   # ★ means include
+  ★ Transitions::Access
+  ★ Elements::Access
+  ★ InitialMarking::Access
+  ★ MarkingClamps::Access
+  ★ MarkingVector::Access
 
   DEFAULT_SETTINGS = -> do { method: :pseudo_euler, guarded: false } end
 
@@ -94,6 +94,7 @@ class YPetri::Simulation
     method = settings[:method] # the simulation method
     @guarded = settings[:guarded] # guarding on / off
     m_clamps = settings[:marking_clamps] || {}
+    m = settings[:marking]
     init_m = settings[:initial_marking] || {}
     use_default_marking = if settings.has? :use_default_marking then
                             settings[:use_default_marking]
@@ -150,7 +151,7 @@ class YPetri::Simulation
     # Init the core.
     @core = Core().new( method: method, guarded: guarded  )
     # Reset.
-    reset!
+    if m then reset! marking: m else reset! end
   end
 
   # Simulation settings.
@@ -194,9 +195,10 @@ class YPetri::Simulation
 
   # Resets the simulation
   # 
-  def reset! **settings
+  def reset! **nn
+    m = nn[:marking]
     tap do
-      m_vector.reset!
+      if m then m_vector.reset! m else m_vector.reset! end
       recorder.reset!
       recorder.alert
     end

data/lib/y_petri/transition/{assignment.rb → A.rb}

@@ -2,7 +2,7 @@
 
 # Mixin for the transitions with assignment action.
 # 
-module YPetri::Transition::Assignment
+module YPetri::Transition::Type_A
   # Transition's action (before validation).
   # 
   def action
@@ -36,4 +36,4 @@ module YPetri::Transition::Assignment
   def enabled?
     true
   end
-end # class YPetri::Transition::Assignment
+end # class YPetri::Transition::Type_A

data/lib/y_petri/transition/{timed.rb → T.rb}

@@ -2,7 +2,7 @@
 
 # Mixin for timed Petri net transitions.
 # 
-module YPetri::Transition::Timed
+module YPetri::Transition::Type_T
   # Transition's action (before validation). Requires Δt as an argument.
   # 
   def action Δt
@@ -47,4 +47,4 @@ module YPetri::Transition::Timed
       rescue YPetri::GuardError; false end
     end
   end
-end # class YPetri::Transition::Timed
+end # class YPetri::Transition::Type_T

data/lib/y_petri/transition/arcs.rb

@@ -1,8 +1,8 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
 
 # Connectivity aspect of a transition.
 #
-class YPetri::Transition
+module YPetri::Transition::Arcs
   # Names of upstream places.
   # 
   def domain_pp; domain.map { |p| p.name || p.object_id } end
@@ -48,4 +48,4 @@ class YPetri::Transition
     downstream_places.each &:fire_downstream_recursively
     return true
   end
-end # class YPetri::Transition
+end # module YPetri::Transition::Arcs

data/lib/y_petri/transition/cocking.rb

@@ -1,9 +1,9 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
 
 # Cocking mechanics of a transition. A transition has to be cocked, before
 # it can succesfuly +#fire+. (+#fire!+ method disregards cocking.)
 # 
-class YPetri::Transition
+module YPetri::Transition::Cocking
   # Is the transition cocked?
   # 
   def cocked?
@@ -29,4 +29,4 @@ class YPetri::Transition
     @cocked = false
   end
   alias :uncock! :uncock
-end # class YPetri::Transition
+end # class YPetri::Transition::Cocking

data/lib/y_petri/transition/{init.rb → construction_convenience.rb}

@@ -1,58 +1,11 @@
 # encoding: utf-8
 
-# Constructor syntax aspect of a transition. Large part of the functionality
-# of the Transition class is the convenient constructor syntax.
+# Given the four transition types (TS, Ts, tS, ts), transition construction
+# is not an easy task. Actually, having convenient constructor syntax is an
+# important part of the functionality of the Transition class. Construction
+# related functionality is thus gathered together in this mixin.
 # 
-class YPetri::Transition
-  # Transition class represents many different kinds of Petri net transitions.
-  # It makes the constructor syntax a bit more polymorphic. The type of the
-  # transition to construct is mostly inferred from the constructor arguments.
-  # 
-  # Mandatorily, the constructor will always need a way to determine the domain
-  # (upstream arcs) and codomain (downstream arcs) of the transition. Also, the
-  # constructor must have a way to determine the transition's action. This is
-  # best explained by examples -- let us have 3 places A, B, C, for whe we will
-  # create different kinds of transitions:
-  # 
-  # 
-  # ==== TS (timed stoichiometric)
-  #
-  # Rate closure and stoichiometry has to be supplied. Rate closure arity should
-  # correspond to the domain size. Return arity should be 1 (to be multiplied by
-  # the stoichiometry vector, as in all other stoichiometric transitions).
-  #
-  #   Transition.new stoichiometry: { A: -1, B: 1 },
-  #                  rate: -> a { a * 0.5 }
-  #                  
-  #
-  # ==== Ts (timed nonstoichiometric)
-  # 
-  # Rate closure has to be supplied, whose arity should match the domain, and
-  # output arity codomain.
-  # 
-  # ==== tS (timeless stoichiometric)
-  # 
-  # Stoichiometry has to be supplied, action closure is optional. If supplied,
-  # its return arity should be 1 (to be multiplied by the stoichiometry vector).
-  # 
-  # ==== ts transitions (timeless nonstoichiometric)
-  # 
-  # Action closure is expected with return arity equal to the codomain size:
-  # 
-  #   Transition.new upstream_arcs: [A, C], downstream_arcs: [A, B],
-  #                  action_closure: proc { |m, x|
-  #                                         if x > 0 then [-(m / 2), (m / 2)]
-  #                                         else [1, 0] end
-  #                                       }
-  # 
-  def initialize *args, &block
-    check_in_arguments *args, &block # the big job
-    extend timed? ? Timed : ( assignment? ? Assignment : OrdinaryTimeless )
-    inform_upstream_places         # that they have been connected
-    inform_downstream_places       # that they have been connected
-    uncock                         # transitions initialize uncocked
-  end
-
+module YPetri::Transition::ConstructionConvenience
   private
 
   # Checking in the arguments supplied to #initialize looks like a big job.
@@ -308,4 +261,4 @@ class YPetri::Transition
   def inform_downstream_places
     downstream_places.each { |p| p.send :register_upstream_transition, self }
   end
-end # class YPetri::Transition
+end # class YPetri::Transition::ConstructionConvenience

data/lib/y_petri/transition/{ordinary_timeless.rb → t.rb}

@@ -2,7 +2,7 @@
 
 # Mixin for timed non-assignment timeless Petri net transitions.
 # 
-module YPetri::Transition::OrdinaryTimeless
+module YPetri::Transition::Type_t
   # Result of the transition's "function", regardless of the #enabled? status.
   # 
   def action
@@ -45,4 +45,4 @@ module YPetri::Transition::OrdinaryTimeless
       rescue YPetri::GuardError; false end
     end
   end
-end # class YPetri::Transition::OrdinaryTimeless
+end # class YPetri::Transition::Type_t

data/lib/y_petri/transition/type.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+module YPetri::Transition::TypeInformation
+  # Is this a timed stoichiometric transition?
+  # 
+  def TS?
+    type == :TS
+  end
+
+  # Is this a timed non-stoichiometric transition?
+  # 
+  def Ts?
+    type == :Ts
+  end
+
+  # Is this a timeless stoichiometric transition?
+  # 
+  def tS?
+    type == :tS
+  end
+
+  # Is this a timeless non-stoichiometric transition?
+  # 
+  def ts?
+    type == :ts
+  end
+
+  # Is this a stoichiometric transition?
+  # 
+  def stoichiometric?; @stoichiometric end
+  alias S? stoichiometric?
+
+  # Is this a non-stoichiometric transition?
+  # 
+  def nonstoichiometric?
+    ! stoichiometric?
+  end
+  alias s? nonstoichiometric?
+
+  # Does the transition's action depend on delta time?
+  # 
+  def timed?
+    @timed
+  end
+  alias T? timed?
+
+  # Is the transition timeless? (Opposite of #timed?)
+  # 
+  def timeless?
+    not timed?
+  end
+  alias t? timeless?
+
+  # Is the transition functional?
+  # 
+  # Explanation: If rate or action closure is supplied, a transition is always
+  # considered 'functional'. Otherwise, it is considered not 'functional'.
+  # Note that even transitions that are not functional still have standard
+  # action acc. to Petri's definition. Also note that a timed transition is
+  # necessarily functional.
+  # 
+  def functional?
+    @functional
+  end
+
+  # Opposite of #functional?
+  # 
+  def functionless?
+    not functional?
+  end
+
+  # Reports the transition's membership in one of the 4 basic types:
+  # 
+  # 1. TS .... timed stoichiometric
+  # 2. tS .... timeless stoichiometric
+  # 3. Ts .... timed nonstoichiometric
+  # 4. ts .... timeless nonstoichiometric
+  #
+  # plus the fifth type
+  #
+  # 5. A .... assignment transitions
+  # 
+  def type
+    return :A if assignment_action?
+    timed? ? ( stoichiometric? ? :TS : :Ts ) : ( stoichiometric? ? :tS : :ts )
+  end
+
+  # Is this a transition with assignment action? (Transitions with assignment
+  # action, or "assignment transitions", completely replace the marking of their
+  # codomain with their action closure result, like in spreadsheets.)
+  # 
+  def assignment_action?
+    @assignment_action
+  end
+  alias assignment? assignment_action?
+  alias A? assignment_action?
+
+  # Is this a non-assignment transition? (Opposite of +#A?+)
+  # 
+  def a?
+    ! assignment_action?
+  end
+end # class YPetri::Transition::Type

data/lib/y_petri/transition/type_information.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+module YPetri::Transition::Types
+  # Is this a timed stoichiometric transition?
+  # 
+  def TS?
+    type == :TS
+  end
+
+  # Is this a timed non-stoichiometric transition?
+  # 
+  def Ts?
+    type == :Ts
+  end
+
+  # Is this a timeless stoichiometric transition?
+  # 
+  def tS?
+    type == :tS
+  end
+
+  # Is this a timeless non-stoichiometric transition?
+  # 
+  def ts?
+    type == :ts
+  end
+
+  # Is this a stoichiometric transition?
+  # 
+  def stoichiometric?; @stoichiometric end
+  alias S? stoichiometric?
+
+  # Is this a non-stoichiometric transition?
+  # 
+  def nonstoichiometric?
+    ! stoichiometric?
+  end
+  alias s? nonstoichiometric?
+
+  # Does the transition's action depend on delta time?
+  # 
+  def timed?
+    @timed
+  end
+  alias T? timed?
+
+  # Is the transition timeless? (Opposite of #timed?)
+  # 
+  def timeless?
+    not timed?
+  end
+  alias t? timeless?
+
+  # Is the transition functional?
+  # 
+  # Explanation: If rate or action closure is supplied, a transition is always
+  # considered 'functional'. Otherwise, it is considered not 'functional'.
+  # Note that even transitions that are not functional still have standard
+  # action acc. to Petri's definition. Also note that a timed transition is
+  # necessarily functional.
+  # 
+  def functional?
+    @functional
+  end
+
+  # Opposite of #functional?
+  # 
+  def functionless?
+    not functional?
+  end
+
+  # Reports the transition's membership in one of the 4 basic types:
+  # 
+  # 1. TS .... timed stoichiometric
+  # 2. tS .... timeless stoichiometric
+  # 3. Ts .... timed nonstoichiometric
+  # 4. ts .... timeless nonstoichiometric
+  #
+  # plus the fifth type
+  #
+  # 5. A .... assignment transitions
+  # 
+  def type
+    return :A if assignment_action?
+    timed? ? ( stoichiometric? ? :TS : :Ts ) : ( stoichiometric? ? :tS : :ts )
+  end
+
+  # Is this a transition with assignment action? (Transitions with assignment
+  # action, or "assignment transitions", completely replace the marking of their
+  # codomain with their action closure result, like in spreadsheets.)
+  # 
+  def assignment_action?
+    @assignment_action
+  end
+  alias assignment? assignment_action?
+  alias A? assignment_action?
+
+  # Is this a non-assignment transition? (Opposite of +#A?+)
+  # 
+  def a?
+    ! assignment_action?
+  end
+end # class YPetri::Transition::Type