cathy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9425cecd1a8abc352a76ef5b5ec49d3b65ac6c76f9b8dea21b951e4878bf21b6
+  data.tar.gz: 64f5cc0e99a06355c793e965feac34f8bdfc3acdb6bcdd9160f8810815533bd5
+SHA512:
+  metadata.gz: 7a030833f9b6002e6e08535906cd70bb38e6e829fb746b90ebd9935a948063a8b4f7ae579ea321fcb81ace712ace13a1090f62746666c7f8cbcb4292442dc47e
+  data.tar.gz: 7fce4ce32cee23ecf651a66fe17d27c69e1390f9898fcba40fa5383437d190cff1ef68554b6228f71be10703df097128ada237b836f7ffe0ad80eefc9c2e8eeb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-01
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dfhougthon@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cathy.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 dfhoughton
+
+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.md

@@ -0,0 +1,97 @@
+# Cathy
+
+`Cathy` facilitates modeling a weighted probability distribution from which one can draw a sample. Say you
+want to pick a realistic weather forecast and you know there's one sunny day for every two cloudy days and one
+rainy day for every two sunny days. `Cathy` will let you model this. But more importantly, `Cathy` will let you
+modify the probabilities on the fly (if you don't need an updatable distribution, I suggest you try
+[`pick_me_too`](https://github.com/dfhoughton/pick_me_too), which is more efficient in this case).
+
+## Synopsis
+
+```ruby
+require 'cathy'
+
+# make a new distribution
+cathy = Cathy.new
+
+# teach cathy some things
+10.times { cathy.add :foo }
+5.times { cathy.add :bar }
+2.times { cathy.add :plugh }
+
+# ask cathy for a sample
+10.times.map { cathy.pick } # => [:foo, :foo, :bar, :foo, :foo, :foo, :foo, :foo, :plugh, :foo]
+
+# teach cathy more things!
+20.times { cathy.add :plugh }
+
+# another sample
+10.times.map { cathy.pick } # => [:plugh, :plugh, :foo, :bar, :foo, :bar, :plugh, :plugh, :foo, :plugh]
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cathy
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cathy
+
+## Usage
+
+See [here](https://github.com/dfhoughton/cathy/blob/main/examples/chatty_cathy.rb) for an example.
+
+### `Cathy#new`
+
+Make an updatable probability distribution. In this state if you ask for a sample it will only give you `nil`.
+
+### `Cathy#add(thing)`
+
+Increase the frequency of `thing` by one.
+
+### `Cathy#pick`
+
+Draw a sample from the distribution given the frequencies seen so far.
+
+### `Cathy#counts`
+
+Returns a map from things to their frequencies.
+
+This is basically a serialization method.
+
+### `Cathy.from_counts`
+
+Build a distribution from a map from things to their frequencies.
+
+This is basically a deserialization method.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cathy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cathy/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cathy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cathy/blob/main/CODE_OF_CONDUCT.md).
+
+## Efficiency
+
+My aim in writing this has been to be lean on memory usage and to use as few mathematical operations and fetches from memory as possible
+when picking things. The underlying data structure is a [heap](https://en.wikipedia.org/wiki/Heap_(data_structure)), which allows drawing
+a sample in sub-logarithmic time in the typical case using only integer subtraction, and comparison. Updating is similarly efficient.
+
+## Name
+
+Cathy is named after [Chatty Cathy](https://en.wikipedia.org/wiki/Chatty_Cathy). Why? Because the only time I wanted to have
+this was when I made a chat bot for my kids to play with.
+
+Also, naming is hard.
+
+## Acknowledgements
+
+My wife Paula and son Jude have been exceedingly tolerant of my messing about with this silliness. Also, my co-workers at [Green River](https://www.greenriver.com/) have humored me.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/cathy.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/cathy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cathy"
+  spec.version = Cathy::VERSION
+  spec.authors = ["David F. Houghton"]
+  spec.email = ["dfhougthon@gmail.com"]
+
+  spec.summary = "an updatable weighted probability distribution model"
+  spec.description = <<~DESCRIPTION.strip.gsub(/\s+/, " ")
+    Cathy lets you model an updatable weighted probability distribution which you can draw from.
+    For example, suppose you want to randomly pull cards from a deck which consists only of
+    aces, jacks, queens, and kings, with twice as many jacks as aces, twice as many queens as jacks,
+    and twice as many kings as queens. Cathy will model this for you. And you can change the frequency
+    of each card on the fly.
+  DESCRIPTION
+  spec.homepage = "https://github.com/dfhoughton/cathy"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dfhoughton/cathy"
+  spec.metadata["changelog_uri"] = "https://github.com/dfhoughton/cathy/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/examples/chatty_cathy.rb

@@ -0,0 +1,83 @@
+require "cathy"
+
+# a chat bot that takes a long, long time to warm up
+# all Cathy learns is the probability a given word begins a sentences
+# and the probability that a given word follows the two preceding words
+# a "word" to Cathy is whatever is between two spaces
+class ChattyCathy
+  # the easy way to begin a conversation
+  def self.chat!
+    new.chat
+  end
+
+  private
+
+  def initialize
+    @starters = Cathy.new
+    @bigrams = {}
+  end
+
+  def chat
+    greet
+
+    loop do
+      text = listen
+
+      if ["", "bye", "goodbye", "quit"].include?(text.downcase.gsub(/\W+/, ""))
+        farewell
+        break
+      end
+
+      ponder(text)
+
+      respond
+    end
+  end
+
+  def greet
+    puts <<~GREETING
+      Hi, I'm Chatty Cathy! Let's have a chat!
+
+      You tell me something. Press enter when you're done. Then I'll
+      respond. If you want to quit, respond with "bye", "goodbye",
+      or "quit", or just press enter without saying anything at all.
+
+      I will learn to chat from what you tell me. At first I will only know
+      how to repeat what you say. The more you repeat yourself the less I
+      will repeat myself. But it will take me a l-o-o-o-n-g time to start being original.
+    GREETING
+  end
+
+  def listen
+    puts
+    print "You: "
+    $stdin.readline
+  end
+
+  def ponder(text)
+    words = [:start] + text.strip.split(/\s+/) + [:end]
+    @starters.add(words[1])
+    (0...words.length - 2).each do |i|
+      *bigram, word = words[i...i + 3]
+      (@bigrams[bigram] ||= Cathy.new).add word
+    end
+  end
+
+  def respond
+    words = [w1 = @starters.pick]
+    w2 = @bigrams[[:start, w1]].pick
+    while w2 != :end
+      words << w2
+      w3 = @bigrams[[w1, w2]].pick
+      w1 = w2
+      w2 = w3
+    end
+    puts
+    puts "Cathy: #{words.join " "}"
+  end
+
+  def farewell
+    puts
+    puts "Cathy: It's been good chatting with you!"
+  end
+end

data/lib/cathy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Cathy
+  VERSION = "0.1.0"
+end

data/lib/cathy.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative "cathy/version"
+
+##
+# Cathy models an updatable weighted probability distribution. It keeps track of the frequency of things
+# added to it. Then you can pick one of the things added to it with a probability proportional to the number
+# of times it has been added.
+class Cathy
+
+  ##
+  # Create a new distribution. In its initial state, it will always pick nil.
+  def initialize
+    @heap = []
+    @total = 0
+  end
+
+  ##
+  # pick an item according to the frequency with which items were added
+  def pick
+    return if @heap.empty?
+
+    amount = rand 0...@total
+    @heap[0].find(amount)
+  end
+
+  ##
+  # Increment the frequency of this item by one
+  def add(item)
+    @total += 1
+    if (i = index(item))
+      child = @heap[i]
+      child.increment!
+      loop do
+        return if child.index.zero?
+
+        # rebalance the heap if necessary
+        parent = child.parent
+        if parent.count < child.count
+          i = child.index
+          child.move!(parent.index)
+          parent.move!(i)
+        else
+          parent.clear_parents!
+          break
+        end
+      end
+    else
+      # new items require minimal work
+      i = @heap.length
+      child = Item.new(item, @heap, i)
+      @heap << child
+      child.clear_parents!
+    end
+  end
+
+  ##
+  # Returns a map from the items added to their frequencies.
+  def counts
+    @heap.to_h { |i| [i.item, i.count] }
+  end
+
+  ##
+  # Generates a distribution from a map from items to frequencies.
+  def self.from_counts(counts)
+    heap = []
+    counts.each_with_index do |(item, count), i|
+      c = Item.new(item, heap, i, count)
+      heap << c
+      loop do
+        break if c.index.zero?
+
+        p = c.parent
+        if c.count > p.count
+          idx = c.index
+          c.move!(p.index)
+          p.move!(idx)
+        else
+          break
+        end
+      end
+    end
+    total = counts.values.sum
+    new.tap do |obj|
+      obj.instance_variable_set :@heap, heap
+      obj.instance_variable_set :@total, total
+    end
+  end
+
+  private
+
+  # because the heap tends to be sorted from most common to least, a linear
+  # search is reasonably efficient
+  #
+  # this returns the index of an item in the heap
+  def index(item)
+    @heap.index { |c| c.item == item }
+  end
+
+  # a container for things added
+  #
+  # items memoize useful counts
+  class Item
+    def initialize(item, heap, index, count = 1)
+      @heap = heap
+      @index = index
+      @count = count
+      @item = item
+    end
+
+    # find an item in this subtree given an "amount"
+    def find(amount)
+      if amount < left_count
+        left.find(amount)
+      elsif amount < non_right
+        item
+      else
+        right&.find(amount - non_right) || item
+      end
+    end
+
+    attr_reader :item, :count, :heap, :index
+
+    def parent
+      heap[(index - 1) / 2] if index.positive?
+    end
+
+    def left
+      (@left ||= [heap[index * 2 + 1]])[0]
+    end
+
+    def right
+      (@right ||= [heap[index * 2 + 2]])[0]
+    end
+
+    def sum
+      @sum ||= non_right + right_count
+    end
+
+    def left_count
+      @left_count ||= left&.sum.to_i
+    end
+
+    def right_count
+      @right_count ||= right&.sum.to_i
+    end
+
+    def non_right
+      @non_right ||= left_count + count
+    end
+
+    # move in the heap
+    def move!(new_index)
+      @index = new_index
+      heap[new_index] = self
+      clear!
+    end
+
+    # increment the frequency count
+    def increment!
+      @count += 1
+      clear!
+    end
+
+    # clear memoized information
+    def clear!
+      @left_count = @right_count = @non_right = @sum = @left = @right = nil
+    end
+
+    # clear memoization up the ancestor path
+    def clear_parents!
+      if (p = parent)
+        p.clear!
+        p.clear_parents!
+      end
+    end
+  end
+end

data/sig/cathy.rbs

@@ -0,0 +1,4 @@
+module Cathy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: cathy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David F. Houghton
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-01 00:00:00.000000000 Z
+dependencies: []
+description: Cathy lets you model an updatable weighted probability distribution which
+  you can draw from. For example, suppose you want to randomly pull cards from a deck
+  which consists only of aces, jacks, queens, and kings, with twice as many jacks
+  as aces, twice as many queens as jacks, and twice as many kings as queens. Cathy
+  will model this for you. And you can change the frequency of each card on the fly.
+email:
+- dfhougthon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cathy.gemspec
+- examples/chatty_cathy.rb
+- lib/cathy.rb
+- lib/cathy/version.rb
+- sig/cathy.rbs
+homepage: https://github.com/dfhoughton/cathy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dfhoughton/cathy
+  source_code_uri: https://github.com/dfhoughton/cathy
+  changelog_uri: https://github.com/dfhoughton/cathy/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: an updatable weighted probability distribution model
+test_files: []