BigInteger.IComparable.CompareTo(Object) Método

Definição

Namespace:

System.Numerics

Assembly:

System.Runtime.Numerics.dll

Compara esta instância a um objeto especificado e retorna um inteiro que indica se o valor desta instância é menor, igual ou maior que o valor do objeto especificado.

 virtual int System.IComparable.CompareTo(System::Object ^ obj) = IComparable::CompareTo;

int IComparable.CompareTo (object obj);

abstract member System.IComparable.CompareTo : obj -> int
override this.System.IComparable.CompareTo : obj -> int

Function CompareTo (obj As Object) As Integer Implements IComparable.CompareTo

Parâmetros

obj

Object

O objeto a ser comparado.

Retornos

Int32

Um inteiro com sinal que indica a relação da instância atual com o parâmetro obj, conforme mostrado na tabela a seguir.

Valor retornado	Descrição
Menor que zero	A instância atual é menor que obj.
Zero	A instância atual é igual a obj.
Maior que zero	A instância atual é maior do que obj ou o parâmetro obj é null.

Implementações

CompareTo(Object)

Exceções

ArgumentException

obj não é um BigInteger.

Exemplos

O exemplo a seguir chama o CompareTo(Object) método para comparar um BigInteger valor com cada elemento em uma matriz de objetos:

object[] values = { BigInteger.Pow(Int64.MaxValue, 10), null,
                    12.534, Int64.MaxValue, BigInteger.One };
BigInteger number = UInt64.MaxValue;

foreach (object value in values)
{
   try {
      Console.WriteLine("Comparing {0} with '{1}': {2}", number, value,
                        number.CompareTo(value));
   }
   catch (ArgumentException) {
      Console.WriteLine("Unable to compare the {0} value {1} with a BigInteger.",
                        value.GetType().Name, value);
   }
}
// The example displays the following output:
//    Comparing 18446744073709551615 with '4.4555084156466750133735972424E+189': -1
//    Comparing 18446744073709551615 with '': 1
//    Unable to compare the Double value 12.534 with a BigInteger.
//    Unable to compare the Int64 value 9223372036854775807 with a BigInteger.
//    Comparing 18446744073709551615 with '1': 1

Dim values() As Object = { BigInteger.Pow(Int64.MaxValue, 10), Nothing, 
                           12.534, Int64.MaxValue, BigInteger.One }
Dim number As BigInteger = UInt64.MaxValue

For Each value As Object In values
   Try
      Console.WriteLine("Comparing {0} with '{1}': {2}", number, value, 
                        number.CompareTo(value))
   Catch e As ArgumentException
      Console.WriteLine("Unable to compare the {0} value {1} with a BigInteger.",
                        value.GetType().Name, value)
   End Try                     
Next                                 
' The example displays the following output:
'    Comparing 18446744073709551615 with '4.4555084156466750133735972424E+189': -1
'    Comparing 18446744073709551615 with '': 1
'    Unable to compare the Double value 12.534 with a BigInteger.
'    Unable to compare the Int64 value 9223372036854775807 with a BigInteger.
'    Comparing 18446744073709551615 with '1': 1

Comentários

O obj parâmetro deve ser um dos seguintes:

• Um objeto cujo tipo de tempo de execução é BigInteger.

• Uma Object variável cujo valor é null. Se o valor do obj parâmetro for null, o método retornará 1, o que indica que a instância atual é maior que obj.

Confira também

• CompareTo(Object)