Class DoubleExt
Represents a struct which contains extension methods for double type values.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Diagram
Assembly: Syncfusion.SfDiagram.UWP.dll
Syntax
public sealed class DoubleExt : ValueType, IComparable, IComparable<DoubleExt>, IEquatable<DoubleExt>, IFormattable
Constructors
DoubleExt(Double)
Initializes a new instance of the DoubleExt class.
Declaration
public DoubleExt(double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | value | The actual value of Value. |
DoubleExt(Double, Double, Double)
Initializes a new instance of the DoubleExt class.
Declaration
public DoubleExt(double min, double max, double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | min | The minimum value. |
System.Double | max | The Maximum value. |
System.Double | value | The value for the Value property. |
Properties
ActualValue
Gets the actual value of DoubleExt class.
Declaration
public double ActualValue { get; }
Property Value
Type |
---|
System.Double |
DesiredValue
Gets the desired value of DoubleExt class.
Declaration
public double DesiredValue { get; }
Property Value
Type |
---|
System.Double |
Max
Gets or sets the maximum value of DoubleExt class.
Declaration
public double Max { get; set; }
Property Value
Type |
---|
System.Double |
Min
Gets or sets the minimum value of DoubleExt class.
Declaration
public double Min { get; set; }
Property Value
Type |
---|
System.Double |
Value
Gets or sets the value of DoubleExt class.
Declaration
public double Value { get; set; }
Property Value
Type |
---|
System.Double |
Methods
CompareTo(DoubleExt)
Compares this instance to a specified DoubleExt-precision floating-point number 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 DoubleExt-precision floating-point number.
Declaration
public int CompareTo(DoubleExt value)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | value | A DoubleExt-precision floating-point number need to be compare. |
Returns
Type | Description |
---|---|
System.Int32 | Returns the compared double values as interger. |
Equals(DoubleExt)
Returns a value indicating whether this instance and a specified DoubleExt object represent the same value.
Declaration
public bool Equals(DoubleExt obj)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | obj | A DoubleExt object to compare to this instance. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if given value is equal to this instance; otherwise, false. |
Equals(Object)
Overridden to compare the given object with the ActualValue.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | The object which needs to be compared. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if both objects are equal, otherwise return false. |
GetHashCode()
Overriden to provide the default hash function for ActualValue.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Returns the hash code for ActualValue. |
IsInfinity(DoubleExt)
Returns a value indicating whether the specified number evaluates to infinity value.
Declaration
public static bool IsInfinity(DoubleExt d)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | d | A DoubleExt-precision floating-point number that need to be evaluate. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if given value is infinity; otherwise, false. |
IsNaN(DoubleExt)
Returns a value that indicates whether the specified value is a number or not.
Declaration
public static bool IsNaN(DoubleExt d)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | d | A DoubleExt-precision floating-point number that need to be evaluate. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if given value is a number; otherwise, false. |
IsNegativeInfinity(DoubleExt)
Returns a value that indicates whether the specified value is a negative infinity value or not.
Declaration
public static bool IsNegativeInfinity(DoubleExt d)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | d | A DoubleExt-precision floating-point number that need to be evaluate. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if given value is a negative infinity value; otherwise, false. |
IsPositiveInfinity(DoubleExt)
Returns a value that indicates whether the specified value is a positive infinity value or not.
Declaration
public static bool IsPositiveInfinity(DoubleExt d)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | d | A DoubleExt-precision floating-point number that need to be evaluate. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true if given value is a positive infinity value; otherwise, false. |
Parse(String)
Converts the string representation of a number to its DoubleExt-precision floating-point number equivalent.
Declaration
public static DoubleExt Parse(string s)
Parameters
Type | Name | Description |
---|---|---|
System.String | s | A string that contains a number to be convert. |
Returns
Type | Description |
---|---|
DoubleExt | Returns the DoubleExt-precision floating-point value of the specified string. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the string is null. |
System.FormatException | Thrown when the value does not represent a number in a valid format. |
System.OverflowException | Thrown when the number that is less than |
Parse(String, NumberStyles)
Converts the string representation of a number in a specified style to its DoubleExt-precision floating-point number equivalent.
Declaration
public static DoubleExt Parse(string s, NumberStyles style)
Parameters
Type | Name | Description |
---|---|---|
System.String | s | A string that contains a number to be convert. |
System.Globalization.NumberStyles | style | A bitwise combination of enumeration values that indicate the style elements. A typical value to specify is a combination of |
Returns
Type | Description |
---|---|
DoubleExt | Returns the DoubleExt-precision floating-point value of the specified string. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the string is null. |
System.FormatException | Thrown when the value does not represent a number in a valid format. |
System.OverflowException | Thrown when the number that is less than |
System.ArgumentException | Thrown when given NumberStyles is not a |
Parse(String, NumberStyles, IFormatProvider)
Converts the string representation of a number in a specified style and culture-specific format to its DoubleExt-precision floating-point number equivalent.
Declaration
public static DoubleExt Parse(string s, NumberStyles style, IFormatProvider provider)
Parameters
Type | Name | Description |
---|---|---|
System.String | s | A string that contains a number to be convert. |
System.Globalization.NumberStyles | style | A bitwise combination of enumeration values that indicate the style elements. A typical value to specify is |
System.IFormatProvider | provider | An object that supplies culture-specific formatting information about the string. |
Returns
Type |
---|
DoubleExt |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the string is null. |
System.FormatException | Thrown when the value does not represent a number in a valid format. |
System.ArgumentException | Thrown when given NumberStyles is not a |
System.OverflowException | Thrown when the number that is less than |
Parse(String, IFormatProvider)
Converts the string representation of a number in a specified culture-specific format to its DoubleExt-precision floating-point number equivalent.
Declaration
public static DoubleExt Parse(string s, IFormatProvider provider)
Parameters
Type | Name | Description |
---|---|---|
System.String | s | A string that contains a number to be convert. |
System.IFormatProvider | provider | An object that supplies culture-specific formatting information about the string. |
Returns
Type |
---|
DoubleExt |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when the string is null. |
System.FormatException | Thrown when the value does not represent a number in a valid format. |
System.OverflowException | Thrown when the number that is less than |
ToString()
Overridden to convert the ActualValue to the equivalent string value.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | Returns the string value of ActualValue. |
ToString(IFormatProvider)
To convert the ActualValue to the equivalent string value using the specified culture-specific format information.
Declaration
public string ToString(IFormatProvider provider)
Parameters
Type | Name | Description |
---|---|---|
System.IFormatProvider | provider | An object that supplies culture-specific formatting information. |
Returns
Type | Description |
---|---|
System.String | Returns the string value of ActualValue. |
ToString(String)
To convert the ActualValue to the equivalent string value using the specified format.
Declaration
public string ToString(string format)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | A numeric format string. |
Returns
Type | Description |
---|---|
System.String | Returns the string value of ActualValue. |
Exceptions
Type | Condition |
---|---|
System.FormatException | Thrown when giver format value is not valid. |
ToString(String, IFormatProvider)
Converts the numeric value to its equivalent string value using the specified format and culture-specific format information.
Declaration
public string ToString(string format, IFormatProvider provider)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | A numeric format string. |
System.IFormatProvider | provider | An object that supplies culture-specific formatting information. |
Returns
Type | Description |
---|---|
System.String | Returns the string value. |
TryParse(String, out DoubleExt)
Converts the string representation of a number to its DoubleExt-precision floating-point number equivalent and specifies a value that indicates whether the conversion is succeeded or failed.
Declaration
public static bool TryParse(string s, out DoubleExt result)
Parameters
Type | Name | Description |
---|---|---|
System.String | s | A string containing a number that need to be convert. |
DoubleExt | result | DoubleExt-precision floating-point which Parameter is passed and uninitialized. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the the conversion is succed; otherwise, false. |
TryParse(String, NumberStyles, IFormatProvider, out DoubleExt)
Converts the string representation of a number in a specified style and culture-specific format to its DoubleExt-precision floating-point number equivalent and specifies a value that indicates whether the conversion succeeded or failed.
Declaration
public static bool TryParse(string s, NumberStyles style, IFormatProvider provider, out DoubleExt result)
Parameters
Type | Name | Description |
---|---|---|
System.String | s | A string containing a number that need to be convert. |
System.Globalization.NumberStyles | style | A bitwise combination of |
System.IFormatProvider | provider | An System.IFormatProvider that supplies culture-specific formatting information about the string. |
DoubleExt | result | DoubleExt-precision floating-point which Parameter is passed and uninitialized. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the the conversion is succed; otherwise, false. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when given NumberStyle is not a |
Operators
Addition(DoubleExt, Double)
Adds the given values.
Declaration
public static DoubleExt operator +(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left value that need to be added with other value. |
System.Double | right | The right value that need to be added with other value. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
Decrement(DoubleExt)
Specifies the decrement operation for given value.
Declaration
public static DoubleExt operator --(DoubleExt left)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The value that need to be decrement. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
Division(DoubleExt, Double)
Specifies the dividing operation for given values.
Declaration
public static DoubleExt operator /(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The Left side value. |
System.Double | right | the right side value. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
Equality(DoubleExt, DoubleExt)
Returns a value that indicates whether two specified DoubleExt values are equal.
Declaration
public static bool operator ==(DoubleExt left, DoubleExt right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The first value to compare. |
DoubleExt | right | The second value to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if |
Equality(DoubleExt, Double)
Performs the basic function of the "==" operator on the given two objects.
Declaration
public static bool operator ==(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left-hand side of the operator. |
System.Double | right | The right-hand side of the operator. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if given values are equal; otherwise, flase. |
False(DoubleExt)
Needs information
Declaration
public static bool operator false (DoubleExt left)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left |
Returns
Type |
---|
System.Boolean |
GreaterThan(DoubleExt, DoubleExt)
Returns a value that indicates whether a specified DoubleExt value is greater than another specified DoubleExt value.
Declaration
public static bool operator>(DoubleExt left, DoubleExt right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The first value to compare. |
DoubleExt | right | The second value to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if |
GreaterThan(DoubleExt, Double)
Performs the basic function of the ">" operator on the given two objects.
Declaration
public static bool operator>(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left-hand side of the operator. |
System.Double | right | The right-hand side of the operator. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the left value is greater than to right value; otherwise, false. |
GreaterThanOrEqual(DoubleExt, DoubleExt)
Returns a value that indicates whether a specified DoubleExt value is greater than or equal to another specified DoubleExt value.
Declaration
public static bool operator >=(DoubleExt left, DoubleExt right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The first value to compare. |
DoubleExt | right | The second value to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if |
GreaterThanOrEqual(DoubleExt, Double)
Performs the basic function of the ">=" operator on the given two objects.
Declaration
public static bool operator >=(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left-hand side of the operator. |
System.Double | right | The right-hand side of the operator. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the left value is greater than or equal to right value; otherwise, false. |
Implicit(Double to DoubleExt)
Operator method to convert double type value to DoubleExt type.
Declaration
public static implicit operator DoubleExt(double d)
Parameters
Type | Name | Description |
---|---|---|
System.Double | d | Double value. |
Returns
Type | Description |
---|---|
DoubleExt | Returns DoubleExt value. |
Increment(DoubleExt)
Specifies the increment operation for given value.
Declaration
public static DoubleExt operator ++(DoubleExt left)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The value that need to be increment. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
Inequality(DoubleExt, DoubleExt)
Returns a value that indicates whether two specified DoubleExt values are not equal.
Declaration
public static bool operator !=(DoubleExt left, DoubleExt right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The first value to compare. |
DoubleExt | right | The second value to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if |
Inequality(DoubleExt, Double)
Performs the basic function of the "!=" operator on the given two objects.
Declaration
public static bool operator !=(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left-hand side of the operator. |
System.Double | right | The right-hand side of the operator. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the given values are not equal; otherwise, false. |
LessThan(DoubleExt, DoubleExt)
Returns a value that indicates whether a specified DoubleExt value is less than another specified DoubleExt value.
Declaration
public static bool operator <(DoubleExt left, DoubleExt right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The first value to compare. |
DoubleExt | right | The second value to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if |
LessThan(DoubleExt, Double)
Performs the basic function of the less than operator on the given two objects.
Declaration
public static bool operator <(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left-hand side of the operator. |
System.Double | right | The right-hand side of the operator. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the left value is less than to right value; otherwise, false. |
LessThanOrEqual(DoubleExt, DoubleExt)
Returns a value that indicates whether a specified DoubleExt value is less than or equal to another specified DoubleExt value.
Declaration
public static bool operator <=(DoubleExt left, DoubleExt right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The first value to compare. |
DoubleExt | right | The second value to compare. |
Returns
Type | Description |
---|---|
System.Boolean | true if |
LessThanOrEqual(DoubleExt, Double)
Performs the basic function of the less than or equal to operator on the given two objects.
Declaration
public static bool operator <=(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The left-hand side of the operator. |
System.Double | right | The right-hand side of the operator. |
Returns
Type | Description |
---|---|
System.Boolean | Returns true, if the left value is less than or equal to right value; otherwise, false. |
Modulus(DoubleExt, Double)
Specifies the modulus operation for given values.
Declaration
public static DoubleExt operator %(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The Left side value. |
System.Double | right | the right side value. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
Multiply(DoubleExt, Double)
Multiplies the given values.
Declaration
public static DoubleExt operator *(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The Left side value. |
System.Double | right | the right side value. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
Subtraction(DoubleExt, Double)
Specifies the Subtraction operation for given values.
Declaration
public static DoubleExt operator -(DoubleExt left, double right)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left | The Left side value of the subtraction. |
System.Double | right | the right side value of the subtraction. |
Returns
Type | Description |
---|---|
DoubleExt | Returns doubleExt-precision floating-point value. |
True(DoubleExt)
Needs information
Declaration
public static bool operator true (DoubleExt left)
Parameters
Type | Name | Description |
---|---|---|
DoubleExt | left |
Returns
Type |
---|
System.Boolean |