lernen 0.1.0

data/lib/lernen/sul.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Lernen
+  # SUL is a System Under Learning.
+  #
+  # It is an abtraction of a system under learning (SUL) which accepts an operation
+  # called "membership query"; it takes an input string (word) and returns a sequence
+  # of outputs corresponding to the input string.
+  #
+  # This SUL assumes the system is much like Mealy machine; that is, a transition puts
+  # an output, and query does not accept the empty string due to no outputs.
+  #
+  # Note that this class is *abstract*. You should implement the following method:
+  #
+  # - `#step(input)`
+  class SUL
+    # Creates a SUL from the given block as an implementation of a membership query.
+    def self.from_block(cache: true, &) = BlockSUL.new(cache:, &)
+
+    def initialize(cache: true)
+      @cache = cache ? {} : nil
+      @num_cached_queries = 0
+      @num_queries = 0
+      @num_steps = 0
+    end
+
+    # Returns statistics information as a `Hash` object.
+    def stats
+      {
+        num_cache: @cache&.size || 0,
+        num_cached_queries: @num_cached_queries,
+        num_queries: @num_queries,
+        num_steps: @num_steps
+      }
+    end
+
+    # Runs a membership query with the given inputs.
+    #
+    # Note that this method does not accept the empty string due to no outpus.
+    # If you need to call `query` with the empty string, you should use `MooreSUL#query_empty` instead.
+    def query(inputs)
+      cached = @cache && @cache[inputs]
+      if cached
+        @num_cached_queries += 1
+        return cached
+      end
+
+      if inputs.empty?
+        raise ArgumentError, "`query` does not accept the empty string. Please use `query_empty` instead."
+      end
+
+      setup
+
+      outputs = inputs.map { |input| step(input) }
+
+      shutdown
+
+      @num_queries += 1
+      @num_steps += inputs.size
+
+      @cache[inputs] = outputs
+
+      outputs
+    end
+
+    # It is a setup procedure of this SUL.
+    #
+    # Note that it does nothing by default.
+    def setup
+    end
+
+    # It is a shutdown procedure of this SUL.
+    #
+    # Note that it does nothing by default.
+    def shutdown
+    end
+
+    # Consumes the given `input` and returns the correspoding output.
+    #
+    # This is *abstract*.
+    def step(_input)
+      raise TypeError, "abstract method: `step`"
+    end
+  end
+
+  # MooreSUL is a System Under Learning (SUL) for a system much like Moore machine.
+  #
+  # By contrast to `SUL`, this accepts a query with the empty string additionally.
+  #
+  # Note that this class is *abstract*. You should implement the following method:
+  #
+  # - `#step(input)`
+  # - `#query_empty`
+  class MooreSUL < SUL
+    def initialize(cache: true)
+      super
+    end
+
+    # Runs a membership query with the given inputs.
+    #
+    # This is *abstract*.
+    def query_empty
+      raise TypeError, "abstract method: `query_empty`"
+    end
+  end
+
+  # BlockSUL is a System Under Learning (SUL) constructed from a block.
+  #
+  # A block is expected to behave like a membership query.
+  class BlockSUL < MooreSUL
+    def initialize(cache: true, &block)
+      super(cache:)
+
+      @block = block
+      @inputs = []
+    end
+
+    # It is a setup procedure of this SUL.
+    def setup
+      @inputs = []
+    end
+
+    # Runs a membership query with the given inputs.
+    def step(input)
+      @inputs << input
+      @block.call(@inputs)
+    end
+
+    # Runs a membership query with the given inputs.
+    def query_empty
+      @block.call([])
+    end
+  end
+end

data/lib/lernen/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Lernen
+  # The version string.
+  VERSION = "0.1.0"
+end

data/lib/lernen.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "set"
+
+# Lernen is a simple automata learning library.
+module Lernen
+  # Error is an error class for this library.
+  class Error < StandardError
+  end
+end
+
+require_relative "lernen/automaton"
+require_relative "lernen/cex_processor"
+require_relative "lernen/oracle"
+require_relative "lernen/sul"
+require_relative "lernen/version"
+
+require_relative "lernen/lstar"
+require_relative "lernen/kearns_vazirani"
+require_relative "lernen/lsharp"

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: lernen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TSUYUSATO Kitsune
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: ''
+email:
+- make.just.on@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lernen.rb
+- lib/lernen/automaton.rb
+- lib/lernen/cex_processor.rb
+- lib/lernen/kearns_vazirani.rb
+- lib/lernen/lsharp.rb
+- lib/lernen/lstar.rb
+- lib/lernen/oracle.rb
+- lib/lernen/sul.rb
+- lib/lernen/version.rb
+homepage: https://github.com/makenowjust/lernen
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/makenowjust/lernen
+  source_code_uri: https://github.com/makenowjust/lernen
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+signing_key:
+specification_version: 4
+summary: a simple automata leraning library
+test_files: []