dynamical_system 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f928508792386bcef2acfe99cb615e99b06fb97
+  data.tar.gz: 1403ada45408dea284ca54d7c3659a994b081e85
+SHA512:
+  metadata.gz: 2144825c5731d2ab450dbba3aaadf58d3f96d3ed793d52c8c99c62fe4c18a6da3cdfaacce134268be22dcecc7389901f9db3526ff94d216b7bcc74eb8422f951
+  data.tar.gz: a2f77bde9fccb193cc5645753abe326f4c6b8ef12a3b8e220dde5389ddc6c292ef457bea2627e9e3b1de8a7b759b83d71b46a3c7d10444dd55df2a9169cb0afe

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+ruby '2.2.2'
+
+group :development do
+  gem 'minitest'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.2)
+    mini_portile2 (2.0.0)
+    minitest (5.8.3)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rake (10.5.0)
+    rdoc (4.2.1)
+      json (~> 1.4)
+    thread_safe (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  minitest
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Luke Grecki
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,37 @@
+A simple ruby library for discrete dynamical systems.
+-----------------------------------------------------
+
+The essence of each system is a rule (given as a hash) that determines state transitions. You can create, evolve, and toy with these systems in a variety of ways.
+
+    require_relative 'dynamical_system'
+
+### A cyclic system with 3 states
+
+    rule = { :s1 => :s2, :s2 => :s3, :s3 => :s1 }
+    sys = DynamicalSystem.new(rule, :s1)
+
+    sys.states      # => [:s1, :s2, :s3]
+    sys.evolve!(6)  # => :s1
+    sys.history     # => [:s1, :s2, :s3, :s1, :s2, :s3, :s1]
+
+### A system with a cycle and a fixed point
+
+    rule = { :s1 => :s2, :s2 => :s1, :s3 => :s3 }
+    sys = DynamicalSystem.new(rule, :s1)
+
+    sys.fixed_points                  # => [:s3]
+    sys.is_invariant_set?([:s1, :s2]) # => true
+    
+### A system with a single attractor
+
+    rule = { :s1 => :s3, :s2 => :s3, :s3 => :s3 }
+    sys = DynamicalSystem.new(rule, :s1)
+
+    sys.path!(3)            # => [:s1, :s3, :s3, :s3]
+    sys.is_fixed_point?(:s3) # => true
+    sys.is_bijective?        # => false
+
+### A random system with 5 states
+
+    sys = DynamicalSystem.random(5)
+    sys.states.size # => 5

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "dynamical_system"
+  gem.homepage = "http://github.com/lukegrecki/dynamical_system"
+  gem.license = "MIT"
+  gem.summary = "A simple ruby library for discrete dynamical systems"
+  gem.description = "Define simple dynamical systems, evolve them, and calculate properties."
+  gem.email = "lukegrecki@gmail.com"
+  gem.authors = ["Luke Grecki"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/dynamical_system.rb

@@ -0,0 +1,136 @@
+require 'set'
+
+class DynamicalSystem
+  attr_reader :state, :states, :history
+
+  def self.is_valid_rule?(rule)
+    return (rule.is_a?(Hash) &&
+            rule.values.to_set.subset?(rule.keys.to_set)) ? true : false
+  end
+
+  def self.random(number_of_states)
+    rule = {}
+    (1..number_of_states).each do |s|
+      r = rand(number_of_states) + 1
+      rule.merge!({ "s#{s}".to_sym => "s#{r}".to_sym })
+    end
+    return self.new(rule, :s1)
+  end
+
+  def inspect
+    puts "state : #{@state}\n" + "history : #{history}\n" +
+         "rule : #{@rule}\n" + "states : #{@states}"
+  end
+
+  def initialize(rule, initial_state)
+    if DynamicalSystem.is_valid_rule?(rule)
+      @rule = rule
+      @states = rule.keys
+      @state = initial_state
+      @history = [initial_state]
+    else
+      raise RuleError
+    end
+  end
+
+  def state=(new_state)
+    @state = new_state
+    @history = [@state] #resets history
+  end
+
+  def evolve!(steps = 1, state = @state)
+    set_state(state) if state != @state
+    steps.times { @state = @rule[@state]; @history << @state }
+    return @state
+  end
+
+  def evolve(steps = 1, state = @state)
+    steps.times { state = @rule[state] }
+    return state
+  end
+
+  def path!(steps = 1, state = @state)
+    set_state(state) if state != @state
+    path = [@state]
+    steps.times { @state = @rule[@state]; @history << @state; path << @state }
+    return path
+  end
+
+  def path(steps = 1, state = @state)
+    path = [state]
+    steps.times { state = @rule[state]; path << state }
+    return path
+  end
+
+  def forward_orbit(state = @state)
+    forward_orbit = [state]
+    new_state = @rule[state]
+    until forward_orbit.include?(new_state) do
+      forward_orbit << new_state
+      new_state = @rule[new_state]
+    end
+    forward_orbit << new_state #needed to see the cycle
+    return forward_orbit
+  end
+
+  def backward_orbit(state = @state)
+    raise RuleError, "Is not bijective" unless is_bijective?
+    backward_orbit = [state]
+    old_state = @rule.key(state)
+    until backward_orbit.include?(old_state) do
+      backward_orbit << old_state
+      old_state = @rule.key(old_state)
+    end
+    backward_orbit << old_state #needed to see the cycle
+    return backward_orbit
+  end
+
+  def orbit(state = @state)
+    raise RuleError, "Is not bijective" unless is_bijective?
+    return backward_orbit(state)[0...-1] += (forward_orbit(state))
+  end
+
+  def cycle_from_forward_orbit(forward_orbit)
+    return forward_orbit[forward_orbit.index(forward_orbit.last)...-1]
+  end
+
+  def cycles
+    return @cycles if @cycles
+    @cycles = []
+    visited_states = []
+    states_array = Array(@states)
+    until visited_states.size == @states.size do
+      start_state = (states_array - visited_states).sample
+      forward_orbit = forward_orbit(start_state)
+      cycle = cycle_from_forward_orbit(forward_orbit)
+      cycle_set = cycle.to_set
+      cycle_sets = @cycles.map { |c| c.to_set }
+      @cycles << cycle unless cycle_sets.include?(cycle_set)
+      visited_states |= forward_orbit
+    end
+    return @cycles
+  end
+
+  def is_fixed_point?(state = @state)
+    return state == evolve(1, state) ? true : false
+  end
+
+  def fixed_points
+    @fixed_points ||= @states.select { |s| is_fixed_point?(s) }
+  end
+
+  def is_invariant_set?(state_array)
+    new_state_array = state_array.map { |s| evolve(1, s) }
+    return new_state_array.to_set == state_array.to_set ? true : false
+  end
+
+  def is_bijective?
+    return @states.size == @rule.values.uniq.size
+  end
+
+  alias :set_state :state=
+end
+
+class StateError < StandardError; end
+class RuleError < StandardError; end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dynamical_system'

data/test/test_dynamical_system.rb

@@ -0,0 +1,104 @@
+require 'helper'
+
+class TestDynamicalSystem < Minitest::Test
+
+  def setup
+    @rule = { :s1 => :s2, :s2 => :s1, :s3 => :s3 }
+    @sys = DynamicalSystem.new(@rule, :s1)
+  end
+
+  def test_initialization
+    assert_instance_of(DynamicalSystem, DynamicalSystem.new(@rule, :s1))
+  end
+
+  def test_is_valid_rule?
+    @rule = 0 #not a Hash
+    assert_equal(DynamicalSystem.is_valid_rule?(@rule), false)
+
+    @rule = { :s1 => :s2, :s3 => :s3 } #undefined on :s2
+    assert_equal(DynamicalSystem.is_valid_rule?(@rule), false)
+  end
+
+  def test_random
+    random_sys = DynamicalSystem.random(5)
+    assert_instance_of(DynamicalSystem, random_sys)
+    assert_equal(5, random_sys.states.size)
+  end
+
+  def test_evolve!
+    assert_equal(@sys.evolve!(2, :s2), :s2)
+    assert_equal(@sys.state, :s2)
+    assert_equal(@sys.history, [:s2, :s1, :s2])
+  end
+
+  def test_evolve
+    assert_equal(@sys.evolve(2, :s2), :s2)
+    assert_equal(@sys.state, :s1)
+  end
+
+  def test_path!
+    assert_equal(@sys.path!(2, :s2), [:s2, :s1, :s2])
+    assert_equal(@sys.state, :s2)
+    assert_equal(@sys.history, [:s2, :s1, :s2])
+  end
+
+  def test_path
+    assert_equal(@sys.path(2, :s2), [:s2, :s1, :s2])
+    assert_equal(@sys.state, :s1)
+  end
+
+  def test_forward_orbit
+    @rule.merge!({ :s2 => :s4, :s4 => :s2 })
+    @sys = DynamicalSystem.new(@rule, :s1)
+    assert_equal(@sys.forward_orbit(:s1), [:s1, :s2, :s4, :s2])
+  end
+
+  def test_backward_orbit
+    assert_equal(@sys.backward_orbit, [:s1, :s2, :s1])
+    assert_equal(@sys.backward_orbit(:s3), [:s3, :s3])
+  end
+
+  def test_orbit
+    assert_equal(@sys.orbit, [:s1, :s2, :s1, :s2, :s1])
+    assert_equal(@sys.orbit(:s3), [:s3, :s3, :s3])
+  end
+
+  def test_cycle_from_forward_orbit
+    @rule.merge!({ :s2 => :s4, :s4 => :s2 })
+    @sys = DynamicalSystem.new(@rule, :s1)
+    forward_orbit = @sys.forward_orbit(:s1)
+    assert_equal([:s2, :s4], @sys.cycle_from_forward_orbit(forward_orbit))
+  end
+
+  def test_cycles
+    @rule.merge!({ :s2 => :s4, :s4 => :s2 })
+    @sys = DynamicalSystem.new(@rule, :s1)
+    assert_equal(true, [[:s2, :s4], [:s3]].to_set == @sys.cycles.to_set || \
+                       [[:s4, :s2], [:s3]].to_set == @sys.cycles.to_set)
+  end
+
+  def test_is_fixed_point?
+    assert_equal(@sys.is_fixed_point?(:s1), false)
+    assert_equal(@sys.is_fixed_point?(:s3), true)
+  end
+
+  def test_fixed_points
+    @rule = { :s1 => :s2, :s2 => :s1, :s3 => :s3, :s4 => :s4 }
+    @sys = DynamicalSystem.new(@rule, :s1)
+    assert_equal(@sys.fixed_points.to_set, Set.new([:s3, :s4]))
+  end
+
+  def test_is_invariant_set?
+    assert_equal(@sys.is_invariant_set?([:s1, :s2]), true)
+    assert_equal(@sys.is_invariant_set?([:s1, :s3]), false)
+  end
+
+  def test_is_bijective?
+    assert_equal(@sys.is_bijective?, true)
+
+    @rule_2 = { :s1 => :s1, :s2 => :s1 }
+    @sys_2 = DynamicalSystem.new(@rule_2, :s1)
+    assert_equal(@sys_2.is_bijective?, false)
+  end
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: dynamical_system
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Grecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Define simple dynamical systems, evolve them, and calculate properties.
+email: lukegrecki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/dynamical_system.rb
+- test/helper.rb
+- test/test_dynamical_system.rb
+homepage: http://github.com/lukegrecki/dynamical_system
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A simple ruby library for discrete dynamical systems
+test_files: []