Numerics.BigInteger Structure (F#)

Article
07/11/2012

The type of arbitrary-sized integers

Namespace/Module Path: System.Numerics

Assembly: FSharp.Core (in FSharp.Core.dll)

[<CustomEquality>]
[<CustomComparison>]
type BigInteger =
 struct
  interface IComparable
  new BigInteger : int64 -> BigInteger
  new BigInteger : int -> BigInteger
  static member Abs : BigInteger -> BigInteger
  static member DivRem : BigInteger * BigInteger * byref<BigInteger> -> BigInteger
  static member GreatestCommonDivisor : BigInteger * BigInteger -> BigInteger
  static member Parse : string -> BigInteger
  static member Pow : BigInteger * int32 -> BigInteger
  member this.IsOne :  bool
  member this.IsZero :  bool
  static member One :  BigInteger
  member this.Sign :  int
  static member Zero :  BigInteger
  static member ( + ) : BigInteger * BigInteger -> BigInteger
  static member ( / ) : BigInteger * BigInteger -> BigInteger
  static member ( = ) : BigInteger * BigInteger -> bool
  static member op_Explicit : BigInteger -> int32
  static member op_Explicit : BigInteger -> int64
  static member op_Explicit : BigInteger -> float
  static member ( > ) : BigInteger * BigInteger -> bool
  static member ( >= ) : BigInteger * BigInteger -> bool
  static member ( <> ) : BigInteger * BigInteger -> bool
  static member ( < ) : BigInteger * BigInteger -> bool
  static member ( <= ) : BigInteger * BigInteger -> bool
  static member ( % ) : BigInteger * BigInteger -> BigInteger
  static member ( * ) : BigInteger * BigInteger -> BigInteger
  static member ( - ) : BigInteger * BigInteger -> BigInteger
  static member ( ~- ) : BigInteger -> BigInteger
  static member ( ~+ ) : BigInteger -> BigInteger
 end

Remarks

This type is provided for use only with the F# Core Library Versions that targets .NET Framework 2.0. If you are using .NET Framework 4, use the .NET Framework 4 type with the same name, BigInteger.

Constructors

Member	Description
new	Construct a BigInteger value for the given 64-bit integer

Instance Members

Member	Description
IsOne	Return true if a big integer is 'one'
IsZero	Return true if a big integer is 'zero'
Sign	Return the sign of a big integer: 0, +1 or -1

Static Members

Member	Description
( % )	Return the modulus of big integers
( * )	Return the product of big integers
( + )	Return the sum of two big integers
( - )	Return the difference of two big integers
( / )	Return the ratio of two big integers
( < )	This operator is for consistency when this type be used from other CLI languages
( <= )	This operator is for consistency when this type be used from other CLI languages
( <> )	This operator is for consistency when this type be used from other CLI languages
( = )	This operator is for consistency when this type be used from other CLI languages
( > )	This operator is for consistency when this type be used from other CLI languages
( >= )	This operator is for consistency when this type be used from other CLI languages
( ~+ )	Return the given big integer
( ~- )	Return the negation of a big integer
Abs	Compute the absolute value of a big integer
DivRem	Compute the ratio and remainder of two big integers
GreatestCommonDivisor	Return the greatest common divisor of two big integers
One	Get the big integer for one
op_Explicit	Convert a big integer to a floating point number
Parse	Parse a big integer from a string format
Pow	Return n^m for two big integers
Zero	Get the big integer for zero

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0

Share via