BigInteger.CompareTo Method (BigInteger)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Compares this instance to a second BigInteger and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.

Namespace:   System.Numerics
Assembly:  System.Numerics (in System.Numerics.dll)

public int CompareTo(
	BigInteger other


Type: System.Numerics.BigInteger

The object to compare.

Return Value

Type: System.Int32

A signed integer value that indicates the relationship of this instance to other, as shown in the following table.

Return value


Less than zero

The current instance is less than other.


The current instance equals other.

Greater than zero

The current instance is greater than other.

This overload of the CompareTo method implements the IComparable<T>.CompareTo method. It is used by generic collection objects to order the items in the collection.

The following example illustrates the use of the CompareTo(BigInteger) method to order a list of StarInfo objects. Each StarInfo object provides information about a star's name and its distance from the Earth in miles. StarInfo implements the IComparable<T> interface, which enables StarInfo objects to be sorted by generic collection classes. Its IComparable<T>.CompareTo implementation just wraps a call to CompareTo(BigInteger).

using System;
using System.Collections.Generic;
using System.Numerics;

public struct StarInfo : IComparable<StarInfo>
   // Define constructors.
   public StarInfo(string name, double lightYears)
      this.Name = name;

      // Calculate distance in miles from light years.
      this.Distance = (BigInteger) Math.Round(lightYears * 5.88e12);

   public StarInfo(string name, BigInteger distance)
      this.Name = name;
      this.Distance = distance;

   // Define public fields.
   public string Name;
   public BigInteger Distance;

   // Display name of star and its distance in parentheses.
   public override string ToString()
      return String.Format("{0,-10} ({1:N0})", this.Name, this.Distance);

   // Compare StarInfo objects by their distance from Earth.
   public int CompareTo(StarInfo other)
      return this.Distance.CompareTo(other.Distance);

The following code then instantiates four StarInfo objects and stores them in a generic List<T> object. After the List<T>.Sort method is called, StarInfo objects are displayed in order of their distance from the Earth.

public class Example
   public static void Main()
      StarInfo star;
      List<StarInfo> stars = new List<StarInfo>();

      star = new StarInfo("Sirius", 8.6d);
      star = new StarInfo("Rigel", 1400d);
      star = new StarInfo("Castor", 49d);
      star = new StarInfo("Antares", 520d);


      foreach (StarInfo sortedStar in stars)
// The example displays the following output:
//       Sirius     (50,568,000,000,000)
//       Castor     (288,120,000,000,000)
//       Antares    (3,057,600,000,000,000)
//       Rigel      (8,232,000,000,000,000)

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Available since 4.0
Windows Phone
Available since 8.1
Return to top