redshift 1.3.28 → 1.3.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36de30bee612231a2007d9738da0e725e53117b8
-  data.tar.gz: 0438a71cdd5dd1e88a2d31c195c53f1dddc4ddfb
+  metadata.gz: ec932d5d5f5e197edab9937d3032d5ca8133f8fd
+  data.tar.gz: 07317699aa39e485291098dda37a1540924c66aa
 SHA512:
-  metadata.gz: abf507a063549f1d2674c1fee1a651c7acfcfcfda8c4e2c8cad3854473d09640980a1818303642a8ffa6de6da75df6f2c2b92262b42d5fe3ecef1c63fbe522a8
-  data.tar.gz: c5679b5e664ada659737673002455a494eeba2ad8975e95e935ce686e0a582e5a7f286e4639ba1f2a592533cf809dd5ae3611e7eac35c62cd144a333d957cbbe
+  metadata.gz: 6b9af94beb0f3480c4b05ae9299016c8e073cea3cbf73f67afa99bc53f3d8cfc5d7742f596d7d219d7bdc82fe11c03ce2471c9152fb56ffe4fbb442c1a7c7839
+  data.tar.gz: a1017985179957c14476f74591ad24791ac37040bbd6cdb6cf0670e5544e7dba84dc6508b524876010d99ece518090e997507b5fba6e6ce0df3e3e0986055b06

data/README.md

@@ -2,14 +2,22 @@
 
 A framework for simulation of networks of hybrid automata, similar to SHIFT and Lambda-SHIFT. Includes ruby-based DSL for defining simulation components, and ruby/C code generation and runtime.
 
-There's no documentation yet. For now, start with the examples.
+RedShift is for simulating digital devices operating in an analog world. It's also for simulating any system that exhibits a mix of discrete and continuous behavior.
+
+There's not much [documentation](doc) yet, but plenty of [examples](examples). Some of the original SHIFT papers are available: [Shift: A Formalism and a Programming Language for Dynamic Networks of Hybrid Automata]( http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.32.5913&rep=rep1&type=pdf).
 
 ## Requirements ##
 
-RedShift needs ruby 1.8.x and a compatible C compiler. If you can build native gems, you're all set.
+RedShift needs ruby (1.8, 1.9, 2.0, 2.1) and a compatible C compiler. If you can build native gems, you're all set.
 
 Some of the examples also use Ruby/Tk and the tkar gem.
 
+## Installation ##
+
+Install as gem:
+
+    gem install redshift
+
 ## Env vars ##
 
 If you have a multicore system and are using the gnu toolchain, set
@@ -18,8 +26,22 @@ If you have a multicore system and are using the gnu toolchain, set
 
 or some variation. You'll find that rebuilds of your simulation code go faster.
 
+
+What is RedShift?
+-----------------
+
+RedShift combines *dataflow* programming (for continuous variables) with *actor*-based programming (for discrete events, states, and variables, and also for continuous variables).
+
+Examples
+--------
+
+See the [examples](examples) dir.
+
+The [RedCloud](https://github.com/vjoel/redcloud) project is based on RedShift.
+
+
 ----
 
-Copyright (C) 2001-2013, Joel VanderWerf, mailto:vjoel@users.sourceforge.net
+Copyright (C) 2001-2014, Joel VanderWerf, mailto:vjoel@users.sourceforge.net
 Distributed under the Ruby license. See www.ruby-lang.org.
 

data/RELEASE-NOTES

@@ -1,5 +1,9 @@
 redshift 1.3.28
 
+- gemspec specifies dvector-float extension
+
+redshift 1.3.28
+
 - update .gitignore
 - fixes for ruby 2.1
 - modernize rakefile: release tasks
@@ -34,7 +38,7 @@ redshift 1.3.23
 - compatible with ruby-1.9.2
 
 - renamed Random module to RandomDistribution to avoid conflict
-    
+
 redshift 1.3.22
 
 - handling of env vars is more consistent
@@ -127,7 +131,7 @@ redshift 1.3.13
 
 redshift 1.3.12
 
-- Fixed bug with explicitly assigning an array to a 
+- Fixed bug with explicitly assigning an array to a
   delay buffer.
 
 - Raise if time_step changes while using delay.
@@ -212,7 +216,7 @@ redshift 1.2.41
 - Improved message for reset type error.
 
 - Link vars can now be declared without a type (defaults to Component).
- 
+
 - Fixed Queue behavior when #unpop called with SimultaneousQueueEntries.
 
 - Added examples and tests.

data/examples/pid.rb

@@ -9,14 +9,14 @@ srand(12345)
 # Variable with discrete and continuous perturbation.
 class Plant < Component
   continuous :x => 0, :t => 1
-  
+
   link :control => :Control # fwd ref to undefined class Control
-  
+
   flow do
     diff " x' = control.output + sin(t) "
     diff " t' = -1 "
   end
-  
+
   transition do
     guard "t <= 0"
     action do
@@ -30,14 +30,14 @@ end
 class Control < Component
   continuous :set_point => 2.0
   continuous :p_out, :i_out, :d_out, :output
-  
+
   # Gains
   constant :k_p => 1.0,
            :k_i => 1.0,
            :k_d => 1.0
-  
+
   link :plant => Plant
-  
+
   flow do
     algebraic     " error   = set_point - plant.x "
     algebraic     " p_out   = k_p * error "

data/examples/robots/lib/shell-world.rb

@@ -34,7 +34,7 @@ module ShellWorld
 
     loop do
       evolve 100000000 do
-        puts "clock: #{clock}"
+        printf "clock: %10.3f\n" % clock
         #sleep 0.01
       end
     end

data/examples/scheduler.rb

@@ -18,10 +18,14 @@ class Scheduler < RedShift::Component
   
   class Request
     include Comparable
+
     attr_accessor :time, :queue, :message
+
     def <=>(other)
       self.time <=> other.time
     end
+
+    # Scheduled request: at given +time+, send +message+ to +queue+.
     def initialize time, queue, message
       @time, @queue, @message = time, queue, message
     end
@@ -29,6 +33,7 @@ class Scheduler < RedShift::Component
   
   EPSILON = 1E-12 # float fuzziness, if timestep is 0.1, for example
   
+  # Schedule the sending of +message+ to +queue+, after +delta_t+ elapses.
   # Returns the request object for use with unschedule
   def schedule_message delta_t, queue, message
     req = Request.new(time + delta_t - EPSILON, queue, message)
@@ -82,7 +87,7 @@ class Client < RedShift::Component
   
   transition Enter => Waiting do
     action do
-      puts "scheduling message at #{world.clock} sec"
+      puts "scheduling message at #{world.clock} sec to run after #{delay} sec"
       scheduler.schedule_message delay, wakeup, "Time to wake up, snoozebrain!"
     end
   end

data/lib/redshift/redshift.rb

@@ -69,8 +69,8 @@ end
 
 module RedShift
   include Math
-  
-  VERSION = '1.3.28'
+
+  VERSION = '1.3.29'
 
   Infinity = Math::Infinity
 
@@ -87,7 +87,7 @@ module RedShift
       $REDSHIFT_DEBUG = setting
     end
   end
-  
+
   # Returns a list of all worlds (instances of RedShift::World and subclasses),
   # or just those descending from +world_class+.
   # Not very efficient, since it uses <tt>ObjectSpace.each_object</tt>, but
@@ -99,7 +99,7 @@ module RedShift
   end
 
 #  class Warning < Exception; end
-#  
+#
 #  # Warn with string str and skipping n stack frames.
 #  def warn str, n = 0
 #    warning = sprintf "\nWarning: #{str}\n\t#{caller(n).join("\n\t")}\n"
@@ -112,7 +112,7 @@ module RedShift
 #  module_function :warn
 
   @library_calls = []
-  
+
   # Defer a block until just after the library ruby code is loaded, but before
   # commit. Necessary for defining inline C functions or shadow_attrs. Note that
   # a whole require statement could be placed inside the with_library block.

data/lib/redshift/util/tkar-driver.rb

@@ -2,7 +2,7 @@
 # Depends on:
 #   gem install tkar
 # See also:
-#   http://tkar.rubyforge.org
+#   https://github.com/vjoel/tkar
 class TkarDriver
   # +dragger+ is a callable object that takes (id, x, y) and should
   # move object id to (x,y)

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: redshift
 version: !ruby/object:Gem::Version
-  version: 1.3.28
+  version: 1.3.29
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tkar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: prng-isaac
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: A framework for simulation of networks of hybrid automata, similar to
@@ -60,6 +60,7 @@ executables: []
 extensions:
 - ext/redshift/buffer/extconf.rb
 - ext/redshift/dvector/extconf.rb
+- ext/redshift/dvector-float/extconf.rb
 extra_rdoc_files:
 - README.md
 - RELEASE-NOTES
@@ -211,7 +212,7 @@ files:
 - test/test_strictness_error.rb
 - test/test_sync.rb
 - test/test_world.rb
-homepage: http://rubyforge.org/projects/redshift
+homepage: https://github.com/vjoel/redshift
 licenses: []
 metadata: {}
 post_install_message: 
@@ -220,7 +221,7 @@ rdoc_options:
 - "--line-numbers"
 - "--inline-source"
 - "--title"
-- CGenerator
+- RedShift
 - "--main"
 - README.md
 - "--output"
@@ -239,8 +240,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: redshift
-rubygems_version: 2.2.0
+rubyforge_project: 
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Simulation of hybrid automata