UFunModel
=========

.. currentmodule:: negmas.sao

.. autoclass:: UFunModel
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~UFunModel.base_type
      ~UFunModel.id
      ~UFunModel.name
      ~UFunModel.negotiator
      ~UFunModel.reserved_distribution
      ~UFunModel.short_type_name
      ~UFunModel.type
      ~UFunModel.type_name
      ~UFunModel.uuid

   .. rubric:: Methods Summary

   .. autosummary::

      ~UFunModel.__call__
      ~UFunModel.after_join
      ~UFunModel.after_proposing
      ~UFunModel.after_responding
      ~UFunModel.argrank
      ~UFunModel.argrank_with_weights
      ~UFunModel.before_proposing
      ~UFunModel.before_responding
      ~UFunModel.best
      ~UFunModel.can_join
      ~UFunModel.changes
      ~UFunModel.checkpoint
      ~UFunModel.checkpoint_info
      ~UFunModel.create
      ~UFunModel.difference
      ~UFunModel.difference_prob
      ~UFunModel.eu
      ~UFunModel.eval
      ~UFunModel.eval_normalized
      ~UFunModel.extreme_outcomes
      ~UFunModel.forget_inverter
      ~UFunModel.from_checkpoint
      ~UFunModel.from_dict
      ~UFunModel.from_genius
      ~UFunModel.from_geniusweb
      ~UFunModel.from_geniusweb_json_str
      ~UFunModel.from_xml_str
      ~UFunModel.invert
      ~UFunModel.is_better
      ~UFunModel.is_equivalent
      ~UFunModel.is_not_better
      ~UFunModel.is_not_worse
      ~UFunModel.is_session_dependent
      ~UFunModel.is_state_dependent
      ~UFunModel.is_stationary
      ~UFunModel.is_volatile
      ~UFunModel.is_worse
      ~UFunModel.max
      ~UFunModel.min
      ~UFunModel.minmax
      ~UFunModel.normalize
      ~UFunModel.normalize_for
      ~UFunModel.on_leave
      ~UFunModel.on_mechanism_error
      ~UFunModel.on_negotiation_end
      ~UFunModel.on_negotiation_start
      ~UFunModel.on_partner_ended
      ~UFunModel.on_partner_joined
      ~UFunModel.on_partner_left
      ~UFunModel.on_partner_proposal
      ~UFunModel.on_partner_refused_to_propose
      ~UFunModel.on_partner_response
      ~UFunModel.on_preferences_changed
      ~UFunModel.on_round_end
      ~UFunModel.on_round_start
      ~UFunModel.rank
      ~UFunModel.rank_with_weights
      ~UFunModel.reset_changes
      ~UFunModel.sample_outcome_with_utility
      ~UFunModel.scale_by
      ~UFunModel.scale_max
      ~UFunModel.scale_max_for
      ~UFunModel.scale_min
      ~UFunModel.scale_min_for
      ~UFunModel.set_id
      ~UFunModel.set_negotiator
      ~UFunModel.shift_by
      ~UFunModel.shift_max_for
      ~UFunModel.shift_min_for
      ~UFunModel.spawn
      ~UFunModel.spawn_object
      ~UFunModel.to_crisp
      ~UFunModel.to_dict
      ~UFunModel.to_genius
      ~UFunModel.to_prob
      ~UFunModel.to_stationary
      ~UFunModel.to_xml_str
      ~UFunModel.worst

   .. rubric:: Attributes Documentation

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

   .. rubric:: Methods Documentation

   .. automethod:: __call__
   .. automethod:: after_join
   .. automethod:: after_proposing
   .. automethod:: after_responding
   .. automethod:: argrank
   .. automethod:: argrank_with_weights
   .. automethod:: before_proposing
   .. automethod:: before_responding
   .. automethod:: best
   .. automethod:: can_join
   .. 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:: on_leave
   .. automethod:: on_mechanism_error
   .. automethod:: on_negotiation_end
   .. automethod:: on_negotiation_start
   .. automethod:: on_partner_ended
   .. automethod:: on_partner_joined
   .. automethod:: on_partner_left
   .. automethod:: on_partner_proposal
   .. automethod:: on_partner_refused_to_propose
   .. automethod:: on_partner_response
   .. automethod:: on_preferences_changed
   .. automethod:: on_round_end
   .. automethod:: on_round_start
   .. 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:: set_negotiator
   .. 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