Skip to main content
`Ctrl`+`K`

# pandas.Index.equals

Index.equals(other)

  Determine if two Index object are equal.

  The things that are being compared are:

  - The elements inside the Index object.

  - The order of the elements inside the Index object.

  Parameters:
    other Any

      The other object to compare against.

  Returns:
    bool

      True if “other” is an Index and it has the same elements and order as the calling index; False otherwise.

  See also

  `Index.identical`

    Checks that object attributes and types are also equal.

  `Index.has_duplicates`

    Check if the Index has duplicate values.

  `Index.is_unique`

    Return if the index has unique values.

  Examples

      >>> idx1 = pd.Index([1, 2, 3])
      >>> idx1
      Index([1, 2, 3], dtype='int64')
      >>> idx1.equals(pd.Index([1, 2, 3]))
      True

  The elements inside are compared

      >>> idx2 = pd.Index(["1", "2", "3"])
      >>> idx2
      Index(['1', '2', '3'], dtype='str')

      >>> idx1.equals(idx2)
      False

  The order is compared

      >>> ascending_idx = pd.Index([1, 2, 3])
      >>> ascending_idx
      Index([1, 2, 3], dtype='int64')
      >>> descending_idx = pd.Index([3, 2, 1])
      >>> descending_idx
      Index([3, 2, 1], dtype='int64')
      >>> ascending_idx.equals(descending_idx)
      False

  The dtype is not compared

      >>> int64_idx = pd.Index([1, 2, 3], dtype="int64")
      >>> int64_idx
      Index([1, 2, 3], dtype='int64')
      >>> uint64_idx = pd.Index([1, 2, 3], dtype="uint64")
      >>> uint64_idx
      Index([1, 2, 3], dtype='uint64')
      >>> int64_idx.equals(uint64_idx)
      True