Struct ByteRange
Represents a byte range with minimum and maximum values.
Implements
IRange<System.Byte>
System.IFormattable
System.IEquatable<ByteRange>
System.Collections.Generic.IEnumerable<System.Byte>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Mars.Numerics.Ranges
Assembly: Mars.Numerics.dll
Syntax
[Serializable]
public struct ByteRange : IRange<byte>, IFormattable, IEquatable<ByteRange>, IEnumerable<byte>, IEnumerable
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
Examples
// create [0, 255] range
var range1 = new ByteRange(0, 255);
// create [64, 128] range
var range2 = new ByteRange(64, 128);
// check if values is inside of the first range
if (range1.IsInside(5))
{
// ...
}
// check if the second range is inside of the first range
if (range1.IsInside(range2))
{
// ...
}
// check if two ranges overlap
if (range1.IsOverlapping(range2))
{
// ...
}
Constructors
| Improve this Doc View SourceByteRange(Byte, Byte)
Initializes a new instance of the IntRange class.
Declaration
public ByteRange(byte min, byte max)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | min | Minimum value of the range. |
System.Byte | max | Maximum value of the range. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
Properties
| Improve this Doc View SourceLength
Gets the length of the range, defined as (max - min).
Declaration
public readonly int Length { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceMax
Maximum value of the range.
Declaration
public byte Max { get; set; }
Property Value
Type | Description |
---|---|
System.Byte |
Remarks
Represents maximum value (right side limit) of the range [min, max].
See Also
| Improve this Doc View SourceMin
Minimum value of the range.
Declaration
public byte Min { get; set; }
Property Value
Type | Description |
---|---|
System.Byte |
Remarks
Represents minimum value (left side limit) of the range [min, max].
See Also
Methods
| Improve this Doc View SourceEquals(ByteRange)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(ByteRange other)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | other | An object to compare with this object. |
Returns
Type | Description |
---|---|
System.Boolean |
true if the current object is equal to the other parameter; otherwise, false.
|
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceEquals(Object)
Determines whether the specified System.Object, is equal to this instance.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | The System.Object to compare with this instance. |
Returns
Type | Description |
---|---|
System.Boolean |
true if the specified System.Object is equal to this instance; otherwise, false .
|
Overrides
System.ValueType.Equals(System.Object)
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceGetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
public IEnumerator<byte> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<System.Byte> | An System.Collections.IEnumerator object that can be used to iterate through the collection. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceGetHashCode()
Returns a hash code for this instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |
Overrides
System.ValueType.GetHashCode()
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceIntersection(ByteRange)
Computes the intersection between two ranges.
Declaration
public ByteRange Intersection(ByteRange range)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range | The second range for which the intersection should be calculated. |
Returns
Type | Description |
---|---|
ByteRange |
An new ByteRange structure containing the intersection
between this range and the range given as argument.
|
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceIsInside(ByteRange)
Check if the specified range is inside of the range.
Declaration
public bool IsInside(ByteRange range)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range | Range to check. |
Returns
Type | Description |
---|---|
System.Boolean | True if the specified range is inside of the range or false otherwise. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceIsInside(Byte)
Check if the specified value is inside of the range.
Declaration
public bool IsInside(byte x)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | x | Value to check. |
Returns
Type | Description |
---|---|
System.Boolean | True if the specified value is inside of the range or false otherwise. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceIsOverlapping(ByteRange)
Check if the specified range overlaps with the range.
Declaration
public bool IsOverlapping(ByteRange range)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range | Range to check for overlapping. |
Returns
Type | Description |
---|---|
System.Boolean | True if the specified range overlaps with the range or false otherwise. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceToString()
Returns a System.String that represents this instance.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | A System.String that represents this instance. |
Overrides
System.ValueType.ToString()
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceToString(String, IFormatProvider)
Returns a System.String that represents this instance.
Declaration
public string ToString(string format, IFormatProvider formatProvider)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | The format. |
System.IFormatProvider | formatProvider | The format provider. |
Returns
Type | Description |
---|---|
System.String | A System.String that represents this instance. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
Operators
| Improve this Doc View SourceEquality(ByteRange, ByteRange)
Determines whether two instances are equal.
Declaration
public static bool operator ==(ByteRange range1, ByteRange range2)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range1 | |
ByteRange | range2 |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceImplicit(ByteRange to DoubleRange)
Performs an implicit conversion from IntRange to DoubleRange.
Declaration
public static implicit operator DoubleRange(ByteRange range)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range | The range. |
Returns
Type | Description |
---|---|
DoubleRange | The result of the conversion. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceImplicit(ByteRange to FloatRange)
Performs an implicit conversion from IntRange to FloatRange.
Declaration
public static implicit operator FloatRange(ByteRange range)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range | The range. |
Returns
Type | Description |
---|---|
FloatRange | The result of the conversion. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceImplicit(ByteRange to IntRange)
Declaration
public static implicit operator IntRange(ByteRange range)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range | The range. |
Returns
Type | Description |
---|---|
IntRange | The result of the conversion. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
| Improve this Doc View SourceInequality(ByteRange, ByteRange)
Determines whether two instances are not equal.
Declaration
public static bool operator !=(ByteRange range1, ByteRange range2)
Parameters
Type | Name | Description |
---|---|---|
ByteRange | range1 | |
ByteRange | range2 |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
Explicit Interface Implementations
| Improve this Doc View SourceIEnumerable.GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | An System.Collections.IEnumerator object that can be used to iterate through the collection. |
Remarks
This class represents a byt range with inclusive limits, where
both minimum and maximum values of the range are included into it.
Mathematical notation of such range is [min, max].
See Also
Implements
System.IFormattable
System.IEquatable<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable