Struct SignedRational

Represents a number that can be expressed as a fraction.

Implements

IEquatable<SignedRational>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SixLabors.ImageSharp

Assembly: SixLabors.ImageSharp.dll

Syntax

public readonly struct SignedRational : IEquatable<SignedRational>

Remarks

This is a very simplified implementation of a rational number designed for use with metadata only.

Constructors

SignedRational(double)

Initializes a new instance of the SignedRational struct.

Declaration

public SignedRational(double value)

Parameters

Type	Name	Description
double	value	The double to create the instance from.

SignedRational(double, bool)

Initializes a new instance of the SignedRational struct.

Declaration

public SignedRational(double value, bool bestPrecision)

Parameters

Type	Name	Description
double	value	The double to create the instance from.
bool	bestPrecision	Whether to use the best possible precision when parsing the value.

SignedRational(int)

Initializes a new instance of the SignedRational struct.

Declaration

public SignedRational(int value)

Parameters

Type	Name	Description
int	value	The int to create the rational from.

SignedRational(int, int)

Initializes a new instance of the SignedRational struct.

Declaration

public SignedRational(int numerator, int denominator)

Parameters

Type	Name	Description
int	numerator	The number above the line in a vulgar fraction showing how many of the parts indicated by the denominator are taken.
int	denominator	The number below the line in a vulgar fraction; a divisor.

SignedRational(int, int, bool)

Initializes a new instance of the SignedRational struct.

Declaration

public SignedRational(int numerator, int denominator, bool simplify)

Parameters

Type	Name	Description
int	numerator	The number above the line in a vulgar fraction showing how many of the parts indicated by the denominator are taken.
int	denominator	The number below the line in a vulgar fraction; a divisor.
bool	simplify	Specified if the rational should be simplified.

Properties

Denominator

Gets the denominator of a number.

Declaration

public int Denominator { get; }

Property Value

Type	Description
int

Numerator

Gets the numerator of a number.

Declaration

public int Numerator { get; }

Property Value

Type	Description
int

Methods

Equals(SignedRational)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(SignedRational other)

Parameters

Type	Name	Description
SignedRational	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current instance.

Returns

Type	Description
bool	true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides

ValueType.Equals(object)

FromDouble(double)

Converts the specified double to an instance of this type.

Declaration

public static SignedRational FromDouble(double value)

Parameters

Type	Name	Description
double	value	The double to convert to an instance of this type.

Returns

Type	Description
SignedRational	The SignedRational.

FromDouble(double, bool)

Converts the specified double to an instance of this type.

Declaration

public static SignedRational FromDouble(double value, bool bestPrecision)

Parameters

Type	Name	Description
double	value	The double to convert to an instance of this type.
bool	bestPrecision	Whether to use the best possible precision when parsing the value.

Returns

Type	Description
SignedRational	The SignedRational.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

ToDouble()

Converts a rational number to the nearest double.

Declaration

public double ToDouble()

Returns

Type	Description
double	The double.

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	The fully qualified type name.

Overrides

ValueType.ToString()

ToString(IFormatProvider)

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Declaration

public string ToString(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An object that supplies culture-specific formatting information.

Returns

Type	Description
string	The string

Operators

operator ==(SignedRational, SignedRational)

Determines whether the specified SignedRational instances are considered equal.

Declaration

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

Parameters

Type	Name	Description
SignedRational	left	The first SignedRational to compare.
SignedRational	right	The second SignedRational to compare.

Returns

Type	Description
bool	The bool

operator !=(SignedRational, SignedRational)

Determines whether the specified SignedRational instances are not considered equal.

Declaration

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

Parameters

Type	Name	Description
SignedRational	left	The first SignedRational to compare.
SignedRational	right	The second SignedRational to compare.

Returns

Type	Description
bool	The bool

Implements

IEquatable<T>