spnet 0.1.5 → 0.1.6

data/ChangeLog.rdoc

@@ -22,4 +22,18 @@ In Block, contain all InPort objects in @in_ports, and all OutPort objects in @o
 
 === 0.1.4 / 2013-02-06
 
-CommandInPort only requires :command_map instead of :list_commands_handler and :exec_command_handler. The command map is just a hash that maps command names to their execution handlers.
+CommandInPort only requires :command_map instead of :list_commands_handler and :exec_command_handler. The command map is just a hash that maps command names to their execution handlers.
+
+=== 0.1.5 / 2013-02-18
+
+Update for use with hashmake-0.1.5 gem.
+Add storage classes: NetworkState, BlockState, LinkState, and PortLocater. These are for persisting a network without relying on non-SPNet objects, which may not be serializable.
+Add limiter classes: RangeLimiter, UpperLimiter, LowerLimiter, EnumLimiter, and NoLimiter. A given limiter object will be used in a ParamInPort to limit an incoming value. The default NoLimiter object does nothing.
+Remove @sample_rate_port from Block class. This means blocks can't change sample rate after initialization.
+Every block is given just one parameter: a Hash containing the :sample_rate key. Block instances expect to recieve this key in #initialize.
+
+=== 0.1.6 / 2013-02-18
+
+Change port_params to params.
+Only export params that have changed from initialization.
+Remove @name from Network class.

data/lib/spnet/core/block.rb

@@ -22,6 +22,7 @@ class Block
   #                    for details of which keys are required.
   def initialize args = {}
     hash_make Block::ARG_SPECS, args
+    @initial_params = collect_params
   end
   
   # Execute the block algorithm.
@@ -33,14 +34,30 @@ class Block
   # Produces a BlockState object based on this Block object.
   # @return [BlockState]
   def export_state
-    port_params = {}
+    params = collect_params
+    
+    # discard the params that are the same as the initial port params
+    params.keys.each do |key|
+      if params[key] == @initial_params[key]
+        params.delete key
+      end
+    end
+    
+    BlockState.new(:class_sym => self.class.to_s.to_sym, :params => params)
+  end
+
+  private
+  
+  def collect_params
+    params = {}
+    
     @in_ports.each do |name, port|
       if port.is_a?(ParamInPort)
-        port_params[name] = port.get_value
+        params[name] = port.get_value
       end
     end
     
-    BlockState.new(:class_sym => self.class.to_s.to_sym, :port_params => port_params)
+    return params
   end
 end
 end

data/lib/spnet/core/network.rb

@@ -9,12 +9,11 @@ class Network
   # Define arg specs to use in processing hashed arguments during #initialize.
   ARG_SPECS = {
     :sample_rate => arg_spec(:reqd => true, :type => Numeric, :validator => ->(a){a > 0.0}),
-    :name => arg_spec(:reqd => false, :type => String, :default => ""),
     :blocks => arg_spec_hash(:reqd => false, :type => Block),
     :links => arg_spec_array(:reqd => false, :type => Link),
   }
   
-  attr_reader :sample_rate, :name, :blocks, :links
+  attr_reader :sample_rate, :blocks, :links
   
   # A new instance of Network. Changes all block sample rates (if necessary) to
   # match the given sample rate. Activates links.
@@ -47,7 +46,7 @@ class Network
       link_states.push link.export_state(@blocks)
     end
     
-    return NetworkState.new(:name => @name, :block_states => block_states, :link_states => link_states)
+    return NetworkState.new(:block_states => block_states, :link_states => link_states)
   end
   
 end

data/lib/spnet/storage/block_state.rb

@@ -9,10 +9,10 @@ class BlockState
   # Define arg specs to use in processing hashed arguments during #initialize.  
   ARG_SPECS = {
     :class_sym => arg_spec(:reqd => true, :type => Symbol),
-    :port_params => arg_spec_hash(:reqd => false, :type => Object)
+    :params => arg_spec_hash(:reqd => false, :type => Object)
   }
   
-  attr_reader :class_sym, :hashed_args, :port_params
+  attr_reader :class_sym, :hashed_args, :params
   
   # A new instance of NetworkState. 
   # @param [Hash] args Hashed arguments for initialization. See Network::ARG_SPECS
@@ -28,7 +28,7 @@ class BlockState
     klass = Kernel.const_get(@class_sym)
     block = klass.new :sample_rate => args[:sample_rate]
     
-    @port_params.each do |port_name,value|
+    @params.each do |port_name,value|
       if block.in_ports.has_key?(port_name)
         port = block.in_ports[port_name]
         port.set_value value

data/lib/spnet/storage/network_state.rb

@@ -8,12 +8,11 @@ class NetworkState
 
   # Define arg specs to use in processing hashed arguments during #initialize.  
   ARG_SPECS = {
-    :name => arg_spec(:reqd => false, :type => String, :default => ""),
     :block_states => arg_spec_hash(:reqd => false, :type => BlockState),
     :link_states => arg_spec_array(:reqd => false, :type => LinkState),
   }
   
-  attr_reader :sample_rate, :name, :block_models, :link_models
+  attr_reader :sample_rate, :block_models, :link_models
   
   # A new instance of NetworkState. 
   # @param [Hash] args Hashed arguments for initialization. See Network::ARG_SPECS
@@ -38,7 +37,7 @@ class NetworkState
       links.push link_state.make_link blocks
     end
     
-    Network.new :name => @name, :blocks => blocks, :links => links, :sample_rate => sample_rate
+    Network.new :blocks => blocks, :links => links, :sample_rate => sample_rate
   end
 end
 end

data/lib/spnet/version.rb

@@ -1,5 +1,5 @@
 # Provide infrastructure for forming processing networks.
 module SPNet
   # spnet version
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/core/block_spec.rb

@@ -62,19 +62,31 @@ describe SPNet::Block do
   end
   
   context '#export_state' do
-    before :all do
-      block = TestBlock.new :sample_rate => @sample_rate
-      block.in_ports["VALUE1"].set_value(4.4)
-      block.in_ports["VALUE2"].set_value(5.5)
-      @state = block.export_state
+    it 'should set class_sym to :Block' do
+      TestBlock.new(:sample_rate => @sample_rate).export_state.class_sym.should eq(:TestBlock)
     end
 
-    it 'should set class_sym to :Block' do
-      @state.class_sym.should eq(:TestBlock)
+    it 'should have empty port params since no params were modified' do
+      TestBlock.new(:sample_rate => @sample_rate).export_state.params.should be_empty
     end
 
-    it 'should set port_params according to ParamInPort settings' do
-      @state.port_params.should eq("VALUE1" => 4.4, "VALUE2" => 5.5)
+    context 'one param modified' do
+      it 'should set params according to ParamInPort settings' do
+        block = TestBlock.new :sample_rate => @sample_rate
+        block.in_ports["VALUE1"].set_value(4.4)
+        state = block.export_state
+        state.params.should eq("VALUE1" => 4.4)
+      end
+    end
+    
+    context 'both params modified' do
+      it 'should set params according to ParamInPort settings' do
+        block = TestBlock.new :sample_rate => @sample_rate
+        block.in_ports["VALUE1"].set_value(4.4)
+        block.in_ports["VALUE2"].set_value(5.5)
+        state = block.export_state
+        state.params.should eq("VALUE1" => 4.4, "VALUE2" => 5.5)
+      end
     end
   end
 end

data/spec/core/network_spec.rb

@@ -6,15 +6,11 @@ describe SPNet::Network do
       @sample_rate =  1.0
     end
     
-    context 'no name, blocks, or links given' do
+    context 'no blocks, or links given' do
       before :all do
         @network = Network.new :sample_rate => @sample_rate
       end
       
-      it 'should have empty name' do
-        @network.name.should be_empty
-      end
-      
       it 'should have no blocks' do
         @network.blocks.should be_empty
       end

data/spec/storage/block_state_spec.rb

@@ -12,8 +12,8 @@ describe SPNet::BlockState do
         "VALUE1" => 0.0,
         "VALUE2" => 1.0,
       }
-      block_state = BlockState.new :class_sym => :TestBlock, :port_params => params
-      block_state.port_params.should eq(params)
+      block_state = BlockState.new :class_sym => :TestBlock, :params => params
+      block_state.params.should eq(params)
     end
   end
   
@@ -24,7 +24,7 @@ describe SPNet::BlockState do
         "VALUE2" => 0.9,
       }
       @class_sym = :TestBlock
-      block_state = BlockState.new :class_sym => @class_sym, :port_params => @params
+      block_state = BlockState.new :class_sym => @class_sym, :params => @params
       @block = block_state.make_block :sample_rate => 2
     end
     

data/spec/storage/network_state_spec.rb

@@ -5,8 +5,8 @@ describe SPNet::NetworkState do
     before :all do
       @network_state = NetworkState.new(
         :block_states => {
-          "A" => BlockState.new(:class_sym => :TestBlock, :hashed_args => {}, :port_params => { "VALUE1" => 0.2}),
-          "B" => BlockState.new(:class_sym => :TestBlock, :hashed_args => {}, :port_params => { "VALUE1" => 0.4})
+          "A" => BlockState.new(:class_sym => :TestBlock, :hashed_args => {}, :params => { "VALUE1" => 0.2}),
+          "B" => BlockState.new(:class_sym => :TestBlock, :hashed_args => {}, :params => { "VALUE1" => 0.4})
         },
         :link_states => [
           LinkState.new(
@@ -25,7 +25,7 @@ describe SPNet::NetworkState do
       network.blocks["B"].class.should be(TestBlock)
     end
     
-    it 'should assign values found in :port_params' do
+    it 'should assign values found in :params' do
       network = @network_state.make_network :sample_rate => 4
       network.blocks["A"].value1.should eq(0.2)
       network.blocks["B"].value1.should eq(0.4)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spnet
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -186,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -699340785
+      hash: 654422513
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -699340785
+      hash: 654422513
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23