Contents

module Picky

  module Query

    # Combinations are a number of Combination-s.
    #
    # They are the core of an allocation.
    # An allocation consists of a number of combinations.
    #
    # Base Combinations contain methods for calculating score and ids.
    #
    class Combinations # :nodoc:all

      attr_reader :combinations

      delegate :empty?, :inject, :to => :@combinations

      def initialize combinations = []
        @combinations = combinations
      end

      def hash
        @combinations.hash
      end

      # Uses user specific weights to calculate a score for the combinations.
      #
      def calculate_score weights
        total_score + weighted_score(weights)
      end
      def total_score
        @combinations.sum &:weight
      end
      def weighted_score weights
        weights.score_for @combinations
      end

      # Filters the tokens and identifiers such that only identifiers
      # that are passed in, remain, including their tokens.
      #
      # Note: This method is not totally independent of the calculate_ids one.
      #       Since identifiers are only nullified, we need to not include the
      #       ids that have an associated identifier that is nil.
      #
      def keep identifiers = []
        @combinations.reject! { |combination| !combination.in?(identifiers) }
      end

      # Filters the tokens and identifiers such that identifiers
      # that are passed in, are removed, including their tokens.
      #
      # Note: This method is not totally independent of the calculate_ids one.
      #       Since identifiers are only nullified, we need to not include the
      #       ids that have an associated identifier that is nil.
      #
      def remove identifiers = []
        @combinations.reject! { |combination| combination.in?(identifiers) }
      end

      #
      #
      def to_result
        @combinations.map &:to_result
      end

    end

  end

end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
picky-3.1.0	lib/picky/query/combinations.rb