Contents

module Index
  # A Bundle is a number of indexes
  # per [index, category] combination.
  #
  # At most, there are three indexes:
  # * *core* index (always used)
  # * *weights* index (always used)
  # * *similarity* index (used with similarity)
  # 
  # In Picky, indexing is separated from the index
  # handling itself through a parallel structure.
  #
  # Both use methods provided by this base class, but
  # have very different goals:
  #
  # * *Indexing*::*Bundle* is just concerned with creating index files
  #   and providing helper functions to e.g. check the indexes.
  #
  # * *Index*::*Bundle* is concerned with loading these index files into
  #   memory and looking up search data as fast as possible.
  #
  class Bundle
    
    attr_reader   :identifier, :files
    attr_accessor :index, :weights, :similarity, :configuration, :similarity_strategy
    
    delegate :clear,    :to => :index
    delegate :[], :[]=, :to => :configuration
    
    def initialize name, configuration, similarity_strategy
      @identifier = "#{configuration.identifier} (#{name})"
      @files      = Files.new name, configuration
      
      @index         = {}
      @weights       = {}
      @similarity    = {}
      @configuration = {} # A hash with config options.
      
      @similarity_strategy = similarity_strategy
    end
    
    # Get a list of similar texts.
    #
    def similar text
      code = similarity_strategy.encoded text
      code && @similarity[code] || []
    end
    
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
picky-0.12.3	lib/picky/index/bundle.rb
picky-0.12.2	lib/picky/index/bundle.rb