UtilityFunction
===============

.. currentmodule:: negmas.preferences

.. autoclass:: UtilityFunction
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~UtilityFunction.base_type
      ~UtilityFunction.id
      ~UtilityFunction.name
      ~UtilityFunction.reserved_distribution
      ~UtilityFunction.short_type_name
      ~UtilityFunction.type
      ~UtilityFunction.type_name
      ~UtilityFunction.uuid

   .. rubric:: Methods Summary

   .. autosummary::

      ~UtilityFunction.__call__
      ~UtilityFunction.argrank
      ~UtilityFunction.argrank_with_weights
      ~UtilityFunction.best
      ~UtilityFunction.changes
      ~UtilityFunction.checkpoint
      ~UtilityFunction.checkpoint_info
      ~UtilityFunction.create
      ~UtilityFunction.difference
      ~UtilityFunction.difference_prob
      ~UtilityFunction.eu
      ~UtilityFunction.eval
      ~UtilityFunction.eval_normalized
      ~UtilityFunction.extreme_outcomes
      ~UtilityFunction.forget_inverter
      ~UtilityFunction.from_checkpoint
      ~UtilityFunction.from_dict
      ~UtilityFunction.from_genius
      ~UtilityFunction.from_geniusweb
      ~UtilityFunction.from_geniusweb_json_str
      ~UtilityFunction.from_xml_str
      ~UtilityFunction.generate_bilateral
      ~UtilityFunction.generate_random
      ~UtilityFunction.generate_random_bilateral
      ~UtilityFunction.invert
      ~UtilityFunction.is_better
      ~UtilityFunction.is_equivalent
      ~UtilityFunction.is_not_better
      ~UtilityFunction.is_not_worse
      ~UtilityFunction.is_session_dependent
      ~UtilityFunction.is_state_dependent
      ~UtilityFunction.is_stationary
      ~UtilityFunction.is_volatile
      ~UtilityFunction.is_worse
      ~UtilityFunction.max
      ~UtilityFunction.min
      ~UtilityFunction.minmax
      ~UtilityFunction.normalize
      ~UtilityFunction.normalize_for
      ~UtilityFunction.rank
      ~UtilityFunction.rank_with_weights
      ~UtilityFunction.reset_changes
      ~UtilityFunction.sample_outcome_with_utility
      ~UtilityFunction.scale_by
      ~UtilityFunction.scale_max
      ~UtilityFunction.scale_max_for
      ~UtilityFunction.scale_min
      ~UtilityFunction.scale_min_for
      ~UtilityFunction.set_id
      ~UtilityFunction.shift_by
      ~UtilityFunction.shift_max_for
      ~UtilityFunction.shift_min_for
      ~UtilityFunction.spawn
      ~UtilityFunction.spawn_object
      ~UtilityFunction.to_crisp
      ~UtilityFunction.to_dict
      ~UtilityFunction.to_genius
      ~UtilityFunction.to_prob
      ~UtilityFunction.to_stationary
      ~UtilityFunction.to_xml_str
      ~UtilityFunction.worst

   .. rubric:: Attributes Documentation

   .. autoattribute:: base_type
   .. autoattribute:: id
   .. autoattribute:: name
   .. autoattribute:: reserved_distribution
   .. autoattribute:: short_type_name
   .. autoattribute:: type
   .. autoattribute:: type_name
   .. autoattribute:: uuid

   .. rubric:: Methods Documentation

   .. automethod:: __call__
   .. automethod:: argrank
   .. automethod:: argrank_with_weights
   .. automethod:: best
   .. automethod:: changes
   .. automethod:: checkpoint
   .. automethod:: checkpoint_info
   .. automethod:: create
   .. automethod:: difference
   .. automethod:: difference_prob
   .. automethod:: eu
   .. automethod:: eval
   .. automethod:: eval_normalized
   .. automethod:: extreme_outcomes
   .. automethod:: forget_inverter
   .. automethod:: from_checkpoint
   .. automethod:: from_dict
   .. automethod:: from_genius
   .. automethod:: from_geniusweb
   .. automethod:: from_geniusweb_json_str
   .. automethod:: from_xml_str
   .. automethod:: generate_bilateral
   .. automethod:: generate_random
   .. automethod:: generate_random_bilateral
   .. automethod:: invert
   .. automethod:: is_better
   .. automethod:: is_equivalent
   .. automethod:: is_not_better
   .. automethod:: is_not_worse
   .. automethod:: is_session_dependent
   .. automethod:: is_state_dependent
   .. automethod:: is_stationary
   .. automethod:: is_volatile
   .. automethod:: is_worse
   .. automethod:: max
   .. automethod:: min
   .. automethod:: minmax
   .. automethod:: normalize
   .. automethod:: normalize_for
   .. automethod:: rank
   .. automethod:: rank_with_weights
   .. automethod:: reset_changes
   .. automethod:: sample_outcome_with_utility
   .. automethod:: scale_by
   .. automethod:: scale_max
   .. automethod:: scale_max_for
   .. automethod:: scale_min
   .. automethod:: scale_min_for
   .. automethod:: set_id
   .. automethod:: shift_by
   .. automethod:: shift_max_for
   .. automethod:: shift_min_for
   .. automethod:: spawn
   .. automethod:: spawn_object
   .. automethod:: to_crisp
   .. automethod:: to_dict
   .. automethod:: to_genius
   .. automethod:: to_prob
   .. automethod:: to_stationary
   .. automethod:: to_xml_str
   .. automethod:: worst