Struct GorgonRangeF

A type that represents a range between two float values.

Implements

IGorgonEquatableByRef<GorgonRangeF>

IEquatable<GorgonRangeF>

IComparable<GorgonRangeF>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Gorgon.Core

Assembly: Gorgon.Core.dll

Syntax

public readonly struct GorgonRangeF : IGorgonEquatableByRef<GorgonRangeF>, IEquatable<GorgonRangeF>, IComparable<GorgonRangeF>

Remarks

This a means to determine the range between a minimum float value and a maximum float value. Use this object to determine if a value falls within a specific range of values.

Constructors

GorgonRangeF(GorgonRangeF)

Initializes a new instance of the GorgonRangeF struct.

Declaration

public GorgonRangeF(GorgonRangeF minMax)

Parameters

Type	Name	Description
GorgonRangeF	minMax	The min max value to copy.

GorgonRangeF(float, float)

Initializes a new instance of the GorgonRangeF struct.

Declaration

public GorgonRangeF(float min, float max)

Parameters

Type	Name	Description
float	min	The minimum value.
float	max	The maximum value.

Fields

Empty

An empty range value.

Declaration

public static readonly GorgonRangeF Empty

Field Value

Type	Description
GorgonRangeF

Maximum

The maximum value in the range.

Declaration

public readonly float Maximum

Field Value

Type	Description
float

Minimum

The minimum value in the range.

Declaration

public readonly float Minimum

Field Value

Type	Description
float

Properties

IsEmpty

Property to return whether the range is empty or not.

Declaration

[JsonIgnore]
public bool IsEmpty { get; }

Property Value

Type	Description
bool

Range

Property to return the range between the two values.

Declaration

[JsonIgnore]
public float Range { get; }

Property Value

Type	Description
float

Methods

Add(GorgonRangeF, GorgonRangeF)

Function to add two GorgonRangeF values together.

Declaration

public static GorgonRangeF Add(GorgonRangeF left, GorgonRangeF right)

Parameters

Type	Name	Description
GorgonRangeF	left	The left GorgonRangeF value to add
GorgonRangeF	right	The right GorgonRangeF value to add.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF representing the total of both ranges.

Add(in GorgonRangeF, in GorgonRangeF, out GorgonRangeF)

Function to add two GorgonRangeF values together.

Declaration

public static void Add(in GorgonRangeF left, in GorgonRangeF right, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	left	The left GorgonRangeF value to add
GorgonRangeF	right	The right GorgonRangeF value to add.
GorgonRangeF	result	A new GorgonRangeF representing the total of both ranges.

CompareTo(GorgonRangeF)

Compares the current object with another object of the same type.

Declaration

public int CompareTo(GorgonRangeF other)

Parameters

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

Returns

Type	Description
int	A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other.

Contains(float)

Function to return whether the float value falls within this GorgonRangeF.

Declaration

public bool Contains(float value)

Parameters

Type	Name	Description
float	value	Value to test.

Returns

Type	Description
bool	true if the value falls into the range, false if not.

Divide(GorgonRangeF, float)

Function to divide a GorgonRangeF by a float value.

Declaration

public static GorgonRangeF Divide(GorgonRangeF range, float scalar)

Parameters

Type	Name	Description
GorgonRangeF	range	The GorgonRangeF range value to divide.
float	scalar	The float scalar value to divide by.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF representing the product of the range and the scalar.

Exceptions

Type	Condition
DivideByZeroException	Thrown if the scalar value is zero.

Divide(in GorgonRangeF, float, out GorgonRangeF)

Function to divide a GorgonRangeF by a float value.

Declaration

public static void Divide(in GorgonRangeF range, float scalar, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	range	The GorgonRangeF range value to divide.
float	scalar	The float scalar value to divide by.
GorgonRangeF	result	A new GorgonRangeF representing the product of the range and the scalar.

Exceptions

Type	Condition
DivideByZeroException	Thrown if the scalar value is zero.

Equals(GorgonRangeF)

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

Declaration

public bool Equals(GorgonRangeF other)

Parameters

Type	Name	Description
GorgonRangeF	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(in GorgonRangeF)

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

Declaration

public bool Equals(in GorgonRangeF other)

Parameters

Type	Name	Description
GorgonRangeF	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	Another object to compare to.

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)

Expand(GorgonRangeF, float)

Function to expand a GorgonRangeF by a specific amount.

Declaration

public static GorgonRangeF Expand(GorgonRangeF range, float amount)

Parameters

Type	Name	Description
GorgonRangeF	range	A GorgonRangeF to expand.
float	amount	The amount to expand the GorgonRangeF by.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF value, increased in size by amount.

Expand(in GorgonRangeF, float, out GorgonRangeF)

Function to expand a GorgonRangeF by a specific amount.

Declaration

public static void Expand(in GorgonRangeF range, float amount, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	range	A GorgonRangeF to expand.
float	amount	The amount to expand the GorgonRangeF by.
GorgonRangeF	result	A new GorgonRangeF value, increased in size by amount.

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()

Multiply(GorgonRangeF, GorgonRangeF)

Function to multiply two GorgonRangeF ranges together.

Declaration

public static GorgonRangeF Multiply(GorgonRangeF left, GorgonRangeF right)

Parameters

Type	Name	Description
GorgonRangeF	left	The left GorgonRangeF value to multiply.
GorgonRangeF	right	The right GorgonRangeF value to multiply.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF value representing the product of both ranges.

Multiply(GorgonRangeF, float)

Function to multiply a GorgonRangeF by a scalar float value.

Declaration

public static GorgonRangeF Multiply(GorgonRangeF range, float scalar)

Parameters

Type	Name	Description
GorgonRangeF	range	The range to multiply by.
float	scalar	The float scalar value to multiply.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF representing the product of the range and the scalar.

Multiply(in GorgonRangeF, in GorgonRangeF, out GorgonRangeF)

Function to multiply two GorgonRangeF ranges together.

Declaration

public static void Multiply(in GorgonRangeF left, in GorgonRangeF right, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	left	The left GorgonRangeF value to multiply.
GorgonRangeF	right	The right GorgonRangeF value to multiply.
GorgonRangeF	result	A new GorgonRangeF value representing the product of both ranges.

Multiply(in GorgonRangeF, float, out GorgonRangeF)

Function to multiply a GorgonRangeF by a scalar float value.

Declaration

public static void Multiply(in GorgonRangeF range, float scalar, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	range	The range to multiply by.
float	scalar	The float scalar value to multiply.
GorgonRangeF	result	A new GorgonRangeF representing the product of the range and the scalar.

Shrink(GorgonRangeF, float)

Function to shrink a GorgonRangeF by a specific amount.

Declaration

public static GorgonRangeF Shrink(GorgonRangeF range, float amount)

Parameters

Type	Name	Description
GorgonRangeF	range	A GorgonRangeF to shrink.
float	amount	The amount to shrink the GorgonRangeF by.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF value, decreased in size by amount.

Shrink(in GorgonRangeF, float, out GorgonRangeF)

Function to shrink a GorgonRangeF by a specific amount.

Declaration

public static void Shrink(in GorgonRangeF range, float amount, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	range	A GorgonRangeF to shrink.
float	amount	The amount to shrink the GorgonRangeF by.
GorgonRangeF	result	A new GorgonRangeF value, decreased in size by amount.

Subtract(GorgonRangeF, GorgonRangeF)

Function to subtract two GorgonRangeF ranges from each other.

Declaration

public static GorgonRangeF Subtract(GorgonRangeF left, GorgonRangeF right)

Parameters

Type	Name	Description
GorgonRangeF	left	The left GorgonRangeF value to subtract.
GorgonRangeF	right	The right GorgonRangeF value to subtract.

Returns

Type	Description
GorgonRangeF	A new GorgonRangeF value representing the difference of both ranges.

Subtract(in GorgonRangeF, in GorgonRangeF, out GorgonRangeF)

Function to subtract two GorgonRangeF ranges from each other.

Declaration

public static void Subtract(in GorgonRangeF left, in GorgonRangeF right, out GorgonRangeF result)

Parameters

Type	Name	Description
GorgonRangeF	left	The left GorgonRangeF value to subtract.
GorgonRangeF	right	The right GorgonRangeF value to subtract.
GorgonRangeF	result	A new GorgonRangeF value representing the difference of both ranges.

ToGorgonRange(GorgonRangeF)

Function to perform an explicit conversion from GorgonRangeF to GorgonRange.

Declaration

public static GorgonRange ToGorgonRange(GorgonRangeF range)

Parameters

Type	Name	Description
GorgonRangeF	range	The range.

Returns

Type	Description
GorgonRange	The result of the conversion.

ToGorgonRangeD(GorgonRangeF)

Function to perform an explicit conversion from GorgonRangeF to GorgonRangeD.

Declaration

public static GorgonRangeD ToGorgonRangeD(GorgonRangeF range)

Parameters

Type	Name	Description
GorgonRangeF	range	The range.

Returns

Type	Description
GorgonRangeD	The result of the conversion.

ToGorgonRangeM(GorgonRangeF)

Function to perform an explicit conversion from GorgonRangeF to GorgonRangeM.

Declaration

public static GorgonRangeM ToGorgonRangeM(GorgonRangeF range)

Parameters

Type	Name	Description
GorgonRangeF	range	The range.

Returns

Type	Description
GorgonRangeM	The result of the conversion.

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string containing a fully qualified type name.

Overrides

ValueType.ToString()

Operators

operator +(GorgonRangeF, GorgonRangeF)

Implements the operator +.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left range.
GorgonRangeF	right	The right range.

Returns

Type	Description
GorgonRangeF	The result of the operator.

operator /(GorgonRangeF, float)

Implements the operator /.

Declaration

public static GorgonRangeF operator /(GorgonRangeF left, float scalar)

Parameters

Type	Name	Description
GorgonRangeF	left	The left range.
float	scalar	The right scalar value.

Returns

Type	Description
GorgonRangeF	The result of the operator.

operator ==(GorgonRangeF, GorgonRangeF)

Implements the operator ==.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left.
GorgonRangeF	right	The right.

Returns

Type	Description
bool	The result of the operator.

explicit operator GorgonRange(GorgonRangeF)

Performs an explicit conversion from GorgonRangeF to GorgonRange.

Declaration

public static explicit operator GorgonRange(GorgonRangeF range)

Parameters

Type	Name	Description
GorgonRangeF	range	The range.

Returns

Type	Description
GorgonRange	The result of the conversion.

explicit operator GorgonRangeM(GorgonRangeF)

Performs an explicit conversion from GorgonRangeF to GorgonRangeM.

Declaration

public static explicit operator GorgonRangeM(GorgonRangeF range)

Parameters

Type	Name	Description
GorgonRangeF	range	The range.

Returns

Type	Description
GorgonRangeM	The result of the conversion.

operator >(GorgonRangeF, GorgonRangeF)

Implements the operator >.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left instance to compare.
GorgonRangeF	right	The right instance to compare.

Returns

Type	Description
bool	true if left is greater than right.

operator >=(GorgonRangeF, GorgonRangeF)

Implements the operator >=.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left instance to compare.
GorgonRangeF	right	The right instance to compare.

Returns

Type	Description
bool	true if left is greater than right.

implicit operator GorgonRangeD(GorgonRangeF)

Performs an explicit conversion from GorgonRangeF to GorgonRangeD.

Declaration

public static implicit operator GorgonRangeD(GorgonRangeF range)

Parameters

Type	Name	Description
GorgonRangeF	range	The range.

Returns

Type	Description
GorgonRangeD	The result of the conversion.

operator !=(GorgonRangeF, GorgonRangeF)

Implements the operator ==.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left.
GorgonRangeF	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator <(GorgonRangeF, GorgonRangeF)

Implements the operator >.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left instance to compare.
GorgonRangeF	right	The right instance to compare.

Returns

Type	Description
bool	true if left is greater than right.

operator <=(GorgonRangeF, GorgonRangeF)

Implements the operator >=.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left instance to compare.
GorgonRangeF	right	The right instance to compare.

Returns

Type	Description
bool	true if left is greater than right.

operator *(GorgonRangeF, GorgonRangeF)

Implements the operator *.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left range.
GorgonRangeF	right	The right range.

Returns

Type	Description
GorgonRangeF	The result of the operator.

operator *(GorgonRangeF, float)

Implements the operator *.

Declaration

public static GorgonRangeF operator *(GorgonRangeF left, float scalar)

Parameters

Type	Name	Description
GorgonRangeF	left	The left range.
float	scalar	The right scalar value.

Returns

Type	Description
GorgonRangeF	The result of the operator.

operator *(float, GorgonRangeF)

Implements the operator *.

Declaration

public static GorgonRangeF operator *(float scalar, GorgonRangeF right)

Parameters

Type	Name	Description
float	scalar	The scalar value.
GorgonRangeF	right	The right scalar value.

Returns

Type	Description
GorgonRangeF	The result of the operator.

operator -(GorgonRangeF, GorgonRangeF)

Implements the operator -.

Declaration

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

Parameters

Type	Name	Description
GorgonRangeF	left	The left range.
GorgonRangeF	right	The right range.

Returns

Type	Description
GorgonRangeF	The result of the operator.

Implements

IGorgonEquatableByRef<T>

IEquatable<T>

IComparable<T>

Extension Methods

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)