BaseUtilityFunction
===================

.. currentmodule:: negmas.preferences

.. autoclass:: BaseUtilityFunction
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

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

   .. rubric:: Methods Summary

   .. autosummary::

      ~BaseUtilityFunction.__call__
      ~BaseUtilityFunction.argrank
      ~BaseUtilityFunction.argrank_with_weights
      ~BaseUtilityFunction.best
      ~BaseUtilityFunction.changes
      ~BaseUtilityFunction.checkpoint
      ~BaseUtilityFunction.checkpoint_info
      ~BaseUtilityFunction.create
      ~BaseUtilityFunction.difference
      ~BaseUtilityFunction.difference_prob
      ~BaseUtilityFunction.eu
      ~BaseUtilityFunction.eval
      ~BaseUtilityFunction.eval_normalized
      ~BaseUtilityFunction.extreme_outcomes
      ~BaseUtilityFunction.forget_inverter
      ~BaseUtilityFunction.from_checkpoint
      ~BaseUtilityFunction.from_dict
      ~BaseUtilityFunction.from_genius
      ~BaseUtilityFunction.from_geniusweb
      ~BaseUtilityFunction.from_geniusweb_json_str
      ~BaseUtilityFunction.from_xml_str
      ~BaseUtilityFunction.invert
      ~BaseUtilityFunction.is_better
      ~BaseUtilityFunction.is_equivalent
      ~BaseUtilityFunction.is_not_better
      ~BaseUtilityFunction.is_not_worse
      ~BaseUtilityFunction.is_session_dependent
      ~BaseUtilityFunction.is_state_dependent
      ~BaseUtilityFunction.is_stationary
      ~BaseUtilityFunction.is_volatile
      ~BaseUtilityFunction.is_worse
      ~BaseUtilityFunction.max
      ~BaseUtilityFunction.min
      ~BaseUtilityFunction.minmax
      ~BaseUtilityFunction.normalize
      ~BaseUtilityFunction.normalize_for
      ~BaseUtilityFunction.rank
      ~BaseUtilityFunction.rank_with_weights
      ~BaseUtilityFunction.reset_changes
      ~BaseUtilityFunction.sample_outcome_with_utility
      ~BaseUtilityFunction.scale_by
      ~BaseUtilityFunction.scale_max
      ~BaseUtilityFunction.scale_max_for
      ~BaseUtilityFunction.scale_min
      ~BaseUtilityFunction.scale_min_for
      ~BaseUtilityFunction.set_id
      ~BaseUtilityFunction.shift_by
      ~BaseUtilityFunction.shift_max_for
      ~BaseUtilityFunction.shift_min_for
      ~BaseUtilityFunction.spawn
      ~BaseUtilityFunction.spawn_object
      ~BaseUtilityFunction.to_crisp
      ~BaseUtilityFunction.to_dict
      ~BaseUtilityFunction.to_genius
      ~BaseUtilityFunction.to_prob
      ~BaseUtilityFunction.to_stationary
      ~BaseUtilityFunction.to_xml_str
      ~BaseUtilityFunction.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:: 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