========
型ヒント
========

型ヒントで主に用いる PySIMPLE のクラスです．
使用例については :doc:`../guide/typehint` をご覧ください．

PySIMPLE クラス
---------------

.. class:: pysimple.typing.Set
   :noindex:

   :obj:`pysimple.Set` と同じです．

.. class:: pysimple.typing.Element
   :noindex:

   :obj:`pysimple.Element` と同じです．

.. class:: pysimple.typing.ElementSlice
   :noindex:

   :obj:`~pysimple.element.ElementSlice` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．

.. class:: pysimple.typing.Cond
   :noindex:

   :obj:`~pysimple.condition.Cond` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．

.. class:: pysimple.typing.Parameter
   :noindex:

   :obj:`pysimple.Parameter` と同じです．

.. class:: pysimple.typing.Table
   :noindex:

   :obj:`~pysimple.table.Table` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．

.. class:: pysimple.typing.Variable
   :noindex:

   :obj:`pysimple.Variable` と同じです．:obj:`pysimple.IntegerVariable` と :obj:`pysimple.BinaryVariable`
   インスタンスは Variable 型となることに注意ください．

.. class:: pysimple.typing.Expression
   :noindex:

   :obj:`~pysimple.expression.Expression` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．

.. class:: pysimple.typing.Constraint
   :noindex:

   :obj:`~pysimple.constraint.Constraint` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．

.. class:: pysimple.typing.SelectionConstraint
   :noindex:

   :obj:`~pysimple.constraint.SelectionConstraint` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．
   :obj:`~pysimple.constraint.Constraint` の派生クラスです．

.. class:: pysimple.typing.Index
   :noindex:

   :obj:`~pysimple.index.Index` と同じです．コンストラクタは非公開ですが，型ヒントとして用いることができます．

基底クラス
----------

.. autodata:: pysimple.typing.ELEMENT
.. autodata:: pysimple.typing.PARAMETER

エイリアス
----------

.. data:: Num

    モデルに使用できる数値型です．int | float 型のエイリアスです．

.. data:: DType

    data type の意．キーや値として使用できる型です． `Num` | str 型のエイリアスです．

.. data:: Key

    集合オブジェクトの要素に使用できる型です．tuple[`DType`, ...] 型のエイリアスです．

.. autodata:: pysimple.typing.ObjPrm

    `DType` | :obj:`~pysimple.typing.ELEMENT` | :obj:`~pysimple.typing.PARAMETER` 型のエイリアスです．

.. autodata:: pysimple.typing.ObjExp

    :obj:`~pysimple.typing.ObjPrm` | :obj:`~pysimple.Variable` | `Expression` 型のエイリアスです．

.. pysimple.typing.VarExp
.. pysimple.typing.Indexed
.. pysimple.typing.ObjSimple