Range Structure

Represents a double range with minimum and maximum values, where values are single-precision floating-point (float) numbers.

Namespace: Accord
Assembly: Accord (in Accord.dll) Version: 3.8.0

Syntax

Copy

[SerializableAttribute]
public struct Range : IRange<float>, 
	IFormattable, IEquatable<Range>

<SerializableAttribute>
Public Structure Range
	Implements IRange(Of Single), IFormattable, 
	IEquatable(Of Range)

Request Example View Source

The Range type exposes the following members.

Constructors

	Name	Description
	Range	Initializes a new instance of the Range class.

Top

Properties

	Name	Description
	Length	Gets the length of the range, defined as (max - min).
	Max	Maximum value of the range.
	Min	Minimum value of the range.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(Range)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Returns a hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Intersection	Computes the intersection between two ranges.
	IsInside(Single)	Check if the specified value is inside of the range.
	IsInside(Range)	Check if the specified range is inside of the range.
	IsOverlapping	Check if the specified range overlaps with the range.
	ToIntRange	Converts this single-precision range into an IntRange.
	ToString	Returns a String that represents this instance. (Overrides ValueTypeToString.)
	ToString(String, IFormatProvider)	Returns a String that represents this instance.

Top

Operators

	Name	Description
	Equality	Determines whether two instances are equal.
	(Range to DoubleRange)	Performs an implicit conversion from IntRange to DoubleRange.
	Inequality	Determines whether two instances are not equal.

Top

Extension Methods

	Name	Description
	HasMethod	Checks whether an object implements a method with the given name. (Defined by ExtensionMethods.)
	Interval(Int32)	Overloaded. Creates an interval vector (like NumPy's linspace function). (Defined by Vector.)
	Interval(Double)	Overloaded. Obsolete. Please use Vector.Range(range, stepSize) instead. (Defined by Vector.)
	IsEqual	Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices. (Defined by Matrix.)
	Range	Overloaded. Creates a range vector (like NumPy's arange function). (Defined by Vector.)
	Range(Double)	Overloaded. Creates a range vector (like NumPy's arange function). (Defined by Vector.)
	Range(Single)	Overloaded. Creates a range vector (like NumPy's arange function). (Defined by Vector.)
	Range(Byte)	Overloaded. Creates a range vector (like NumPy's arange function). (Defined by Vector.)
	Range(Int32)	Overloaded. Creates a range vector (like NumPy's arange function). (Defined by Vector.)
	To(Type)	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)
	ToT	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)

Top

Remarks

This class represents a double 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

Copy

// create [0.25, 1.5] range
var range1 = new SingleRange(0.25f, 1.5f);

// create [1.00, 2.25] range
var range2 = new SingleRange(1.00f, 2.25f);

// check if values is inside of the first range
if (range1.IsInside(0.75f))
{
    // ...
}

// check if the second range is inside of the first range
if (range1.IsInside(range2))
{
    // ...
}

// check if two ranges overlap
if (range1.IsOverlapping(range2))
{
    // ...
}

Reference