Struct BigInteger

Namespace

Renci.SshNet.Common

Assembly

Renci.SshNet.dll

Represents an arbitrarily large signed integer.

public struct BigInteger : IComparable, IFormattable, IComparable<BigInteger>, IEquatable<BigInteger>

Implements

IComparable

IFormattable

IComparable<BigInteger>

IEquatable<BigInteger>

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

BigInteger(int)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using a 32-bit signed integer value.

public BigInteger(int value)

Parameters

value int

A 32-bit signed integer.

BigInteger(uint)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using an unsigned 32-bit integer value.

[CLSCompliant(false)]
public BigInteger(uint value)

Parameters

value uint

An unsigned 32-bit integer value.

BigInteger(long)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using a 64-bit signed integer value.

public BigInteger(long value)

Parameters

value long

A 64-bit signed integer.

BigInteger(ulong)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure with an unsigned 64-bit integer value.

[CLSCompliant(false)]
public BigInteger(ulong value)

Parameters

value ulong

An unsigned 64-bit integer.

BigInteger(double)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using a double-precision floating-point value.

public BigInteger(double value)

Parameters

value double

A double-precision floating-point value.

BigInteger(float)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using a single-precision floating-point value.

public BigInteger(float value)

Parameters

value float

A single-precision floating-point value.

BigInteger(decimal)

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using a System.Decimal value.

public BigInteger(decimal value)

Parameters

value decimal

A decimal number.

BigInteger(byte[])

Initializes a new instance of the Renci.SshNet.Common.BigInteger structure using the values in a byte array.

[CLSCompliant(false)]
public BigInteger(byte[] value)

Parameters

value byte[]

An array of System.Byte values in little-endian order.

Exceptions

ArgumentNullException

value is null.

Properties

BitLength

Gets number of bits used by the number.

public readonly int BitLength { get; }

Property Value

int

IsEven

Gets a value indicating whether the value of the current Renci.SshNet.Common.BigInteger object is an even number.

public readonly bool IsEven { get; }

Property Value

bool

IsOne

Gets a value indicating whether the value of the current Renci.SshNet.Common.BigInteger object is Renci.SshNet.Common.BigInteger.One.

public readonly bool IsOne { get; }

Property Value

bool

IsPowerOfTwo

Gets a value Indicating whether the value of the current Renci.SshNet.Common.BigInteger object is a power of two.

public readonly bool IsPowerOfTwo { get; }

Property Value

bool

IsZero

Gets a value indicating whether the value of the current Renci.SshNet.Common.BigInteger object is Renci.SshNet.Common.BigInteger.Zero.

public readonly bool IsZero { get; }

Property Value

bool

MinusOne

Gets a value that represents the number negative one (-1).

public static BigInteger MinusOne { get; }

Property Value

BigInteger

One

Gets a value that represents the number one (1).

public static BigInteger One { get; }

Property Value

BigInteger

Sign

Gets a number that indicates the sign (negative, positive, or zero) of the current Renci.SshNet.Common.BigInteger object.

public readonly int Sign { get; }

Property Value

int

Zero

Gets a value that represents the number 0 (zero).

public static BigInteger Zero { get; }

Property Value

BigInteger

Methods

Abs(BigInteger)

Gets the absolute value of a Renci.SshNet.Common.BigInteger object.

public static BigInteger Abs(BigInteger value)

Parameters

value BigInteger

A number.

Returns

BigInteger

The absolute value of value.

Add(BigInteger, BigInteger)

Adds two Renci.SshNet.Common.BigInteger values and returns the result.

public static BigInteger Add(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to add.

right BigInteger

The second value to add.

Returns

BigInteger

The sum of left and right.

Compare(BigInteger, BigInteger)

Compares two Renci.SshNet.Common.BigInteger values and returns an integer that indicates whether the first value is less than, equal to, or greater than the second value.

public static int Compare(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

int

A signed integer that indicates the relative values of left and right, as shown in the following table.

Value	Condition
Less than zero	left is less than right.
Zero	left equals right.
Greater than zero	left is greater than right.

CompareTo(object)

Compares this instance to a specified object 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.

public readonly int CompareTo(object obj)

Parameters

obj object

The object to compare.

Returns

int

A signed integer that indicates the relationship of the current instance to the obj parameter, as shown in the following table.

Value	Condition
Less than zero	The current instance is less than obj.
Zero	The current instance equals obj.
Greater than zero	The current instance is greater than obj.

Exceptions

ArgumentException

obj is not a Renci.SshNet.Common.BigInteger.

CompareTo(BigInteger)

Compares this instance to a second Renci.SshNet.Common.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.

public readonly int CompareTo(BigInteger other)

Parameters

other BigInteger

The object to compare.

Returns

int

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

Value	Condition
Less than zero	The current instance is less than other.
Zero	The current instance equals other.
Greater than zero	The current instance is greater than other.

CompareTo(ulong)

Compares this instance to an unsigned 64-bit integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the unsigned 64-bit integer.

[CLSCompliant(false)]
public readonly int CompareTo(ulong other)

Parameters

other ulong

The unsigned 64-bit integer to compare.

Returns

int

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

Value	Condition
Less than zero	The current instance is less than other.
Zero	The current instance equals other.
Greater than zero	The current instance is greater than other.

CompareTo(long)

Compares this instance to a signed 64-bit integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the signed 64-bit integer.

public readonly int CompareTo(long other)

Parameters

other long

The signed 64-bit integer to compare.

Returns

int

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

Value	Condition
Less than zero	The current instance is less than other.
Zero	The current instance equals other.
Greater than zero	The current instance is greater than other.

DivRem(BigInteger, BigInteger, out BigInteger)

Divides one Renci.SshNet.Common.BigInteger value by another, returns the result, and returns the remainder in an output parameter.

public static BigInteger DivRem(BigInteger dividend, BigInteger divisor, out BigInteger remainder)

Parameters

dividend BigInteger

The value to be divided.

divisor BigInteger

The value to divide by.

remainder BigInteger

When this method returns, contains a Renci.SshNet.Common.BigInteger value that represents the remainder from the division. This parameter is passed uninitialized.

Returns

BigInteger

The quotient of the division.

Divide(BigInteger, BigInteger)

Divides one Renci.SshNet.Common.BigInteger value by another and returns the result.

public static BigInteger Divide(BigInteger dividend, BigInteger divisor)

Parameters

dividend BigInteger

The value to be divided.

divisor BigInteger

The value to divide by.

Returns

BigInteger

The quotient of the division.

Equals(object)

Returns a value that indicates whether the current instance and a specified object have the same value.

public override readonly bool Equals(object obj)

Parameters

obj object

The object to compare.

Returns

bool

true if the obj parameter is a Renci.SshNet.Common.BigInteger object or a type capable of implicit conversion to a Renci.SshNet.Common.BigInteger value, and its value is equal to the value of the current Renci.SshNet.Common.BigInteger object; otherwise, false.

Equals(BigInteger)

Returns a value that indicates whether the current instance and a specified Renci.SshNet.Common.BigInteger object have the same value.

public readonly bool Equals(BigInteger other)

Parameters

other BigInteger

The object to compare.

Returns

bool

true if this Renci.SshNet.Common.BigInteger object and other have the same value; otherwise, false.

Equals(long)

Returns a value that indicates whether the current instance and a signed 64-bit integer have the same value.

public readonly bool Equals(long other)

Parameters

other long

The signed 64-bit integer value to compare.

Returns

bool

true if the signed 64-bit integer and the current instance have the same value; otherwise, false.

Equals(ulong)

Returns a value that indicates whether the current instance and an unsigned 64-bit integer have the same value.

[CLSCompliant(false)]
public readonly bool Equals(ulong other)

Parameters

other ulong

The unsigned 64-bit integer to compare.

Returns

bool

true if the current instance and the unsigned 64-bit integer have the same value; otherwise, false.

GetHashCode()

Returns the hash code for the current Renci.SshNet.Common.BigInteger object.

public override readonly int GetHashCode()

Returns

int

A 32-bit signed integer hash code.

GreatestCommonDivisor(BigInteger, BigInteger)

Finds the greatest common divisor of two Renci.SshNet.Common.BigInteger values.

public static BigInteger GreatestCommonDivisor(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value.

right BigInteger

The second value.

Returns

BigInteger

The greatest common divisor of left and right.

Log(BigInteger, double)

Returns the logarithm of a specified number in a specified base.

public static double Log(BigInteger value, double baseValue)

Parameters

value BigInteger

A number whose logarithm is to be found.

baseValue double

The base of the logarithm.

Returns

double

The base baseValue logarithm of value.

Exceptions

ArgumentOutOfRangeException

The log of value is out of range of the System.Double data type.

Log(BigInteger)

Returns the natural (base e) logarithm of a specified number.

public static double Log(BigInteger value)

Parameters

value BigInteger

The number whose logarithm is to be found.

Returns

double

The natural (base e) logarithm of value.

Exceptions

ArgumentOutOfRangeException

The base 10 log of value is out of range of the System.Double data type.

Log10(BigInteger)

Returns the base 10 logarithm of a specified number.

public static double Log10(BigInteger value)

Parameters

value BigInteger

A number whose logarithm is to be found.

Returns

double

The base 10 logarithm of value.

Exceptions

ArgumentOutOfRangeException

The base 10 log of value is out of range of the System.Double data type.

Max(BigInteger, BigInteger)

Returns the larger of two Renci.SshNet.Common.BigInteger values.

public static BigInteger Max(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

BigInteger

The left or right parameter, whichever is larger.

Min(BigInteger, BigInteger)

Returns the smaller of two Renci.SshNet.Common.BigInteger values.

public static BigInteger Min(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

BigInteger

The left or right parameter, whichever is smaller.

ModInverse(BigInteger, BigInteger)

Mods the inverse.

public static BigInteger ModInverse(BigInteger bi, BigInteger modulus)

Parameters

bi BigInteger

The bi.

modulus BigInteger

The modulus.

Returns

BigInteger

Modulus inverted number.

ModPow(BigInteger, BigInteger, BigInteger)

Performs modulus division on a number raised to the power of another number.

public static BigInteger ModPow(BigInteger value, BigInteger exponent, BigInteger modulus)

Parameters

value BigInteger

The number to raise to the exponent power.

exponent BigInteger

The exponent to raise value by.

modulus BigInteger

The number by which to divide value raised to the exponent power.

Returns

BigInteger

The remainder after dividing value raised by exponent by modulus.

Exceptions

ArgumentOutOfRangeException

exponent is negative.

Multiply(BigInteger, BigInteger)

Returns the product of two Renci.SshNet.Common.BigInteger values.

public static BigInteger Multiply(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first number to multiply.

right BigInteger

The second number to multiply.

Returns

BigInteger

The product of the left and right parameters.

Negate(BigInteger)

Negates a specified Renci.SshNet.Common.BigInteger value.

public static BigInteger Negate(BigInteger value)

Parameters

value BigInteger

The value to negate.

Returns

BigInteger

The result of the value parameter multiplied by negative one (-1).

Parse(string)

Converts the string representation of a number to its Renci.SshNet.Common.BigInteger equivalent.

public static BigInteger Parse(string value)

Parameters

value string

A string that contains the number to convert.

Returns

BigInteger

A value that is equivalent to the number specified in the value parameter.

Exceptions

ArgumentNullException

value is null.

FormatException

value is not in the correct format.

Parse(string, NumberStyles)

Converts the string representation of a number in a specified style to its Renci.SshNet.Common.BigInteger equivalent.

public static BigInteger Parse(string value, NumberStyles style)

Parameters

value string

A string that contains a number to convert.

style NumberStyles

A bitwise combination of the enumeration values that specify the permitted format of value.

Returns

BigInteger

A value that is equivalent to the number specified in the value parameter.

Exceptions

ArgumentException

style is not a System.Globalization.NumberStyles value.

-or-

style includes the System.Globalization.NumberStyles.AllowHexSpecifier or System.Globalization.NumberStyles.HexNumber flag along with another value.

ArgumentNullException

value is null.

FormatException

value does not comply with the input pattern specified by System.Globalization.NumberStyles.

Parse(string, IFormatProvider)

Converts the string representation of a number in a specified style to its Renci.SshNet.Common.BigInteger equivalent.

public static BigInteger Parse(string value, IFormatProvider provider)

Parameters

value string

A string that contains a number to convert.

provider IFormatProvider

An object that provides culture-specific formatting information about value.

Returns

BigInteger

A value that is equivalent to the number specified in the value parameter.

Exceptions

ArgumentNullException

value is null.

FormatException

value is not in the correct format.

Parse(string, NumberStyles, IFormatProvider)

Converts the string representation of a number in a specified style and culture-specific format to its Renci.SshNet.Common.BigInteger equivalent.

public static BigInteger Parse(string value, NumberStyles style, IFormatProvider provider)

Parameters

value string

A string that contains a number to convert.

style NumberStyles

A bitwise combination of the enumeration values that specify the permitted format of value.

provider IFormatProvider

An object that provides culture-specific formatting information about value.

Returns

BigInteger

A value that is equivalent to the number specified in the value parameter.

Exceptions

ArgumentException

style is not a System.Globalization.NumberStyles value.

-or-

style includes the System.Globalization.NumberStyles.AllowHexSpecifier or System.Globalization.NumberStyles.HexNumber flag along with another value.

ArgumentNullException

value is null.

FormatException

value does not comply with the input pattern specified by System.Globalization.NumberStyles.

PositiveMod(BigInteger, BigInteger)

Returns positive remainder that results from division with two specified Renci.SshNet.Common.BigInteger values.

public static BigInteger PositiveMod(BigInteger dividend, BigInteger divisor)

Parameters

dividend BigInteger

The value to be divided.

divisor BigInteger

The value to divide by.

Returns

BigInteger

Positive remainder that results from the division.

Pow(BigInteger, int)

Raises a Renci.SshNet.Common.BigInteger value to the power of a specified value.

public static BigInteger Pow(BigInteger value, int exponent)

Parameters

value BigInteger

The number to raise to the exponent power.

exponent int

The exponent to raise value by.

Returns

BigInteger

The result of raising value to the exponent power.

Random(int)

Generates a new, random Renci.SshNet.Common.BigInteger of the specified length.

public static BigInteger Random(int bitLength)

Parameters

bitLength int

The number of bits for the new number.

Returns

BigInteger

A random number of the specified length.

Remainder(BigInteger, BigInteger)

Performs integer division on two Renci.SshNet.Common.BigInteger values and returns the remainder.

public static BigInteger Remainder(BigInteger dividend, BigInteger divisor)

Parameters

dividend BigInteger

The value to be divided.

divisor BigInteger

The value to divide by.

Returns

BigInteger

The remainder after dividing dividend by divisor.

Subtract(BigInteger, BigInteger)

Subtracts one Renci.SshNet.Common.BigInteger value from another and returns the result.

public static BigInteger Subtract(BigInteger left, BigInteger right)

Parameters

left BigInteger

The value to subtract from (the minuend).

right BigInteger

The value to subtract (the subtrahend).

Returns

BigInteger

The result of subtracting right from left.

ToByteArray()

Converts a Renci.SshNet.Common.BigInteger value to a byte array.

public readonly byte[] ToByteArray()

Returns

byte[]

The value of the current Renci.SshNet.Common.BigInteger object converted to an array of bytes.

ToString()

Converts the numeric value of the current Renci.SshNet.Common.BigInteger object to its equivalent string representation.

public override readonly string ToString()

Returns

string

The string representation of the current Renci.SshNet.Common.BigInteger value.

ToString(string)

Converts the numeric value of the current Renci.SshNet.Common.BigInteger object to its equivalent string representation by using the specified format.

public readonly string ToString(string format)

Parameters

format string

A standard or custom numeric format string.

Returns

string

The string representation of the current Renci.SshNet.Common.BigInteger value in the format specified by the format parameter.

Exceptions

FormatException

format is not a valid format string.

ToString(IFormatProvider)

Converts the numeric value of the current Renci.SshNet.Common.BigInteger object to its equivalent string representation by using the specified culture-specific formatting information.

public readonly string ToString(IFormatProvider provider)

Parameters

provider IFormatProvider

An object that supplies culture-specific formatting information.

Returns

string

The string representation of the current Renci.SshNet.Common.BigInteger value in the format specified by the provider parameter.

ToString(string, IFormatProvider)

Converts the numeric value of the current Renci.SshNet.Common.BigInteger object to its equivalent string representation by using the specified format and culture-specific format information.

public readonly string ToString(string format, IFormatProvider formatProvider)

Parameters

format string

A standard or custom numeric format string.

formatProvider IFormatProvider

An object that supplies culture-specific formatting information.

Returns

string

The string representation of the current Renci.SshNet.Common.BigInteger value as specified by the format and formatProvider parameters.

TryParse(string, out BigInteger)

Tries to convert the string representation of a number to its Renci.SshNet.Common.BigInteger equivalent, and returns a value that indicates whether the conversion succeeded.

public static bool TryParse(string value, out BigInteger result)

Parameters

value string

The string representation of a number.

result BigInteger

When this method returns, contains the Renci.SshNet.Common.BigInteger equivalent to the number that is contained in value, or zero (0) if the conversion fails. The conversion fails if the value parameter is null or is not of the correct format. This parameter is passed uninitialized.

Returns

bool

true if value was converted successfully; otherwise, false.

Exceptions

ArgumentNullException

value is null.

TryParse(string, NumberStyles, IFormatProvider, out BigInteger)

Tries to convert the string representation of a number in a specified style and culture-specific format to its Renci.SshNet.Common.BigInteger equivalent, and returns a value that indicates whether the conversion succeeded.

public static bool TryParse(string value, NumberStyles style, IFormatProvider provider, out BigInteger result)

Parameters

value string

The string representation of a number.

style NumberStyles

A bitwise combination of enumeration values that indicates the style elements that can be present in value.

provider IFormatProvider

An object that supplies culture-specific formatting information about value.

result BigInteger

When this method returns, contains the Renci.SshNet.Common.BigInteger equivalent to the number that is contained in value, or Renci.SshNet.Common.BigInteger.Zero if the conversion fails. The conversion fails if the value parameter is null or is not of the correct format. This parameter is passed uninitialized.

Returns

bool

true if value was converted successfully; otherwise, false.

Exceptions

ArgumentException

style is not a System.Globalization.NumberStyles value.

-or-

style includes the System.Globalization.NumberStyles.AllowHexSpecifier or System.Globalization.NumberStyles.HexNumber flag along with another value.

Operators

operator +(BigInteger, BigInteger)

Adds the values of two specified Renci.SshNet.Common.BigInteger objects.

public static BigInteger operator +(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to add.

right BigInteger

The second value to add.

Returns

BigInteger

The sum of left and right.

operator &(BigInteger, BigInteger)

Performs a bitwise And operation on two Renci.SshNet.Common.BigInteger values.

public static BigInteger operator &(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value.

right BigInteger

The second value.

Returns

BigInteger

The result of the bitwise And operation.

operator |(BigInteger, BigInteger)

Performs a bitwise Or operation on two Renci.SshNet.Common.BigInteger values.

public static BigInteger operator |(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value.

right BigInteger

The second value.

Returns

BigInteger

The result of the bitwise Or operation.

operator --(BigInteger)

Decrements a Renci.SshNet.Common.BigInteger value by 1.

public static BigInteger operator --(BigInteger value)

Parameters

value BigInteger

The value to decrement.

Returns

BigInteger

The value of the value parameter decremented by 1.

operator /(BigInteger, BigInteger)

Divides a specified Renci.SshNet.Common.BigInteger value by another specified Renci.SshNet.Common.BigInteger value by using integer division.

public static BigInteger operator /(BigInteger dividend, BigInteger divisor)

Parameters

dividend BigInteger

The value to be divided.

divisor BigInteger

The value to divide by.

Returns

BigInteger

The integral result of the division.

operator ==(BigInteger, BigInteger)

Returns a value that indicates whether the values of two Renci.SshNet.Common.BigInteger objects are equal.

public static bool operator ==(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if the left and right parameters have the same value; otherwise, false.

operator ==(BigInteger, long)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value and a signed long integer value are equal.

public static bool operator ==(BigInteger left, long right)

Parameters

left BigInteger

The first value to compare.

right long

The second value to compare.

Returns

bool

true if the left and right parameters have the same value; otherwise, false.

operator ==(long, BigInteger)

Returns a value that indicates whether a signed long integer value and a Renci.SshNet.Common.BigInteger value are equal.

public static bool operator ==(long left, BigInteger right)

Parameters

left long

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if the left and right parameters have the same value; otherwise, false.

operator ==(BigInteger, ulong)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value and an unsigned long integer value are equal.

[CLSCompliant(false)]
public static bool operator ==(BigInteger left, ulong right)

Parameters

left BigInteger

The first value to compare.

right ulong

The second value to compare.

Returns

bool

true if the left and right parameters have the same value; otherwise, false.

operator ==(ulong, BigInteger)

Returns a value that indicates whether an unsigned long integer value and a Renci.SshNet.Common.BigInteger value are equal.

[CLSCompliant(false)]
public static bool operator ==(ulong left, BigInteger right)

Parameters

left ulong

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if the left and right parameters have the same value; otherwise, false.

operator ^(BigInteger, BigInteger)

Performs a bitwise exclusive Or (XOr) operation on two Renci.SshNet.Common.BigInteger values.

public static BigInteger operator ^(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value.

right BigInteger

The second value.

Returns

BigInteger

The result of the bitwise Or operation.

explicit operator int(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a 32-bit signed integer value.

public static explicit operator int(BigInteger value)

Parameters

value BigInteger

The value to convert to a 32-bit signed integer.

Returns

int

An object that contains the value of the value parameter.

explicit operator uint(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to an unsigned 32-bit integer value.

[CLSCompliant(false)]
public static explicit operator uint(BigInteger value)

Parameters

value BigInteger

The value to convert to an unsigned 32-bit integer.

Returns

uint

An object that contains the value of the value parameter.

explicit operator short(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a 16-bit signed integer value.

public static explicit operator short(BigInteger value)

Parameters

value BigInteger

The value to convert to a 16-bit signed integer.

Returns

short

An object that contains the value of the value parameter.

explicit operator ushort(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a 16-bit unsigned integer value.

[CLSCompliant(false)]
public static explicit operator ushort(BigInteger value)

Parameters

value BigInteger

The value to convert to a 16-bit unsigned integer.

Returns

ushort

An object that contains the value of the value parameter.

explicit operator byte(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to an unsigned byte value.

public static explicit operator byte(BigInteger value)

Parameters

value BigInteger

The value to convert to a System.Byte.

Returns

byte

An object that contains the value of the value parameter.

explicit operator sbyte(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a signed 8-bit value.

[CLSCompliant(false)]
public static explicit operator sbyte(BigInteger value)

Parameters

value BigInteger

The value to convert to a signed 8-bit value.

Returns

sbyte

An object that contains the value of the value parameter.

explicit operator long(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a 64-bit signed integer value.

public static explicit operator long(BigInteger value)

Parameters

value BigInteger

The value to convert to a 64-bit signed integer.

Returns

long

An object that contains the value of the value parameter.

explicit operator ulong(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to an unsigned 64-bit integer value.

[CLSCompliant(false)]
public static explicit operator ulong(BigInteger value)

Parameters

value BigInteger

The value to convert to an unsigned 64-bit integer.

Returns

ulong

An object that contains the value of the value parameter.

explicit operator double(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a System.Double value.

public static explicit operator double(BigInteger value)

Parameters

value BigInteger

The value to convert to a System.Double.

Returns

double

An object that contains the value of the value parameter.

explicit operator float(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a single-precision floating-point value.

public static explicit operator float(BigInteger value)

Parameters

value BigInteger

The value to convert to a single-precision floating-point value.

Returns

float

An object that contains the value of the value parameter.

explicit operator decimal(BigInteger)

Defines an explicit conversion of a Renci.SshNet.Common.BigInteger object to a System.Decimal value.

public static explicit operator decimal(BigInteger value)

Parameters

value BigInteger

The value to convert to a System.Decimal.

Returns

decimal

An object that contains the value of the value parameter.

explicit operator BigInteger(double)

Defines an explicit conversion of a System.Double value to a Renci.SshNet.Common.BigInteger value.

public static explicit operator BigInteger(double value)

Parameters

value double

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

explicit operator BigInteger(float)

Defines an explicit conversion of a System.Single object to a Renci.SshNet.Common.BigInteger value.

public static explicit operator BigInteger(float value)

Parameters

value float

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

explicit operator BigInteger(decimal)

Defines an explicit conversion of a System.Decimal object to a Renci.SshNet.Common.BigInteger value.

public static explicit operator BigInteger(decimal value)

Parameters

value decimal

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

operator >(BigInteger, BigInteger)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is greater than another Renci.SshNet.Common.BigInteger value.

public static bool operator >(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >(BigInteger, long)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger is greater than a 64-bit signed integer value.

public static bool operator >(BigInteger left, long right)

Parameters

left BigInteger

The first value to compare.

right long

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >(long, BigInteger)

Returns a value that indicates whether a 64-bit signed integer is greater than a Renci.SshNet.Common.BigInteger value.

public static bool operator >(long left, BigInteger right)

Parameters

left long

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >(BigInteger, ulong)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is greater than a 64-bit unsigned integer.

[CLSCompliant(false)]
public static bool operator >(BigInteger left, ulong right)

Parameters

left BigInteger

The first value to compare.

right ulong

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >(ulong, BigInteger)

Returns a value that indicates whether a 64-bit unsigned integer is greater than a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static bool operator >(ulong left, BigInteger right)

Parameters

left ulong

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >=(BigInteger, BigInteger)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is greater than or equal to another Renci.SshNet.Common.BigInteger value.

public static bool operator >=(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >=(BigInteger, long)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is greater than or equal to a 64-bit signed integer value.

public static bool operator >=(BigInteger left, long right)

Parameters

left BigInteger

The first value to compare.

right long

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >=(long, BigInteger)

Returns a value that indicates whether a 64-bit signed integer is greater than or equal to a Renci.SshNet.Common.BigInteger value.

public static bool operator >=(long left, BigInteger right)

Parameters

left long

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >=(BigInteger, ulong)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is greater than or equal to a 64-bit unsigned integer value.

[CLSCompliant(false)]
public static bool operator >=(BigInteger left, ulong right)

Parameters

left BigInteger

The first value to compare.

right ulong

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

operator >=(ulong, BigInteger)

Returns a value that indicates whether a 64-bit unsigned integer is greater than or equal to a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static bool operator >=(ulong left, BigInteger right)

Parameters

left ulong

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is greater than right; otherwise, false.

implicit operator BigInteger(int)

Defines an implicit conversion of a signed 32-bit integer to a Renci.SshNet.Common.BigInteger value.

public static implicit operator BigInteger(int value)

Parameters

value int

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(uint)

Defines an implicit conversion of a 32-bit unsigned integer to a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static implicit operator BigInteger(uint value)

Parameters

value uint

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(short)

Defines an implicit conversion of a signed 16-bit integer to a BigInteger value.

public static implicit operator BigInteger(short value)

Parameters

value short

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(ushort)

Defines an implicit conversion of a 16-bit unsigned integer to a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static implicit operator BigInteger(ushort value)

Parameters

value ushort

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(byte)

Defines an implicit conversion of an unsigned byte to a Renci.SshNet.Common.BigInteger value.

public static implicit operator BigInteger(byte value)

Parameters

value byte

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(sbyte)

Defines an implicit conversion of a signed byte to a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static implicit operator BigInteger(sbyte value)

Parameters

value sbyte

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(long)

Defines an implicit conversion of a signed 64-bit integer to a Renci.SshNet.Common.BigInteger value.

public static implicit operator BigInteger(long value)

Parameters

value long

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

implicit operator BigInteger(ulong)

Defines an implicit conversion of a 64-bit unsigned integer to a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static implicit operator BigInteger(ulong value)

Parameters

value ulong

The value to convert to a Renci.SshNet.Common.BigInteger.

Returns

BigInteger

An object that contains the value of the value parameter.

operator ++(BigInteger)

Increments a Renci.SshNet.Common.BigInteger value by 1.

public static BigInteger operator ++(BigInteger value)

Parameters

value BigInteger

The value to increment.

Returns

BigInteger

The value of the value parameter incremented by 1.

operator !=(BigInteger, BigInteger)

Returns a value that indicates whether two Renci.SshNet.Common.BigInteger objects have different values.

public static bool operator !=(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left and right are not equal; otherwise, false.

operator !=(BigInteger, long)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value and a 64-bit signed integer are not equal.

public static bool operator !=(BigInteger left, long right)

Parameters

left BigInteger

The first value to compare.

right long

The second value to compare.

Returns

bool

true if left and right are not equal; otherwise, false.

operator !=(long, BigInteger)

Returns a value that indicates whether a 64-bit signed integer and a Renci.SshNet.Common.BigInteger value are not equal.

public static bool operator !=(long left, BigInteger right)

Parameters

left long

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left and right are not equal; otherwise, false.

operator !=(BigInteger, ulong)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value and a 64-bit unsigned integer are not equal.

[CLSCompliant(false)]
public static bool operator !=(BigInteger left, ulong right)

Parameters

left BigInteger

The first value to compare.

right ulong

The second value to compare.

Returns

bool

true if left and right are not equal; otherwise, false.

operator !=(ulong, BigInteger)

Returns a value that indicates whether a 64-bit unsigned integer and a Renci.SshNet.Common.BigInteger value are not equal.

[CLSCompliant(false)]
public static bool operator !=(ulong left, BigInteger right)

Parameters

left ulong

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left and right are not equal; otherwise, false.

operator <<(BigInteger, int)

Shifts a Renci.SshNet.Common.BigInteger value a specified number of bits to the left.

public static BigInteger operator <<(BigInteger value, int shift)

Parameters

value BigInteger

The value whose bits are to be shifted.

shift int

The number of bits to shift value to the left.

Returns

BigInteger

A value that has been shifted to the left by the specified number of bits.

operator <(BigInteger, BigInteger)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is less than another Renci.SshNet.Common.BigInteger value.

public static bool operator <(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is less than right; otherwise, false.

operator <(BigInteger, long)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is less than a 64-bit signed integer.

public static bool operator <(BigInteger left, long right)

Parameters

left BigInteger

The first value to compare.

right long

The second value to compare.

Returns

bool

true if left is left than right; otherwise, false.

operator <(long, BigInteger)

Returns a value that indicates whether a 64-bit signed integer is less than a Renci.SshNet.Common.BigInteger value.

public static bool operator <(long left, BigInteger right)

Parameters

left long

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is less than right; otherwise, false.

operator <(BigInteger, ulong)

Returns a value that indicates whether a 64-bit signed integer is less than a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static bool operator <(BigInteger left, ulong right)

Parameters

left BigInteger

The first value to compare.

right ulong

The second value to compare.

Returns

bool

true if left is less than right; otherwise, false.

operator <(ulong, BigInteger)

Returns a value that indicates whether a 64-bit unsigned integer is less than a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static bool operator <(ulong left, BigInteger right)

Parameters

left ulong

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is less than right; otherwise, false.

operator <=(BigInteger, BigInteger)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is less than or equal to another Renci.SshNet.Common.BigInteger value.

public static bool operator <=(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is less than or equal to right; otherwise, false.

operator <=(BigInteger, long)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is less than or equal to a 64-bit signed integer.

public static bool operator <=(BigInteger left, long right)

Parameters

left BigInteger

The first value to compare.

right long

The second value to compare.

Returns

bool

true if left is less than or equal to right; otherwise, false.

operator <=(long, BigInteger)

Returns a value that indicates whether a 64-bit signed integer is less than or equal to a Renci.SshNet.Common.BigInteger value.

public static bool operator <=(long left, BigInteger right)

Parameters

left long

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is less than or equal to right; otherwise, false.

operator <=(BigInteger, ulong)

Returns a value that indicates whether a Renci.SshNet.Common.BigInteger value is less than or equal to a 64-bit unsigned integer.

[CLSCompliant(false)]
public static bool operator <=(BigInteger left, ulong right)

Parameters

left BigInteger

The first value to compare.

right ulong

The second value to compare.

Returns

bool

true if left is less than or equal to right; otherwise, false.

operator <=(ulong, BigInteger)

Returns a value that indicates whether a 64-bit unsigned integer is less than or equal to a Renci.SshNet.Common.BigInteger value.

[CLSCompliant(false)]
public static bool operator <=(ulong left, BigInteger right)

Parameters

left ulong

The first value to compare.

right BigInteger

The second value to compare.

Returns

bool

true if left is less than or equal to right; otherwise, false.

operator %(BigInteger, BigInteger)

Returns the remainder that results from division with two specified Renci.SshNet.Common.BigInteger values.

public static BigInteger operator %(BigInteger dividend, BigInteger divisor)

Parameters

dividend BigInteger

The value to be divided.

divisor BigInteger

The value to divide by.

Returns

BigInteger

The remainder that results from the division.

operator *(BigInteger, BigInteger)

Multiplies two specified Renci.SshNet.Common.BigInteger values.

public static BigInteger operator *(BigInteger left, BigInteger right)

Parameters

left BigInteger

The first value to multiply.

right BigInteger

The second value to multiply.

Returns

BigInteger

The product of left and right.

operator ~(BigInteger)

Returns the bitwise one's complement of a Renci.SshNet.Common.BigInteger value.

public static BigInteger operator ~(BigInteger value)

Parameters

value BigInteger

An integer value.

Returns

BigInteger

The bitwise one's complement of value.

operator >>(BigInteger, int)

Shifts a Renci.SshNet.Common.BigInteger value a specified number of bits to the right.

public static BigInteger operator >>(BigInteger value, int shift)

Parameters

value BigInteger

The value whose bits are to be shifted.

shift int

The number of bits to shift value to the right.

Returns

BigInteger

A value that has been shifted to the right by the specified number of bits.

operator -(BigInteger, BigInteger)

Subtracts a Renci.SshNet.Common.BigInteger value from another Renci.SshNet.Common.BigInteger value.

public static BigInteger operator -(BigInteger left, BigInteger right)

Parameters

left BigInteger

The value to subtract from (the minuend).

right BigInteger

The value to subtract (the subtrahend).

Returns

BigInteger

The result of subtracting right from left.

operator -(BigInteger)

Negates a specified Renci.SshNet.Common.BigInteger value.

public static BigInteger operator -(BigInteger value)

Parameters

value BigInteger

The value to negate.

Returns

BigInteger

The result of the value parameter multiplied by negative one (-1).

operator +(BigInteger)

Returns the value of the Renci.SshNet.Common.BigInteger operand.

public static BigInteger operator +(BigInteger value)

Parameters

value BigInteger

An integer value.

Returns

BigInteger

The value of the value operand.

Remarks

The sign of the operand is unchanged.