Tuple Class
===========






AMPL immutable tuple


Namespace
    :dn:ns:`ampl`
Assemblies
    * AMPL

----

.. contents::
   :local:



Inheritance Hierarchy
---------------------


* :dn:cls:`System.Object`
* :dn:cls:`ampl.Tuple`








Syntax
------

.. code-block:: csharp

    public class Tuple








.. dn:class:: ampl.Tuple
    :hidden:

.. dn:class:: ampl.Tuple

Fields
------

.. dn:class:: ampl.Tuple
    :noindex:
    :hidden:

    
    .. dn:field:: ampl.Tuple.inner

        
        :rtype: TupleBase

        
        .. code-block:: csharp

            public TupleBase inner
    

Constructors
------------

.. dn:class:: ampl.Tuple
    :noindex:
    :hidden:

    
    .. dn:constructor:: ampl.Tuple.Tuple()

        

        
        .. code-block:: csharp

            public Tuple()
    
    .. dn:constructor:: ampl.Tuple.Tuple(System.Object)

        

        
        :type o: System.Object

        
        .. code-block:: csharp

            public Tuple(object o)
    
    .. dn:constructor:: ampl.Tuple.Tuple(System.Object[])

        

        
        :type objects: System.Object<System.Object>[]

        
        .. code-block:: csharp

            public Tuple(params object[] objects)
    

Methods
-------

.. dn:class:: ampl.Tuple
    :noindex:
    :hidden:

    
    .. dn:method:: ampl.Tuple.Equals(System.Object)

        

        
        Determines whether the specified <xref href="System.Object" data-throw-if-not-resolved="false"></xref>, is equal to this instance,
        implements deep comparison


        

        
        :type obj: System.Object
        :rtype: System.Boolean

        
        .. code-block:: csharp

            public override bool Equals(object obj)
    
    .. dn:method:: ampl.Tuple.FromArray(System.Object[])

        

        
        Create an array of tuples from an array of objects.
        Each object in the first level array (being it a string, a number or 
        an array) is interpreted as the contents of each returned Tuple.


        

        
        :type objects: System.Object<System.Object>[]
        :rtype: ampl.Tuple<ampl.Tuple>[]

        
        .. code-block:: csharp

            public static Tuple[] FromArray(params object[] objects)
    
    .. dn:method:: ampl.Tuple.GetHashCode()

        

        
        Returns a hash code for this instance.


        
        :rtype: System.Int32

        
        .. code-block:: csharp

            public override int GetHashCode()
    
    .. dn:method:: ampl.Tuple.ToString()

        

        
        Returns a <xref href="System.String" data-throw-if-not-resolved="false"></xref> that represents this instance.


        
        :rtype: System.String

        
        .. code-block:: csharp

            public override string ToString()
    

Properties
----------

.. dn:class:: ampl.Tuple
    :noindex:
    :hidden:

    
    .. dn:property:: ampl.Tuple.Item[System.Int32]

        

        
        Gets the <xref href="ampl.Variant" data-throw-if-not-resolved="false"></xref> at the specified index.


        

        
        :type index: System.Int32
        :rtype: ampl.Variant

        
        .. code-block:: csharp

            public Variant this[int index] { get; }
    
    .. dn:property:: ampl.Tuple.Size

        

        
        Gets the size (number of elements) of this tuple


        
        :rtype: System.Int32

        
        .. code-block:: csharp

            public int Size { get; }