.. -*- coding: utf-8 -*-

======
クラス
======

   コンストラクタが公開されているクラスは，すべての引数をキーワード引数として呼び出さなければなりません．
   複数の引数を持たせる場合，キーワード引数の順序は任意です．

   インスタンス間に定義されている演算については `operation` を参照してください．

集合
----

.. autoclass:: pysimple.Set
   :show-inheritance:
   :special-members: __call__, __getitem__, __contains__, __len__, __iter__
   :exclude-members: clear, add, discard
.. versionadded:: 1.1.0
   :meth:`~pysimple.Set.__getitem__` に *slice* が使用可能になりました．

添字
----

.. autoclass:: pysimple.Element
   :inherited-members:
   :special-members: __call__
   :exclude-members: element, slice

.. autoclass:: pysimple.element.ElementSlice()
   :no-members:

   ElementSlice クラスは :meth:`~pysimple.Element.__call__` がないこと以外は，ほぼ :class:`~pysimple.Element` と同じです．
   ElementSlice クラスのコンストラクタは公開されません．

.. autoclass:: pysimple.condition.Cond()
   :no-members:

   Cond クラスのコンストラクタは公開されません．

定数
----

.. autoclass:: pysimple.Parameter
   :inherited-members:
   :special-members: __getitem__, __setitem__, __bool__, __int__, __float__, __format__, __contains__, __len__, __iter__, __ceil__, __floor__, __abs__, __round__
   :exclude-members: index, indexed, update, setdefault, pop, popitem, clear, copy, fromkeys
.. versionadded:: 1.3.0
   :meth:`~pysimple.Parameter.__round__` が使用可能になりました．
.. versionadded:: 1.5.0
   :meth:`~pysimple.Parameter.get` が添字をサポートするようになりました．

.. autoclass:: pysimple.table.Table()
   :no-members:

   Table クラスは :meth:`~pysimple.Parameter.__getitem__`, :meth:`~pysimple.Parameter.get`, :meth:`~pysimple.Parameter.__setitem__` がないこと以外は，ほぼ :class:`~pysimple.Parameter` と同じです．

   Table クラスのコンストラクタは公開されません．

   :attr:`~pysimple.Variable.init`，:attr:`~pysimple.Variable.val`，:attr:`~pysimple.Variable.lb`，:attr:`~pysimple.Variable.ub`，:attr:`~pysimple.Variable.dual`，
   :attr:`~pysimple.expression.Expression.init`，:attr:`~pysimple.expression.Expression.val`,
   :attr:`~pysimple.constraint.Constraint.dual`，:attr:`~pysimple.constraint.Constraint.violation`
   が Table クラスに該当します．

変数，式
--------

.. autoclass:: pysimple.Variable
   :show-inheritance:
   :special-members: __getitem__, __setitem__, __contains__, __len__, __iter__
   :exclude-members: index, indexed, items, vars, qvars, const, const0, objs, issamevar, linemtx
.. versionadded:: 1.5.0
   :meth:`~pysimple.Variable.fix` , :meth:`~pysimple.Variable.unfix` が追加されました．
.. versionadded:: 1.5.0
   :meth:`~pysimple.Variable.get` が追加されました．

.. autoclass:: pysimple.IntegerVariable
   :show-inheritance:

.. autoclass:: pysimple.BinaryVariable
   :show-inheritance:

.. autoclass:: pysimple.expression.QVariable()
   :show-inheritance:
   :no-members:

.. autoclass:: pysimple.expression.Expression()
   :show-inheritance:
   :special-members: __getitem__, __contains__, __len__, __iter__
   :exclude-members: index, indexed

.. versionadded:: 1.3.1
   :meth:`~pysimple.expression.Expression.__getitem__` に Parameter が使用可能になりました．
.. versionadded:: 1.5.0
   :meth:`~pysimple.expression.Expression.get` が追加されました．

制約式
------

.. autoclass:: pysimple.constraint.Constraint()
   :show-inheritance:
   :special-members: __getitem__, __contains__, __len__, __iter__
   :exclude-members: index, mtx, info, indexed

   Constraint クラスのコンストラクタは公開されません．
.. versionadded:: 1.5.0
   :meth:`~pysimple.constraint.Constraint.get` が追加されました．

.. autoclass:: pysimple.constraint.SelectionConstraint()
   :show-inheritance:
   :exclude-members: weight

.. autoclass:: pysimple.constraint.ConstraintWeight()
   :exclude-members: type, weight, quad, linear

問題，求解オプション，解情報
----------------------------

.. autoclass:: pysimple.Problem
   :special-members: __iadd__, __getitem__, __delitem__
   :exclude-members: origvars, expand

.. versionadded:: 1.1.0
   :meth:`~pysimple.Problem.mpsout` が追加されました．
.. versionadded:: 1.3.0
   :meth:`~pysimple.Problem.variables` が追加されました．
.. versionadded:: 1.3.0
   :meth:`~pysimple.Problem.__getitem__`, :meth:`~pysimple.Problem.__delitem__`
   に番号でアクセスできるようになりました．
.. versionadded:: 1.4.0
   :meth:`~pysimple.Problem.setCallback` が追加されました．

.. autoclass:: pysimple.options.ProblemOptions
   :special-members: __dir__
   :exclude-members: to_dict, set, nuopt_prm

.. autoclass:: pysimple.Options
.. versionadded:: 1.4.0
   求解オプション定数のクラス構造が変更されました．

.. autoclass:: pysimple.NuoptStatus
   :show-inheritance:
   :exclude-members: status, status2

.. autoclass:: pysimple.problem.Result()

.. autoclass:: pysimple.problem.IIS()
   :exclude-members: update, setdefault, pop, popitem, clear, copy, fromkeys

シリアライズ
------------

.. autoclass:: pysimple.serialize.Serialize